Serialized Form (AWS SDK for Java

Package com.amazonaws
- Class com.amazonaws.AbortedException extends SdkClientException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.AmazonClientException extends SdkBaseException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.AmazonServiceException extends SdkClientException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
      The unique AWS identifier for the service request the caller made. The AWS request ID can uniquely identify the AWS request, and is used for reporting an error to AWS support team.
    - errorCode
```
String errorCode
```
      The AWS error code represented by this exception (ex: InvalidParameterValue).
    - errorType
```
AmazonServiceException.ErrorType errorType
```
      Indicates (if known) whether this exception was the fault of the caller or the service.
      
      See Also:
      
      AmazonServiceException.ErrorType
    - errorMessage
```
String errorMessage
```
      The error message as returned by the service.
    - statusCode
```
int statusCode
```
      The HTTP status code that was returned with this error
    - serviceName
```
String serviceName
```
      The name of the Amazon service that sent this error response.
    - httpHeaders
```
Map<K,V> httpHeaders
```
      All HTTP headers in the response for additional context and debugging.
    - rawResponse
```
byte[] rawResponse
```
      The raw response payload.
- Class com.amazonaws.ResetException extends SdkClientException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - extraInfo
```
String extraInfo
```
- Class com.amazonaws.SdkBaseException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.SdkClientException extends AmazonClientException implements Serializable
Package com.amazonaws.http.exception
- Class com.amazonaws.http.exception.HttpRequestTimeoutException extends IOException implements Serializable
  
  serialVersionUID:
  
  -2588353895012259837L
Package com.amazonaws.http.timers.client
- Class com.amazonaws.http.timers.client.ClientExecutionTimeoutException extends SdkClientException implements Serializable
  
  serialVersionUID:
  
  4861767589924758934L
- Class com.amazonaws.http.timers.client.SdkInterruptedException extends InterruptedException implements Serializable
  
  serialVersionUID:
  
  8194951388566545094L
Package com.amazonaws.internal
- Class com.amazonaws.internal.CRC32MismatchException extends IOException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.internal.ListWithAutoConstructFlag extends ArrayList<T> implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - autoConstruct
```
boolean autoConstruct
```
      Auto construct flag to indicate whether the list is auto constructed by Java SDK.
- Class com.amazonaws.internal.SdkInternalList extends ArrayList<T> implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - autoConstruct
```
boolean autoConstruct
```
      Auto construct flag to indicate whether the list is auto constructed by Java SDK.
- Class com.amazonaws.internal.SdkInternalMap extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - map
```
Map<K,V> map
```
    - autoConstruct
```
boolean autoConstruct
```
      Auto construct flag to indicate whether the map is auto constructed by Java SDK.
Package com.amazonaws.jmespath
- Class com.amazonaws.jmespath.InvalidTypeException extends RuntimeException implements Serializable
Package com.amazonaws.protocol.json
- Class com.amazonaws.protocol.json.SdkJsonGenerator.JsonGenerationException extends SdkClientException implements Serializable
Package com.amazonaws.services.accessanalyzer.model
- Class com.amazonaws.services.accessanalyzer.model.AccessDeniedException extends AWSAccessAnalyzerException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.accessanalyzer.model.AnalyzedResource extends Object implements Serializable
  - Serialized Fields
    - actions
```
List<E> actions
```
      The actions that an external principal is granted permission to use by the policy that generated the finding.
    - analyzedAt
```
Date analyzedAt
```
      The time at which the resource was analyzed.
    - createdAt
```
Date createdAt
```
      The time at which the finding was created.
    - error
```
String error
```
      An error message.
    - isPublic
```
Boolean isPublic
```
      Indicates whether the policy that generated the finding grants public access to the resource.
    - resourceArn
```
String resourceArn
```
      The ARN of the resource that was analyzed.
    - resourceType
```
String resourceType
```
      The type of the resource that was analyzed.
    - sharedVia
```
List<E> sharedVia
```
      Indicates how the access that generated the finding is granted.
    - status
```
String status
```
      The current status of the finding generated from the analyzed resource.
    - updatedAt
```
Date updatedAt
```
      The time at which the finding was updated.
- Class com.amazonaws.services.accessanalyzer.model.AnalyzedResourceSummary extends Object implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the analyzed resource.
    - resourceType
```
String resourceType
```
      The type of resource that was analyzed.
- Class com.amazonaws.services.accessanalyzer.model.AnalyzerSummary extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the analyzer.
    - createdAt
```
Date createdAt
```
      A timestamp for the time at which the analyzer was created.
    - lastResourceAnalyzed
```
String lastResourceAnalyzed
```
      The resource that was most recently analyzed by the analyzer.
    - lastResourceAnalyzedAt
```
Date lastResourceAnalyzedAt
```
      The time at which the most recently analyzed resource was analyzed.
    - name
```
String name
```
      The name of the analyzer.
    - tags
```
Map<K,V> tags
```
      The tags added to the analyzer.
    - type
```
String type
```
      The type of analyzer, which corresponds to the zone of trust chosen for the analyzer.
- Class com.amazonaws.services.accessanalyzer.model.ArchiveRuleSummary extends Object implements Serializable
  - Serialized Fields
    - createdAt
```
Date createdAt
```
      The time at which the archive rule was created.
    - filter
```
Map<K,V> filter
```
      A filter used to define the archive rule.
    - ruleName
```
String ruleName
```
      The name of the archive rule.
    - updatedAt
```
Date updatedAt
```
      The time at which the archive rule was last updated.
- Class com.amazonaws.services.accessanalyzer.model.AWSAccessAnalyzerException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.accessanalyzer.model.ConflictException extends AWSAccessAnalyzerException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The ID of the resource.
    - resourceType
```
String resourceType
```
      The resource type.
- Class com.amazonaws.services.accessanalyzer.model.CreateAnalyzerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerName
```
String analyzerName
```
      The name of the analyzer to create.
    - archiveRules
```
List<E> archiveRules
```
      Specifies the archive rules to add for the analyzer. Archive rules automatically archive findings that meet the criteria you define for the rule.
    - clientToken
```
String clientToken
```
      A client token.
    - tags
```
Map<K,V> tags
```
      The tags to apply to the analyzer.
    - type
```
String type
```
      The type of analyzer to create. Only ACCOUNT analyzers are supported. You can create only one analyzer per account per Region.
- Class com.amazonaws.services.accessanalyzer.model.CreateAnalyzerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the analyzer that was created by the request.
- Class com.amazonaws.services.accessanalyzer.model.CreateArchiveRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerName
```
String analyzerName
```
      The name of the created analyzer.
    - clientToken
```
String clientToken
```
      A client token.
    - filter
```
Map<K,V> filter
```
      The criteria for the rule.
    - ruleName
```
String ruleName
```
      The name of the rule to create.
- Class com.amazonaws.services.accessanalyzer.model.CreateArchiveRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.Criterion extends Object implements Serializable
  - Serialized Fields
    - contains
```
List<E> contains
```
      A "contains" operator to match for the filter used to create the rule.
    - eq
```
List<E> eq
```
      An "equals" operator to match for the filter used to create the rule.
    - exists
```
Boolean exists
```
      An "exists" operator to match for the filter used to create the rule.
    - neq
```
List<E> neq
```
      A "not equals" operator to match for the filter used to create the rule.
- Class com.amazonaws.services.accessanalyzer.model.DeleteAnalyzerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerName
```
String analyzerName
```
      The name of the analyzer to delete.
    - clientToken
```
String clientToken
```
      A client token.
- Class com.amazonaws.services.accessanalyzer.model.DeleteAnalyzerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.DeleteArchiveRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerName
```
String analyzerName
```
      The name of the analyzer that associated with the archive rule to delete.
    - clientToken
```
String clientToken
```
      A client token.
    - ruleName
```
String ruleName
```
      The name of the rule to delete.
- Class com.amazonaws.services.accessanalyzer.model.DeleteArchiveRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.Finding extends Object implements Serializable
  - Serialized Fields
    - action
```
List<E> action
```
      The action in the analyzed policy statement that an external principal has permission to use.
    - analyzedAt
```
Date analyzedAt
```
      The time at which the resource was analyzed.
    - condition
```
Map<K,V> condition
```
      The condition in the analyzed policy statement that resulted in a finding.
    - createdAt
```
Date createdAt
```
      The time at which the finding was generated.
    - error
```
String error
```
      An error.
    - id
```
String id
```
      The ID of the finding.
    - isPublic
```
Boolean isPublic
```
      Indicates whether the policy that generated the finding allows public access to the resource.
    - principal
```
Map<K,V> principal
```
      The external principal that access to a resource within the zone of trust.
    - resource
```
String resource
```
      The resource that an external principal has access to.
    - resourceType
```
String resourceType
```
      The type of the resource reported in the finding.
    - status
```
String status
```
      The current status of the finding.
    - updatedAt
```
Date updatedAt
```
      The time at which the finding was updated.
- Class com.amazonaws.services.accessanalyzer.model.FindingSummary extends Object implements Serializable
  - Serialized Fields
    - action
```
List<E> action
```
      The action in the analyzed policy statement that an external principal has permission to use.
    - analyzedAt
```
Date analyzedAt
```
      The time at which the resource-based policy that generated the finding was analyzed.
    - condition
```
Map<K,V> condition
```
      The condition in the analyzed policy statement that resulted in a finding.
    - createdAt
```
Date createdAt
```
      The time at which the finding was created.
    - error
```
String error
```
      The error that resulted in an Error finding.
    - id
```
String id
```
      The ID of the finding.
    - isPublic
```
Boolean isPublic
```
      Indicates whether the finding reports a resource that has a policy that allows public access.
    - principal
```
Map<K,V> principal
```
      The external principal that has access to a resource within the zone of trust.
    - resource
```
String resource
```
      The resource that the external principal has access to.
    - resourceType
```
String resourceType
```
      The type of the resource that the external principal has access to.
    - status
```
String status
```
      The status of the finding.
    - updatedAt
```
Date updatedAt
```
      The time at which the finding was most recently updated.
- Class com.amazonaws.services.accessanalyzer.model.GetAnalyzedResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer to retrieve information from.
    - resourceArn
```
String resourceArn
```
      The ARN of the resource to retrieve information about.
- Class com.amazonaws.services.accessanalyzer.model.GetAnalyzedResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resource
```
AnalyzedResource resource
```
      An AnalyedResource object that contains information that Access Analyzer found when it analyzed the resource.
- Class com.amazonaws.services.accessanalyzer.model.GetAnalyzerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerName
```
String analyzerName
```
      The name of the analyzer retrieved.
- Class com.amazonaws.services.accessanalyzer.model.GetAnalyzerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - analyzer
```
AnalyzerSummary analyzer
```
      An AnalyzerSummary object that contains information about the analyzer.
- Class com.amazonaws.services.accessanalyzer.model.GetArchiveRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerName
```
String analyzerName
```
      The name of the analyzer to retrieve rules from.
    - ruleName
```
String ruleName
```
      The name of the rule to retrieve.
- Class com.amazonaws.services.accessanalyzer.model.GetArchiveRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - archiveRule
```
ArchiveRuleSummary archiveRule
```
- Class com.amazonaws.services.accessanalyzer.model.GetFindingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer that generated the finding.
    - id
```
String id
```
      The ID of the finding to retrieve.
- Class com.amazonaws.services.accessanalyzer.model.GetFindingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - finding
```
Finding finding
```
      A finding object that contains finding details.
- Class com.amazonaws.services.accessanalyzer.model.InlineArchiveRule extends Object implements Serializable
  - Serialized Fields
    - filter
```
Map<K,V> filter
```
      The condition and values for a criterion.
    - ruleName
```
String ruleName
```
      The name of the rule.
- Class com.amazonaws.services.accessanalyzer.model.InternalServerException extends AWSAccessAnalyzerException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - retryAfterSeconds
```
Integer retryAfterSeconds
```
      The seconds to wait to retry.
- Class com.amazonaws.services.accessanalyzer.model.ListAnalyzedResourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer to retrieve a list of analyzed resources from.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
    - resourceType
```
String resourceType
```
      The type of resource.
- Class com.amazonaws.services.accessanalyzer.model.ListAnalyzedResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - analyzedResources
```
List<E> analyzedResources
```
      A list of resources that were analyzed.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
- Class com.amazonaws.services.accessanalyzer.model.ListAnalyzersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
    - type
```
String type
```
      The type of analyzer.
- Class com.amazonaws.services.accessanalyzer.model.ListAnalyzersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - analyzers
```
List<E> analyzers
```
      The analyzers retrieved.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
- Class com.amazonaws.services.accessanalyzer.model.ListArchiveRulesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerName
```
String analyzerName
```
      The name of the analyzer to retrieve rules from.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the request.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
- Class com.amazonaws.services.accessanalyzer.model.ListArchiveRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - archiveRules
```
List<E> archiveRules
```
      A list of archive rules created for the specified analyzer.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
- Class com.amazonaws.services.accessanalyzer.model.ListFindingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer to retrieve findings from.
    - filter
```
Map<K,V> filter
```
      A filter to match for the findings to return.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in the response.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
    - sort
```
SortCriteria sort
```
      The sort order for the findings returned.
- Class com.amazonaws.services.accessanalyzer.model.ListFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - findings
```
List<E> findings
```
      A list of findings retrieved from the analyzer that match the filter criteria specified, if any.
    - nextToken
```
String nextToken
```
      A token used for pagination of results returned.
- Class com.amazonaws.services.accessanalyzer.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the resource to retrieve tags from.
- Class com.amazonaws.services.accessanalyzer.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      The tags that are applied to the specified resource.
- Class com.amazonaws.services.accessanalyzer.model.ResourceNotFoundException extends AWSAccessAnalyzerException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The ID of the resource.
    - resourceType
```
String resourceType
```
      The type of the resource.
- Class com.amazonaws.services.accessanalyzer.model.ServiceQuotaExceededException extends AWSAccessAnalyzerException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The resource ID.
    - resourceType
```
String resourceType
```
      The resource type.
- Class com.amazonaws.services.accessanalyzer.model.SortCriteria extends Object implements Serializable
  - Serialized Fields
    - attributeName
```
String attributeName
```
      The name of the attribute to sort on.
    - orderBy
```
String orderBy
```
      The sort order, ascending or descending.
- Class com.amazonaws.services.accessanalyzer.model.StartResourceScanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer to use to scan the policies applied to the specified resource.
    - resourceArn
```
String resourceArn
```
      The ARN of the resource to scan.
- Class com.amazonaws.services.accessanalyzer.model.StartResourceScanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the resource to add the tag to.
    - tags
```
Map<K,V> tags
```
      The tags to add to the resource.
- Class com.amazonaws.services.accessanalyzer.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.ThrottlingException extends AWSAccessAnalyzerException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - retryAfterSeconds
```
Integer retryAfterSeconds
```
      The seconds to wait to retry.
- Class com.amazonaws.services.accessanalyzer.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the resource to remove the tag from.
    - tagKeys
```
List<E> tagKeys
```
      The key for the tag to add.
- Class com.amazonaws.services.accessanalyzer.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.UpdateArchiveRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerName
```
String analyzerName
```
      The name of the analyzer to update the archive rules for.
    - clientToken
```
String clientToken
```
      A client token.
    - filter
```
Map<K,V> filter
```
      A filter to match for the rules to update. Only rules that match the filter are updated.
    - ruleName
```
String ruleName
```
      The name of the rule to update.
- Class com.amazonaws.services.accessanalyzer.model.UpdateArchiveRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.UpdateFindingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - analyzerArn
```
String analyzerArn
```
      The ARN of the analyzer that generated the findings to update.
    - clientToken
```
String clientToken
```
      A client token.
    - ids
```
List<E> ids
```
      The IDs of the findings to update.
    - resourceArn
```
String resourceArn
```
      The ARN of the resource identified in the finding.
    - status
```
String status
```
      The state represents the action to take to update the finding Status. Use ARCHIVE to change an Active finding to an Archived finding. Use ACTIVE to change an Archived finding to an Active finding.
- Class com.amazonaws.services.accessanalyzer.model.UpdateFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.accessanalyzer.model.ValidationException extends AWSAccessAnalyzerException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - fieldList
```
List<E> fieldList
```
      A list of fields that didn't validate.
    - reason
```
String reason
```
      The reason for the exception.
- Class com.amazonaws.services.accessanalyzer.model.ValidationExceptionField extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      A message about the validation exception.
    - name
```
String name
```
      The name of the validation exception.
Package com.amazonaws.services.acmpca.model
- Class com.amazonaws.services.acmpca.model.ASN1Subject extends Object implements Serializable
  - Serialized Fields
    - country
```
String country
```
      Two-digit code that specifies the country in which the certificate subject located.
    - organization
```
String organization
```
      Legal name of the organization with which the certificate subject is affiliated.
    - organizationalUnit
```
String organizationalUnit
```
      A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
    - distinguishedNameQualifier
```
String distinguishedNameQualifier
```
      Disambiguating information for the certificate subject.
    - state
```
String state
```
      State in which the subject of the certificate is located.
    - commonName
```
String commonName
```
      Fully qualified domain name (FQDN) associated with the certificate subject.
    - serialNumber
```
String serialNumber
```
      The certificate serial number.
    - locality
```
String locality
```
      The locality (such as a city or town) in which the certificate subject is located.
    - title
```
String title
```
      A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
    - surname
```
String surname
```
      Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.
    - givenName
```
String givenName
```
      First name.
    - initials
```
String initials
```
      Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the SurName.
    - pseudonym
```
String pseudonym
```
      Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.
    - generationQualifier
```
String generationQualifier
```
      Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
- Class com.amazonaws.services.acmpca.model.AWSACMPCAException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.CertificateAuthority extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
    - createdAt
```
Date createdAt
```
      Date and time at which your private CA was created.
    - lastStateChangeAt
```
Date lastStateChangeAt
```
      Date and time at which your private CA was last updated.
    - type
```
String type
```
      Type of your private CA.
    - serial
```
String serial
```
      Serial number of your private CA.
    - status
```
String status
```
      Status of your private CA.
    - notBefore
```
Date notBefore
```
      Date and time before which your private CA certificate is not valid.
    - notAfter
```
Date notAfter
```
      Date and time after which your private CA certificate is not valid.
    - failureReason
```
String failureReason
```
      Reason the request to create your private CA failed.
    - certificateAuthorityConfiguration
```
CertificateAuthorityConfiguration certificateAuthorityConfiguration
```
      Your private CA configuration.
    - revocationConfiguration
```
RevocationConfiguration revocationConfiguration
```
      Information about the certificate revocation list (CRL) created and maintained by your private CA.
    - restorableUntil
```
Date restorableUntil
```
      The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
- Class com.amazonaws.services.acmpca.model.CertificateAuthorityConfiguration extends Object implements Serializable
  - Serialized Fields
    - keyAlgorithm
```
String keyAlgorithm
```
      Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.
    - signingAlgorithm
```
String signingAlgorithm
```
      Name of the algorithm your private CA uses to sign certificate requests.
    - subject
```
ASN1Subject subject
```
      Structure that contains X.500 distinguished name information for your private CA.
- Class com.amazonaws.services.acmpca.model.CertificateMismatchException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.ConcurrentModificationException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.CreateCertificateAuthorityAuditReportRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
    - s3BucketName
```
String s3BucketName
```
      The name of the S3 bucket that will contain the audit report.
    - auditReportResponseFormat
```
String auditReportResponseFormat
```
      The format in which to create the report. This can be either JSON or CSV.
- Class com.amazonaws.services.acmpca.model.CreateCertificateAuthorityAuditReportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - auditReportId
```
String auditReportId
```
      An alphanumeric string that contains a report identifier.
    - s3Key
```
String s3Key
```
      The key that uniquely identifies the report file in your S3 bucket.
- Class com.amazonaws.services.acmpca.model.CreateCertificateAuthorityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityConfiguration
```
CertificateAuthorityConfiguration certificateAuthorityConfiguration
```
      Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
    - revocationConfiguration
```
RevocationConfiguration revocationConfiguration
```
      Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.
    - certificateAuthorityType
```
String certificateAuthorityType
```
      The type of the certificate authority.
    - idempotencyToken
```
String idempotencyToken
```
      Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within a five minute period, ACM Private CA recognizes that you are requesting only one certificate. As a result, ACM Private CA issues only one. If you change the idempotency token for each call, however, ACM Private CA recognizes that you are requesting multiple certificates.
    - tags
```
List<E> tags
```
      Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with
      
      IAM to manage permissions, see Controlling Access Using IAM Tags.
- Class com.amazonaws.services.acmpca.model.CreateCertificateAuthorityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
- Class com.amazonaws.services.acmpca.model.CreatePermissionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities action. This must have the following form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
    - principal
```
String principal
```
      The AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.
    - sourceAccount
```
String sourceAccount
```
      The ID of the calling account.
    - actions
```
List<E> actions
```
      The actions that the specified AWS service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.
- Class com.amazonaws.services.acmpca.model.CreatePermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.acmpca.model.CrlConfiguration extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.
    - expirationInDays
```
Integer expirationInDays
```
      Number of days until a certificate expires.
    - customCname
```
String customCname
```
      Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.
    - s3BucketName
```
String s3BucketName
```
      Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.
- Class com.amazonaws.services.acmpca.model.DeleteCertificateAuthorityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must have the following form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
    - permanentDeletionTimeInDays
```
Integer permanentDeletionTimeInDays
```
      The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default.
- Class com.amazonaws.services.acmpca.model.DeleteCertificateAuthorityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.acmpca.model.DeletePermissionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
    - principal
```
String principal
```
      The AWS service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com
    - sourceAccount
```
String sourceAccount
```
      The AWS account that calls this action.
- Class com.amazonaws.services.acmpca.model.DeletePermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.acmpca.model.DescribeCertificateAuthorityAuditReportRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) of the private CA. This must be of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
    - auditReportId
```
String auditReportId
```
      The report ID returned by calling the CreateCertificateAuthorityAuditReport action.
- Class com.amazonaws.services.acmpca.model.DescribeCertificateAuthorityAuditReportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - auditReportStatus
```
String auditReportStatus
```
      Specifies whether report creation is in progress, has succeeded, or has failed.
    - s3BucketName
```
String s3BucketName
```
      Name of the S3 bucket that contains the report.
    - s3Key
```
String s3Key
```
      S3 key that uniquely identifies the report file in your S3 bucket.
    - createdAt
```
Date createdAt
```
      The date and time at which the report was created.
- Class com.amazonaws.services.acmpca.model.DescribeCertificateAuthorityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
- Class com.amazonaws.services.acmpca.model.DescribeCertificateAuthorityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - certificateAuthority
```
CertificateAuthority certificateAuthority
```
      A CertificateAuthority structure that contains information about your private CA.
- Class com.amazonaws.services.acmpca.model.GetCertificateAuthorityCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) of your private CA. This is of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
- Class com.amazonaws.services.acmpca.model.GetCertificateAuthorityCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - certificate
```
String certificate
```
      Base64-encoded certificate authority (CA) certificate.
    - certificateChain
```
String certificateChain
```
      Base64-encoded certificate chain that includes any intermediate certificates and chains up to root on-premises certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate. If this is a root CA, the value will be null.
- Class com.amazonaws.services.acmpca.model.GetCertificateAuthorityCsrRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
- Class com.amazonaws.services.acmpca.model.GetCertificateAuthorityCsrResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - csr
```
String csr
```
      The base64 PEM-encoded certificate signing request (CSR) for your private CA certificate.
- Class com.amazonaws.services.acmpca.model.GetCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
    - certificateArn
```
String certificateArn
```
      The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
- Class com.amazonaws.services.acmpca.model.GetCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - certificate
```
String certificate
```
      The base64 PEM-encoded certificate specified by the CertificateArn parameter.
    - certificateChain
```
String certificateChain
```
      The base64 PEM-encoded certificate chain that chains up to the on-premises root CA certificate that you used to sign your private CA certificate.
- Class com.amazonaws.services.acmpca.model.ImportCertificateAuthorityCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
    - certificate
```
ByteBuffer certificate
```
      The PEM-encoded certificate for a private CA. This may be a self-signed certificate in the case of a root CA, or it may be signed by another CA that you control.
    - certificateChain
```
ByteBuffer certificateChain
```
      A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your ACM Private CA-hosted or on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.
      
      This parameter must be supplied when you import a subordinate CA. When you import a root CA, there is no chain.
- Class com.amazonaws.services.acmpca.model.ImportCertificateAuthorityCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.acmpca.model.InvalidArgsException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.InvalidArnException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.InvalidNextTokenException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.InvalidPolicyException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.InvalidRequestException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.InvalidStateException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.InvalidTagException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.IssueCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
    - csr
```
ByteBuffer csr
```
      The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.
      
      openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
      
      If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.
      
      openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
    - signingAlgorithm
```
String signingAlgorithm
```
      The name of the algorithm that will be used to sign the certificate to be issued.
    - templateArn
```
String templateArn
```
      Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.
      
      The following service-owned TemplateArn values are supported by ACM Private CA:
      
      arn:aws:acm-pca:::template/EndEntityCertificate/V1
      
      arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1
      
      arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1
      
      arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1
      
      arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1
      
      arn:aws:acm-pca:::template/RootCACertificate/V1
      
      For more information, see Using Templates.
    - validity
```
Validity validity
```
      The type of the validity period.
    - idempotencyToken
```
String idempotencyToken
```
      Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.
- Class com.amazonaws.services.acmpca.model.IssueCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
- Class com.amazonaws.services.acmpca.model.LimitExceededException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.ListCertificateAuthoritiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.
    - maxResults
```
Integer maxResults
```
      Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
- Class com.amazonaws.services.acmpca.model.ListCertificateAuthoritiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - certificateAuthorities
```
List<E> certificateAuthorities
```
      Summary information about each certificate authority you have created.
    - nextToken
```
String nextToken
```
      When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.
- Class com.amazonaws.services.acmpca.model.ListPermissionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action.
    - nextToken
```
String nextToken
```
      When paginating results, use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.
    - maxResults
```
Integer maxResults
```
      When paginating results, use this parameter to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
- Class com.amazonaws.services.acmpca.model.ListPermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - permissions
```
List<E> permissions
```
      Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation.
    - nextToken
```
String nextToken
```
      When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.
- Class com.amazonaws.services.acmpca.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
    - nextToken
```
String nextToken
```
      Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.
    - maxResults
```
Integer maxResults
```
      Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
- Class com.amazonaws.services.acmpca.model.ListTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
List<E> tags
```
      The tags associated with your private CA.
    - nextToken
```
String nextToken
```
      When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.
- Class com.amazonaws.services.acmpca.model.MalformedCertificateException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.MalformedCSRException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.Permission extends Object implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Number (ARN) of the private CA from which the permission was issued.
    - createdAt
```
Date createdAt
```
      The time at which the permission was created.
    - principal
```
String principal
```
      The AWS service or entity that holds the permission. At this time, the only valid principal is acm.amazonaws.com.
    - sourceAccount
```
String sourceAccount
```
      The ID of the account that assigned the permission.
    - actions
```
List<E> actions
```
      The private CA actions that can be performed by the designated AWS service.
    - policy
```
String policy
```
      The name of the policy that is associated with the permission.
- Class com.amazonaws.services.acmpca.model.PermissionAlreadyExistsException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.RequestAlreadyProcessedException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.RequestFailedException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.RequestInProgressException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.ResourceNotFoundException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.RestoreCertificateAuthorityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. This must be of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
- Class com.amazonaws.services.acmpca.model.RestoreCertificateAuthorityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.acmpca.model.RevocationConfiguration extends Object implements Serializable
  - Serialized Fields
    - crlConfiguration
```
CrlConfiguration crlConfiguration
```
      Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
- Class com.amazonaws.services.acmpca.model.RevokeCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
    - certificateSerial
```
String certificateSerial
```
      Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.
      
      openssl x509 -in file_path -text -noout
      
      You can also copy the serial number from the console or use the DescribeCertificate action in the AWS Certificate Manager API Reference.
    - revocationReason
```
String revocationReason
```
      Specifies why you revoked the certificate.
- Class com.amazonaws.services.acmpca.model.RevokeCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.acmpca.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      Key (name) of the tag.
    - value
```
String value
```
      Value of the tag.
- Class com.amazonaws.services.acmpca.model.TagCertificateAuthorityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
    - tags
```
List<E> tags
```
      List of tags to be associated with the CA.
- Class com.amazonaws.services.acmpca.model.TagCertificateAuthorityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.acmpca.model.TooManyTagsException extends AWSACMPCAException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.acmpca.model.UntagCertificateAuthorityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
    - tags
```
List<E> tags
```
      List of tags to be removed from the CA.
- Class com.amazonaws.services.acmpca.model.UntagCertificateAuthorityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.acmpca.model.UpdateCertificateAuthorityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
    - revocationConfiguration
```
RevocationConfiguration revocationConfiguration
```
      Revocation information for your private CA.
    - status
```
String status
```
      Status of your private CA.
- Class com.amazonaws.services.acmpca.model.UpdateCertificateAuthorityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.acmpca.model.Validity extends Object implements Serializable
  - Serialized Fields
    - value
```
Long value
```
      Time period.
    - type
```
String type
```
      Specifies whether the Value parameter represents days, months, or years.
Package com.amazonaws.services.alexaforbusiness.model
- Class com.amazonaws.services.alexaforbusiness.model.AddressBook extends Object implements Serializable
  - Serialized Fields
    - addressBookArn
```
String addressBookArn
```
      The ARN of the address book.
    - name
```
String name
```
      The name of the address book.
    - description
```
String description
```
      The description of the address book.
- Class com.amazonaws.services.alexaforbusiness.model.AddressBookData extends Object implements Serializable
  - Serialized Fields
    - addressBookArn
```
String addressBookArn
```
      The ARN of the address book.
    - name
```
String name
```
      The name of the address book.
    - description
```
String description
```
      The description of the address book.
- Class com.amazonaws.services.alexaforbusiness.model.AlreadyExistsException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.AmazonAlexaForBusinessException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.ApproveSkillRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillId
```
String skillId
```
      The unique identifier of the skill.
- Class com.amazonaws.services.alexaforbusiness.model.ApproveSkillResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.AssociateContactWithAddressBookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - contactArn
```
String contactArn
```
      The ARN of the contact to associate with an address book.
    - addressBookArn
```
String addressBookArn
```
      The ARN of the address book with which to associate the contact.
- Class com.amazonaws.services.alexaforbusiness.model.AssociateContactWithAddressBookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.AssociateDeviceWithNetworkProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deviceArn
```
String deviceArn
```
      The device ARN.
    - networkProfileArn
```
String networkProfileArn
```
      The ARN of the network profile to associate with a device.
- Class com.amazonaws.services.alexaforbusiness.model.AssociateDeviceWithNetworkProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.AssociateDeviceWithRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deviceArn
```
String deviceArn
```
      The ARN of the device to associate to a room. Required.
    - roomArn
```
String roomArn
```
      The ARN of the room with which to associate the device. Required.
- Class com.amazonaws.services.alexaforbusiness.model.AssociateDeviceWithRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.AssociateSkillGroupWithRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillGroupArn
```
String skillGroupArn
```
      The ARN of the skill group to associate with a room. Required.
    - roomArn
```
String roomArn
```
      The ARN of the room with which to associate the skill group. Required.
- Class com.amazonaws.services.alexaforbusiness.model.AssociateSkillGroupWithRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.AssociateSkillWithSkillGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillGroupArn
```
String skillGroupArn
```
      The ARN of the skill group to associate the skill to. Required.
    - skillId
```
String skillId
```
      The unique identifier of the skill.
- Class com.amazonaws.services.alexaforbusiness.model.AssociateSkillWithSkillGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.AssociateSkillWithUsersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillId
```
String skillId
```
      The private skill ID you want to make available to enrolled users.
- Class com.amazonaws.services.alexaforbusiness.model.AssociateSkillWithUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.Audio extends Object implements Serializable
  - Serialized Fields
    - locale
```
String locale
```
      The locale of the audio message. Currently, en-US is supported.
    - location
```
String location
```
      The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.
- Class com.amazonaws.services.alexaforbusiness.model.BusinessReport extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).
    - failureCode
```
String failureCode
```
      The failure code.
    - s3Location
```
BusinessReportS3Location s3Location
```
      The S3 location of the output reports.
    - deliveryTime
```
Date deliveryTime
```
      The time of report delivery.
    - downloadUrl
```
String downloadUrl
```
      The download link where a user can download the report.
- Class com.amazonaws.services.alexaforbusiness.model.BusinessReportContentRange extends Object implements Serializable
  - Serialized Fields
    - interval
```
String interval
```
      The interval of the content range.
- Class com.amazonaws.services.alexaforbusiness.model.BusinessReportRecurrence extends Object implements Serializable
  - Serialized Fields
    - startDate
```
String startDate
```
      The start date.
- Class com.amazonaws.services.alexaforbusiness.model.BusinessReportS3Location extends Object implements Serializable
  - Serialized Fields
    - path
```
String path
```
      The path of the business report.
    - bucketName
```
String bucketName
```
      The S3 bucket name of the output reports.
- Class com.amazonaws.services.alexaforbusiness.model.BusinessReportSchedule extends Object implements Serializable
  - Serialized Fields
    - scheduleArn
```
String scheduleArn
```
      The ARN of the business report schedule.
    - scheduleName
```
String scheduleName
```
      The name identifier of the schedule.
    - s3BucketName
```
String s3BucketName
```
      The S3 bucket name of the output reports.
    - s3KeyPrefix
```
String s3KeyPrefix
```
      The S3 key where the report is delivered.
    - format
```
String format
```
      The format of the generated report (individual CSV files or zipped files of individual files).
    - contentRange
```
BusinessReportContentRange contentRange
```
      The content range of the reports.
    - recurrence
```
BusinessReportRecurrence recurrence
```
      The recurrence of the reports.
    - lastBusinessReport
```
BusinessReport lastBusinessReport
```
      The details of the last business report delivery for a specified time interval.
- Class com.amazonaws.services.alexaforbusiness.model.Category extends Object implements Serializable
  - Serialized Fields
    - categoryId
```
Long categoryId
```
      The ID of the skill store category.
    - categoryName
```
String categoryName
```
      The name of the skill store category.
- Class com.amazonaws.services.alexaforbusiness.model.ConcurrentModificationException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.ConferencePreference extends Object implements Serializable
  - Serialized Fields
    - defaultConferenceProviderArn
```
String defaultConferenceProviderArn
```
      The ARN of the default conference provider.
- Class com.amazonaws.services.alexaforbusiness.model.ConferenceProvider extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the newly created conference provider.
    - name
```
String name
```
      The name of the conference provider.
    - type
```
String type
```
      The type of conference providers.
    - iPDialIn
```
IPDialIn iPDialIn
```
      The IP endpoint and protocol for calling.
    - pSTNDialIn
```
PSTNDialIn pSTNDialIn
```
      The information for PSTN conferencing.
    - meetingSetting
```
MeetingSetting meetingSetting
```
      The meeting settings for the conference provider.
- Class com.amazonaws.services.alexaforbusiness.model.Contact extends Object implements Serializable
  - Serialized Fields
    - contactArn
```
String contactArn
```
      The ARN of the contact.
    - displayName
```
String displayName
```
      The name of the contact to display on the console.
    - firstName
```
String firstName
```
      The first name of the contact, used to call the contact on the device.
    - lastName
```
String lastName
```
      The last name of the contact, used to call the contact on the device.
    - phoneNumber
```
String phoneNumber
```
      The phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
    - phoneNumbers
```
List<E> phoneNumbers
```
      The list of phone numbers for the contact.
    - sipAddresses
```
List<E> sipAddresses
```
      The list of SIP addresses for the contact.
- Class com.amazonaws.services.alexaforbusiness.model.ContactData extends Object implements Serializable
  - Serialized Fields
    - contactArn
```
String contactArn
```
      The ARN of the contact.
    - displayName
```
String displayName
```
      The name of the contact to display on the console.
    - firstName
```
String firstName
```
      The first name of the contact, used to call the contact on the device.
    - lastName
```
String lastName
```
      The last name of the contact, used to call the contact on the device.
    - phoneNumber
```
String phoneNumber
```
      The phone number of the contact. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
    - phoneNumbers
```
List<E> phoneNumbers
```
      The list of phone numbers for the contact.
    - sipAddresses
```
List<E> sipAddresses
```
      The list of SIP addresses for the contact.
- Class com.amazonaws.services.alexaforbusiness.model.Content extends Object implements Serializable
  - Serialized Fields
    - textList
```
List<E> textList
```
      The list of text messages.
    - ssmlList
```
List<E> ssmlList
```
      The list of SSML messages.
    - audioList
```
List<E> audioList
```
      The list of audio messages.
- Class com.amazonaws.services.alexaforbusiness.model.CreateAddressBookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the address book.
    - description
```
String description
```
      The description of the address book.
    - clientRequestToken
```
String clientRequestToken
```
      A unique, user-specified identifier for the request that ensures idempotency.
- Class com.amazonaws.services.alexaforbusiness.model.CreateAddressBookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - addressBookArn
```
String addressBookArn
```
      The ARN of the newly created address book.
- Class com.amazonaws.services.alexaforbusiness.model.CreateBusinessReportScheduleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - scheduleName
```
String scheduleName
```
      The name identifier of the schedule.
    - s3BucketName
```
String s3BucketName
```
      The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.
    - s3KeyPrefix
```
String s3KeyPrefix
```
      The S3 key where the report is delivered.
    - format
```
String format
```
      The format of the generated report (individual CSV files or zipped files of individual files).
    - contentRange
```
BusinessReportContentRange contentRange
```
      The content range of the reports.
    - recurrence
```
BusinessReportRecurrence recurrence
```
      The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.
    - clientRequestToken
```
String clientRequestToken
```
      The client request token.
- Class com.amazonaws.services.alexaforbusiness.model.CreateBusinessReportScheduleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - scheduleArn
```
String scheduleArn
```
      The ARN of the business report schedule.
- Class com.amazonaws.services.alexaforbusiness.model.CreateConferenceProviderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - conferenceProviderName
```
String conferenceProviderName
```
      The name of the conference provider.
    - conferenceProviderType
```
String conferenceProviderType
```
      Represents a type within a list of predefined types.
    - iPDialIn
```
IPDialIn iPDialIn
```
      The IP endpoint and protocol for calling.
    - pSTNDialIn
```
PSTNDialIn pSTNDialIn
```
      The information for PSTN conferencing.
    - meetingSetting
```
MeetingSetting meetingSetting
```
      The meeting settings for the conference provider.
    - clientRequestToken
```
String clientRequestToken
```
      The request token of the client.
- Class com.amazonaws.services.alexaforbusiness.model.CreateConferenceProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - conferenceProviderArn
```
String conferenceProviderArn
```
      The ARN of the newly-created conference provider.
- Class com.amazonaws.services.alexaforbusiness.model.CreateContactRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - displayName
```
String displayName
```
      The name of the contact to display on the console.
    - firstName
```
String firstName
```
      The first name of the contact that is used to call the contact on the device.
    - lastName
```
String lastName
```
      The last name of the contact that is used to call the contact on the device.
    - phoneNumber
```
String phoneNumber
```
      The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
    - phoneNumbers
```
List<E> phoneNumbers
```
      The list of phone numbers for the contact.
    - sipAddresses
```
List<E> sipAddresses
```
      The list of SIP addresses for the contact.
    - clientRequestToken
```
String clientRequestToken
```
      A unique, user-specified identifier for this request that ensures idempotency.
- Class com.amazonaws.services.alexaforbusiness.model.CreateContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contactArn
```
String contactArn
```
      The ARN of the newly created address book.
- Class com.amazonaws.services.alexaforbusiness.model.CreateEndOfMeetingReminder extends Object implements Serializable
  - Serialized Fields
    - reminderAtMinutes
```
List<E> reminderAtMinutes
```
      A range of 3 to 15 minutes that determines when the reminder begins.
    - reminderType
```
String reminderType
```
      The type of sound that users hear during the end of meeting reminder.
    - enabled
```
Boolean enabled
```
      Whether an end of meeting reminder is enabled or not.
- Class com.amazonaws.services.alexaforbusiness.model.CreateGatewayGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the gateway group.
    - description
```
String description
```
      The description of the gateway group.
    - clientRequestToken
```
String clientRequestToken
```
      A unique, user-specified identifier for the request that ensures idempotency.
- Class com.amazonaws.services.alexaforbusiness.model.CreateGatewayGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - gatewayGroupArn
```
String gatewayGroupArn
```
      The ARN of the created gateway group.
- Class com.amazonaws.services.alexaforbusiness.model.CreateInstantBooking extends Object implements Serializable
  - Serialized Fields
    - durationInMinutes
```
Integer durationInMinutes
```
      Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.
    - enabled
```
Boolean enabled
```
      Whether instant booking is enabled or not.
- Class com.amazonaws.services.alexaforbusiness.model.CreateMeetingRoomConfiguration extends Object implements Serializable
  - Serialized Fields
    - roomUtilizationMetricsEnabled
```
Boolean roomUtilizationMetricsEnabled
```
      Whether room utilization metrics are enabled or not.
    - endOfMeetingReminder
```
CreateEndOfMeetingReminder endOfMeetingReminder
```
    - instantBooking
```
CreateInstantBooking instantBooking
```
      Settings to automatically book a room for a configured duration if it's free when joining a meeting with Alexa.
    - requireCheckIn
```
CreateRequireCheckIn requireCheckIn
```
      Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
- Class com.amazonaws.services.alexaforbusiness.model.CreateNetworkProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkProfileName
```
String networkProfileName
```
      The name of the network profile associated with a device.
    - description
```
String description
```
      Detailed information about a device's network profile.
    - ssid
```
String ssid
```
      The SSID of the Wi-Fi network.
    - securityType
```
String securityType
```
      The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
    - eapMethod
```
String eapMethod
```
      The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
    - currentPassword
```
String currentPassword
```
      The current password of the Wi-Fi network.
    - nextPassword
```
String nextPassword
```
      The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
    - trustAnchors
```
List<E> trustAnchors
```
      The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.
    - clientRequestToken
```
String clientRequestToken
```
- Class com.amazonaws.services.alexaforbusiness.model.CreateNetworkProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - networkProfileArn
```
String networkProfileArn
```
      The ARN of the network profile associated with a device.
- Class com.amazonaws.services.alexaforbusiness.model.CreateProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - profileName
```
String profileName
```
      The name of a room profile.
    - timezone
```
String timezone
```
      The time zone used by a room profile.
    - address
```
String address
```
      The valid address for the room.
    - distanceUnit
```
String distanceUnit
```
      The distance unit to be used by devices in the profile.
    - temperatureUnit
```
String temperatureUnit
```
      The temperature unit to be used by devices in the profile.
    - wakeWord
```
String wakeWord
```
      A wake word for Alexa, Echo, Amazon, or a computer.
    - locale
```
String locale
```
      The locale of the room profile. (This is currently only available to a limited preview audience.)
    - clientRequestToken
```
String clientRequestToken
```
      The user-specified token that is used during the creation of a profile.
    - setupModeDisabled
```
Boolean setupModeDisabled
```
      Whether room profile setup is enabled.
    - maxVolumeLimit
```
Integer maxVolumeLimit
```
      The maximum volume limit for a room profile.
    - pSTNEnabled
```
Boolean pSTNEnabled
```
      Whether PSTN calling is enabled.
    - meetingRoomConfiguration
```
CreateMeetingRoomConfiguration meetingRoomConfiguration
```
      The meeting room settings of a room profile.
- Class com.amazonaws.services.alexaforbusiness.model.CreateProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - profileArn
```
String profileArn
```
      The ARN of the newly created room profile in the response.
- Class com.amazonaws.services.alexaforbusiness.model.CreateRequireCheckIn extends Object implements Serializable
  - Serialized Fields
    - releaseAfterMinutes
```
Integer releaseAfterMinutes
```
      Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.
    - enabled
```
Boolean enabled
```
      Whether require check in is enabled or not.
- Class com.amazonaws.services.alexaforbusiness.model.CreateRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - roomName
```
String roomName
```
      The name for the room.
    - description
```
String description
```
      The description for the room.
    - profileArn
```
String profileArn
```
      The profile ARN for the room.
    - providerCalendarId
```
String providerCalendarId
```
      The calendar ARN for the room.
    - clientRequestToken
```
String clientRequestToken
```
      A unique, user-specified identifier for this request that ensures idempotency.
    - tags
```
List<E> tags
```
      The tags for the room.
- Class com.amazonaws.services.alexaforbusiness.model.CreateRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The ARN of the newly created room in the response.
- Class com.amazonaws.services.alexaforbusiness.model.CreateSkillGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillGroupName
```
String skillGroupName
```
      The name for the skill group.
    - description
```
String description
```
      The description for the skill group.
    - clientRequestToken
```
String clientRequestToken
```
      A unique, user-specified identifier for this request that ensures idempotency.
- Class com.amazonaws.services.alexaforbusiness.model.CreateSkillGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - skillGroupArn
```
String skillGroupArn
```
      The ARN of the newly created skill group in the response.
- Class com.amazonaws.services.alexaforbusiness.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userId
```
String userId
```
      The ARN for the user.
    - firstName
```
String firstName
```
      The first name for the user.
    - lastName
```
String lastName
```
      The last name for the user.
    - email
```
String email
```
      The email address for the user.
    - clientRequestToken
```
String clientRequestToken
```
      A unique, user-specified identifier for this request that ensures idempotency.
    - tags
```
List<E> tags
```
      The tags for the user.
- Class com.amazonaws.services.alexaforbusiness.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userArn
```
String userArn
```
      The ARN of the newly created user in the response.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteAddressBookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - addressBookArn
```
String addressBookArn
```
      The ARN of the address book to delete.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteAddressBookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteBusinessReportScheduleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - scheduleArn
```
String scheduleArn
```
      The ARN of the business report schedule.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteBusinessReportScheduleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteConferenceProviderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - conferenceProviderArn
```
String conferenceProviderArn
```
      The ARN of the conference provider.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteConferenceProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteContactRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - contactArn
```
String contactArn
```
      The ARN of the contact to delete.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteDeviceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deviceArn
```
String deviceArn
```
      The ARN of the device for which to request details.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteDeviceUsageDataRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deviceArn
```
String deviceArn
```
      The ARN of the device.
    - deviceUsageType
```
String deviceUsageType
```
      The type of usage data to delete.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteDeviceUsageDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteGatewayGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - gatewayGroupArn
```
String gatewayGroupArn
```
      The ARN of the gateway group to delete.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteGatewayGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteNetworkProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkProfileArn
```
String networkProfileArn
```
      The ARN of the network profile associated with a device.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteNetworkProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - profileArn
```
String profileArn
```
      The ARN of the room profile to delete. Required.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The ARN of the room to delete. Required.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteRoomSkillParameterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The ARN of the room from which to remove the room skill parameter details.
    - skillId
```
String skillId
```
      The ID of the skill from which to remove the room skill parameter details.
    - parameterKey
```
String parameterKey
```
      The room skill parameter key for which to remove details.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteRoomSkillParameterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteSkillAuthorizationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillId
```
String skillId
```
      The unique identifier of a skill.
    - roomArn
```
String roomArn
```
      The room that the skill is authorized for.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteSkillAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteSkillGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillGroupArn
```
String skillGroupArn
```
      The ARN of the skill group to delete. Required.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteSkillGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userArn
```
String userArn
```
      The ARN of the user to delete in the organization. Required.
    - enrollmentId
```
String enrollmentId
```
      The ARN of the user's enrollment in the organization. Required.
- Class com.amazonaws.services.alexaforbusiness.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DeveloperInfo extends Object implements Serializable
  - Serialized Fields
    - developerName
```
String developerName
```
      The name of the developer.
    - privacyPolicy
```
String privacyPolicy
```
      The URL of the privacy policy.
    - email
```
String email
```
      The email of the developer.
    - url
```
String url
```
      The website of the developer.
- Class com.amazonaws.services.alexaforbusiness.model.Device extends Object implements Serializable
  - Serialized Fields
    - deviceArn
```
String deviceArn
```
      The ARN of a device.
    - deviceSerialNumber
```
String deviceSerialNumber
```
      The serial number of a device.
    - deviceType
```
String deviceType
```
      The type of a device.
    - deviceName
```
String deviceName
```
      The name of a device.
    - softwareVersion
```
String softwareVersion
```
      The software version of a device.
    - macAddress
```
String macAddress
```
      The MAC address of a device.
    - roomArn
```
String roomArn
```
      The room ARN of a device.
    - deviceStatus
```
String deviceStatus
```
      The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.
    - deviceStatusInfo
```
DeviceStatusInfo deviceStatusInfo
```
      Detailed information about a device's status.
    - networkProfileInfo
```
DeviceNetworkProfileInfo networkProfileInfo
```
      Detailed information about a device's network profile.
- Class com.amazonaws.services.alexaforbusiness.model.DeviceData extends Object implements Serializable
  - Serialized Fields
    - deviceArn
```
String deviceArn
```
      The ARN of a device.
    - deviceSerialNumber
```
String deviceSerialNumber
```
      The serial number of a device.
    - deviceType
```
String deviceType
```
      The type of a device.
    - deviceName
```
String deviceName
```
      The name of a device.
    - softwareVersion
```
String softwareVersion
```
      The software version of a device.
    - macAddress
```
String macAddress
```
      The MAC address of a device.
    - deviceStatus
```
String deviceStatus
```
      The status of a device.
    - networkProfileArn
```
String networkProfileArn
```
      The ARN of the network profile associated with a device.
    - networkProfileName
```
String networkProfileName
```
      The name of the network profile associated with a device.
    - roomArn
```
String roomArn
```
      The room ARN associated with a device.
    - roomName
```
String roomName
```
      The name of the room associated with a device.
    - deviceStatusInfo
```
DeviceStatusInfo deviceStatusInfo
```
      Detailed information about a device's status.
    - createdTime
```
Date createdTime
```
      The time (in epoch) when the device data was created.
- Class com.amazonaws.services.alexaforbusiness.model.DeviceEvent extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of device event.
    - value
```
String value
```
      The value of the event.
    - timestamp
```
Date timestamp
```
      The time (in epoch) when the event occurred.
- Class com.amazonaws.services.alexaforbusiness.model.DeviceNetworkProfileInfo extends Object implements Serializable
  - Serialized Fields
    - networkProfileArn
```
String networkProfileArn
```
      The ARN of the network profile associated with a device.
    - certificateArn
```
String certificateArn
```
      The ARN of the certificate associated with a device.
    - certificateExpirationTime
```
Date certificateExpirationTime
```
      The time (in epoch) when the certificate expires.
- Class com.amazonaws.services.alexaforbusiness.model.DeviceNotRegisteredException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.DeviceStatusDetail extends Object implements Serializable
  - Serialized Fields
    - feature
```
String feature
```
      The list of available features on the device.
    - code
```
String code
```
      The device status detail code.
- Class com.amazonaws.services.alexaforbusiness.model.DeviceStatusInfo extends Object implements Serializable
  - Serialized Fields
    - deviceStatusDetails
```
List<E> deviceStatusDetails
```
      One or more device status detail descriptions.
    - connectionStatus
```
String connectionStatus
```
      The latest available information about the connection status of a device.
    - connectionStatusUpdatedTime
```
Date connectionStatusUpdatedTime
```
      The time (in epoch) when the device connection status changed.
- Class com.amazonaws.services.alexaforbusiness.model.DisassociateContactFromAddressBookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - contactArn
```
String contactArn
```
      The ARN of the contact to disassociate from an address book.
    - addressBookArn
```
String addressBookArn
```
      The ARN of the address from which to disassociate the contact.
- Class com.amazonaws.services.alexaforbusiness.model.DisassociateContactFromAddressBookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DisassociateDeviceFromRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deviceArn
```
String deviceArn
```
      The ARN of the device to disassociate from a room. Required.
- Class com.amazonaws.services.alexaforbusiness.model.DisassociateDeviceFromRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DisassociateSkillFromSkillGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillGroupArn
```
String skillGroupArn
```
      The unique identifier of a skill. Required.
    - skillId
```
String skillId
```
      The ARN of a skill group to associate to a skill.
- Class com.amazonaws.services.alexaforbusiness.model.DisassociateSkillFromSkillGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DisassociateSkillFromUsersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillId
```
String skillId
```
      The private skill ID you want to make unavailable for enrolled users.
- Class com.amazonaws.services.alexaforbusiness.model.DisassociateSkillFromUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.DisassociateSkillGroupFromRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillGroupArn
```
String skillGroupArn
```
      The ARN of the skill group to disassociate from a room. Required.
    - roomArn
```
String roomArn
```
      The ARN of the room from which the skill group is to be disassociated. Required.
- Class com.amazonaws.services.alexaforbusiness.model.DisassociateSkillGroupFromRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.EndOfMeetingReminder extends Object implements Serializable
  - Serialized Fields
    - reminderAtMinutes
```
List<E> reminderAtMinutes
```
      A range of 3 to 15 minutes that determines when the reminder begins.
    - reminderType
```
String reminderType
```
      The type of sound that users hear during the end of meeting reminder.
    - enabled
```
Boolean enabled
```
      Whether an end of meeting reminder is enabled or not.
- Class com.amazonaws.services.alexaforbusiness.model.Filter extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The key of a filter.
    - values
```
List<E> values
```
      The values of a filter.
- Class com.amazonaws.services.alexaforbusiness.model.ForgetSmartHomeAppliancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The room that the appliances are associated with.
- Class com.amazonaws.services.alexaforbusiness.model.ForgetSmartHomeAppliancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.Gateway extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the gateway.
    - name
```
String name
```
      The name of the gateway.
    - description
```
String description
```
      The description of the gateway.
    - gatewayGroupArn
```
String gatewayGroupArn
```
      The ARN of the gateway group that the gateway is associated to.
    - softwareVersion
```
String softwareVersion
```
      The software version of the gateway. The gateway automatically updates its software version during normal operation.
- Class com.amazonaws.services.alexaforbusiness.model.GatewayGroup extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the gateway group.
    - name
```
String name
```
      The name of the gateway group.
    - description
```
String description
```
      The description of the gateway group.
- Class com.amazonaws.services.alexaforbusiness.model.GatewayGroupSummary extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the gateway group.
    - name
```
String name
```
      The name of the gateway group.
    - description
```
String description
```
      The description of the gateway group.
- Class com.amazonaws.services.alexaforbusiness.model.GatewaySummary extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the gateway.
    - name
```
String name
```
      The name of the gateway.
    - description
```
String description
```
      The description of the gateway.
    - gatewayGroupArn
```
String gatewayGroupArn
```
      The ARN of the gateway group that the gateway is associated to.
    - softwareVersion
```
String softwareVersion
```
      The software version of the gateway. The gateway automatically updates its software version during normal operation.
- Class com.amazonaws.services.alexaforbusiness.model.GetAddressBookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - addressBookArn
```
String addressBookArn
```
      The ARN of the address book for which to request details.
- Class com.amazonaws.services.alexaforbusiness.model.GetAddressBookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - addressBook
```
AddressBook addressBook
```
      The details of the requested address book.
- Class com.amazonaws.services.alexaforbusiness.model.GetConferencePreferenceRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.GetConferencePreferenceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - preference
```
ConferencePreference preference
```
      The conference preference.
- Class com.amazonaws.services.alexaforbusiness.model.GetConferenceProviderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - conferenceProviderArn
```
String conferenceProviderArn
```
      The ARN of the newly created conference provider.
- Class com.amazonaws.services.alexaforbusiness.model.GetConferenceProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - conferenceProvider
```
ConferenceProvider conferenceProvider
```
      The conference provider.
- Class com.amazonaws.services.alexaforbusiness.model.GetContactRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - contactArn
```
String contactArn
```
      The ARN of the contact for which to request details.
- Class com.amazonaws.services.alexaforbusiness.model.GetContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contact
```
Contact contact
```
      The details of the requested contact.
- Class com.amazonaws.services.alexaforbusiness.model.GetDeviceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deviceArn
```
String deviceArn
```
      The ARN of the device for which to request details. Required.
- Class com.amazonaws.services.alexaforbusiness.model.GetDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - device
```
Device device
```
      The details of the device requested. Required.
- Class com.amazonaws.services.alexaforbusiness.model.GetGatewayGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - gatewayGroupArn
```
String gatewayGroupArn
```
      The ARN of the gateway group to get.
- Class com.amazonaws.services.alexaforbusiness.model.GetGatewayGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - gatewayGroup
```
GatewayGroup gatewayGroup
```
- Class com.amazonaws.services.alexaforbusiness.model.GetGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - gatewayArn
```
String gatewayArn
```
      The ARN of the gateway to get.
- Class com.amazonaws.services.alexaforbusiness.model.GetGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - gateway
```
Gateway gateway
```
      The details of the gateway.
- Class com.amazonaws.services.alexaforbusiness.model.GetInvitationConfigurationRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.GetInvitationConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - organizationName
```
String organizationName
```
      The name of the organization sending the enrollment invite to a user.
    - contactEmail
```
String contactEmail
```
      The email ID of the organization or individual contact that the enrolled user can use.
    - privateSkillIds
```
List<E> privateSkillIds
```
      The list of private skill IDs that you want to recommend to the user to enable in the invitation.
- Class com.amazonaws.services.alexaforbusiness.model.GetNetworkProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkProfileArn
```
String networkProfileArn
```
      The ARN of the network profile associated with a device.
- Class com.amazonaws.services.alexaforbusiness.model.GetNetworkProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - networkProfile
```
NetworkProfile networkProfile
```
      The network profile associated with a device.
- Class com.amazonaws.services.alexaforbusiness.model.GetProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - profileArn
```
String profileArn
```
      The ARN of the room profile for which to request details. Required.
- Class com.amazonaws.services.alexaforbusiness.model.GetProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - profile
```
Profile profile
```
      The details of the room profile requested. Required.
- Class com.amazonaws.services.alexaforbusiness.model.GetRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The ARN of the room for which to request details. Required.
- Class com.amazonaws.services.alexaforbusiness.model.GetRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - room
```
Room room
```
      The details of the room requested.
- Class com.amazonaws.services.alexaforbusiness.model.GetRoomSkillParameterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The ARN of the room from which to get the room skill parameter details.
    - skillId
```
String skillId
```
      The ARN of the skill from which to get the room skill parameter details. Required.
    - parameterKey
```
String parameterKey
```
      The room skill parameter key for which to get details. Required.
- Class com.amazonaws.services.alexaforbusiness.model.GetRoomSkillParameterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - roomSkillParameter
```
RoomSkillParameter roomSkillParameter
```
      The details of the room skill parameter requested. Required.
- Class com.amazonaws.services.alexaforbusiness.model.GetSkillGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillGroupArn
```
String skillGroupArn
```
      The ARN of the skill group for which to get details. Required.
- Class com.amazonaws.services.alexaforbusiness.model.GetSkillGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - skillGroup
```
SkillGroup skillGroup
```
      The details of the skill group requested. Required.
- Class com.amazonaws.services.alexaforbusiness.model.InstantBooking extends Object implements Serializable
  - Serialized Fields
    - durationInMinutes
```
Integer durationInMinutes
```
      Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.
    - enabled
```
Boolean enabled
```
      Whether instant booking is enabled or not.
- Class com.amazonaws.services.alexaforbusiness.model.InvalidCertificateAuthorityException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.InvalidDeviceException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.InvalidSecretsManagerResourceException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.InvalidServiceLinkedRoleStateException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.InvalidUserStatusException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.IPDialIn extends Object implements Serializable
  - Serialized Fields
    - endpoint
```
String endpoint
```
      The IP address.
    - commsProtocol
```
String commsProtocol
```
      The protocol, including SIP, SIPS, and H323.
- Class com.amazonaws.services.alexaforbusiness.model.LimitExceededException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.ListBusinessReportSchedulesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The token used to list the remaining schedules from the previous API call.
    - maxResults
```
Integer maxResults
```
      The maximum number of schedules listed in the call.
- Class com.amazonaws.services.alexaforbusiness.model.ListBusinessReportSchedulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - businessReportSchedules
```
List<E> businessReportSchedules
```
      The schedule of the reports.
    - nextToken
```
String nextToken
```
      The token used to list the remaining schedules from the previous API call.
- Class com.amazonaws.services.alexaforbusiness.model.ListConferenceProvidersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The tokens used for pagination.
    - maxResults
```
Integer maxResults
```
      The maximum number of conference providers to be returned, per paginated calls.
- Class com.amazonaws.services.alexaforbusiness.model.ListConferenceProvidersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - conferenceProviders
```
List<E> conferenceProviders
```
      The conference providers.
    - nextToken
```
String nextToken
```
      The tokens used for pagination.
- Class com.amazonaws.services.alexaforbusiness.model.ListDeviceEventsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deviceArn
```
String deviceArn
```
      The ARN of a device.
    - eventType
```
String eventType
```
      The event type to filter device events. If EventType isn't specified, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order.
    - nextToken
```
String nextToken
```
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults. When the end of results is reached, the response has a value of null.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response. The default value is 50. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
- Class com.amazonaws.services.alexaforbusiness.model.ListDeviceEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - deviceEvents
```
List<E> deviceEvents
```
      The device events requested for the device ARN.
    - nextToken
```
String nextToken
```
      The token returned to indicate that there is more data available.
- Class com.amazonaws.services.alexaforbusiness.model.ListGatewayGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The token used to paginate though multiple pages of gateway group summaries.
    - maxResults
```
Integer maxResults
```
      The maximum number of gateway group summaries to return. The default is 50.
- Class com.amazonaws.services.alexaforbusiness.model.ListGatewayGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - gatewayGroups
```
List<E> gatewayGroups
```
      The gateway groups in the list.
    - nextToken
```
String nextToken
```
      The token used to paginate though multiple pages of gateway group summaries.
- Class com.amazonaws.services.alexaforbusiness.model.ListGatewaysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - gatewayGroupArn
```
String gatewayGroupArn
```
      The gateway group ARN for which to list gateways.
    - nextToken
```
String nextToken
```
      The token used to paginate though multiple pages of gateway summaries.
    - maxResults
```
Integer maxResults
```
      The maximum number of gateway summaries to return. The default is 50.
- Class com.amazonaws.services.alexaforbusiness.model.ListGatewaysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - gateways
```
List<E> gateways
```
      The gateways in the list.
    - nextToken
```
String nextToken
```
      The token used to paginate though multiple pages of gateway summaries.
- Class com.amazonaws.services.alexaforbusiness.model.ListSkillsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillGroupArn
```
String skillGroupArn
```
      The ARN of the skill group for which to list enabled skills.
    - enablementType
```
String enablementType
```
      Whether the skill is enabled under the user's account.
    - skillType
```
String skillType
```
      Whether the skill is publicly available or is a private skill.
    - nextToken
```
String nextToken
```
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
- Class com.amazonaws.services.alexaforbusiness.model.ListSkillsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - skillSummaries
```
List<E> skillSummaries
```
      The list of enabled skills requested. Required.
    - nextToken
```
String nextToken
```
      The token returned to indicate that there is more data available.
- Class com.amazonaws.services.alexaforbusiness.model.ListSkillsStoreCategoriesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The tokens used for pagination.
    - maxResults
```
Integer maxResults
```
      The maximum number of categories returned, per paginated calls.
- Class com.amazonaws.services.alexaforbusiness.model.ListSkillsStoreCategoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - categoryList
```
List<E> categoryList
```
      The list of categories.
    - nextToken
```
String nextToken
```
      The tokens used for pagination.
- Class com.amazonaws.services.alexaforbusiness.model.ListSkillsStoreSkillsByCategoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - categoryId
```
Long categoryId
```
      The category ID for which the skills are being retrieved from the skill store.
    - nextToken
```
String nextToken
```
      The tokens used for pagination.
    - maxResults
```
Integer maxResults
```
      The maximum number of skills returned per paginated calls.
- Class com.amazonaws.services.alexaforbusiness.model.ListSkillsStoreSkillsByCategoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - skillsStoreSkills
```
List<E> skillsStoreSkills
```
      The skill store skills.
    - nextToken
```
String nextToken
```
      The tokens used for pagination.
- Class com.amazonaws.services.alexaforbusiness.model.ListSmartHomeAppliancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The room that the appliances are associated with.
    - maxResults
```
Integer maxResults
```
      The maximum number of appliances to be returned, per paginated calls.
    - nextToken
```
String nextToken
```
      The tokens used for pagination.
- Class com.amazonaws.services.alexaforbusiness.model.ListSmartHomeAppliancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - smartHomeAppliances
```
List<E> smartHomeAppliances
```
      The smart home appliances.
    - nextToken
```
String nextToken
```
      The tokens used for pagination.
- Class com.amazonaws.services.alexaforbusiness.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the specified resource for which to list tags.
    - nextToken
```
String nextToken
```
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
- Class com.amazonaws.services.alexaforbusiness.model.ListTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
List<E> tags
```
      The tags requested for the specified resource.
    - nextToken
```
String nextToken
```
      The token returned to indicate that there is more data available.
- Class com.amazonaws.services.alexaforbusiness.model.MeetingRoomConfiguration extends Object implements Serializable
  - Serialized Fields
    - roomUtilizationMetricsEnabled
```
Boolean roomUtilizationMetricsEnabled
```
      Whether room utilization metrics are enabled or not.
    - endOfMeetingReminder
```
EndOfMeetingReminder endOfMeetingReminder
```
      Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
    - instantBooking
```
InstantBooking instantBooking
```
      Settings to automatically book the room if available for a configured duration when joining a meeting with Alexa.
    - requireCheckIn
```
RequireCheckIn requireCheckIn
```
      Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into. This makes the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
- Class com.amazonaws.services.alexaforbusiness.model.MeetingSetting extends Object implements Serializable
  - Serialized Fields
    - requirePin
```
String requirePin
```
      The values that indicate whether the pin is always required.
- Class com.amazonaws.services.alexaforbusiness.model.NameInUseException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.NetworkProfile extends Object implements Serializable
  - Serialized Fields
    - networkProfileArn
```
String networkProfileArn
```
      The ARN of the network profile associated with a device.
    - networkProfileName
```
String networkProfileName
```
      The name of the network profile associated with a device.
    - description
```
String description
```
      Detailed information about a device's network profile.
    - ssid
```
String ssid
```
      The SSID of the Wi-Fi network.
    - securityType
```
String securityType
```
      The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
    - eapMethod
```
String eapMethod
```
      The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
    - currentPassword
```
String currentPassword
```
      The current password of the Wi-Fi network.
    - nextPassword
```
String nextPassword
```
      The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
    - trustAnchors
```
List<E> trustAnchors
```
      The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.
- Class com.amazonaws.services.alexaforbusiness.model.NetworkProfileData extends Object implements Serializable
  - Serialized Fields
    - networkProfileArn
```
String networkProfileArn
```
      The ARN of the network profile associated with a device.
    - networkProfileName
```
String networkProfileName
```
      The name of the network profile associated with a device.
    - description
```
String description
```
      Detailed information about a device's network profile.
    - ssid
```
String ssid
```
      The SSID of the Wi-Fi network.
    - securityType
```
String securityType
```
      The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.
    - eapMethod
```
String eapMethod
```
      The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
- Class com.amazonaws.services.alexaforbusiness.model.NotFoundException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.PhoneNumber extends Object implements Serializable
  - Serialized Fields
    - number
```
String number
```
      The raw value of the phone number.
    - type
```
String type
```
      The type of the phone number.
- Class com.amazonaws.services.alexaforbusiness.model.Profile extends Object implements Serializable
  - Serialized Fields
    - profileArn
```
String profileArn
```
      The ARN of a room profile.
    - profileName
```
String profileName
```
      The name of a room profile.
    - isDefault
```
Boolean isDefault
```
      Retrieves if the profile is default or not.
    - address
```
String address
```
      The address of a room profile.
    - timezone
```
String timezone
```
      The time zone of a room profile.
    - distanceUnit
```
String distanceUnit
```
      The distance unit of a room profile.
    - temperatureUnit
```
String temperatureUnit
```
      The temperature unit of a room profile.
    - wakeWord
```
String wakeWord
```
      The wake word of a room profile.
    - locale
```
String locale
```
      The locale of a room profile. (This is currently available only to a limited preview audience.)
    - setupModeDisabled
```
Boolean setupModeDisabled
```
      The setup mode of a room profile.
    - maxVolumeLimit
```
Integer maxVolumeLimit
```
      The max volume limit of a room profile.
    - pSTNEnabled
```
Boolean pSTNEnabled
```
      The PSTN setting of a room profile.
    - addressBookArn
```
String addressBookArn
```
      The ARN of the address book.
    - meetingRoomConfiguration
```
MeetingRoomConfiguration meetingRoomConfiguration
```
      Meeting room settings of a room profile.
- Class com.amazonaws.services.alexaforbusiness.model.ProfileData extends Object implements Serializable
  - Serialized Fields
    - profileArn
```
String profileArn
```
      The ARN of a room profile.
    - profileName
```
String profileName
```
      The name of a room profile.
    - isDefault
```
Boolean isDefault
```
      Retrieves if the profile data is default or not.
    - address
```
String address
```
      The address of a room profile.
    - timezone
```
String timezone
```
      The time zone of a room profile.
    - distanceUnit
```
String distanceUnit
```
      The distance unit of a room profile.
    - temperatureUnit
```
String temperatureUnit
```
      The temperature unit of a room profile.
    - wakeWord
```
String wakeWord
```
      The wake word of a room profile.
    - locale
```
String locale
```
      The locale of a room profile. (This is currently available only to a limited preview audience.)
- Class com.amazonaws.services.alexaforbusiness.model.PSTNDialIn extends Object implements Serializable
  - Serialized Fields
    - countryCode
```
String countryCode
```
      The zip code.
    - phoneNumber
```
String phoneNumber
```
      The phone number to call to join the conference.
    - oneClickIdDelay
```
String oneClickIdDelay
```
      The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.
    - oneClickPinDelay
```
String oneClickPinDelay
```
      The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.
- Class com.amazonaws.services.alexaforbusiness.model.PutConferencePreferenceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - conferencePreference
```
ConferencePreference conferencePreference
```
      The conference preference of a specific conference provider.
- Class com.amazonaws.services.alexaforbusiness.model.PutConferencePreferenceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.PutInvitationConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - organizationName
```
String organizationName
```
      The name of the organization sending the enrollment invite to a user.
    - contactEmail
```
String contactEmail
```
      The email ID of the organization or individual contact that the enrolled user can use.
    - privateSkillIds
```
List<E> privateSkillIds
```
      The list of private skill IDs that you want to recommend to the user to enable in the invitation.
- Class com.amazonaws.services.alexaforbusiness.model.PutInvitationConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.PutRoomSkillParameterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The ARN of the room associated with the room skill parameter. Required.
    - skillId
```
String skillId
```
      The ARN of the skill associated with the room skill parameter. Required.
    - roomSkillParameter
```
RoomSkillParameter roomSkillParameter
```
      The updated room skill parameter. Required.
- Class com.amazonaws.services.alexaforbusiness.model.PutRoomSkillParameterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.PutSkillAuthorizationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - authorizationResult
```
Map<K,V> authorizationResult
```
      The authorization result specific to OAUTH code grant output. "Code” must be populated in the AuthorizationResult map to establish the authorization.
    - skillId
```
String skillId
```
      The unique identifier of a skill.
    - roomArn
```
String roomArn
```
      The room that the skill is authorized for.
- Class com.amazonaws.services.alexaforbusiness.model.PutSkillAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.RegisterAVSDeviceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The client ID of the OEM used for code-based linking authorization on an AVS device.
    - userCode
```
String userCode
```
      The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.
    - productId
```
String productId
```
      The product ID used to identify your AVS device during authorization.
    - deviceSerialNumber
```
String deviceSerialNumber
```
      The key generated by the OEM that uniquely identifies a specified instance of your AVS device.
    - amazonId
```
String amazonId
```
      The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.
- Class com.amazonaws.services.alexaforbusiness.model.RegisterAVSDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - deviceArn
```
String deviceArn
```
      The ARN of the device.
- Class com.amazonaws.services.alexaforbusiness.model.RejectSkillRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillId
```
String skillId
```
      The unique identifier of the skill.
- Class com.amazonaws.services.alexaforbusiness.model.RejectSkillResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.RequireCheckIn extends Object implements Serializable
  - Serialized Fields
    - releaseAfterMinutes
```
Integer releaseAfterMinutes
```
      Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.
    - enabled
```
Boolean enabled
```
      Whether require check in is enabled or not.
- Class com.amazonaws.services.alexaforbusiness.model.ResolveRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userId
```
String userId
```
      The ARN of the user. Required.
    - skillId
```
String skillId
```
      The ARN of the skill that was requested. Required.
- Class com.amazonaws.services.alexaforbusiness.model.ResolveRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The ARN of the room from which the skill request was invoked.
    - roomName
```
String roomName
```
      The name of the room from which the skill request was invoked.
    - roomSkillParameters
```
List<E> roomSkillParameters
```
      Response to get the room profile request. Required.
- Class com.amazonaws.services.alexaforbusiness.model.ResourceAssociatedException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.ResourceInUseException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - clientRequestToken
```
String clientRequestToken
```
- Class com.amazonaws.services.alexaforbusiness.model.RevokeInvitationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userArn
```
String userArn
```
      The ARN of the user for whom to revoke an enrollment invitation. Required.
    - enrollmentId
```
String enrollmentId
```
      The ARN of the enrollment invitation to revoke. Required.
- Class com.amazonaws.services.alexaforbusiness.model.RevokeInvitationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.Room extends Object implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The ARN of a room.
    - roomName
```
String roomName
```
      The name of a room.
    - description
```
String description
```
      The description of a room.
    - providerCalendarId
```
String providerCalendarId
```
      The provider calendar ARN of a room.
    - profileArn
```
String profileArn
```
      The profile ARN of a room.
- Class com.amazonaws.services.alexaforbusiness.model.RoomData extends Object implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The ARN of a room.
    - roomName
```
String roomName
```
      The name of a room.
    - description
```
String description
```
      The description of a room.
    - providerCalendarId
```
String providerCalendarId
```
      The provider calendar ARN of a room.
    - profileArn
```
String profileArn
```
      The profile ARN of a room.
    - profileName
```
String profileName
```
      The profile name of a room.
- Class com.amazonaws.services.alexaforbusiness.model.RoomSkillParameter extends Object implements Serializable
  - Serialized Fields
    - parameterKey
```
String parameterKey
```
      The parameter key of a room skill parameter. ParameterKey is an enumerated type that only takes “DEFAULT” or “SCOPE” as valid values.
    - parameterValue
```
String parameterValue
```
      The parameter value of a room skill parameter.
- Class com.amazonaws.services.alexaforbusiness.model.SearchAddressBooksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
List<E> filters
```
      The filters to use to list a specified set of address books. The supported filter key is AddressBookName.
    - sortCriteria
```
List<E> sortCriteria
```
      The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.
    - nextToken
```
String nextToken
```
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
- Class com.amazonaws.services.alexaforbusiness.model.SearchAddressBooksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - addressBooks
```
List<E> addressBooks
```
      The address books that meet the specified set of filter criteria, in sort order.
    - nextToken
```
String nextToken
```
      The token returned to indicate that there is more data available.
    - totalCount
```
Integer totalCount
```
      The total number of address books returned.
- Class com.amazonaws.services.alexaforbusiness.model.SearchContactsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
List<E> filters
```
      The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.
    - sortCriteria
```
List<E> sortCriteria
```
      The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.
    - nextToken
```
String nextToken
```
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
- Class com.amazonaws.services.alexaforbusiness.model.SearchContactsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contacts
```
List<E> contacts
```
      The contacts that meet the specified set of filter criteria, in sort order.
    - nextToken
```
String nextToken
```
      The token returned to indicate that there is more data available.
    - totalCount
```
Integer totalCount
```
      The total number of contacts returned.
- Class com.amazonaws.services.alexaforbusiness.model.SearchDevicesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
    - filters
```
List<E> filters
```
      The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
    - sortCriteria
```
List<E> sortCriteria
```
      The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.
- Class com.amazonaws.services.alexaforbusiness.model.SearchDevicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - devices
```
List<E> devices
```
      The devices that meet the specified set of filter criteria, in sort order.
    - nextToken
```
String nextToken
```
      The token returned to indicate that there is more data available.
    - totalCount
```
Integer totalCount
```
      The total number of devices returned.
- Class com.amazonaws.services.alexaforbusiness.model.SearchNetworkProfilesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
    - filters
```
List<E> filters
```
      The filters to use to list a specified set of network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.
    - sortCriteria
```
List<E> sortCriteria
```
      The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.
- Class com.amazonaws.services.alexaforbusiness.model.SearchNetworkProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - networkProfiles
```
List<E> networkProfiles
```
      The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.
    - nextToken
```
String nextToken
```
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
    - totalCount
```
Integer totalCount
```
      The total number of network profiles returned.
- Class com.amazonaws.services.alexaforbusiness.model.SearchProfilesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
    - filters
```
List<E> filters
```
      The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required.
    - sortCriteria
```
List<E> sortCriteria
```
      The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.
- Class com.amazonaws.services.alexaforbusiness.model.SearchProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - profiles
```
List<E> profiles
```
      The profiles that meet the specified set of filter criteria, in sort order.
    - nextToken
```
String nextToken
```
      The token returned to indicate that there is more data available.
    - totalCount
```
Integer totalCount
```
      The total number of room profiles returned.
- Class com.amazonaws.services.alexaforbusiness.model.SearchRoomsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
    - filters
```
List<E> filters
```
      The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.
    - sortCriteria
```
List<E> sortCriteria
```
      The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.
- Class com.amazonaws.services.alexaforbusiness.model.SearchRoomsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - rooms
```
List<E> rooms
```
      The rooms that meet the specified set of filter criteria, in sort order.
    - nextToken
```
String nextToken
```
      The token returned to indicate that there is more data available.
    - totalCount
```
Integer totalCount
```
      The total number of rooms returned.
- Class com.amazonaws.services.alexaforbusiness.model.SearchSkillGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
    - filters
```
List<E> filters
```
      The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName.
    - sortCriteria
```
List<E> sortCriteria
```
      The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName.
- Class com.amazonaws.services.alexaforbusiness.model.SearchSkillGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - skillGroups
```
List<E> skillGroups
```
      The skill groups that meet the filter criteria, in sort order.
    - nextToken
```
String nextToken
```
      The token returned to indicate that there is more data available.
    - totalCount
```
Integer totalCount
```
      The total number of skill groups returned.
- Class com.amazonaws.services.alexaforbusiness.model.SearchUsersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Required.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required.
    - filters
```
List<E> filters
```
      The filters to use for listing a specific set of users. Required. Supported filter keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
    - sortCriteria
```
List<E> sortCriteria
```
      The sort order to use in listing the filtered set of users. Required. Supported sort keys are UserId, FirstName, LastName, Email, and EnrollmentStatus.
- Class com.amazonaws.services.alexaforbusiness.model.SearchUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - users
```
List<E> users
```
      The users that meet the specified set of filter criteria, in sort order.
    - nextToken
```
String nextToken
```
      The token returned to indicate that there is more data available.
    - totalCount
```
Integer totalCount
```
      The total number of users returned.
- Class com.amazonaws.services.alexaforbusiness.model.SendAnnouncementRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - roomFilters
```
List<E> roomFilters
```
      The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.
    - content
```
Content content
```
      The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).
    - timeToLiveInSeconds
```
Integer timeToLiveInSeconds
```
      The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.
    - clientRequestToken
```
String clientRequestToken
```
      The unique, user-specified identifier for the request that ensures idempotency.
- Class com.amazonaws.services.alexaforbusiness.model.SendAnnouncementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - announcementArn
```
String announcementArn
```
      The identifier of the announcement.
- Class com.amazonaws.services.alexaforbusiness.model.SendInvitationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userArn
```
String userArn
```
      The ARN of the user to whom to send an invitation. Required.
- Class com.amazonaws.services.alexaforbusiness.model.SendInvitationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.SipAddress extends Object implements Serializable
  - Serialized Fields
    - uri
```
String uri
```
      The URI for the SIP address.
    - type
```
String type
```
      The type of the SIP address.
- Class com.amazonaws.services.alexaforbusiness.model.SkillDetails extends Object implements Serializable
  - Serialized Fields
    - productDescription
```
String productDescription
```
      The description of the product.
    - invocationPhrase
```
String invocationPhrase
```
      The phrase used to trigger the skill.
    - releaseDate
```
String releaseDate
```
      The date when the skill was released.
    - endUserLicenseAgreement
```
String endUserLicenseAgreement
```
      The URL of the end user license agreement.
    - genericKeywords
```
List<E> genericKeywords
```
      The generic keywords associated with the skill that can be used to find a skill.
    - bulletPoints
```
List<E> bulletPoints
```
      The details about what the skill supports organized as bullet points.
    - newInThisVersionBulletPoints
```
List<E> newInThisVersionBulletPoints
```
      The updates added in bullet points.
    - skillTypes
```
List<E> skillTypes
```
      The types of skills.
    - reviews
```
Map<K,V> reviews
```
      The list of reviews for the skill, including Key and Value pair.
    - developerInfo
```
DeveloperInfo developerInfo
```
      The details about the developer that published the skill.
- Class com.amazonaws.services.alexaforbusiness.model.SkillGroup extends Object implements Serializable
  - Serialized Fields
    - skillGroupArn
```
String skillGroupArn
```
      The ARN of a skill group.
    - skillGroupName
```
String skillGroupName
```
      The name of a skill group.
    - description
```
String description
```
      The description of a skill group.
- Class com.amazonaws.services.alexaforbusiness.model.SkillGroupData extends Object implements Serializable
  - Serialized Fields
    - skillGroupArn
```
String skillGroupArn
```
      The skill group ARN of a skill group.
    - skillGroupName
```
String skillGroupName
```
      The skill group name of a skill group.
    - description
```
String description
```
      The description of a skill group.
- Class com.amazonaws.services.alexaforbusiness.model.SkillNotLinkedException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.SkillsStoreSkill extends Object implements Serializable
  - Serialized Fields
    - skillId
```
String skillId
```
      The ARN of the skill.
    - skillName
```
String skillName
```
      The name of the skill.
    - shortDescription
```
String shortDescription
```
      Short description about the skill.
    - iconUrl
```
String iconUrl
```
      The URL where the skill icon resides.
    - sampleUtterances
```
List<E> sampleUtterances
```
      Sample utterances that interact with the skill.
    - skillDetails
```
SkillDetails skillDetails
```
      Information about the skill.
    - supportsLinking
```
Boolean supportsLinking
```
      Linking support for a skill.
- Class com.amazonaws.services.alexaforbusiness.model.SkillSummary extends Object implements Serializable
  - Serialized Fields
    - skillId
```
String skillId
```
      The ARN of the skill summary.
    - skillName
```
String skillName
```
      The name of the skill.
    - supportsLinking
```
Boolean supportsLinking
```
      Linking support for a skill.
    - enablementType
```
String enablementType
```
      Whether the skill is enabled under the user's account, or if it requires linking to be used.
    - skillType
```
String skillType
```
      Whether the skill is publicly available or is a private skill.
- Class com.amazonaws.services.alexaforbusiness.model.SmartHomeAppliance extends Object implements Serializable
  - Serialized Fields
    - friendlyName
```
String friendlyName
```
      The friendly name of the smart home appliance.
    - description
```
String description
```
      The description of the smart home appliance.
    - manufacturerName
```
String manufacturerName
```
      The name of the manufacturer of the smart home appliance.
- Class com.amazonaws.services.alexaforbusiness.model.Sort extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The sort key of a sort object.
    - value
```
String value
```
      The sort value of a sort object.
- Class com.amazonaws.services.alexaforbusiness.model.Ssml extends Object implements Serializable
  - Serialized Fields
    - locale
```
String locale
```
      The locale of the SSML message. Currently, en-US is supported.
    - value
```
String value
```
      The value of the SSML message in the correct SSML format. The audio tag is not supported.
- Class com.amazonaws.services.alexaforbusiness.model.StartDeviceSyncRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The ARN of the room with which the device to sync is associated. Required.
    - deviceArn
```
String deviceArn
```
      The ARN of the device to sync. Required.
    - features
```
List<E> features
```
      Request structure to start the device sync. Required.
- Class com.amazonaws.services.alexaforbusiness.model.StartDeviceSyncResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.StartSmartHomeApplianceDiscoveryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The room where smart home appliance discovery was initiated.
- Class com.amazonaws.services.alexaforbusiness.model.StartSmartHomeApplianceDiscoveryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The key of a tag. Tag keys are case-sensitive.
    - value
```
String value
```
      The value of a tag. Tag values are case sensitive and can be null.
- Class com.amazonaws.services.alexaforbusiness.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the resource to which to add metadata tags. Required.
    - tags
```
List<E> tags
```
      The tags to be added to the specified resource. Do not provide system tags. Required.
- Class com.amazonaws.services.alexaforbusiness.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.Text extends Object implements Serializable
  - Serialized Fields
    - locale
```
String locale
```
      The locale of the text message. Currently, en-US is supported.
    - value
```
String value
```
      The value of the text message.
- Class com.amazonaws.services.alexaforbusiness.model.UnauthorizedException extends AmazonAlexaForBusinessException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.alexaforbusiness.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the resource from which to remove metadata tags. Required.
    - tagKeys
```
List<E> tagKeys
```
      The tags to be removed from the specified resource. Do not provide system tags. Required.
- Class com.amazonaws.services.alexaforbusiness.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.UpdateAddressBookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - addressBookArn
```
String addressBookArn
```
      The ARN of the room to update.
    - name
```
String name
```
      The updated name of the room.
    - description
```
String description
```
      The updated description of the room.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateAddressBookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.UpdateBusinessReportScheduleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - scheduleArn
```
String scheduleArn
```
      The ARN of the business report schedule.
    - s3BucketName
```
String s3BucketName
```
      The S3 location of the output reports.
    - s3KeyPrefix
```
String s3KeyPrefix
```
      The S3 key where the report is delivered.
    - format
```
String format
```
      The format of the generated report (individual CSV files or zipped files of individual files).
    - scheduleName
```
String scheduleName
```
      The name identifier of the schedule.
    - recurrence
```
BusinessReportRecurrence recurrence
```
      The recurrence of the reports.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateBusinessReportScheduleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.UpdateConferenceProviderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - conferenceProviderArn
```
String conferenceProviderArn
```
      The ARN of the conference provider.
    - conferenceProviderType
```
String conferenceProviderType
```
      The type of the conference provider.
    - iPDialIn
```
IPDialIn iPDialIn
```
      The IP endpoint and protocol for calling.
    - pSTNDialIn
```
PSTNDialIn pSTNDialIn
```
      The information for PSTN conferencing.
    - meetingSetting
```
MeetingSetting meetingSetting
```
      The meeting settings for the conference provider.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateConferenceProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.UpdateContactRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - contactArn
```
String contactArn
```
      The ARN of the contact to update.
    - displayName
```
String displayName
```
      The updated display name of the contact.
    - firstName
```
String firstName
```
      The updated first name of the contact.
    - lastName
```
String lastName
```
      The updated last name of the contact.
    - phoneNumber
```
String phoneNumber
```
      The updated phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.
    - phoneNumbers
```
List<E> phoneNumbers
```
      The list of phone numbers for the contact.
    - sipAddresses
```
List<E> sipAddresses
```
      The list of SIP addresses for the contact.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.UpdateDeviceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deviceArn
```
String deviceArn
```
      The ARN of the device to update. Required.
    - deviceName
```
String deviceName
```
      The updated device name. Required.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.UpdateEndOfMeetingReminder extends Object implements Serializable
  - Serialized Fields
    - reminderAtMinutes
```
List<E> reminderAtMinutes
```
      Updates settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
    - reminderType
```
String reminderType
```
      The type of sound that users hear during the end of meeting reminder.
    - enabled
```
Boolean enabled
```
      Whether an end of meeting reminder is enabled or not.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateGatewayGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - gatewayGroupArn
```
String gatewayGroupArn
```
      The ARN of the gateway group to update.
    - name
```
String name
```
      The updated name of the gateway group.
    - description
```
String description
```
      The updated description of the gateway group.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateGatewayGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.UpdateGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - gatewayArn
```
String gatewayArn
```
      The ARN of the gateway to update.
    - name
```
String name
```
      The updated name of the gateway.
    - description
```
String description
```
      The updated description of the gateway.
    - softwareVersion
```
String softwareVersion
```
      The updated software version of the gateway. The gateway automatically updates its software version during normal operation.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.UpdateInstantBooking extends Object implements Serializable
  - Serialized Fields
    - durationInMinutes
```
Integer durationInMinutes
```
      Duration between 15 and 240 minutes at increments of 15 that determines how long to book an available room when a meeting is started with Alexa.
    - enabled
```
Boolean enabled
```
      Whether instant booking is enabled or not.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateMeetingRoomConfiguration extends Object implements Serializable
  - Serialized Fields
    - roomUtilizationMetricsEnabled
```
Boolean roomUtilizationMetricsEnabled
```
      Whether room utilization metrics are enabled or not.
    - endOfMeetingReminder
```
UpdateEndOfMeetingReminder endOfMeetingReminder
```
      Settings for the end of meeting reminder feature that are applied to a room profile. The end of meeting reminder enables Alexa to remind users when a meeting is ending.
    - instantBooking
```
UpdateInstantBooking instantBooking
```
      Settings to automatically book an available room available for a configured duration when joining a meeting with Alexa.
    - requireCheckIn
```
UpdateRequireCheckIn requireCheckIn
```
      Settings for requiring a check in when a room is reserved. Alexa can cancel a room reservation if it's not checked into to make the room available for others. Users can check in by joining the meeting with Alexa or an AVS device, or by saying “Alexa, check in.”
- Class com.amazonaws.services.alexaforbusiness.model.UpdateNetworkProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkProfileArn
```
String networkProfileArn
```
      The ARN of the network profile associated with a device.
    - networkProfileName
```
String networkProfileName
```
      The name of the network profile associated with a device.
    - description
```
String description
```
      Detailed information about a device's network profile.
    - currentPassword
```
String currentPassword
```
      The current password of the Wi-Fi network.
    - nextPassword
```
String nextPassword
```
      The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.
    - trustAnchors
```
List<E> trustAnchors
```
      The root certificate(s) of your authentication server that will be installed on your devices and used to trust your authentication server during EAP negotiation.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateNetworkProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.UpdateProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - profileArn
```
String profileArn
```
      The ARN of the room profile to update. Required.
    - profileName
```
String profileName
```
      The updated name for the room profile.
    - isDefault
```
Boolean isDefault
```
      Sets the profile as default if selected. If this is missing, no update is done to the default status.
    - timezone
```
String timezone
```
      The updated timezone for the room profile.
    - address
```
String address
```
      The updated address for the room profile.
    - distanceUnit
```
String distanceUnit
```
      The updated distance unit for the room profile.
    - temperatureUnit
```
String temperatureUnit
```
      The updated temperature unit for the room profile.
    - wakeWord
```
String wakeWord
```
      The updated wake word for the room profile.
    - locale
```
String locale
```
      The updated locale for the room profile. (This is currently only available to a limited preview audience.)
    - setupModeDisabled
```
Boolean setupModeDisabled
```
      Whether the setup mode of the profile is enabled.
    - maxVolumeLimit
```
Integer maxVolumeLimit
```
      The updated maximum volume limit for the room profile.
    - pSTNEnabled
```
Boolean pSTNEnabled
```
      Whether the PSTN setting of the room profile is enabled.
    - meetingRoomConfiguration
```
UpdateMeetingRoomConfiguration meetingRoomConfiguration
```
      The updated meeting room settings of a room profile.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.UpdateRequireCheckIn extends Object implements Serializable
  - Serialized Fields
    - releaseAfterMinutes
```
Integer releaseAfterMinutes
```
      Duration between 5 and 20 minutes to determine when to release the room if it's not checked into.
    - enabled
```
Boolean enabled
```
      Whether require check in is enabled or not.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateRoomRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - roomArn
```
String roomArn
```
      The ARN of the room to update.
    - roomName
```
String roomName
```
      The updated name for the room.
    - description
```
String description
```
      The updated description for the room.
    - providerCalendarId
```
String providerCalendarId
```
      The updated provider calendar ARN for the room.
    - profileArn
```
String profileArn
```
      The updated profile ARN for the room.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.UpdateSkillGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - skillGroupArn
```
String skillGroupArn
```
      The ARN of the skill group to update.
    - skillGroupName
```
String skillGroupName
```
      The updated name for the skill group.
    - description
```
String description
```
      The updated description for the skill group.
- Class com.amazonaws.services.alexaforbusiness.model.UpdateSkillGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.alexaforbusiness.model.UserData extends Object implements Serializable
  - Serialized Fields
    - userArn
```
String userArn
```
      The ARN of a user.
    - firstName
```
String firstName
```
      The first name of a user.
    - lastName
```
String lastName
```
      The last name of a user.
    - email
```
String email
```
      The email of a user.
    - enrollmentStatus
```
String enrollmentStatus
```
      The enrollment status of a user.
    - enrollmentId
```
String enrollmentId
```
      The enrollment ARN of a user.
Package com.amazonaws.services.amplify.model
- Class com.amazonaws.services.amplify.model.App extends Object implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for the Amplify App.
    - appArn
```
String appArn
```
      ARN for the Amplify App.
    - name
```
String name
```
      Name for the Amplify App.
    - tags
```
Map<K,V> tags
```
      Tag for Amplify App.
    - description
```
String description
```
      Description for the Amplify App.
    - repository
```
String repository
```
      Repository for the Amplify App.
    - platform
```
String platform
```
      Platform for the Amplify App.
    - createTime
```
Date createTime
```
      Create date / time for the Amplify App.
    - updateTime
```
Date updateTime
```
      Update date / time for the Amplify App.
    - iamServiceRoleArn
```
String iamServiceRoleArn
```
      IAM service role ARN for the Amplify App.
    - environmentVariables
```
Map<K,V> environmentVariables
```
      Environment Variables for the Amplify App.
    - defaultDomain
```
String defaultDomain
```
      Default domain for the Amplify App.
    - enableBranchAutoBuild
```
Boolean enableBranchAutoBuild
```
      Enables auto-building of branches for the Amplify App.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables Basic Authorization for branches for the Amplify App.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      Basic Authorization credentials for branches for the Amplify App.
    - customRules
```
List<E> customRules
```
      Custom redirect / rewrite rules for the Amplify App.
    - productionBranch
```
ProductionBranch productionBranch
```
      Structure with Production Branch information.
    - buildSpec
```
String buildSpec
```
      BuildSpec content for Amplify App.
    - enableAutoBranchCreation
```
Boolean enableAutoBranchCreation
```
      Enables automated branch creation for the Amplify App.
    - autoBranchCreationPatterns
```
List<E> autoBranchCreationPatterns
```
      Automated branch creation glob patterns for the Amplify App.
    - autoBranchCreationConfig
```
AutoBranchCreationConfig autoBranchCreationConfig
```
      Automated branch creation config for the Amplify App.
- Class com.amazonaws.services.amplify.model.Artifact extends Object implements Serializable
  - Serialized Fields
    - artifactFileName
```
String artifactFileName
```
      File name for the artifact.
    - artifactId
```
String artifactId
```
      Unique Id for a artifact.
- Class com.amazonaws.services.amplify.model.AutoBranchCreationConfig extends Object implements Serializable
  - Serialized Fields
    - stage
```
String stage
```
      Stage for the auto created branch.
    - framework
```
String framework
```
      Framework for the auto created branch.
    - enableAutoBuild
```
Boolean enableAutoBuild
```
      Enables auto building for the auto created branch.
    - environmentVariables
```
Map<K,V> environmentVariables
```
      Environment Variables for the auto created branch.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      Basic Authorization credentials for the auto created branch.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables Basic Auth for the auto created branch.
    - buildSpec
```
String buildSpec
```
      BuildSpec for the auto created branch.
    - enablePullRequestPreview
```
Boolean enablePullRequestPreview
```
      Enables Pull Request Preview for auto created branch.
    - pullRequestEnvironmentName
```
String pullRequestEnvironmentName
```
      The Amplify Environment name for the pull request.
- Class com.amazonaws.services.amplify.model.AWSAmplifyException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.amplify.model.BackendEnvironment extends Object implements Serializable
  - Serialized Fields
    - backendEnvironmentArn
```
String backendEnvironmentArn
```
      Arn for a backend environment, part of an Amplify App.
    - environmentName
```
String environmentName
```
      Name for a backend environment, part of an Amplify App.
    - stackName
```
String stackName
```
      CloudFormation stack name of backend environment.
    - deploymentArtifacts
```
String deploymentArtifacts
```
      Name of deployment artifacts.
    - createTime
```
Date createTime
```
      Creation date and time for a backend environment, part of an Amplify App.
    - updateTime
```
Date updateTime
```
      Last updated date and time for a backend environment, part of an Amplify App.
- Class com.amazonaws.services.amplify.model.BadRequestException extends AWSAmplifyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.amplify.model.Branch extends Object implements Serializable
  - Serialized Fields
    - branchArn
```
String branchArn
```
      ARN for a branch, part of an Amplify App.
    - branchName
```
String branchName
```
      Name for a branch, part of an Amplify App.
    - description
```
String description
```
      Description for a branch, part of an Amplify App.
    - tags
```
Map<K,V> tags
```
      Tag for branch for Amplify App.
    - stage
```
String stage
```
      Stage for a branch, part of an Amplify App.
    - displayName
```
String displayName
```
      Display name for a branch, will use as the default domain prefix.
    - enableNotification
```
Boolean enableNotification
```
      Enables notifications for a branch, part of an Amplify App.
    - createTime
```
Date createTime
```
      Creation date and time for a branch, part of an Amplify App.
    - updateTime
```
Date updateTime
```
      Last updated date and time for a branch, part of an Amplify App.
    - environmentVariables
```
Map<K,V> environmentVariables
```
      Environment Variables specific to a branch, part of an Amplify App.
    - enableAutoBuild
```
Boolean enableAutoBuild
```
      Enables auto-building on push for a branch, part of an Amplify App.
    - customDomains
```
List<E> customDomains
```
      Custom domains for a branch, part of an Amplify App.
    - framework
```
String framework
```
      Framework for a branch, part of an Amplify App.
    - activeJobId
```
String activeJobId
```
      Id of the active job for a branch, part of an Amplify App.
    - totalNumberOfJobs
```
String totalNumberOfJobs
```
      Total number of Jobs part of an Amplify App.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables Basic Authorization for a branch, part of an Amplify App.
    - thumbnailUrl
```
String thumbnailUrl
```
      Thumbnail URL for the branch.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      Basic Authorization credentials for a branch, part of an Amplify App.
    - buildSpec
```
String buildSpec
```
      BuildSpec content for branch for Amplify App.
    - ttl
```
String ttl
```
      The content TTL for the website in seconds.
    - associatedResources
```
List<E> associatedResources
```
      List of custom resources that are linked to this branch.
    - enablePullRequestPreview
```
Boolean enablePullRequestPreview
```
      Enables Pull Request Preview for this branch.
    - pullRequestEnvironmentName
```
String pullRequestEnvironmentName
```
      The Amplify Environment name for the pull request.
    - destinationBranch
```
String destinationBranch
```
      The destination branch if the branch is a pull request branch.
    - sourceBranch
```
String sourceBranch
```
      The source branch if the branch is a pull request branch.
    - backendEnvironmentArn
```
String backendEnvironmentArn
```
      ARN for a Backend Environment, part of an Amplify App.
- Class com.amazonaws.services.amplify.model.CreateAppRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Name for the Amplify App
    - description
```
String description
```
      Description for an Amplify App
    - repository
```
String repository
```
      Repository for an Amplify App
    - platform
```
String platform
```
      Platform / framework for an Amplify App
    - iamServiceRoleArn
```
String iamServiceRoleArn
```
      AWS IAM service role for an Amplify App
    - oauthToken
```
String oauthToken
```
      OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored.
    - accessToken
```
String accessToken
```
      Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.
    - environmentVariables
```
Map<K,V> environmentVariables
```
      Environment variables map for an Amplify App.
    - enableBranchAutoBuild
```
Boolean enableBranchAutoBuild
```
      Enable the auto building of branches for an Amplify App.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      Credentials for Basic Authorization for an Amplify App.
    - customRules
```
List<E> customRules
```
      Custom rewrite / redirect rules for an Amplify App.
    - tags
```
Map<K,V> tags
```
      Tag for an Amplify App
    - buildSpec
```
String buildSpec
```
      BuildSpec for an Amplify App
    - enableAutoBranchCreation
```
Boolean enableAutoBranchCreation
```
      Enables automated branch creation for the Amplify App.
    - autoBranchCreationPatterns
```
List<E> autoBranchCreationPatterns
```
      Automated branch creation glob patterns for the Amplify App.
    - autoBranchCreationConfig
```
AutoBranchCreationConfig autoBranchCreationConfig
```
      Automated branch creation config for the Amplify App.
- Class com.amazonaws.services.amplify.model.CreateAppResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - app
```
App app
```
- Class com.amazonaws.services.amplify.model.CreateBackendEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - environmentName
```
String environmentName
```
      Name for the backend environment.
    - stackName
```
String stackName
```
      CloudFormation stack name of backend environment.
    - deploymentArtifacts
```
String deploymentArtifacts
```
      Name of deployment artifacts.
- Class com.amazonaws.services.amplify.model.CreateBackendEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backendEnvironment
```
BackendEnvironment backendEnvironment
```
      Backend environment structure for an amplify App.
- Class com.amazonaws.services.amplify.model.CreateBranchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for the branch.
    - description
```
String description
```
      Description for the branch.
    - stage
```
String stage
```
      Stage for the branch.
    - framework
```
String framework
```
      Framework for the branch.
    - enableNotification
```
Boolean enableNotification
```
      Enables notifications for the branch.
    - enableAutoBuild
```
Boolean enableAutoBuild
```
      Enables auto building for the branch.
    - environmentVariables
```
Map<K,V> environmentVariables
```
      Environment Variables for the branch.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      Basic Authorization credentials for the branch.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables Basic Auth for the branch.
    - tags
```
Map<K,V> tags
```
      Tag for the branch.
    - buildSpec
```
String buildSpec
```
      BuildSpec for the branch.
    - ttl
```
String ttl
```
      The content TTL for the website in seconds.
    - displayName
```
String displayName
```
      Display name for a branch, will use as the default domain prefix.
    - enablePullRequestPreview
```
Boolean enablePullRequestPreview
```
      Enables Pull Request Preview for this branch.
    - pullRequestEnvironmentName
```
String pullRequestEnvironmentName
```
      The Amplify Environment name for the pull request.
    - backendEnvironmentArn
```
String backendEnvironmentArn
```
      ARN for a Backend Environment, part of an Amplify App.
- Class com.amazonaws.services.amplify.model.CreateBranchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - branch
```
Branch branch
```
      Branch structure for an Amplify App.
- Class com.amazonaws.services.amplify.model.CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for the branch, for the Job.
    - fileMap
```
Map<K,V> fileMap
```
      Optional file map that contains file name as the key and file content md5 hash as the value. If this argument is provided, the service will generate different upload url per file. Otherwise, the service will only generate a single upload url for the zipped files.
- Class com.amazonaws.services.amplify.model.CreateDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The jobId for this deployment, will supply to start deployment api.
    - fileUploadUrls
```
Map<K,V> fileUploadUrls
```
      When the fileMap argument is provided in the request, the fileUploadUrls will contain a map of file names to upload url.
    - zipUploadUrl
```
String zipUploadUrl
```
      When the fileMap argument is NOT provided. This zipUploadUrl will be returned.
- Class com.amazonaws.services.amplify.model.CreateDomainAssociationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - domainName
```
String domainName
```
      Domain name for the Domain Association.
    - enableAutoSubDomain
```
Boolean enableAutoSubDomain
```
      Enables automated creation of Subdomains for branches. (Currently not supported)
    - subDomainSettings
```
List<E> subDomainSettings
```
      Setting structure for the Subdomain.
- Class com.amazonaws.services.amplify.model.CreateDomainAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - domainAssociation
```
DomainAssociation domainAssociation
```
      Domain Association structure.
- Class com.amazonaws.services.amplify.model.CreateWebhookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for a branch, part of an Amplify App.
    - description
```
String description
```
      Description for a webhook.
- Class com.amazonaws.services.amplify.model.CreateWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - webhook
```
Webhook webhook
```
      Webhook structure.
- Class com.amazonaws.services.amplify.model.CustomRule extends Object implements Serializable
  - Serialized Fields
    - source
```
String source
```
      The source pattern for a URL rewrite or redirect rule.
    - target
```
String target
```
      The target pattern for a URL rewrite or redirect rule.
    - status
```
String status
```
      The status code for a URL rewrite or redirect rule.
    - condition
```
String condition
```
      The condition for a URL rewrite or redirect rule, e.g. country code.
- Class com.amazonaws.services.amplify.model.DeleteAppRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
- Class com.amazonaws.services.amplify.model.DeleteAppResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - app
```
App app
```
- Class com.amazonaws.services.amplify.model.DeleteBackendEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id of an Amplify App.
    - environmentName
```
String environmentName
```
      Name of a backend environment of an Amplify App.
- Class com.amazonaws.services.amplify.model.DeleteBackendEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backendEnvironment
```
BackendEnvironment backendEnvironment
```
      Backend environment structure for an Amplify App.
- Class com.amazonaws.services.amplify.model.DeleteBranchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for the branch.
- Class com.amazonaws.services.amplify.model.DeleteBranchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - branch
```
Branch branch
```
      Branch structure for an Amplify App.
- Class com.amazonaws.services.amplify.model.DeleteDomainAssociationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - domainName
```
String domainName
```
      Name of the domain.
- Class com.amazonaws.services.amplify.model.DeleteDomainAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - domainAssociation
```
DomainAssociation domainAssociation
```
- Class com.amazonaws.services.amplify.model.DeleteJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for the branch, for the Job.
    - jobId
```
String jobId
```
      Unique Id for the Job.
- Class com.amazonaws.services.amplify.model.DeleteJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobSummary
```
JobSummary jobSummary
```
- Class com.amazonaws.services.amplify.model.DeleteWebhookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - webhookId
```
String webhookId
```
      Unique Id for a webhook.
- Class com.amazonaws.services.amplify.model.DeleteWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - webhook
```
Webhook webhook
```
      Webhook structure.
- Class com.amazonaws.services.amplify.model.DependentServiceFailureException extends AWSAmplifyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.amplify.model.DomainAssociation extends Object implements Serializable
  - Serialized Fields
    - domainAssociationArn
```
String domainAssociationArn
```
      ARN for the Domain Association.
    - domainName
```
String domainName
```
      Name of the domain.
    - enableAutoSubDomain
```
Boolean enableAutoSubDomain
```
      Enables automated creation of Subdomains for branches. (Currently not supported)
    - domainStatus
```
String domainStatus
```
      Status fo the Domain Association.
    - statusReason
```
String statusReason
```
      Reason for the current status of the Domain Association.
    - certificateVerificationDNSRecord
```
String certificateVerificationDNSRecord
```
      DNS Record for certificate verification.
    - subDomains
```
List<E> subDomains
```
      Subdomains for the Domain Association.
- Class com.amazonaws.services.amplify.model.GenerateAccessLogsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - startTime
```
Date startTime
```
      The time at which the logs should start, inclusive.
    - endTime
```
Date endTime
```
      The time at which the logs should end, inclusive.
    - domainName
```
String domainName
```
      Name of the domain.
    - appId
```
String appId
```
      Unique Id for an Amplify App.
- Class com.amazonaws.services.amplify.model.GenerateAccessLogsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - logUrl
```
String logUrl
```
      Pre-signed URL for the requested access logs.
- Class com.amazonaws.services.amplify.model.GetAppRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
- Class com.amazonaws.services.amplify.model.GetAppResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - app
```
App app
```
- Class com.amazonaws.services.amplify.model.GetArtifactUrlRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - artifactId
```
String artifactId
```
      Unique Id for a artifact.
- Class com.amazonaws.services.amplify.model.GetArtifactUrlResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - artifactId
```
String artifactId
```
      Unique Id for a artifact.
    - artifactUrl
```
String artifactUrl
```
      Presigned url for the artifact.
- Class com.amazonaws.services.amplify.model.GetBackendEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - environmentName
```
String environmentName
```
      Name for the backend environment.
- Class com.amazonaws.services.amplify.model.GetBackendEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backendEnvironment
```
BackendEnvironment backendEnvironment
```
      Backend environment structure for an an Amplify App.
- Class com.amazonaws.services.amplify.model.GetBranchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for the branch.
- Class com.amazonaws.services.amplify.model.GetBranchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - branch
```
Branch branch
```
- Class com.amazonaws.services.amplify.model.GetDomainAssociationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - domainName
```
String domainName
```
      Name of the domain.
- Class com.amazonaws.services.amplify.model.GetDomainAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - domainAssociation
```
DomainAssociation domainAssociation
```
      Domain Association structure.
- Class com.amazonaws.services.amplify.model.GetJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for the branch, for the Job.
    - jobId
```
String jobId
```
      Unique Id for the Job.
- Class com.amazonaws.services.amplify.model.GetJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - job
```
Job job
```
- Class com.amazonaws.services.amplify.model.GetWebhookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - webhookId
```
String webhookId
```
      Unique Id for a webhook.
- Class com.amazonaws.services.amplify.model.GetWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - webhook
```
Webhook webhook
```
      Webhook structure.
- Class com.amazonaws.services.amplify.model.InternalFailureException extends AWSAmplifyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.amplify.model.Job extends Object implements Serializable
  - Serialized Fields
    - summary
```
JobSummary summary
```
      Summary for an execution job for an Amplify App.
    - steps
```
List<E> steps
```
      Execution steps for an execution job, for an Amplify App.
- Class com.amazonaws.services.amplify.model.JobSummary extends Object implements Serializable
  - Serialized Fields
    - jobArn
```
String jobArn
```
      Arn for the Job.
    - jobId
```
String jobId
```
      Unique Id for the Job.
    - commitId
```
String commitId
```
      Commit Id from 3rd party repository provider for the Job.
    - commitMessage
```
String commitMessage
```
      Commit message from 3rd party repository provider for the Job.
    - commitTime
```
Date commitTime
```
      Commit date / time for the Job.
    - startTime
```
Date startTime
```
      Start date / time for the Job.
    - status
```
String status
```
      Status for the Job.
    - endTime
```
Date endTime
```
      End date / time for the Job.
    - jobType
```
String jobType
```
      Type for the Job. \n "RELEASE": Manually released from source by using StartJob API. "RETRY": Manually retried by using StartJob API. "WEB_HOOK": Automatically triggered by WebHooks.
- Class com.amazonaws.services.amplify.model.LimitExceededException extends AWSAmplifyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.amplify.model.ListAppsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
    - maxResults
```
Integer maxResults
```
      Maximum number of records to list in a single response.
- Class com.amazonaws.services.amplify.model.ListAppsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apps
```
List<E> apps
```
      List of Amplify Apps.
    - nextToken
```
String nextToken
```
      Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.
- Class com.amazonaws.services.amplify.model.ListArtifactsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for a branch, part of an Amplify App.
    - jobId
```
String jobId
```
      Unique Id for an Job.
    - nextToken
```
String nextToken
```
      Pagination token. Set to null to start listing artifacts from start. If non-null pagination token is returned in a result, then pass its value in here to list more artifacts.
    - maxResults
```
Integer maxResults
```
      Maximum number of records to list in a single response.
- Class com.amazonaws.services.amplify.model.ListArtifactsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - artifacts
```
List<E> artifacts
```
      List of artifacts.
    - nextToken
```
String nextToken
```
      Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
- Class com.amazonaws.services.amplify.model.ListBackendEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an amplify App.
    - environmentName
```
String environmentName
```
      Name of the backend environment
    - nextToken
```
String nextToken
```
      Pagination token. Set to null to start listing backen environments from start. If a non-null pagination token is returned in a result, then pass its value in here to list more backend environments.
    - maxResults
```
Integer maxResults
```
      Maximum number of records to list in a single response.
- Class com.amazonaws.services.amplify.model.ListBackendEnvironmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backendEnvironments
```
List<E> backendEnvironments
```
      List of backend environments for an Amplify App.
    - nextToken
```
String nextToken
```
      Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
- Class com.amazonaws.services.amplify.model.ListBranchesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - nextToken
```
String nextToken
```
      Pagination token. Set to null to start listing branches from start. If a non-null pagination token is returned in a result, then pass its value in here to list more branches.
    - maxResults
```
Integer maxResults
```
      Maximum number of records to list in a single response.
- Class com.amazonaws.services.amplify.model.ListBranchesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - branches
```
List<E> branches
```
      List of branches for an Amplify App.
    - nextToken
```
String nextToken
```
      Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
- Class com.amazonaws.services.amplify.model.ListDomainAssociationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - nextToken
```
String nextToken
```
      Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.
    - maxResults
```
Integer maxResults
```
      Maximum number of records to list in a single response.
- Class com.amazonaws.services.amplify.model.ListDomainAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - domainAssociations
```
List<E> domainAssociations
```
      List of Domain Associations.
    - nextToken
```
String nextToken
```
      Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
- Class com.amazonaws.services.amplify.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for a branch.
    - nextToken
```
String nextToken
```
      Pagination token. Set to null to start listing steps from start. If a non-null pagination token is returned in a result, then pass its value in here to list more steps.
    - maxResults
```
Integer maxResults
```
      Maximum number of records to list in a single response.
- Class com.amazonaws.services.amplify.model.ListJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobSummaries
```
List<E> jobSummaries
```
      Result structure for list job result request.
    - nextToken
```
String nextToken
```
      Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
- Class com.amazonaws.services.amplify.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      Resource arn used to list tags.
- Class com.amazonaws.services.amplify.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      Tags result for response.
- Class com.amazonaws.services.amplify.model.ListWebhooksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - nextToken
```
String nextToken
```
      Pagination token. Set to null to start listing webhooks from start. If non-null pagination token is returned in a result, then pass its value in here to list more webhooks.
    - maxResults
```
Integer maxResults
```
      Maximum number of records to list in a single response.
- Class com.amazonaws.services.amplify.model.ListWebhooksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - webhooks
```
List<E> webhooks
```
      List of webhooks.
    - nextToken
```
String nextToken
```
      Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
- Class com.amazonaws.services.amplify.model.NotFoundException extends AWSAmplifyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.amplify.model.ProductionBranch extends Object implements Serializable
  - Serialized Fields
    - lastDeployTime
```
Date lastDeployTime
```
      Last Deploy Time of Production Branch.
    - status
```
String status
```
      Status of Production Branch.
    - thumbnailUrl
```
String thumbnailUrl
```
      Thumbnail URL for Production Branch.
    - branchName
```
String branchName
```
      Branch Name for Production Branch.
- Class com.amazonaws.services.amplify.model.ResourceNotFoundException extends AWSAmplifyException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
- Class com.amazonaws.services.amplify.model.StartDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for the branch, for the Job.
    - jobId
```
String jobId
```
      The job id for this deployment, generated by create deployment request.
    - sourceUrl
```
String sourceUrl
```
      The sourceUrl for this deployment, used when calling start deployment without create deployment. SourceUrl can be any HTTP GET url that is public accessible and downloads a single zip.
- Class com.amazonaws.services.amplify.model.StartDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobSummary
```
JobSummary jobSummary
```
      Summary for the Job.
- Class com.amazonaws.services.amplify.model.StartJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for the branch, for the Job.
    - jobId
```
String jobId
```
      Unique Id for an existing job. Required for "RETRY" JobType.
    - jobType
```
String jobType
```
      Type for the Job. Available JobTypes are: \n "RELEASE": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. "RETRY": Retry an existing job. JobId is required for this type of job.
    - jobReason
```
String jobReason
```
      Descriptive reason for starting this job.
    - commitId
```
String commitId
```
      Commit Id from 3rd party repository provider for the Job.
    - commitMessage
```
String commitMessage
```
      Commit message from 3rd party repository provider for the Job.
    - commitTime
```
Date commitTime
```
      Commit date / time for the Job.
- Class com.amazonaws.services.amplify.model.StartJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobSummary
```
JobSummary jobSummary
```
      Summary for the Job.
- Class com.amazonaws.services.amplify.model.Step extends Object implements Serializable
  - Serialized Fields
    - stepName
```
String stepName
```
      Name of the execution step.
    - startTime
```
Date startTime
```
      Start date/ time of the execution step.
    - status
```
String status
```
      Status of the execution step.
    - endTime
```
Date endTime
```
      End date/ time of the execution step.
    - logUrl
```
String logUrl
```
      URL to the logs for the execution step.
    - artifactsUrl
```
String artifactsUrl
```
      URL to the artifact for the execution step.
    - testArtifactsUrl
```
String testArtifactsUrl
```
      URL to the test artifact for the execution step.
    - testConfigUrl
```
String testConfigUrl
```
      URL to the test config for the execution step.
    - screenshots
```
Map<K,V> screenshots
```
      List of screenshot URLs for the execution step, if relevant.
    - statusReason
```
String statusReason
```
      The reason for current step status.
    - context
```
String context
```
      The context for current step, will include build image if step is build.
- Class com.amazonaws.services.amplify.model.StopJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for the branch, for the Job.
    - jobId
```
String jobId
```
      Unique Id for the Job.
- Class com.amazonaws.services.amplify.model.StopJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobSummary
```
JobSummary jobSummary
```
      Summary for the Job.
- Class com.amazonaws.services.amplify.model.SubDomain extends Object implements Serializable
  - Serialized Fields
    - subDomainSetting
```
SubDomainSetting subDomainSetting
```
      Setting structure for the Subdomain.
    - verified
```
Boolean verified
```
      Verified status of the Subdomain
    - dnsRecord
```
String dnsRecord
```
      DNS record for the Subdomain.
- Class com.amazonaws.services.amplify.model.SubDomainSetting extends Object implements Serializable
  - Serialized Fields
    - prefix
```
String prefix
```
      Prefix setting for the Subdomain.
    - branchName
```
String branchName
```
      Branch name setting for the Subdomain.
- Class com.amazonaws.services.amplify.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      Resource arn used to tag resource.
    - tags
```
Map<K,V> tags
```
      Tags used to tag resource.
- Class com.amazonaws.services.amplify.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.amplify.model.UnauthorizedException extends AWSAmplifyException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.amplify.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      Resource arn used to untag resource.
    - tagKeys
```
List<E> tagKeys
```
      Tag keys used to untag resource.
- Class com.amazonaws.services.amplify.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.amplify.model.UpdateAppRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - name
```
String name
```
      Name for an Amplify App.
    - description
```
String description
```
      Description for an Amplify App.
    - platform
```
String platform
```
      Platform for an Amplify App.
    - iamServiceRoleArn
```
String iamServiceRoleArn
```
      IAM service role for an Amplify App.
    - environmentVariables
```
Map<K,V> environmentVariables
```
      Environment Variables for an Amplify App.
    - enableBranchAutoBuild
```
Boolean enableBranchAutoBuild
```
      Enables branch auto-building for an Amplify App.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables Basic Authorization for an Amplify App.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      Basic Authorization credentials for an Amplify App.
    - customRules
```
List<E> customRules
```
      Custom redirect / rewrite rules for an Amplify App.
    - buildSpec
```
String buildSpec
```
      BuildSpec for an Amplify App.
    - enableAutoBranchCreation
```
Boolean enableAutoBranchCreation
```
      Enables automated branch creation for the Amplify App.
    - autoBranchCreationPatterns
```
List<E> autoBranchCreationPatterns
```
      Automated branch creation glob patterns for the Amplify App.
    - autoBranchCreationConfig
```
AutoBranchCreationConfig autoBranchCreationConfig
```
      Automated branch creation branchConfig for the Amplify App.
    - repository
```
String repository
```
      Repository for an Amplify App
    - oauthToken
```
String oauthToken
```
      OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored.
    - accessToken
```
String accessToken
```
      Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.
- Class com.amazonaws.services.amplify.model.UpdateAppResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - app
```
App app
```
      App structure for the updated App.
- Class com.amazonaws.services.amplify.model.UpdateBranchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - branchName
```
String branchName
```
      Name for the branch.
    - description
```
String description
```
      Description for the branch.
    - framework
```
String framework
```
      Framework for the branch.
    - stage
```
String stage
```
      Stage for the branch.
    - enableNotification
```
Boolean enableNotification
```
      Enables notifications for the branch.
    - enableAutoBuild
```
Boolean enableAutoBuild
```
      Enables auto building for the branch.
    - environmentVariables
```
Map<K,V> environmentVariables
```
      Environment Variables for the branch.
    - basicAuthCredentials
```
String basicAuthCredentials
```
      Basic Authorization credentials for the branch.
    - enableBasicAuth
```
Boolean enableBasicAuth
```
      Enables Basic Auth for the branch.
    - buildSpec
```
String buildSpec
```
      BuildSpec for the branch.
    - ttl
```
String ttl
```
      The content TTL for the website in seconds.
    - displayName
```
String displayName
```
      Display name for a branch, will use as the default domain prefix.
    - enablePullRequestPreview
```
Boolean enablePullRequestPreview
```
      Enables Pull Request Preview for this branch.
    - pullRequestEnvironmentName
```
String pullRequestEnvironmentName
```
      The Amplify Environment name for the pull request.
    - backendEnvironmentArn
```
String backendEnvironmentArn
```
      ARN for a Backend Environment, part of an Amplify App.
- Class com.amazonaws.services.amplify.model.UpdateBranchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - branch
```
Branch branch
```
      Branch structure for an Amplify App.
- Class com.amazonaws.services.amplify.model.UpdateDomainAssociationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - appId
```
String appId
```
      Unique Id for an Amplify App.
    - domainName
```
String domainName
```
      Name of the domain.
    - enableAutoSubDomain
```
Boolean enableAutoSubDomain
```
      Enables automated creation of Subdomains for branches. (Currently not supported)
    - subDomainSettings
```
List<E> subDomainSettings
```
      Setting structure for the Subdomain.
- Class com.amazonaws.services.amplify.model.UpdateDomainAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - domainAssociation
```
DomainAssociation domainAssociation
```
      Domain Association structure.
- Class com.amazonaws.services.amplify.model.UpdateWebhookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - webhookId
```
String webhookId
```
      Unique Id for a webhook.
    - branchName
```
String branchName
```
      Name for a branch, part of an Amplify App.
    - description
```
String description
```
      Description for a webhook.
- Class com.amazonaws.services.amplify.model.UpdateWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - webhook
```
Webhook webhook
```
      Webhook structure.
- Class com.amazonaws.services.amplify.model.Webhook extends Object implements Serializable
  - Serialized Fields
    - webhookArn
```
String webhookArn
```
      ARN for the webhook.
    - webhookId
```
String webhookId
```
      Id of the webhook.
    - webhookUrl
```
String webhookUrl
```
      Url of the webhook.
    - branchName
```
String branchName
```
      Name for a branch, part of an Amplify App.
    - description
```
String description
```
      Description for a webhook.
    - createTime
```
Date createTime
```
      Create date / time for a webhook.
    - updateTime
```
Date updateTime
```
      Update date / time for a webhook.
Package com.amazonaws.services.apigateway.model
- Class com.amazonaws.services.apigateway.model.AccessLogSettings extends Object implements Serializable
  - Serialized Fields
    - format
```
String format
```
      A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
    - destinationArn
```
String destinationArn
```
      The ARN of the CloudWatch Logs log group to receive access logs.
- Class com.amazonaws.services.apigateway.model.AmazonApiGatewayException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigateway.model.ApiKey extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the API Key.
    - value
```
String value
```
      The value of the API Key.
    - name
```
String name
```
      The name of the API Key.
    - customerId
```
String customerId
```
      An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
    - description
```
String description
```
      The description of the API Key.
    - enabled
```
Boolean enabled
```
      Specifies whether the API Key can be used by callers.
    - createdDate
```
Date createdDate
```
      The timestamp when the API Key was created.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The timestamp when the API Key was last updated.
    - stageKeys
```
List<E> stageKeys
```
      A list of Stage resources that are associated with the ApiKey resource.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.ApiStage extends Object implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      API Id of the associated API stage in a usage plan.
    - stage
```
String stage
```
      API stage name of the associated API stage in a usage plan.
    - throttle
```
Map<K,V> throttle
```
      Map containing method level throttling information for API stage in a usage plan.
- Class com.amazonaws.services.apigateway.model.Authorizer extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the authorizer resource.
    - name
```
String name
```
      [Required] The name of the authorizer.
    - type
```
String type
```
      The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    - providerARNs
```
List<E> providerARNs
```
      A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
    - authType
```
String authType
```
      Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
    - authorizerUri
```
String authorizerUri
```
      Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
    - authorizerCredentials
```
String authorizerCredentials
```
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
    - identitySource
```
String identitySource
```
      The identity source for which authorization is requested.
      
      For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
      
      For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
    - identityValidationExpression
```
String identityValidationExpression
```
      A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- Class com.amazonaws.services.apigateway.model.BadRequestException extends AmazonApiGatewayException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigateway.model.BasePathMapping extends Object implements Serializable
  - Serialized Fields
    - basePath
```
String basePath
```
      The base path name that callers of the API must provide as part of the URL after the domain name.
    - restApiId
```
String restApiId
```
      The string identifier of the associated RestApi.
    - stage
```
String stage
```
      The name of the associated stage.
- Class com.amazonaws.services.apigateway.model.CanarySettings extends Object implements Serializable
  - Serialized Fields
    - percentTraffic
```
Double percentTraffic
```
      The percent (0-100) of traffic diverted to a canary deployment.
    - deploymentId
```
String deploymentId
```
      The ID of the canary deployment.
    - stageVariableOverrides
```
Map<K,V> stageVariableOverrides
```
      Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
    - useStageCache
```
Boolean useStageCache
```
      A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
- Class com.amazonaws.services.apigateway.model.ClientCertificate extends Object implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of the client certificate.
    - description
```
String description
```
      The description of the client certificate.
    - pemEncodedCertificate
```
String pemEncodedCertificate
```
      The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
    - createdDate
```
Date createdDate
```
      The timestamp when the client certificate was created.
    - expirationDate
```
Date expirationDate
```
      The timestamp when the client certificate will expire.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.ConflictException extends AmazonApiGatewayException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigateway.model.CreateApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the ApiKey.
    - description
```
String description
```
      The description of the ApiKey.
    - enabled
```
Boolean enabled
```
      Specifies whether the ApiKey can be used by callers.
    - generateDistinctId
```
Boolean generateDistinctId
```
      Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
    - value
```
String value
```
      Specifies a value of the API key.
    - stageKeys
```
List<E> stageKeys
```
      DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
    - customerId
```
String customerId
```
      An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
    - tags
```
Map<K,V> tags
```
      The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- Class com.amazonaws.services.apigateway.model.CreateApiKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the API Key.
    - value
```
String value
```
      The value of the API Key.
    - name
```
String name
```
      The name of the API Key.
    - customerId
```
String customerId
```
      An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
    - description
```
String description
```
      The description of the API Key.
    - enabled
```
Boolean enabled
```
      Specifies whether the API Key can be used by callers.
    - createdDate
```
Date createdDate
```
      The timestamp when the API Key was created.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The timestamp when the API Key was last updated.
    - stageKeys
```
List<E> stageKeys
```
      A list of Stage resources that are associated with the ApiKey resource.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.CreateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - name
```
String name
```
      [Required] The name of the authorizer.
    - type
```
String type
```
      [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    - providerARNs
```
List<E> providerARNs
```
      A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
    - authType
```
String authType
```
      Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
    - authorizerUri
```
String authorizerUri
```
      Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
    - authorizerCredentials
```
String authorizerCredentials
```
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
    - identitySource
```
String identitySource
```
      The identity source for which authorization is requested.
      
      For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
      
      For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
    - identityValidationExpression
```
String identityValidationExpression
```
      A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- Class com.amazonaws.services.apigateway.model.CreateAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the authorizer resource.
    - name
```
String name
```
      [Required] The name of the authorizer.
    - type
```
String type
```
      The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    - providerARNs
```
List<E> providerARNs
```
      A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
    - authType
```
String authType
```
      Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
    - authorizerUri
```
String authorizerUri
```
      Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
    - authorizerCredentials
```
String authorizerCredentials
```
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
    - identitySource
```
String identitySource
```
      The identity source for which authorization is requested.
      
      For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
      
      For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
    - identityValidationExpression
```
String identityValidationExpression
```
      A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- Class com.amazonaws.services.apigateway.model.CreateBasePathMappingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      [Required] The domain name of the BasePathMapping resource to create.
    - basePath
```
String basePath
```
      The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - stage
```
String stage
```
      The name of the API's stage that you want to use for this mapping. Specify '(none)' if you do not want callers to explicitly specify the stage name after any base path name.
- Class com.amazonaws.services.apigateway.model.CreateBasePathMappingResult extends AmazonWebServiceResult<ResponseMetadata> 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 string identifier of the associated RestApi.
    - stage
```
String stage
```
      The name of the associated stage.
- Class com.amazonaws.services.apigateway.model.CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - stageName
```
String stageName
```
      The name of the Stage resource for the Deployment resource to create.
    - stageDescription
```
String stageDescription
```
      The description of the Stage resource for the Deployment resource to create.
    - description
```
String description
```
      The description for the Deployment resource to create.
    - cacheClusterEnabled
```
Boolean cacheClusterEnabled
```
      Enables a cache cluster for the Stage resource specified in the input.
    - cacheClusterSize
```
String cacheClusterSize
```
      Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
    - variables
```
Map<K,V> variables
```
      A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    - canarySettings
```
DeploymentCanarySettings canarySettings
```
      The input configuration for the canary deployment when the deployment is a canary release deployment.
    - tracingEnabled
```
Boolean tracingEnabled
```
      Specifies whether active tracing with X-ray is enabled for the Stage.
- Class com.amazonaws.services.apigateway.model.CreateDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the deployment resource.
    - description
```
String description
```
      The description for the deployment resource.
    - createdDate
```
Date createdDate
```
      The date and time that the deployment resource was created.
    - apiSummary
```
Map<K,V> apiSummary
```
      A summary of the RestApi at the date and time that the deployment resource was created.
- Class com.amazonaws.services.apigateway.model.CreateDocumentationPartRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - location
```
DocumentationPartLocation location
```
      [Required] The location of the targeted API entity of the to-be-created documentation part.
    - properties
```
String properties
```
      [Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
- Class com.amazonaws.services.apigateway.model.CreateDocumentationPartResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
    - location
```
DocumentationPartLocation location
```
      The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
    - properties
```
String properties
```
      A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.
- Class com.amazonaws.services.apigateway.model.CreateDocumentationVersionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - documentationVersion
```
String documentationVersion
```
      [Required] The version identifier of the new snapshot.
    - stageName
```
String stageName
```
      The stage name to be associated with the new documentation snapshot.
    - description
```
String description
```
      A description about the new documentation snapshot.
- Class com.amazonaws.services.apigateway.model.CreateDocumentationVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - version
```
String version
```
      The version identifier of the API documentation snapshot.
    - createdDate
```
Date createdDate
```
      The date when the API documentation snapshot is created.
    - description
```
String description
```
      The description of the API documentation snapshot.
- Class com.amazonaws.services.apigateway.model.CreateDomainNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      [Required] The name of the DomainName resource.
    - certificateName
```
String certificateName
```
      The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.
    - certificateBody
```
String certificateBody
```
      [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.
    - certificatePrivateKey
```
String certificatePrivateKey
```
      [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
    - certificateChain
```
String certificateChain
```
      [Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. 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.
    - certificateArn
```
String certificateArn
```
      The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    - regionalCertificateName
```
String regionalCertificateName
```
      The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
    - regionalCertificateArn
```
String regionalCertificateArn
```
      The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.
    - endpointConfiguration
```
EndpointConfiguration endpointConfiguration
```
      The endpoint configuration of this DomainName showing the endpoint types of the domain name.
    - tags
```
Map<K,V> tags
```
      The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    - securityPolicy
```
String securityPolicy
```
      The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
- Class com.amazonaws.services.apigateway.model.CreateDomainNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The custom domain name as an API host name, for example, my-api.example.com.
    - certificateName
```
String certificateName
```
      The name of the certificate that will be used by edge-optimized endpoint for this domain name.
    - certificateArn
```
String certificateArn
```
      The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    - certificateUploadDate
```
Date certificateUploadDate
```
      The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
    - regionalDomainName
```
String regionalDomainName
```
      The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
    - regionalHostedZoneId
```
String regionalHostedZoneId
```
      The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
    - regionalCertificateName
```
String regionalCertificateName
```
      The name of the certificate that will be used for validating the regional domain name.
    - regionalCertificateArn
```
String regionalCertificateArn
```
      The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
    - distributionDomainName
```
String distributionDomainName
```
      The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
    - distributionHostedZoneId
```
String distributionHostedZoneId
```
      The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
    - endpointConfiguration
```
EndpointConfiguration endpointConfiguration
```
      The endpoint configuration of this DomainName showing the endpoint types of the domain name.
    - domainNameStatus
```
String domainNameStatus
```
      The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
    - domainNameStatusMessage
```
String domainNameStatusMessage
```
      An optional text message containing detailed information about status of the DomainName migration.
    - securityPolicy
```
String securityPolicy
```
      The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.CreateModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The RestApi identifier under which the Model will be created.
    - name
```
String name
```
      [Required] The name of the model. Must be alphanumeric.
    - description
```
String description
```
      The description of the model.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON schema draft 4 model.
    - contentType
```
String contentType
```
      [Required] The content-type for the model.
- Class com.amazonaws.services.apigateway.model.CreateModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the model resource.
    - name
```
String name
```
      The name of the model. Must be an alphanumeric string.
    - description
```
String description
```
      The description of the model.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
    - contentType
```
String contentType
```
      The content-type for the model.
- Class com.amazonaws.services.apigateway.model.CreateRequestValidatorRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - name
```
String name
```
      The name of the to-be-created RequestValidator.
    - validateRequestBody
```
Boolean validateRequestBody
```
      A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).
    - validateRequestParameters
```
Boolean validateRequestParameters
```
      A Boolean flag to indicate whether to validate request parameters, true, or not false.
- Class com.amazonaws.services.apigateway.model.CreateRequestValidatorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of this RequestValidator.
    - name
```
String name
```
      The name of this RequestValidator
    - validateRequestBody
```
Boolean validateRequestBody
```
      A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    - validateRequestParameters
```
Boolean validateRequestParameters
```
      A Boolean flag to indicate whether to validate request parameters (true) or not (false ).
- Class com.amazonaws.services.apigateway.model.CreateResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - parentId
```
String parentId
```
      [Required] The parent resource's identifier.
    - pathPart
```
String pathPart
```
      The last path segment for this resource.
- Class com.amazonaws.services.apigateway.model.CreateResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The resource's identifier.
    - parentId
```
String parentId
```
      The parent resource's identifier.
    - pathPart
```
String pathPart
```
      The last path segment for this resource.
    - path
```
String path
```
      The full path for this resource.
    - resourceMethods
```
Map<K,V> resourceMethods
```
      Gets an API resource's method of a given HTTP verb.
      
      The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.
      
      Example: Get the GET method of an API resource
      
      Request
      
      GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }
      
      If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.
- Class com.amazonaws.services.apigateway.model.CreateRestApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      [Required] The name of the RestApi.
    - description
```
String description
```
      The description of the RestApi.
    - version
```
String version
```
      A version identifier for the API.
    - cloneFrom
```
String cloneFrom
```
      The ID of the RestApi that you want to clone from.
    - binaryMediaTypes
```
List<E> binaryMediaTypes
```
      The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    - minimumCompressionSize
```
Integer minimumCompressionSize
```
      A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
    - apiKeySource
```
String apiKeySource
```
      The source of the API key for metering requests according to a usage plan. Valid values are:
      
      HEADER to read the API key from the X-API-Key header of a request.
      
      AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    - endpointConfiguration
```
EndpointConfiguration endpointConfiguration
```
      The endpoint configuration of this RestApi showing the endpoint types of the API.
    - policy
```
String policy
```
      A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
    - tags
```
Map<K,V> tags
```
      The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- Class com.amazonaws.services.apigateway.model.CreateRestApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API's identifier. This identifier is unique across all of your APIs in API Gateway.
    - name
```
String name
```
      The API's name.
    - description
```
String description
```
      The API's description.
    - createdDate
```
Date createdDate
```
      The timestamp when the API was created.
    - version
```
String version
```
      A version identifier for the API.
    - warnings
```
List<E> warnings
```
      The warning messages reported when failonwarnings is turned on during API import.
    - binaryMediaTypes
```
List<E> binaryMediaTypes
```
      The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    - minimumCompressionSize
```
Integer minimumCompressionSize
```
      A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
    - apiKeySource
```
String apiKeySource
```
      The source of the API key for metering requests according to a usage plan. Valid values are:
      
      HEADER to read the API key from the X-API-Key header of a request.
      
      AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    - endpointConfiguration
```
EndpointConfiguration endpointConfiguration
```
      The endpoint configuration of this RestApi showing the endpoint types of the API.
    - policy
```
String policy
```
      A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.CreateStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - stageName
```
String stageName
```
      [Required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
    - deploymentId
```
String deploymentId
```
      [Required] The identifier of the Deployment resource for the Stage resource.
    - description
```
String description
```
      The description of the Stage resource.
    - cacheClusterEnabled
```
Boolean cacheClusterEnabled
```
      Whether cache clustering is enabled for the stage.
    - cacheClusterSize
```
String cacheClusterSize
```
      The stage's cache cluster size.
    - variables
```
Map<K,V> variables
```
      A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    - documentationVersion
```
String documentationVersion
```
      The version of the associated API documentation.
    - canarySettings
```
CanarySettings canarySettings
```
      The canary deployment settings of this stage.
    - tracingEnabled
```
Boolean tracingEnabled
```
      Specifies whether active tracing with X-ray is enabled for the Stage.
    - tags
```
Map<K,V> tags
```
      The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- Class com.amazonaws.services.apigateway.model.CreateStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment that the stage points to.
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of a client certificate for an API stage.
    - stageName
```
String stageName
```
      The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
    - description
```
String description
```
      The stage's description.
    - cacheClusterEnabled
```
Boolean cacheClusterEnabled
```
      Specifies whether a cache cluster is enabled for the stage.
    - cacheClusterSize
```
String cacheClusterSize
```
      The size of the cache cluster for the stage, if enabled.
    - cacheClusterStatus
```
String cacheClusterStatus
```
      The status of the cache cluster for the stage, if enabled.
    - methodSettings
```
Map<K,V> methodSettings
```
      A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
    - variables
```
Map<K,V> variables
```
      A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    - documentationVersion
```
String documentationVersion
```
      The version of the associated API documentation.
    - accessLogSettings
```
AccessLogSettings accessLogSettings
```
      Settings for logging access in this stage.
    - canarySettings
```
CanarySettings canarySettings
```
      Settings for the canary deployment in this stage.
    - tracingEnabled
```
Boolean tracingEnabled
```
      Specifies whether active tracing with X-ray is enabled for the Stage.
    - webAclArn
```
String webAclArn
```
      The ARN of the WebAcl associated with the Stage.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
    - createdDate
```
Date createdDate
```
      The timestamp when the stage was created.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The timestamp when the stage last updated.
- Class com.amazonaws.services.apigateway.model.CreateUsagePlanKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - usagePlanId
```
String usagePlanId
```
      [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.
    - keyId
```
String keyId
```
      [Required] The identifier of a UsagePlanKey resource for a plan customer.
    - keyType
```
String keyType
```
      [Required] The type of a UsagePlanKey resource for a plan customer.
- Class com.amazonaws.services.apigateway.model.CreateUsagePlanKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The Id of a usage plan key.
    - type
```
String type
```
      The type of a usage plan key. Currently, the valid key type is API_KEY.
    - value
```
String value
```
      The value of a usage plan key.
    - name
```
String name
```
      The name of a usage plan key.
- Class com.amazonaws.services.apigateway.model.CreateUsagePlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      [Required] The name of the usage plan.
    - description
```
String description
```
      The description of the usage plan.
    - apiStages
```
List<E> apiStages
```
      The associated API stages of the usage plan.
    - throttle
```
ThrottleSettings throttle
```
      The throttling limits of the usage plan.
    - quota
```
QuotaSettings quota
```
      The quota of the usage plan.
    - tags
```
Map<K,V> tags
```
      The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- Class com.amazonaws.services.apigateway.model.CreateUsagePlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of a UsagePlan resource.
    - name
```
String name
```
      The name of a usage plan.
    - description
```
String description
```
      The description of a usage plan.
    - apiStages
```
List<E> apiStages
```
      The associated API stages of a usage plan.
    - throttle
```
ThrottleSettings throttle
```
      The request throttle limits of a usage plan.
    - quota
```
QuotaSettings quota
```
      The maximum number of permitted requests per a given unit time interval.
    - productCode
```
String productCode
```
      The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.CreateVpcLinkRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      [Required] The name used to label and identify the VPC link.
    - description
```
String description
```
      The description of the VPC link.
    - targetArns
```
List<E> targetArns
```
      [Required] The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
    - tags
```
Map<K,V> tags
```
      The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- Class com.amazonaws.services.apigateway.model.CreateVpcLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
    - name
```
String name
```
      The name used to label and identify the VPC link.
    - description
```
String description
```
      The description of the VPC link.
    - targetArns
```
List<E> targetArns
```
      The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
    - status
```
String status
```
      The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.
    - statusMessage
```
String statusMessage
```
      A description about the VPC link status.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.DeleteApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiKey
```
String apiKey
```
      [Required] The identifier of the ApiKey resource to be deleted.
- Class com.amazonaws.services.apigateway.model.DeleteApiKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - authorizerId
```
String authorizerId
```
      [Required] The identifier of the Authorizer resource.
- Class com.amazonaws.services.apigateway.model.DeleteAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteBasePathMappingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      [Required] The domain name of the BasePathMapping resource to delete.
    - basePath
```
String basePath
```
      [Required] The base path name of the BasePathMapping resource to delete.
      
      To specify an empty base path, set this parameter to '(none)'.
- Class com.amazonaws.services.apigateway.model.DeleteBasePathMappingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteClientCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      [Required] The identifier of the ClientCertificate resource to be deleted.
- Class com.amazonaws.services.apigateway.model.DeleteClientCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - deploymentId
```
String deploymentId
```
      [Required] The identifier of the Deployment resource to delete.
- Class com.amazonaws.services.apigateway.model.DeleteDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteDocumentationPartRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - documentationPartId
```
String documentationPartId
```
      [Required] The identifier of the to-be-deleted documentation part.
- Class com.amazonaws.services.apigateway.model.DeleteDocumentationPartResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteDocumentationVersionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - documentationVersion
```
String documentationVersion
```
      [Required] The version identifier of a to-be-deleted documentation snapshot.
- Class com.amazonaws.services.apigateway.model.DeleteDocumentationVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteDomainNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      [Required] The name of the DomainName resource to be deleted.
- Class com.amazonaws.services.apigateway.model.DeleteDomainNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteGatewayResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - responseType
```
String responseType
```
      [Required]
      The response type of the associated GatewayResponse. Valid values are
      
      ACCESS_DENIED
      
      API_CONFIGURATION_ERROR
      
      AUTHORIZER_FAILURE
      
      AUTHORIZER_CONFIGURATION_ERROR
      
      BAD_REQUEST_PARAMETERS
      
      BAD_REQUEST_BODY
      
      DEFAULT_4XX
      
      DEFAULT_5XX
      
      EXPIRED_TOKEN
      
      INVALID_SIGNATURE
      
      INTEGRATION_FAILURE
      
      INTEGRATION_TIMEOUT
      
      INVALID_API_KEY
      
      MISSING_AUTHENTICATION_TOKEN
      
      QUOTA_EXCEEDED
      
      REQUEST_TOO_LARGE
      
      RESOURCE_NOT_FOUND
      
      THROTTLED
      
      UNAUTHORIZED
      
      UNSUPPORTED_MEDIA_TYPE
- Class com.amazonaws.services.apigateway.model.DeleteGatewayResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteIntegrationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] Specifies a delete integration request's resource identifier.
    - httpMethod
```
String httpMethod
```
      [Required] Specifies a delete integration request's HTTP method.
- Class com.amazonaws.services.apigateway.model.DeleteIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] Specifies a delete integration response request's resource identifier.
    - httpMethod
```
String httpMethod
```
      [Required] Specifies a delete integration response request's HTTP method.
    - statusCode
```
String statusCode
```
      [Required] Specifies a delete integration response request's status code.
- Class com.amazonaws.services.apigateway.model.DeleteIntegrationResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteMethodRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] The Resource identifier for the Method resource.
    - httpMethod
```
String httpMethod
```
      [Required] The HTTP verb of the Method resource.
- Class com.amazonaws.services.apigateway.model.DeleteMethodResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] The Resource identifier for the MethodResponse resource.
    - httpMethod
```
String httpMethod
```
      [Required] The HTTP verb of the Method resource.
    - statusCode
```
String statusCode
```
      [Required] The status code identifier for the MethodResponse resource.
- Class com.amazonaws.services.apigateway.model.DeleteMethodResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteMethodResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - modelName
```
String modelName
```
      [Required] The name of the model to delete.
- Class com.amazonaws.services.apigateway.model.DeleteModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteRequestValidatorRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - requestValidatorId
```
String requestValidatorId
```
      [Required] The identifier of the RequestValidator to be deleted.
- Class com.amazonaws.services.apigateway.model.DeleteRequestValidatorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] The identifier of the Resource resource.
- Class com.amazonaws.services.apigateway.model.DeleteResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteRestApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
- Class com.amazonaws.services.apigateway.model.DeleteRestApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - stageName
```
String stageName
```
      [Required] The name of the Stage resource to delete.
- Class com.amazonaws.services.apigateway.model.DeleteStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteUsagePlanKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - usagePlanId
```
String usagePlanId
```
      [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
    - keyId
```
String keyId
```
      [Required] The Id of the UsagePlanKey resource to be deleted.
- Class com.amazonaws.services.apigateway.model.DeleteUsagePlanKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteUsagePlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - usagePlanId
```
String usagePlanId
```
      [Required] The Id of the to-be-deleted usage plan.
- Class com.amazonaws.services.apigateway.model.DeleteUsagePlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.DeleteVpcLinkRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcLinkId
```
String vpcLinkId
```
      [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
- Class com.amazonaws.services.apigateway.model.DeleteVpcLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.Deployment extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the deployment resource.
    - description
```
String description
```
      The description for the deployment resource.
    - createdDate
```
Date createdDate
```
      The date and time that the deployment resource was created.
    - apiSummary
```
Map<K,V> apiSummary
```
      A summary of the RestApi at the date and time that the deployment resource was created.
- Class com.amazonaws.services.apigateway.model.DeploymentCanarySettings extends Object implements Serializable
  - Serialized Fields
    - percentTraffic
```
Double percentTraffic
```
      The percentage (0.0-100.0) of traffic routed to the canary deployment.
    - stageVariableOverrides
```
Map<K,V> stageVariableOverrides
```
      A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.
    - useStageCache
```
Boolean useStageCache
```
      A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
- Class com.amazonaws.services.apigateway.model.DocumentationPart extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
    - location
```
DocumentationPartLocation location
```
      The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
    - properties
```
String properties
```
      A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.
- Class com.amazonaws.services.apigateway.model.DocumentationPartLocation extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      [Required] The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type.
    - path
```
String path
```
      The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.
    - method
```
String method
```
      The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.
    - statusCode
```
String statusCode
```
      The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.
    - name
```
String name
```
      The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type.
- Class com.amazonaws.services.apigateway.model.DocumentationVersion extends Object implements Serializable
  - Serialized Fields
    - version
```
String version
```
      The version identifier of the API documentation snapshot.
    - createdDate
```
Date createdDate
```
      The date when the API documentation snapshot is created.
    - description
```
String description
```
      The description of the API documentation snapshot.
- Class com.amazonaws.services.apigateway.model.DomainName extends Object implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The custom domain name as an API host name, for example, my-api.example.com.
    - certificateName
```
String certificateName
```
      The name of the certificate that will be used by edge-optimized endpoint for this domain name.
    - certificateArn
```
String certificateArn
```
      The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    - certificateUploadDate
```
Date certificateUploadDate
```
      The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
    - regionalDomainName
```
String regionalDomainName
```
      The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
    - regionalHostedZoneId
```
String regionalHostedZoneId
```
      The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
    - regionalCertificateName
```
String regionalCertificateName
```
      The name of the certificate that will be used for validating the regional domain name.
    - regionalCertificateArn
```
String regionalCertificateArn
```
      The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
    - distributionDomainName
```
String distributionDomainName
```
      The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
    - distributionHostedZoneId
```
String distributionHostedZoneId
```
      The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
    - endpointConfiguration
```
EndpointConfiguration endpointConfiguration
```
      The endpoint configuration of this DomainName showing the endpoint types of the domain name.
    - domainNameStatus
```
String domainNameStatus
```
      The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
    - domainNameStatusMessage
```
String domainNameStatusMessage
```
      An optional text message containing detailed information about status of the DomainName migration.
    - securityPolicy
```
String securityPolicy
```
      The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.EndpointConfiguration extends Object implements Serializable
  - Serialized Fields
    - types
```
List<E> types
```
      A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.
    - vpcEndpointIds
```
List<E> vpcEndpointIds
```
      A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.
- Class com.amazonaws.services.apigateway.model.FlushStageAuthorizersCacheRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The string identifier of the associated RestApi.
    - stageName
```
String stageName
```
      The name of the stage to flush.
- Class com.amazonaws.services.apigateway.model.FlushStageAuthorizersCacheResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.FlushStageCacheRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - stageName
```
String stageName
```
      [Required] The name of the stage to flush its cache.
- Class com.amazonaws.services.apigateway.model.FlushStageCacheResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.GatewayResponse extends Object implements Serializable
  - Serialized Fields
    - responseType
```
String responseType
```
      The response type of the associated GatewayResponse. Valid values are
      
      ACCESS_DENIED
      
      API_CONFIGURATION_ERROR
      
      AUTHORIZER_FAILURE
      
      AUTHORIZER_CONFIGURATION_ERROR
      
      BAD_REQUEST_PARAMETERS
      
      BAD_REQUEST_BODY
      
      DEFAULT_4XX
      
      DEFAULT_5XX
      
      EXPIRED_TOKEN
      
      INVALID_SIGNATURE
      
      INTEGRATION_FAILURE
      
      INTEGRATION_TIMEOUT
      
      INVALID_API_KEY
      
      MISSING_AUTHENTICATION_TOKEN
      
      QUOTA_EXCEEDED
      
      REQUEST_TOO_LARGE
      
      RESOURCE_NOT_FOUND
      
      THROTTLED
      
      UNAUTHORIZED
      
      UNSUPPORTED_MEDIA_TYPE
    - statusCode
```
String statusCode
```
      The HTTP status code for this GatewayResponse.
    - responseParameters
```
Map<K,V> responseParameters
```
      Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    - defaultResponse
```
Boolean defaultResponse
```
      A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true ) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.
- Class com.amazonaws.services.apigateway.model.GenerateClientCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - description
```
String description
```
      The description of the ClientCertificate.
    - tags
```
Map<K,V> tags
```
      The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- Class com.amazonaws.services.apigateway.model.GenerateClientCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of the client certificate.
    - description
```
String description
```
      The description of the client certificate.
    - pemEncodedCertificate
```
String pemEncodedCertificate
```
      The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
    - createdDate
```
Date createdDate
```
      The timestamp when the client certificate was created.
    - expirationDate
```
Date expirationDate
```
      The timestamp when the client certificate will expire.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.GetAccountRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.apigateway.model.GetAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - cloudwatchRoleArn
```
String cloudwatchRoleArn
```
      The ARN of an Amazon CloudWatch role for the current Account.
    - throttleSettings
```
ThrottleSettings throttleSettings
```
      Specifies the API request limits configured for the current Account.
    - features
```
List<E> features
```
      A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".
    - apiKeyVersion
```
String apiKeyVersion
```
      The version of the API keys used for the account.
- Class com.amazonaws.services.apigateway.model.GetApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiKey
```
String apiKey
```
      [Required] The identifier of the ApiKey resource.
    - includeValue
```
Boolean includeValue
```
      A boolean flag to specify whether (true) or not (false) the result contains the key value.
- Class com.amazonaws.services.apigateway.model.GetApiKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the API Key.
    - value
```
String value
```
      The value of the API Key.
    - name
```
String name
```
      The name of the API Key.
    - customerId
```
String customerId
```
      An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
    - description
```
String description
```
      The description of the API Key.
    - enabled
```
Boolean enabled
```
      Specifies whether the API Key can be used by callers.
    - createdDate
```
Date createdDate
```
      The timestamp when the API Key was created.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The timestamp when the API Key was last updated.
    - stageKeys
```
List<E> stageKeys
```
      A list of Stage resources that are associated with the ApiKey resource.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.GetApiKeysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    - nameQuery
```
String nameQuery
```
      The name of queried API keys.
    - customerId
```
String customerId
```
      The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.
    - includeValues
```
Boolean includeValues
```
      A boolean flag to specify whether (true) or not (false) the result contains key values.
- Class com.amazonaws.services.apigateway.model.GetApiKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - warnings
```
List<E> warnings
```
      A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - authorizerId
```
String authorizerId
```
      [Required] The identifier of the Authorizer resource.
- Class com.amazonaws.services.apigateway.model.GetAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the authorizer resource.
    - name
```
String name
```
      [Required] The name of the authorizer.
    - type
```
String type
```
      The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    - providerARNs
```
List<E> providerARNs
```
      A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
    - authType
```
String authType
```
      Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
    - authorizerUri
```
String authorizerUri
```
      Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
    - authorizerCredentials
```
String authorizerCredentials
```
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
    - identitySource
```
String identitySource
```
      The identity source for which authorization is requested.
      
      For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
      
      For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
    - identityValidationExpression
```
String identityValidationExpression
```
      A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- Class com.amazonaws.services.apigateway.model.GetAuthorizersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetAuthorizersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetBasePathMappingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      [Required] The domain name of the BasePathMapping resource to be described.
    - basePath
```
String basePath
```
      [Required] 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. Specify '(none)' if you do not want callers to specify any base path name after the domain name.
- Class com.amazonaws.services.apigateway.model.GetBasePathMappingResult extends AmazonWebServiceResult<ResponseMetadata> 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 string identifier of the associated RestApi.
    - stage
```
String stage
```
      The name of the associated stage.
- Class com.amazonaws.services.apigateway.model.GetBasePathMappingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      [Required] The domain name of a BasePathMapping resource.
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetBasePathMappingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetClientCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      [Required] The identifier of the ClientCertificate resource to be described.
- Class com.amazonaws.services.apigateway.model.GetClientCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of the client certificate.
    - description
```
String description
```
      The description of the client certificate.
    - pemEncodedCertificate
```
String pemEncodedCertificate
```
      The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
    - createdDate
```
Date createdDate
```
      The timestamp when the client certificate was created.
    - expirationDate
```
Date expirationDate
```
      The timestamp when the client certificate will expire.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.GetClientCertificatesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetClientCertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - deploymentId
```
String deploymentId
```
      [Required] The identifier of the Deployment resource to get information about.
    - embed
```
List<E> embed
```
      A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.
- Class com.amazonaws.services.apigateway.model.GetDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the deployment resource.
    - description
```
String description
```
      The description for the deployment resource.
    - createdDate
```
Date createdDate
```
      The date and time that the deployment resource was created.
    - apiSummary
```
Map<K,V> apiSummary
```
      A summary of the RestApi at the date and time that the deployment resource was created.
- Class com.amazonaws.services.apigateway.model.GetDeploymentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetDeploymentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetDocumentationPartRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - documentationPartId
```
String documentationPartId
```
      [Required] The string identifier of the associated RestApi.
- Class com.amazonaws.services.apigateway.model.GetDocumentationPartResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
    - location
```
DocumentationPartLocation location
```
      The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
    - properties
```
String properties
```
      A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.
- Class com.amazonaws.services.apigateway.model.GetDocumentationPartsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - type
```
String type
```
      The type of API entities of the to-be-retrieved documentation parts.
    - nameQuery
```
String nameQuery
```
      The name of API entities of the to-be-retrieved documentation parts.
    - path
```
String path
```
      The path of API entities of the to-be-retrieved documentation parts.
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    - locationStatus
```
String locationStatus
```
      The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
- Class com.amazonaws.services.apigateway.model.GetDocumentationPartsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetDocumentationVersionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - documentationVersion
```
String documentationVersion
```
      [Required] The version identifier of the to-be-retrieved documentation snapshot.
- Class com.amazonaws.services.apigateway.model.GetDocumentationVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - version
```
String version
```
      The version identifier of the API documentation snapshot.
    - createdDate
```
Date createdDate
```
      The date when the API documentation snapshot is created.
    - description
```
String description
```
      The description of the API documentation snapshot.
- Class com.amazonaws.services.apigateway.model.GetDocumentationVersionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetDocumentationVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetDomainNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      [Required] The name of the DomainName resource.
- Class com.amazonaws.services.apigateway.model.GetDomainNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The custom domain name as an API host name, for example, my-api.example.com.
    - certificateName
```
String certificateName
```
      The name of the certificate that will be used by edge-optimized endpoint for this domain name.
    - certificateArn
```
String certificateArn
```
      The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    - certificateUploadDate
```
Date certificateUploadDate
```
      The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
    - regionalDomainName
```
String regionalDomainName
```
      The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
    - regionalHostedZoneId
```
String regionalHostedZoneId
```
      The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
    - regionalCertificateName
```
String regionalCertificateName
```
      The name of the certificate that will be used for validating the regional domain name.
    - regionalCertificateArn
```
String regionalCertificateArn
```
      The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
    - distributionDomainName
```
String distributionDomainName
```
      The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
    - distributionHostedZoneId
```
String distributionHostedZoneId
```
      The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
    - endpointConfiguration
```
EndpointConfiguration endpointConfiguration
```
      The endpoint configuration of this DomainName showing the endpoint types of the domain name.
    - domainNameStatus
```
String domainNameStatus
```
      The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
    - domainNameStatusMessage
```
String domainNameStatusMessage
```
      An optional text message containing detailed information about status of the DomainName migration.
    - securityPolicy
```
String securityPolicy
```
      The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.GetDomainNamesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetDomainNamesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetExportRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - stageName
```
String stageName
```
      [Required] The name of the Stage that will be exported.
    - exportType
```
String exportType
```
      [Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.
    - parameters
```
Map<K,V> parameters
```
      A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool
    - accepts
```
String accepts
```
      The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType of oas30 and swagger. This should be specified in the Accept header for direct API requests.
- Class com.amazonaws.services.apigateway.model.GetExportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contentType
```
String contentType
```
      The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.
    - contentDisposition
```
String contentDisposition
```
      The content-disposition header value in the HTTP response.
    - body
```
ByteBuffer body
```
      The binary blob response to GetExport, which contains the export.
- Class com.amazonaws.services.apigateway.model.GetGatewayResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - responseType
```
String responseType
```
      [Required]
      The response type of the associated GatewayResponse. Valid values are
      
      ACCESS_DENIED
      
      API_CONFIGURATION_ERROR
      
      AUTHORIZER_FAILURE
      
      AUTHORIZER_CONFIGURATION_ERROR
      
      BAD_REQUEST_PARAMETERS
      
      BAD_REQUEST_BODY
      
      DEFAULT_4XX
      
      DEFAULT_5XX
      
      EXPIRED_TOKEN
      
      INVALID_SIGNATURE
      
      INTEGRATION_FAILURE
      
      INTEGRATION_TIMEOUT
      
      INVALID_API_KEY
      
      MISSING_AUTHENTICATION_TOKEN
      
      QUOTA_EXCEEDED
      
      REQUEST_TOO_LARGE
      
      RESOURCE_NOT_FOUND
      
      THROTTLED
      
      UNAUTHORIZED
      
      UNSUPPORTED_MEDIA_TYPE
- Class com.amazonaws.services.apigateway.model.GetGatewayResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - responseType
```
String responseType
```
      The response type of the associated GatewayResponse. Valid values are
      
      ACCESS_DENIED
      
      API_CONFIGURATION_ERROR
      
      AUTHORIZER_FAILURE
      
      AUTHORIZER_CONFIGURATION_ERROR
      
      BAD_REQUEST_PARAMETERS
      
      BAD_REQUEST_BODY
      
      DEFAULT_4XX
      
      DEFAULT_5XX
      
      EXPIRED_TOKEN
      
      INVALID_SIGNATURE
      
      INTEGRATION_FAILURE
      
      INTEGRATION_TIMEOUT
      
      INVALID_API_KEY
      
      MISSING_AUTHENTICATION_TOKEN
      
      QUOTA_EXCEEDED
      
      REQUEST_TOO_LARGE
      
      RESOURCE_NOT_FOUND
      
      THROTTLED
      
      UNAUTHORIZED
      
      UNSUPPORTED_MEDIA_TYPE
    - statusCode
```
String statusCode
```
      The HTTP status code for this GatewayResponse.
    - responseParameters
```
Map<K,V> responseParameters
```
      Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    - defaultResponse
```
Boolean defaultResponse
```
      A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true ) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.
- Class com.amazonaws.services.apigateway.model.GetGatewayResponsesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - position
```
String position
```
      The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.
- Class com.amazonaws.services.apigateway.model.GetGatewayResponsesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      Returns the entire collection, because of no pagination support.
- Class com.amazonaws.services.apigateway.model.GetIntegrationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] Specifies a get integration request's resource identifier
    - httpMethod
```
String httpMethod
```
      [Required] Specifies a get integration request's HTTP method.
- Class com.amazonaws.services.apigateway.model.GetIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] Specifies a get integration response request's resource identifier.
    - httpMethod
```
String httpMethod
```
      [Required] Specifies a get integration response request's HTTP method.
    - statusCode
```
String statusCode
```
      [Required] Specifies a get integration response request's status code.
- Class com.amazonaws.services.apigateway.model.GetIntegrationResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      Specifies the status code that is used to map the integration response to an existing MethodResponse.
    - selectionPattern
```
String selectionPattern
```
      Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    - contentHandling
```
String contentHandling
```
      Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Class com.amazonaws.services.apigateway.model.GetIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - type
```
String type
```
      Specifies an API method integration type. The valid value is one of the following:
      
      AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
      
      AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
      
      HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
      
      HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
      
      MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
      
      For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
    - httpMethod
```
String httpMethod
```
      Specifies the integration's HTTP method type.
    - uri
```
String uri
```
      Specifies Uniform Resource Identifier (URI) of the integration endpoint.
      
      For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
      
      For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
    - connectionType
```
String connectionType
```
      The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    - connectionId
```
String connectionId
```
      The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    - 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 API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
    - requestTemplates
```
Map<K,V> 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.
    - passthroughBehavior
```
String passthroughBehavior
```
      Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
      
      WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
      
      WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
      
      NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    - contentHandling
```
String contentHandling
```
      Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
    - timeoutInMillis
```
Integer timeoutInMillis
```
      Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    - cacheNamespace
```
String cacheNamespace
```
      An API-specific tag group of related cached parameters. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    - cacheKeyParameters
```
List<E> cacheKeyParameters
```
      A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    - integrationResponses
```
Map<K,V> integrationResponses
```
      Specifies the integration's responses.
      
      Example: Get integration responses of a method
      
      Request
      
      GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      The successful response returns 200 OK status and a payload as follows:
      
      { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
      
      Creating an API
- Class com.amazonaws.services.apigateway.model.GetMethodRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] The Resource identifier for the Method resource.
    - httpMethod
```
String httpMethod
```
      [Required] Specifies the method request's HTTP method type.
- Class com.amazonaws.services.apigateway.model.GetMethodResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] The Resource identifier for the MethodResponse resource.
    - httpMethod
```
String httpMethod
```
      [Required] The HTTP verb of the Method resource.
    - statusCode
```
String statusCode
```
      [Required] The status code for the MethodResponse resource.
- Class com.amazonaws.services.apigateway.model.GetMethodResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      The method response's status code.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
    - responseModels
```
Map<K,V> responseModels
```
      Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
- Class com.amazonaws.services.apigateway.model.GetMethodResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - httpMethod
```
String httpMethod
```
      The method's HTTP verb.
    - authorizationType
```
String authorizationType
```
      The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
    - authorizerId
```
String authorizerId
```
      The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      A boolean flag specifying whether a valid ApiKey is required to invoke this method.
    - requestValidatorId
```
String requestValidatorId
```
      The identifier of a RequestValidator for request validation.
    - operationName
```
String operationName
```
      A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
    - requestModels
```
Map<K,V> requestModels
```
      A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
    - methodResponses
```
Map<K,V> methodResponses
```
      Gets a method response associated with a given HTTP status code.
      
      The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.
      
      Example: Get a 200 OK response of a GET method
      
      Request
      
      GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      The successful response returns a 200 OK status code and a payload similar to the following:
      
      { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }
      
      AWS CLI
    - methodIntegration
```
Integration methodIntegration
```
      Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
      
      Example:
      
      Request
      
      GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      The successful response returns a 200 OK status code and a payload similar to the following:
      
      { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } }
      
      AWS CLI
    - authorizationScopes
```
List<E> authorizationScopes
```
      A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- Class com.amazonaws.services.apigateway.model.GetModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The RestApi identifier under which the Model exists.
    - modelName
```
String modelName
```
      [Required] The name of the model as an identifier.
    - flatten
```
Boolean flatten
```
      A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.
- Class com.amazonaws.services.apigateway.model.GetModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the model resource.
    - name
```
String name
```
      The name of the model. Must be an alphanumeric string.
    - description
```
String description
```
      The description of the model.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
    - contentType
```
String contentType
```
      The content-type for the model.
- Class com.amazonaws.services.apigateway.model.GetModelsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetModelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetModelTemplateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - modelName
```
String modelName
```
      [Required] The name of the model for which to generate a template.
- Class com.amazonaws.services.apigateway.model.GetModelTemplateResult extends AmazonWebServiceResult<ResponseMetadata> 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.GetRequestValidatorRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - requestValidatorId
```
String requestValidatorId
```
      [Required] The identifier of the RequestValidator to be retrieved.
- Class com.amazonaws.services.apigateway.model.GetRequestValidatorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of this RequestValidator.
    - name
```
String name
```
      The name of this RequestValidator
    - validateRequestBody
```
Boolean validateRequestBody
```
      A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    - validateRequestParameters
```
Boolean validateRequestParameters
```
      A Boolean flag to indicate whether to validate request parameters (true) or not (false ).
- Class com.amazonaws.services.apigateway.model.GetRequestValidatorsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetRequestValidatorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] The identifier for the Resource resource.
    - embed
```
List<E> embed
```
      A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods.
- Class com.amazonaws.services.apigateway.model.GetResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The resource's identifier.
    - parentId
```
String parentId
```
      The parent resource's identifier.
    - pathPart
```
String pathPart
```
      The last path segment for this resource.
    - path
```
String path
```
      The full path for this resource.
    - resourceMethods
```
Map<K,V> resourceMethods
```
      Gets an API resource's method of a given HTTP verb.
      
      The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.
      
      Example: Get the GET method of an API resource
      
      Request
      
      GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }
      
      If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.
- Class com.amazonaws.services.apigateway.model.GetResourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    - embed
```
List<E> embed
```
      A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.
- Class com.amazonaws.services.apigateway.model.GetResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetRestApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
- Class com.amazonaws.services.apigateway.model.GetRestApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API's identifier. This identifier is unique across all of your APIs in API Gateway.
    - name
```
String name
```
      The API's name.
    - description
```
String description
```
      The API's description.
    - createdDate
```
Date createdDate
```
      The timestamp when the API was created.
    - version
```
String version
```
      A version identifier for the API.
    - warnings
```
List<E> warnings
```
      The warning messages reported when failonwarnings is turned on during API import.
    - binaryMediaTypes
```
List<E> binaryMediaTypes
```
      The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    - minimumCompressionSize
```
Integer minimumCompressionSize
```
      A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
    - apiKeySource
```
String apiKeySource
```
      The source of the API key for metering requests according to a usage plan. Valid values are:
      
      HEADER to read the API key from the X-API-Key header of a request.
      
      AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    - endpointConfiguration
```
EndpointConfiguration endpointConfiguration
```
      The endpoint configuration of this RestApi showing the endpoint types of the API.
    - policy
```
String policy
```
      A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.GetRestApisRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetRestApisResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetSdkRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - stageName
```
String stageName
```
      [Required] The name of the Stage that the SDK will use.
    - sdkType
```
String sdkType
```
      [Required] The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
    - parameters
```
Map<K,V> parameters
```
      A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.
- Class com.amazonaws.services.apigateway.model.GetSdkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contentType
```
String contentType
```
      The content-type header value in the HTTP response.
    - contentDisposition
```
String contentDisposition
```
      The content-disposition header value in the HTTP response.
    - body
```
ByteBuffer body
```
      The binary blob response to GetSdk, which contains the generated SDK.
- Class com.amazonaws.services.apigateway.model.GetSdkTypeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      [Required] The identifier of the queried SdkType instance.
- Class com.amazonaws.services.apigateway.model.GetSdkTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of an SdkType instance.
    - friendlyName
```
String friendlyName
```
      The user-friendly name of an SdkType instance.
    - description
```
String description
```
      The description of an SdkType.
    - configurationProperties
```
List<E> configurationProperties
```
      A list of configuration properties of an SdkType.
- Class com.amazonaws.services.apigateway.model.GetSdkTypesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetSdkTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - stageName
```
String stageName
```
      [Required] The name of the Stage resource to get information about.
- Class com.amazonaws.services.apigateway.model.GetStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment that the stage points to.
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of a client certificate for an API stage.
    - stageName
```
String stageName
```
      The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
    - description
```
String description
```
      The stage's description.
    - cacheClusterEnabled
```
Boolean cacheClusterEnabled
```
      Specifies whether a cache cluster is enabled for the stage.
    - cacheClusterSize
```
String cacheClusterSize
```
      The size of the cache cluster for the stage, if enabled.
    - cacheClusterStatus
```
String cacheClusterStatus
```
      The status of the cache cluster for the stage, if enabled.
    - methodSettings
```
Map<K,V> methodSettings
```
      A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
    - variables
```
Map<K,V> variables
```
      A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    - documentationVersion
```
String documentationVersion
```
      The version of the associated API documentation.
    - accessLogSettings
```
AccessLogSettings accessLogSettings
```
      Settings for logging access in this stage.
    - canarySettings
```
CanarySettings canarySettings
```
      Settings for the canary deployment in this stage.
    - tracingEnabled
```
Boolean tracingEnabled
```
      Specifies whether active tracing with X-ray is enabled for the Stage.
    - webAclArn
```
String webAclArn
```
      The ARN of the WebAcl associated with the Stage.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
    - createdDate
```
Date createdDate
```
      The timestamp when the stage was created.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The timestamp when the stage last updated.
- Class com.amazonaws.services.apigateway.model.GetStagesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - deploymentId
```
String deploymentId
```
      The stages' deployment identifiers.
- Class com.amazonaws.services.apigateway.model.GetStagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - item
```
List<E> item
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.
    - position
```
String position
```
      (Not currently supported) The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      (Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.GetUsagePlanKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - usagePlanId
```
String usagePlanId
```
      [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
    - keyId
```
String keyId
```
      [Required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.
- Class com.amazonaws.services.apigateway.model.GetUsagePlanKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The Id of a usage plan key.
    - type
```
String type
```
      The type of a usage plan key. Currently, the valid key type is API_KEY.
    - value
```
String value
```
      The value of a usage plan key.
    - name
```
String name
```
      The name of a usage plan key.
- Class com.amazonaws.services.apigateway.model.GetUsagePlanKeysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - usagePlanId
```
String usagePlanId
```
      [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
    - nameQuery
```
String nameQuery
```
      A query parameter specifying the name of the to-be-returned usage plan keys.
- Class com.amazonaws.services.apigateway.model.GetUsagePlanKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetUsagePlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - usagePlanId
```
String usagePlanId
```
      [Required] The identifier of the UsagePlan resource to be retrieved.
- Class com.amazonaws.services.apigateway.model.GetUsagePlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of a UsagePlan resource.
    - name
```
String name
```
      The name of a usage plan.
    - description
```
String description
```
      The description of a usage plan.
    - apiStages
```
List<E> apiStages
```
      The associated API stages of a usage plan.
    - throttle
```
ThrottleSettings throttle
```
      The request throttle limits of a usage plan.
    - quota
```
QuotaSettings quota
```
      The maximum number of permitted requests per a given unit time interval.
    - productCode
```
String productCode
```
      The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.GetUsagePlansRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - position
```
String position
```
      The current pagination position in the paged result set.
    - keyId
```
String keyId
```
      The identifier of the API key associated with the usage plans.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetUsagePlansResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.GetUsageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - usagePlanId
```
String usagePlanId
```
      [Required] The Id of the usage plan associated with the usage data.
    - keyId
```
String keyId
```
      The Id of the API key associated with the resultant usage data.
    - startDate
```
String startDate
```
      [Required] The starting date (e.g., 2016-01-01) of the usage data.
    - endDate
```
String endDate
```
      [Required] The ending date (e.g., 2016-12-31) of the usage data.
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - usagePlanId
```
String usagePlanId
```
      The plan Id associated with this usage data.
    - startDate
```
String startDate
```
      The starting date of the usage data.
    - endDate
```
String endDate
```
      The ending date of the usage data.
    - position
```
String position
```
    - items
```
Map<K,V> items
```
      The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].
- Class com.amazonaws.services.apigateway.model.GetVpcLinkRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcLinkId
```
String vpcLinkId
```
      [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
- Class com.amazonaws.services.apigateway.model.GetVpcLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
    - name
```
String name
```
      The name used to label and identify the VPC link.
    - description
```
String description
```
      The description of the VPC link.
    - targetArns
```
List<E> targetArns
```
      The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
    - status
```
String status
```
      The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.
    - statusMessage
```
String statusMessage
```
      A description about the VPC link status.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.GetVpcLinksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - position
```
String position
```
      The current pagination position in the paged result set.
    - limit
```
Integer limit
```
      The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
- Class com.amazonaws.services.apigateway.model.GetVpcLinksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of elements from this collection.
- Class com.amazonaws.services.apigateway.model.ImportApiKeysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - body
```
ByteBuffer body
```
      The payload of the POST request to import API keys. For the payload format, see API Key File Format.
    - format
```
String format
```
      A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.
    - failOnWarnings
```
Boolean failOnWarnings
```
      A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.
- Class com.amazonaws.services.apigateway.model.ImportApiKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - ids
```
List<E> ids
```
      A list of all the ApiKey identifiers.
    - warnings
```
List<E> warnings
```
      A list of warning messages.
- Class com.amazonaws.services.apigateway.model.ImportDocumentationPartsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - mode
```
String mode
```
      A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.
    - failOnWarnings
```
Boolean failOnWarnings
```
      A query parameter to specify whether to rollback the documentation importation (true) or not ( false) when a warning is encountered. The default value is false.
    - body
```
ByteBuffer body
```
      [Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.
- Class com.amazonaws.services.apigateway.model.ImportDocumentationPartsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - ids
```
List<E> ids
```
      A list of the returned documentation part identifiers.
    - warnings
```
List<E> warnings
```
      A list of warning messages reported during import of documentation parts.
- Class com.amazonaws.services.apigateway.model.ImportRestApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - failOnWarnings
```
Boolean failOnWarnings
```
      A query parameter to indicate whether to rollback the API creation (true) or not (false ) when a warning is encountered. The default value is false.
    - parameters
```
Map<K,V> parameters
```
      A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.
      
      To exclude DocumentationParts from the import, set parameters as ignore=documentation.
      
      To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.
      
      To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.
      
      For example, the AWS CLI command to exclude documentation from the imported API is:
      
      aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
      
      The AWS CLI command to set the regional endpoint on the imported API is:
      
      aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
    - body
```
ByteBuffer body
```
      [Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.
- Class com.amazonaws.services.apigateway.model.ImportRestApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API's identifier. This identifier is unique across all of your APIs in API Gateway.
    - name
```
String name
```
      The API's name.
    - description
```
String description
```
      The API's description.
    - createdDate
```
Date createdDate
```
      The timestamp when the API was created.
    - version
```
String version
```
      A version identifier for the API.
    - warnings
```
List<E> warnings
```
      The warning messages reported when failonwarnings is turned on during API import.
    - binaryMediaTypes
```
List<E> binaryMediaTypes
```
      The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    - minimumCompressionSize
```
Integer minimumCompressionSize
```
      A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
    - apiKeySource
```
String apiKeySource
```
      The source of the API key for metering requests according to a usage plan. Valid values are:
      
      HEADER to read the API key from the X-API-Key header of a request.
      
      AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    - endpointConfiguration
```
EndpointConfiguration endpointConfiguration
```
      The endpoint configuration of this RestApi showing the endpoint types of the API.
    - policy
```
String policy
```
      A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.Integration extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      Specifies an API method integration type. The valid value is one of the following:
      
      AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
      
      AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
      
      HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
      
      HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
      
      MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
      
      For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
    - httpMethod
```
String httpMethod
```
      Specifies the integration's HTTP method type.
    - uri
```
String uri
```
      Specifies Uniform Resource Identifier (URI) of the integration endpoint.
      
      For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
      
      For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
    - connectionType
```
String connectionType
```
      The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    - connectionId
```
String connectionId
```
      The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    - 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 API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
    - requestTemplates
```
Map<K,V> 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.
    - passthroughBehavior
```
String passthroughBehavior
```
      Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
      
      WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
      
      WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
      
      NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    - contentHandling
```
String contentHandling
```
      Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
    - timeoutInMillis
```
Integer timeoutInMillis
```
      Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    - cacheNamespace
```
String cacheNamespace
```
      An API-specific tag group of related cached parameters. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    - cacheKeyParameters
```
List<E> cacheKeyParameters
```
      A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    - integrationResponses
```
Map<K,V> integrationResponses
```
      Specifies the integration's responses.
      
      Example: Get integration responses of a method
      
      Request
      
      GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      The successful response returns 200 OK status and a payload as follows:
      
      { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
      
      Creating an API
- Class com.amazonaws.services.apigateway.model.IntegrationResponse extends Object implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      Specifies the status code that is used to map the integration response to an existing MethodResponse.
    - selectionPattern
```
String selectionPattern
```
      Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    - contentHandling
```
String contentHandling
```
      Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Class com.amazonaws.services.apigateway.model.LimitExceededException extends AmazonApiGatewayException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - retryAfterSeconds
```
String retryAfterSeconds
```
- Class com.amazonaws.services.apigateway.model.Method extends Object implements Serializable
  - Serialized Fields
    - httpMethod
```
String httpMethod
```
      The method's HTTP verb.
    - authorizationType
```
String authorizationType
```
      The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
    - authorizerId
```
String authorizerId
```
      The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      A boolean flag specifying whether a valid ApiKey is required to invoke this method.
    - requestValidatorId
```
String requestValidatorId
```
      The identifier of a RequestValidator for request validation.
    - operationName
```
String operationName
```
      A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
    - requestModels
```
Map<K,V> requestModels
```
      A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
    - methodResponses
```
Map<K,V> methodResponses
```
      Gets a method response associated with a given HTTP status code.
      
      The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.
      
      Example: Get a 200 OK response of a GET method
      
      Request
      
      GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      The successful response returns a 200 OK status code and a payload similar to the following:
      
      { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }
      
      AWS CLI
    - methodIntegration
```
Integration methodIntegration
```
      Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
      
      Example:
      
      Request
      
      GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      The successful response returns a 200 OK status code and a payload similar to the following:
      
      { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } }
      
      AWS CLI
    - authorizationScopes
```
List<E> authorizationScopes
```
      A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- Class com.amazonaws.services.apigateway.model.MethodResponse extends Object implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      The method response's status code.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
    - responseModels
```
Map<K,V> responseModels
```
      Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
- Class com.amazonaws.services.apigateway.model.MethodSetting extends Object implements Serializable
  - Serialized Fields
    - metricsEnabled
```
Boolean metricsEnabled
```
      Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.
    - loggingLevel
```
String loggingLevel
```
      Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO.
    - dataTraceEnabled
```
Boolean dataTraceEnabled
```
      Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.
    - throttlingBurstLimit
```
Integer throttlingBurstLimit
```
      Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.
    - throttlingRateLimit
```
Double throttlingRateLimit
```
      Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.
    - cachingEnabled
```
Boolean cachingEnabled
```
      Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.
    - cacheTtlInSeconds
```
Integer cacheTtlInSeconds
```
      Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.
    - cacheDataEncrypted
```
Boolean cacheDataEncrypted
```
      Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.
    - requireAuthorizationForCacheControl
```
Boolean requireAuthorizationForCacheControl
```
      Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.
    - unauthorizedCacheControlHeaderStrategy
```
String unauthorizedCacheControlHeaderStrategy
```
      Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.
- Class com.amazonaws.services.apigateway.model.MethodSnapshot extends Object implements Serializable
  - Serialized Fields
    - authorizationType
```
String authorizationType
```
      The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether the method requires a valid ApiKey.
- Class com.amazonaws.services.apigateway.model.Model extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the model resource.
    - name
```
String name
```
      The name of the model. Must be an alphanumeric string.
    - description
```
String description
```
      The description of the model.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
    - contentType
```
String contentType
```
      The content-type for the model.
- Class com.amazonaws.services.apigateway.model.NotFoundException extends AmazonApiGatewayException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigateway.model.PatchOperation extends Object implements Serializable
  - Serialized Fields
    - op
```
String op
```
      An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.
    - path
```
String path
```
      The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.
    - value
```
String value
```
      The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'. In a Windows shell, see Using JSON for Parameters.
    - from
```
String from
```
      The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId".
- Class com.amazonaws.services.apigateway.model.PutGatewayResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - responseType
```
String responseType
```
      [Required]
      The response type of the associated GatewayResponse. Valid values are
      
      ACCESS_DENIED
      
      API_CONFIGURATION_ERROR
      
      AUTHORIZER_FAILURE
      
      AUTHORIZER_CONFIGURATION_ERROR
      
      BAD_REQUEST_PARAMETERS
      
      BAD_REQUEST_BODY
      
      DEFAULT_4XX
      
      DEFAULT_5XX
      
      EXPIRED_TOKEN
      
      INVALID_SIGNATURE
      
      INTEGRATION_FAILURE
      
      INTEGRATION_TIMEOUT
      
      INVALID_API_KEY
      
      MISSING_AUTHENTICATION_TOKEN
      
      QUOTA_EXCEEDED
      
      REQUEST_TOO_LARGE
      
      RESOURCE_NOT_FOUND
      
      THROTTLED
      
      UNAUTHORIZED
      
      UNSUPPORTED_MEDIA_TYPE
    - statusCode
```
String statusCode
```
      The HTTP status code of the GatewayResponse.
    - responseParameters
```
Map<K,V> responseParameters
```
      Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
- Class com.amazonaws.services.apigateway.model.PutGatewayResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - responseType
```
String responseType
```
      The response type of the associated GatewayResponse. Valid values are
      
      ACCESS_DENIED
      
      API_CONFIGURATION_ERROR
      
      AUTHORIZER_FAILURE
      
      AUTHORIZER_CONFIGURATION_ERROR
      
      BAD_REQUEST_PARAMETERS
      
      BAD_REQUEST_BODY
      
      DEFAULT_4XX
      
      DEFAULT_5XX
      
      EXPIRED_TOKEN
      
      INVALID_SIGNATURE
      
      INTEGRATION_FAILURE
      
      INTEGRATION_TIMEOUT
      
      INVALID_API_KEY
      
      MISSING_AUTHENTICATION_TOKEN
      
      QUOTA_EXCEEDED
      
      REQUEST_TOO_LARGE
      
      RESOURCE_NOT_FOUND
      
      THROTTLED
      
      UNAUTHORIZED
      
      UNSUPPORTED_MEDIA_TYPE
    - statusCode
```
String statusCode
```
      The HTTP status code for this GatewayResponse.
    - responseParameters
```
Map<K,V> responseParameters
```
      Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    - defaultResponse
```
Boolean defaultResponse
```
      A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true ) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.
- Class com.amazonaws.services.apigateway.model.PutIntegrationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] Specifies a put integration request's resource ID.
    - httpMethod
```
String httpMethod
```
      [Required] Specifies a put integration request's HTTP method.
    - type
```
String type
```
      [Required] Specifies a put integration input's type.
    - integrationHttpMethod
```
String integrationHttpMethod
```
      Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
    - uri
```
String uri
```
      Specifies Uniform Resource Identifier (URI) of the integration endpoint.
      
      For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
      
      For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
    - connectionType
```
String connectionType
```
      The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    - connectionId
```
String connectionId
```
      The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    - credentials
```
String credentials
```
      Specifies whether credentials are required for a put integration.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
    - requestTemplates
```
Map<K,V> 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.
    - passthroughBehavior
```
String passthroughBehavior
```
      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. 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 back end without transformation.
      
      NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.
      
      WHEN_NO_TEMPLATES allows 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.
    - cacheNamespace
```
String cacheNamespace
```
      A list of request parameters whose values are to be cached.
    - cacheKeyParameters
```
List<E> cacheKeyParameters
```
      An API-specific tag group of related cached parameters.
    - contentHandling
```
String contentHandling
```
      Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
    - timeoutInMillis
```
Integer timeoutInMillis
```
      Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
- Class com.amazonaws.services.apigateway.model.PutIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] Specifies a put integration response request's resource identifier.
    - httpMethod
```
String httpMethod
```
      [Required] Specifies a put integration response request's HTTP method.
    - statusCode
```
String statusCode
```
      [Required] Specifies the status code that is used to map the integration response to an existing MethodResponse.
    - selectionPattern
```
String selectionPattern
```
      Specifies the selection pattern of a put integration response.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      Specifies a put integration response's templates.
    - contentHandling
```
String contentHandling
```
      Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Class com.amazonaws.services.apigateway.model.PutIntegrationResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      Specifies the status code that is used to map the integration response to an existing MethodResponse.
    - selectionPattern
```
String selectionPattern
```
      Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    - contentHandling
```
String contentHandling
```
      Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Class com.amazonaws.services.apigateway.model.PutIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - type
```
String type
```
      Specifies an API method integration type. The valid value is one of the following:
      
      AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
      
      AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
      
      HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
      
      HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
      
      MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
      
      For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
    - httpMethod
```
String httpMethod
```
      Specifies the integration's HTTP method type.
    - uri
```
String uri
```
      Specifies Uniform Resource Identifier (URI) of the integration endpoint.
      
      For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
      
      For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
    - connectionType
```
String connectionType
```
      The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    - connectionId
```
String connectionId
```
      The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    - 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 API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
    - requestTemplates
```
Map<K,V> 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.
    - passthroughBehavior
```
String passthroughBehavior
```
      Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
      
      WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
      
      WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
      
      NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    - contentHandling
```
String contentHandling
```
      Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
    - timeoutInMillis
```
Integer timeoutInMillis
```
      Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    - cacheNamespace
```
String cacheNamespace
```
      An API-specific tag group of related cached parameters. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    - cacheKeyParameters
```
List<E> cacheKeyParameters
```
      A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    - integrationResponses
```
Map<K,V> integrationResponses
```
      Specifies the integration's responses.
      
      Example: Get integration responses of a method
      
      Request
      
      GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      The successful response returns 200 OK status and a payload as follows:
      
      { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
      
      Creating an API
- Class com.amazonaws.services.apigateway.model.PutMethodRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] The Resource identifier for the new Method resource.
    - httpMethod
```
String httpMethod
```
      [Required] Specifies the method request's HTTP method type.
    - authorizationType
```
String authorizationType
```
      [Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
    - authorizerId
```
String authorizerId
```
      Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether the method required a valid ApiKey.
    - operationName
```
String operationName
```
      A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.
    - requestModels
```
Map<K,V> requestModels
```
      Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
    - requestValidatorId
```
String requestValidatorId
```
      The identifier of a RequestValidator for validating the method request.
    - authorizationScopes
```
List<E> authorizationScopes
```
      A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- Class com.amazonaws.services.apigateway.model.PutMethodResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] The Resource identifier for the Method resource.
    - httpMethod
```
String httpMethod
```
      [Required] The HTTP verb of the Method resource.
    - statusCode
```
String statusCode
```
      [Required] The method response's status code.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
    - responseModels
```
Map<K,V> responseModels
```
      Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
- Class com.amazonaws.services.apigateway.model.PutMethodResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      The method response's status code.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
    - responseModels
```
Map<K,V> responseModels
```
      Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
- Class com.amazonaws.services.apigateway.model.PutMethodResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - httpMethod
```
String httpMethod
```
      The method's HTTP verb.
    - authorizationType
```
String authorizationType
```
      The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
    - authorizerId
```
String authorizerId
```
      The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      A boolean flag specifying whether a valid ApiKey is required to invoke this method.
    - requestValidatorId
```
String requestValidatorId
```
      The identifier of a RequestValidator for request validation.
    - operationName
```
String operationName
```
      A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
    - requestModels
```
Map<K,V> requestModels
```
      A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
    - methodResponses
```
Map<K,V> methodResponses
```
      Gets a method response associated with a given HTTP status code.
      
      The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.
      
      Example: Get a 200 OK response of a GET method
      
      Request
      
      GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      The successful response returns a 200 OK status code and a payload similar to the following:
      
      { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }
      
      AWS CLI
    - methodIntegration
```
Integration methodIntegration
```
      Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
      
      Example:
      
      Request
      
      GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      The successful response returns a 200 OK status code and a payload similar to the following:
      
      { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } }
      
      AWS CLI
    - authorizationScopes
```
List<E> authorizationScopes
```
      A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- Class com.amazonaws.services.apigateway.model.PutRestApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - mode
```
String mode
```
      The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
    - failOnWarnings
```
Boolean failOnWarnings
```
      A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.
    - parameters
```
Map<K,V> parameters
```
      Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .
    - body
```
ByteBuffer body
```
      [Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.
- Class com.amazonaws.services.apigateway.model.PutRestApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API's identifier. This identifier is unique across all of your APIs in API Gateway.
    - name
```
String name
```
      The API's name.
    - description
```
String description
```
      The API's description.
    - createdDate
```
Date createdDate
```
      The timestamp when the API was created.
    - version
```
String version
```
      A version identifier for the API.
    - warnings
```
List<E> warnings
```
      The warning messages reported when failonwarnings is turned on during API import.
    - binaryMediaTypes
```
List<E> binaryMediaTypes
```
      The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    - minimumCompressionSize
```
Integer minimumCompressionSize
```
      A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
    - apiKeySource
```
String apiKeySource
```
      The source of the API key for metering requests according to a usage plan. Valid values are:
      
      HEADER to read the API key from the X-API-Key header of a request.
      
      AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    - endpointConfiguration
```
EndpointConfiguration endpointConfiguration
```
      The endpoint configuration of this RestApi showing the endpoint types of the API.
    - policy
```
String policy
```
      A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.QuotaSettings extends Object implements Serializable
  - Serialized Fields
    - limit
```
Integer limit
```
      The maximum number of requests that can be made in a given time period.
    - offset
```
Integer offset
```
      The number of requests subtracted from the given limit in the initial time period.
    - period
```
String period
```
      The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
- Class com.amazonaws.services.apigateway.model.RequestValidator extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of this RequestValidator.
    - name
```
String name
```
      The name of this RequestValidator
    - validateRequestBody
```
Boolean validateRequestBody
```
      A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    - validateRequestParameters
```
Boolean validateRequestParameters
```
      A Boolean flag to indicate whether to validate request parameters (true) or not (false ).
- Class com.amazonaws.services.apigateway.model.Resource extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The resource's identifier.
    - parentId
```
String parentId
```
      The parent resource's identifier.
    - pathPart
```
String pathPart
```
      The last path segment for this resource.
    - path
```
String path
```
      The full path for this resource.
    - resourceMethods
```
Map<K,V> resourceMethods
```
      Gets an API resource's method of a given HTTP verb.
      
      The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.
      
      Example: Get the GET method of an API resource
      
      Request
      
      GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }
      
      If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.
- Class com.amazonaws.services.apigateway.model.RestApi extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API's identifier. This identifier is unique across all of your APIs in API Gateway.
    - name
```
String name
```
      The API's name.
    - description
```
String description
```
      The API's description.
    - createdDate
```
Date createdDate
```
      The timestamp when the API was created.
    - version
```
String version
```
      A version identifier for the API.
    - warnings
```
List<E> warnings
```
      The warning messages reported when failonwarnings is turned on during API import.
    - binaryMediaTypes
```
List<E> binaryMediaTypes
```
      The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    - minimumCompressionSize
```
Integer minimumCompressionSize
```
      A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
    - apiKeySource
```
String apiKeySource
```
      The source of the API key for metering requests according to a usage plan. Valid values are:
      
      HEADER to read the API key from the X-API-Key header of a request.
      
      AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    - endpointConfiguration
```
EndpointConfiguration endpointConfiguration
```
      The endpoint configuration of this RestApi showing the endpoint types of the API.
    - policy
```
String policy
```
      A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.SdkConfigurationProperty extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of a an SdkType configuration property.
    - friendlyName
```
String friendlyName
```
      The user-friendly name of an SdkType configuration property.
    - description
```
String description
```
      The description of an SdkType configuration property.
    - required
```
Boolean required
```
      A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).
    - defaultValue
```
String defaultValue
```
      The default value of an SdkType configuration property.
- Class com.amazonaws.services.apigateway.model.SdkType extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of an SdkType instance.
    - friendlyName
```
String friendlyName
```
      The user-friendly name of an SdkType instance.
    - description
```
String description
```
      The description of an SdkType.
    - configurationProperties
```
List<E> configurationProperties
```
      A list of configuration properties of an SdkType.
- Class com.amazonaws.services.apigateway.model.ServiceUnavailableException extends AmazonApiGatewayException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - retryAfterSeconds
```
String retryAfterSeconds
```
- Class com.amazonaws.services.apigateway.model.Stage extends Object implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment that the stage points to.
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of a client certificate for an API stage.
    - stageName
```
String stageName
```
      The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
    - description
```
String description
```
      The stage's description.
    - cacheClusterEnabled
```
Boolean cacheClusterEnabled
```
      Specifies whether a cache cluster is enabled for the stage.
    - cacheClusterSize
```
String cacheClusterSize
```
      The size of the cache cluster for the stage, if enabled.
    - cacheClusterStatus
```
String cacheClusterStatus
```
      The status of the cache cluster for the stage, if enabled.
    - methodSettings
```
Map<K,V> methodSettings
```
      A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
    - variables
```
Map<K,V> variables
```
      A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    - documentationVersion
```
String documentationVersion
```
      The version of the associated API documentation.
    - accessLogSettings
```
AccessLogSettings accessLogSettings
```
      Settings for logging access in this stage.
    - canarySettings
```
CanarySettings canarySettings
```
      Settings for the canary deployment in this stage.
    - tracingEnabled
```
Boolean tracingEnabled
```
      Specifies whether active tracing with X-ray is enabled for the Stage.
    - webAclArn
```
String webAclArn
```
      The ARN of the WebAcl associated with the Stage.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
    - createdDate
```
Date createdDate
```
      The timestamp when the stage was created.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The timestamp when the stage last updated.
- Class com.amazonaws.services.apigateway.model.StageKey extends Object implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The string identifier of the associated RestApi.
    - stageName
```
String stageName
```
      The stage name associated with the stage key.
- Class com.amazonaws.services.apigateway.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.
    - tags
```
Map<K,V> tags
```
      [Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- Class com.amazonaws.services.apigateway.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.TestInvokeAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - authorizerId
```
String authorizerId
```
      [Required] Specifies a test invoke authorizer request's Authorizer ID.
    - headers
```
Map<K,V> headers
```
      [Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
    - multiValueHeaders
```
Map<K,V> multiValueHeaders
```
      [Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.
    - pathWithQueryString
```
String pathWithQueryString
```
      [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
    - body
```
String body
```
      [Optional] The simulated request body of an incoming invocation request.
    - stageVariables
```
Map<K,V> stageVariables
```
      A key-value map of stage variables to simulate an invocation on a deployed Stage.
    - additionalContext
```
Map<K,V> additionalContext
```
      [Optional] A key-value map of additional context variables.
- Class com.amazonaws.services.apigateway.model.TestInvokeAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - clientStatus
```
Integer clientStatus
```
      The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
    - log
```
String log
```
      The API Gateway execution log for the test authorizer request.
    - latency
```
Long latency
```
      The execution latency of the test authorizer request.
    - principalId
```
String principalId
```
      The principal identity returned by the Authorizer
    - policy
```
String policy
```
      The JSON policy document returned by the Authorizer
    - authorization
```
Map<K,V> authorization
```
    - claims
```
Map<K,V> claims
```
      The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.
- Class com.amazonaws.services.apigateway.model.TestInvokeMethodRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] Specifies a test invoke method request's resource ID.
    - httpMethod
```
String httpMethod
```
      [Required] Specifies a test invoke method request's HTTP method.
    - pathWithQueryString
```
String pathWithQueryString
```
      The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
    - body
```
String body
```
      The simulated request body of an incoming invocation request.
    - headers
```
Map<K,V> headers
```
      A key-value map of headers to simulate an incoming invocation request.
    - multiValueHeaders
```
Map<K,V> multiValueHeaders
```
      The headers as a map from string to list of values to simulate an incoming invocation request.
    - clientCertificateId
```
String clientCertificateId
```
      A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
    - stageVariables
```
Map<K,V> stageVariables
```
      A key-value map of stage variables to simulate an invocation on a deployed Stage.
- Class com.amazonaws.services.apigateway.model.TestInvokeMethodResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - status
```
Integer status
```
      The HTTP status code.
    - body
```
String body
```
      The body of the HTTP response.
    - headers
```
Map<K,V> headers
```
      The headers of the HTTP response.
    - multiValueHeaders
```
Map<K,V> multiValueHeaders
```
      The headers of the HTTP response as a map from string to list of values.
    - log
```
String log
```
      The API Gateway execution log for the test invoke request.
    - latency
```
Long latency
```
      The execution latency of the test invoke request.
- Class com.amazonaws.services.apigateway.model.ThrottleSettings extends Object implements Serializable
  - Serialized Fields
    - burstLimit
```
Integer burstLimit
```
      The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
    - rateLimit
```
Double rateLimit
```
      The API request steady-state rate limit.
- Class com.amazonaws.services.apigateway.model.TooManyRequestsException extends AmazonApiGatewayException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - retryAfterSeconds
```
String retryAfterSeconds
```
- Class com.amazonaws.services.apigateway.model.UnauthorizedException extends AmazonApiGatewayException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigateway.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      [Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.
    - tagKeys
```
List<E> tagKeys
```
      [Required] The Tag keys to delete.
- Class com.amazonaws.services.apigateway.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigateway.model.UpdateAccountRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - cloudwatchRoleArn
```
String cloudwatchRoleArn
```
      The ARN of an Amazon CloudWatch role for the current Account.
    - throttleSettings
```
ThrottleSettings throttleSettings
```
      Specifies the API request limits configured for the current Account.
    - features
```
List<E> features
```
      A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".
    - apiKeyVersion
```
String apiKeyVersion
```
      The version of the API keys used for the account.
- Class com.amazonaws.services.apigateway.model.UpdateApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiKey
```
String apiKey
```
      [Required] The identifier of the ApiKey resource to be updated.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateApiKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the API Key.
    - value
```
String value
```
      The value of the API Key.
    - name
```
String name
```
      The name of the API Key.
    - customerId
```
String customerId
```
      An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
    - description
```
String description
```
      The description of the API Key.
    - enabled
```
Boolean enabled
```
      Specifies whether the API Key can be used by callers.
    - createdDate
```
Date createdDate
```
      The timestamp when the API Key was created.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The timestamp when the API Key was last updated.
    - stageKeys
```
List<E> stageKeys
```
      A list of Stage resources that are associated with the ApiKey resource.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.UpdateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - authorizerId
```
String authorizerId
```
      [Required] The identifier of the Authorizer resource.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the authorizer resource.
    - name
```
String name
```
      [Required] The name of the authorizer.
    - type
```
String type
```
      The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
    - providerARNs
```
List<E> providerARNs
```
      A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.
    - authType
```
String authType
```
      Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
    - authorizerUri
```
String authorizerUri
```
      Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
    - authorizerCredentials
```
String authorizerCredentials
```
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
    - identitySource
```
String identitySource
```
      The identity source for which authorization is requested.
      
      For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth.
      
      For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
    - identityValidationExpression
```
String identityValidationExpression
```
      A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- Class com.amazonaws.services.apigateway.model.UpdateBasePathMappingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      [Required] The domain name of the BasePathMapping resource to change.
    - basePath
```
String basePath
```
      [Required] The base path of the BasePathMapping resource to change.
      
      To specify an empty base path, set this parameter to '(none)'.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateBasePathMappingResult extends AmazonWebServiceResult<ResponseMetadata> 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 string identifier of the associated RestApi.
    - stage
```
String stage
```
      The name of the associated stage.
- Class com.amazonaws.services.apigateway.model.UpdateClientCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      [Required] The identifier of the ClientCertificate resource to be updated.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateClientCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of the client certificate.
    - description
```
String description
```
      The description of the client certificate.
    - pemEncodedCertificate
```
String pemEncodedCertificate
```
      The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
    - createdDate
```
Date createdDate
```
      The timestamp when the client certificate was created.
    - expirationDate
```
Date expirationDate
```
      The timestamp when the client certificate will expire.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.UpdateDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - deploymentId
```
String deploymentId
```
      The replacement identifier for the Deployment resource to change information about.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the deployment resource.
    - description
```
String description
```
      The description for the deployment resource.
    - createdDate
```
Date createdDate
```
      The date and time that the deployment resource was created.
    - apiSummary
```
Map<K,V> apiSummary
```
      A summary of the RestApi at the date and time that the deployment resource was created.
- Class com.amazonaws.services.apigateway.model.UpdateDocumentationPartRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - documentationPartId
```
String documentationPartId
```
      [Required] The identifier of the to-be-updated documentation part.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateDocumentationPartResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
    - location
```
DocumentationPartLocation location
```
      The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
    - properties
```
String properties
```
      A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.
- Class com.amazonaws.services.apigateway.model.UpdateDocumentationVersionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi..
    - documentationVersion
```
String documentationVersion
```
      [Required] The version identifier of the to-be-updated documentation version.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateDocumentationVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - version
```
String version
```
      The version identifier of the API documentation snapshot.
    - createdDate
```
Date createdDate
```
      The date when the API documentation snapshot is created.
    - description
```
String description
```
      The description of the API documentation snapshot.
- Class com.amazonaws.services.apigateway.model.UpdateDomainNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      [Required] The name of the DomainName resource to be changed.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateDomainNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The custom domain name as an API host name, for example, my-api.example.com.
    - certificateName
```
String certificateName
```
      The name of the certificate that will be used by edge-optimized endpoint for this domain name.
    - certificateArn
```
String certificateArn
```
      The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    - certificateUploadDate
```
Date certificateUploadDate
```
      The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
    - regionalDomainName
```
String regionalDomainName
```
      The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
    - regionalHostedZoneId
```
String regionalHostedZoneId
```
      The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
    - regionalCertificateName
```
String regionalCertificateName
```
      The name of the certificate that will be used for validating the regional domain name.
    - regionalCertificateArn
```
String regionalCertificateArn
```
      The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
    - distributionDomainName
```
String distributionDomainName
```
      The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
    - distributionHostedZoneId
```
String distributionHostedZoneId
```
      The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
    - endpointConfiguration
```
EndpointConfiguration endpointConfiguration
```
      The endpoint configuration of this DomainName showing the endpoint types of the domain name.
    - domainNameStatus
```
String domainNameStatus
```
      The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
    - domainNameStatusMessage
```
String domainNameStatusMessage
```
      An optional text message containing detailed information about status of the DomainName migration.
    - securityPolicy
```
String securityPolicy
```
      The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.UpdateGatewayResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - responseType
```
String responseType
```
      [Required]
      The response type of the associated GatewayResponse. Valid values are
      
      ACCESS_DENIED
      
      API_CONFIGURATION_ERROR
      
      AUTHORIZER_FAILURE
      
      AUTHORIZER_CONFIGURATION_ERROR
      
      BAD_REQUEST_PARAMETERS
      
      BAD_REQUEST_BODY
      
      DEFAULT_4XX
      
      DEFAULT_5XX
      
      EXPIRED_TOKEN
      
      INVALID_SIGNATURE
      
      INTEGRATION_FAILURE
      
      INTEGRATION_TIMEOUT
      
      INVALID_API_KEY
      
      MISSING_AUTHENTICATION_TOKEN
      
      QUOTA_EXCEEDED
      
      REQUEST_TOO_LARGE
      
      RESOURCE_NOT_FOUND
      
      THROTTLED
      
      UNAUTHORIZED
      
      UNSUPPORTED_MEDIA_TYPE
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateGatewayResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - responseType
```
String responseType
```
      The response type of the associated GatewayResponse. Valid values are
      
      ACCESS_DENIED
      
      API_CONFIGURATION_ERROR
      
      AUTHORIZER_FAILURE
      
      AUTHORIZER_CONFIGURATION_ERROR
      
      BAD_REQUEST_PARAMETERS
      
      BAD_REQUEST_BODY
      
      DEFAULT_4XX
      
      DEFAULT_5XX
      
      EXPIRED_TOKEN
      
      INVALID_SIGNATURE
      
      INTEGRATION_FAILURE
      
      INTEGRATION_TIMEOUT
      
      INVALID_API_KEY
      
      MISSING_AUTHENTICATION_TOKEN
      
      QUOTA_EXCEEDED
      
      REQUEST_TOO_LARGE
      
      RESOURCE_NOT_FOUND
      
      THROTTLED
      
      UNAUTHORIZED
      
      UNSUPPORTED_MEDIA_TYPE
    - statusCode
```
String statusCode
```
      The HTTP status code for this GatewayResponse.
    - responseParameters
```
Map<K,V> responseParameters
```
      Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
    - defaultResponse
```
Boolean defaultResponse
```
      A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true ) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.
- Class com.amazonaws.services.apigateway.model.UpdateIntegrationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] Represents an update integration request's resource identifier.
    - httpMethod
```
String httpMethod
```
      [Required] Represents an update integration request's HTTP method.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] Specifies an update integration response request's resource identifier.
    - httpMethod
```
String httpMethod
```
      [Required] Specifies an update integration response request's HTTP method.
    - statusCode
```
String statusCode
```
      [Required] Specifies an update integration response request's status code.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateIntegrationResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      Specifies the status code that is used to map the integration response to an existing MethodResponse.
    - selectionPattern
```
String selectionPattern
```
      Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    - contentHandling
```
String contentHandling
```
      Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
- Class com.amazonaws.services.apigateway.model.UpdateIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - type
```
String type
```
      Specifies an API method integration type. The valid value is one of the following:
      
      AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
      
      AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
      
      HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
      
      HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
      
      MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
      
      For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
    - httpMethod
```
String httpMethod
```
      Specifies the integration's HTTP method type.
    - uri
```
String uri
```
      Specifies Uniform Resource Identifier (URI) of the integration endpoint.
      
      For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.
      
      For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
    - connectionType
```
String connectionType
```
      The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.
    - connectionId
```
String connectionId
```
      The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
    - 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 API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.
    - requestTemplates
```
Map<K,V> 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.
    - passthroughBehavior
```
String passthroughBehavior
```
      Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:
      
      WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
      
      WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
      
      NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
    - contentHandling
```
String contentHandling
```
      Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.
    - timeoutInMillis
```
Integer timeoutInMillis
```
      Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
    - cacheNamespace
```
String cacheNamespace
```
      An API-specific tag group of related cached parameters. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    - cacheKeyParameters
```
List<E> cacheKeyParameters
```
      A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.
    - integrationResponses
```
Map<K,V> integrationResponses
```
      Specifies the integration's responses.
      
      Example: Get integration responses of a method
      
      Request
      
      GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      The successful response returns 200 OK status and a payload as follows:
      
      { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }
      
      Creating an API
- Class com.amazonaws.services.apigateway.model.UpdateMethodRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] The Resource identifier for the Method resource.
    - httpMethod
```
String httpMethod
```
      [Required] The HTTP verb of the Method resource.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateMethodResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] The Resource identifier for the MethodResponse resource.
    - httpMethod
```
String httpMethod
```
      [Required] The HTTP verb of the Method resource.
    - statusCode
```
String statusCode
```
      [Required] The status code for the MethodResponse resource.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateMethodResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      The method response's status code.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)
    - responseModels
```
Map<K,V> responseModels
```
      Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
- Class com.amazonaws.services.apigateway.model.UpdateMethodResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - httpMethod
```
String httpMethod
```
      The method's HTTP verb.
    - authorizationType
```
String authorizationType
```
      The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
    - authorizerId
```
String authorizerId
```
      The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      A boolean flag specifying whether a valid ApiKey is required to invoke this method.
    - requestValidatorId
```
String requestValidatorId
```
      The identifier of a RequestValidator for request validation.
    - operationName
```
String operationName
```
      A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
    - requestModels
```
Map<K,V> requestModels
```
      A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
    - methodResponses
```
Map<K,V> methodResponses
```
      Gets a method response associated with a given HTTP status code.
      
      The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.
      
      Example: Get a 200 OK response of a GET method
      
      Request
      
      GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      The successful response returns a 200 OK status code and a payload similar to the following:
      
      { "_links": { "curies": { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }
      
      AWS CLI
    - methodIntegration
```
Integration methodIntegration
```
      Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.
      
      Example:
      
      Request
      
      GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      The successful response returns a 200 OK status code and a payload similar to the following:
      
      { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \"$input.params('operand1')\",\n \"b\": \"$input.params('operand2')\", \n \"op\": \"$input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set($res = $input.path('$'))\n{\n \"result\": \"$res.a, $res.b, $res.op => $res.c\",\n \"a\" : \"$res.a\",\n \"b\" : \"$res.b\",\n \"op\" : \"$res.op\",\n \"c\" : \"$res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } }
      
      AWS CLI
    - authorizationScopes
```
List<E> authorizationScopes
```
      A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
- Class com.amazonaws.services.apigateway.model.UpdateModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - modelName
```
String modelName
```
      [Required] The name of the model to update.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the model resource.
    - name
```
String name
```
      The name of the model. Must be an alphanumeric string.
    - description
```
String description
```
      The description of the model.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
    - contentType
```
String contentType
```
      The content-type for the model.
- Class com.amazonaws.services.apigateway.model.UpdateRequestValidatorRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - requestValidatorId
```
String requestValidatorId
```
      [Required] The identifier of RequestValidator to be updated.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateRequestValidatorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of this RequestValidator.
    - name
```
String name
```
      The name of this RequestValidator
    - validateRequestBody
```
Boolean validateRequestBody
```
      A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
    - validateRequestParameters
```
Boolean validateRequestParameters
```
      A Boolean flag to indicate whether to validate request parameters (true) or not (false ).
- Class com.amazonaws.services.apigateway.model.UpdateResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - resourceId
```
String resourceId
```
      [Required] The identifier of the Resource resource.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The resource's identifier.
    - parentId
```
String parentId
```
      The parent resource's identifier.
    - pathPart
```
String pathPart
```
      The last path segment for this resource.
    - path
```
String path
```
      The full path for this resource.
    - resourceMethods
```
Map<K,V> resourceMethods
```
      Gets an API resource's method of a given HTTP verb.
      
      The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.
      
      Example: Get the GET method of an API resource
      
      Request
      
      GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
      
      Response
      
      { "_links": { "curies": [ { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": "$util.urlDecode(\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }
      
      If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.
- Class com.amazonaws.services.apigateway.model.UpdateRestApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateRestApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API's identifier. This identifier is unique across all of your APIs in API Gateway.
    - name
```
String name
```
      The API's name.
    - description
```
String description
```
      The API's description.
    - createdDate
```
Date createdDate
```
      The timestamp when the API was created.
    - version
```
String version
```
      A version identifier for the API.
    - warnings
```
List<E> warnings
```
      The warning messages reported when failonwarnings is turned on during API import.
    - binaryMediaTypes
```
List<E> binaryMediaTypes
```
      The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
    - minimumCompressionSize
```
Integer minimumCompressionSize
```
      A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
    - apiKeySource
```
String apiKeySource
```
      The source of the API key for metering requests according to a usage plan. Valid values are:
      
      HEADER to read the API key from the X-API-Key header of a request.
      
      AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
    - endpointConfiguration
```
EndpointConfiguration endpointConfiguration
```
      The endpoint configuration of this RestApi showing the endpoint types of the API.
    - policy
```
String policy
```
      A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.UpdateStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      [Required] The string identifier of the associated RestApi.
    - stageName
```
String stageName
```
      [Required] The name of the Stage resource to change information about.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment that the stage points to.
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of a client certificate for an API stage.
    - stageName
```
String stageName
```
      The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
    - description
```
String description
```
      The stage's description.
    - cacheClusterEnabled
```
Boolean cacheClusterEnabled
```
      Specifies whether a cache cluster is enabled for the stage.
    - cacheClusterSize
```
String cacheClusterSize
```
      The size of the cache cluster for the stage, if enabled.
    - cacheClusterStatus
```
String cacheClusterStatus
```
      The status of the cache cluster for the stage, if enabled.
    - methodSettings
```
Map<K,V> methodSettings
```
      A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.
    - variables
```
Map<K,V> variables
```
      A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    - documentationVersion
```
String documentationVersion
```
      The version of the associated API documentation.
    - accessLogSettings
```
AccessLogSettings accessLogSettings
```
      Settings for logging access in this stage.
    - canarySettings
```
CanarySettings canarySettings
```
      Settings for the canary deployment in this stage.
    - tracingEnabled
```
Boolean tracingEnabled
```
      Specifies whether active tracing with X-ray is enabled for the Stage.
    - webAclArn
```
String webAclArn
```
      The ARN of the WebAcl associated with the Stage.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
    - createdDate
```
Date createdDate
```
      The timestamp when the stage was created.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The timestamp when the stage last updated.
- Class com.amazonaws.services.apigateway.model.UpdateUsagePlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - usagePlanId
```
String usagePlanId
```
      [Required] The Id of the to-be-updated usage plan.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateUsagePlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of a UsagePlan resource.
    - name
```
String name
```
      The name of a usage plan.
    - description
```
String description
```
      The description of a usage plan.
    - apiStages
```
List<E> apiStages
```
      The associated API stages of a usage plan.
    - throttle
```
ThrottleSettings throttle
```
      The request throttle limits of a usage plan.
    - quota
```
QuotaSettings quota
```
      The maximum number of permitted requests per a given unit time interval.
    - productCode
```
String productCode
```
      The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.UpdateUsageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - usagePlanId
```
String usagePlanId
```
      [Required] The Id of the usage plan associated with the usage data.
    - keyId
```
String keyId
```
      [Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - usagePlanId
```
String usagePlanId
```
      The plan Id associated with this usage data.
    - startDate
```
String startDate
```
      The starting date of the usage data.
    - endDate
```
String endDate
```
      The ending date of the usage data.
    - position
```
String position
```
    - items
```
Map<K,V> items
```
      The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].
- Class com.amazonaws.services.apigateway.model.UpdateVpcLinkRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcLinkId
```
String vpcLinkId
```
      [Required] The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
    - patchOperations
```
List<E> patchOperations
```
      A list of update operations to be applied to the specified resource and in the order specified in this list.
- Class com.amazonaws.services.apigateway.model.UpdateVpcLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
    - name
```
String name
```
      The name used to label and identify the VPC link.
    - description
```
String description
```
      The description of the VPC link.
    - targetArns
```
List<E> targetArns
```
      The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
    - status
```
String status
```
      The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.
    - statusMessage
```
String statusMessage
```
      A description about the VPC link status.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.UsagePlan extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of a UsagePlan resource.
    - name
```
String name
```
      The name of a usage plan.
    - description
```
String description
```
      The description of a usage plan.
    - apiStages
```
List<E> apiStages
```
      The associated API stages of a usage plan.
    - throttle
```
ThrottleSettings throttle
```
      The request throttle limits of a usage plan.
    - quota
```
QuotaSettings quota
```
      The maximum number of permitted requests per a given unit time interval.
    - productCode
```
String productCode
```
      The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigateway.model.UsagePlanKey extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The Id of a usage plan key.
    - type
```
String type
```
      The type of a usage plan key. Currently, the valid key type is API_KEY.
    - value
```
String value
```
      The value of a usage plan key.
    - name
```
String name
```
      The name of a usage plan key.
- Class com.amazonaws.services.apigateway.model.VpcLink extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
    - name
```
String name
```
      The name used to label and identify the VPC link.
    - description
```
String description
```
      The description of the VPC link.
    - targetArns
```
List<E> targetArns
```
      The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
    - status
```
String status
```
      The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.
    - statusMessage
```
String statusMessage
```
      A description about the VPC link status.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
Package com.amazonaws.services.apigatewaymanagementapi.model
- Class com.amazonaws.services.apigatewaymanagementapi.model.AmazonApiGatewayManagementApiException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigatewaymanagementapi.model.DeleteConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - connectionId
```
String connectionId
```
- Class com.amazonaws.services.apigatewaymanagementapi.model.DeleteConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewaymanagementapi.model.ForbiddenException extends AmazonApiGatewayManagementApiException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigatewaymanagementapi.model.GetConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - connectionId
```
String connectionId
```
- Class com.amazonaws.services.apigatewaymanagementapi.model.GetConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - connectedAt
```
Date connectedAt
```
      The time in ISO 8601 format for when the connection was established.
    - identity
```
Identity identity
```
    - lastActiveAt
```
Date lastActiveAt
```
      The time in ISO 8601 format for when the connection was last active.
- Class com.amazonaws.services.apigatewaymanagementapi.model.GoneException extends AmazonApiGatewayManagementApiException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigatewaymanagementapi.model.Identity extends Object implements Serializable
  - Serialized Fields
    - sourceIp
```
String sourceIp
```
      The source IP address of the TCP connection making the request to API Gateway.
    - userAgent
```
String userAgent
```
      The User Agent of the API caller.
- Class com.amazonaws.services.apigatewaymanagementapi.model.LimitExceededException extends AmazonApiGatewayManagementApiException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigatewaymanagementapi.model.PayloadTooLargeException extends AmazonApiGatewayManagementApiException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigatewaymanagementapi.model.PostToConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - data
```
ByteBuffer data
```
      The data to be sent to the client specified by its connection id.
    - connectionId
```
String connectionId
```
      The identifier of the connection that a specific client is using.
- Class com.amazonaws.services.apigatewaymanagementapi.model.PostToConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
Package com.amazonaws.services.apigatewayv2.model
- Class com.amazonaws.services.apigatewayv2.model.AccessDeniedException extends AmazonApiGatewayV2Exception implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigatewayv2.model.AccessLogSettings extends Object implements Serializable
  - Serialized Fields
    - destinationArn
```
String destinationArn
```
      The ARN of the CloudWatch Logs log group to receive access logs.
    - format
```
String format
```
      A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
- Class com.amazonaws.services.apigatewayv2.model.AmazonApiGatewayV2Exception extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigatewayv2.model.Api extends Object implements Serializable
  - Serialized Fields
    - apiEndpoint
```
String apiEndpoint
```
      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
    - apiId
```
String apiId
```
      The API ID.
    - apiKeySelectionExpression
```
String apiKeySelectionExpression
```
      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
    - corsConfiguration
```
Cors corsConfiguration
```
      A CORS configuration. Supported only for HTTP APIs.
    - createdDate
```
Date createdDate
```
      The timestamp when the API was created.
    - description
```
String description
```
      The description of the API.
    - disableSchemaValidation
```
Boolean disableSchemaValidation
```
      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
    - importInfo
```
List<E> importInfo
```
      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
    - name
```
String name
```
      The name of the API.
    - protocolType
```
String protocolType
```
      The API protocol.
    - routeSelectionExpression
```
String routeSelectionExpression
```
      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
    - tags
```
Map<K,V> tags
```
      A collection of tags associated with the API.
    - version
```
String version
```
      A version identifier for the API.
    - warnings
```
List<E> warnings
```
      The warning messages reported when failonwarnings is turned on during API import.
- Class com.amazonaws.services.apigatewayv2.model.ApiMapping extends Object implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - apiMappingId
```
String apiMappingId
```
      The API mapping identifier.
    - apiMappingKey
```
String apiMappingKey
```
      The API mapping key.
    - stage
```
String stage
```
      The API stage.
- Class com.amazonaws.services.apigatewayv2.model.Authorizer extends Object implements Serializable
  - Serialized Fields
    - authorizerCredentialsArn
```
String authorizerCredentialsArn
```
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
    - authorizerId
```
String authorizerId
```
      The authorizer identifier.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      Authorizer caching is not currently supported. Don't specify this value for authorizers.
    - authorizerType
```
String authorizerType
```
      The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
    - authorizerUri
```
String authorizerUri
```
      The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: {account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates 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. Supported only for REQUEST authorizers.
    - identitySource
```
List<E> identitySource
```
      The identity source for which authorization is requested.
      
      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function.
      
      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization".
    - identityValidationExpression
```
String identityValidationExpression
```
      The validation expression does not apply to the REQUEST authorizer.
    - jwtConfiguration
```
JWTConfiguration jwtConfiguration
```
      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
    - name
```
String name
```
      The name of the authorizer.
- Class com.amazonaws.services.apigatewayv2.model.BadRequestException extends AmazonApiGatewayV2Exception implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigatewayv2.model.ConflictException extends AmazonApiGatewayV2Exception implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigatewayv2.model.Cors extends Object implements Serializable
  - Serialized Fields
    - allowCredentials
```
Boolean allowCredentials
```
      Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
    - allowHeaders
```
List<E> allowHeaders
```
      Represents a collection of allowed headers. Supported only for HTTP APIs.
    - allowMethods
```
List<E> allowMethods
```
      Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
    - allowOrigins
```
List<E> allowOrigins
```
      Represents a collection of allowed origins. Supported only for HTTP APIs.
    - exposeHeaders
```
List<E> exposeHeaders
```
      Represents a collection of exposed headers. Supported only for HTTP APIs.
    - maxAge
```
Integer maxAge
```
      The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
- Class com.amazonaws.services.apigatewayv2.model.CreateApiMappingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - apiMappingKey
```
String apiMappingKey
```
      The API mapping key.
    - domainName
```
String domainName
```
      The domain name.
    - stage
```
String stage
```
      The API stage.
- Class com.amazonaws.services.apigatewayv2.model.CreateApiMappingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - apiMappingId
```
String apiMappingId
```
      The API mapping identifier.
    - apiMappingKey
```
String apiMappingKey
```
      The API mapping key.
    - stage
```
String stage
```
      The API stage.
- Class com.amazonaws.services.apigatewayv2.model.CreateApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiKeySelectionExpression
```
String apiKeySelectionExpression
```
      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
    - corsConfiguration
```
Cors corsConfiguration
```
      A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
    - credentialsArn
```
String credentialsArn
```
      This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for 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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
    - description
```
String description
```
      The description of the API.
    - disableSchemaValidation
```
Boolean disableSchemaValidation
```
      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
    - name
```
String name
```
      The name of the API.
    - protocolType
```
String protocolType
```
      The API protocol.
    - routeKey
```
String routeKey
```
      This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
    - routeSelectionExpression
```
String routeSelectionExpression
```
      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
    - target
```
String target
```
      This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
    - version
```
String version
```
      A version identifier for the API.
- Class com.amazonaws.services.apigatewayv2.model.CreateApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiEndpoint
```
String apiEndpoint
```
      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
    - apiId
```
String apiId
```
      The API ID.
    - apiKeySelectionExpression
```
String apiKeySelectionExpression
```
      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
    - corsConfiguration
```
Cors corsConfiguration
```
      A CORS configuration. Supported only for HTTP APIs.
    - createdDate
```
Date createdDate
```
      The timestamp when the API was created.
    - description
```
String description
```
      The description of the API.
    - disableSchemaValidation
```
Boolean disableSchemaValidation
```
      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
    - importInfo
```
List<E> importInfo
```
      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
    - name
```
String name
```
      The name of the API.
    - protocolType
```
String protocolType
```
      The API protocol.
    - routeSelectionExpression
```
String routeSelectionExpression
```
      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
    - tags
```
Map<K,V> tags
```
      A collection of tags associated with the API.
    - version
```
String version
```
      A version identifier for the API.
    - warnings
```
List<E> warnings
```
      The warning messages reported when failonwarnings is turned on during API import.
- Class com.amazonaws.services.apigatewayv2.model.CreateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - authorizerCredentialsArn
```
String authorizerCredentialsArn
```
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      Authorizer caching is not currently supported. Don't specify this value for authorizers.
    - authorizerType
```
String authorizerType
```
      The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
    - authorizerUri
```
String authorizerUri
```
      The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: {account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates 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. Supported only for REQUEST authorizers.
    - identitySource
```
List<E> identitySource
```
      The identity source for which authorization is requested.
      
      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function.
      
      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT )from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization".
    - identityValidationExpression
```
String identityValidationExpression
```
      This parameter is not used.
    - jwtConfiguration
```
JWTConfiguration jwtConfiguration
```
      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
    - name
```
String name
```
      The name of the authorizer.
- Class com.amazonaws.services.apigatewayv2.model.CreateAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - authorizerCredentialsArn
```
String authorizerCredentialsArn
```
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
    - authorizerId
```
String authorizerId
```
      The authorizer identifier.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      Authorizer caching is not currently supported. Don't specify this value for authorizers.
    - authorizerType
```
String authorizerType
```
      The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
    - authorizerUri
```
String authorizerUri
```
      The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: {account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates 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. Supported only for REQUEST authorizers.
    - identitySource
```
List<E> identitySource
```
      The identity source for which authorization is requested.
      
      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function.
      
      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization".
    - identityValidationExpression
```
String identityValidationExpression
```
      The validation expression does not apply to the REQUEST authorizer.
    - jwtConfiguration
```
JWTConfiguration jwtConfiguration
```
      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
    - name
```
String name
```
      The name of the authorizer.
- Class com.amazonaws.services.apigatewayv2.model.CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - description
```
String description
```
      The description for the deployment resource.
    - stageName
```
String stageName
```
      The name of the Stage resource for the Deployment resource to create.
- Class com.amazonaws.services.apigatewayv2.model.CreateDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - autoDeployed
```
Boolean autoDeployed
```
      Specifies whether a deployment was automatically released.
    - createdDate
```
Date createdDate
```
      The date and time when the Deployment resource was created.
    - deploymentId
```
String deploymentId
```
      The identifier for the deployment.
    - deploymentStatus
```
String deploymentStatus
```
      The status of the deployment: PENDING, FAILED, or SUCCEEDED.
    - deploymentStatusMessage
```
String deploymentStatusMessage
```
      May contain additional feedback on the status of an API deployment.
    - description
```
String description
```
      The description for the deployment.
- Class com.amazonaws.services.apigatewayv2.model.CreateDomainNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The domain name.
    - domainNameConfigurations
```
List<E> domainNameConfigurations
```
      The domain name configurations.
    - tags
```
Map<K,V> tags
```
      The collection of tags associated with a domain name.
- Class com.amazonaws.services.apigatewayv2.model.CreateDomainNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiMappingSelectionExpression
```
String apiMappingSelectionExpression
```
      The API mapping selection expression.
    - domainName
```
String domainName
```
      The name of the DomainName resource.
    - domainNameConfigurations
```
List<E> domainNameConfigurations
```
      The domain name configurations.
    - tags
```
Map<K,V> tags
```
      The collection of tags associated with a domain name.
- Class com.amazonaws.services.apigatewayv2.model.CreateIntegrationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - connectionId
```
String connectionId
```
      The connection ID.
    - connectionType
```
String connectionType
```
      The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
    - contentHandlingStrategy
```
String contentHandlingStrategy
```
      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    - credentialsArn
```
String credentialsArn
```
      Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for 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.
    - description
```
String description
```
      The description of the integration.
    - integrationMethod
```
String integrationMethod
```
      Specifies the integration's HTTP method type.
    - integrationType
```
String integrationType
```
      The integration type of an integration. One of the following:
      
      AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
      
      AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
      
      HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
      
      HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
      
      MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
    - integrationUri
```
String integrationUri
```
      For a Lambda proxy integration, this is the URI of the Lambda function.
    - passthroughBehavior
```
String passthroughBehavior
```
      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
      
      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 allows 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 HTTP 415 Unsupported Media Type response.
    - payloadFormatVersion
```
String payloadFormatVersion
```
      Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name. Supported only for WebSocket APIs.
    - requestTemplates
```
Map<K,V> 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. Supported only for WebSocket APIs.
    - templateSelectionExpression
```
String templateSelectionExpression
```
      The template selection expression for the integration.
    - timeoutInMillis
```
Integer timeoutInMillis
```
      Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
- Class com.amazonaws.services.apigatewayv2.model.CreateIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - contentHandlingStrategy
```
String contentHandlingStrategy
```
      Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    - integrationId
```
String integrationId
```
      The integration ID.
    - integrationResponseKey
```
String integrationResponseKey
```
      The integration response key.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where {name} is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    - templateSelectionExpression
```
String templateSelectionExpression
```
      The template selection expression for the integration response. Supported only for WebSocket APIs.
- Class com.amazonaws.services.apigatewayv2.model.CreateIntegrationResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contentHandlingStrategy
```
String contentHandlingStrategy
```
      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    - integrationResponseId
```
String integrationResponseId
```
      The integration response ID.
    - integrationResponseKey
```
String integrationResponseKey
```
      The integration response key.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    - templateSelectionExpression
```
String templateSelectionExpression
```
      The template selection expressions for the integration response.
- Class com.amazonaws.services.apigatewayv2.model.CreateIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiGatewayManaged
```
Boolean apiGatewayManaged
```
      Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
    - connectionId
```
String connectionId
```
      The connection ID.
    - connectionType
```
String connectionType
```
      The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
    - contentHandlingStrategy
```
String contentHandlingStrategy
```
      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    - credentialsArn
```
String credentialsArn
```
      Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for 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.
    - description
```
String description
```
      Represents the description of an integration.
    - integrationId
```
String integrationId
```
      Represents the identifier of an integration.
    - integrationMethod
```
String integrationMethod
```
      Specifies the integration's HTTP method type.
    - integrationResponseSelectionExpression
```
String integrationResponseSelectionExpression
```
      The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
    - integrationType
```
String integrationType
```
      The integration type of an integration. One of the following:
      
      AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
      
      AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
      
      HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
      
      HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
      
      MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
    - integrationUri
```
String integrationUri
```
      For a Lambda proxy integration, this is the URI of the Lambda function.
    - passthroughBehavior
```
String passthroughBehavior
```
      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
      
      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 allows 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 HTTP 415 Unsupported Media Type response.
    - payloadFormatVersion
```
String payloadFormatVersion
```
      Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name. Supported only for WebSocket APIs.
    - requestTemplates
```
Map<K,V> 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. Supported only for WebSocket APIs.
    - templateSelectionExpression
```
String templateSelectionExpression
```
      The template selection expression for the integration. Supported only for WebSocket APIs.
    - timeoutInMillis
```
Integer timeoutInMillis
```
      Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
- Class com.amazonaws.services.apigatewayv2.model.CreateModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - contentType
```
String contentType
```
      The content-type for the model, for example, "application/json".
    - description
```
String description
```
      The description of the model.
    - name
```
String name
```
      The name of the model. Must be alphanumeric.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON schema draft 4 model.
- Class com.amazonaws.services.apigatewayv2.model.CreateModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contentType
```
String contentType
```
      The content-type for the model, for example, "application/json".
    - description
```
String description
```
      The description of the model.
    - modelId
```
String modelId
```
      The model identifier.
    - name
```
String name
```
      The name of the model. Must be alphanumeric.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON schema draft 4 model.
- Class com.amazonaws.services.apigatewayv2.model.CreateRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
    - authorizationScopes
```
List<E> authorizationScopes
```
      The authorization scopes supported by this route.
    - authorizationType
```
String authorizationType
```
      The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.
    - authorizerId
```
String authorizerId
```
      The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    - modelSelectionExpression
```
String modelSelectionExpression
```
      The model selection expression for the route. Supported only for WebSocket APIs.
    - operationName
```
String operationName
```
      The operation name for the route.
    - requestModels
```
Map<K,V> requestModels
```
      The request models for the route. Supported only for WebSocket APIs.
    - requestParameters
```
Map<K,V> requestParameters
```
      The request parameters for the route. Supported only for WebSocket APIs.
    - routeKey
```
String routeKey
```
      The route key for the route.
    - routeResponseSelectionExpression
```
String routeResponseSelectionExpression
```
      The route response selection expression for the route. Supported only for WebSocket APIs.
    - target
```
String target
```
      The target for the route.
- Class com.amazonaws.services.apigatewayv2.model.CreateRouteResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - modelSelectionExpression
```
String modelSelectionExpression
```
      The model selection expression for the route response. Supported only for WebSocket APIs.
    - responseModels
```
Map<K,V> responseModels
```
      The response models for the route response.
    - responseParameters
```
Map<K,V> responseParameters
```
      The route response parameters.
    - routeId
```
String routeId
```
      The route ID.
    - routeResponseKey
```
String routeResponseKey
```
      The route response key.
- Class com.amazonaws.services.apigatewayv2.model.CreateRouteResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - modelSelectionExpression
```
String modelSelectionExpression
```
      Represents the model selection expression of a route response. Supported only for WebSocket APIs.
    - responseModels
```
Map<K,V> responseModels
```
      Represents the response models of a route response.
    - responseParameters
```
Map<K,V> responseParameters
```
      Represents the response parameters of a route response.
    - routeResponseId
```
String routeResponseId
```
      Represents the identifier of a route response.
    - routeResponseKey
```
String routeResponseKey
```
      Represents the route response key of a route response.
- Class com.amazonaws.services.apigatewayv2.model.CreateRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiGatewayManaged
```
Boolean apiGatewayManaged
```
      Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
    - authorizationScopes
```
List<E> authorizationScopes
```
      A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
    - authorizationType
```
String authorizationType
```
      The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.
    - authorizerId
```
String authorizerId
```
      The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    - modelSelectionExpression
```
String modelSelectionExpression
```
      The model selection expression for the route. Supported only for WebSocket APIs.
    - operationName
```
String operationName
```
      The operation name for the route.
    - requestModels
```
Map<K,V> requestModels
```
      The request models for the route. Supported only for WebSocket APIs.
    - requestParameters
```
Map<K,V> requestParameters
```
      The request parameters for the route. Supported only for WebSocket APIs.
    - routeId
```
String routeId
```
      The route ID.
    - routeKey
```
String routeKey
```
      The route key for the route.
    - routeResponseSelectionExpression
```
String routeResponseSelectionExpression
```
      The route response selection expression for the route. Supported only for WebSocket APIs.
    - target
```
String target
```
      The target for the route.
- Class com.amazonaws.services.apigatewayv2.model.CreateStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessLogSettings
```
AccessLogSettings accessLogSettings
```
      Settings for logging access in this stage.
    - apiId
```
String apiId
```
      The API identifier.
    - autoDeploy
```
Boolean autoDeploy
```
      Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
    - defaultRouteSettings
```
RouteSettings defaultRouteSettings
```
      The default route settings for the stage.
    - deploymentId
```
String deploymentId
```
      The deployment identifier of the API stage.
    - description
```
String description
```
      The description for the API stage.
    - routeSettings
```
Map<K,V> routeSettings
```
      Route settings for the stage, by routeKey.
    - stageName
```
String stageName
```
      The name of the stage.
    - stageVariables
```
Map<K,V> stageVariables
```
      A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigatewayv2.model.CreateStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - accessLogSettings
```
AccessLogSettings accessLogSettings
```
      Settings for logging access in this stage.
    - apiGatewayManaged
```
Boolean apiGatewayManaged
```
      Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
    - autoDeploy
```
Boolean autoDeploy
```
      Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
    - createdDate
```
Date createdDate
```
      The timestamp when the stage was created.
    - defaultRouteSettings
```
RouteSettings defaultRouteSettings
```
      Default route settings for the stage.
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
    - description
```
String description
```
      The description of the stage.
    - lastDeploymentStatusMessage
```
String lastDeploymentStatusMessage
```
      Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The timestamp when the stage was last updated.
    - routeSettings
```
Map<K,V> routeSettings
```
      Route settings for the stage, by routeKey.
    - stageName
```
String stageName
```
      The name of the stage.
    - stageVariables
```
Map<K,V> stageVariables
```
      A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigatewayv2.model.DeleteApiMappingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiMappingId
```
String apiMappingId
```
      The API mapping identifier.
    - domainName
```
String domainName
```
      The domain name.
- Class com.amazonaws.services.apigatewayv2.model.DeleteApiMappingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.DeleteApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
- Class com.amazonaws.services.apigatewayv2.model.DeleteApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.DeleteAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - authorizerId
```
String authorizerId
```
      The authorizer identifier.
- Class com.amazonaws.services.apigatewayv2.model.DeleteAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.DeleteCorsConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
- Class com.amazonaws.services.apigatewayv2.model.DeleteCorsConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.DeleteDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - deploymentId
```
String deploymentId
```
      The deployment ID.
- Class com.amazonaws.services.apigatewayv2.model.DeleteDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.DeleteDomainNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The domain name.
- Class com.amazonaws.services.apigatewayv2.model.DeleteDomainNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.DeleteIntegrationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - integrationId
```
String integrationId
```
      The integration ID.
- Class com.amazonaws.services.apigatewayv2.model.DeleteIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - integrationId
```
String integrationId
```
      The integration ID.
    - integrationResponseId
```
String integrationResponseId
```
      The integration response ID.
- Class com.amazonaws.services.apigatewayv2.model.DeleteIntegrationResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.DeleteIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.DeleteModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - modelId
```
String modelId
```
      The model ID.
- Class com.amazonaws.services.apigatewayv2.model.DeleteModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.DeleteRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - routeId
```
String routeId
```
      The route ID.
- Class com.amazonaws.services.apigatewayv2.model.DeleteRouteResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - routeId
```
String routeId
```
      The route ID.
    - routeResponseId
```
String routeResponseId
```
      The route response ID.
- Class com.amazonaws.services.apigatewayv2.model.DeleteRouteResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.DeleteRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.DeleteRouteSettingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - routeKey
```
String routeKey
```
      The route key.
    - stageName
```
String stageName
```
      The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
- Class com.amazonaws.services.apigatewayv2.model.DeleteRouteSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.DeleteStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - stageName
```
String stageName
```
      The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
- Class com.amazonaws.services.apigatewayv2.model.DeleteStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.Deployment extends Object implements Serializable
  - Serialized Fields
    - autoDeployed
```
Boolean autoDeployed
```
      Specifies whether a deployment was automatically released.
    - createdDate
```
Date createdDate
```
      The date and time when the Deployment resource was created.
    - deploymentId
```
String deploymentId
```
      The identifier for the deployment.
    - deploymentStatus
```
String deploymentStatus
```
      The status of the deployment: PENDING, FAILED, or SUCCEEDED.
    - deploymentStatusMessage
```
String deploymentStatusMessage
```
      May contain additional feedback on the status of an API deployment.
    - description
```
String description
```
      The description for the deployment.
- Class com.amazonaws.services.apigatewayv2.model.DomainName extends Object implements Serializable
  - Serialized Fields
    - apiMappingSelectionExpression
```
String apiMappingSelectionExpression
```
      The API mapping selection expression.
    - domainName
```
String domainName
```
      The name of the DomainName resource.
    - domainNameConfigurations
```
List<E> domainNameConfigurations
```
      The domain name configurations.
    - tags
```
Map<K,V> tags
```
      The collection of tags associated with a domain name.
- Class com.amazonaws.services.apigatewayv2.model.DomainNameConfiguration extends Object implements Serializable
  - Serialized Fields
    - apiGatewayDomainName
```
String apiGatewayDomainName
```
      A domain name for the API.
    - certificateArn
```
String certificateArn
```
      An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
    - certificateName
```
String certificateName
```
      The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
    - certificateUploadDate
```
Date certificateUploadDate
```
      The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
    - domainNameStatus
```
String domainNameStatus
```
      The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
    - domainNameStatusMessage
```
String domainNameStatusMessage
```
      An optional text message containing detailed information about status of the domain name migration.
    - endpointType
```
String endpointType
```
      The endpoint type.
    - hostedZoneId
```
String hostedZoneId
```
      The Amazon Route 53 Hosted Zone ID of the endpoint.
    - securityPolicy
```
String securityPolicy
```
      The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
- Class com.amazonaws.services.apigatewayv2.model.GetApiMappingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiMappingId
```
String apiMappingId
```
      The API mapping identifier.
    - domainName
```
String domainName
```
      The domain name.
- Class com.amazonaws.services.apigatewayv2.model.GetApiMappingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - apiMappingId
```
String apiMappingId
```
      The API mapping identifier.
    - apiMappingKey
```
String apiMappingKey
```
      The API mapping key.
    - stage
```
String stage
```
      The API stage.
- Class com.amazonaws.services.apigatewayv2.model.GetApiMappingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The domain name.
    - maxResults
```
String maxResults
```
      The maximum number of elements to be returned for this resource.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetApiMappingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
- Class com.amazonaws.services.apigatewayv2.model.GetApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiEndpoint
```
String apiEndpoint
```
      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
    - apiId
```
String apiId
```
      The API ID.
    - apiKeySelectionExpression
```
String apiKeySelectionExpression
```
      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
    - corsConfiguration
```
Cors corsConfiguration
```
      A CORS configuration. Supported only for HTTP APIs.
    - createdDate
```
Date createdDate
```
      The timestamp when the API was created.
    - description
```
String description
```
      The description of the API.
    - disableSchemaValidation
```
Boolean disableSchemaValidation
```
      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
    - importInfo
```
List<E> importInfo
```
      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
    - name
```
String name
```
      The name of the API.
    - protocolType
```
String protocolType
```
      The API protocol.
    - routeSelectionExpression
```
String routeSelectionExpression
```
      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
    - tags
```
Map<K,V> tags
```
      A collection of tags associated with the API.
    - version
```
String version
```
      A version identifier for the API.
    - warnings
```
List<E> warnings
```
      The warning messages reported when failonwarnings is turned on during API import.
- Class com.amazonaws.services.apigatewayv2.model.GetApisRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
String maxResults
```
      The maximum number of elements to be returned for this resource.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetApisResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - authorizerId
```
String authorizerId
```
      The authorizer identifier.
- Class com.amazonaws.services.apigatewayv2.model.GetAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - authorizerCredentialsArn
```
String authorizerCredentialsArn
```
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
    - authorizerId
```
String authorizerId
```
      The authorizer identifier.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      Authorizer caching is not currently supported. Don't specify this value for authorizers.
    - authorizerType
```
String authorizerType
```
      The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
    - authorizerUri
```
String authorizerUri
```
      The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: {account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates 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. Supported only for REQUEST authorizers.
    - identitySource
```
List<E> identitySource
```
      The identity source for which authorization is requested.
      
      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function.
      
      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization".
    - identityValidationExpression
```
String identityValidationExpression
```
      The validation expression does not apply to the REQUEST authorizer.
    - jwtConfiguration
```
JWTConfiguration jwtConfiguration
```
      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
    - name
```
String name
```
      The name of the authorizer.
- Class com.amazonaws.services.apigatewayv2.model.GetAuthorizersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - maxResults
```
String maxResults
```
      The maximum number of elements to be returned for this resource.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetAuthorizersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - deploymentId
```
String deploymentId
```
      The deployment ID.
- Class com.amazonaws.services.apigatewayv2.model.GetDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - autoDeployed
```
Boolean autoDeployed
```
      Specifies whether a deployment was automatically released.
    - createdDate
```
Date createdDate
```
      The date and time when the Deployment resource was created.
    - deploymentId
```
String deploymentId
```
      The identifier for the deployment.
    - deploymentStatus
```
String deploymentStatus
```
      The status of the deployment: PENDING, FAILED, or SUCCEEDED.
    - deploymentStatusMessage
```
String deploymentStatusMessage
```
      May contain additional feedback on the status of an API deployment.
    - description
```
String description
```
      The description for the deployment.
- Class com.amazonaws.services.apigatewayv2.model.GetDeploymentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - maxResults
```
String maxResults
```
      The maximum number of elements to be returned for this resource.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetDeploymentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetDomainNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The domain name.
- Class com.amazonaws.services.apigatewayv2.model.GetDomainNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiMappingSelectionExpression
```
String apiMappingSelectionExpression
```
      The API mapping selection expression.
    - domainName
```
String domainName
```
      The name of the DomainName resource.
    - domainNameConfigurations
```
List<E> domainNameConfigurations
```
      The domain name configurations.
    - tags
```
Map<K,V> tags
```
      The collection of tags associated with a domain name.
- Class com.amazonaws.services.apigatewayv2.model.GetDomainNamesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
String maxResults
```
      The maximum number of elements to be returned for this resource.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetDomainNamesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetIntegrationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - integrationId
```
String integrationId
```
      The integration ID.
- Class com.amazonaws.services.apigatewayv2.model.GetIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - integrationId
```
String integrationId
```
      The integration ID.
    - integrationResponseId
```
String integrationResponseId
```
      The integration response ID.
- Class com.amazonaws.services.apigatewayv2.model.GetIntegrationResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contentHandlingStrategy
```
String contentHandlingStrategy
```
      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    - integrationResponseId
```
String integrationResponseId
```
      The integration response ID.
    - integrationResponseKey
```
String integrationResponseKey
```
      The integration response key.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    - templateSelectionExpression
```
String templateSelectionExpression
```
      The template selection expressions for the integration response.
- Class com.amazonaws.services.apigatewayv2.model.GetIntegrationResponsesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - integrationId
```
String integrationId
```
      The integration ID.
    - maxResults
```
String maxResults
```
      The maximum number of elements to be returned for this resource.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetIntegrationResponsesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiGatewayManaged
```
Boolean apiGatewayManaged
```
      Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
    - connectionId
```
String connectionId
```
      The connection ID.
    - connectionType
```
String connectionType
```
      The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
    - contentHandlingStrategy
```
String contentHandlingStrategy
```
      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    - credentialsArn
```
String credentialsArn
```
      Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for 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.
    - description
```
String description
```
      Represents the description of an integration.
    - integrationId
```
String integrationId
```
      Represents the identifier of an integration.
    - integrationMethod
```
String integrationMethod
```
      Specifies the integration's HTTP method type.
    - integrationResponseSelectionExpression
```
String integrationResponseSelectionExpression
```
      The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
    - integrationType
```
String integrationType
```
      The integration type of an integration. One of the following:
      
      AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
      
      AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
      
      HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
      
      HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
      
      MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
    - integrationUri
```
String integrationUri
```
      For a Lambda proxy integration, this is the URI of the Lambda function.
    - passthroughBehavior
```
String passthroughBehavior
```
      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
      
      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 allows 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 HTTP 415 Unsupported Media Type response.
    - payloadFormatVersion
```
String payloadFormatVersion
```
      Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name. Supported only for WebSocket APIs.
    - requestTemplates
```
Map<K,V> 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. Supported only for WebSocket APIs.
    - templateSelectionExpression
```
String templateSelectionExpression
```
      The template selection expression for the integration. Supported only for WebSocket APIs.
    - timeoutInMillis
```
Integer timeoutInMillis
```
      Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
- Class com.amazonaws.services.apigatewayv2.model.GetIntegrationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - maxResults
```
String maxResults
```
      The maximum number of elements to be returned for this resource.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetIntegrationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - modelId
```
String modelId
```
      The model ID.
- Class com.amazonaws.services.apigatewayv2.model.GetModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contentType
```
String contentType
```
      The content-type for the model, for example, "application/json".
    - description
```
String description
```
      The description of the model.
    - modelId
```
String modelId
```
      The model identifier.
    - name
```
String name
```
      The name of the model. Must be alphanumeric.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON schema draft 4 model.
- Class com.amazonaws.services.apigatewayv2.model.GetModelsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - maxResults
```
String maxResults
```
      The maximum number of elements to be returned for this resource.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetModelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetModelTemplateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - modelId
```
String modelId
```
      The model ID.
- Class com.amazonaws.services.apigatewayv2.model.GetModelTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - value
```
String value
```
      The template value.
- Class com.amazonaws.services.apigatewayv2.model.GetRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - routeId
```
String routeId
```
      The route ID.
- Class com.amazonaws.services.apigatewayv2.model.GetRouteResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - routeId
```
String routeId
```
      The route ID.
    - routeResponseId
```
String routeResponseId
```
      The route response ID.
- Class com.amazonaws.services.apigatewayv2.model.GetRouteResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - modelSelectionExpression
```
String modelSelectionExpression
```
      Represents the model selection expression of a route response. Supported only for WebSocket APIs.
    - responseModels
```
Map<K,V> responseModels
```
      Represents the response models of a route response.
    - responseParameters
```
Map<K,V> responseParameters
```
      Represents the response parameters of a route response.
    - routeResponseId
```
String routeResponseId
```
      Represents the identifier of a route response.
    - routeResponseKey
```
String routeResponseKey
```
      Represents the route response key of a route response.
- Class com.amazonaws.services.apigatewayv2.model.GetRouteResponsesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - maxResults
```
String maxResults
```
      The maximum number of elements to be returned for this resource.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
    - routeId
```
String routeId
```
      The route ID.
- Class com.amazonaws.services.apigatewayv2.model.GetRouteResponsesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiGatewayManaged
```
Boolean apiGatewayManaged
```
      Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
    - authorizationScopes
```
List<E> authorizationScopes
```
      A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
    - authorizationType
```
String authorizationType
```
      The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.
    - authorizerId
```
String authorizerId
```
      The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    - modelSelectionExpression
```
String modelSelectionExpression
```
      The model selection expression for the route. Supported only for WebSocket APIs.
    - operationName
```
String operationName
```
      The operation name for the route.
    - requestModels
```
Map<K,V> requestModels
```
      The request models for the route. Supported only for WebSocket APIs.
    - requestParameters
```
Map<K,V> requestParameters
```
      The request parameters for the route. Supported only for WebSocket APIs.
    - routeId
```
String routeId
```
      The route ID.
    - routeKey
```
String routeKey
```
      The route key for the route.
    - routeResponseSelectionExpression
```
String routeResponseSelectionExpression
```
      The route response selection expression for the route. Supported only for WebSocket APIs.
    - target
```
String target
```
      The target for the route.
- Class com.amazonaws.services.apigatewayv2.model.GetRoutesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - maxResults
```
String maxResults
```
      The maximum number of elements to be returned for this resource.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetRoutesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - stageName
```
String stageName
```
      The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
- Class com.amazonaws.services.apigatewayv2.model.GetStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - accessLogSettings
```
AccessLogSettings accessLogSettings
```
      Settings for logging access in this stage.
    - apiGatewayManaged
```
Boolean apiGatewayManaged
```
      Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
    - autoDeploy
```
Boolean autoDeploy
```
      Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
    - createdDate
```
Date createdDate
```
      The timestamp when the stage was created.
    - defaultRouteSettings
```
RouteSettings defaultRouteSettings
```
      Default route settings for the stage.
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
    - description
```
String description
```
      The description of the stage.
    - lastDeploymentStatusMessage
```
String lastDeploymentStatusMessage
```
      Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The timestamp when the stage was last updated.
    - routeSettings
```
Map<K,V> routeSettings
```
      Route settings for the stage, by routeKey.
    - stageName
```
String stageName
```
      The name of the stage.
    - stageVariables
```
Map<K,V> stageVariables
```
      A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigatewayv2.model.GetStagesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - maxResults
```
String maxResults
```
      The maximum number of elements to be returned for this resource.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetStagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The next page of elements from this collection. Not valid for the last element of the collection.
- Class com.amazonaws.services.apigatewayv2.model.GetTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The resource ARN for the tag.
- Class com.amazonaws.services.apigatewayv2.model.GetTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
- Class com.amazonaws.services.apigatewayv2.model.ImportApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - basepath
```
String basepath
```
      Represents the base path of the imported API. Supported only for HTTP APIs.
    - body
```
String body
```
      The OpenAPI definition. Supported only for HTTP APIs.
    - failOnWarnings
```
Boolean failOnWarnings
```
      Specifies whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.
- Class com.amazonaws.services.apigatewayv2.model.ImportApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiEndpoint
```
String apiEndpoint
```
      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
    - apiId
```
String apiId
```
      The API ID.
    - apiKeySelectionExpression
```
String apiKeySelectionExpression
```
      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
    - corsConfiguration
```
Cors corsConfiguration
```
      A CORS configuration. Supported only for HTTP APIs.
    - createdDate
```
Date createdDate
```
      The timestamp when the API was created.
    - description
```
String description
```
      The description of the API.
    - disableSchemaValidation
```
Boolean disableSchemaValidation
```
      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
    - importInfo
```
List<E> importInfo
```
      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
    - name
```
String name
```
      The name of the API.
    - protocolType
```
String protocolType
```
      The API protocol.
    - routeSelectionExpression
```
String routeSelectionExpression
```
      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
    - tags
```
Map<K,V> tags
```
      A collection of tags associated with the API.
    - version
```
String version
```
      A version identifier for the API.
    - warnings
```
List<E> warnings
```
      The warning messages reported when failonwarnings is turned on during API import.
- Class com.amazonaws.services.apigatewayv2.model.Integration extends Object implements Serializable
  - Serialized Fields
    - apiGatewayManaged
```
Boolean apiGatewayManaged
```
      Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
    - connectionId
```
String connectionId
```
      The connection ID.
    - connectionType
```
String connectionType
```
      The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
    - contentHandlingStrategy
```
String contentHandlingStrategy
```
      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    - credentialsArn
```
String credentialsArn
```
      Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for 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.
    - description
```
String description
```
      Represents the description of an integration.
    - integrationId
```
String integrationId
```
      Represents the identifier of an integration.
    - integrationMethod
```
String integrationMethod
```
      Specifies the integration's HTTP method type.
    - integrationResponseSelectionExpression
```
String integrationResponseSelectionExpression
```
      The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
    - integrationType
```
String integrationType
```
      The integration type of an integration. One of the following:
      
      AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
      
      AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
      
      HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
      
      HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
      
      MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
    - integrationUri
```
String integrationUri
```
      For a Lambda proxy integration, this is the URI of the Lambda function.
    - passthroughBehavior
```
String passthroughBehavior
```
      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
      
      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 allows 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 HTTP 415 Unsupported Media Type response.
    - payloadFormatVersion
```
String payloadFormatVersion
```
      Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name. Supported only for WebSocket APIs.
    - requestTemplates
```
Map<K,V> 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. Supported only for WebSocket APIs.
    - templateSelectionExpression
```
String templateSelectionExpression
```
      The template selection expression for the integration. Supported only for WebSocket APIs.
    - timeoutInMillis
```
Integer timeoutInMillis
```
      Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
- Class com.amazonaws.services.apigatewayv2.model.IntegrationResponse extends Object implements Serializable
  - Serialized Fields
    - contentHandlingStrategy
```
String contentHandlingStrategy
```
      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    - integrationResponseId
```
String integrationResponseId
```
      The integration response ID.
    - integrationResponseKey
```
String integrationResponseKey
```
      The integration response key.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    - templateSelectionExpression
```
String templateSelectionExpression
```
      The template selection expressions for the integration response.
- Class com.amazonaws.services.apigatewayv2.model.JWTConfiguration extends Object implements Serializable
  - Serialized Fields
    - audience
```
List<E> audience
```
      A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.
    - issuer
```
String issuer
```
      The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId} . Required for the JWT authorizer type. Supported only for HTTP APIs.
- Class com.amazonaws.services.apigatewayv2.model.Model extends Object implements Serializable
  - Serialized Fields
    - contentType
```
String contentType
```
      The content-type for the model, for example, "application/json".
    - description
```
String description
```
      The description of the model.
    - modelId
```
String modelId
```
      The model identifier.
    - name
```
String name
```
      The name of the model. Must be alphanumeric.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON schema draft 4 model.
- Class com.amazonaws.services.apigatewayv2.model.NotFoundException extends AmazonApiGatewayV2Exception implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceType
```
String resourceType
```
      The resource type.
- Class com.amazonaws.services.apigatewayv2.model.ParameterConstraints extends Object implements Serializable
  - Serialized Fields
    - required
```
Boolean required
```
      Whether or not the parameter is required.
- Class com.amazonaws.services.apigatewayv2.model.ReimportApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - basepath
```
String basepath
```
      Represents the base path of the imported API. Supported only for HTTP APIs.
    - body
```
String body
```
      The OpenAPI definition. Supported only for HTTP APIs.
    - failOnWarnings
```
Boolean failOnWarnings
```
      Specifies whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.
- Class com.amazonaws.services.apigatewayv2.model.ReimportApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiEndpoint
```
String apiEndpoint
```
      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
    - apiId
```
String apiId
```
      The API ID.
    - apiKeySelectionExpression
```
String apiKeySelectionExpression
```
      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
    - corsConfiguration
```
Cors corsConfiguration
```
      A CORS configuration. Supported only for HTTP APIs.
    - createdDate
```
Date createdDate
```
      The timestamp when the API was created.
    - description
```
String description
```
      The description of the API.
    - disableSchemaValidation
```
Boolean disableSchemaValidation
```
      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
    - importInfo
```
List<E> importInfo
```
      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
    - name
```
String name
```
      The name of the API.
    - protocolType
```
String protocolType
```
      The API protocol.
    - routeSelectionExpression
```
String routeSelectionExpression
```
      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
    - tags
```
Map<K,V> tags
```
      A collection of tags associated with the API.
    - version
```
String version
```
      A version identifier for the API.
    - warnings
```
List<E> warnings
```
      The warning messages reported when failonwarnings is turned on during API import.
- Class com.amazonaws.services.apigatewayv2.model.Route extends Object implements Serializable
  - Serialized Fields
    - apiGatewayManaged
```
Boolean apiGatewayManaged
```
      Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
    - authorizationScopes
```
List<E> authorizationScopes
```
      A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
    - authorizationType
```
String authorizationType
```
      The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.
    - authorizerId
```
String authorizerId
```
      The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    - modelSelectionExpression
```
String modelSelectionExpression
```
      The model selection expression for the route. Supported only for WebSocket APIs.
    - operationName
```
String operationName
```
      The operation name for the route.
    - requestModels
```
Map<K,V> requestModels
```
      The request models for the route. Supported only for WebSocket APIs.
    - requestParameters
```
Map<K,V> requestParameters
```
      The request parameters for the route. Supported only for WebSocket APIs.
    - routeId
```
String routeId
```
      The route ID.
    - routeKey
```
String routeKey
```
      The route key for the route.
    - routeResponseSelectionExpression
```
String routeResponseSelectionExpression
```
      The route response selection expression for the route. Supported only for WebSocket APIs.
    - target
```
String target
```
      The target for the route.
- Class com.amazonaws.services.apigatewayv2.model.RouteResponse extends Object implements Serializable
  - Serialized Fields
    - modelSelectionExpression
```
String modelSelectionExpression
```
      Represents the model selection expression of a route response. Supported only for WebSocket APIs.
    - responseModels
```
Map<K,V> responseModels
```
      Represents the response models of a route response.
    - responseParameters
```
Map<K,V> responseParameters
```
      Represents the response parameters of a route response.
    - routeResponseId
```
String routeResponseId
```
      Represents the identifier of a route response.
    - routeResponseKey
```
String routeResponseKey
```
      Represents the route response key of a route response.
- Class com.amazonaws.services.apigatewayv2.model.RouteSettings extends Object implements Serializable
  - Serialized Fields
    - dataTraceEnabled
```
Boolean dataTraceEnabled
```
      Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    - detailedMetricsEnabled
```
Boolean detailedMetricsEnabled
```
      Specifies whether detailed metrics are enabled.
    - loggingLevel
```
String loggingLevel
```
      Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
    - throttlingBurstLimit
```
Integer throttlingBurstLimit
```
      Specifies the throttling burst limit. Supported only for WebSocket APIs.
    - throttlingRateLimit
```
Double throttlingRateLimit
```
      Specifies the throttling rate limit. Supported only for WebSocket APIs.
- Class com.amazonaws.services.apigatewayv2.model.Stage extends Object implements Serializable
  - Serialized Fields
    - accessLogSettings
```
AccessLogSettings accessLogSettings
```
      Settings for logging access in this stage.
    - apiGatewayManaged
```
Boolean apiGatewayManaged
```
      Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
    - autoDeploy
```
Boolean autoDeploy
```
      Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
    - createdDate
```
Date createdDate
```
      The timestamp when the stage was created.
    - defaultRouteSettings
```
RouteSettings defaultRouteSettings
```
      Default route settings for the stage.
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
    - description
```
String description
```
      The description of the stage.
    - lastDeploymentStatusMessage
```
String lastDeploymentStatusMessage
```
      Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The timestamp when the stage was last updated.
    - routeSettings
```
Map<K,V> routeSettings
```
      Route settings for the stage, by routeKey.
    - stageName
```
String stageName
```
      The name of the stage.
    - stageVariables
```
Map<K,V> stageVariables
```
      A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigatewayv2.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The resource ARN for the tag.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
- Class com.amazonaws.services.apigatewayv2.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.TooManyRequestsException extends AmazonApiGatewayV2Exception implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - limitType
```
String limitType
```
      The limit type.
- Class com.amazonaws.services.apigatewayv2.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The resource ARN for the tag.
    - tagKeys
```
List<E> tagKeys
```
      The Tag keys to delete.
- Class com.amazonaws.services.apigatewayv2.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.apigatewayv2.model.UpdateApiMappingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - apiMappingId
```
String apiMappingId
```
      The API mapping identifier.
    - apiMappingKey
```
String apiMappingKey
```
      The API mapping key.
    - domainName
```
String domainName
```
      The domain name.
    - stage
```
String stage
```
      The API stage.
- Class com.amazonaws.services.apigatewayv2.model.UpdateApiMappingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - apiMappingId
```
String apiMappingId
```
      The API mapping identifier.
    - apiMappingKey
```
String apiMappingKey
```
      The API mapping key.
    - stage
```
String stage
```
      The API stage.
- Class com.amazonaws.services.apigatewayv2.model.UpdateApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - apiKeySelectionExpression
```
String apiKeySelectionExpression
```
      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
    - corsConfiguration
```
Cors corsConfiguration
```
      A CORS configuration. Supported only for HTTP APIs.
    - credentialsArn
```
String credentialsArn
```
      This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for 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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
    - description
```
String description
```
      The description of the API.
    - disableSchemaValidation
```
Boolean disableSchemaValidation
```
      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
    - name
```
String name
```
      The name of the API.
    - routeKey
```
String routeKey
```
      This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
    - routeSelectionExpression
```
String routeSelectionExpression
```
      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
    - target
```
String target
```
      This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
    - version
```
String version
```
      A version identifier for the API.
- Class com.amazonaws.services.apigatewayv2.model.UpdateApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiEndpoint
```
String apiEndpoint
```
      The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
    - apiId
```
String apiId
```
      The API ID.
    - apiKeySelectionExpression
```
String apiKeySelectionExpression
```
      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
    - corsConfiguration
```
Cors corsConfiguration
```
      A CORS configuration. Supported only for HTTP APIs.
    - createdDate
```
Date createdDate
```
      The timestamp when the API was created.
    - description
```
String description
```
      The description of the API.
    - disableSchemaValidation
```
Boolean disableSchemaValidation
```
      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
    - importInfo
```
List<E> importInfo
```
      The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
    - name
```
String name
```
      The name of the API.
    - protocolType
```
String protocolType
```
      The API protocol.
    - routeSelectionExpression
```
String routeSelectionExpression
```
      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
    - tags
```
Map<K,V> tags
```
      A collection of tags associated with the API.
    - version
```
String version
```
      A version identifier for the API.
    - warnings
```
List<E> warnings
```
      The warning messages reported when failonwarnings is turned on during API import.
- Class com.amazonaws.services.apigatewayv2.model.UpdateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - authorizerCredentialsArn
```
String authorizerCredentialsArn
```
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
    - authorizerId
```
String authorizerId
```
      The authorizer identifier.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      Authorizer caching is not currently supported. Don't specify this value for authorizers.
    - authorizerType
```
String authorizerType
```
      The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
    - authorizerUri
```
String authorizerUri
```
      The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: {account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates 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. Supported only for REQUEST authorizers.
    - identitySource
```
List<E> identitySource
```
      The identity source for which authorization is requested.
      
      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function.
      
      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization".
    - identityValidationExpression
```
String identityValidationExpression
```
      This parameter is not used.
    - jwtConfiguration
```
JWTConfiguration jwtConfiguration
```
      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
    - name
```
String name
```
      The name of the authorizer.
- Class com.amazonaws.services.apigatewayv2.model.UpdateAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - authorizerCredentialsArn
```
String authorizerCredentialsArn
```
      Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. Supported only for REQUEST authorizers.
    - authorizerId
```
String authorizerId
```
      The authorizer identifier.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      Authorizer caching is not currently supported. Don't specify this value for authorizers.
    - authorizerType
```
String authorizerType
```
      The authorizer type. For WebSocket APIs, specify REQUEST for a Lambda function using incoming request parameters. For HTTP APIs, specify JWT to use JSON Web Tokens.
    - authorizerUri
```
String authorizerUri
```
      The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: {account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates 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. Supported only for REQUEST authorizers.
    - identitySource
```
List<E> identitySource
```
      The identity source for which authorization is requested.
      
      For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. Currently, the identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name. These parameters will be used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function.
      
      For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example "$request.header.Authorization".
    - identityValidationExpression
```
String identityValidationExpression
```
      The validation expression does not apply to the REQUEST authorizer.
    - jwtConfiguration
```
JWTConfiguration jwtConfiguration
```
      Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
    - name
```
String name
```
      The name of the authorizer.
- Class com.amazonaws.services.apigatewayv2.model.UpdateDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - deploymentId
```
String deploymentId
```
      The deployment ID.
    - description
```
String description
```
      The description for the deployment resource.
- Class com.amazonaws.services.apigatewayv2.model.UpdateDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - autoDeployed
```
Boolean autoDeployed
```
      Specifies whether a deployment was automatically released.
    - createdDate
```
Date createdDate
```
      The date and time when the Deployment resource was created.
    - deploymentId
```
String deploymentId
```
      The identifier for the deployment.
    - deploymentStatus
```
String deploymentStatus
```
      The status of the deployment: PENDING, FAILED, or SUCCEEDED.
    - deploymentStatusMessage
```
String deploymentStatusMessage
```
      May contain additional feedback on the status of an API deployment.
    - description
```
String description
```
      The description for the deployment.
- Class com.amazonaws.services.apigatewayv2.model.UpdateDomainNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The domain name.
    - domainNameConfigurations
```
List<E> domainNameConfigurations
```
      The domain name configurations.
- Class com.amazonaws.services.apigatewayv2.model.UpdateDomainNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiMappingSelectionExpression
```
String apiMappingSelectionExpression
```
      The API mapping selection expression.
    - domainName
```
String domainName
```
      The name of the DomainName resource.
    - domainNameConfigurations
```
List<E> domainNameConfigurations
```
      The domain name configurations.
    - tags
```
Map<K,V> tags
```
      The collection of tags associated with a domain name.
- Class com.amazonaws.services.apigatewayv2.model.UpdateIntegrationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - connectionId
```
String connectionId
```
      The connection ID.
    - connectionType
```
String connectionType
```
      The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
    - contentHandlingStrategy
```
String contentHandlingStrategy
```
      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    - credentialsArn
```
String credentialsArn
```
      Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for 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.
    - description
```
String description
```
      The description of the integration
    - integrationId
```
String integrationId
```
      The integration ID.
    - integrationMethod
```
String integrationMethod
```
      Specifies the integration's HTTP method type.
    - integrationType
```
String integrationType
```
      The integration type of an integration. One of the following:
      
      AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
      
      AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
      
      HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
      
      HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
      
      MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
    - integrationUri
```
String integrationUri
```
      For a Lambda proxy integration, this is the URI of the Lambda function.
    - passthroughBehavior
```
String passthroughBehavior
```
      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
      
      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 allows 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 HTTP 415 Unsupported Media Type response.
    - payloadFormatVersion
```
String payloadFormatVersion
```
      Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name. Supported only for WebSocket APIs.
    - requestTemplates
```
Map<K,V> 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. Supported only for WebSocket APIs.
    - templateSelectionExpression
```
String templateSelectionExpression
```
      The template selection expression for the integration.
    - timeoutInMillis
```
Integer timeoutInMillis
```
      Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
- Class com.amazonaws.services.apigatewayv2.model.UpdateIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - contentHandlingStrategy
```
String contentHandlingStrategy
```
      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    - integrationId
```
String integrationId
```
      The integration ID.
    - integrationResponseId
```
String integrationResponseId
```
      The integration response ID.
    - integrationResponseKey
```
String integrationResponseKey
```
      The integration response key.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where {name} is a valid and unique response header name and {JSON-expression} is a valid JSON expression without the $ prefix.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    - templateSelectionExpression
```
String templateSelectionExpression
```
      The template selection expression for the integration response. Supported only for WebSocket APIs.
- Class com.amazonaws.services.apigatewayv2.model.UpdateIntegrationResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contentHandlingStrategy
```
String contentHandlingStrategy
```
      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    - integrationResponseId
```
String integrationResponseId
```
      The integration response ID.
    - integrationResponseKey
```
String integrationResponseKey
```
      The integration response key.
    - responseParameters
```
Map<K,V> responseParameters
```
      A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
    - templateSelectionExpression
```
String templateSelectionExpression
```
      The template selection expressions for the integration response.
- Class com.amazonaws.services.apigatewayv2.model.UpdateIntegrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiGatewayManaged
```
Boolean apiGatewayManaged
```
      Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
    - connectionId
```
String connectionId
```
      The connection ID.
    - connectionType
```
String connectionType
```
      The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
    - contentHandlingStrategy
```
String contentHandlingStrategy
```
      Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
      
      CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
      
      CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
      
      If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
    - credentialsArn
```
String credentialsArn
```
      Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for 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.
    - description
```
String description
```
      Represents the description of an integration.
    - integrationId
```
String integrationId
```
      Represents the identifier of an integration.
    - integrationMethod
```
String integrationMethod
```
      Specifies the integration's HTTP method type.
    - integrationResponseSelectionExpression
```
String integrationResponseSelectionExpression
```
      The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
    - integrationType
```
String integrationType
```
      The integration type of an integration. One of the following:
      
      AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
      
      AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
      
      HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
      
      HTTP_PROXY: for integrating route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
      
      MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
    - integrationUri
```
String integrationUri
```
      For a Lambda proxy integration, this is the URI of the Lambda function.
    - passthroughBehavior
```
String passthroughBehavior
```
      Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
      
      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 allows 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 HTTP 415 Unsupported Media Type response.
    - payloadFormatVersion
```
String payloadFormatVersion
```
      Specifies the format of the payload sent to an integration. Required for HTTP APIs. Currently, the only supported value is 1.0.
    - requestParameters
```
Map<K,V> requestParameters
```
      A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name. Supported only for WebSocket APIs.
    - requestTemplates
```
Map<K,V> 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. Supported only for WebSocket APIs.
    - templateSelectionExpression
```
String templateSelectionExpression
```
      The template selection expression for the integration. Supported only for WebSocket APIs.
    - timeoutInMillis
```
Integer timeoutInMillis
```
      Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds for WebSocket APIs. The default value is 5,000 milliseconds, or 5 seconds for HTTP APIs.
- Class com.amazonaws.services.apigatewayv2.model.UpdateModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - contentType
```
String contentType
```
      The content-type for the model, for example, "application/json".
    - description
```
String description
```
      The description of the model.
    - modelId
```
String modelId
```
      The model ID.
    - 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 4 model.
- Class com.amazonaws.services.apigatewayv2.model.UpdateModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - contentType
```
String contentType
```
      The content-type for the model, for example, "application/json".
    - description
```
String description
```
      The description of the model.
    - modelId
```
String modelId
```
      The model identifier.
    - name
```
String name
```
      The name of the model. Must be alphanumeric.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON schema draft 4 model.
- Class com.amazonaws.services.apigatewayv2.model.UpdateRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
    - authorizationScopes
```
List<E> authorizationScopes
```
      The authorization scopes supported by this route.
    - authorizationType
```
String authorizationType
```
      The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.
    - authorizerId
```
String authorizerId
```
      The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    - modelSelectionExpression
```
String modelSelectionExpression
```
      The model selection expression for the route. Supported only for WebSocket APIs.
    - operationName
```
String operationName
```
      The operation name for the route.
    - requestModels
```
Map<K,V> requestModels
```
      The request models for the route. Supported only for WebSocket APIs.
    - requestParameters
```
Map<K,V> requestParameters
```
      The request parameters for the route. Supported only for WebSocket APIs.
    - routeId
```
String routeId
```
      The route ID.
    - routeKey
```
String routeKey
```
      The route key for the route.
    - routeResponseSelectionExpression
```
String routeResponseSelectionExpression
```
      The route response selection expression for the route. Supported only for WebSocket APIs.
    - target
```
String target
```
      The target for the route.
- Class com.amazonaws.services.apigatewayv2.model.UpdateRouteResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API identifier.
    - modelSelectionExpression
```
String modelSelectionExpression
```
      The model selection expression for the route response. Supported only for WebSocket APIs.
    - responseModels
```
Map<K,V> responseModels
```
      The response models for the route response.
    - responseParameters
```
Map<K,V> responseParameters
```
      The route response parameters.
    - routeId
```
String routeId
```
      The route ID.
    - routeResponseId
```
String routeResponseId
```
      The route response ID.
    - routeResponseKey
```
String routeResponseKey
```
      The route response key.
- Class com.amazonaws.services.apigatewayv2.model.UpdateRouteResponseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - modelSelectionExpression
```
String modelSelectionExpression
```
      Represents the model selection expression of a route response. Supported only for WebSocket APIs.
    - responseModels
```
Map<K,V> responseModels
```
      Represents the response models of a route response.
    - responseParameters
```
Map<K,V> responseParameters
```
      Represents the response parameters of a route response.
    - routeResponseId
```
String routeResponseId
```
      Represents the identifier of a route response.
    - routeResponseKey
```
String routeResponseKey
```
      Represents the route response key of a route response.
- Class com.amazonaws.services.apigatewayv2.model.UpdateRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiGatewayManaged
```
Boolean apiGatewayManaged
```
      Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
    - authorizationScopes
```
List<E> authorizationScopes
```
      A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
    - authorizationType
```
String authorizationType
```
      The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.
    - authorizerId
```
String authorizerId
```
      The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
    - modelSelectionExpression
```
String modelSelectionExpression
```
      The model selection expression for the route. Supported only for WebSocket APIs.
    - operationName
```
String operationName
```
      The operation name for the route.
    - requestModels
```
Map<K,V> requestModels
```
      The request models for the route. Supported only for WebSocket APIs.
    - requestParameters
```
Map<K,V> requestParameters
```
      The request parameters for the route. Supported only for WebSocket APIs.
    - routeId
```
String routeId
```
      The route ID.
    - routeKey
```
String routeKey
```
      The route key for the route.
    - routeResponseSelectionExpression
```
String routeResponseSelectionExpression
```
      The route response selection expression for the route. Supported only for WebSocket APIs.
    - target
```
String target
```
      The target for the route.
- Class com.amazonaws.services.apigatewayv2.model.UpdateStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessLogSettings
```
AccessLogSettings accessLogSettings
```
      Settings for logging access in this stage.
    - apiId
```
String apiId
```
      The API identifier.
    - autoDeploy
```
Boolean autoDeploy
```
      Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of a client certificate for a Stage.
    - defaultRouteSettings
```
RouteSettings defaultRouteSettings
```
      The default route settings for the stage.
    - deploymentId
```
String deploymentId
```
      The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
    - description
```
String description
```
      The description for the API stage.
    - routeSettings
```
Map<K,V> routeSettings
```
      Route settings for the stage.
    - stageName
```
String stageName
```
      The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
    - stageVariables
```
Map<K,V> stageVariables
```
      A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs.
- Class com.amazonaws.services.apigatewayv2.model.UpdateStageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - accessLogSettings
```
AccessLogSettings accessLogSettings
```
      Settings for logging access in this stage.
    - apiGatewayManaged
```
Boolean apiGatewayManaged
```
      Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
    - autoDeploy
```
Boolean autoDeploy
```
      Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
    - createdDate
```
Date createdDate
```
      The timestamp when the stage was created.
    - defaultRouteSettings
```
RouteSettings defaultRouteSettings
```
      Default route settings for the stage.
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
    - description
```
String description
```
      The description of the stage.
    - lastDeploymentStatusMessage
```
String lastDeploymentStatusMessage
```
      Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The timestamp when the stage was last updated.
    - routeSettings
```
Map<K,V> routeSettings
```
      Route settings for the stage, by routeKey.
    - stageName
```
String stageName
```
      The name of the stage.
    - stageVariables
```
Map<K,V> stageVariables
```
      A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+. Supported only for WebSocket APIs.
    - tags
```
Map<K,V> tags
```
      The collection of tags. Each tag element is associated with a given resource.
Package com.amazonaws.services.appconfig.model
- Class com.amazonaws.services.appconfig.model.AmazonAppConfigException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appconfig.model.Application extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The application ID.
    - name
```
String name
```
      The application name.
    - description
```
String description
```
      The description of the application.
- Class com.amazonaws.services.appconfig.model.BadRequestException extends AmazonAppConfigException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appconfig.model.ConfigurationProfileSummary extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - id
```
String id
```
      The ID of the configuration profile.
    - name
```
String name
```
      The name of the configuration profile.
    - locationUri
```
String locationUri
```
      The URI location of the configuration.
    - validatorTypes
```
List<E> validatorTypes
```
      The types of validators in the configuration profile.
- Class com.amazonaws.services.appconfig.model.ConflictException extends AmazonAppConfigException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appconfig.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      A name for the application.
    - description
```
String description
```
      A description of the application.
    - tags
```
Map<K,V> tags
```
      Metadata to assign to the application. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
- Class com.amazonaws.services.appconfig.model.CreateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The application ID.
    - name
```
String name
```
      The application name.
    - description
```
String description
```
      The description of the application.
- Class com.amazonaws.services.appconfig.model.CreateConfigurationProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - name
```
String name
```
      A name for the configuration profile.
    - description
```
String description
```
      A description of the configuration profile.
    - locationUri
```
String locationUri
```
      A URI to locate the configuration. You can specify either a Systems Manager (SSM) document or an SSM Parameter Store parameter. For an SSM document, specify either the document name in the format ssm-document://<Document name> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format ssm-parameter://<Parameter name> or the ARN.
    - retrievalRoleArn
```
String retrievalRoleArn
```
      The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
    - validators
```
List<E> validators
```
      A list of methods for validating the configuration.
    - tags
```
Map<K,V> tags
```
      Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
- Class com.amazonaws.services.appconfig.model.CreateConfigurationProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - id
```
String id
```
      The configuration profile ID.
    - name
```
String name
```
      The name of the configuration profile.
    - description
```
String description
```
      The configuration profile description.
    - locationUri
```
String locationUri
```
      The URI location of the configuration.
    - retrievalRoleArn
```
String retrievalRoleArn
```
      The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
    - validators
```
List<E> validators
```
      A list of methods for validating the configuration.
- Class com.amazonaws.services.appconfig.model.CreateDeploymentStrategyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      A name for the deployment strategy.
    - description
```
String description
```
      A description of the deployment strategy.
    - deploymentDurationInMinutes
```
Integer deploymentDurationInMinutes
```
      Total amount of time for a deployment to last.
    - finalBakeTimeInMinutes
```
Integer finalBakeTimeInMinutes
```
      The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
    - growthFactor
```
Float growthFactor
```
      The percentage of targets to receive a deployed configuration during each interval.
    - growthType
```
String growthType
```
      The algorithm used to define how percentage grows over time.
    - replicateTo
```
String replicateTo
```
      Save the deployment strategy to a Systems Manager (SSM) document.
    - tags
```
Map<K,V> tags
```
      Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
- Class com.amazonaws.services.appconfig.model.CreateDeploymentStrategyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The deployment strategy ID.
    - name
```
String name
```
      The name of the deployment strategy.
    - description
```
String description
```
      The description of the deployment strategy.
    - deploymentDurationInMinutes
```
Integer deploymentDurationInMinutes
```
      Total amount of time the deployment lasted.
    - growthType
```
String growthType
```
      The algorithm used to define how percentage grew over time.
    - growthFactor
```
Float growthFactor
```
      The percentage of targets that received a deployed configuration during each interval.
    - finalBakeTimeInMinutes
```
Integer finalBakeTimeInMinutes
```
      The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
    - replicateTo
```
String replicateTo
```
      Save the deployment strategy to a Systems Manager (SSM) document.
- Class com.amazonaws.services.appconfig.model.CreateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - name
```
String name
```
      A name for the environment.
    - description
```
String description
```
      A description of the environment.
    - monitors
```
List<E> monitors
```
      Amazon CloudWatch alarms to monitor during the deployment process.
    - tags
```
Map<K,V> tags
```
      Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
- Class com.amazonaws.services.appconfig.model.CreateEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - id
```
String id
```
      The environment ID.
    - name
```
String name
```
      The name of the environment.
    - description
```
String description
```
      The description of the environment.
    - state
```
String state
```
      The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK
    - monitors
```
List<E> monitors
```
      Amazon CloudWatch alarms monitored during the deployment.
- Class com.amazonaws.services.appconfig.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application to delete.
- Class com.amazonaws.services.appconfig.model.DeleteApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appconfig.model.DeleteConfigurationProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID that includes the configuration profile you want to delete.
    - configurationProfileId
```
String configurationProfileId
```
      The ID of the configuration profile you want to delete.
- Class com.amazonaws.services.appconfig.model.DeleteConfigurationProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appconfig.model.DeleteDeploymentStrategyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deploymentStrategyId
```
String deploymentStrategyId
```
      The ID of the deployment strategy you want to delete.
- Class com.amazonaws.services.appconfig.model.DeleteDeploymentStrategyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appconfig.model.DeleteEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID that includes the environment you want to delete.
    - environmentId
```
String environmentId
```
      The ID of the environment you want to delete.
- Class com.amazonaws.services.appconfig.model.DeleteEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appconfig.model.DeploymentStrategy extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The deployment strategy ID.
    - name
```
String name
```
      The name of the deployment strategy.
    - description
```
String description
```
      The description of the deployment strategy.
    - deploymentDurationInMinutes
```
Integer deploymentDurationInMinutes
```
      Total amount of time the deployment lasted.
    - growthType
```
String growthType
```
      The algorithm used to define how percentage grew over time.
    - growthFactor
```
Float growthFactor
```
      The percentage of targets that received a deployed configuration during each interval.
    - finalBakeTimeInMinutes
```
Integer finalBakeTimeInMinutes
```
      The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
    - replicateTo
```
String replicateTo
```
      Save the deployment strategy to a Systems Manager (SSM) document.
- Class com.amazonaws.services.appconfig.model.DeploymentSummary extends Object implements Serializable
  - Serialized Fields
    - deploymentNumber
```
Integer deploymentNumber
```
      The sequence number of the deployment.
    - configurationName
```
String configurationName
```
      The name of the configuration.
    - configurationVersion
```
String configurationVersion
```
      The version of the configuration.
    - deploymentDurationInMinutes
```
Integer deploymentDurationInMinutes
```
      Total amount of time the deployment lasted.
    - growthType
```
String growthType
```
      The algorithm used to define how percentage grows over time.
    - growthFactor
```
Float growthFactor
```
      The percentage of targets to receive a deployed configuration during each interval.
    - finalBakeTimeInMinutes
```
Integer finalBakeTimeInMinutes
```
      The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
    - state
```
String state
```
      The state of the deployment.
    - percentageComplete
```
Float percentageComplete
```
      The percentage of targets for which the deployment is available.
    - startedAt
```
Date startedAt
```
      Time the deployment started.
    - completedAt
```
Date completedAt
```
      Time the deployment completed.
- Class com.amazonaws.services.appconfig.model.Environment extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - id
```
String id
```
      The environment ID.
    - name
```
String name
```
      The name of the environment.
    - description
```
String description
```
      The description of the environment.
    - state
```
String state
```
      The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK
    - monitors
```
List<E> monitors
```
      Amazon CloudWatch alarms monitored during the deployment.
- Class com.amazonaws.services.appconfig.model.GetApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application you want to get.
- Class com.amazonaws.services.appconfig.model.GetApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The application ID.
    - name
```
String name
```
      The application name.
    - description
```
String description
```
      The description of the application.
- Class com.amazonaws.services.appconfig.model.GetConfigurationProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application that includes the configuration profile you want to get.
    - configurationProfileId
```
String configurationProfileId
```
      The ID of the configuration profile you want to get.
- Class com.amazonaws.services.appconfig.model.GetConfigurationProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - id
```
String id
```
      The configuration profile ID.
    - name
```
String name
```
      The name of the configuration profile.
    - description
```
String description
```
      The configuration profile description.
    - locationUri
```
String locationUri
```
      The URI location of the configuration.
    - retrievalRoleArn
```
String retrievalRoleArn
```
      The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
    - validators
```
List<E> validators
```
      A list of methods for validating the configuration.
- Class com.amazonaws.services.appconfig.model.GetConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - application
```
String application
```
      The application to get.
    - environment
```
String environment
```
      The environment to get.
    - configuration
```
String configuration
```
      The configuration to get.
    - clientId
```
String clientId
```
      A unique ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.
    - clientConfigurationVersion
```
String clientConfigurationVersion
```
      The configuration version returned in the most recent GetConfiguration response.
- Class com.amazonaws.services.appconfig.model.GetConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - content
```
ByteBuffer content
```
      The content of the configuration or the configuration data.
    - configurationVersion
```
String configurationVersion
```
      The configuration version.
    - contentType
```
String contentType
```
      A standard MIME type describing the format of the configuration content. For more information, see Content-Type.
- Class com.amazonaws.services.appconfig.model.GetDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application that includes the deployment you want to get.
    - environmentId
```
String environmentId
```
      The ID of the environment that includes the deployment you want to get.
    - deploymentNumber
```
Integer deploymentNumber
```
      The sequence number of the deployment.
- Class com.amazonaws.services.appconfig.model.GetDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application that was deployed.
    - environmentId
```
String environmentId
```
      The ID of the environment that was deployed.
    - deploymentStrategyId
```
String deploymentStrategyId
```
      The ID of the deployment strategy that was deployed.
    - configurationProfileId
```
String configurationProfileId
```
      The ID of the configuration profile that was deployed.
    - deploymentNumber
```
Integer deploymentNumber
```
      The sequence number of the deployment.
    - configurationName
```
String configurationName
```
      The name of the configuration.
    - configurationLocationUri
```
String configurationLocationUri
```
      Information about the source location of the configuration.
    - configurationVersion
```
String configurationVersion
```
      The configuration version that was deployed.
    - description
```
String description
```
      The description of the deployment.
    - deploymentDurationInMinutes
```
Integer deploymentDurationInMinutes
```
      Total amount of time the deployment lasted.
    - growthType
```
String growthType
```
      The algorithm used to define how percentage grew over time.
    - growthFactor
```
Float growthFactor
```
      The percentage of targets to receive a deployed configuration during each interval.
    - finalBakeTimeInMinutes
```
Integer finalBakeTimeInMinutes
```
      The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
    - state
```
String state
```
      The state of the deployment.
    - percentageComplete
```
Float percentageComplete
```
      The percentage of targets for which the deployment is available.
    - startedAt
```
Date startedAt
```
      The time the deployment started.
    - completedAt
```
Date completedAt
```
      The time the deployment completed.
- Class com.amazonaws.services.appconfig.model.GetDeploymentStrategyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deploymentStrategyId
```
String deploymentStrategyId
```
      The ID of the deployment strategy to get.
- Class com.amazonaws.services.appconfig.model.GetDeploymentStrategyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The deployment strategy ID.
    - name
```
String name
```
      The name of the deployment strategy.
    - description
```
String description
```
      The description of the deployment strategy.
    - deploymentDurationInMinutes
```
Integer deploymentDurationInMinutes
```
      Total amount of time the deployment lasted.
    - growthType
```
String growthType
```
      The algorithm used to define how percentage grew over time.
    - growthFactor
```
Float growthFactor
```
      The percentage of targets that received a deployed configuration during each interval.
    - finalBakeTimeInMinutes
```
Integer finalBakeTimeInMinutes
```
      The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
    - replicateTo
```
String replicateTo
```
      Save the deployment strategy to a Systems Manager (SSM) document.
- Class com.amazonaws.services.appconfig.model.GetEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application that includes the environment you want to get.
    - environmentId
```
String environmentId
```
      The ID of the environment you wnat to get.
- Class com.amazonaws.services.appconfig.model.GetEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - id
```
String id
```
      The environment ID.
    - name
```
String name
```
      The name of the environment.
    - description
```
String description
```
      The description of the environment.
    - state
```
String state
```
      The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK
    - monitors
```
List<E> monitors
```
      Amazon CloudWatch alarms monitored during the deployment.
- Class com.amazonaws.services.appconfig.model.InternalServerException extends AmazonAppConfigException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appconfig.model.ListApplicationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
    - nextToken
```
String nextToken
```
      A token to start the list. Use this token to get the next set of results.
- Class com.amazonaws.services.appconfig.model.ListApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. Use this token to get the next set of results.
- Class com.amazonaws.services.appconfig.model.ListConfigurationProfilesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
    - nextToken
```
String nextToken
```
      A token to start the list. Use this token to get the next set of results.
- Class com.amazonaws.services.appconfig.model.ListConfigurationProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. Use this token to get the next set of results.
- Class com.amazonaws.services.appconfig.model.ListDeploymentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - environmentId
```
String environmentId
```
      The environment ID.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
    - nextToken
```
String nextToken
```
      A token to start the list. Use this token to get the next set of results.
- Class com.amazonaws.services.appconfig.model.ListDeploymentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. Use this token to get the next set of results.
- Class com.amazonaws.services.appconfig.model.ListDeploymentStrategiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
    - nextToken
```
String nextToken
```
      A token to start the list. Use this token to get the next set of results.
- Class com.amazonaws.services.appconfig.model.ListDeploymentStrategiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. Use this token to get the next set of results.
- Class com.amazonaws.services.appconfig.model.ListEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
    - nextToken
```
String nextToken
```
      A token to start the list. Use this token to get the next set of results.
- Class com.amazonaws.services.appconfig.model.ListEnvironmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - items
```
List<E> items
```
      The elements from this collection.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. Use this token to get the next set of results.
- Class com.amazonaws.services.appconfig.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The resource ARN.
- Class com.amazonaws.services.appconfig.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      Metadata to assign to AppConfig resources. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
- Class com.amazonaws.services.appconfig.model.Monitor extends Object implements Serializable
  - Serialized Fields
    - alarmArn
```
String alarmArn
```
      ARN of the Amazon CloudWatch alarm.
    - alarmRoleArn
```
String alarmRoleArn
```
      ARN of an IAM role for AppConfig to monitor AlarmArn.
- Class com.amazonaws.services.appconfig.model.ResourceNotFoundException extends AmazonAppConfigException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceName
```
String resourceName
```
- Class com.amazonaws.services.appconfig.model.StartDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - environmentId
```
String environmentId
```
      The environment ID.
    - deploymentStrategyId
```
String deploymentStrategyId
```
      The deployment strategy ID.
    - configurationProfileId
```
String configurationProfileId
```
      The configuration profile ID.
    - configurationVersion
```
String configurationVersion
```
      The configuration version to deploy.
    - description
```
String description
```
      A description of the deployment.
    - tags
```
Map<K,V> tags
```
      Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
- Class com.amazonaws.services.appconfig.model.StartDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application that was deployed.
    - environmentId
```
String environmentId
```
      The ID of the environment that was deployed.
    - deploymentStrategyId
```
String deploymentStrategyId
```
      The ID of the deployment strategy that was deployed.
    - configurationProfileId
```
String configurationProfileId
```
      The ID of the configuration profile that was deployed.
    - deploymentNumber
```
Integer deploymentNumber
```
      The sequence number of the deployment.
    - configurationName
```
String configurationName
```
      The name of the configuration.
    - configurationLocationUri
```
String configurationLocationUri
```
      Information about the source location of the configuration.
    - configurationVersion
```
String configurationVersion
```
      The configuration version that was deployed.
    - description
```
String description
```
      The description of the deployment.
    - deploymentDurationInMinutes
```
Integer deploymentDurationInMinutes
```
      Total amount of time the deployment lasted.
    - growthType
```
String growthType
```
      The algorithm used to define how percentage grew over time.
    - growthFactor
```
Float growthFactor
```
      The percentage of targets to receive a deployed configuration during each interval.
    - finalBakeTimeInMinutes
```
Integer finalBakeTimeInMinutes
```
      The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
    - state
```
String state
```
      The state of the deployment.
    - percentageComplete
```
Float percentageComplete
```
      The percentage of targets for which the deployment is available.
    - startedAt
```
Date startedAt
```
      The time the deployment started.
    - completedAt
```
Date completedAt
```
      The time the deployment completed.
- Class com.amazonaws.services.appconfig.model.StopDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - environmentId
```
String environmentId
```
      The environment ID.
    - deploymentNumber
```
Integer deploymentNumber
```
      The sequence number of the deployment.
- Class com.amazonaws.services.appconfig.model.StopDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The ID of the application that was deployed.
    - environmentId
```
String environmentId
```
      The ID of the environment that was deployed.
    - deploymentStrategyId
```
String deploymentStrategyId
```
      The ID of the deployment strategy that was deployed.
    - configurationProfileId
```
String configurationProfileId
```
      The ID of the configuration profile that was deployed.
    - deploymentNumber
```
Integer deploymentNumber
```
      The sequence number of the deployment.
    - configurationName
```
String configurationName
```
      The name of the configuration.
    - configurationLocationUri
```
String configurationLocationUri
```
      Information about the source location of the configuration.
    - configurationVersion
```
String configurationVersion
```
      The configuration version that was deployed.
    - description
```
String description
```
      The description of the deployment.
    - deploymentDurationInMinutes
```
Integer deploymentDurationInMinutes
```
      Total amount of time the deployment lasted.
    - growthType
```
String growthType
```
      The algorithm used to define how percentage grew over time.
    - growthFactor
```
Float growthFactor
```
      The percentage of targets to receive a deployed configuration during each interval.
    - finalBakeTimeInMinutes
```
Integer finalBakeTimeInMinutes
```
      The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
    - state
```
String state
```
      The state of the deployment.
    - percentageComplete
```
Float percentageComplete
```
      The percentage of targets for which the deployment is available.
    - startedAt
```
Date startedAt
```
      The time the deployment started.
    - completedAt
```
Date completedAt
```
      The time the deployment completed.
- Class com.amazonaws.services.appconfig.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the resource for which to retrieve tags.
    - tags
```
Map<K,V> tags
```
      The key-value string map. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
- Class com.amazonaws.services.appconfig.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appconfig.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The ARN of the resource for which to remove tags.
    - tagKeys
```
List<E> tagKeys
```
      The tag keys to delete.
- Class com.amazonaws.services.appconfig.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appconfig.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - name
```
String name
```
      The name of the application.
    - description
```
String description
```
      A description of the application.
- Class com.amazonaws.services.appconfig.model.UpdateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The application ID.
    - name
```
String name
```
      The application name.
    - description
```
String description
```
      The description of the application.
- Class com.amazonaws.services.appconfig.model.UpdateConfigurationProfileRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - configurationProfileId
```
String configurationProfileId
```
      The ID of the configuration profile.
    - name
```
String name
```
      The name of the configuration profile.
    - description
```
String description
```
      A description of the configuration profile.
    - retrievalRoleArn
```
String retrievalRoleArn
```
      The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
    - validators
```
List<E> validators
```
      A list of methods for validating the configuration.
- Class com.amazonaws.services.appconfig.model.UpdateConfigurationProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - id
```
String id
```
      The configuration profile ID.
    - name
```
String name
```
      The name of the configuration profile.
    - description
```
String description
```
      The configuration profile description.
    - locationUri
```
String locationUri
```
      The URI location of the configuration.
    - retrievalRoleArn
```
String retrievalRoleArn
```
      The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
    - validators
```
List<E> validators
```
      A list of methods for validating the configuration.
- Class com.amazonaws.services.appconfig.model.UpdateDeploymentStrategyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deploymentStrategyId
```
String deploymentStrategyId
```
      The deployment strategy ID.
    - description
```
String description
```
      A description of the deployment strategy.
    - deploymentDurationInMinutes
```
Integer deploymentDurationInMinutes
```
      Total amount of time for a deployment to last.
    - finalBakeTimeInMinutes
```
Integer finalBakeTimeInMinutes
```
      The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
    - growthFactor
```
Float growthFactor
```
      The percentage of targets to receive a deployed configuration during each interval.
    - growthType
```
String growthType
```
      The algorithm used to define how percentage grows over time.
- Class com.amazonaws.services.appconfig.model.UpdateDeploymentStrategyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The deployment strategy ID.
    - name
```
String name
```
      The name of the deployment strategy.
    - description
```
String description
```
      The description of the deployment strategy.
    - deploymentDurationInMinutes
```
Integer deploymentDurationInMinutes
```
      Total amount of time the deployment lasted.
    - growthType
```
String growthType
```
      The algorithm used to define how percentage grew over time.
    - growthFactor
```
Float growthFactor
```
      The percentage of targets that received a deployed configuration during each interval.
    - finalBakeTimeInMinutes
```
Integer finalBakeTimeInMinutes
```
      The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
    - replicateTo
```
String replicateTo
```
      Save the deployment strategy to a Systems Manager (SSM) document.
- Class com.amazonaws.services.appconfig.model.UpdateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - environmentId
```
String environmentId
```
      The environment ID.
    - name
```
String name
```
      The name of the environment.
    - description
```
String description
```
      A description of the environment.
    - monitors
```
List<E> monitors
```
      Amazon CloudWatch alarms to monitor during the deployment process.
- Class com.amazonaws.services.appconfig.model.UpdateEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - id
```
String id
```
      The environment ID.
    - name
```
String name
```
      The name of the environment.
    - description
```
String description
```
      The description of the environment.
    - state
```
String state
```
      The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK
    - monitors
```
List<E> monitors
```
      Amazon CloudWatch alarms monitored during the deployment.
- Class com.amazonaws.services.appconfig.model.ValidateConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - configurationProfileId
```
String configurationProfileId
```
      The configuration profile ID.
    - configurationVersion
```
String configurationVersion
```
      The version of the configuration to validate.
- Class com.amazonaws.services.appconfig.model.ValidateConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appconfig.model.Validator extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      AppConfig supports validators of type JSON_SCHEMA and LAMBDA
    - content
```
String content
```
      Either the JSON Schema content or an AWS Lambda function name.
Package com.amazonaws.services.applicationautoscaling.model
- Class com.amazonaws.services.applicationautoscaling.model.Alarm extends Object implements Serializable
  - Serialized Fields
    - alarmName
```
String alarmName
```
      The name of the alarm.
    - alarmARN
```
String alarmARN
```
      The Amazon Resource Name (ARN) of the alarm.
- Class com.amazonaws.services.applicationautoscaling.model.AWSApplicationAutoScalingException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationautoscaling.model.ConcurrentUpdateException extends AWSApplicationAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationautoscaling.model.CustomizedMetricSpecification extends Object implements Serializable
  - Serialized Fields
    - metricName
```
String metricName
```
      The name of the metric.
    - namespace
```
String namespace
```
      The namespace of the metric.
    - dimensions
```
List<E> dimensions
```
      The dimensions of the metric.
      
      Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    - statistic
```
String statistic
```
      The statistic of the metric.
    - unit
```
String unit
```
      The unit of the metric.
- Class com.amazonaws.services.applicationautoscaling.model.DeleteScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - policyName
```
String policyName
```
      The name of the scaling policy.
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - resourceId
```
String resourceId
```
      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
- Class com.amazonaws.services.applicationautoscaling.model.DeleteScalingPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationautoscaling.model.DeleteScheduledActionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - scheduledActionName
```
String scheduledActionName
```
      The name of the scheduled action.
    - resourceId
```
String resourceId
```
      The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
- Class com.amazonaws.services.applicationautoscaling.model.DeleteScheduledActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationautoscaling.model.DeregisterScalableTargetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - resourceId
```
String resourceId
```
      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
- Class com.amazonaws.services.applicationautoscaling.model.DeregisterScalableTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationautoscaling.model.DescribeScalableTargetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - resourceIds
```
List<E> resourceIds
```
      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    - maxResults
```
Integer maxResults
```
      The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.
      
      If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
- Class com.amazonaws.services.applicationautoscaling.model.DescribeScalableTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - scalableTargets
```
List<E> scalableTargets
```
      The scalable targets that match the request parameters.
    - nextToken
```
String nextToken
```
      The token required to get the next set of results. This value is null if there are no more results to return.
- Class com.amazonaws.services.applicationautoscaling.model.DescribeScalingActivitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - resourceId
```
String resourceId
```
      The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    - maxResults
```
Integer maxResults
```
      The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.
      
      If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
- Class com.amazonaws.services.applicationautoscaling.model.DescribeScalingActivitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - scalingActivities
```
List<E> scalingActivities
```
      A list of scaling activity objects.
    - nextToken
```
String nextToken
```
      The token required to get the next set of results. This value is null if there are no more results to return.
- Class com.amazonaws.services.applicationautoscaling.model.DescribeScalingPoliciesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - policyNames
```
List<E> policyNames
```
      The names of the scaling policies to describe.
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - resourceId
```
String resourceId
```
      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    - maxResults
```
Integer maxResults
```
      The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.
      
      If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
- Class com.amazonaws.services.applicationautoscaling.model.DescribeScalingPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - scalingPolicies
```
List<E> scalingPolicies
```
      Information about the scaling policies.
    - nextToken
```
String nextToken
```
      The token required to get the next set of results. This value is null if there are no more results to return.
- Class com.amazonaws.services.applicationautoscaling.model.DescribeScheduledActionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - scheduledActionNames
```
List<E> scheduledActionNames
```
      The names of the scheduled actions to describe.
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - resourceId
```
String resourceId
```
      The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    - maxResults
```
Integer maxResults
```
      The maximum number of scheduled action results. This value can be between 1 and 50. The default value is 50.
      
      If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
- Class com.amazonaws.services.applicationautoscaling.model.DescribeScheduledActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - scheduledActions
```
List<E> scheduledActions
```
      Information about the scheduled actions.
    - nextToken
```
String nextToken
```
      The token required to get the next set of results. This value is null if there are no more results to return.
- Class com.amazonaws.services.applicationautoscaling.model.FailedResourceAccessException extends AWSApplicationAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationautoscaling.model.InternalServiceException extends AWSApplicationAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationautoscaling.model.InvalidNextTokenException extends AWSApplicationAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationautoscaling.model.LimitExceededException extends AWSApplicationAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationautoscaling.model.MetricDimension extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the dimension.
    - value
```
String value
```
      The value of the dimension.
- Class com.amazonaws.services.applicationautoscaling.model.ObjectNotFoundException extends AWSApplicationAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationautoscaling.model.PredefinedMetricSpecification extends Object implements Serializable
  - Serialized Fields
    - predefinedMetricType
```
String predefinedMetricType
```
      The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleet requests and ECS services.
    - resourceLabel
```
String resourceLabel
```
      Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet request or ECS service.
      
      The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target -group-id>, where:
      
      app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
      
      targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
- Class com.amazonaws.services.applicationautoscaling.model.PutScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - policyName
```
String policyName
```
      The name of the scaling policy.
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - resourceId
```
String resourceId
```
      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    - policyType
```
String policyType
```
      The policy type. This parameter is required if you are creating a scaling policy.
      
      The following policy types are supported:
      
      TargetTrackingScaling—Not supported for Amazon EMR
      
      StepScaling—Not supported for DynamoDB, Amazon Comprehend, or AWS Lambda
      
      For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.
    - stepScalingPolicyConfiguration
```
StepScalingPolicyConfiguration stepScalingPolicyConfiguration
```
      A step scaling policy.
      
      This parameter is required if you are creating a policy and the policy type is StepScaling.
    - targetTrackingScalingPolicyConfiguration
```
TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration
```
      A target tracking scaling policy. Includes support for predefined or customized metrics.
      
      This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling .
- Class com.amazonaws.services.applicationautoscaling.model.PutScalingPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - policyARN
```
String policyARN
```
      The Amazon Resource Name (ARN) of the resulting scaling policy.
    - alarms
```
List<E> alarms
```
      The CloudWatch alarms created for the target tracking scaling policy.
- Class com.amazonaws.services.applicationautoscaling.model.PutScheduledActionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - schedule
```
String schedule
```
      The schedule for this action. The following formats are supported:
      
      At expressions - "at(yyyy-mm-ddThh:mm:ss)"
      
      Rate expressions - "rate(value unit)"
      
      Cron expressions - "cron(fields)"
      
      At expressions are useful for one-time schedules. Specify the time, in UTC.
      
      For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.
      
      For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.
    - scheduledActionName
```
String scheduledActionName
```
      The name of the scheduled action.
    - resourceId
```
String resourceId
```
      The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    - startTime
```
Date startTime
```
      The date and time for the scheduled action to start.
    - endTime
```
Date endTime
```
      The date and time for the scheduled action to end.
    - scalableTargetAction
```
ScalableTargetAction scalableTargetAction
```
      The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
- Class com.amazonaws.services.applicationautoscaling.model.PutScheduledActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationautoscaling.model.RegisterScalableTargetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - resourceId
```
String resourceId
```
      The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    - minCapacity
```
Integer minCapacity
```
      The minimum value to scale to in response to a scale-in event. MinCapacity is required to register a scalable target.
    - maxCapacity
```
Integer maxCapacity
```
      The maximum value to scale to in response to a scale-out event. MaxCapacity is required to register a scalable target.
    - roleARN
```
String roleARN
```
      Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see Service-Linked Roles for Application Auto Scaling.
      
      For Amazon EMR, this parameter is required, and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
    - suspendedState
```
SuspendedState suspendedState
```
      An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
      
      Suspension Outcomes
      
      For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
      
      For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
      
      For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.
      
      For more information, see Suspending and Resuming Scaling in the Application Auto Scaling User Guide.
- Class com.amazonaws.services.applicationautoscaling.model.RegisterScalableTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationautoscaling.model.ScalableTarget extends Object implements Serializable
  - Serialized Fields
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - resourceId
```
String resourceId
```
      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    - minCapacity
```
Integer minCapacity
```
      The minimum value to scale to in response to a scale-in event.
    - maxCapacity
```
Integer maxCapacity
```
      The maximum value to scale to in response to a scale-out event.
    - roleARN
```
String roleARN
```
      The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
    - creationTime
```
Date creationTime
```
      The Unix timestamp for when the scalable target was created.
    - suspendedState
```
SuspendedState suspendedState
```
- Class com.amazonaws.services.applicationautoscaling.model.ScalableTargetAction extends Object implements Serializable
  - Serialized Fields
    - minCapacity
```
Integer minCapacity
```
      The minimum capacity.
    - maxCapacity
```
Integer maxCapacity
```
      The maximum capacity.
- Class com.amazonaws.services.applicationautoscaling.model.ScalingActivity extends Object implements Serializable
  - Serialized Fields
    - activityId
```
String activityId
```
      The unique identifier of the scaling activity.
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - resourceId
```
String resourceId
```
      The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    - description
```
String description
```
      A simple description of what action the scaling activity intends to accomplish.
    - cause
```
String cause
```
      A simple description of what caused the scaling activity to happen.
    - startTime
```
Date startTime
```
      The Unix timestamp for when the scaling activity began.
    - endTime
```
Date endTime
```
      The Unix timestamp for when the scaling activity ended.
    - statusCode
```
String statusCode
```
      Indicates the status of the scaling activity.
    - statusMessage
```
String statusMessage
```
      A simple message about the current status of the scaling activity.
    - details
```
String details
```
      The details about the scaling activity.
- Class com.amazonaws.services.applicationautoscaling.model.ScalingPolicy extends Object implements Serializable
  - Serialized Fields
    - policyARN
```
String policyARN
```
      The Amazon Resource Name (ARN) of the scaling policy.
    - policyName
```
String policyName
```
      The name of the scaling policy.
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - resourceId
```
String resourceId
```
      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    - policyType
```
String policyType
```
      The scaling policy type.
    - stepScalingPolicyConfiguration
```
StepScalingPolicyConfiguration stepScalingPolicyConfiguration
```
      A step scaling policy.
    - targetTrackingScalingPolicyConfiguration
```
TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration
```
      A target tracking scaling policy.
    - alarms
```
List<E> alarms
```
      The CloudWatch alarms associated with the scaling policy.
    - creationTime
```
Date creationTime
```
      The Unix timestamp for when the scaling policy was created.
- Class com.amazonaws.services.applicationautoscaling.model.ScheduledAction extends Object implements Serializable
  - Serialized Fields
    - scheduledActionName
```
String scheduledActionName
```
      The name of the scheduled action.
    - scheduledActionARN
```
String scheduledActionARN
```
      The Amazon Resource Name (ARN) of the scheduled action.
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.
    - schedule
```
String schedule
```
      The schedule for this action. The following formats are supported:
      
      At expressions - "at(yyyy-mm-ddThh:mm:ss)"
      
      Rate expressions - "rate(value unit)"
      
      Cron expressions - "cron(fields)"
      
      At expressions are useful for one-time schedules. Specify the time, in UTC.
      
      For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.
      
      For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.
    - resourceId
```
String resourceId
```
      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
      
      AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
      
      DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
      
      Amazon SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
      
      Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
      
      Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
      
      Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
      
      appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
      
      sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.
      
      custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
      
      comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
      
      lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    - startTime
```
Date startTime
```
      The date and time that the action is scheduled to begin.
    - endTime
```
Date endTime
```
      The date and time that the action is scheduled to end.
    - scalableTargetAction
```
ScalableTargetAction scalableTargetAction
```
      The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
    - creationTime
```
Date creationTime
```
      The date and time that the scheduled action was created.
- Class com.amazonaws.services.applicationautoscaling.model.StepAdjustment extends Object implements Serializable
  - Serialized Fields
    - metricIntervalLowerBound
```
Double metricIntervalLowerBound
```
      The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
    - metricIntervalUpperBound
```
Double metricIntervalUpperBound
```
      The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
      
      The upper bound must be greater than the lower bound.
    - scalingAdjustment
```
Integer scalingAdjustment
```
      The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.
- Class com.amazonaws.services.applicationautoscaling.model.StepScalingPolicyConfiguration extends Object implements Serializable
  - Serialized Fields
    - adjustmentType
```
String adjustmentType
```
      Specifies whether the ScalingAdjustment value in a StepAdjustment is an absolute number or a percentage of the current capacity.
    - stepAdjustments
```
List<E> stepAdjustments
```
      A set of adjustments that enable you to scale based on the size of the alarm breach.
    - 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.
      
      For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
    - 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 the cooldown period 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. If the aggregation type is null, the value is treated as Average.
- Class com.amazonaws.services.applicationautoscaling.model.SuspendedState extends Object implements Serializable
  - Serialized Fields
    - dynamicScalingInSuspended
```
Boolean dynamicScalingInSuspended
```
      Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false.
    - dynamicScalingOutSuspended
```
Boolean dynamicScalingOutSuspended
```
      Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false.
    - scheduledScalingSuspended
```
Boolean scheduledScalingSuspended
```
      Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false.
- Class com.amazonaws.services.applicationautoscaling.model.TargetTrackingScalingPolicyConfiguration extends Object implements Serializable
  - Serialized Fields
    - targetValue
```
Double targetValue
```
      The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
    - predefinedMetricSpecification
```
PredefinedMetricSpecification predefinedMetricSpecification
```
      A predefined metric. You can specify either a predefined metric or a customized metric.
    - customizedMetricSpecification
```
CustomizedMetricSpecification customizedMetricSpecification
```
      A customized metric. You can specify either a predefined metric or a customized metric.
    - scaleOutCooldown
```
Integer scaleOutCooldown
```
      The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.
      
      While the cooldown period 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.
    - scaleInCooldown
```
Integer scaleInCooldown
```
      The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start.
      
      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.
    - disableScaleIn
```
Boolean disableScaleIn
```
      Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false.
- Class com.amazonaws.services.applicationautoscaling.model.ValidationException extends AWSApplicationAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
Package com.amazonaws.services.applicationdiscovery.model
- Class com.amazonaws.services.applicationdiscovery.model.AgentConfigurationStatus extends Object implements Serializable
  - Serialized Fields
    - agentId
```
String agentId
```
      The agent/connector ID.
    - operationSucceeded
```
Boolean operationSucceeded
```
      Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent/connector receives this command the next time it polls for a new command.
    - description
```
String description
```
      A description of the operation performed.
- Class com.amazonaws.services.applicationdiscovery.model.AgentInfo extends Object implements Serializable
  - Serialized Fields
    - agentId
```
String agentId
```
      The agent or connector ID.
    - hostName
```
String hostName
```
      The name of the host where the agent or connector resides. The host can be a server or virtual machine.
    - agentNetworkInfoList
```
List<E> agentNetworkInfoList
```
      Network details about the host where the agent or connector resides.
    - connectorId
```
String connectorId
```
      The ID of the connector.
    - version
```
String version
```
      The agent or connector version.
    - health
```
String health
```
      The health of the agent or connector.
    - lastHealthPingTime
```
String lastHealthPingTime
```
      Time since agent or connector health was reported.
    - collectionStatus
```
String collectionStatus
```
      Status of the collection process for an agent or connector.
    - agentType
```
String agentType
```
      Type of agent.
    - registeredTime
```
String registeredTime
```
      Agent's first registration timestamp in UTC.
- Class com.amazonaws.services.applicationdiscovery.model.AgentNetworkInfo extends Object implements Serializable
  - Serialized Fields
    - ipAddress
```
String ipAddress
```
      The IP address for the host where the agent/connector resides.
    - macAddress
```
String macAddress
```
      The MAC address for the host where the agent/connector resides.
- Class com.amazonaws.services.applicationdiscovery.model.AssociateConfigurationItemsToApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationConfigurationId
```
String applicationConfigurationId
```
      The configuration ID of an application with which items are to be associated.
    - configurationIds
```
List<E> configurationIds
```
      The ID of each configuration item to be associated with an application.
- Class com.amazonaws.services.applicationdiscovery.model.AssociateConfigurationItemsToApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationdiscovery.model.AuthorizationErrorException extends AWSApplicationDiscoveryException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationdiscovery.model.AWSApplicationDiscoveryException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationdiscovery.model.BatchDeleteImportDataError extends Object implements Serializable
  - Serialized Fields
    - importTaskId
```
String importTaskId
```
      The unique import ID associated with the error that occurred.
    - errorCode
```
String errorCode
```
      The type of error that occurred for a specific import task.
    - errorDescription
```
String errorDescription
```
      The description of the error that occurred for a specific import task.
- Class com.amazonaws.services.applicationdiscovery.model.BatchDeleteImportDataRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - importTaskIds
```
List<E> importTaskIds
```
      The IDs for the import tasks that you want to delete.
- Class com.amazonaws.services.applicationdiscovery.model.BatchDeleteImportDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - errors
```
List<E> errors
```
      Error messages returned for each import task that you deleted as a response for this command.
- Class com.amazonaws.services.applicationdiscovery.model.ConfigurationTag extends Object implements Serializable
  - Serialized Fields
    - configurationType
```
String configurationType
```
      A type of IT asset to tag.
    - configurationId
```
String configurationId
```
      The configuration ID for the item to tag. You can specify a list of keys and values.
    - key
```
String key
```
      A type of tag on which to filter. For example, serverType.
    - value
```
String value
```
      A value on which to filter. For example key = serverType and value = web server.
    - timeOfCreation
```
Date timeOfCreation
```
      The time the configuration tag was created in Coordinated Universal Time (UTC).
- Class com.amazonaws.services.applicationdiscovery.model.ConflictErrorException extends AWSApplicationDiscoveryException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationdiscovery.model.ContinuousExportDescription extends Object implements Serializable
  - Serialized Fields
    - exportId
```
String exportId
```
      The unique ID assigned to this export.
    - status
```
String status
```
      Describes the status of the export. Can be one of the following values:
      
      START_IN_PROGRESS - setting up resources to start continuous export.
      
      START_FAILED - an error occurred setting up continuous export. To recover, call start-continuous-export again.
      
      ACTIVE - data is being exported to the customer bucket.
      
      ERROR - an error occurred during export. To fix the issue, call stop-continuous-export and start-continuous-export.
      
      STOP_IN_PROGRESS - stopping the export.
      
      STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again.
      
      INACTIVE - the continuous export has been stopped. Data is no longer being exported to the customer bucket.
    - statusDetail
```
String statusDetail
```
      Contains information about any errors that have occurred. This data type can have the following values:
      
      ACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon Athena. Contact your AWS administrator for help. For more information, see Setting Up AWS Application Discovery Service in the Application Discovery Service User Guide.
      
      DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data Firehose delivery streams. Reduce the number of streams or request a limit increase and try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide.
      
      FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because your IAM User is missing the AWSApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again. For more information, see Step 3: Provide Application Discovery Service Access to Non-Administrator Users by Attaching Policies in the Application Discovery Service User Guide.
      
      FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your IAM User is missing one or more of the Kinesis data delivery streams.
      
      INTERNAL_FAILURE - The Data Exploration feature is in an error state because of an internal failure. Try again later. If this problem persists, contact AWS Support.
      
      S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the number of Amazon S3 buckets or request a limit increase and try again. For more information, see Bucket Restrictions and Limitations in the Amazon Simple Storage Service Developer Guide.
      
      S3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.
    - s3Bucket
```
String s3Bucket
```
      The name of the s3 bucket where the export data parquet files are stored.
    - startTime
```
Date startTime
```
      The timestamp representing when the continuous export was started.
    - stopTime
```
Date stopTime
```
      The timestamp that represents when this continuous export was stopped.
    - dataSource
```
String dataSource
```
      The type of data collector used to gather this data (currently only offered for AGENT).
    - schemaStorageConfig
```
Map<K,V> schemaStorageConfig
```
      An object which describes how the data is stored.
      
      databaseName - the name of the Glue database used to store the schema.
- Class com.amazonaws.services.applicationdiscovery.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Name of the application to be created.
    - description
```
String description
```
      Description of the application to be created.
- Class com.amazonaws.services.applicationdiscovery.model.CreateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - configurationId
```
String configurationId
```
      Configuration ID of an application to be created.
- Class com.amazonaws.services.applicationdiscovery.model.CreateTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configurationIds
```
List<E> configurationIds
```
      A list of configuration items that you want to tag.
    - tags
```
List<E> 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationdiscovery.model.CustomerAgentInfo extends Object implements Serializable
  - Serialized Fields
    - activeAgents
```
Integer activeAgents
```
      Number of active discovery agents.
    - healthyAgents
```
Integer healthyAgents
```
      Number of healthy discovery agents
    - blackListedAgents
```
Integer blackListedAgents
```
      Number of blacklisted discovery agents.
    - shutdownAgents
```
Integer shutdownAgents
```
      Number of discovery agents with status SHUTDOWN.
    - unhealthyAgents
```
Integer unhealthyAgents
```
      Number of unhealthy discovery agents.
    - totalAgents
```
Integer totalAgents
```
      Total number of discovery agents.
    - unknownAgents
```
Integer unknownAgents
```
      Number of unknown discovery agents.
- Class com.amazonaws.services.applicationdiscovery.model.CustomerConnectorInfo extends Object implements Serializable
  - Serialized Fields
    - activeConnectors
```
Integer activeConnectors
```
      Number of active discovery connectors.
    - healthyConnectors
```
Integer healthyConnectors
```
      Number of healthy discovery connectors.
    - blackListedConnectors
```
Integer blackListedConnectors
```
      Number of blacklisted discovery connectors.
    - shutdownConnectors
```
Integer shutdownConnectors
```
      Number of discovery connectors with status SHUTDOWN,
    - unhealthyConnectors
```
Integer unhealthyConnectors
```
      Number of unhealthy discovery connectors.
    - totalConnectors
```
Integer totalConnectors
```
      Total number of discovery connectors.
    - unknownConnectors
```
Integer unknownConnectors
```
      Number of unknown discovery connectors.
- Class com.amazonaws.services.applicationdiscovery.model.DeleteApplicationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configurationIds
```
List<E> configurationIds
```
      Configuration ID of an application to be deleted.
- Class com.amazonaws.services.applicationdiscovery.model.DeleteApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationdiscovery.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configurationIds
```
List<E> configurationIds
```
      A list of configuration items with tags that you want to delete.
    - tags
```
List<E> 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationdiscovery.model.DescribeAgentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - agentIds
```
List<E> agentIds
```
      The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your AWS user account.
    - filters
```
List<E> filters
```
      You can filter the request using various logical operators and a key-value format. For example:
      
      {"key": "collectionStatus", "value": "STARTED"}
    - maxResults
```
Integer maxResults
```
      The total number of agents/Connectors to return in a single page of output. The maximum value is 100.
    - nextToken
```
String nextToken
```
      Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.
- Class com.amazonaws.services.applicationdiscovery.model.DescribeAgentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - agentsInfo
```
List<E> agentsInfo
```
      Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an agent/Connector ID. The output includes agent/Connector IDs, IP addresses, media access control (MAC) addresses, agent/Connector health, host name where the agent/Connector resides, and the version number of each agent/Connector.
    - nextToken
```
String nextToken
```
      Token to retrieve the next set of results. For example, if you specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.
- Class com.amazonaws.services.applicationdiscovery.model.DescribeConfigurationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configurationIds
```
List<E> configurationIds
```
      One or more configuration IDs.
- Class com.amazonaws.services.applicationdiscovery.model.DescribeConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - configurations
```
List<E> configurations
```
      A key in the response map. The value is an array of data.
- Class com.amazonaws.services.applicationdiscovery.model.DescribeContinuousExportsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - exportIds
```
List<E> exportIds
```
      The unique IDs assigned to the exports.
    - maxResults
```
Integer maxResults
```
      A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.
    - nextToken
```
String nextToken
```
      The token from the previous call to DescribeExportTasks.
- Class com.amazonaws.services.applicationdiscovery.model.DescribeContinuousExportsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - descriptions
```
List<E> descriptions
```
      A list of continuous export descriptions.
    - nextToken
```
String nextToken
```
      The token from the previous call to DescribeExportTasks.
- Class com.amazonaws.services.applicationdiscovery.model.DescribeExportConfigurationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - exportIds
```
List<E> exportIds
```
      A list of continuous export IDs to search for.
    - maxResults
```
Integer maxResults
```
      A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.
    - nextToken
```
String nextToken
```
      The token from the previous call to describe-export-tasks.
- Class com.amazonaws.services.applicationdiscovery.model.DescribeExportConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - exportsInfo
```
List<E> exportsInfo
```
    - nextToken
```
String nextToken
```
      The token from the previous call to describe-export-tasks.
- Class com.amazonaws.services.applicationdiscovery.model.DescribeExportTasksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - exportIds
```
List<E> exportIds
```
      One or more unique identifiers used to query the status of an export request.
    - filters
```
List<E> filters
```
      One or more filters.
      
      AgentId - ID of the agent whose collected data will be exported
    - maxResults
```
Integer maxResults
```
      The maximum number of volume results returned by DescribeExportTasks in paginated output. When this parameter is used, DescribeExportTasks only returns maxResults results in a single page along with a nextToken response element.
    - nextToken
```
String nextToken
```
      The nextToken value returned from a previous paginated DescribeExportTasks 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.
- Class com.amazonaws.services.applicationdiscovery.model.DescribeExportTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - exportsInfo
```
List<E> exportsInfo
```
      Contains one or more sets of export request details. When the status of a request is SUCCEEDED, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.
    - nextToken
```
String nextToken
```
      The nextToken value to include in a future DescribeExportTasks request. When the results of a DescribeExportTasks 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.applicationdiscovery.model.DescribeImportTasksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
List<E> filters
```
      An array of name-value pairs that you provide to filter the results for the DescribeImportTask request to a specific subset of results. Currently, wildcard values aren't supported for filters.
    - maxResults
```
Integer maxResults
```
      The maximum number of results that you want this request to return, up to 100.
    - nextToken
```
String nextToken
```
      The token to request a specific page of results.
- Class com.amazonaws.services.applicationdiscovery.model.DescribeImportTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The token to request the next page of results.
    - tasks
```
List<E> tasks
```
      A returned array of import tasks that match any applied filters, up to the specified number of maximum results.
- Class com.amazonaws.services.applicationdiscovery.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
List<E> 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 in a single page of output. 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
List<E> 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.
    - nextToken
```
String nextToken
```
      The call returns a token. Use this token to get the next set of results.
- Class com.amazonaws.services.applicationdiscovery.model.DisassociateConfigurationItemsFromApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationConfigurationId
```
String applicationConfigurationId
```
      Configuration ID of an application from which each item is disassociated.
    - configurationIds
```
List<E> configurationIds
```
      Configuration ID of each item to be disassociated from an application.
- Class com.amazonaws.services.applicationdiscovery.model.DisassociateConfigurationItemsFromApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationdiscovery.model.ExportConfigurationsRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.applicationdiscovery.model.ExportConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> 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.ExportFilter extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      A single ExportFilter name. Supported filters: agentId.
    - values
```
List<E> values
```
      A single agentId for a Discovery Agent. An agentId can be found using the DescribeAgents action. Typically an ADS agentId is in the form o-0123456789abcdef0 .
    - condition
```
String condition
```
      Supported condition: EQUALS
- Class com.amazonaws.services.applicationdiscovery.model.ExportInfo extends Object implements Serializable
  - Serialized Fields
    - exportId
```
String exportId
```
      A unique identifier used to query an export.
    - exportStatus
```
String exportStatus
```
      The status of the data export job.
    - statusMessage
```
String statusMessage
```
      A status message provided for API callers.
    - configurationsDownloadUrl
```
String configurationsDownloadUrl
```
      A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.
    - exportRequestTime
```
Date exportRequestTime
```
      The time that the data export was initiated.
    - isTruncated
```
Boolean isTruncated
```
      If true, the export of agent information exceeded the size limit for a single export and the exported data is incomplete for the requested time range. To address this, select a smaller time range for the export by using startDate and endDate.
    - requestedStartTime
```
Date requestedStartTime
```
      The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo.
    - requestedEndTime
```
Date requestedEndTime
```
      The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo.
- Class com.amazonaws.services.applicationdiscovery.model.Filter extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the filter.
    - values
```
List<E> values
```
      A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.
    - 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.
- Class com.amazonaws.services.applicationdiscovery.model.GetDiscoverySummaryRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.applicationdiscovery.model.GetDiscoverySummaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - servers
```
Long servers
```
      The number of servers discovered.
    - applications
```
Long applications
```
      The number of applications discovered.
    - serversMappedToApplications
```
Long serversMappedToApplications
```
      The number of servers mapped to applications.
    - serversMappedtoTags
```
Long serversMappedtoTags
```
      The number of servers mapped to tags.
    - agentSummary
```
CustomerAgentInfo agentSummary
```
      Details about discovered agents, including agent status and health.
    - connectorSummary
```
CustomerConnectorInfo connectorSummary
```
      Details about discovered connectors, including connector status and health.
- Class com.amazonaws.services.applicationdiscovery.model.HomeRegionNotSetException extends AWSApplicationDiscoveryException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationdiscovery.model.ImportTask extends Object implements Serializable
  - Serialized Fields
    - importTaskId
```
String importTaskId
```
      The unique ID for a specific import task. These IDs aren't globally unique, but they are unique within an AWS account.
    - clientRequestToken
```
String clientRequestToken
```
      A unique token used to prevent the same import request from occurring more than once. If you didn't provide a token, a token was automatically generated when the import task request was sent.
    - name
```
String name
```
      A descriptive name for an import task. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.
    - importUrl
```
String importUrl
```
      The URL for your import file that you've uploaded to Amazon S3.
    - status
```
String status
```
      The status of the import task. An import can have the status of IMPORT_COMPLETE and still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in the errorsAndFailedEntriesZip field, or in the Migration Hub management console.
    - importRequestTime
```
Date importRequestTime
```
      The time that the import task request was made, presented in the Unix time stamp format.
    - importCompletionTime
```
Date importCompletionTime
```
      The time that the import task request finished, presented in the Unix time stamp format.
    - importDeletedTime
```
Date importDeletedTime
```
      The time that the import task request was deleted, presented in the Unix time stamp format.
    - serverImportSuccess
```
Integer serverImportSuccess
```
      The total number of server records in the import file that were successfully imported.
    - serverImportFailure
```
Integer serverImportFailure
```
      The total number of server records in the import file that failed to be imported.
    - applicationImportSuccess
```
Integer applicationImportSuccess
```
      The total number of application records in the import file that were successfully imported.
    - applicationImportFailure
```
Integer applicationImportFailure
```
      The total number of application records in the import file that failed to be imported.
    - errorsAndFailedEntriesZip
```
String errorsAndFailedEntriesZip
```
      A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of failed records. You can use these two files to quickly identify records that failed, why they failed, and correct those records. Afterward, you can upload the corrected file to your Amazon S3 bucket and create another import task request.
      
      This field also includes authorization information so you can confirm the authenticity of the compressed archive before you download it.
      
      If some records failed to be imported we recommend that you correct the records in the failed entries file and then imports that failed entries file. This prevents you from having to correct and update the larger original file and attempt importing it again.
- Class com.amazonaws.services.applicationdiscovery.model.ImportTaskFilter extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name, status, or import task ID for a specific import task.
    - values
```
List<E> values
```
      An array of strings that you can provide to match against a specific name, status, or import task ID to filter the results for your import task queries.
- Class com.amazonaws.services.applicationdiscovery.model.InvalidParameterException extends AWSApplicationDiscoveryException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationdiscovery.model.InvalidParameterValueException extends AWSApplicationDiscoveryException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationdiscovery.model.ListConfigurationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configurationType
```
String configurationType
```
      A valid configuration identified by Application Discovery Service.
    - filters
```
List<E> filters
```
      You can filter the request using various logical operators and a key-value format. For example:
      
      {"key": "serverType", "value": "webServer"}
      
      For a complete list of filter options and guidance about using them with this action, see Using the ListConfigurations Action in the AWS Application Discovery Service User Guide.
    - maxResults
```
Integer maxResults
```
      The total number of items to return. The maximum value is 100.
    - nextToken
```
String nextToken
```
      Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.
    - orderBy
```
List<E> orderBy
```
      Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action in the AWS Application Discovery Service User Guide.
- Class com.amazonaws.services.applicationdiscovery.model.ListConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - configurations
```
List<E> configurations
```
      Returns configuration details, including the configuration ID, attribute names, and attribute values.
    - nextToken
```
String nextToken
```
      Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.
- Class com.amazonaws.services.applicationdiscovery.model.ListServerNeighborsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configurationId
```
String configurationId
```
      Configuration ID of the server for which neighbors are being listed.
    - portInformationNeeded
```
Boolean portInformationNeeded
```
      Flag to indicate if port and protocol information is needed as part of the response.
    - neighborConfigurationIds
```
List<E> neighborConfigurationIds
```
      List of configuration IDs to test for one-hop-away.
    - maxResults
```
Integer maxResults
```
      Maximum number of results to return in a single page of output.
    - nextToken
```
String nextToken
```
      Token to retrieve the next set of results. For example, if you previously specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.
- Class com.amazonaws.services.applicationdiscovery.model.ListServerNeighborsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - neighbors
```
List<E> neighbors
```
      List of distinct servers that are one hop away from the given server.
    - nextToken
```
String nextToken
```
      Token to retrieve the next set of results. For example, if you specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.
    - knownDependencyCount
```
Long knownDependencyCount
```
      Count of distinct servers that are one hop away from the given server.
- Class com.amazonaws.services.applicationdiscovery.model.NeighborConnectionDetail extends Object implements Serializable
  - Serialized Fields
    - sourceServerId
```
String sourceServerId
```
      The ID of the server that opened the network connection.
    - destinationServerId
```
String destinationServerId
```
      The ID of the server that accepted the network connection.
    - destinationPort
```
Integer destinationPort
```
      The destination network port for the connection.
    - transportProtocol
```
String transportProtocol
```
      The network protocol used for the connection.
    - connectionsCount
```
Long connectionsCount
```
      The number of open network connections with the neighboring server.
- Class com.amazonaws.services.applicationdiscovery.model.OperationNotPermittedException extends AWSApplicationDiscoveryException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationdiscovery.model.OrderByElement extends Object implements Serializable
  - Serialized Fields
    - fieldName
```
String fieldName
```
      The field on which to order.
    - sortOrder
```
String sortOrder
```
      Ordering direction.
- Class com.amazonaws.services.applicationdiscovery.model.ResourceInUseException extends AWSApplicationDiscoveryException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationdiscovery.model.ResourceNotFoundException extends AWSApplicationDiscoveryException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationdiscovery.model.ServerInternalErrorException extends AWSApplicationDiscoveryException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationdiscovery.model.StartContinuousExportRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.applicationdiscovery.model.StartContinuousExportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - exportId
```
String exportId
```
      The unique ID assigned to this export.
    - s3Bucket
```
String s3Bucket
```
      The name of the s3 bucket where the export data parquet files are stored.
    - startTime
```
Date startTime
```
      The timestamp representing when the continuous export was started.
    - dataSource
```
String dataSource
```
      The type of data collector used to gather this data (currently only offered for AGENT).
    - schemaStorageConfig
```
Map<K,V> schemaStorageConfig
```
      A dictionary which describes how the data is stored.
      
      databaseName - the name of the Glue database used to store the schema.
- Class com.amazonaws.services.applicationdiscovery.model.StartDataCollectionByAgentIdsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - agentIds
```
List<E> agentIds
```
      The IDs of the agents or connectors from which to start collecting data. If you send a request to an agent/connector 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/connectors and you do not have permission to contact some of those agents/connectors, the system does not throw an exception. Instead, the system shows Failed in the Description field.
- Class com.amazonaws.services.applicationdiscovery.model.StartDataCollectionByAgentIdsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - agentsConfigurationStatus
```
List<E> agentsConfigurationStatus
```
      Information about agents or the connector that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.
- Class com.amazonaws.services.applicationdiscovery.model.StartExportTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - exportDataFormat
```
List<E> exportDataFormat
```
      The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been deprecated.
    - filters
```
List<E> filters
```
      If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Agentless Discovery Connector data and summary data from Application Discovery agents.
    - startTime
```
Date startTime
```
      The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.
    - endTime
```
Date endTime
```
      The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.
- Class com.amazonaws.services.applicationdiscovery.model.StartExportTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - exportId
```
String exportId
```
      A unique identifier used to query the status of an export request.
- Class com.amazonaws.services.applicationdiscovery.model.StartImportTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientRequestToken
```
String clientRequestToken
```
      Optional. A unique token that you can provide to prevent the same import request from occurring more than once. If you don't provide a token, a token is automatically generated.
      
      Sending more than one StartImportTask request with the same client request token will return information about the original import task with that client request token.
    - name
```
String name
```
      A descriptive name for this request. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.
    - importUrl
```
String importUrl
```
      The URL for your import file that you've uploaded to Amazon S3.
      
      If you're using the AWS CLI, this URL is structured as follows: s3://BucketName/ImportFileName.CSV
- Class com.amazonaws.services.applicationdiscovery.model.StartImportTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - task
```
ImportTask task
```
      An array of information related to the import task request including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.
- Class com.amazonaws.services.applicationdiscovery.model.StopContinuousExportRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - exportId
```
String exportId
```
      The unique ID assigned to this export.
- Class com.amazonaws.services.applicationdiscovery.model.StopContinuousExportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - startTime
```
Date startTime
```
      Timestamp that represents when this continuous export started collecting data.
    - stopTime
```
Date stopTime
```
      Timestamp that represents when this continuous export was stopped.
- Class com.amazonaws.services.applicationdiscovery.model.StopDataCollectionByAgentIdsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - agentIds
```
List<E> agentIds
```
      The IDs of the agents or connectors from which to stop collecting data.
- Class com.amazonaws.services.applicationdiscovery.model.StopDataCollectionByAgentIdsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - agentsConfigurationStatus
```
List<E> agentsConfigurationStatus
```
      Information about the agents or connector that were instructed to stop collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.
- Class com.amazonaws.services.applicationdiscovery.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The type of tag on which to filter.
    - value
```
String value
```
      A value for a tag key on which to filter.
- Class com.amazonaws.services.applicationdiscovery.model.TagFilter extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      A name of the tag filter.
    - values
```
List<E> values
```
      Values for the tag filter.
- Class com.amazonaws.services.applicationdiscovery.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configurationId
```
String configurationId
```
      Configuration ID of the application to be updated.
    - name
```
String name
```
      New name of the application to be updated.
    - description
```
String description
```
      New description of the application to be updated.
- Class com.amazonaws.services.applicationdiscovery.model.UpdateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
Package com.amazonaws.services.applicationinsights.model
- Class com.amazonaws.services.applicationinsights.model.AmazonApplicationInsightsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationinsights.model.ApplicationComponent extends Object implements Serializable
  - Serialized Fields
    - componentName
```
String componentName
```
      The name of the component.
    - resourceType
```
String resourceType
```
      The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.
    - tier
```
String tier
```
      The stack tier of the application component.
    - monitor
```
Boolean monitor
```
      Indicates whether the application component is monitored.
- Class com.amazonaws.services.applicationinsights.model.ApplicationInfo extends Object implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group used for the application.
    - lifeCycle
```
String lifeCycle
```
      The lifecycle of the application.
    - opsItemSNSTopicArn
```
String opsItemSNSTopicArn
```
      The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.
    - opsCenterEnabled
```
Boolean opsCenterEnabled
```
      Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.
    - remarks
```
String remarks
```
      The issues on the user side that block Application Insights from successfully monitoring an application. Example remarks include:
      
      “Configuring application, detected 1 Errors, 3 Warnings”
      
      “Configuring application, detected 1 Unconfigured Components”
- Class com.amazonaws.services.applicationinsights.model.BadRequestException extends AmazonApplicationInsightsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationinsights.model.ConfigurationEvent extends Object implements Serializable
  - Serialized Fields
    - monitoredResourceARN
```
String monitoredResourceARN
```
      The resource monitored by Application Insights.
    - eventStatus
```
String eventStatus
```
      The status of the configuration update event. Possible values include INFO, WARN, and ERROR.
    - eventResourceType
```
String eventResourceType
```
      The resource type that Application Insights attempted to configure, for example, CLOUDWATCH_ALARM.
    - eventTime
```
Date eventTime
```
      The timestamp of the event.
    - eventDetail
```
String eventDetail
```
      The details of the event in plain text.
    - eventResourceName
```
String eventResourceName
```
      The name of the resource Application Insights attempted to configure.
- Class com.amazonaws.services.applicationinsights.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - opsCenterEnabled
```
Boolean opsCenterEnabled
```
      When set to true, creates opsItems for any problems detected on an application.
    - opsItemSNSTopicArn
```
String opsItemSNSTopicArn
```
      The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
    - tags
```
List<E> tags
```
      List of tags to add to the application. tag key (Key) and an associated tag value ( Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
- Class com.amazonaws.services.applicationinsights.model.CreateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationInfo
```
ApplicationInfo applicationInfo
```
      Information about the application.
- Class com.amazonaws.services.applicationinsights.model.CreateComponentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - componentName
```
String componentName
```
      The name of the component.
    - resourceList
```
List<E> resourceList
```
      The list of resource ARNs that belong to the component.
- Class com.amazonaws.services.applicationinsights.model.CreateComponentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationinsights.model.CreateLogPatternRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - patternSetName
```
String patternSetName
```
      The name of the log pattern set.
    - patternName
```
String patternName
```
      The name of the log pattern.
    - pattern
```
String pattern
```
      The log pattern.
    - rank
```
Integer rank
```
      Rank of the log pattern.
- Class com.amazonaws.services.applicationinsights.model.CreateLogPatternResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - logPattern
```
LogPattern logPattern
```
      The successfully created log pattern.
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
- Class com.amazonaws.services.applicationinsights.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
- Class com.amazonaws.services.applicationinsights.model.DeleteApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationinsights.model.DeleteComponentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - componentName
```
String componentName
```
      The name of the component.
- Class com.amazonaws.services.applicationinsights.model.DeleteComponentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationinsights.model.DeleteLogPatternRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - patternSetName
```
String patternSetName
```
      The name of the log pattern set.
    - patternName
```
String patternName
```
      The name of the log pattern.
- Class com.amazonaws.services.applicationinsights.model.DeleteLogPatternResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationinsights.model.DescribeApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
- Class com.amazonaws.services.applicationinsights.model.DescribeApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationInfo
```
ApplicationInfo applicationInfo
```
      Information about the application.
- Class com.amazonaws.services.applicationinsights.model.DescribeComponentConfigurationRecommendationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - componentName
```
String componentName
```
      The name of the component.
    - tier
```
String tier
```
      The tier of the application component. Supported tiers include DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT.
- Class com.amazonaws.services.applicationinsights.model.DescribeComponentConfigurationRecommendationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - componentConfiguration
```
String componentConfiguration
```
      The recommended configuration settings of the component. The value is the escaped JSON of the configuration.
- Class com.amazonaws.services.applicationinsights.model.DescribeComponentConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - componentName
```
String componentName
```
      The name of the component.
- Class com.amazonaws.services.applicationinsights.model.DescribeComponentConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - monitor
```
Boolean monitor
```
      Indicates whether the application component is monitored.
    - tier
```
String tier
```
      The tier of the application component. Supported tiers include DOT_NET_CORE, DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT
    - componentConfiguration
```
String componentConfiguration
```
      The configuration settings of the component. The value is the escaped JSON of the configuration.
- Class com.amazonaws.services.applicationinsights.model.DescribeComponentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - componentName
```
String componentName
```
      The name of the component.
- Class com.amazonaws.services.applicationinsights.model.DescribeComponentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationComponent
```
ApplicationComponent applicationComponent
```
    - resourceList
```
List<E> resourceList
```
      The list of resource ARNs that belong to the component.
- Class com.amazonaws.services.applicationinsights.model.DescribeLogPatternRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - patternSetName
```
String patternSetName
```
      The name of the log pattern set.
    - patternName
```
String patternName
```
      The name of the log pattern.
- Class com.amazonaws.services.applicationinsights.model.DescribeLogPatternResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - logPattern
```
LogPattern logPattern
```
      The successfully created log pattern.
- Class com.amazonaws.services.applicationinsights.model.DescribeObservationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - observationId
```
String observationId
```
      The ID of the observation.
- Class com.amazonaws.services.applicationinsights.model.DescribeObservationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - observation
```
Observation observation
```
      Information about the observation.
- Class com.amazonaws.services.applicationinsights.model.DescribeProblemObservationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - problemId
```
String problemId
```
      The ID of the problem.
- Class com.amazonaws.services.applicationinsights.model.DescribeProblemObservationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - relatedObservations
```
RelatedObservations relatedObservations
```
      Observations related to the problem.
- Class com.amazonaws.services.applicationinsights.model.DescribeProblemRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - problemId
```
String problemId
```
      The ID of the problem.
- Class com.amazonaws.services.applicationinsights.model.DescribeProblemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - problem
```
Problem problem
```
      Information about the problem.
- Class com.amazonaws.services.applicationinsights.model.InternalServerException extends AmazonApplicationInsightsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationinsights.model.ListApplicationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - 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
```
      The token to request the next page of results.
- Class com.amazonaws.services.applicationinsights.model.ListApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationInfoList
```
List<E> applicationInfoList
```
      The list of applications.
    - nextToken
```
String nextToken
```
      The token used to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.applicationinsights.model.ListComponentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - 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
```
      The token to request the next page of results.
- Class com.amazonaws.services.applicationinsights.model.ListComponentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationComponentList
```
List<E> applicationComponentList
```
      The list of application components.
    - nextToken
```
String nextToken
```
      The token to request the next page of results.
- Class com.amazonaws.services.applicationinsights.model.ListConfigurationHistoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      Resource group to which the application belongs.
    - startTime
```
Date startTime
```
      The start time of the event.
    - endTime
```
Date endTime
```
      The end time of the event.
    - eventStatus
```
String eventStatus
```
      The status of the configuration update event. Possible values include INFO, WARN, and ERROR.
    - maxResults
```
Integer maxResults
```
      The maximum number of results returned by ListConfigurationHistory in paginated output. When this parameter is used, ListConfigurationHistory returns only MaxResults in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another ListConfigurationHistory request with the returned NextToken value. If this parameter is not used, then ListConfigurationHistory returns all results.
    - nextToken
```
String nextToken
```
      The NextToken value returned from a previous paginated ListConfigurationHistory 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.
- Class com.amazonaws.services.applicationinsights.model.ListConfigurationHistoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - eventList
```
List<E> eventList
```
      The list of configuration events and their corresponding details.
    - nextToken
```
String nextToken
```
      The NextToken value to include in a future ListConfigurationHistory request. When the results of a ListConfigurationHistory 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.applicationinsights.model.ListLogPatternSetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - 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
```
      The token to request the next page of results.
- Class com.amazonaws.services.applicationinsights.model.ListLogPatternSetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - logPatternSets
```
List<E> logPatternSets
```
      The list of log pattern sets.
    - nextToken
```
String nextToken
```
      The token used to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.applicationinsights.model.ListLogPatternsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - patternSetName
```
String patternSetName
```
      The name of the log pattern set.
    - 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
```
      The token to request the next page of results.
- Class com.amazonaws.services.applicationinsights.model.ListLogPatternsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - logPatterns
```
List<E> logPatterns
```
      The list of log patterns.
    - nextToken
```
String nextToken
```
      The token used to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.applicationinsights.model.ListProblemsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - startTime
```
Date startTime
```
      The time when the problem was detected, in epoch seconds. If you don't specify a time frame for the request, problems within the past seven days are returned.
    - endTime
```
Date endTime
```
      The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.
    - 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
```
      The token to request the next page of results.
- Class com.amazonaws.services.applicationinsights.model.ListProblemsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - problemList
```
List<E> problemList
```
      The list of problems.
    - nextToken
```
String nextToken
```
      The token used to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.applicationinsights.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      The Amazon Resource Name (ARN) of the application that you want to retrieve tag information for.
- Class com.amazonaws.services.applicationinsights.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
List<E> tags
```
      An array that lists all the tags that are associated with the application. Each tag consists of a required tag key (Key) and an associated tag value (Value).
- Class com.amazonaws.services.applicationinsights.model.LogPattern extends Object implements Serializable
  - Serialized Fields
    - patternSetName
```
String patternSetName
```
      The name of the log pattern. A log pattern name can contains at many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits or one of the following symbols: period, dash, underscore.
    - patternName
```
String patternName
```
      The name of the log pattern. A log pattern name can contains at many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits or one of the following symbols: period, dash, underscore.
    - pattern
```
String pattern
```
      A regular expression that defines the log pattern. A log pattern can contains at many as 50 characters, and it cannot be empty.
    - rank
```
Integer rank
```
      Rank of the log pattern.
- Class com.amazonaws.services.applicationinsights.model.Observation extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the observation type.
    - startTime
```
Date startTime
```
      The time when the observation was first detected, in epoch seconds.
    - endTime
```
Date endTime
```
      The time when the observation ended, in epoch seconds.
    - sourceType
```
String sourceType
```
      The source type of the observation.
    - sourceARN
```
String sourceARN
```
      The source resource ARN of the observation.
    - logGroup
```
String logGroup
```
      The log group name.
    - lineTime
```
Date lineTime
```
      The timestamp in the CloudWatch Logs that specifies when the matched line occurred.
    - logText
```
String logText
```
      The log text of the observation.
    - logFilter
```
String logFilter
```
      The log filter of the observation.
    - metricNamespace
```
String metricNamespace
```
      The namespace of the observation metric.
    - metricName
```
String metricName
```
      The name of the observation metric.
    - unit
```
String unit
```
      The unit of the source observation metric.
    - value
```
Double value
```
      The value of the source observation metric.
- Class com.amazonaws.services.applicationinsights.model.Problem extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the problem.
    - title
```
String title
```
      The name of the problem.
    - insights
```
String insights
```
      A detailed analysis of the problem using machine learning.
    - status
```
String status
```
      The status of the problem.
    - affectedResource
```
String affectedResource
```
      The resource affected by the problem.
    - startTime
```
Date startTime
```
      The time when the problem started, in epoch seconds.
    - endTime
```
Date endTime
```
      The time when the problem ended, in epoch seconds.
    - severityLevel
```
String severityLevel
```
      A measure of the level of impact of the problem.
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group affected by the problem.
    - feedback
```
Map<K,V> feedback
```
      Feedback provided by the user about the problem.
- Class com.amazonaws.services.applicationinsights.model.RelatedObservations extends Object implements Serializable
  - Serialized Fields
    - observationList
```
List<E> observationList
```
      The list of observations related to the problem.
- Class com.amazonaws.services.applicationinsights.model.ResourceInUseException extends AmazonApplicationInsightsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationinsights.model.ResourceNotFoundException extends AmazonApplicationInsightsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationinsights.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.
    - value
```
String value
```
      The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don't want an application to have a specific tag value, don't specify a value for this parameter.
- Class com.amazonaws.services.applicationinsights.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      The Amazon Resource Name (ARN) of the application that you want to add one or more tags to.
    - tags
```
List<E> tags
```
      A list of tags that to add to the application. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
- Class com.amazonaws.services.applicationinsights.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationinsights.model.TagsAlreadyExistException extends AmazonApplicationInsightsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.applicationinsights.model.TooManyTagsException extends AmazonApplicationInsightsException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceName
```
String resourceName
```
      The name of the resource with too many tags.
- Class com.amazonaws.services.applicationinsights.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      The Amazon Resource Name (ARN) of the application that you want to remove one or more tags from.
    - tagKeys
```
List<E> tagKeys
```
      The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.
      
      To remove more than one tag from the application, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand.
- Class com.amazonaws.services.applicationinsights.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationinsights.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - opsCenterEnabled
```
Boolean opsCenterEnabled
```
      When set to true, creates opsItems for any problems detected on an application.
    - opsItemSNSTopicArn
```
String opsItemSNSTopicArn
```
      The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.
    - removeSNSTopic
```
Boolean removeSNSTopic
```
      Disassociates the SNS topic from the opsItem created for detected problems.
- Class com.amazonaws.services.applicationinsights.model.UpdateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - applicationInfo
```
ApplicationInfo applicationInfo
```
      Information about the application.
- Class com.amazonaws.services.applicationinsights.model.UpdateComponentConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - componentName
```
String componentName
```
      The name of the component.
    - monitor
```
Boolean monitor
```
      Indicates whether the application component is monitored.
    - tier
```
String tier
```
      The tier of the application component. Supported tiers include DOT_NET_WORKER, DOT_NET_WEB, DOT_NET_CORE, SQL_SERVER, and DEFAULT.
    - componentConfiguration
```
String componentConfiguration
```
      The configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see Working with JSON. You can send a request to DescribeComponentConfigurationRecommendation to see the recommended configuration for a component. For the complete format of the component configuration file, see Component Configuration.
- Class com.amazonaws.services.applicationinsights.model.UpdateComponentConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationinsights.model.UpdateComponentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - componentName
```
String componentName
```
      The name of the component.
    - newComponentName
```
String newComponentName
```
      The new name of the component.
    - resourceList
```
List<E> resourceList
```
      The list of resource ARNs that belong to the component.
- Class com.amazonaws.services.applicationinsights.model.UpdateComponentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.applicationinsights.model.UpdateLogPatternRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - patternSetName
```
String patternSetName
```
      The name of the log pattern set.
    - patternName
```
String patternName
```
      The name of the log pattern.
    - pattern
```
String pattern
```
      The log pattern.
    - rank
```
Integer rank
```
      Rank of the log pattern.
- Class com.amazonaws.services.applicationinsights.model.UpdateLogPatternResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resourceGroupName
```
String resourceGroupName
```
      The name of the resource group.
    - logPattern
```
LogPattern logPattern
```
      The successfully created log pattern.
- Class com.amazonaws.services.applicationinsights.model.ValidationException extends AmazonApplicationInsightsException implements Serializable
  
  serialVersionUID:
  
  1L
Package com.amazonaws.services.appmesh.model
- Class com.amazonaws.services.appmesh.model.AccessLog extends Object implements Serializable
  - Serialized Fields
    - file
```
FileAccessLog file
```
      The file object to send virtual node access logs to.
- Class com.amazonaws.services.appmesh.model.AWSAppMeshException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appmesh.model.AwsCloudMapInstanceAttribute extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
    - value
```
String value
```
      The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
- Class com.amazonaws.services.appmesh.model.AwsCloudMapServiceDiscovery extends Object implements Serializable
  - Serialized Fields
    - attributes
```
List<E> attributes
```
      A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.
    - namespaceName
```
String namespaceName
```
      The name of the AWS Cloud Map namespace to use.
    - serviceName
```
String serviceName
```
      The name of the AWS Cloud Map service to use.
- Class com.amazonaws.services.appmesh.model.Backend extends Object implements Serializable
  - Serialized Fields
    - virtualService
```
VirtualServiceBackend virtualService
```
      Specifies a virtual service to use as a backend for a virtual node.
- Class com.amazonaws.services.appmesh.model.BadRequestException extends AWSAppMeshException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appmesh.model.ConflictException extends AWSAppMeshException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appmesh.model.CreateMeshRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    - meshName
```
String meshName
```
      The name to use for the service mesh.
    - spec
```
MeshSpec spec
```
      The service mesh specification to apply.
    - tags
```
List<E> tags
```
      Optional metadata that you can apply to the service mesh to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- Class com.amazonaws.services.appmesh.model.CreateMeshResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - mesh
```
MeshData mesh
```
      The full description of your service mesh following the create call.
- Class com.amazonaws.services.appmesh.model.CreateRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    - meshName
```
String meshName
```
      The name of the service mesh to create the route in.
    - routeName
```
String routeName
```
      The name to use for the route.
    - spec
```
RouteSpec spec
```
      The route specification to apply.
    - tags
```
List<E> tags
```
      Optional metadata that you can apply to the route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
    - virtualRouterName
```
String virtualRouterName
```
      The name of the virtual router in which to create the route.
- Class com.amazonaws.services.appmesh.model.CreateRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - route
```
RouteData route
```
      The full description of your mesh following the create call.
- Class com.amazonaws.services.appmesh.model.CreateVirtualNodeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    - meshName
```
String meshName
```
      The name of the service mesh to create the virtual node in.
    - spec
```
VirtualNodeSpec spec
```
      The virtual node specification to apply.
    - tags
```
List<E> tags
```
      Optional metadata that you can apply to the virtual node to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
    - virtualNodeName
```
String virtualNodeName
```
      The name to use for the virtual node.
- Class com.amazonaws.services.appmesh.model.CreateVirtualNodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - virtualNode
```
VirtualNodeData virtualNode
```
      The full description of your virtual node following the create call.
- Class com.amazonaws.services.appmesh.model.CreateVirtualRouterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    - meshName
```
String meshName
```
      The name of the service mesh to create the virtual router in.
    - spec
```
VirtualRouterSpec spec
```
      The virtual router specification to apply.
    - tags
```
List<E> tags
```
      Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
    - virtualRouterName
```
String virtualRouterName
```
      The name to use for the virtual router.
- Class com.amazonaws.services.appmesh.model.CreateVirtualRouterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - virtualRouter
```
VirtualRouterData virtualRouter
```
      The full description of your virtual router following the create call.
- Class com.amazonaws.services.appmesh.model.CreateVirtualServiceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    - meshName
```
String meshName
```
      The name of the service mesh to create the virtual service in.
    - spec
```
VirtualServiceSpec spec
```
      The virtual service specification to apply.
    - tags
```
List<E> tags
```
      Optional metadata that you can apply to the virtual service to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
    - virtualServiceName
```
String virtualServiceName
```
      The name to use for the virtual service.
- Class com.amazonaws.services.appmesh.model.CreateVirtualServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - virtualService
```
VirtualServiceData virtualService
```
      The full description of your virtual service following the create call.
- Class com.amazonaws.services.appmesh.model.DeleteMeshRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh to delete.
- Class com.amazonaws.services.appmesh.model.DeleteMeshResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - mesh
```
MeshData mesh
```
      The service mesh that was deleted.
- Class com.amazonaws.services.appmesh.model.DeleteRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh to delete the route in.
    - routeName
```
String routeName
```
      The name of the route to delete.
    - virtualRouterName
```
String virtualRouterName
```
      The name of the virtual router to delete the route in.
- Class com.amazonaws.services.appmesh.model.DeleteRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - route
```
RouteData route
```
      The route that was deleted.
- Class com.amazonaws.services.appmesh.model.DeleteVirtualNodeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh to delete the virtual node in.
    - virtualNodeName
```
String virtualNodeName
```
      The name of the virtual node to delete.
- Class com.amazonaws.services.appmesh.model.DeleteVirtualNodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - virtualNode
```
VirtualNodeData virtualNode
```
      The virtual node that was deleted.
- Class com.amazonaws.services.appmesh.model.DeleteVirtualRouterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh to delete the virtual router in.
    - virtualRouterName
```
String virtualRouterName
```
      The name of the virtual router to delete.
- Class com.amazonaws.services.appmesh.model.DeleteVirtualRouterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - virtualRouter
```
VirtualRouterData virtualRouter
```
      The virtual router that was deleted.
- Class com.amazonaws.services.appmesh.model.DeleteVirtualServiceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh to delete the virtual service in.
    - virtualServiceName
```
String virtualServiceName
```
      The name of the virtual service to delete.
- Class com.amazonaws.services.appmesh.model.DeleteVirtualServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - virtualService
```
VirtualServiceData virtualService
```
      The virtual service that was deleted.
- Class com.amazonaws.services.appmesh.model.DescribeMeshRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh to describe.
- Class com.amazonaws.services.appmesh.model.DescribeMeshResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - mesh
```
MeshData mesh
```
      The full description of your service mesh.
- Class com.amazonaws.services.appmesh.model.DescribeRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh that the route resides in.
    - routeName
```
String routeName
```
      The name of the route to describe.
    - virtualRouterName
```
String virtualRouterName
```
      The name of the virtual router that the route is associated with.
- Class com.amazonaws.services.appmesh.model.DescribeRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - route
```
RouteData route
```
      The full description of your route.
- Class com.amazonaws.services.appmesh.model.DescribeVirtualNodeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh that the virtual node resides in.
    - virtualNodeName
```
String virtualNodeName
```
      The name of the virtual node to describe.
- Class com.amazonaws.services.appmesh.model.DescribeVirtualNodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - virtualNode
```
VirtualNodeData virtualNode
```
      The full description of your virtual node.
- Class com.amazonaws.services.appmesh.model.DescribeVirtualRouterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh that the virtual router resides in.
    - virtualRouterName
```
String virtualRouterName
```
      The name of the virtual router to describe.
- Class com.amazonaws.services.appmesh.model.DescribeVirtualRouterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - virtualRouter
```
VirtualRouterData virtualRouter
```
      The full description of your virtual router.
- Class com.amazonaws.services.appmesh.model.DescribeVirtualServiceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh that the virtual service resides in.
    - virtualServiceName
```
String virtualServiceName
```
      The name of the virtual service to describe.
- Class com.amazonaws.services.appmesh.model.DescribeVirtualServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - virtualService
```
VirtualServiceData virtualService
```
      The full description of your virtual service.
- Class com.amazonaws.services.appmesh.model.DnsServiceDiscovery extends Object implements Serializable
  - Serialized Fields
    - hostname
```
String hostname
```
      Specifies the DNS service discovery hostname for the virtual node.
- Class com.amazonaws.services.appmesh.model.Duration extends Object implements Serializable
  - Serialized Fields
    - unit
```
String unit
```
      A unit of time.
    - value
```
Long value
```
      A number of time units.
- Class com.amazonaws.services.appmesh.model.EgressFilter extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The egress filter type. By default, the type is DROP_ALL, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for AWS API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.
- Class com.amazonaws.services.appmesh.model.FileAccessLog extends Object implements Serializable
  - Serialized Fields
    - path
```
String path
```
      The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
      
      The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.
- Class com.amazonaws.services.appmesh.model.ForbiddenException extends AWSAppMeshException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appmesh.model.GrpcRetryPolicy extends Object implements Serializable
  - Serialized Fields
    - grpcRetryEvents
```
List<E> grpcRetryEvents
```
      Specify at least one of the valid values.
    - httpRetryEvents
```
List<E> httpRetryEvents
```
      Specify at least one of the following values.
      
      server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
      
      gateway-error – HTTP status codes 502, 503, and 504
      
      client-error – HTTP status code 409
      
      stream-error – Retry on refused stream
    - maxRetries
```
Long maxRetries
```
      The maximum number of retry attempts.
    - perRetryTimeout
```
Duration perRetryTimeout
```
      An object that represents a duration of time.
    - tcpRetryEvents
```
List<E> tcpRetryEvents
```
      Specify a valid value.
- Class com.amazonaws.services.appmesh.model.GrpcRoute extends Object implements Serializable
  - Serialized Fields
    - action
```
GrpcRouteAction action
```
      An object that represents the action to take if a match is determined.
    - match
```
GrpcRouteMatch match
```
      An object that represents the criteria for determining a request match.
    - retryPolicy
```
GrpcRetryPolicy retryPolicy
```
      An object that represents a retry policy.
- Class com.amazonaws.services.appmesh.model.GrpcRouteAction extends Object implements Serializable
  - Serialized Fields
    - weightedTargets
```
List<E> weightedTargets
```
      An object that represents the targets that traffic is routed to when a request matches the route.
- Class com.amazonaws.services.appmesh.model.GrpcRouteMatch extends Object implements Serializable
  - Serialized Fields
    - metadata
```
List<E> metadata
```
      An object that represents the data to match from the request.
    - methodName
```
String methodName
```
      The method name to match from the request. If you specify a name, you must also specify a serviceName.
    - serviceName
```
String serviceName
```
      The fully qualified domain name for the service to match from the request.
- Class com.amazonaws.services.appmesh.model.GrpcRouteMetadata extends Object implements Serializable
  - Serialized Fields
    - invert
```
Boolean invert
```
      Specify True to match anything except the match criteria. The default value is False.
    - match
```
GrpcRouteMetadataMatchMethod match
```
      An object that represents the data to match from the request.
    - name
```
String name
```
      The name of the route.
- Class com.amazonaws.services.appmesh.model.GrpcRouteMetadataMatchMethod extends Object implements Serializable
  - Serialized Fields
    - exact
```
String exact
```
      The value sent by the client must match the specified value exactly.
    - prefix
```
String prefix
```
      The value sent by the client must begin with the specified characters.
    - range
```
MatchRange range
```
      An object that represents the range of values to match on.
    - regex
```
String regex
```
      The value sent by the client must include the specified characters.
    - suffix
```
String suffix
```
      The value sent by the client must end with the specified characters.
- Class com.amazonaws.services.appmesh.model.HeaderMatchMethod extends Object implements Serializable
  - Serialized Fields
    - exact
```
String exact
```
      The value sent by the client must match the specified value exactly.
    - prefix
```
String prefix
```
      The value sent by the client must begin with the specified characters.
    - range
```
MatchRange range
```
      An object that represents the range of values to match on.
    - regex
```
String regex
```
      The value sent by the client must include the specified characters.
    - suffix
```
String suffix
```
      The value sent by the client must end with the specified characters.
- Class com.amazonaws.services.appmesh.model.HealthCheckPolicy extends Object implements Serializable
  - Serialized Fields
    - healthyThreshold
```
Integer healthyThreshold
```
      The number of consecutive successful health checks that must occur before declaring listener healthy.
    - intervalMillis
```
Long intervalMillis
```
      The time period in milliseconds between each health check execution.
    - path
```
String path
```
      The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.
    - port
```
Integer port
```
      The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
    - protocol
```
String protocol
```
      The protocol for the health check request.
    - timeoutMillis
```
Long timeoutMillis
```
      The amount of time to wait when receiving a response from the health check, in milliseconds.
    - unhealthyThreshold
```
Integer unhealthyThreshold
```
      The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
- Class com.amazonaws.services.appmesh.model.HttpRetryPolicy extends Object implements Serializable
  - Serialized Fields
    - httpRetryEvents
```
List<E> httpRetryEvents
```
      Specify at least one of the following values.
      
      server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
      
      gateway-error – HTTP status codes 502, 503, and 504
      
      client-error – HTTP status code 409
      
      stream-error – Retry on refused stream
    - maxRetries
```
Long maxRetries
```
      The maximum number of retry attempts.
    - perRetryTimeout
```
Duration perRetryTimeout
```
      An object that represents a duration of time.
    - tcpRetryEvents
```
List<E> tcpRetryEvents
```
      Specify a valid value.
- Class com.amazonaws.services.appmesh.model.HttpRoute extends Object implements Serializable
  - Serialized Fields
    - action
```
HttpRouteAction action
```
      An object that represents the action to take if a match is determined.
    - match
```
HttpRouteMatch match
```
      An object that represents the criteria for determining a request match.
    - retryPolicy
```
HttpRetryPolicy retryPolicy
```
      An object that represents a retry policy.
- Class com.amazonaws.services.appmesh.model.HttpRouteAction extends Object implements Serializable
  - Serialized Fields
    - weightedTargets
```
List<E> weightedTargets
```
      An object that represents the targets that traffic is routed to when a request matches the route.
- Class com.amazonaws.services.appmesh.model.HttpRouteHeader extends Object implements Serializable
  - Serialized Fields
    - invert
```
Boolean invert
```
      Specify True to match anything except the match criteria. The default value is False.
    - match
```
HeaderMatchMethod match
```
      The HeaderMatchMethod object.
    - name
```
String name
```
      A name for the HTTP header in the client request that will be matched on.
- Class com.amazonaws.services.appmesh.model.HttpRouteMatch extends Object implements Serializable
  - Serialized Fields
    - headers
```
List<E> headers
```
      An object that represents the client request headers to match on.
    - method
```
String method
```
      The client request method to match on. Specify only one.
    - prefix
```
String prefix
```
      Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.
    - scheme
```
String scheme
```
      The client request scheme to match on. Specify only one.
- Class com.amazonaws.services.appmesh.model.InternalServerErrorException extends AWSAppMeshException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appmesh.model.LimitExceededException extends AWSAppMeshException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appmesh.model.Listener extends Object implements Serializable
  - Serialized Fields
    - healthCheck
```
HealthCheckPolicy healthCheck
```
      The health check information for the listener.
    - portMapping
```
PortMapping portMapping
```
      The port mapping information for the listener.
- Class com.amazonaws.services.appmesh.model.ListMeshesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - limit
```
Integer limit
```
      The maximum number of results returned by ListMeshes in paginated output. When you use this parameter, ListMeshes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListMeshes returns up to 100 results and a nextToken value if applicable.
    - nextToken
```
String nextToken
```
      The nextToken value returned from a previous paginated ListMeshes request where limit 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 token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.
- Class com.amazonaws.services.appmesh.model.ListMeshesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - meshes
```
List<E> meshes
```
      The list of existing service meshes.
    - nextToken
```
String nextToken
```
      The nextToken value to include in a future ListMeshes request. When the results of a ListMeshes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.appmesh.model.ListRoutesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - limit
```
Integer limit
```
      The maximum number of results returned by ListRoutes in paginated output. When you use this parameter, ListRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable.
    - meshName
```
String meshName
```
      The name of the service mesh to list routes in.
    - nextToken
```
String nextToken
```
      The nextToken value returned from a previous paginated ListRoutes request where limit 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.
    - virtualRouterName
```
String virtualRouterName
```
      The name of the virtual router to list routes in.
- Class com.amazonaws.services.appmesh.model.ListRoutesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
    - routes
```
List<E> routes
```
      The list of existing routes for the specified service mesh and virtual router.
- Class com.amazonaws.services.appmesh.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - limit
```
Integer limit
```
      The maximum number of tag results returned by ListTagsForResource in paginated output. When this parameter is used, ListTagsForResource returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListTagsForResource request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListTagsForResource returns up to 100 results and a nextToken value if applicable.
    - nextToken
```
String nextToken
```
      The nextToken value returned from a previous paginated ListTagsForResource request where limit 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.
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) that identifies the resource to list the tags for.
- Class com.amazonaws.services.appmesh.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The nextToken value to include in a future ListTagsForResource request. When the results of a ListTagsForResource request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
    - tags
```
List<E> tags
```
      The tags for the resource.
- Class com.amazonaws.services.appmesh.model.ListVirtualNodesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - limit
```
Integer limit
```
      The maximum number of results returned by ListVirtualNodes in paginated output. When you use this parameter, ListVirtualNodes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualNodes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualNodes returns up to 100 results and a nextToken value if applicable.
    - meshName
```
String meshName
```
      The name of the service mesh to list virtual nodes in.
    - nextToken
```
String nextToken
```
      The nextToken value returned from a previous paginated ListVirtualNodes request where limit 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.
- Class com.amazonaws.services.appmesh.model.ListVirtualNodesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The nextToken value to include in a future ListVirtualNodes request. When the results of a ListVirtualNodes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
    - virtualNodes
```
List<E> virtualNodes
```
      The list of existing virtual nodes for the specified service mesh.
- Class com.amazonaws.services.appmesh.model.ListVirtualRoutersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - limit
```
Integer limit
```
      The maximum number of results returned by ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable.
    - meshName
```
String meshName
```
      The name of the service mesh to list virtual routers in.
    - nextToken
```
String nextToken
```
      The nextToken value returned from a previous paginated ListVirtualRouters request where limit 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.
- Class com.amazonaws.services.appmesh.model.ListVirtualRoutersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
    - virtualRouters
```
List<E> virtualRouters
```
      The list of existing virtual routers for the specified service mesh.
- Class com.amazonaws.services.appmesh.model.ListVirtualServicesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - limit
```
Integer limit
```
      The maximum number of results returned by ListVirtualServices in paginated output. When you use this parameter, ListVirtualServices returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualServices request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualServices returns up to 100 results and a nextToken value if applicable.
    - meshName
```
String meshName
```
      The name of the service mesh to list virtual services in.
    - nextToken
```
String nextToken
```
      The nextToken value returned from a previous paginated ListVirtualServices request where limit 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.
- Class com.amazonaws.services.appmesh.model.ListVirtualServicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The nextToken value to include in a future ListVirtualServices request. When the results of a ListVirtualServices request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
    - virtualServices
```
List<E> virtualServices
```
      The list of existing virtual services for the specified service mesh.
- Class com.amazonaws.services.appmesh.model.Logging extends Object implements Serializable
  - Serialized Fields
    - accessLog
```
AccessLog accessLog
```
      The access log configuration for a virtual node.
- Class com.amazonaws.services.appmesh.model.MatchRange extends Object implements Serializable
  - Serialized Fields
    - end
```
Long end
```
      The end of the range.
    - start
```
Long start
```
      The start of the range.
- Class com.amazonaws.services.appmesh.model.MeshData extends Object implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh.
    - metadata
```
ResourceMetadata metadata
```
      The associated metadata for the service mesh.
    - spec
```
MeshSpec spec
```
      The associated specification for the service mesh.
    - status
```
MeshStatus status
```
      The status of the service mesh.
- Class com.amazonaws.services.appmesh.model.MeshRef extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The full Amazon Resource Name (ARN) of the service mesh.
    - meshName
```
String meshName
```
      The name of the service mesh.
- Class com.amazonaws.services.appmesh.model.MeshSpec extends Object implements Serializable
  - Serialized Fields
    - egressFilter
```
EgressFilter egressFilter
```
      The egress filter rules for the service mesh.
- Class com.amazonaws.services.appmesh.model.MeshStatus extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The current mesh status.
- Class com.amazonaws.services.appmesh.model.NotFoundException extends AWSAppMeshException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appmesh.model.PortMapping extends Object implements Serializable
  - Serialized Fields
    - port
```
Integer port
```
      The port used for the port mapping.
    - protocol
```
String protocol
```
      The protocol used for the port mapping. Specify one protocol.
- Class com.amazonaws.services.appmesh.model.ResourceInUseException extends AWSAppMeshException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appmesh.model.ResourceMetadata extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The full Amazon Resource Name (ARN) for the resource.
    - createdAt
```
Date createdAt
```
      The Unix epoch timestamp in seconds for when the resource was created.
    - lastUpdatedAt
```
Date lastUpdatedAt
```
      The Unix epoch timestamp in seconds for when the resource was last updated.
    - uid
```
String uid
```
      The unique identifier for the resource.
    - version
```
Long version
```
      The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
- Class com.amazonaws.services.appmesh.model.RouteData extends Object implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh that the route resides in.
    - metadata
```
ResourceMetadata metadata
```
      The associated metadata for the route.
    - routeName
```
String routeName
```
      The name of the route.
    - spec
```
RouteSpec spec
```
      The specifications of the route.
    - status
```
RouteStatus status
```
      The status of the route.
    - virtualRouterName
```
String virtualRouterName
```
      The virtual router that the route is associated with.
- Class com.amazonaws.services.appmesh.model.RouteRef extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The full Amazon Resource Name (ARN) for the route.
    - meshName
```
String meshName
```
      The name of the service mesh that the route resides in.
    - routeName
```
String routeName
```
      The name of the route.
    - virtualRouterName
```
String virtualRouterName
```
      The virtual router that the route is associated with.
- Class com.amazonaws.services.appmesh.model.RouteSpec extends Object implements Serializable
  - Serialized Fields
    - grpcRoute
```
GrpcRoute grpcRoute
```
      An object that represents the specification of a GRPC route.
    - http2Route
```
HttpRoute http2Route
```
      An object that represents the specification of an HTTP2 route.
    - httpRoute
```
HttpRoute httpRoute
```
      An object that represents the specification of an HTTP route.
    - priority
```
Integer priority
```
      The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
    - tcpRoute
```
TcpRoute tcpRoute
```
      An object that represents the specification of a TCP route.
- Class com.amazonaws.services.appmesh.model.RouteStatus extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The current status for the route.
- Class com.amazonaws.services.appmesh.model.ServiceDiscovery extends Object implements Serializable
  - Serialized Fields
    - awsCloudMap
```
AwsCloudMapServiceDiscovery awsCloudMap
```
      Specifies any AWS Cloud Map information for the virtual node.
    - dns
```
DnsServiceDiscovery dns
```
      Specifies the DNS information for the virtual node.
- Class com.amazonaws.services.appmesh.model.ServiceUnavailableException extends AWSAppMeshException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appmesh.model.TagRef extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
    - value
```
String value
```
      The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
- Class com.amazonaws.services.appmesh.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource to add tags to.
    - tags
```
List<E> tags
```
      The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
- Class com.amazonaws.services.appmesh.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appmesh.model.TcpRoute extends Object implements Serializable
  - Serialized Fields
    - action
```
TcpRouteAction action
```
      The action to take if a match is determined.
- Class com.amazonaws.services.appmesh.model.TcpRouteAction extends Object implements Serializable
  - Serialized Fields
    - weightedTargets
```
List<E> weightedTargets
```
      An object that represents the targets that traffic is routed to when a request matches the route.
- Class com.amazonaws.services.appmesh.model.TooManyRequestsException extends AWSAppMeshException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appmesh.model.TooManyTagsException extends AWSAppMeshException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appmesh.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource to delete tags from.
    - tagKeys
```
List<E> tagKeys
```
      The keys of the tags to be removed.
- Class com.amazonaws.services.appmesh.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appmesh.model.UpdateMeshRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    - meshName
```
String meshName
```
      The name of the service mesh to update.
    - spec
```
MeshSpec spec
```
      The service mesh specification to apply.
- Class com.amazonaws.services.appmesh.model.UpdateMeshResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - mesh
```
MeshData mesh
```
- Class com.amazonaws.services.appmesh.model.UpdateRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    - meshName
```
String meshName
```
      The name of the service mesh that the route resides in.
    - routeName
```
String routeName
```
      The name of the route to update.
    - spec
```
RouteSpec spec
```
      The new route specification to apply. This overwrites the existing data.
    - virtualRouterName
```
String virtualRouterName
```
      The name of the virtual router that the route is associated with.
- Class com.amazonaws.services.appmesh.model.UpdateRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - route
```
RouteData route
```
      A full description of the route that was updated.
- Class com.amazonaws.services.appmesh.model.UpdateVirtualNodeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    - meshName
```
String meshName
```
      The name of the service mesh that the virtual node resides in.
    - spec
```
VirtualNodeSpec spec
```
      The new virtual node specification to apply. This overwrites the existing data.
    - virtualNodeName
```
String virtualNodeName
```
      The name of the virtual node to update.
- Class com.amazonaws.services.appmesh.model.UpdateVirtualNodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - virtualNode
```
VirtualNodeData virtualNode
```
      A full description of the virtual node that was updated.
- Class com.amazonaws.services.appmesh.model.UpdateVirtualRouterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    - meshName
```
String meshName
```
      The name of the service mesh that the virtual router resides in.
    - spec
```
VirtualRouterSpec spec
```
      The new virtual router specification to apply. This overwrites the existing data.
    - virtualRouterName
```
String virtualRouterName
```
      The name of the virtual router to update.
- Class com.amazonaws.services.appmesh.model.UpdateVirtualRouterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - virtualRouter
```
VirtualRouterData virtualRouter
```
      A full description of the virtual router that was updated.
- Class com.amazonaws.services.appmesh.model.UpdateVirtualServiceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    - meshName
```
String meshName
```
      The name of the service mesh that the virtual service resides in.
    - spec
```
VirtualServiceSpec spec
```
      The new virtual service specification to apply. This overwrites the existing data.
    - virtualServiceName
```
String virtualServiceName
```
      The name of the virtual service to update.
- Class com.amazonaws.services.appmesh.model.UpdateVirtualServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - virtualService
```
VirtualServiceData virtualService
```
      A full description of the virtual service that was updated.
- Class com.amazonaws.services.appmesh.model.VirtualNodeData extends Object implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh that the virtual node resides in.
    - metadata
```
ResourceMetadata metadata
```
      The associated metadata for the virtual node.
    - spec
```
VirtualNodeSpec spec
```
      The specifications of the virtual node.
    - status
```
VirtualNodeStatus status
```
      The current status for the virtual node.
    - virtualNodeName
```
String virtualNodeName
```
      The name of the virtual node.
- Class com.amazonaws.services.appmesh.model.VirtualNodeRef extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The full Amazon Resource Name (ARN) for the virtual node.
    - meshName
```
String meshName
```
      The name of the service mesh that the virtual node resides in.
    - virtualNodeName
```
String virtualNodeName
```
      The name of the virtual node.
- Class com.amazonaws.services.appmesh.model.VirtualNodeServiceProvider extends Object implements Serializable
  - Serialized Fields
    - virtualNodeName
```
String virtualNodeName
```
      The name of the virtual node that is acting as a service provider.
- Class com.amazonaws.services.appmesh.model.VirtualNodeSpec extends Object implements Serializable
  - Serialized Fields
    - backends
```
List<E> backends
```
      The backends that the virtual node is expected to send outbound traffic to.
    - listeners
```
List<E> listeners
```
      The listeners that the virtual node is expected to receive inbound traffic from. You can specify one listener.
    - logging
```
Logging logging
```
      The inbound and outbound access logging information for the virtual node.
    - serviceDiscovery
```
ServiceDiscovery serviceDiscovery
```
      The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.
- Class com.amazonaws.services.appmesh.model.VirtualNodeStatus extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The current status of the virtual node.
- Class com.amazonaws.services.appmesh.model.VirtualRouterData extends Object implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh that the virtual router resides in.
    - metadata
```
ResourceMetadata metadata
```
      The associated metadata for the virtual router.
    - spec
```
VirtualRouterSpec spec
```
      The specifications of the virtual router.
    - status
```
VirtualRouterStatus status
```
      The current status of the virtual router.
    - virtualRouterName
```
String virtualRouterName
```
      The name of the virtual router.
- Class com.amazonaws.services.appmesh.model.VirtualRouterListener extends Object implements Serializable
  - Serialized Fields
    - portMapping
```
PortMapping portMapping
```
- Class com.amazonaws.services.appmesh.model.VirtualRouterRef extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The full Amazon Resource Name (ARN) for the virtual router.
    - meshName
```
String meshName
```
      The name of the service mesh that the virtual router resides in.
    - virtualRouterName
```
String virtualRouterName
```
      The name of the virtual router.
- Class com.amazonaws.services.appmesh.model.VirtualRouterServiceProvider extends Object implements Serializable
  - Serialized Fields
    - virtualRouterName
```
String virtualRouterName
```
      The name of the virtual router that is acting as a service provider.
- Class com.amazonaws.services.appmesh.model.VirtualRouterSpec extends Object implements Serializable
  - Serialized Fields
    - listeners
```
List<E> listeners
```
      The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.
- Class com.amazonaws.services.appmesh.model.VirtualRouterStatus extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The current status of the virtual router.
- Class com.amazonaws.services.appmesh.model.VirtualServiceBackend extends Object implements Serializable
  - Serialized Fields
    - virtualServiceName
```
String virtualServiceName
```
      The name of the virtual service that is acting as a virtual node backend.
- Class com.amazonaws.services.appmesh.model.VirtualServiceData extends Object implements Serializable
  - Serialized Fields
    - meshName
```
String meshName
```
      The name of the service mesh that the virtual service resides in.
    - metadata
```
ResourceMetadata metadata
```
    - spec
```
VirtualServiceSpec spec
```
      The specifications of the virtual service.
    - status
```
VirtualServiceStatus status
```
      The current status of the virtual service.
    - virtualServiceName
```
String virtualServiceName
```
      The name of the virtual service.
- Class com.amazonaws.services.appmesh.model.VirtualServiceProvider extends Object implements Serializable
  - Serialized Fields
    - virtualNode
```
VirtualNodeServiceProvider virtualNode
```
      The virtual node associated with a virtual service.
    - virtualRouter
```
VirtualRouterServiceProvider virtualRouter
```
      The virtual router associated with a virtual service.
- Class com.amazonaws.services.appmesh.model.VirtualServiceRef extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The full Amazon Resource Name (ARN) for the virtual service.
    - meshName
```
String meshName
```
      The name of the service mesh that the virtual service resides in.
    - virtualServiceName
```
String virtualServiceName
```
      The name of the virtual service.
- Class com.amazonaws.services.appmesh.model.VirtualServiceSpec extends Object implements Serializable
  - Serialized Fields
    - provider
```
VirtualServiceProvider provider
```
      The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
- Class com.amazonaws.services.appmesh.model.VirtualServiceStatus extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The current status of the virtual service.
- Class com.amazonaws.services.appmesh.model.WeightedTarget extends Object implements Serializable
  - Serialized Fields
    - virtualNode
```
String virtualNode
```
      The virtual node to associate with the weighted target.
    - weight
```
Integer weight
```
      The relative weight of the weighted target.
Package com.amazonaws.services.appstream.model
- Class com.amazonaws.services.appstream.model.AccessEndpoint extends Object implements Serializable
  - Serialized Fields
    - endpointType
```
String endpointType
```
      The type of interface endpoint.
    - vpceId
```
String vpceId
```
      The identifier (ID) of the VPC in which the interface endpoint is used.
- Class com.amazonaws.services.appstream.model.AmazonAppStreamException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appstream.model.Application extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the application.
    - displayName
```
String displayName
```
      The application name to display.
    - iconURL
```
String iconURL
```
      The URL for the application icon. This URL might be time-limited.
    - launchPath
```
String launchPath
```
      The path to the application executable in the instance.
    - launchParameters
```
String launchParameters
```
      The arguments that are passed to the application at launch.
    - enabled
```
Boolean enabled
```
      If there is a problem, the application can be disabled after image creation.
    - metadata
```
Map<K,V> metadata
```
      Additional attributes that describe the application.
- Class com.amazonaws.services.appstream.model.ApplicationSettings extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      Enables or disables persistent application settings for users during their streaming sessions.
    - settingsGroup
```
String settingsGroup
```
      The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
- Class com.amazonaws.services.appstream.model.ApplicationSettingsResponse extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      Specifies whether persistent application settings are enabled for users during their streaming sessions.
    - settingsGroup
```
String settingsGroup
```
      The path prefix for the S3 bucket where users’ persistent application settings are stored.
    - s3BucketName
```
String s3BucketName
```
      The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
- Class com.amazonaws.services.appstream.model.AssociateFleetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - fleetName
```
String fleetName
```
      The name of the fleet.
    - stackName
```
String stackName
```
      The name of the stack.
- Class com.amazonaws.services.appstream.model.AssociateFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.BatchAssociateUserStackRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userStackAssociations
```
List<E> userStackAssociations
```
      The list of UserStackAssociation objects.
- Class com.amazonaws.services.appstream.model.BatchAssociateUserStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - errors
```
List<E> errors
```
      The list of UserStackAssociationError objects.
- Class com.amazonaws.services.appstream.model.BatchDisassociateUserStackRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userStackAssociations
```
List<E> userStackAssociations
```
      The list of UserStackAssociation objects.
- Class com.amazonaws.services.appstream.model.BatchDisassociateUserStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - errors
```
List<E> errors
```
      The list of UserStackAssociationError objects.
- Class com.amazonaws.services.appstream.model.ComputeCapacity extends Object implements Serializable
  - Serialized Fields
    - desiredInstances
```
Integer desiredInstances
```
      The desired number of streaming instances.
- Class com.amazonaws.services.appstream.model.ComputeCapacityStatus extends Object implements Serializable
  - Serialized Fields
    - desired
```
Integer desired
```
      The desired number of streaming instances.
    - running
```
Integer running
```
      The total number of simultaneous streaming instances that are running.
    - inUse
```
Integer inUse
```
      The number of instances in use for streaming.
    - available
```
Integer available
```
      The number of currently available instances that can be used to stream sessions.
- Class com.amazonaws.services.appstream.model.ConcurrentModificationException extends AmazonAppStreamException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appstream.model.CopyImageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - sourceImageName
```
String sourceImageName
```
      The name of the image to copy.
    - destinationImageName
```
String destinationImageName
```
      The name that the image will have when it is copied to the destination.
    - destinationRegion
```
String destinationRegion
```
      The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.
    - destinationImageDescription
```
String destinationImageDescription
```
      The description that the image will have when it is copied to the destination.
- Class com.amazonaws.services.appstream.model.CopyImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - destinationImageName
```
String destinationImageName
```
      The name of the destination image.
- Class com.amazonaws.services.appstream.model.CreateDirectoryConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryName
```
String directoryName
```
      The fully qualified name of the directory (for example, corp.example.com).
    - organizationalUnitDistinguishedNames
```
List<E> organizationalUnitDistinguishedNames
```
      The distinguished names of the organizational units for computer accounts.
    - serviceAccountCredentials
```
ServiceAccountCredentials serviceAccountCredentials
```
      The credentials for the service account used by the fleet or image builder to connect to the directory.
- Class com.amazonaws.services.appstream.model.CreateDirectoryConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - directoryConfig
```
DirectoryConfig directoryConfig
```
      Information about the directory configuration.
- Class com.amazonaws.services.appstream.model.CreateFleetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      A unique name for the fleet.
    - imageName
```
String imageName
```
      The name of the image used to create the fleet.
    - imageArn
```
String imageArn
```
      The ARN of the public, private, or shared image to use.
    - instanceType
```
String instanceType
```
      The instance type to use when launching fleet instances. The following instance types are available:
      
      stream.standard.medium
      
      stream.standard.large
      
      stream.compute.large
      
      stream.compute.xlarge
      
      stream.compute.2xlarge
      
      stream.compute.4xlarge
      
      stream.compute.8xlarge
      
      stream.memory.large
      
      stream.memory.xlarge
      
      stream.memory.2xlarge
      
      stream.memory.4xlarge
      
      stream.memory.8xlarge
      
      stream.graphics-design.large
      
      stream.graphics-design.xlarge
      
      stream.graphics-design.2xlarge
      
      stream.graphics-design.4xlarge
      
      stream.graphics-desktop.2xlarge
      
      stream.graphics-pro.4xlarge
      
      stream.graphics-pro.8xlarge
      
      stream.graphics-pro.16xlarge
    - fleetType
```
String fleetType
```
      The fleet type.
      
      ALWAYS_ON
      
      Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.
      
      ON_DEMAND
      
      Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
    - computeCapacity
```
ComputeCapacity computeCapacity
```
      The desired capacity for the fleet.
    - vpcConfig
```
VpcConfig vpcConfig
```
      The VPC configuration for the fleet.
    - maxUserDurationInSeconds
```
Integer maxUserDurationInSeconds
```
      The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
      
      Specify a value between 600 and 360000.
    - disconnectTimeoutInSeconds
```
Integer disconnectTimeoutInSeconds
```
      The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
      
      Specify a value between 60 and 360000.
    - description
```
String description
```
      The description to display.
    - displayName
```
String displayName
```
      The fleet name to display.
    - enableDefaultInternetAccess
```
Boolean enableDefaultInternetAccess
```
      Enables or disables default internet access for the fleet.
    - domainJoinInfo
```
DomainJoinInfo domainJoinInfo
```
      The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
    - tags
```
Map<K,V> tags
```
      The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
      
      If you do not specify a value, the value is set to an empty string.
      
      Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
      
      _ . : / = + \ - @
      
      For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
    - idleDisconnectTimeoutInSeconds
```
Integer idleDisconnectTimeoutInSeconds
```
      The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
      
      To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
      
      If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
    - iamRoleArn
```
String iamRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.
      
      For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
- Class com.amazonaws.services.appstream.model.CreateFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - fleet
```
Fleet fleet
```
      Information about the fleet.
- Class com.amazonaws.services.appstream.model.CreateImageBuilderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      A unique name for the image builder.
    - imageName
```
String imageName
```
      The name of the image used to create the image builder.
    - imageArn
```
String imageArn
```
      The ARN of the public, private, or shared image to use.
    - instanceType
```
String instanceType
```
      The instance type to use when launching the image builder. The following instance types are available:
      
      stream.standard.medium
      
      stream.standard.large
      
      stream.compute.large
      
      stream.compute.xlarge
      
      stream.compute.2xlarge
      
      stream.compute.4xlarge
      
      stream.compute.8xlarge
      
      stream.memory.large
      
      stream.memory.xlarge
      
      stream.memory.2xlarge
      
      stream.memory.4xlarge
      
      stream.memory.8xlarge
      
      stream.graphics-design.large
      
      stream.graphics-design.xlarge
      
      stream.graphics-design.2xlarge
      
      stream.graphics-design.4xlarge
      
      stream.graphics-desktop.2xlarge
      
      stream.graphics-pro.4xlarge
      
      stream.graphics-pro.8xlarge
      
      stream.graphics-pro.16xlarge
    - description
```
String description
```
      The description to display.
    - displayName
```
String displayName
```
      The image builder name to display.
    - vpcConfig
```
VpcConfig vpcConfig
```
      The VPC configuration for the image builder. You can specify only one subnet.
    - iamRoleArn
```
String iamRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.
      
      For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
    - enableDefaultInternetAccess
```
Boolean enableDefaultInternetAccess
```
      Enables or disables default internet access for the image builder.
    - domainJoinInfo
```
DomainJoinInfo domainJoinInfo
```
      The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
    - appstreamAgentVersion
```
String appstreamAgentVersion
```
      The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
    - tags
```
Map<K,V> tags
```
      The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
      
      Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
      
      _ . : / = + \ - @
      
      If you do not specify a value, the value is set to an empty string.
      
      For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
    - accessEndpoints
```
List<E> accessEndpoints
```
      The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.
- Class com.amazonaws.services.appstream.model.CreateImageBuilderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - imageBuilder
```
ImageBuilder imageBuilder
```
      Information about the image builder.
- Class com.amazonaws.services.appstream.model.CreateImageBuilderStreamingURLRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the image builder.
    - validity
```
Long validity
```
      The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.
- Class com.amazonaws.services.appstream.model.CreateImageBuilderStreamingURLResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - streamingURL
```
String streamingURL
```
      The URL to start the AppStream 2.0 streaming session.
    - expires
```
Date expires
```
      The elapsed time, in seconds after the Unix epoch, when this URL expires.
- Class com.amazonaws.services.appstream.model.CreateStackRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the stack.
    - description
```
String description
```
      The description to display.
    - displayName
```
String displayName
```
      The stack name to display.
    - storageConnectors
```
List<E> storageConnectors
```
      The storage connectors to enable.
    - redirectURL
```
String redirectURL
```
      The URL that users are redirected to after their streaming session ends.
    - feedbackURL
```
String feedbackURL
```
      The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
    - userSettings
```
List<E> userSettings
```
      The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
    - applicationSettings
```
ApplicationSettings applicationSettings
```
      The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
    - tags
```
Map<K,V> tags
```
      The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
      
      If you do not specify a value, the value is set to an empty string.
      
      Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
      
      _ . : / = + \ - @
      
      For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
    - accessEndpoints
```
List<E> accessEndpoints
```
      The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
    - embedHostDomains
```
List<E> embedHostDomains
```
      The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
- Class com.amazonaws.services.appstream.model.CreateStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - stack
```
Stack stack
```
      Information about the stack.
- Class com.amazonaws.services.appstream.model.CreateStreamingURLRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name of the stack.
    - fleetName
```
String fleetName
```
      The name of the fleet.
    - userId
```
String userId
```
      The identifier of the user.
    - applicationId
```
String applicationId
```
      The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant.
    - validity
```
Long validity
```
      The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.
    - sessionContext
```
String sessionContext
```
      The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.
- Class com.amazonaws.services.appstream.model.CreateStreamingURLResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - streamingURL
```
String streamingURL
```
      The URL to start the AppStream 2.0 streaming session.
    - expires
```
Date expires
```
      The elapsed time, in seconds after the Unix epoch, when this URL expires.
- Class com.amazonaws.services.appstream.model.CreateUsageReportSubscriptionRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.appstream.model.CreateUsageReportSubscriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - s3BucketName
```
String s3BucketName
```
      The Amazon S3 bucket where generated reports are stored.
      
      If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
    - schedule
```
String schedule
```
      The schedule for generating usage reports.
- Class com.amazonaws.services.appstream.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userName
```
String userName
```
      The email address of the user.
      
      Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
    - messageAction
```
String messageAction
```
      The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.
      
      The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
    - firstName
```
String firstName
```
      The first name, or given name, of the user.
    - lastName
```
String lastName
```
      The last name, or surname, of the user.
    - authenticationType
```
String authenticationType
```
      The authentication type for the user. You must specify USERPOOL.
- Class com.amazonaws.services.appstream.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.DeleteDirectoryConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryName
```
String directoryName
```
      The name of the directory configuration.
- Class com.amazonaws.services.appstream.model.DeleteDirectoryConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.DeleteFleetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the fleet.
- Class com.amazonaws.services.appstream.model.DeleteFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.DeleteImageBuilderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the image builder.
- Class com.amazonaws.services.appstream.model.DeleteImageBuilderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - imageBuilder
```
ImageBuilder imageBuilder
```
      Information about the image builder.
- Class com.amazonaws.services.appstream.model.DeleteImagePermissionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the private image.
    - sharedAccountId
```
String sharedAccountId
```
      The 12-digit identifier of the AWS account for which to delete image permissions.
- Class com.amazonaws.services.appstream.model.DeleteImagePermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.DeleteImageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the image.
- Class com.amazonaws.services.appstream.model.DeleteImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - image
```
Image image
```
      Information about the image.
- Class com.amazonaws.services.appstream.model.DeleteStackRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the stack.
- Class com.amazonaws.services.appstream.model.DeleteStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.DeleteUsageReportSubscriptionRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.appstream.model.DeleteUsageReportSubscriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userName
```
String userName
```
      The email address of the user.
      
      Users' email addresses are case-sensitive.
    - authenticationType
```
String authenticationType
```
      The authentication type for the user. You must specify USERPOOL.
- Class com.amazonaws.services.appstream.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.DescribeDirectoryConfigsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryNames
```
List<E> directoryNames
```
      The directory names.
    - maxResults
```
Integer maxResults
```
      The maximum size of each page of results.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- Class com.amazonaws.services.appstream.model.DescribeDirectoryConfigsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - directoryConfigs
```
List<E> directoryConfigs
```
      Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- Class com.amazonaws.services.appstream.model.DescribeFleetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - names
```
List<E> names
```
      The names of the fleets to describe.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- Class com.amazonaws.services.appstream.model.DescribeFleetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - fleets
```
List<E> fleets
```
      Information about the fleets.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- Class com.amazonaws.services.appstream.model.DescribeImageBuildersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - names
```
List<E> names
```
      The names of the image builders to describe.
    - maxResults
```
Integer maxResults
```
      The maximum size of each page of results.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- Class com.amazonaws.services.appstream.model.DescribeImageBuildersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - imageBuilders
```
List<E> imageBuilders
```
      Information about the image builders.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- Class com.amazonaws.services.appstream.model.DescribeImagePermissionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the private image for which to describe permissions. The image must be one that you own.
    - maxResults
```
Integer maxResults
```
      The maximum size of each page of results.
    - sharedAwsAccountIds
```
List<E> sharedAwsAccountIds
```
      The 12-digit identifier of one or more AWS accounts with which the image is shared.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- Class com.amazonaws.services.appstream.model.DescribeImagePermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the private image.
    - sharedImagePermissionsList
```
List<E> sharedImagePermissionsList
```
      The permissions for a private image that you own.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- Class com.amazonaws.services.appstream.model.DescribeImagesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - names
```
List<E> names
```
      The names of the public or private images to describe.
    - arns
```
List<E> arns
```
      The ARNs of the public, private, and shared images to describe.
    - type
```
String type
```
      The type of image (public, private, or shared) to describe.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
    - maxResults
```
Integer maxResults
```
      The maximum size of each page of results.
- Class com.amazonaws.services.appstream.model.DescribeImagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - images
```
List<E> images
```
      Information about the images.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- Class com.amazonaws.services.appstream.model.DescribeSessionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name of the stack. This value is case-sensitive.
    - fleetName
```
String fleetName
```
      The name of the fleet. This value is case-sensitive.
    - userId
```
String userId
```
      The user identifier.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
    - limit
```
Integer limit
```
      The size of each page of results. The default value is 20 and the maximum value is 50.
    - authenticationType
```
String authenticationType
```
      The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.
- Class com.amazonaws.services.appstream.model.DescribeSessionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - sessions
```
List<E> sessions
```
      Information about the streaming sessions.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- Class com.amazonaws.services.appstream.model.DescribeStacksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - names
```
List<E> names
```
      The names of the stacks to describe.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- Class com.amazonaws.services.appstream.model.DescribeStacksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - stacks
```
List<E> stacks
```
      Information about the stacks.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- Class com.amazonaws.services.appstream.model.DescribeUsageReportSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum size of each page of results.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- Class com.amazonaws.services.appstream.model.DescribeUsageReportSubscriptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - usageReportSubscriptions
```
List<E> usageReportSubscriptions
```
      Information about the usage report subscription.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- Class com.amazonaws.services.appstream.model.DescribeUsersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - authenticationType
```
String authenticationType
```
      The authentication type for the users in the user pool to describe. You must specify USERPOOL.
    - maxResults
```
Integer maxResults
```
      The maximum size of each page of results.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- Class com.amazonaws.services.appstream.model.DescribeUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - users
```
List<E> users
```
      Information about users in the user pool.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- Class com.amazonaws.services.appstream.model.DescribeUserStackAssociationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name of the stack that is associated with the user.
    - userName
```
String userName
```
      The email address of the user who is associated with the stack.
      
      Users' email addresses are case-sensitive.
    - authenticationType
```
String authenticationType
```
      The authentication type for the user who is associated with the stack. You must specify USERPOOL.
    - maxResults
```
Integer maxResults
```
      The maximum size of each page of results.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- Class com.amazonaws.services.appstream.model.DescribeUserStackAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - userStackAssociations
```
List<E> userStackAssociations
```
      The UserStackAssociation objects.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- Class com.amazonaws.services.appstream.model.DirectoryConfig extends Object implements Serializable
  - Serialized Fields
    - directoryName
```
String directoryName
```
      The fully qualified name of the directory (for example, corp.example.com).
    - organizationalUnitDistinguishedNames
```
List<E> organizationalUnitDistinguishedNames
```
      The distinguished names of the organizational units for computer accounts.
    - serviceAccountCredentials
```
ServiceAccountCredentials serviceAccountCredentials
```
      The credentials for the service account used by the fleet or image builder to connect to the directory.
    - createdTime
```
Date createdTime
```
      The time the directory configuration was created.
- Class com.amazonaws.services.appstream.model.DisableUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userName
```
String userName
```
      The email address of the user.
      
      Users' email addresses are case-sensitive.
    - authenticationType
```
String authenticationType
```
      The authentication type for the user. You must specify USERPOOL.
- Class com.amazonaws.services.appstream.model.DisableUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.DisassociateFleetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - fleetName
```
String fleetName
```
      The name of the fleet.
    - stackName
```
String stackName
```
      The name of the stack.
- Class com.amazonaws.services.appstream.model.DisassociateFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.DomainJoinInfo extends Object implements Serializable
  - Serialized Fields
    - directoryName
```
String directoryName
```
      The fully qualified name of the directory (for example, corp.example.com).
    - organizationalUnitDistinguishedName
```
String organizationalUnitDistinguishedName
```
      The distinguished name of the organizational unit for computer accounts.
- Class com.amazonaws.services.appstream.model.EnableUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userName
```
String userName
```
      The email address of the user.
      
      Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
    - authenticationType
```
String authenticationType
```
      The authentication type for the user. You must specify USERPOOL.
- Class com.amazonaws.services.appstream.model.EnableUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.ExpireSessionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - sessionId
```
String sessionId
```
      The identifier of the streaming session.
- Class com.amazonaws.services.appstream.model.ExpireSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.Fleet extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) for the fleet.
    - name
```
String name
```
      The name of the fleet.
    - displayName
```
String displayName
```
      The fleet name to display.
    - description
```
String description
```
      The description to display.
    - imageName
```
String imageName
```
      The name of the image used to create the fleet.
    - imageArn
```
String imageArn
```
      The ARN for the public, private, or shared image.
    - instanceType
```
String instanceType
```
      The instance type to use when launching fleet instances. The following instance types are available:
      
      stream.standard.medium
      
      stream.standard.large
      
      stream.compute.large
      
      stream.compute.xlarge
      
      stream.compute.2xlarge
      
      stream.compute.4xlarge
      
      stream.compute.8xlarge
      
      stream.memory.large
      
      stream.memory.xlarge
      
      stream.memory.2xlarge
      
      stream.memory.4xlarge
      
      stream.memory.8xlarge
      
      stream.graphics-design.large
      
      stream.graphics-design.xlarge
      
      stream.graphics-design.2xlarge
      
      stream.graphics-design.4xlarge
      
      stream.graphics-desktop.2xlarge
      
      stream.graphics-pro.4xlarge
      
      stream.graphics-pro.8xlarge
      
      stream.graphics-pro.16xlarge
    - fleetType
```
String fleetType
```
      The fleet type.
      
      ALWAYS_ON
      
      Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.
      
      ON_DEMAND
      
      Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
    - computeCapacityStatus
```
ComputeCapacityStatus computeCapacityStatus
```
      The capacity status for the fleet.
    - maxUserDurationInSeconds
```
Integer maxUserDurationInSeconds
```
      The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
      
      Specify a value between 600 and 360000.
    - disconnectTimeoutInSeconds
```
Integer disconnectTimeoutInSeconds
```
      The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
      
      Specify a value between 60 and 360000.
    - state
```
String state
```
      The current state for the fleet.
    - vpcConfig
```
VpcConfig vpcConfig
```
      The VPC configuration for the fleet.
    - createdTime
```
Date createdTime
```
      The time the fleet was created.
    - fleetErrors
```
List<E> fleetErrors
```
      The fleet errors.
    - enableDefaultInternetAccess
```
Boolean enableDefaultInternetAccess
```
      Indicates whether default internet access is enabled for the fleet.
    - domainJoinInfo
```
DomainJoinInfo domainJoinInfo
```
      The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
    - idleDisconnectTimeoutInSeconds
```
Integer idleDisconnectTimeoutInSeconds
```
      The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
      
      To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
      
      If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
    - iamRoleArn
```
String iamRoleArn
```
      The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.
      
      For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
- Class com.amazonaws.services.appstream.model.FleetError extends Object implements Serializable
  - Serialized Fields
    - errorCode
```
String errorCode
```
      The error code.
    - errorMessage
```
String errorMessage
```
      The error message.
- Class com.amazonaws.services.appstream.model.Image extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the image.
    - arn
```
String arn
```
      The ARN of the image.
    - baseImageArn
```
String baseImageArn
```
      The ARN of the image from which this image was created.
    - displayName
```
String displayName
```
      The image name to display.
    - state
```
String state
```
      The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.
    - visibility
```
String visibility
```
      Indicates whether the image is public or private.
    - imageBuilderSupported
```
Boolean imageBuilderSupported
```
      Indicates whether an image builder can be launched from this image.
    - imageBuilderName
```
String imageBuilderName
```
      The name of the image builder that was used to create the private image. If the image is shared, this value is null.
    - platform
```
String platform
```
      The operating system platform of the image.
    - description
```
String description
```
      The description to display.
    - stateChangeReason
```
ImageStateChangeReason stateChangeReason
```
      The reason why the last state change occurred.
    - applications
```
List<E> applications
```
      The applications associated with the image.
    - createdTime
```
Date createdTime
```
      The time the image was created.
    - publicBaseImageReleasedDate
```
Date publicBaseImageReleasedDate
```
      The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
    - appstreamAgentVersion
```
String appstreamAgentVersion
```
      The version of the AppStream 2.0 agent to use for instances that are launched from this image.
    - imagePermissions
```
ImagePermissions imagePermissions
```
      The permissions to provide to the destination AWS account for the specified image.
- Class com.amazonaws.services.appstream.model.ImageBuilder extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the image builder.
    - arn
```
String arn
```
      The ARN for the image builder.
    - imageArn
```
String imageArn
```
      The ARN of the image from which this builder was created.
    - description
```
String description
```
      The description to display.
    - displayName
```
String displayName
```
      The image builder name to display.
    - vpcConfig
```
VpcConfig vpcConfig
```
      The VPC configuration of the image builder.
    - instanceType
```
String instanceType
```
      The instance type for the image builder. The following instance types are available:
      
      stream.standard.medium
      
      stream.standard.large
      
      stream.compute.large
      
      stream.compute.xlarge
      
      stream.compute.2xlarge
      
      stream.compute.4xlarge
      
      stream.compute.8xlarge
      
      stream.memory.large
      
      stream.memory.xlarge
      
      stream.memory.2xlarge
      
      stream.memory.4xlarge
      
      stream.memory.8xlarge
      
      stream.graphics-design.large
      
      stream.graphics-design.xlarge
      
      stream.graphics-design.2xlarge
      
      stream.graphics-design.4xlarge
      
      stream.graphics-desktop.2xlarge
      
      stream.graphics-pro.4xlarge
      
      stream.graphics-pro.8xlarge
      
      stream.graphics-pro.16xlarge
    - platform
```
String platform
```
      The operating system platform of the image builder.
    - iamRoleArn
```
String iamRoleArn
```
      The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.
      
      For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
    - state
```
String state
```
      The state of the image builder.
    - stateChangeReason
```
ImageBuilderStateChangeReason stateChangeReason
```
      The reason why the last state change occurred.
    - createdTime
```
Date createdTime
```
      The time stamp when the image builder was created.
    - enableDefaultInternetAccess
```
Boolean enableDefaultInternetAccess
```
      Enables or disables default internet access for the image builder.
    - domainJoinInfo
```
DomainJoinInfo domainJoinInfo
```
      The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
    - networkAccessConfiguration
```
NetworkAccessConfiguration networkAccessConfiguration
```
    - imageBuilderErrors
```
List<E> imageBuilderErrors
```
      The image builder errors.
    - appstreamAgentVersion
```
String appstreamAgentVersion
```
      The version of the AppStream 2.0 agent that is currently being used by the image builder.
    - accessEndpoints
```
List<E> accessEndpoints
```
      The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
- Class com.amazonaws.services.appstream.model.ImageBuilderStateChangeReason extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The state change reason code.
    - message
```
String message
```
      The state change reason message.
- Class com.amazonaws.services.appstream.model.ImagePermissions extends Object implements Serializable
  - Serialized Fields
    - allowFleet
```
Boolean allowFleet
```
      Indicates whether the image can be used for a fleet.
    - allowImageBuilder
```
Boolean allowImageBuilder
```
      Indicates whether the image can be used for an image builder.
- Class com.amazonaws.services.appstream.model.ImageStateChangeReason extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The state change reason code.
    - message
```
String message
```
      The state change reason message.
- Class com.amazonaws.services.appstream.model.IncompatibleImageException extends AmazonAppStreamException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appstream.model.InvalidAccountStatusException extends AmazonAppStreamException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appstream.model.InvalidParameterCombinationException extends AmazonAppStreamException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appstream.model.InvalidRoleException extends AmazonAppStreamException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appstream.model.LastReportGenerationExecutionError extends Object implements Serializable
  - Serialized Fields
    - errorCode
```
String errorCode
```
      The error code for the error that is returned when a usage report can't be generated.
    - errorMessage
```
String errorMessage
```
      The error message for the error that is returned when a usage report can't be generated.
- Class com.amazonaws.services.appstream.model.LimitExceededException extends AmazonAppStreamException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appstream.model.ListAssociatedFleetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name of the stack.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- Class com.amazonaws.services.appstream.model.ListAssociatedFleetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - names
```
List<E> names
```
      The name of the fleet.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- Class com.amazonaws.services.appstream.model.ListAssociatedStacksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - fleetName
```
String fleetName
```
      The name of the fleet.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- Class com.amazonaws.services.appstream.model.ListAssociatedStacksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - names
```
List<E> names
```
      The name of the stack.
    - nextToken
```
String nextToken
```
      The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- Class com.amazonaws.services.appstream.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource.
- Class com.amazonaws.services.appstream.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      The information about the tags.
- Class com.amazonaws.services.appstream.model.NetworkAccessConfiguration extends Object implements Serializable
  - Serialized Fields
    - eniPrivateIpAddress
```
String eniPrivateIpAddress
```
      The private IP address of the elastic network interface that is attached to instances in your VPC.
    - eniId
```
String eniId
```
      The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
- Class com.amazonaws.services.appstream.model.OperationNotPermittedException extends AmazonAppStreamException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appstream.model.ResourceAlreadyExistsException extends AmazonAppStreamException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appstream.model.ResourceError extends Object implements Serializable
  - Serialized Fields
    - errorCode
```
String errorCode
```
      The error code.
    - errorMessage
```
String errorMessage
```
      The error message.
    - errorTimestamp
```
Date errorTimestamp
```
      The time the error occurred.
- Class com.amazonaws.services.appstream.model.ResourceInUseException extends AmazonAppStreamException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appstream.model.ResourceNotAvailableException extends AmazonAppStreamException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appstream.model.ResourceNotFoundException extends AmazonAppStreamException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appstream.model.ServiceAccountCredentials extends Object implements Serializable
  - Serialized Fields
    - accountName
```
String accountName
```
      The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
    - accountPassword
```
String accountPassword
```
      The password for the account.
- Class com.amazonaws.services.appstream.model.Session extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the streaming session.
    - userId
```
String userId
```
      The identifier of the user for whom the session was created.
    - stackName
```
String stackName
```
      The name of the stack for the streaming session.
    - fleetName
```
String fleetName
```
      The name of the fleet for the streaming session.
    - state
```
String state
```
      The current state of the streaming session.
    - connectionState
```
String connectionState
```
      Specifies whether a user is connected to the streaming session.
    - startTime
```
Date startTime
```
      The time when a streaming instance is dedicated for the user.
    - maxExpirationTime
```
Date maxExpirationTime
```
      The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.
    - authenticationType
```
String authenticationType
```
      The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).
    - networkAccessConfiguration
```
NetworkAccessConfiguration networkAccessConfiguration
```
      The network details for the streaming session.
- Class com.amazonaws.services.appstream.model.SharedImagePermissions extends Object implements Serializable
  - Serialized Fields
    - sharedAccountId
```
String sharedAccountId
```
      The 12-digit identifier of the AWS account with which the image is shared.
    - imagePermissions
```
ImagePermissions imagePermissions
```
      Describes the permissions for a shared image.
- Class com.amazonaws.services.appstream.model.Stack extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the stack.
    - name
```
String name
```
      The name of the stack.
    - description
```
String description
```
      The description to display.
    - displayName
```
String displayName
```
      The stack name to display.
    - createdTime
```
Date createdTime
```
      The time the stack was created.
    - storageConnectors
```
List<E> storageConnectors
```
      The storage connectors to enable.
    - redirectURL
```
String redirectURL
```
      The URL that users are redirected to after their streaming session ends.
    - feedbackURL
```
String feedbackURL
```
      The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
    - stackErrors
```
List<E> stackErrors
```
      The errors for the stack.
    - userSettings
```
List<E> userSettings
```
      The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
    - applicationSettings
```
ApplicationSettingsResponse applicationSettings
```
      The persistent application settings for users of the stack.
    - accessEndpoints
```
List<E> accessEndpoints
```
      The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
    - embedHostDomains
```
List<E> embedHostDomains
```
      The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
- Class com.amazonaws.services.appstream.model.StackError extends Object implements Serializable
  - Serialized Fields
    - errorCode
```
String errorCode
```
      The error code.
    - errorMessage
```
String errorMessage
```
      The error message.
- Class com.amazonaws.services.appstream.model.StartFleetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the fleet.
- Class com.amazonaws.services.appstream.model.StartFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.StartImageBuilderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the image builder.
    - appstreamAgentVersion
```
String appstreamAgentVersion
```
      The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
- Class com.amazonaws.services.appstream.model.StartImageBuilderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - imageBuilder
```
ImageBuilder imageBuilder
```
      Information about the image builder.
- Class com.amazonaws.services.appstream.model.StopFleetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the fleet.
- Class com.amazonaws.services.appstream.model.StopFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.StopImageBuilderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the image builder.
- Class com.amazonaws.services.appstream.model.StopImageBuilderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - imageBuilder
```
ImageBuilder imageBuilder
```
      Information about the image builder.
- Class com.amazonaws.services.appstream.model.StorageConnector extends Object implements Serializable
  - Serialized Fields
    - connectorType
```
String connectorType
```
      The type of storage connector.
    - resourceIdentifier
```
String resourceIdentifier
```
      The ARN of the storage connector.
    - domains
```
List<E> domains
```
      The names of the domains for the account.
- Class com.amazonaws.services.appstream.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource.
    - tags
```
Map<K,V> tags
```
      The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.
      
      If you do not specify a value, the value is set to an empty string.
      
      Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:
      
      _ . : / = + \ - @
- Class com.amazonaws.services.appstream.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource.
    - tagKeys
```
List<E> tagKeys
```
      The tag keys for the tags to disassociate.
- Class com.amazonaws.services.appstream.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.UpdateDirectoryConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryName
```
String directoryName
```
      The name of the Directory Config object.
    - organizationalUnitDistinguishedNames
```
List<E> organizationalUnitDistinguishedNames
```
      The distinguished names of the organizational units for computer accounts.
    - serviceAccountCredentials
```
ServiceAccountCredentials serviceAccountCredentials
```
      The credentials for the service account used by the fleet or image builder to connect to the directory.
- Class com.amazonaws.services.appstream.model.UpdateDirectoryConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - directoryConfig
```
DirectoryConfig directoryConfig
```
      Information about the Directory Config object.
- Class com.amazonaws.services.appstream.model.UpdateFleetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - imageName
```
String imageName
```
      The name of the image used to create the fleet.
    - imageArn
```
String imageArn
```
      The ARN of the public, private, or shared image to use.
    - name
```
String name
```
      A unique name for the fleet.
    - instanceType
```
String instanceType
```
      The instance type to use when launching fleet instances. The following instance types are available:
      
      stream.standard.medium
      
      stream.standard.large
      
      stream.compute.large
      
      stream.compute.xlarge
      
      stream.compute.2xlarge
      
      stream.compute.4xlarge
      
      stream.compute.8xlarge
      
      stream.memory.large
      
      stream.memory.xlarge
      
      stream.memory.2xlarge
      
      stream.memory.4xlarge
      
      stream.memory.8xlarge
      
      stream.graphics-design.large
      
      stream.graphics-design.xlarge
      
      stream.graphics-design.2xlarge
      
      stream.graphics-design.4xlarge
      
      stream.graphics-desktop.2xlarge
      
      stream.graphics-pro.4xlarge
      
      stream.graphics-pro.8xlarge
      
      stream.graphics-pro.16xlarge
    - computeCapacity
```
ComputeCapacity computeCapacity
```
      The desired capacity for the fleet.
    - vpcConfig
```
VpcConfig vpcConfig
```
      The VPC configuration for the fleet.
    - maxUserDurationInSeconds
```
Integer maxUserDurationInSeconds
```
      The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.
      
      Specify a value between 600 and 360000.
    - disconnectTimeoutInSeconds
```
Integer disconnectTimeoutInSeconds
```
      The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.
      
      Specify a value between 60 and 360000.
    - deleteVpcConfig
```
Boolean deleteVpcConfig
```
      Deprecated.
      
      Deletes the VPC association for the specified fleet.
    - description
```
String description
```
      The description to display.
    - displayName
```
String displayName
```
      The fleet name to display.
    - enableDefaultInternetAccess
```
Boolean enableDefaultInternetAccess
```
      Enables or disables default internet access for the fleet.
    - domainJoinInfo
```
DomainJoinInfo domainJoinInfo
```
      The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
    - idleDisconnectTimeoutInSeconds
```
Integer idleDisconnectTimeoutInSeconds
```
      The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.
      
      To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.
      
      If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
    - attributesToDelete
```
List<E> attributesToDelete
```
      The fleet attributes to delete.
    - iamRoleArn
```
String iamRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.
      
      For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
- Class com.amazonaws.services.appstream.model.UpdateFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - fleet
```
Fleet fleet
```
      Information about the fleet.
- Class com.amazonaws.services.appstream.model.UpdateImagePermissionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the private image.
    - sharedAccountId
```
String sharedAccountId
```
      The 12-digit identifier of the AWS account for which you want add or update image permissions.
    - imagePermissions
```
ImagePermissions imagePermissions
```
      The permissions for the image.
- Class com.amazonaws.services.appstream.model.UpdateImagePermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appstream.model.UpdateStackRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - displayName
```
String displayName
```
      The stack name to display.
    - description
```
String description
```
      The description to display.
    - name
```
String name
```
      The name of the stack.
    - storageConnectors
```
List<E> storageConnectors
```
      The storage connectors to enable.
    - deleteStorageConnectors
```
Boolean deleteStorageConnectors
```
      Deprecated.
      
      Deletes the storage connectors currently enabled for the stack.
    - redirectURL
```
String redirectURL
```
      The URL that users are redirected to after their streaming session ends.
    - feedbackURL
```
String feedbackURL
```
      The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
    - attributesToDelete
```
List<E> attributesToDelete
```
      The stack attributes to delete.
    - userSettings
```
List<E> userSettings
```
      The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
    - applicationSettings
```
ApplicationSettings applicationSettings
```
      The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
    - accessEndpoints
```
List<E> accessEndpoints
```
      The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
    - embedHostDomains
```
List<E> embedHostDomains
```
      The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
- Class com.amazonaws.services.appstream.model.UpdateStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - stack
```
Stack stack
```
      Information about the stack.
- Class com.amazonaws.services.appstream.model.UsageReportSubscription extends Object implements Serializable
  - Serialized Fields
    - s3BucketName
```
String s3BucketName
```
      The Amazon S3 bucket where generated reports are stored.
      
      If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
    - schedule
```
String schedule
```
      The schedule for generating usage reports.
    - lastGeneratedReportDate
```
Date lastGeneratedReportDate
```
      The time when the last usage report was generated.
    - subscriptionErrors
```
List<E> subscriptionErrors
```
      The errors that were returned if usage reports couldn't be generated.
- Class com.amazonaws.services.appstream.model.User extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The ARN of the user.
    - userName
```
String userName
```
      The email address of the user.
      
      Users' email addresses are case-sensitive.
    - enabled
```
Boolean enabled
```
      Specifies whether the user in the user pool is enabled.
    - status
```
String status
```
      The status of the user in the user pool. The status can be one of the following:
      
      UNCONFIRMED – The user is created but not confirmed.
      
      CONFIRMED – The user is confirmed.
      
      ARCHIVED – The user is no longer active.
      
      COMPROMISED – The user is disabled because of a potential security threat.
      
      UNKNOWN – The user status is not known.
    - firstName
```
String firstName
```
      The first name, or given name, of the user.
    - lastName
```
String lastName
```
      The last name, or surname, of the user.
    - createdTime
```
Date createdTime
```
      The date and time the user was created in the user pool.
    - authenticationType
```
String authenticationType
```
      The authentication type for the user.
- Class com.amazonaws.services.appstream.model.UserSetting extends Object implements Serializable
  - Serialized Fields
    - action
```
String action
```
      The action that is enabled or disabled.
    - permission
```
String permission
```
      Indicates whether the action is enabled or disabled.
- Class com.amazonaws.services.appstream.model.UserStackAssociation extends Object implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name of the stack that is associated with the user.
    - userName
```
String userName
```
      The email address of the user who is associated with the stack.
      
      Users' email addresses are case-sensitive.
    - authenticationType
```
String authenticationType
```
      The authentication type for the user.
    - sendEmailNotification
```
Boolean sendEmailNotification
```
      Specifies whether a welcome email is sent to a user after the user is created in the user pool.
- Class com.amazonaws.services.appstream.model.UserStackAssociationError extends Object implements Serializable
  - Serialized Fields
    - userStackAssociation
```
UserStackAssociation userStackAssociation
```
      Information about the user and associated stack.
    - errorCode
```
String errorCode
```
      The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.
    - errorMessage
```
String errorMessage
```
      The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.
- Class com.amazonaws.services.appstream.model.VpcConfig extends Object implements Serializable
  - Serialized Fields
    - subnetIds
```
List<E> subnetIds
```
      The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
    - securityGroupIds
```
List<E> securityGroupIds
```
      The identifiers of the security groups for the fleet or image builder.
Package com.amazonaws.services.appsync.model
- Class com.amazonaws.services.appsync.model.AccessDeniedException extends AWSAppSyncException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appsync.model.AdditionalAuthenticationProvider extends Object implements Serializable
  - Serialized Fields
    - authenticationType
```
String authenticationType
```
      The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
    - openIDConnectConfig
```
OpenIDConnectConfig openIDConnectConfig
```
      The OpenID Connect configuration.
    - userPoolConfig
```
CognitoUserPoolConfig userPoolConfig
```
      The Amazon Cognito user pool configuration.
- Class com.amazonaws.services.appsync.model.ApiCache extends Object implements Serializable
  - Serialized Fields
    - ttl
```
Long ttl
```
      TTL in seconds for cache entries.
      
      Valid values are between 1 and 3600 seconds.
    - apiCachingBehavior
```
String apiCachingBehavior
```
      Caching behavior.
      
      FULL_REQUEST_CACHING: All requests are fully cached.
      
      PER_RESOLVER_CACHING: Individual resovlers that you specify are cached.
    - transitEncryptionEnabled
```
Boolean transitEncryptionEnabled
```
      Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
    - atRestEncryptionEnabled
```
Boolean atRestEncryptionEnabled
```
      At rest encryption flag for cache. This setting cannot be updated after creation.
    - type
```
String type
```
      The cache instance type.
      
      T2_SMALL: A t2.small instance type.
      
      T2_MEDIUM: A t2.medium instance type.
      
      R4_LARGE: A r4.large instance type.
      
      R4_XLARGE: A r4.xlarge instance type.
      
      R4_2XLARGE: A r4.2xlarge instance type.
      
      R4_4XLARGE: A r4.4xlarge instance type.
      
      R4_8XLARGE: A r4.8xlarge instance type.
    - status
```
String status
```
      The cache instance status.
      
      AVAILABLE: The instance is available for use.
      
      CREATING: The instance is currently creating.
      
      DELETING: The instance is currently deleting.
      
      MODIFYING: The instance is currently modifying.
      
      FAILED: The instance has failed creation.
- Class com.amazonaws.services.appsync.model.ApiKey extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API key ID.
    - description
```
String description
```
      A description of the purpose of the API key.
    - expires
```
Long expires
```
      The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
- Class com.amazonaws.services.appsync.model.ApiKeyLimitExceededException extends AWSAppSyncException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appsync.model.ApiKeyValidityOutOfBoundsException extends AWSAppSyncException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appsync.model.ApiLimitExceededException extends AWSAppSyncException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appsync.model.AuthorizationConfig extends Object implements Serializable
  - Serialized Fields
    - authorizationType
```
String authorizationType
```
      The authorization type required by the HTTP endpoint.
      
      AWS_IAM: The authorization type is Sigv4.
    - awsIamConfig
```
AwsIamConfig awsIamConfig
```
      The AWS IAM settings.
- Class com.amazonaws.services.appsync.model.AWSAppSyncException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appsync.model.AwsIamConfig extends Object implements Serializable
  - Serialized Fields
    - signingRegion
```
String signingRegion
```
      The signing region for AWS IAM authorization.
    - signingServiceName
```
String signingServiceName
```
      The signing service name for AWS IAM authorization.
- Class com.amazonaws.services.appsync.model.BadRequestException extends AWSAppSyncException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appsync.model.CachingConfig extends Object implements Serializable
  - Serialized Fields
    - ttl
```
Long ttl
```
      The TTL in seconds for a resolver that has caching enabled.
      
      Valid values are between 1 and 3600 seconds.
    - cachingKeys
```
List<E> cachingKeys
```
      The caching keys for a resolver that has caching enabled.
      
      Valid values are entries from the $context.identity and $context.arguments maps.
- Class com.amazonaws.services.appsync.model.CognitoUserPoolConfig extends Object implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - awsRegion
```
String awsRegion
```
      The AWS Region in which the user pool was created.
    - appIdClientRegex
```
String appIdClientRegex
```
      A regular expression for validating the incoming Amazon Cognito user pool app client ID.
- Class com.amazonaws.services.appsync.model.ConcurrentModificationException extends AWSAppSyncException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appsync.model.CreateApiCacheRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The GraphQL API Id.
    - ttl
```
Long ttl
```
      TTL in seconds for cache entries.
      
      Valid values are between 1 and 3600 seconds.
    - transitEncryptionEnabled
```
Boolean transitEncryptionEnabled
```
      Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
    - atRestEncryptionEnabled
```
Boolean atRestEncryptionEnabled
```
      At rest encryption flag for cache. This setting cannot be updated after creation.
    - apiCachingBehavior
```
String apiCachingBehavior
```
      Caching behavior.
      
      FULL_REQUEST_CACHING: All requests are fully cached.
      
      PER_RESOLVER_CACHING: Individual resovlers that you specify are cached.
    - type
```
String type
```
      The cache instance type.
      
      T2_SMALL: A t2.small instance type.
      
      T2_MEDIUM: A t2.medium instance type.
      
      R4_LARGE: A r4.large instance type.
      
      R4_XLARGE: A r4.xlarge instance type.
      
      R4_2XLARGE: A r4.2xlarge instance type.
      
      R4_4XLARGE: A r4.4xlarge instance type.
      
      R4_8XLARGE: A r4.8xlarge instance type.
- Class com.amazonaws.services.appsync.model.CreateApiCacheResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiCache
```
ApiCache apiCache
```
      The ApiCache object.
- Class com.amazonaws.services.appsync.model.CreateApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The ID for your GraphQL API.
    - description
```
String description
```
      A description of the purpose of the API key.
    - expires
```
Long expires
```
      The time from creation time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .
- Class com.amazonaws.services.appsync.model.CreateApiKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiKey
```
ApiKey apiKey
```
      The API key.
- Class com.amazonaws.services.appsync.model.CreateDataSourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID for the GraphQL API for the DataSource.
    - name
```
String name
```
      A user-supplied name for the DataSource.
    - description
```
String description
```
      A description of the DataSource.
    - type
```
String type
```
      The type of the DataSource.
    - serviceRoleArn
```
String serviceRoleArn
```
      The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
    - dynamodbConfig
```
DynamodbDataSourceConfig dynamodbConfig
```
      Amazon DynamoDB settings.
    - lambdaConfig
```
LambdaDataSourceConfig lambdaConfig
```
      AWS Lambda settings.
    - elasticsearchConfig
```
ElasticsearchDataSourceConfig elasticsearchConfig
```
      Amazon Elasticsearch Service settings.
    - httpConfig
```
HttpDataSourceConfig httpConfig
```
      HTTP endpoint settings.
    - relationalDatabaseConfig
```
RelationalDatabaseDataSourceConfig relationalDatabaseConfig
```
      Relational database settings.
- Class com.amazonaws.services.appsync.model.CreateDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - dataSource
```
DataSource dataSource
```
      The DataSource object.
- Class com.amazonaws.services.appsync.model.CreateFunctionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The GraphQL API ID.
    - name
```
String name
```
      The Function name. The function name does not have to be unique.
    - description
```
String description
```
      The Function description.
    - dataSourceName
```
String dataSourceName
```
      The Function DataSource name.
    - requestMappingTemplate
```
String requestMappingTemplate
```
      The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
    - responseMappingTemplate
```
String responseMappingTemplate
```
      The Function response mapping template.
    - functionVersion
```
String functionVersion
```
      The version of the request mapping template. Currently the supported value is 2018-05-29.
- Class com.amazonaws.services.appsync.model.CreateFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - functionConfiguration
```
FunctionConfiguration functionConfiguration
```
      The Function object.
- Class com.amazonaws.services.appsync.model.CreateGraphqlApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      A user-supplied name for the GraphqlApi.
    - logConfig
```
LogConfig logConfig
```
      The Amazon CloudWatch Logs configuration.
    - authenticationType
```
String authenticationType
```
      The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
    - userPoolConfig
```
UserPoolConfig userPoolConfig
```
      The Amazon Cognito user pool configuration.
    - openIDConnectConfig
```
OpenIDConnectConfig openIDConnectConfig
```
      The OpenID Connect configuration.
    - tags
```
Map<K,V> tags
```
      A TagMap object.
    - additionalAuthenticationProviders
```
List<E> additionalAuthenticationProviders
```
      A list of additional authentication providers for the GraphqlApi API.
- Class com.amazonaws.services.appsync.model.CreateGraphqlApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - graphqlApi
```
GraphqlApi graphqlApi
```
      The GraphqlApi.
- Class com.amazonaws.services.appsync.model.CreateResolverRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The ID for the GraphQL API for which the resolver is being created.
    - typeName
```
String typeName
```
      The name of the Type.
    - fieldName
```
String fieldName
```
      The name of the field to attach the resolver to.
    - dataSourceName
```
String dataSourceName
```
      The name of the data source for which the resolver is being created.
    - requestMappingTemplate
```
String requestMappingTemplate
```
      The mapping template to be used for requests.
      
      A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
    - responseMappingTemplate
```
String responseMappingTemplate
```
      The mapping template to be used for responses from the data source.
    - kind
```
String kind
```
      The resolver type.
      
      UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
      
      PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
    - pipelineConfig
```
PipelineConfig pipelineConfig
```
      The PipelineConfig.
    - syncConfig
```
SyncConfig syncConfig
```
      The SyncConfig for a resolver attached to a versioned datasource.
    - cachingConfig
```
CachingConfig cachingConfig
```
      The caching configuration for the resolver.
- Class com.amazonaws.services.appsync.model.CreateResolverResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resolver
```
Resolver resolver
```
      The Resolver object.
- Class com.amazonaws.services.appsync.model.CreateTypeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - definition
```
String definition
```
      The type definition, in GraphQL Schema Definition Language (SDL) format.
      
      For more information, see the GraphQL SDL documentation.
    - format
```
String format
```
      The type format: SDL or JSON.
- Class com.amazonaws.services.appsync.model.CreateTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - type
```
Type type
```
      The Type object.
- Class com.amazonaws.services.appsync.model.DataSource extends Object implements Serializable
  - Serialized Fields
    - dataSourceArn
```
String dataSourceArn
```
      The data source ARN.
    - name
```
String name
```
      The name of the data source.
    - description
```
String description
```
      The description of the data source.
    - type
```
String type
```
      The type of the data source.
      
      AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.
      
      AMAZON_ELASTICSEARCH: The data source is an Amazon Elasticsearch Service domain.
      
      AWS_LAMBDA: The data source is an AWS Lambda function.
      
      NONE: There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.
      
      HTTP: The data source is an HTTP endpoint.
      
      RELATIONAL_DATABASE: The data source is a relational database.
    - serviceRoleArn
```
String serviceRoleArn
```
      The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
    - dynamodbConfig
```
DynamodbDataSourceConfig dynamodbConfig
```
      Amazon DynamoDB settings.
    - lambdaConfig
```
LambdaDataSourceConfig lambdaConfig
```
      AWS Lambda settings.
    - elasticsearchConfig
```
ElasticsearchDataSourceConfig elasticsearchConfig
```
      Amazon Elasticsearch Service settings.
    - httpConfig
```
HttpDataSourceConfig httpConfig
```
      HTTP endpoint settings.
    - relationalDatabaseConfig
```
RelationalDatabaseDataSourceConfig relationalDatabaseConfig
```
      Relational database settings.
- Class com.amazonaws.services.appsync.model.DeleteApiCacheRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
- Class com.amazonaws.services.appsync.model.DeleteApiCacheResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appsync.model.DeleteApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - id
```
String id
```
      The ID for the API key.
- Class com.amazonaws.services.appsync.model.DeleteApiKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appsync.model.DeleteDataSourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - name
```
String name
```
      The name of the data source.
- Class com.amazonaws.services.appsync.model.DeleteDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appsync.model.DeleteFunctionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The GraphQL API ID.
    - functionId
```
String functionId
```
      The Function ID.
- Class com.amazonaws.services.appsync.model.DeleteFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appsync.model.DeleteGraphqlApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
- Class com.amazonaws.services.appsync.model.DeleteGraphqlApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appsync.model.DeleteResolverRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - typeName
```
String typeName
```
      The name of the resolver type.
    - fieldName
```
String fieldName
```
      The resolver field name.
- Class com.amazonaws.services.appsync.model.DeleteResolverResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appsync.model.DeleteTypeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - typeName
```
String typeName
```
      The type name.
- Class com.amazonaws.services.appsync.model.DeleteTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appsync.model.DeltaSyncConfig extends Object implements Serializable
  - Serialized Fields
    - baseTableTTL
```
Long baseTableTTL
```
      The number of minutes an Item is stored in the datasource.
    - deltaSyncTableName
```
String deltaSyncTableName
```
      The Delta Sync table name.
    - deltaSyncTableTTL
```
Long deltaSyncTableTTL
```
      The number of minutes a Delta Sync log entry is stored in the Delta Sync table.
- Class com.amazonaws.services.appsync.model.DynamodbDataSourceConfig extends Object implements Serializable
  - Serialized Fields
    - tableName
```
String tableName
```
      The table name.
    - awsRegion
```
String awsRegion
```
      The AWS Region.
    - useCallerCredentials
```
Boolean useCallerCredentials
```
      Set to TRUE to use Amazon Cognito credentials with this data source.
    - deltaSyncConfig
```
DeltaSyncConfig deltaSyncConfig
```
      The DeltaSyncConfig for a versioned datasource.
    - versioned
```
Boolean versioned
```
      Set to TRUE to use Conflict Detection and Resolution with this data source.
- Class com.amazonaws.services.appsync.model.ElasticsearchDataSourceConfig extends Object implements Serializable
  - Serialized Fields
    - endpoint
```
String endpoint
```
      The endpoint.
    - awsRegion
```
String awsRegion
```
      The AWS Region.
- Class com.amazonaws.services.appsync.model.FlushApiCacheRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
- Class com.amazonaws.services.appsync.model.FlushApiCacheResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appsync.model.FunctionConfiguration extends Object implements Serializable
  - Serialized Fields
    - functionId
```
String functionId
```
      A unique ID representing the Function object.
    - functionArn
```
String functionArn
```
      The ARN of the Function object.
    - name
```
String name
```
      The name of the Function object.
    - description
```
String description
```
      The Function description.
    - dataSourceName
```
String dataSourceName
```
      The name of the DataSource.
    - requestMappingTemplate
```
String requestMappingTemplate
```
      The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
    - responseMappingTemplate
```
String responseMappingTemplate
```
      The Function response mapping template.
    - functionVersion
```
String functionVersion
```
      The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.
- Class com.amazonaws.services.appsync.model.GetApiCacheRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
- Class com.amazonaws.services.appsync.model.GetApiCacheResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiCache
```
ApiCache apiCache
```
- Class com.amazonaws.services.appsync.model.GetDataSourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - name
```
String name
```
      The name of the data source.
- Class com.amazonaws.services.appsync.model.GetDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - dataSource
```
DataSource dataSource
```
      The DataSource object.
- Class com.amazonaws.services.appsync.model.GetFunctionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The GraphQL API ID.
    - functionId
```
String functionId
```
      The Function ID.
- Class com.amazonaws.services.appsync.model.GetFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - functionConfiguration
```
FunctionConfiguration functionConfiguration
```
      The Function object.
- Class com.amazonaws.services.appsync.model.GetGraphqlApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID for the GraphQL API.
- Class com.amazonaws.services.appsync.model.GetGraphqlApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - graphqlApi
```
GraphqlApi graphqlApi
```
      The GraphqlApi object.
- Class com.amazonaws.services.appsync.model.GetIntrospectionSchemaRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - format
```
String format
```
      The schema format: SDL or JSON.
    - includeDirectives
```
Boolean includeDirectives
```
      A flag that specifies whether the schema introspection should contain directives.
- Class com.amazonaws.services.appsync.model.GetIntrospectionSchemaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - schema
```
ByteBuffer schema
```
      The schema, in GraphQL Schema Definition Language (SDL) format.
      
      For more information, see the GraphQL SDL documentation.
- Class com.amazonaws.services.appsync.model.GetResolverRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - typeName
```
String typeName
```
      The resolver type name.
    - fieldName
```
String fieldName
```
      The resolver field name.
- Class com.amazonaws.services.appsync.model.GetResolverResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resolver
```
Resolver resolver
```
      The Resolver object.
- Class com.amazonaws.services.appsync.model.GetSchemaCreationStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
- Class com.amazonaws.services.appsync.model.GetSchemaCreationStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
    - details
```
String details
```
      Detailed information about the status of the schema creation operation.
- Class com.amazonaws.services.appsync.model.GetTypeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - typeName
```
String typeName
```
      The type name.
    - format
```
String format
```
      The type format: SDL or JSON.
- Class com.amazonaws.services.appsync.model.GetTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - type
```
Type type
```
      The Type object.
- Class com.amazonaws.services.appsync.model.GraphqlApi extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The API name.
    - apiId
```
String apiId
```
      The API ID.
    - authenticationType
```
String authenticationType
```
      The authentication type.
    - logConfig
```
LogConfig logConfig
```
      The Amazon CloudWatch Logs configuration.
    - userPoolConfig
```
UserPoolConfig userPoolConfig
```
      The Amazon Cognito user pool configuration.
    - openIDConnectConfig
```
OpenIDConnectConfig openIDConnectConfig
```
      The OpenID Connect configuration.
    - arn
```
String arn
```
      The ARN.
    - uris
```
Map<K,V> uris
```
      The URIs.
    - tags
```
Map<K,V> tags
```
      The tags.
    - additionalAuthenticationProviders
```
List<E> additionalAuthenticationProviders
```
      A list of additional authentication providers for the GraphqlApi API.
- Class com.amazonaws.services.appsync.model.GraphQLSchemaException extends AWSAppSyncException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appsync.model.HttpDataSourceConfig extends Object implements Serializable
  - Serialized Fields
    - endpoint
```
String endpoint
```
      The HTTP URL endpoint. You can either specify the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
    - authorizationConfig
```
AuthorizationConfig authorizationConfig
```
      The authorization config in case the HTTP endpoint requires authorization.
- Class com.amazonaws.services.appsync.model.InternalFailureException extends AWSAppSyncException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appsync.model.LambdaConflictHandlerConfig extends Object implements Serializable
  - Serialized Fields
    - lambdaConflictHandlerArn
```
String lambdaConflictHandlerArn
```
      The Arn for the Lambda function to use as the Conflict Handler.
- Class com.amazonaws.services.appsync.model.LambdaDataSourceConfig extends Object implements Serializable
  - Serialized Fields
    - lambdaFunctionArn
```
String lambdaFunctionArn
```
      The ARN for the Lambda function.
- Class com.amazonaws.services.appsync.model.LimitExceededException extends AWSAppSyncException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appsync.model.ListApiKeysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - nextToken
```
String nextToken
```
      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
    - maxResults
```
Integer maxResults
```
      The maximum number of results you want the request to return.
- Class com.amazonaws.services.appsync.model.ListApiKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiKeys
```
List<E> apiKeys
```
      The ApiKey objects.
    - nextToken
```
String nextToken
```
      An identifier to be passed in the next request to this operation to return the next set of items in the list.
- Class com.amazonaws.services.appsync.model.ListDataSourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - nextToken
```
String nextToken
```
      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
    - maxResults
```
Integer maxResults
```
      The maximum number of results you want the request to return.
- Class com.amazonaws.services.appsync.model.ListDataSourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - dataSources
```
List<E> dataSources
```
      The DataSource objects.
    - nextToken
```
String nextToken
```
      An identifier to be passed in the next request to this operation to return the next set of items in the list.
- Class com.amazonaws.services.appsync.model.ListFunctionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The GraphQL API ID.
    - nextToken
```
String nextToken
```
      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
    - maxResults
```
Integer maxResults
```
      The maximum number of results you want the request to return.
- Class com.amazonaws.services.appsync.model.ListFunctionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - functions
```
List<E> functions
```
      A list of Function objects.
    - 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.appsync.model.ListGraphqlApisRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
    - maxResults
```
Integer maxResults
```
      The maximum number of results you want the request to return.
- Class com.amazonaws.services.appsync.model.ListGraphqlApisResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - graphqlApis
```
List<E> graphqlApis
```
      The GraphqlApi objects.
    - nextToken
```
String nextToken
```
      An identifier to be passed in the next request to this operation to return the next set of items in the list.
- Class com.amazonaws.services.appsync.model.ListResolversByFunctionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - functionId
```
String functionId
```
      The Function ID.
    - nextToken
```
String nextToken
```
      An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.
    - maxResults
```
Integer maxResults
```
      The maximum number of results you want the request to return.
- Class com.amazonaws.services.appsync.model.ListResolversByFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resolvers
```
List<E> resolvers
```
      The list of resolvers.
    - nextToken
```
String nextToken
```
      An identifier that can be used to return the next set of items in the list.
- Class com.amazonaws.services.appsync.model.ListResolversRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - typeName
```
String typeName
```
      The type name.
    - nextToken
```
String nextToken
```
      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
    - maxResults
```
Integer maxResults
```
      The maximum number of results you want the request to return.
- Class com.amazonaws.services.appsync.model.ListResolversResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resolvers
```
List<E> resolvers
```
      The Resolver objects.
    - nextToken
```
String nextToken
```
      An identifier to be passed in the next request to this operation to return the next set of items in the list.
- Class com.amazonaws.services.appsync.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The GraphqlApi ARN.
- Class com.amazonaws.services.appsync.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      A TagMap object.
- Class com.amazonaws.services.appsync.model.ListTypesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - format
```
String format
```
      The type format: SDL or JSON.
    - nextToken
```
String nextToken
```
      An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
    - maxResults
```
Integer maxResults
```
      The maximum number of results you want the request to return.
- Class com.amazonaws.services.appsync.model.ListTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - types
```
List<E> types
```
      The Type objects.
    - nextToken
```
String nextToken
```
      An identifier to be passed in the next request to this operation to return the next set of items in the list.
- Class com.amazonaws.services.appsync.model.LogConfig extends Object implements Serializable
  - Serialized Fields
    - fieldLogLevel
```
String fieldLogLevel
```
      The field logging level. Values can be NONE, ERROR, or ALL.
      
      NONE: No field-level logs are captured.
      
      ERROR: Logs the following information only for the fields that are in error:
      
      The error section in the server response.
      
      Field-level errors.
      
      The generated request/response functions that got resolved for error fields.
      
      ALL: The following information is logged for all fields in the query:
      
      Field-level tracing information.
      
      The generated request/response functions that got resolved for each field.
    - cloudWatchLogsRoleArn
```
String cloudWatchLogsRoleArn
```
      The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
    - excludeVerboseContent
```
Boolean excludeVerboseContent
```
      Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
- Class com.amazonaws.services.appsync.model.NotFoundException extends AWSAppSyncException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appsync.model.OpenIDConnectConfig extends Object implements Serializable
  - Serialized Fields
    - issuer
```
String issuer
```
      The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
    - clientId
```
String clientId
```
      The client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
    - iatTTL
```
Long iatTTL
```
      The number of milliseconds a token is valid after being issued to a user.
    - authTTL
```
Long authTTL
```
      The number of milliseconds a token is valid after being authenticated.
- Class com.amazonaws.services.appsync.model.PipelineConfig extends Object implements Serializable
  - Serialized Fields
    - functions
```
List<E> functions
```
      A list of Function objects.
- Class com.amazonaws.services.appsync.model.RdsHttpEndpointConfig extends Object implements Serializable
  - Serialized Fields
    - awsRegion
```
String awsRegion
```
      AWS Region for RDS HTTP endpoint.
    - dbClusterIdentifier
```
String dbClusterIdentifier
```
      Amazon RDS cluster identifier.
    - databaseName
```
String databaseName
```
      Logical database name.
    - schema
```
String schema
```
      Logical schema name.
    - awsSecretStoreArn
```
String awsSecretStoreArn
```
      AWS secret store ARN for database credentials.
- Class com.amazonaws.services.appsync.model.RelationalDatabaseDataSourceConfig extends Object implements Serializable
  - Serialized Fields
    - relationalDatabaseSourceType
```
String relationalDatabaseSourceType
```
      Source type for the relational database.
      
      RDS_HTTP_ENDPOINT: The relational database source type is an Amazon RDS HTTP endpoint.
    - rdsHttpEndpointConfig
```
RdsHttpEndpointConfig rdsHttpEndpointConfig
```
      Amazon RDS HTTP endpoint settings.
- Class com.amazonaws.services.appsync.model.Resolver extends Object implements Serializable
  - Serialized Fields
    - typeName
```
String typeName
```
      The resolver type name.
    - fieldName
```
String fieldName
```
      The resolver field name.
    - dataSourceName
```
String dataSourceName
```
      The resolver data source name.
    - resolverArn
```
String resolverArn
```
      The resolver ARN.
    - requestMappingTemplate
```
String requestMappingTemplate
```
      The request mapping template.
    - responseMappingTemplate
```
String responseMappingTemplate
```
      The response mapping template.
    - kind
```
String kind
```
      The resolver type.
      
      UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
      
      PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
    - pipelineConfig
```
PipelineConfig pipelineConfig
```
      The PipelineConfig.
    - syncConfig
```
SyncConfig syncConfig
```
      The SyncConfig for a resolver attached to a versioned datasource.
    - cachingConfig
```
CachingConfig cachingConfig
```
      The caching configuration for the resolver.
- Class com.amazonaws.services.appsync.model.StartSchemaCreationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - definition
```
ByteBuffer definition
```
      The schema definition, in GraphQL schema language format.
- Class com.amazonaws.services.appsync.model.StartSchemaCreationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
- Class com.amazonaws.services.appsync.model.SyncConfig extends Object implements Serializable
  - Serialized Fields
    - conflictHandler
```
String conflictHandler
```
      The Conflict Resolution strategy to perform in the event of a conflict.
      
      OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions do not match the latest version at the server.
      
      AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
      
      LAMBDA: Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
    - conflictDetection
```
String conflictDetection
```
      The Conflict Detection strategy to use.
      
      VERSION: Detect conflicts based on object versions for this resolver.
      
      NONE: Do not detect conflicts when executing this resolver.
    - lambdaConflictHandlerConfig
```
LambdaConflictHandlerConfig lambdaConflictHandlerConfig
```
      The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
- Class com.amazonaws.services.appsync.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The GraphqlApi ARN.
    - tags
```
Map<K,V> tags
```
      A TagMap object.
- Class com.amazonaws.services.appsync.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appsync.model.Type extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The type name.
    - description
```
String description
```
      The type description.
    - arn
```
String arn
```
      The type ARN.
    - definition
```
String definition
```
      The type definition.
    - format
```
String format
```
      The type format: SDL or JSON.
- Class com.amazonaws.services.appsync.model.UnauthorizedException extends AWSAppSyncException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.appsync.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The GraphqlApi ARN.
    - tagKeys
```
List<E> tagKeys
```
      A list of TagKey objects.
- Class com.amazonaws.services.appsync.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.appsync.model.UpdateApiCacheRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The GraphQL API Id.
    - ttl
```
Long ttl
```
      TTL in seconds for cache entries.
      
      Valid values are between 1 and 3600 seconds.
    - apiCachingBehavior
```
String apiCachingBehavior
```
      Caching behavior.
      
      FULL_REQUEST_CACHING: All requests are fully cached.
      
      PER_RESOLVER_CACHING: Individual resovlers that you specify are cached.
    - type
```
String type
```
      The cache instance type.
      
      T2_SMALL: A t2.small instance type.
      
      T2_MEDIUM: A t2.medium instance type.
      
      R4_LARGE: A r4.large instance type.
      
      R4_XLARGE: A r4.xlarge instance type.
      
      R4_2XLARGE: A r4.2xlarge instance type.
      
      R4_4XLARGE: A r4.4xlarge instance type.
      
      R4_8XLARGE: A r4.8xlarge instance type.
- Class com.amazonaws.services.appsync.model.UpdateApiCacheResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiCache
```
ApiCache apiCache
```
      The ApiCache object.
- Class com.amazonaws.services.appsync.model.UpdateApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The ID for the GraphQL API.
    - id
```
String id
```
      The API key ID.
    - description
```
String description
```
      A description of the purpose of the API key.
    - expires
```
Long expires
```
      The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .
- Class com.amazonaws.services.appsync.model.UpdateApiKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - apiKey
```
ApiKey apiKey
```
      The API key.
- Class com.amazonaws.services.appsync.model.UpdateDataSourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - name
```
String name
```
      The new name for the data source.
    - description
```
String description
```
      The new description for the data source.
    - type
```
String type
```
      The new data source type.
    - serviceRoleArn
```
String serviceRoleArn
```
      The new service role ARN for the data source.
    - dynamodbConfig
```
DynamodbDataSourceConfig dynamodbConfig
```
      The new Amazon DynamoDB configuration.
    - lambdaConfig
```
LambdaDataSourceConfig lambdaConfig
```
      The new AWS Lambda configuration.
    - elasticsearchConfig
```
ElasticsearchDataSourceConfig elasticsearchConfig
```
      The new Elasticsearch Service configuration.
    - httpConfig
```
HttpDataSourceConfig httpConfig
```
      The new HTTP endpoint configuration.
    - relationalDatabaseConfig
```
RelationalDatabaseDataSourceConfig relationalDatabaseConfig
```
      The new relational database configuration.
- Class com.amazonaws.services.appsync.model.UpdateDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - dataSource
```
DataSource dataSource
```
      The updated DataSource object.
- Class com.amazonaws.services.appsync.model.UpdateFunctionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The GraphQL API ID.
    - name
```
String name
```
      The Function name.
    - description
```
String description
```
      The Function description.
    - functionId
```
String functionId
```
      The function ID.
    - dataSourceName
```
String dataSourceName
```
      The Function DataSource name.
    - requestMappingTemplate
```
String requestMappingTemplate
```
      The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
    - responseMappingTemplate
```
String responseMappingTemplate
```
      The Function request mapping template.
    - functionVersion
```
String functionVersion
```
      The version of the request mapping template. Currently the supported value is 2018-05-29.
- Class com.amazonaws.services.appsync.model.UpdateFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - functionConfiguration
```
FunctionConfiguration functionConfiguration
```
      The Function object.
- Class com.amazonaws.services.appsync.model.UpdateGraphqlApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - name
```
String name
```
      The new name for the GraphqlApi object.
    - logConfig
```
LogConfig logConfig
```
      The Amazon CloudWatch Logs configuration for the GraphqlApi object.
    - authenticationType
```
String authenticationType
```
      The new authentication type for the GraphqlApi object.
    - userPoolConfig
```
UserPoolConfig userPoolConfig
```
      The new Amazon Cognito user pool configuration for the GraphqlApi object.
    - openIDConnectConfig
```
OpenIDConnectConfig openIDConnectConfig
```
      The OpenID Connect configuration for the GraphqlApi object.
    - additionalAuthenticationProviders
```
List<E> additionalAuthenticationProviders
```
      A list of additional authentication providers for the GraphqlApi API.
- Class com.amazonaws.services.appsync.model.UpdateGraphqlApiResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - graphqlApi
```
GraphqlApi graphqlApi
```
      The updated GraphqlApi object.
- Class com.amazonaws.services.appsync.model.UpdateResolverRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - typeName
```
String typeName
```
      The new type name.
    - fieldName
```
String fieldName
```
      The new field name.
    - dataSourceName
```
String dataSourceName
```
      The new data source name.
    - requestMappingTemplate
```
String requestMappingTemplate
```
      The new request mapping template.
    - responseMappingTemplate
```
String responseMappingTemplate
```
      The new response mapping template.
    - kind
```
String kind
```
      The resolver type.
      
      UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.
      
      PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
    - pipelineConfig
```
PipelineConfig pipelineConfig
```
      The PipelineConfig.
    - syncConfig
```
SyncConfig syncConfig
```
      The SyncConfig for a resolver attached to a versioned datasource.
    - cachingConfig
```
CachingConfig cachingConfig
```
      The caching configuration for the resolver.
- Class com.amazonaws.services.appsync.model.UpdateResolverResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resolver
```
Resolver resolver
```
      The updated Resolver object.
- Class com.amazonaws.services.appsync.model.UpdateTypeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiId
```
String apiId
```
      The API ID.
    - typeName
```
String typeName
```
      The new type name.
    - definition
```
String definition
```
      The new definition.
    - format
```
String format
```
      The new type format: SDL or JSON.
- Class com.amazonaws.services.appsync.model.UpdateTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - type
```
Type type
```
      The updated Type object.
- Class com.amazonaws.services.appsync.model.UserPoolConfig extends Object implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID.
    - awsRegion
```
String awsRegion
```
      The AWS Region in which the user pool was created.
    - defaultAction
```
String defaultAction
```
      The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.
    - appIdClientRegex
```
String appIdClientRegex
```
      A regular expression for validating the incoming Amazon Cognito user pool app client ID.
Package com.amazonaws.services.athena.model
- Class com.amazonaws.services.athena.model.AmazonAthenaException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.athena.model.BatchGetNamedQueryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - namedQueryIds
```
List<E> namedQueryIds
```
      An array of query IDs.
- Class com.amazonaws.services.athena.model.BatchGetNamedQueryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - namedQueries
```
List<E> namedQueries
```
      Information about the named query IDs submitted.
    - unprocessedNamedQueryIds
```
List<E> unprocessedNamedQueryIds
```
      Information about provided query IDs.
- Class com.amazonaws.services.athena.model.BatchGetQueryExecutionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - queryExecutionIds
```
List<E> queryExecutionIds
```
      An array of query execution IDs.
- Class com.amazonaws.services.athena.model.BatchGetQueryExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - queryExecutions
```
List<E> queryExecutions
```
      Information about a query execution.
    - unprocessedQueryExecutionIds
```
List<E> unprocessedQueryExecutionIds
```
      Information about the query executions that failed to run.
- Class com.amazonaws.services.athena.model.ColumnInfo extends Object implements Serializable
  - Serialized Fields
    - catalogName
```
String catalogName
```
      The catalog to which the query results belong.
    - schemaName
```
String schemaName
```
      The schema name (database name) to which the query results belong.
    - tableName
```
String tableName
```
      The table name for the query results.
    - name
```
String name
```
      The name of the column.
    - label
```
String label
```
      A column label.
    - type
```
String type
```
      The data type of the column.
    - precision
```
Integer precision
```
      For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.
    - scale
```
Integer scale
```
      For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.
    - nullable
```
String nullable
```
      Indicates the column's nullable status.
    - caseSensitive
```
Boolean caseSensitive
```
      Indicates whether values in the column are case-sensitive.
- Class com.amazonaws.services.athena.model.CreateNamedQueryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The query name.
    - description
```
String description
```
      The query description.
    - database
```
String database
```
      The database to which the query belongs.
    - queryString
```
String queryString
```
      The contents of the query with all query statements.
    - clientRequestToken
```
String clientRequestToken
```
      A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.
      
      This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.
    - workGroup
```
String workGroup
```
      The name of the workgroup in which the named query is being created.
- Class com.amazonaws.services.athena.model.CreateNamedQueryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - namedQueryId
```
String namedQueryId
```
      The unique ID of the query.
- Class com.amazonaws.services.athena.model.CreateWorkGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The workgroup name.
    - configuration
```
WorkGroupConfiguration configuration
```
      The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
    - description
```
String description
```
      The workgroup description.
    - tags
```
List<E> tags
```
      One or more tags, separated by commas, that you want to attach to the workgroup as you create it.
- Class com.amazonaws.services.athena.model.CreateWorkGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.athena.model.Datum extends Object implements Serializable
  - Serialized Fields
    - varCharValue
```
String varCharValue
```
      The value of the datum.
- Class com.amazonaws.services.athena.model.DeleteNamedQueryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - namedQueryId
```
String namedQueryId
```
      The unique ID of the query to delete.
- Class com.amazonaws.services.athena.model.DeleteNamedQueryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.athena.model.DeleteWorkGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - workGroup
```
String workGroup
```
      The unique name of the workgroup to delete.
    - recursiveDeleteOption
```
Boolean recursiveDeleteOption
```
      The option to delete the workgroup and its contents even if the workgroup contains any named queries.
- Class com.amazonaws.services.athena.model.DeleteWorkGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.athena.model.EncryptionConfiguration extends Object implements Serializable
  - Serialized Fields
    - encryptionOption
```
String encryptionOption
```
      Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used.
      
      If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.
    - kmsKey
```
String kmsKey
```
      For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.
- Class com.amazonaws.services.athena.model.GetNamedQueryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - namedQueryId
```
String namedQueryId
```
      The unique ID of the query. Use ListNamedQueries to get query IDs.
- Class com.amazonaws.services.athena.model.GetNamedQueryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - namedQuery
```
NamedQuery namedQuery
```
      Information about the query.
- Class com.amazonaws.services.athena.model.GetQueryExecutionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - queryExecutionId
```
String queryExecutionId
```
      The unique ID of the query execution.
- Class com.amazonaws.services.athena.model.GetQueryExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - queryExecution
```
QueryExecution queryExecution
```
      Information about the query execution.
- Class com.amazonaws.services.athena.model.GetQueryResultsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - queryExecutionId
```
String queryExecutionId
```
      The unique ID of the query execution.
    - nextToken
```
String nextToken
```
      The token that specifies where to start pagination if a previous request was truncated.
    - maxResults
```
Integer maxResults
```
      The maximum number of results (rows) to return in this request.
- Class com.amazonaws.services.athena.model.GetQueryResultsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - updateCount
```
Long updateCount
```
      The number of rows inserted with a CREATE TABLE AS SELECT statement.
    - resultSet
```
ResultSet resultSet
```
      The results of the query execution.
    - nextToken
```
String nextToken
```
      A token to be used by the next request if this request is truncated.
- Class com.amazonaws.services.athena.model.GetWorkGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - workGroup
```
String workGroup
```
      The name of the workgroup.
- Class com.amazonaws.services.athena.model.GetWorkGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - workGroup
```
WorkGroup workGroup
```
      Information about the workgroup.
- Class com.amazonaws.services.athena.model.InternalServerException extends AmazonAthenaException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.athena.model.InvalidRequestException extends AmazonAthenaException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - athenaErrorCode
```
String athenaErrorCode
```
- Class com.amazonaws.services.athena.model.ListNamedQueriesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The token that specifies where to start pagination if a previous request was truncated.
    - maxResults
```
Integer maxResults
```
      The maximum number of queries to return in this request.
    - workGroup
```
String workGroup
```
      The name of the workgroup from which the named queries are being returned.
- Class com.amazonaws.services.athena.model.ListNamedQueriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - namedQueryIds
```
List<E> namedQueryIds
```
      The list of unique query IDs.
    - nextToken
```
String nextToken
```
      A token to be used by the next request if this request is truncated.
- Class com.amazonaws.services.athena.model.ListQueryExecutionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The token that specifies where to start pagination if a previous request was truncated.
    - maxResults
```
Integer maxResults
```
      The maximum number of query executions to return in this request.
    - workGroup
```
String workGroup
```
      The name of the workgroup from which queries are being returned.
- Class com.amazonaws.services.athena.model.ListQueryExecutionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - queryExecutionIds
```
List<E> queryExecutionIds
```
      The unique IDs of each query execution as an array of strings.
    - nextToken
```
String nextToken
```
      A token to be used by the next request if this request is truncated.
- Class com.amazonaws.services.athena.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      Lists the tags for the workgroup resource with the specified ARN.
    - nextToken
```
String nextToken
```
      The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the workgroup resource with the specified ARN.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to be returned per request that lists the tags for the workgroup resource.
- Class com.amazonaws.services.athena.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
List<E> tags
```
      The list of tags associated with this workgroup.
    - nextToken
```
String nextToken
```
      A token to be used by the next request if this request is truncated.
- Class com.amazonaws.services.athena.model.ListWorkGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      A token to be used by the next request if this request is truncated.
    - maxResults
```
Integer maxResults
```
      The maximum number of workgroups to return in this request.
- Class com.amazonaws.services.athena.model.ListWorkGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - workGroups
```
List<E> workGroups
```
      The list of workgroups, including their names, descriptions, creation times, and states.
    - nextToken
```
String nextToken
```
      A token to be used by the next request if this request is truncated.
- Class com.amazonaws.services.athena.model.NamedQuery extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The query name.
    - description
```
String description
```
      The query description.
    - database
```
String database
```
      The database to which the query belongs.
    - queryString
```
String queryString
```
      The SQL query statements that comprise the query.
    - namedQueryId
```
String namedQueryId
```
      The unique identifier of the query.
    - workGroup
```
String workGroup
```
      The name of the workgroup that contains the named query.
- Class com.amazonaws.services.athena.model.QueryExecution extends Object implements Serializable
  - Serialized Fields
    - queryExecutionId
```
String queryExecutionId
```
      The unique identifier for each query execution.
    - query
```
String query
```
      The SQL query statements which the query execution ran.
    - statementType
```
String statementType
```
      The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE <table>.
    - resultConfiguration
```
ResultConfiguration resultConfiguration
```
      The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results. These are known as "client-side settings". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.
    - queryExecutionContext
```
QueryExecutionContext queryExecutionContext
```
      The database in which the query execution occurred.
    - status
```
QueryExecutionStatus status
```
      The completion date, current state, submission time, and state change reason (if applicable) for the query execution.
    - statistics
```
QueryExecutionStatistics statistics
```
      The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.
    - workGroup
```
String workGroup
```
      The name of the workgroup in which the query ran.
- Class com.amazonaws.services.athena.model.QueryExecutionContext extends Object implements Serializable
  - Serialized Fields
    - database
```
String database
```
      The name of the database.
- Class com.amazonaws.services.athena.model.QueryExecutionStatistics extends Object implements Serializable
  - Serialized Fields
    - engineExecutionTimeInMillis
```
Long engineExecutionTimeInMillis
```
      The number of milliseconds that the query took to execute.
    - dataScannedInBytes
```
Long dataScannedInBytes
```
      The number of bytes in the data that was queried.
    - dataManifestLocation
```
String dataManifestLocation
```
      The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. The manifest file tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Results, Output Files, and Query History in the Amazon Athena User Guide.
    - totalExecutionTimeInMillis
```
Long totalExecutionTimeInMillis
```
      The number of milliseconds that Athena took to run the query.
    - queryQueueTimeInMillis
```
Long queryQueueTimeInMillis
```
      The number of milliseconds that the query was in your query queue waiting for resources. Note that if transient errors occur, Athena might automatically add the query back to the queue.
    - queryPlanningTimeInMillis
```
Long queryPlanningTimeInMillis
```
      The number of milliseconds that Athena took to plan the query processing flow. This includes the time spent retrieving table partitions from the data source. Note that because the query engine performs the query planning, query planning time is a subset of engine processing time.
    - serviceProcessingTimeInMillis
```
Long serviceProcessingTimeInMillis
```
      The number of milliseconds that Athena took to finalize and publish the query results after the query engine finished running the query.
- Class com.amazonaws.services.athena.model.QueryExecutionStatus extends Object implements Serializable
  - Serialized Fields
    - state
```
String state
```
      The state of query execution. QUEUED state is listed but is not used by Athena and is reserved for future use. RUNNING indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.
    - stateChangeReason
```
String stateChangeReason
```
      Further detail about the status of the query.
    - submissionDateTime
```
Date submissionDateTime
```
      The date and time that the query was submitted.
    - completionDateTime
```
Date completionDateTime
```
      The date and time that the query completed.
- Class com.amazonaws.services.athena.model.ResourceNotFoundException extends AmazonAthenaException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceName
```
String resourceName
```
- Class com.amazonaws.services.athena.model.ResultConfiguration extends Object implements Serializable
  - Serialized Fields
    - outputLocation
```
String outputLocation
```
      The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
    - encryptionConfiguration
```
EncryptionConfiguration encryptionConfiguration
```
      If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.
- Class com.amazonaws.services.athena.model.ResultConfigurationUpdates extends Object implements Serializable
  - Serialized Fields
    - outputLocation
```
String outputLocation
```
      The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. For more information, see Query Results If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
    - removeOutputLocation
```
Boolean removeOutputLocation
```
      If set to "true", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
    - encryptionConfiguration
```
EncryptionConfiguration encryptionConfiguration
```
      The encryption configuration for the query results.
    - removeEncryptionConfiguration
```
Boolean removeEncryptionConfiguration
```
      If set to "true", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to "false" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.
- Class com.amazonaws.services.athena.model.ResultSet extends Object implements Serializable
  - Serialized Fields
    - rows
```
List<E> rows
```
      The rows in the table.
    - resultSetMetadata
```
ResultSetMetadata resultSetMetadata
```
      The metadata that describes the column structure and data types of a table of query results.
- Class com.amazonaws.services.athena.model.ResultSetMetadata extends Object implements Serializable
  - Serialized Fields
    - columnInfo
```
List<E> columnInfo
```
      Information about the columns returned in a query result metadata.
- Class com.amazonaws.services.athena.model.Row extends Object implements Serializable
  - Serialized Fields
    - data
```
List<E> data
```
      The data that populates a row in a query result table.
- Class com.amazonaws.services.athena.model.StartQueryExecutionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - queryString
```
String queryString
```
      The SQL query statements to be executed.
    - clientRequestToken
```
String clientRequestToken
```
      A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.
      
      This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.
    - queryExecutionContext
```
QueryExecutionContext queryExecutionContext
```
      The database within which the query executes.
    - resultConfiguration
```
ResultConfiguration resultConfiguration
```
      Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
    - workGroup
```
String workGroup
```
      The name of the workgroup in which the query is being started.
- Class com.amazonaws.services.athena.model.StartQueryExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - queryExecutionId
```
String queryExecutionId
```
      The unique ID of the query that ran as a result of this request.
- Class com.amazonaws.services.athena.model.StopQueryExecutionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - queryExecutionId
```
String queryExecutionId
```
      The unique ID of the query execution to stop.
- Class com.amazonaws.services.athena.model.StopQueryExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.athena.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.
    - value
```
String value
```
      A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.
- Class com.amazonaws.services.athena.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      Requests that one or more tags are added to the resource (such as a workgroup) for the specified ARN.
    - tags
```
List<E> tags
```
      One or more tags, separated by commas, to be added to the resource, such as a workgroup.
- Class com.amazonaws.services.athena.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.athena.model.TooManyRequestsException extends AmazonAthenaException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - reason
```
String reason
```
- Class com.amazonaws.services.athena.model.UnprocessedNamedQueryId extends Object implements Serializable
  - Serialized Fields
    - namedQueryId
```
String namedQueryId
```
      The unique identifier of the named query.
    - errorCode
```
String errorCode
```
      The error code returned when the processing request for the named query failed, if applicable.
    - errorMessage
```
String errorMessage
```
      The error message returned when the processing request for the named query failed, if applicable.
- Class com.amazonaws.services.athena.model.UnprocessedQueryExecutionId extends Object implements Serializable
  - Serialized Fields
    - queryExecutionId
```
String queryExecutionId
```
      The unique identifier of the query execution.
    - errorCode
```
String errorCode
```
      The error code returned when the query execution failed to process, if applicable.
    - errorMessage
```
String errorMessage
```
      The error message returned when the query execution failed to process, if applicable.
- Class com.amazonaws.services.athena.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceARN
```
String resourceARN
```
      Removes one or more tags from the workgroup resource for the specified ARN.
    - tagKeys
```
List<E> tagKeys
```
      Removes the tags associated with one or more tag keys from the workgroup resource.
- Class com.amazonaws.services.athena.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.athena.model.UpdateWorkGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - workGroup
```
String workGroup
```
      The specified workgroup that will be updated.
    - description
```
String description
```
      The workgroup description.
    - configurationUpdates
```
WorkGroupConfigurationUpdates configurationUpdates
```
      The workgroup configuration that will be updated for the given workgroup.
    - state
```
String state
```
      The workgroup state that will be updated for the given workgroup.
- Class com.amazonaws.services.athena.model.UpdateWorkGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.athena.model.WorkGroup extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The workgroup name.
    - state
```
String state
```
      The state of the workgroup: ENABLED or DISABLED.
    - configuration
```
WorkGroupConfiguration configuration
```
      The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.
    - description
```
String description
```
      The workgroup description.
    - creationTime
```
Date creationTime
```
      The date and time the workgroup was created.
- Class com.amazonaws.services.athena.model.WorkGroupConfiguration extends Object implements Serializable
  - Serialized Fields
    - resultConfiguration
```
ResultConfiguration resultConfiguration
```
      The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.
    - enforceWorkGroupConfiguration
```
Boolean enforceWorkGroupConfiguration
```
      If set to "true", the settings for the workgroup override client-side settings. If set to "false", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
    - publishCloudWatchMetricsEnabled
```
Boolean publishCloudWatchMetricsEnabled
```
      Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.
    - bytesScannedCutoffPerQuery
```
Long bytesScannedCutoffPerQuery
```
      The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
    - requesterPaysEnabled
```
Boolean requesterPaysEnabled
```
      If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.
- Class com.amazonaws.services.athena.model.WorkGroupConfigurationUpdates extends Object implements Serializable
  - Serialized Fields
    - enforceWorkGroupConfiguration
```
Boolean enforceWorkGroupConfiguration
```
      If set to "true", the settings for the workgroup override client-side settings. If set to "false" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.
    - resultConfigurationUpdates
```
ResultConfigurationUpdates resultConfigurationUpdates
```
      The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.
    - publishCloudWatchMetricsEnabled
```
Boolean publishCloudWatchMetricsEnabled
```
      Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.
    - bytesScannedCutoffPerQuery
```
Long bytesScannedCutoffPerQuery
```
      The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.
    - removeBytesScannedCutoffPerQuery
```
Boolean removeBytesScannedCutoffPerQuery
```
      Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery
    - requesterPaysEnabled
```
Boolean requesterPaysEnabled
```
      If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.
- Class com.amazonaws.services.athena.model.WorkGroupSummary extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the workgroup.
    - state
```
String state
```
      The state of the workgroup.
    - description
```
String description
```
      The workgroup description.
    - creationTime
```
Date creationTime
```
      The workgroup creation date and time.
Package com.amazonaws.services.augmentedairuntime.model
- Class com.amazonaws.services.augmentedairuntime.model.AmazonAugmentedAIRuntimeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.augmentedairuntime.model.DeleteHumanLoopRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - humanLoopName
```
String humanLoopName
```
      The name of the human loop you want to delete.
- Class com.amazonaws.services.augmentedairuntime.model.DeleteHumanLoopResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.augmentedairuntime.model.DescribeHumanLoopRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - humanLoopName
```
String humanLoopName
```
      The name of the human loop.
- Class com.amazonaws.services.augmentedairuntime.model.DescribeHumanLoopResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - creationTimestamp
```
Date creationTimestamp
```
      The timestamp when Amazon Augmented AI created the human loop.
    - failureReason
```
String failureReason
```
      The reason why a human loop has failed. The failure reason is returned when the human loop status is Failed.
    - failureCode
```
String failureCode
```
      A failure code denoting a specific type of failure.
    - humanLoopStatus
```
String humanLoopStatus
```
      The status of the human loop. Valid values:
    - humanLoopName
```
String humanLoopName
```
      The name of the human loop.
    - humanLoopArn
```
String humanLoopArn
```
      The Amazon Resource Name (ARN) of the human loop.
    - flowDefinitionArn
```
String flowDefinitionArn
```
      The Amazon Resource Name (ARN) of the flow definition.
    - humanLoopInput
```
HumanLoopInputContent humanLoopInput
```
      An object containing information about the human loop input.
    - humanLoopOutput
```
HumanLoopOutputContent humanLoopOutput
```
      An object containing information about the output of the human loop.
- Class com.amazonaws.services.augmentedairuntime.model.HumanLoopActivationReason extends Object implements Serializable
  - Serialized Fields
    - conditionsMatched
```
Boolean conditionsMatched
```
      True if the specified conditions were matched to trigger the human loop.
- Class com.amazonaws.services.augmentedairuntime.model.HumanLoopActivationResults extends Object implements Serializable
  - Serialized Fields
    - humanLoopActivationReason
```
HumanLoopActivationReason humanLoopActivationReason
```
      An object containing information about why a human loop was triggered.
    - humanLoopActivationConditionsEvaluationResults
```
String humanLoopActivationConditionsEvaluationResults
```
      A copy of the human loop activation conditions of the flow definition, augmented with the results of evaluating those conditions on the input provided to the StartHumanLoop operation.
- Class com.amazonaws.services.augmentedairuntime.model.HumanLoopInputContent extends Object implements Serializable
  - Serialized Fields
    - inputContent
```
String inputContent
```
      Serialized input from the human loop.
- Class com.amazonaws.services.augmentedairuntime.model.HumanLoopOutputContent extends Object implements Serializable
  - Serialized Fields
    - outputS3Uri
```
String outputS3Uri
```
      The location of the Amazon S3 object where Amazon Augmented AI stores your human loop output. The output is stored at the following location: s3://S3OutputPath/HumanLoopName/CreationTime/output.json.
- Class com.amazonaws.services.augmentedairuntime.model.HumanLoopSummary extends Object implements Serializable
  - Serialized Fields
    - humanLoopName
```
String humanLoopName
```
      The name of the human loop.
    - humanLoopStatus
```
String humanLoopStatus
```
      The status of the human loop. Valid values:
    - creationTime
```
Date creationTime
```
      When Amazon Augmented AI created the human loop.
    - failureReason
```
String failureReason
```
      The reason why the human loop failed. A failure reason is returned only when the status of the human loop is Failed.
    - flowDefinitionArn
```
String flowDefinitionArn
```
      The Amazon Resource Name (ARN) of the flow definition.
- Class com.amazonaws.services.augmentedairuntime.model.HumanReviewDataAttributes extends Object implements Serializable
  - Serialized Fields
    - contentClassifiers
```
List<E> contentClassifiers
```
      Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.
- Class com.amazonaws.services.augmentedairuntime.model.InternalServerException extends AmazonAugmentedAIRuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.augmentedairuntime.model.ListHumanLoopsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - creationTimeAfter
```
Date creationTimeAfter
```
      (Optional) The timestamp of the date when you want the human loops to begin. For example, 1551000000 .
    - creationTimeBefore
```
Date creationTimeBefore
```
      (Optional) The timestamp of the date before which you want the human loops to begin. For example, 1550000000.
    - sortOrder
```
String sortOrder
```
      An optional value that specifies whether you want the results sorted in Ascending or Descending order.
    - nextToken
```
String nextToken
```
      A token to resume pagination.
    - maxResults
```
Integer maxResults
```
      The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.
- Class com.amazonaws.services.augmentedairuntime.model.ListHumanLoopsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - humanLoopSummaries
```
List<E> humanLoopSummaries
```
      An array of objects containing information about the human loops.
    - nextToken
```
String nextToken
```
      A token to resume pagination.
- Class com.amazonaws.services.augmentedairuntime.model.ResourceNotFoundException extends AmazonAugmentedAIRuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.augmentedairuntime.model.ServiceQuotaExceededException extends AmazonAugmentedAIRuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.augmentedairuntime.model.StartHumanLoopRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - humanLoopName
```
String humanLoopName
```
      The name of the human loop.
    - flowDefinitionArn
```
String flowDefinitionArn
```
      The Amazon Resource Name (ARN) of the flow definition.
    - humanLoopInput
```
HumanLoopInputContent humanLoopInput
```
      An object containing information about the human loop.
    - dataAttributes
```
HumanReviewDataAttributes dataAttributes
```
      Attributes of the data specified by the customer.
- Class com.amazonaws.services.augmentedairuntime.model.StartHumanLoopResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - humanLoopArn
```
String humanLoopArn
```
      The Amazon Resource Name (ARN) of the human loop.
    - humanLoopActivationResults
```
HumanLoopActivationResults humanLoopActivationResults
```
      An object containing information about the human loop activation.
- Class com.amazonaws.services.augmentedairuntime.model.StopHumanLoopRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - humanLoopName
```
String humanLoopName
```
      The name of the human loop you want to stop.
- Class com.amazonaws.services.augmentedairuntime.model.StopHumanLoopResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.augmentedairuntime.model.ThrottlingException extends AmazonAugmentedAIRuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.augmentedairuntime.model.ValidationException extends AmazonAugmentedAIRuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
Package com.amazonaws.services.autoscaling.model
- Class com.amazonaws.services.autoscaling.model.Activity extends Object implements Serializable
  - Serialized Fields
    - activityId
```
String activityId
```
      The ID of the activity.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - description
```
String description
```
      A friendly, more verbose description of the activity.
    - cause
```
String cause
```
      The reason the activity began.
    - startTime
```
Date startTime
```
      The start time of the activity.
    - endTime
```
Date endTime
```
      The end time of the activity.
    - statusCode
```
String statusCode
```
      The current status of the activity.
    - statusMessage
```
String statusMessage
```
      A friendly, more verbose description of the activity status.
    - progress
```
Integer progress
```
      A value between 0 and 100 that indicates the progress of the activity.
    - details
```
String details
```
      The details about the activity.
- Class com.amazonaws.services.autoscaling.model.AdjustmentType extends Object implements Serializable
  - Serialized Fields
    - adjustmentType
```
String adjustmentType
```
      The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
- Class com.amazonaws.services.autoscaling.model.Alarm extends Object implements Serializable
  - Serialized Fields
    - alarmName
```
String alarmName
```
      The name of the alarm.
    - alarmARN
```
String alarmARN
```
      The Amazon Resource Name (ARN) of the alarm.
- Class com.amazonaws.services.autoscaling.model.AlreadyExistsException extends AmazonAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.AmazonAutoScalingException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.AttachInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
SdkInternalList<T> instanceIds
```
      The IDs of the instances. You can specify up to 20 instances.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
- Class com.amazonaws.services.autoscaling.model.AttachInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.AttachLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - loadBalancerNames
```
SdkInternalList<T> loadBalancerNames
```
      The names of the load balancers. You can specify up to 10 load balancers.
- Class com.amazonaws.services.autoscaling.model.AttachLoadBalancersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.AttachLoadBalancerTargetGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - targetGroupARNs
```
SdkInternalList<T> targetGroupARNs
```
      The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.
- Class com.amazonaws.services.autoscaling.model.AttachLoadBalancerTargetGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.AutoScalingGroup extends Object implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - autoScalingGroupARN
```
String autoScalingGroupARN
```
      The Amazon Resource Name (ARN) of the Auto Scaling group.
    - launchConfigurationName
```
String launchConfigurationName
```
      The name of the associated launch configuration.
    - launchTemplate
```
LaunchTemplateSpecification launchTemplate
```
      The launch template for the group.
    - mixedInstancesPolicy
```
MixedInstancesPolicy mixedInstancesPolicy
```
      The mixed instances policy for the group.
    - minSize
```
Integer minSize
```
      The minimum size of the group.
    - maxSize
```
Integer maxSize
```
      The maximum size of the group.
    - desiredCapacity
```
Integer desiredCapacity
```
      The desired size of the group.
    - defaultCooldown
```
Integer defaultCooldown
```
      The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
    - availabilityZones
```
SdkInternalList<T> availabilityZones
```
      One or more Availability Zones for the group.
    - loadBalancerNames
```
SdkInternalList<T> loadBalancerNames
```
      One or more load balancers associated with the group.
    - targetGroupARNs
```
SdkInternalList<T> targetGroupARNs
```
      The Amazon Resource Names (ARN) of the target groups for your load balancer.
    - healthCheckType
```
String healthCheckType
```
      The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
    - healthCheckGracePeriod
```
Integer healthCheckGracePeriod
```
      The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.
    - instances
```
SdkInternalList<T> instances
```
      The EC2 instances associated with the group.
    - createdTime
```
Date createdTime
```
      The date and time the group was created.
    - suspendedProcesses
```
SdkInternalList<T> suspendedProcesses
```
      The suspended processes associated with the group.
    - placementGroup
```
String placementGroup
```
      The name of the placement group into which to launch your instances, if any.
    - vPCZoneIdentifier
```
String vPCZoneIdentifier
```
      One or more subnet IDs, if applicable, separated by commas.
    - enabledMetrics
```
SdkInternalList<T> enabledMetrics
```
      The metrics enabled for the group.
    - status
```
String status
```
      The current state of the group when DeleteAutoScalingGroup is in progress.
    - tags
```
SdkInternalList<T> tags
```
      The tags for the group.
    - terminationPolicies
```
SdkInternalList<T> terminationPolicies
```
      The termination policies for the group.
    - newInstancesProtectedFromScaleIn
```
Boolean newInstancesProtectedFromScaleIn
```
      Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
    - serviceLinkedRoleARN
```
String serviceLinkedRoleARN
```
      The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.
    - maxInstanceLifetime
```
Integer maxInstanceLifetime
```
      The maximum amount of time, in seconds, that an instance can be in service.
      
      Valid Range: Minimum value of 604800.
- Class com.amazonaws.services.autoscaling.model.AutoScalingInstanceDetails extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - instanceType
```
String instanceType
```
      The instance type of the EC2 instance.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group for the instance.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone for the instance.
    - lifecycleState
```
String lifecycleState
```
      The lifecycle state for the instance.
    - healthStatus
```
String healthStatus
```
      The last reported 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 Amazon EC2 Auto Scaling should terminate and replace it.
    - launchConfigurationName
```
String launchConfigurationName
```
      The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.
    - launchTemplate
```
LaunchTemplateSpecification launchTemplate
```
      The launch template for the instance.
    - protectedFromScaleIn
```
Boolean protectedFromScaleIn
```
      Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
    - weightedCapacity
```
String weightedCapacity
```
      The number of capacity units contributed by the instance based on its instance type.
      
      Valid Range: Minimum value of 1. Maximum value of 999.
- Class com.amazonaws.services.autoscaling.model.BatchDeleteScheduledActionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - scheduledActionNames
```
SdkInternalList<T> scheduledActionNames
```
      The names of the scheduled actions to delete. The maximum number allowed is 50.
- Class com.amazonaws.services.autoscaling.model.BatchDeleteScheduledActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - failedScheduledActions
```
SdkInternalList<T> failedScheduledActions
```
      The names of the scheduled actions that could not be deleted, including an error message.
- Class com.amazonaws.services.autoscaling.model.BatchPutScheduledUpdateGroupActionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - scheduledUpdateGroupActions
```
SdkInternalList<T> scheduledUpdateGroupActions
```
      One or more scheduled actions. The maximum number allowed is 50.
- Class com.amazonaws.services.autoscaling.model.BatchPutScheduledUpdateGroupActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - failedScheduledUpdateGroupActions
```
SdkInternalList<T> failedScheduledUpdateGroupActions
```
      The names of the scheduled actions that could not be created or updated, including an error message.
- Class com.amazonaws.services.autoscaling.model.BlockDeviceMapping extends Object implements Serializable
  - Serialized Fields
    - virtualName
```
String virtualName
```
      The name of the virtual device (for example, ephemeral0).
    - deviceName
```
String deviceName
```
      The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances.
    - 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. In that case, Amazon EC2 Auto Scaling launches a replacement instance.
- Class com.amazonaws.services.autoscaling.model.CompleteLifecycleActionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - lifecycleHookName
```
String lifecycleHookName
```
      The name of the lifecycle hook.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - lifecycleActionToken
```
String lifecycleActionToken
```
      A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.
    - lifecycleActionResult
```
String lifecycleActionResult
```
      The action for the group to take. This parameter can be either CONTINUE or ABANDON.
    - instanceId
```
String instanceId
```
      The ID of the instance.
- Class com.amazonaws.services.autoscaling.model.CompleteLifecycleActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.CreateAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group. This name must be unique per Region per account.
    - launchConfigurationName
```
String launchConfigurationName
```
      The name of the launch configuration.
      
      If you do not specify LaunchConfigurationName, you must specify one of the following parameters: InstanceId, LaunchTemplate, or MixedInstancesPolicy.
    - launchTemplate
```
LaunchTemplateSpecification launchTemplate
```
      The launch template to use to launch instances.
      
      For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference.
      
      If you do not specify LaunchTemplate, you must specify one of the following parameters: InstanceId, LaunchConfigurationName, or MixedInstancesPolicy.
    - mixedInstancesPolicy
```
MixedInstancesPolicy mixedInstancesPolicy
```
      An embedded object that specifies a mixed instances policy. The required parameters must be specified. If optional parameters are unspecified, their default values are used.
      
      The policy includes parameters that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the parameters that specify the instance configuration information—the launch template and instance types.
      
      For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.
      
      You must specify one of the following parameters in your request: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy.
    - instanceId
```
String instanceId
```
      The ID of the instance used to create a launch configuration for the group.
      
      When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping.
      
      For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.
      
      You must specify one of the following parameters in your request: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy.
    - minSize
```
Integer minSize
```
      The minimum size of the group.
    - maxSize
```
Integer maxSize
```
      The maximum size of the group.
    - desiredCapacity
```
Integer desiredCapacity
```
      The number of Amazon EC2 instances that the Auto Scaling group attempts to maintain. 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. If you do not specify a desired capacity, the default is the minimum size of the group.
    - defaultCooldown
```
Integer defaultCooldown
```
      The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.
      
      For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
    - availabilityZones
```
SdkInternalList<T> availabilityZones
```
      One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets for VPCZoneIdentifier.
      
      Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.
    - loadBalancerNames
```
SdkInternalList<T> loadBalancerNames
```
      A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers and Network Load Balancers, specify a list of target groups using the TargetGroupARNs property instead.
      
      For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
    - targetGroupARNs
```
SdkInternalList<T> targetGroupARNs
```
      The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. Instances are registered as targets in a target group, and traffic is routed to the target group.
      
      For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
    - healthCheckType
```
String healthCheckType
```
      The service to use for the health checks. The valid values are EC2 and ELB. The default value is EC2. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
      
      For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.
    - healthCheckGracePeriod
```
Integer healthCheckGracePeriod
```
      The amount of time, in seconds, that Amazon EC2 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 value is 0.
      
      For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide.
      
      Conditional: This parameter is required if you are adding an ELB health check.
    - placementGroup
```
String placementGroup
```
      The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
    - vPCZoneIdentifier
```
String vPCZoneIdentifier
```
      A comma-separated list of subnet IDs for your virtual private cloud (VPC).
      
      If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.
      
      Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.
    - terminationPolicies
```
SdkInternalList<T> terminationPolicies
```
      One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.
      
      For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.
    - newInstancesProtectedFromScaleIn
```
Boolean newInstancesProtectedFromScaleIn
```
      Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
      
      For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
    - lifecycleHookSpecificationList
```
SdkInternalList<T> lifecycleHookSpecificationList
```
      One or more lifecycle hooks.
    - tags
```
SdkInternalList<T> tags
```
      One or more tags.
      
      For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
    - serviceLinkedRoleARN
```
String serviceLinkedRoleARN
```
      The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.
    - maxInstanceLifetime
```
Integer maxInstanceLifetime
```
      The maximum amount of time, in seconds, that an instance can be in service.
      
      Valid Range: Minimum value of 604800.
- Class com.amazonaws.services.autoscaling.model.CreateAutoScalingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.CreateLaunchConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - launchConfigurationName
```
String launchConfigurationName
```
      The name of the launch configuration. This name must be unique per Region per account.
    - imageId
```
String imageId
```
      The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
      
      If you do not specify InstanceId, you must specify ImageId.
    - keyName
```
String keyName
```
      The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
    - securityGroups
```
SdkInternalList<T> securityGroups
```
      A list that contains the security groups to assign to the instances in the Auto Scaling group.
      
      [EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
      
      [EC2-Classic] Specify either the security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances.
    - classicLinkVPCId
```
String classicLinkVPCId
```
      The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
      
      This parameter can only be used if you are launching EC2-Classic instances.
    - classicLinkVPCSecurityGroups
```
SdkInternalList<T> classicLinkVPCSecurityGroups
```
      The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
      
      If you specify the ClassicLinkVPCId parameter, you must specify this parameter.
    - userData
```
String userData
```
      The Base64-encoded user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.
    - instanceId
```
String instanceId
```
      The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for 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 Amazon EC2 Auto Scaling User Guide.
      
      If you do not specify InstanceId, you must specify both ImageId and InstanceType.
    - instanceType
```
String instanceType
```
      Specifies the instance type of the EC2 instance.
      
      For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
      
      If you do not specify InstanceId, you must specify InstanceType.
    - kernelId
```
String kernelId
```
      The ID of the kernel associated with the AMI.
    - ramdiskId
```
String ramdiskId
```
      The ID of the RAM disk to select.
    - blockDeviceMappings
```
SdkInternalList<T> blockDeviceMappings
```
      A block device mapping, which specifies the block devices for the instance. You can specify virtual devices and EBS volumes. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
    - instanceMonitoring
```
InstanceMonitoring instanceMonitoring
```
      Controls whether instances in this group are launched with detailed (true) or basic ( false) monitoring.
      
      The default value is true (enabled).
      
      When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling 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 price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
      
      When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.
    - iamInstanceProfile
```
String iamInstanceProfile
```
      The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.
      
      For more information, see IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.
    - ebsOptimized
```
Boolean ebsOptimized
```
      Specifies whether the launch configuration is optimized for EBS I/O (true) or not ( false). 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 fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.
      
      The default value is false.
    - associatePublicIpAddress
```
Boolean associatePublicIpAddress
```
      For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. If you specify true, each instance in the Auto Scaling group receives a unique public IP address. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
      
      If you specify this parameter, you must specify at least one subnet for VPCZoneIdentifier when you create your group.
      
      If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet.
    - placementTenancy
```
String placementTenancy
```
      The tenancy of the instance. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.
      
      To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this parameter to dedicated.
      
      If you specify PlacementTenancy, you must specify at least one subnet for VPCZoneIdentifier when you create your group.
      
      For more information, see Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide.
      
      Valid Values: default | dedicated
- Class com.amazonaws.services.autoscaling.model.CreateLaunchConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.CreateOrUpdateTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tags
```
SdkInternalList<T> tags
```
      One or more tags.
- Class com.amazonaws.services.autoscaling.model.CreateOrUpdateTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.CustomizedMetricSpecification extends Object implements Serializable
  - Serialized Fields
    - metricName
```
String metricName
```
      The name of the metric.
    - namespace
```
String namespace
```
      The namespace of the metric.
    - dimensions
```
SdkInternalList<T> dimensions
```
      The dimensions of the metric.
      
      Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    - statistic
```
String statistic
```
      The statistic of the metric.
    - unit
```
String unit
```
      The unit of the metric.
- Class com.amazonaws.services.autoscaling.model.DeleteAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - forceDelete
```
Boolean forceDelete
```
      Specifies that the group is to 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.DeleteLaunchConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - launchConfigurationName
```
String launchConfigurationName
```
      The name of the launch configuration.
- Class com.amazonaws.services.autoscaling.model.DeleteLaunchConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.DeleteLifecycleHookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - lifecycleHookName
```
String lifecycleHookName
```
      The name of the lifecycle hook.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
- Class com.amazonaws.services.autoscaling.model.DeleteLifecycleHookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.DeleteNotificationConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - topicARN
```
String topicARN
```
      The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
- Class com.amazonaws.services.autoscaling.model.DeleteNotificationConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - policyName
```
String policyName
```
      The name or Amazon Resource Name (ARN) of the policy.
- Class com.amazonaws.services.autoscaling.model.DeletePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.DeleteScheduledActionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - scheduledActionName
```
String scheduledActionName
```
      The name of the action to delete.
- Class com.amazonaws.services.autoscaling.model.DeleteScheduledActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tags
```
SdkInternalList<T> tags
```
      One or more tags.
- Class com.amazonaws.services.autoscaling.model.DeleteTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeAccountLimitsRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeAccountLimitsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - maxNumberOfAutoScalingGroups
```
Integer maxNumberOfAutoScalingGroups
```
      The maximum number of groups allowed for your AWS account. The default limit is 200 per AWS Region.
    - maxNumberOfLaunchConfigurations
```
Integer maxNumberOfLaunchConfigurations
```
      The maximum number of launch configurations allowed for your AWS account. The default limit is 200 per AWS Region.
    - numberOfAutoScalingGroups
```
Integer numberOfAutoScalingGroups
```
      The current number of groups for your AWS account.
    - numberOfLaunchConfigurations
```
Integer numberOfLaunchConfigurations
```
      The current number of launch configurations for your AWS account.
- Class com.amazonaws.services.autoscaling.model.DescribeAdjustmentTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeAdjustmentTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - adjustmentTypes
```
SdkInternalList<T> adjustmentTypes
```
      The policy adjustment types.
- Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupNames
```
SdkInternalList<T> autoScalingGroupNames
```
      The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.
      
      If you omit this parameter, all Auto Scaling groups are described.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
- Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - autoScalingGroups
```
SdkInternalList<T> autoScalingGroups
```
      The groups.
    - nextToken
```
String nextToken
```
      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
- Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
SdkInternalList<T> instanceIds
```
      The IDs of the instances. You can specify up to MaxRecords 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. The default value is 50 and the maximum value is 50.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
- Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - autoScalingInstances
```
SdkInternalList<T> autoScalingInstances
```
      The instances.
    - nextToken
```
String nextToken
```
      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
- Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingNotificationTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingNotificationTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - autoScalingNotificationTypes
```
SdkInternalList<T> autoScalingNotificationTypes
```
      The notification types.
- Class com.amazonaws.services.autoscaling.model.DescribeLaunchConfigurationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - launchConfigurationNames
```
SdkInternalList<T> launchConfigurationNames
```
      The launch configuration names. If you omit this parameter, all launch configurations are described.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
- Class com.amazonaws.services.autoscaling.model.DescribeLaunchConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - launchConfigurations
```
SdkInternalList<T> launchConfigurations
```
      The launch configurations.
    - nextToken
```
String nextToken
```
      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
- Class com.amazonaws.services.autoscaling.model.DescribeLifecycleHooksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - lifecycleHookNames
```
SdkInternalList<T> lifecycleHookNames
```
      The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.
- Class com.amazonaws.services.autoscaling.model.DescribeLifecycleHooksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - lifecycleHooks
```
SdkInternalList<T> lifecycleHooks
```
      The lifecycle hooks for the specified group.
- Class com.amazonaws.services.autoscaling.model.DescribeLifecycleHookTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeLifecycleHookTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - lifecycleHookTypes
```
SdkInternalList<T> lifecycleHookTypes
```
      The lifecycle hook types.
- Class com.amazonaws.services.autoscaling.model.DescribeLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.
- Class com.amazonaws.services.autoscaling.model.DescribeLoadBalancersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - loadBalancers
```
SdkInternalList<T> loadBalancers
```
      The load balancers.
    - nextToken
```
String nextToken
```
      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
- Class com.amazonaws.services.autoscaling.model.DescribeLoadBalancerTargetGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.
- Class com.amazonaws.services.autoscaling.model.DescribeLoadBalancerTargetGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - loadBalancerTargetGroups
```
SdkInternalList<T> loadBalancerTargetGroups
```
      Information about the target groups.
    - nextToken
```
String nextToken
```
      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
- Class com.amazonaws.services.autoscaling.model.DescribeMetricCollectionTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeMetricCollectionTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - metrics
```
SdkInternalList<T> metrics
```
      One or more metrics.
    - granularities
```
SdkInternalList<T> granularities
```
      The granularities for the metrics.
- Class com.amazonaws.services.autoscaling.model.DescribeNotificationConfigurationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupNames
```
SdkInternalList<T> autoScalingGroupNames
```
      The name of the Auto Scaling group.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
- Class com.amazonaws.services.autoscaling.model.DescribeNotificationConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - notificationConfigurations
```
SdkInternalList<T> notificationConfigurations
```
      The notification configurations.
    - nextToken
```
String nextToken
```
      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
- Class com.amazonaws.services.autoscaling.model.DescribePoliciesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - policyNames
```
SdkInternalList<T> policyNames
```
      The names of one or more policies. If you omit this parameter, all policies are described. If a 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
```
SdkInternalList<T> policyTypes
```
      One or more policy types. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.
- Class com.amazonaws.services.autoscaling.model.DescribePoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - scalingPolicies
```
SdkInternalList<T> scalingPolicies
```
      The scaling policies.
    - nextToken
```
String nextToken
```
      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
- Class com.amazonaws.services.autoscaling.model.DescribeScalingActivitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - activityIds
```
SdkInternalList<T> activityIds
```
      The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call. The default value is 100 and the maximum value 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.DescribeScalingActivitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - activities
```
SdkInternalList<T> activities
```
      The scaling activities. Activities are sorted by start time. Activities still in progress are described first.
    - nextToken
```
String nextToken
```
      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
- Class com.amazonaws.services.autoscaling.model.DescribeScalingProcessTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeScalingProcessTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - processes
```
SdkInternalList<T> processes
```
      The names of the process types.
- Class com.amazonaws.services.autoscaling.model.DescribeScheduledActionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - scheduledActionNames
```
SdkInternalList<T> scheduledActionNames
```
      The names of one or more scheduled actions. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.
    - startTime
```
Date startTime
```
      The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    - endTime
```
Date endTime
```
      The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
- Class com.amazonaws.services.autoscaling.model.DescribeScheduledActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - scheduledUpdateGroupActions
```
SdkInternalList<T> scheduledUpdateGroupActions
```
      The scheduled actions.
    - nextToken
```
String nextToken
```
      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
- Class com.amazonaws.services.autoscaling.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
SdkInternalList<T> filters
```
      One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, auto-scaling-group) is 1000.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.
- Class com.amazonaws.services.autoscaling.model.DescribeTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
SdkInternalList<T> tags
```
      One or more tags.
    - nextToken
```
String nextToken
```
      A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.
- Class com.amazonaws.services.autoscaling.model.DescribeTerminationPolicyTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeTerminationPolicyTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - terminationPolicyTypes
```
SdkInternalList<T> terminationPolicyTypes
```
      The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default, OldestLaunchTemplate, and AllocationStrategy.
- Class com.amazonaws.services.autoscaling.model.DetachInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
SdkInternalList<T> instanceIds
```
      The IDs of the instances. You can specify up to 20 instances.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - shouldDecrementDesiredCapacity
```
Boolean shouldDecrementDesiredCapacity
```
      Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.
- Class com.amazonaws.services.autoscaling.model.DetachInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - activities
```
SdkInternalList<T> activities
```
      The activities related to detaching the instances from the Auto Scaling group.
- Class com.amazonaws.services.autoscaling.model.DetachLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - loadBalancerNames
```
SdkInternalList<T> loadBalancerNames
```
      The names of the load balancers. You can specify up to 10 load balancers.
- Class com.amazonaws.services.autoscaling.model.DetachLoadBalancersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.DetachLoadBalancerTargetGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - targetGroupARNs
```
SdkInternalList<T> targetGroupARNs
```
      The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.
- Class com.amazonaws.services.autoscaling.model.DetachLoadBalancerTargetGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.DisableMetricsCollectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - metrics
```
SdkInternalList<T> metrics
```
      One or more of the following metrics. If you omit this parameter, all metrics are disabled.
      
      GroupMinSize
      
      GroupMaxSize
      
      GroupDesiredCapacity
      
      GroupInServiceInstances
      
      GroupPendingInstances
      
      GroupStandbyInstances
      
      GroupTerminatingInstances
      
      GroupTotalInstances
- Class com.amazonaws.services.autoscaling.model.DisableMetricsCollectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.Ebs extends Object implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The snapshot ID of the volume to use.
      
      Conditional: This parameter is optional if you specify a volume size. If you specify both SnapshotId and VolumeSize, VolumeSize must be equal or greater than the size of the snapshot.
    - volumeSize
```
Integer volumeSize
```
      The volume size, in Gibibytes (GiB).
      
      This can be a number from 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. 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.
      
      At least one of VolumeSize or SnapshotId is required.
    - volumeType
```
String volumeType
```
      The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.
      
      Valid Values: standard | io1 | gp2 | st1 | sc1
    - deleteOnTermination
```
Boolean deleteOnTermination
```
      Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.
    - iops
```
Integer iops
```
      The number of I/O operations per second (IOPS) to provision for the volume. The maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.
      
      Conditional: This parameter is required when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)
    - encrypted
```
Boolean encrypted
```
      Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.
      
      If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the AWS managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK.
      
      Enabling encryption by default results in all EBS volumes being encrypted with the AWS managed CMK or a customer managed CMK, whether or not the snapshot was encrypted.
      
      For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK Key Policy for Use with Encrypted Volumes in the Amazon EC2 Auto Scaling User Guide.
- Class com.amazonaws.services.autoscaling.model.EnabledMetric extends Object implements Serializable
  - Serialized Fields
    - metric
```
String metric
```
      One of the following metrics:
      
      GroupMinSize
      
      GroupMaxSize
      
      GroupDesiredCapacity
      
      GroupInServiceInstances
      
      GroupPendingInstances
      
      GroupStandbyInstances
      
      GroupTerminatingInstances
      
      GroupTotalInstances
    - granularity
```
String granularity
```
      The granularity of the metric. The only valid value is 1Minute.
- Class com.amazonaws.services.autoscaling.model.EnableMetricsCollectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - metrics
```
SdkInternalList<T> metrics
```
      One or more of the following metrics. If you omit this parameter, all metrics are enabled.
      
      GroupMinSize
      
      GroupMaxSize
      
      GroupDesiredCapacity
      
      GroupInServiceInstances
      
      GroupPendingInstances
      
      GroupStandbyInstances
      
      GroupTerminatingInstances
      
      GroupTotalInstances
    - granularity
```
String granularity
```
      The granularity to associate with the metrics to collect. The only valid value is 1Minute.
- Class com.amazonaws.services.autoscaling.model.EnableMetricsCollectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.EnterStandbyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
SdkInternalList<T> instanceIds
```
      The IDs of the instances. You can specify up to 20 instances.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - shouldDecrementDesiredCapacity
```
Boolean shouldDecrementDesiredCapacity
```
      Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.
- Class com.amazonaws.services.autoscaling.model.EnterStandbyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - activities
```
SdkInternalList<T> activities
```
      The activities related to moving instances into Standby mode.
- Class com.amazonaws.services.autoscaling.model.ExecutePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - policyName
```
String policyName
```
      The name or ARN of the policy.
    - honorCooldown
```
Boolean honorCooldown
```
      Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.
      
      This parameter is not supported if the policy type is StepScaling or TargetTrackingScaling.
      
      For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User 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.
      
      Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.
    - breachThreshold
```
Double breachThreshold
```
      The breach threshold for the alarm.
      
      Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.
- Class com.amazonaws.services.autoscaling.model.ExecutePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.ExitStandbyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
SdkInternalList<T> instanceIds
```
      The IDs of the instances. You can specify up to 20 instances.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
- Class com.amazonaws.services.autoscaling.model.ExitStandbyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - activities
```
SdkInternalList<T> activities
```
      The activities related to moving instances out of Standby mode.
- Class com.amazonaws.services.autoscaling.model.FailedScheduledUpdateGroupActionRequest extends Object implements Serializable
  - Serialized Fields
    - scheduledActionName
```
String scheduledActionName
```
      The name of the scheduled action.
    - errorCode
```
String errorCode
```
      The error code.
    - errorMessage
```
String errorMessage
```
      The error message accompanying the error code.
- Class com.amazonaws.services.autoscaling.model.Filter extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the filter. The valid values are: "auto-scaling-group", "key", "value", and "propagate-at-launch".
    - values
```
SdkInternalList<T> values
```
      The value of the filter.
- Class com.amazonaws.services.autoscaling.model.Instance extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - instanceType
```
String instanceType
```
      The instance type of the EC2 instance.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone in which the instance is running.
    - lifecycleState
```
String lifecycleState
```
      A description of the current lifecycle state. The Quarantined state is not used.
    - healthStatus
```
String healthStatus
```
      The last reported 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 that Amazon EC2 Auto Scaling should terminate and replace it.
    - launchConfigurationName
```
String launchConfigurationName
```
      The launch configuration associated with the instance.
    - launchTemplate
```
LaunchTemplateSpecification launchTemplate
```
      The launch template for the instance.
    - protectedFromScaleIn
```
Boolean protectedFromScaleIn
```
      Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
    - weightedCapacity
```
String weightedCapacity
```
      The number of capacity units contributed by the instance based on its instance type.
      
      Valid Range: Minimum value of 1. Maximum value of 999.
- Class com.amazonaws.services.autoscaling.model.InstanceMonitoring extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
- Class com.amazonaws.services.autoscaling.model.InstancesDistribution extends Object implements Serializable
  - Serialized Fields
    - onDemandAllocationStrategy
```
String onDemandAllocationStrategy
```
      Indicates how to allocate instance types to fulfill On-Demand capacity.
      
      The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.
    - onDemandBaseCapacity
```
Integer onDemandBaseCapacity
```
      The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.
      
      Default if not set is 0. If you leave it set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.
      
      An update to this setting means a gradual replacement of instances to maintain the specified number of On-Demand Instances for your base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones.
    - onDemandPercentageAboveBaseCapacity
```
Integer onDemandPercentageAboveBaseCapacity
```
      Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
      
      Default if not set is 100. If you leave it set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.
      
      An update to this setting means a gradual replacement of instances to maintain the percentage of On-Demand Instances for your additional capacity above the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones.
      
      Valid Range: Minimum value of 0. Maximum value of 100.
    - spotAllocationStrategy
```
String spotAllocationStrategy
```
      Indicates how to allocate instances across Spot Instance pools.
      
      If the allocation strategy is lowest-price, the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify. If the allocation strategy is capacity-optimized, the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity.
      
      The default Spot allocation strategy for calls that you make through the API, the AWS CLI, or the AWS SDKs is lowest-price. The default Spot allocation strategy for the AWS Management Console is capacity-optimized.
      
      Valid values: lowest-price | capacity-optimized
    - spotInstancePools
```
Integer spotInstancePools
```
      The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate. Default if not set is 2.
      
      Used only when the Spot allocation strategy is lowest-price.
      
      Valid Range: Minimum value of 1. Maximum value of 20.
    - spotMaxPrice
```
String spotMaxPrice
```
      The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.
      
      To remove a value that you previously set, include the parameter but leave the value blank.
- Class com.amazonaws.services.autoscaling.model.InvalidNextTokenException extends AmazonAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.LaunchConfiguration extends Object implements Serializable
  - Serialized Fields
    - launchConfigurationName
```
String launchConfigurationName
```
      The name of the launch configuration.
    - launchConfigurationARN
```
String launchConfigurationARN
```
      The Amazon Resource Name (ARN) of the launch configuration.
    - imageId
```
String imageId
```
      The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.
      
      For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.
    - keyName
```
String keyName
```
      The name of the key pair.
      
      For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
    - securityGroups
```
SdkInternalList<T> securityGroups
```
      A list that contains the security groups to assign to the instances in the Auto Scaling group.
      
      For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
    - classicLinkVPCId
```
String classicLinkVPCId
```
      The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
      
      For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
    - classicLinkVPCSecurityGroups
```
SdkInternalList<T> classicLinkVPCSecurityGroups
```
      The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId.
      
      For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
    - userData
```
String userData
```
      The Base64-encoded user data to make available to the launched EC2 instances.
      
      For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.
    - instanceType
```
String instanceType
```
      The instance type for the instances.
      
      For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.
    - kernelId
```
String kernelId
```
      The ID of the kernel associated with the AMI.
    - ramdiskId
```
String ramdiskId
```
      The ID of the RAM disk associated with the AMI.
    - blockDeviceMappings
```
SdkInternalList<T> blockDeviceMappings
```
      A block device mapping, which specifies the block devices for the instance.
      
      For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.
    - instanceMonitoring
```
InstanceMonitoring instanceMonitoring
```
      Controls whether instances in this group are launched with detailed (true) or basic ( false) monitoring.
      
      For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling 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 price.
      
      For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling 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. The instance profile contains the IAM role.
      
      For more information, see IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.
    - createdTime
```
Date createdTime
```
      The creation date and time for the launch configuration.
    - ebsOptimized
```
Boolean ebsOptimized
```
      Specifies whether the launch configuration is optimized for EBS I/O (true) or not ( false).
      
      For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.
    - associatePublicIpAddress
```
Boolean associatePublicIpAddress
```
      For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP address to the group's instances.
      
      For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.
    - placementTenancy
```
String placementTenancy
```
      The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.
      
      For more information, see Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide.
- Class com.amazonaws.services.autoscaling.model.LaunchTemplate extends Object implements Serializable
  - Serialized Fields
    - launchTemplateSpecification
```
LaunchTemplateSpecification launchTemplateSpecification
```
      The launch template to use. You must specify either the launch template ID or launch template name in the request.
    - overrides
```
SdkInternalList<T> overrides
```
      An optional setting. Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type. You can specify between 1 and 20 instance types.
- Class com.amazonaws.services.autoscaling.model.LaunchTemplateOverrides extends Object implements Serializable
  - Serialized Fields
    - instanceType
```
String instanceType
```
      The instance type.
      
      For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.
    - weightedCapacity
```
String weightedCapacity
```
      The number of capacity units, which gives the instance type a proportional weight to other instance types. For example, larger instance types are generally weighted more than smaller instance types. These are the same units that you chose to set the desired capacity in terms of instances, or a performance attribute such as vCPUs, memory, or I/O.
      
      Valid Range: Minimum value of 1. Maximum value of 999.
- Class com.amazonaws.services.autoscaling.model.LaunchTemplateSpecification extends Object implements Serializable
  - Serialized Fields
    - launchTemplateId
```
String launchTemplateId
```
      The ID of the launch template. You must specify either a template ID or a template name.
    - launchTemplateName
```
String launchTemplateName
```
      The name of the launch template. You must specify either a template name or a template ID.
    - version
```
String version
```
      The version number, $Latest, or $Default. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.
- Class com.amazonaws.services.autoscaling.model.LifecycleHook extends Object implements Serializable
  - Serialized Fields
    - lifecycleHookName
```
String lifecycleHookName
```
      The name of the lifecycle hook.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group for the lifecycle hook.
    - lifecycleTransition
```
String lifecycleTransition
```
      The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:
      
      autoscaling:EC2_INSTANCE_LAUNCHING
      
      autoscaling:EC2_INSTANCE_TERMINATING
    - notificationTargetARN
```
String notificationTargetARN
```
      The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
    - roleARN
```
String roleARN
```
      The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
    - notificationMetadata
```
String notificationMetadata
```
      Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
    - heartbeatTimeout
```
Integer heartbeatTimeout
```
      The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter.
    - globalTimeout
```
Integer globalTimeout
```
      The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.
    - 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 possible values are CONTINUE and ABANDON.
- Class com.amazonaws.services.autoscaling.model.LifecycleHookSpecification extends Object implements Serializable
  - Serialized Fields
    - 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. The valid values are:
      
      autoscaling:EC2_INSTANCE_LAUNCHING
      
      autoscaling:EC2_INSTANCE_TERMINATING
    - notificationMetadata
```
String notificationMetadata
```
      Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
    - heartbeatTimeout
```
Integer heartbeatTimeout
```
      The maximum time, in seconds, that can elapse before the lifecycle hook times out.
      
      If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
    - 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 ABANDON.
    - notificationTargetARN
```
String notificationTargetARN
```
      The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.
    - roleARN
```
String roleARN
```
      The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
- Class com.amazonaws.services.autoscaling.model.LimitExceededException extends AmazonAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.LoadBalancerState extends Object implements Serializable
  - Serialized Fields
    - loadBalancerName
```
String loadBalancerName
```
      The name of the load balancer.
    - state
```
String state
```
      One of the following load balancer states:
      
      Adding - The instances in the group are being registered with the load balancer.
      
      Added - All instances in the group are registered with the load balancer.
      
      InService - At least one instance in the group passed an ELB health check.
      
      Removing - The instances in the group 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.
      
      Removed - All instances in the group are deregistered from the load balancer.
- Class com.amazonaws.services.autoscaling.model.LoadBalancerTargetGroupState extends Object implements Serializable
  - Serialized Fields
    - loadBalancerTargetGroupARN
```
String loadBalancerTargetGroupARN
```
      The Amazon Resource Name (ARN) of the target group.
    - state
```
String state
```
      The state of the target group.
      
      Adding - The Auto Scaling instances are being registered with the target group.
      
      Added - All Auto Scaling instances are registered with the target group.
      
      InService - At least one Auto Scaling instance passed an ELB health check.
      
      Removing - The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.
      
      Removed - All Auto Scaling instances are deregistered from the target group.
- Class com.amazonaws.services.autoscaling.model.MetricCollectionType extends Object implements Serializable
  - Serialized Fields
    - metric
```
String metric
```
      One of the following metrics:
      
      GroupMinSize
      
      GroupMaxSize
      
      GroupDesiredCapacity
      
      GroupInServiceInstances
      
      GroupPendingInstances
      
      GroupStandbyInstances
      
      GroupTerminatingInstances
      
      GroupTotalInstances
- Class com.amazonaws.services.autoscaling.model.MetricDimension extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the dimension.
    - value
```
String value
```
      The value of the dimension.
- Class com.amazonaws.services.autoscaling.model.MetricGranularityType extends Object implements Serializable
  - Serialized Fields
    - granularity
```
String granularity
```
      The granularity. The only valid value is 1Minute.
- Class com.amazonaws.services.autoscaling.model.MixedInstancesPolicy extends Object implements Serializable
  - Serialized Fields
    - launchTemplate
```
LaunchTemplate launchTemplate
```
      The launch template and instance types (overrides).
      
      This parameter must be specified when creating a mixed instances policy.
    - instancesDistribution
```
InstancesDistribution instancesDistribution
```
      The instances distribution to use.
      
      If you leave this parameter unspecified, the value for each parameter in InstancesDistribution uses a default value.
- Class com.amazonaws.services.autoscaling.model.NotificationConfiguration extends Object 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 (Amazon SNS) topic.
    - notificationType
```
String notificationType
```
      One of the following event notification types:
      
      autoscaling:EC2_INSTANCE_LAUNCH
      
      autoscaling:EC2_INSTANCE_LAUNCH_ERROR
      
      autoscaling:EC2_INSTANCE_TERMINATE
      
      autoscaling:EC2_INSTANCE_TERMINATE_ERROR
      
      autoscaling:TEST_NOTIFICATION
- Class com.amazonaws.services.autoscaling.model.PredefinedMetricSpecification extends Object implements Serializable
  - Serialized Fields
    - predefinedMetricType
```
String predefinedMetricType
```
      The metric type. The following predefined metrics are available:
      
      ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.
      
      ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.
      
      ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.
      
      ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.
    - resourceLabel
```
String resourceLabel
```
      Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Auto Scaling group.
      
      The format is app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where
      
      app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and
      
      targetgroup/target-group-name/target-group-id is the final portion of the target group ARN.
- Class com.amazonaws.services.autoscaling.model.ProcessType extends Object implements Serializable
  - Serialized Fields
    - processName
```
String processName
```
      One of the following processes:
      
      Launch
      
      Terminate
      
      AddToLoadBalancer
      
      AlarmNotification
      
      AZRebalance
      
      HealthCheck
      
      ReplaceUnhealthy
      
      ScheduledActions
- Class com.amazonaws.services.autoscaling.model.PutLifecycleHookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - lifecycleHookName
```
String lifecycleHookName
```
      The name of the lifecycle hook.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - lifecycleTransition
```
String lifecycleTransition
```
      The instance state to which you want to attach the lifecycle hook. The valid values are:
      
      autoscaling:EC2_INSTANCE_LAUNCHING
      
      autoscaling:EC2_INSTANCE_TERMINATING
      
      Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
    - roleARN
```
String roleARN
```
      The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
      
      Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.
    - notificationTargetARN
```
String notificationTargetARN
```
      The ARN of the notification target that Amazon EC2 Auto Scaling uses 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.
      
      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, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: "Event": "autoscaling:TEST_NOTIFICATION".
    - notificationMetadata
```
String notificationMetadata
```
      Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
    - heartbeatTimeout
```
Integer heartbeatTimeout
```
      The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).
      
      If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
    - 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.
- Class com.amazonaws.services.autoscaling.model.PutLifecycleHookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.PutNotificationConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - topicARN
```
String topicARN
```
      The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) topic.
    - notificationTypes
```
SdkInternalList<T> notificationTypes
```
      The type of event that causes the notification to be sent. For more information about notification types supported by Amazon EC2 Auto Scaling, see DescribeAutoScalingNotificationTypes.
- Class com.amazonaws.services.autoscaling.model.PutNotificationConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.PutScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - policyName
```
String policyName
```
      The name of the policy.
    - policyType
```
String policyType
```
      The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.
    - adjustmentType
```
String adjustmentType
```
      Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
      
      Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.
    - minAdjustmentStep
```
Integer minAdjustmentStep
```
      Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    - minAdjustmentMagnitude
```
Integer minAdjustmentMagnitude
```
      The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
      
      This property replaces the MinAdjustmentStep property. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.
      
      Valid only if the policy type is SimpleScaling or StepScaling.
    - scalingAdjustment
```
Integer scalingAdjustment
```
      The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.
      
      Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
    - cooldown
```
Integer cooldown
```
      The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.
      
      Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
    - metricAggregationType
```
String metricAggregationType
```
      The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
      
      Valid only if the policy type is StepScaling.
    - stepAdjustments
```
SdkInternalList<T> stepAdjustments
```
      A set of adjustments that enable you to scale based on the size of the alarm breach.
      
      Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
    - 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.
      
      Valid only if the policy type is StepScaling or TargetTrackingScaling.
    - targetTrackingConfiguration
```
TargetTrackingConfiguration targetTrackingConfiguration
```
      A target tracking scaling policy. Includes support for predefined or customized metrics.
      
      For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.
      
      Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)
- Class com.amazonaws.services.autoscaling.model.PutScalingPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - policyARN
```
String policyARN
```
      The Amazon Resource Name (ARN) of the policy.
    - alarms
```
SdkInternalList<T> alarms
```
      The CloudWatch alarms created for the target tracking scaling policy.
- Class com.amazonaws.services.autoscaling.model.PutScheduledUpdateGroupActionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - scheduledActionName
```
String scheduledActionName
```
      The name of this scaling action.
    - time
```
Date time
```
      This parameter is no longer used.
    - startTime
```
Date startTime
```
      The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z").
      
      If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.
      
      If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
    - endTime
```
Date endTime
```
      The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.
    - recurrence
```
String recurrence
```
      The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.
      
      When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.
    - minSize
```
Integer minSize
```
      The minimum number of instances in the Auto Scaling group.
    - maxSize
```
Integer maxSize
```
      The maximum number of instances in the Auto Scaling group.
    - desiredCapacity
```
Integer desiredCapacity
```
      The number of EC2 instances that should be running in the Auto Scaling group.
- Class com.amazonaws.services.autoscaling.model.PutScheduledUpdateGroupActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.RecordLifecycleActionHeartbeatRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - lifecycleHookName
```
String lifecycleHookName
```
      The name of the lifecycle hook.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - lifecycleActionToken
```
String lifecycleActionToken
```
      A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when you created the lifecycle hook.
    - instanceId
```
String instanceId
```
      The ID of the instance.
- Class com.amazonaws.services.autoscaling.model.RecordLifecycleActionHeartbeatResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.ResourceContentionException extends AmazonAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.ResourceInUseException extends AmazonAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.ResumeProcessesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - scalingProcesses
```
SdkInternalList<T> scalingProcesses
```
      One or more of the following processes. If you omit this parameter, all processes are specified.
      
      Launch
      
      Terminate
      
      HealthCheck
      
      ReplaceUnhealthy
      
      AZRebalance
      
      AlarmNotification
      
      ScheduledActions
      
      AddToLoadBalancer
- Class com.amazonaws.services.autoscaling.model.ResumeProcessesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.ScalingActivityInProgressException extends AmazonAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.ScalingPolicy extends Object implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - policyName
```
String policyName
```
      The name of the scaling policy.
    - policyARN
```
String policyARN
```
      The Amazon Resource Name (ARN) of the policy.
    - policyType
```
String policyType
```
      The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.
    - adjustmentType
```
String adjustmentType
```
      The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    - minAdjustmentStep
```
Integer minAdjustmentStep
```
      Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    - minAdjustmentMagnitude
```
Integer minAdjustmentMagnitude
```
      The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.
    - scalingAdjustment
```
Integer scalingAdjustment
```
      The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
    - cooldown
```
Integer cooldown
```
      The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.
    - stepAdjustments
```
SdkInternalList<T> stepAdjustments
```
      A set of adjustments that enable you to scale based on the size of the alarm breach.
    - metricAggregationType
```
String metricAggregationType
```
      The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.
    - estimatedInstanceWarmup
```
Integer estimatedInstanceWarmup
```
      The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
    - alarms
```
SdkInternalList<T> alarms
```
      The CloudWatch alarms related to the policy.
    - targetTrackingConfiguration
```
TargetTrackingConfiguration targetTrackingConfiguration
```
      A target tracking scaling policy.
- Class com.amazonaws.services.autoscaling.model.ScheduledUpdateGroupAction extends Object implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - scheduledActionName
```
String scheduledActionName
```
      The name of the scheduled action.
    - scheduledActionARN
```
String scheduledActionARN
```
      The Amazon Resource Name (ARN) of the scheduled action.
    - time
```
Date time
```
      This parameter is no longer used.
    - startTime
```
Date startTime
```
      The date and time in UTC for this action to start. For example, "2019-06-01T00:00:00Z".
    - endTime
```
Date endTime
```
      The date and time in UTC for the recurring schedule to end. For example, "2019-06-01T00:00:00Z".
    - recurrence
```
String recurrence
```
      The recurring schedule for the action, in Unix cron syntax format.
      
      When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.
    - minSize
```
Integer minSize
```
      The minimum number of instances in the Auto Scaling group.
    - maxSize
```
Integer maxSize
```
      The maximum number of instances in the Auto Scaling group.
    - desiredCapacity
```
Integer desiredCapacity
```
      The number of instances you prefer to maintain in the group.
- Class com.amazonaws.services.autoscaling.model.ScheduledUpdateGroupActionRequest extends Object implements Serializable
  - Serialized Fields
    - scheduledActionName
```
String scheduledActionName
```
      The name of the scaling action.
    - startTime
```
Date startTime
```
      The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, "2019-06-01T00:00:00Z").
      
      If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.
      
      If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.
    - endTime
```
Date endTime
```
      The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.
    - recurrence
```
String recurrence
```
      The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.
      
      When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.
    - minSize
```
Integer minSize
```
      The minimum number of instances in the Auto Scaling group.
    - maxSize
```
Integer maxSize
```
      The maximum number of instances in the Auto Scaling group.
    - desiredCapacity
```
Integer desiredCapacity
```
      The number of EC2 instances that should be running in the group.
- Class com.amazonaws.services.autoscaling.model.ServiceLinkedRoleFailureException extends AmazonAutoScalingException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.SetDesiredCapacityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - desiredCapacity
```
Integer desiredCapacity
```
      The number of EC2 instances that should be running in the Auto Scaling group.
    - honorCooldown
```
Boolean honorCooldown
```
      Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.
- Class com.amazonaws.services.autoscaling.model.SetDesiredCapacityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.SetInstanceHealthRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - healthStatus
```
String healthStatus
```
      The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.
    - shouldRespectGracePeriod
```
Boolean shouldRespectGracePeriod
```
      If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group.
      
      For more information about the health check grace period, see CreateAutoScalingGroup.
- Class com.amazonaws.services.autoscaling.model.SetInstanceHealthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.SetInstanceProtectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
SdkInternalList<T> instanceIds
```
      One or more instance IDs.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - protectedFromScaleIn
```
Boolean protectedFromScaleIn
```
      Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
- Class com.amazonaws.services.autoscaling.model.SetInstanceProtectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.StepAdjustment extends Object implements Serializable
  - Serialized Fields
    - metricIntervalLowerBound
```
Double metricIntervalLowerBound
```
      The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
    - metricIntervalUpperBound
```
Double metricIntervalUpperBound
```
      The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
      
      The upper bound must be greater than the lower bound.
    - scalingAdjustment
```
Integer scalingAdjustment
```
      The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.
- Class com.amazonaws.services.autoscaling.model.SuspendedProcess extends Object implements Serializable
  - Serialized Fields
    - processName
```
String processName
```
      The name of the suspended process.
    - suspensionReason
```
String suspensionReason
```
      The reason that the process was suspended.
- Class com.amazonaws.services.autoscaling.model.SuspendProcessesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - scalingProcesses
```
SdkInternalList<T> scalingProcesses
```
      One or more of the following processes. If you omit this parameter, all processes are specified.
      
      Launch
      
      Terminate
      
      HealthCheck
      
      ReplaceUnhealthy
      
      AZRebalance
      
      AlarmNotification
      
      ScheduledActions
      
      AddToLoadBalancer
- Class com.amazonaws.services.autoscaling.model.SuspendProcessesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscaling.model.Tag extends Object implements Serializable
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The name of the group.
    - resourceType
```
String resourceType
```
      The type of resource. The only supported value is auto-scaling-group.
    - key
```
String key
```
      The tag key.
    - value
```
String value
```
      The tag value.
    - propagateAtLaunch
```
Boolean propagateAtLaunch
```
      Determines whether the tag is added to new instances as they are launched in the group.
- Class com.amazonaws.services.autoscaling.model.TagDescription extends Object implements Serializable
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The name of the group.
    - resourceType
```
String resourceType
```
      The type of resource. The only supported value is auto-scaling-group.
    - key
```
String key
```
      The tag key.
    - value
```
String value
```
      The tag value.
    - propagateAtLaunch
```
Boolean propagateAtLaunch
```
      Determines whether the tag is added to new instances as they are launched in the group.
- Class com.amazonaws.services.autoscaling.model.TargetTrackingConfiguration extends Object implements Serializable
  - Serialized Fields
    - predefinedMetricSpecification
```
PredefinedMetricSpecification predefinedMetricSpecification
```
      A predefined metric. You must specify either a predefined metric or a customized metric.
    - customizedMetricSpecification
```
CustomizedMetricSpecification customizedMetricSpecification
```
      A customized metric. You must specify either a predefined metric or a customized metric.
    - targetValue
```
Double targetValue
```
      The target value for the metric.
    - disableScaleIn
```
Boolean disableScaleIn
```
      Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false.
- Class com.amazonaws.services.autoscaling.model.TerminateInstanceInAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - shouldDecrementDesiredCapacity
```
Boolean shouldDecrementDesiredCapacity
```
      Indicates whether terminating the instance also decrements the size of the Auto Scaling group.
- Class com.amazonaws.services.autoscaling.model.TerminateInstanceInAutoScalingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - activity
```
Activity activity
```
      A scaling activity.
- Class com.amazonaws.services.autoscaling.model.UpdateAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - launchConfigurationName
```
String launchConfigurationName
```
      The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.
    - launchTemplate
```
LaunchTemplateSpecification launchTemplate
```
      The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify LaunchConfigurationName or MixedInstancesPolicy.
      
      For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference.
    - mixedInstancesPolicy
```
MixedInstancesPolicy mixedInstancesPolicy
```
      An embedded object that specifies a mixed instances policy.
      
      In your call to UpdateAutoScalingGroup, you can make changes to the policy that is specified. All optional parameters are left unchanged if not specified.
      
      For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.
    - minSize
```
Integer minSize
```
      The minimum size of the Auto Scaling group.
    - maxSize
```
Integer maxSize
```
      The maximum size of the Auto Scaling group.
    - desiredCapacity
```
Integer desiredCapacity
```
      The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
    - defaultCooldown
```
Integer defaultCooldown
```
      The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. This cooldown period is not used when a scaling-specific cooldown is specified.
      
      Cooldown periods are not supported for target tracking scaling policies, step scaling policies, or scheduled scaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.
    - availabilityZones
```
SdkInternalList<T> availabilityZones
```
      One or more Availability Zones for the group.
    - healthCheckType
```
String healthCheckType
```
      The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.
    - healthCheckGracePeriod
```
Integer healthCheckGracePeriod
```
      The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is 0.
      
      For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide.
      
      Conditional: This parameter is required if you are adding an ELB health check.
    - placementGroup
```
String placementGroup
```
      The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
    - vPCZoneIdentifier
```
String vPCZoneIdentifier
```
      A comma-separated list of subnet IDs for virtual private cloud (VPC).
      
      If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.
    - terminationPolicies
```
SdkInternalList<T> terminationPolicies
```
      A standalone termination policy or a list of termination policies used to select the instance to terminate. The policies are executed in the order that they are listed.
      
      For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.
    - newInstancesProtectedFromScaleIn
```
Boolean newInstancesProtectedFromScaleIn
```
      Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
      
      For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
    - serviceLinkedRoleARN
```
String serviceLinkedRoleARN
```
      The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.
    - maxInstanceLifetime
```
Integer maxInstanceLifetime
```
      The maximum amount of time, in seconds, that an instance can be in service.
      
      Valid Range: Minimum value of 604800.
- Class com.amazonaws.services.autoscaling.model.UpdateAutoScalingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
Package com.amazonaws.services.autoscalingplans.model
- Class com.amazonaws.services.autoscalingplans.model.ApplicationSource extends Object implements Serializable
  - Serialized Fields
    - cloudFormationStackARN
```
String cloudFormationStackARN
```
      The Amazon Resource Name (ARN) of a AWS CloudFormation stack.
    - tagFilters
```
List<E> tagFilters
```
      A set of tags (up to 50).
- Class com.amazonaws.services.autoscalingplans.model.AWSAutoScalingPlansException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscalingplans.model.ConcurrentUpdateException extends AWSAutoScalingPlansException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscalingplans.model.CreateScalingPlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - scalingPlanName
```
String scalingPlanName
```
      The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.
    - applicationSource
```
ApplicationSource applicationSource
```
      A CloudFormation stack or set of tags. You can create one scaling plan per application source.
    - scalingInstructions
```
List<E> scalingInstructions
```
      The scaling instructions.
- Class com.amazonaws.services.autoscalingplans.model.CreateScalingPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - scalingPlanVersion
```
Long scalingPlanVersion
```
      The version number of the scaling plan. This value is always 1.
      
      Currently, you cannot specify multiple scaling plan versions.
- Class com.amazonaws.services.autoscalingplans.model.CustomizedLoadMetricSpecification extends Object implements Serializable
  - Serialized Fields
    - metricName
```
String metricName
```
      The name of the metric.
    - namespace
```
String namespace
```
      The namespace of the metric.
    - dimensions
```
List<E> dimensions
```
      The dimensions of the metric.
      
      Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.
    - statistic
```
String statistic
```
      The statistic of the metric. Currently, the value must always be Sum.
    - unit
```
String unit
```
      The unit of the metric.
- Class com.amazonaws.services.autoscalingplans.model.CustomizedScalingMetricSpecification extends Object implements Serializable
  - Serialized Fields
    - metricName
```
String metricName
```
      The name of the metric.
    - namespace
```
String namespace
```
      The namespace of the metric.
    - dimensions
```
List<E> dimensions
```
      The dimensions of the metric.
      
      Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.
    - statistic
```
String statistic
```
      The statistic of the metric.
    - unit
```
String unit
```
      The unit of the metric.
- Class com.amazonaws.services.autoscalingplans.model.Datapoint extends Object implements Serializable
  - Serialized Fields
    - timestamp
```
Date timestamp
```
      The time stamp for the data point in UTC format.
    - value
```
Double value
```
      The value of the data point.
- Class com.amazonaws.services.autoscalingplans.model.DeleteScalingPlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - scalingPlanName
```
String scalingPlanName
```
      The name of the scaling plan.
    - scalingPlanVersion
```
Long scalingPlanVersion
```
      The version number of the scaling plan.
- Class com.amazonaws.services.autoscalingplans.model.DeleteScalingPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscalingplans.model.DescribeScalingPlanResourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - scalingPlanName
```
String scalingPlanName
```
      The name of the scaling plan.
    - scalingPlanVersion
```
Long scalingPlanVersion
```
      The version number of the scaling plan.
    - maxResults
```
Integer maxResults
```
      The maximum number of scalable resources to return. The value must be between 1 and 50. The default value is 50.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
- Class com.amazonaws.services.autoscalingplans.model.DescribeScalingPlanResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - scalingPlanResources
```
List<E> scalingPlanResources
```
      Information about the scalable resources.
    - nextToken
```
String nextToken
```
      The token required to get the next set of results. This value is null if there are no more results to return.
- Class com.amazonaws.services.autoscalingplans.model.DescribeScalingPlansRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - scalingPlanNames
```
List<E> scalingPlanNames
```
      The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.
    - scalingPlanVersion
```
Long scalingPlanVersion
```
      The version number of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.
    - applicationSources
```
List<E> applicationSources
```
      The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.
    - maxResults
```
Integer maxResults
```
      The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
- Class com.amazonaws.services.autoscalingplans.model.DescribeScalingPlansResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - scalingPlans
```
List<E> scalingPlans
```
      Information about the scaling plans.
    - nextToken
```
String nextToken
```
      The token required to get the next set of results. This value is null if there are no more results to return.
- Class com.amazonaws.services.autoscalingplans.model.GetScalingPlanResourceForecastDataRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - scalingPlanName
```
String scalingPlanName
```
      The name of the scaling plan.
    - scalingPlanVersion
```
Long scalingPlanVersion
```
      The version number of the scaling plan.
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service.
    - resourceId
```
String resourceId
```
      The ID of the resource. This string consists of the resource type and unique identifier.
      
      Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension for the resource.
    - forecastDataType
```
String forecastDataType
```
      The type of forecast data to get.
      
      LoadForecast: The load metric forecast.
      
      CapacityForecast: The capacity forecast.
      
      ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.
      
      ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.
    - startTime
```
Date startTime
```
      The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time.
    - endTime
```
Date endTime
```
      The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is seven days.
      
      Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.
- Class com.amazonaws.services.autoscalingplans.model.GetScalingPlanResourceForecastDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - datapoints
```
List<E> datapoints
```
      The data points to return.
- Class com.amazonaws.services.autoscalingplans.model.InternalServiceException extends AWSAutoScalingPlansException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscalingplans.model.InvalidNextTokenException extends AWSAutoScalingPlansException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscalingplans.model.LimitExceededException extends AWSAutoScalingPlansException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscalingplans.model.MetricDimension extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the dimension.
    - value
```
String value
```
      The value of the dimension.
- Class com.amazonaws.services.autoscalingplans.model.ObjectNotFoundException extends AWSAutoScalingPlansException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscalingplans.model.PredefinedLoadMetricSpecification extends Object implements Serializable
  - Serialized Fields
    - predefinedLoadMetricType
```
String predefinedLoadMetricType
```
      The metric type.
    - resourceLabel
```
String resourceLabel
```
      Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group.
      
      The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target -group-id>, where:
      
      app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.
      
      targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
- Class com.amazonaws.services.autoscalingplans.model.PredefinedScalingMetricSpecification extends Object implements Serializable
  - Serialized Fields
    - predefinedScalingMetricType
```
String predefinedScalingMetricType
```
      The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.
    - resourceLabel
```
String resourceLabel
```
      Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.
      
      The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target -group-id>, where:
      
      app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.
      
      targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
- Class com.amazonaws.services.autoscalingplans.model.ScalingInstruction extends Object implements Serializable
  - Serialized Fields
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service.
    - resourceId
```
String resourceId
```
      The ID of the resource. This string consists of the resource type and unique identifier.
      
      Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension associated with the resource.
      
      autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
    - minCapacity
```
Integer minCapacity
```
      The minimum capacity of the resource.
    - maxCapacity
```
Integer maxCapacity
```
      The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.
    - targetTrackingConfigurations
```
List<E> targetTrackingConfigurations
```
      The structure that defines new target tracking configurations (up to 10). Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling.
      
      With predictive scaling and dynamic scaling, the resource scales based on the target tracking configuration that provides the largest capacity for both scale in and scale out.
      
      Condition: The scaling metric must be unique across target tracking configurations.
    - predefinedLoadMetricSpecification
```
PredefinedLoadMetricSpecification predefinedLoadMetricSpecification
```
      The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
    - customizedLoadMetricSpecification
```
CustomizedLoadMetricSpecification customizedLoadMetricSpecification
```
      The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.
    - scheduledActionBufferTime
```
Integer scheduledActionBufferTime
```
      The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.
      
      The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.
      
      Only valid when configuring predictive scaling.
    - predictiveScalingMaxCapacityBehavior
```
String predictiveScalingMaxCapacityBehavior
```
      Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.
      
      The following are possible values:
      
      SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.
      
      SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.
      
      SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.
      
      Only valid when configuring predictive scaling.
    - predictiveScalingMaxCapacityBuffer
```
Integer predictiveScalingMaxCapacityBuffer
```
      The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.
      
      Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.
      
      The range is 1-100.
    - predictiveScalingMode
```
String predictiveScalingMode
```
      The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.
    - scalingPolicyUpdateBehavior
```
String scalingPolicyUpdateBehavior
```
      Controls whether a resource's externally created scaling policies are kept or replaced.
      
      The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.
      
      Only valid when configuring dynamic scaling.
      
      Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.
    - disableDynamicScaling
```
Boolean disableDynamicScaling
```
      Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.
      
      The default is enabled (false).
- Class com.amazonaws.services.autoscalingplans.model.ScalingPlan extends Object implements Serializable
  - Serialized Fields
    - scalingPlanName
```
String scalingPlanName
```
      The name of the scaling plan.
    - scalingPlanVersion
```
Long scalingPlanVersion
```
      The version number of the scaling plan.
    - applicationSource
```
ApplicationSource applicationSource
```
      The application source.
    - scalingInstructions
```
List<E> scalingInstructions
```
      The scaling instructions.
    - statusCode
```
String statusCode
```
      The status of the scaling plan.
      
      Active - The scaling plan is active.
      
      ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.
      
      CreationInProgress - The scaling plan is being created.
      
      CreationFailed - The scaling plan could not be created.
      
      DeletionInProgress - The scaling plan is being deleted.
      
      DeletionFailed - The scaling plan could not be deleted.
      
      UpdateInProgress - The scaling plan is being updated.
      
      UpdateFailed - The scaling plan could not be updated.
    - statusMessage
```
String statusMessage
```
      A simple message about the current status of the scaling plan.
    - statusStartTime
```
Date statusStartTime
```
      The Unix time stamp when the scaling plan entered the current status.
    - creationTime
```
Date creationTime
```
      The Unix time stamp when the scaling plan was created.
- Class com.amazonaws.services.autoscalingplans.model.ScalingPlanResource extends Object implements Serializable
  - Serialized Fields
    - scalingPlanName
```
String scalingPlanName
```
      The name of the scaling plan.
    - scalingPlanVersion
```
Long scalingPlanVersion
```
      The version number of the scaling plan.
    - serviceNamespace
```
String serviceNamespace
```
      The namespace of the AWS service.
    - resourceId
```
String resourceId
```
      The ID of the resource. This string consists of the resource type and unique identifier.
      
      Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.
      
      ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
      
      Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
      
      DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.
      
      DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.
      
      Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
    - scalableDimension
```
String scalableDimension
```
      The scalable dimension for the resource.
      
      autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.
      
      ecs:service:DesiredCount - The desired task count of an ECS service.
      
      ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.
      
      dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
      
      dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
      
      dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
      
      dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
      
      rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
    - scalingPolicies
```
List<E> scalingPolicies
```
      The scaling policies.
    - scalingStatusCode
```
String scalingStatusCode
```
      The scaling status of the resource.
      
      Active - The scaling configuration is active.
      
      Inactive - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information.
      
      PartiallyActive - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.
    - scalingStatusMessage
```
String scalingStatusMessage
```
      A simple message about the current scaling status of the resource.
- Class com.amazonaws.services.autoscalingplans.model.ScalingPolicy extends Object implements Serializable
  - Serialized Fields
    - policyName
```
String policyName
```
      The name of the scaling policy.
    - policyType
```
String policyType
```
      The type of scaling policy.
    - targetTrackingConfiguration
```
TargetTrackingConfiguration targetTrackingConfiguration
```
      The target tracking scaling policy. Includes support for predefined or customized metrics.
- Class com.amazonaws.services.autoscalingplans.model.TagFilter extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The tag key.
    - values
```
List<E> values
```
      The tag values (0 to 20).
- Class com.amazonaws.services.autoscalingplans.model.TargetTrackingConfiguration extends Object implements Serializable
  - Serialized Fields
    - predefinedScalingMetricSpecification
```
PredefinedScalingMetricSpecification predefinedScalingMetricSpecification
```
      A predefined metric. You can specify either a predefined metric or a customized metric.
    - customizedScalingMetricSpecification
```
CustomizedScalingMetricSpecification customizedScalingMetricSpecification
```
      A customized metric. You can specify either a predefined metric or a customized metric.
    - targetValue
```
Double targetValue
```
      The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).
    - disableScaleIn
```
Boolean disableScaleIn
```
      Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.
      
      The default value is false.
    - scaleOutCooldown
```
Integer scaleOutCooldown
```
      The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.
      
      While the cooldown period 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.
    - scaleInCooldown
```
Integer scaleInCooldown
```
      The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.
      
      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, AWS Auto Scaling scales out your scalable target immediately.
    - estimatedInstanceWarmup
```
Integer estimatedInstanceWarmup
```
      The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.
- Class com.amazonaws.services.autoscalingplans.model.UpdateScalingPlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - scalingPlanName
```
String scalingPlanName
```
      The name of the scaling plan.
    - scalingPlanVersion
```
Long scalingPlanVersion
```
      The version number of the scaling plan.
    - applicationSource
```
ApplicationSource applicationSource
```
      A CloudFormation stack or set of tags.
    - scalingInstructions
```
List<E> scalingInstructions
```
      The scaling instructions.
- Class com.amazonaws.services.autoscalingplans.model.UpdateScalingPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.autoscalingplans.model.ValidationException extends AWSAutoScalingPlansException implements Serializable
  
  serialVersionUID:
  
  1L
Package com.amazonaws.services.backup.model
- Class com.amazonaws.services.backup.model.AlreadyExistsException extends AWSBackupException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
    - creatorRequestId
```
String creatorRequestId
```
    - arn
```
String arn
```
    - type
```
String type
```
    - context
```
String context
```
- Class com.amazonaws.services.backup.model.AWSBackupException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.backup.model.BackupJob extends Object implements Serializable
  - Serialized Fields
    - backupJobId
```
String backupJobId
```
      Uniquely identifies a request to AWS Backup to back up a resource.
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - backupVaultArn
```
String backupVaultArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - recoveryPointArn
```
String recoveryPointArn
```
      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - resourceArn
```
String resourceArn
```
      An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
    - creationDate
```
Date creationDate
```
      The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - completionDate
```
Date completionDate
```
      The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - state
```
String state
```
      The current state of a resource recovery point.
    - statusMessage
```
String statusMessage
```
      A detailed message explaining the status of the job to back up a resource.
    - percentDone
```
String percentDone
```
      Contains an estimated percentage complete of a job at the time the job status was queried.
    - backupSizeInBytes
```
Long backupSizeInBytes
```
      The size, in bytes, of a backup.
    - iamRoleArn
```
String iamRoleArn
```
      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    - createdBy
```
RecoveryPointCreator createdBy
```
      Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
    - expectedCompletionDate
```
Date expectedCompletionDate
```
      The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - startBy
```
Date startBy
```
      Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - resourceType
```
String resourceType
```
      The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
    - bytesTransferred
```
Long bytesTransferred
```
      The size in bytes transferred to a backup vault at the time that the job status was queried.
- Class com.amazonaws.services.backup.model.BackupPlan extends Object implements Serializable
  - Serialized Fields
    - backupPlanName
```
String backupPlanName
```
      The display name of a backup plan.
    - rules
```
List<E> rules
```
      An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
- Class com.amazonaws.services.backup.model.BackupPlanInput extends Object implements Serializable
  - Serialized Fields
    - backupPlanName
```
String backupPlanName
```
      The display name of a backup plan.
    - rules
```
List<E> rules
```
      An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
- Class com.amazonaws.services.backup.model.BackupPlansListMember extends Object implements Serializable
  - Serialized Fields
    - backupPlanArn
```
String backupPlanArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - creationDate
```
Date creationDate
```
      The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - deletionDate
```
Date deletionDate
```
      The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - versionId
```
String versionId
```
      Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
    - backupPlanName
```
String backupPlanName
```
      The display name of a saved backup plan.
    - creatorRequestId
```
String creatorRequestId
```
      A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
    - lastExecutionDate
```
Date lastExecutionDate
```
      The last time a job to back up resources was executed with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- Class com.amazonaws.services.backup.model.BackupPlanTemplatesListMember extends Object implements Serializable
  - Serialized Fields
    - backupPlanTemplateId
```
String backupPlanTemplateId
```
      Uniquely identifies a stored backup plan template.
    - backupPlanTemplateName
```
String backupPlanTemplateName
```
      The optional display name of a backup plan template.
- Class com.amazonaws.services.backup.model.BackupRule extends Object implements Serializable
  - Serialized Fields
    - ruleName
```
String ruleName
```
      An optional display name for a backup rule.
    - targetBackupVaultName
```
String targetBackupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - scheduleExpression
```
String scheduleExpression
```
      A CRON expression specifying when AWS Backup initiates a backup job.
    - startWindowMinutes
```
Long startWindowMinutes
```
      An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.
    - completionWindowMinutes
```
Long completionWindowMinutes
```
      A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. This value is optional.
    - lifecycle
```
Lifecycle lifecycle
```
      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
      
      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    - recoveryPointTags
```
Map<K,V> recoveryPointTags
```
      An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.
    - ruleId
```
String ruleId
```
      Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
    - copyActions
```
List<E> copyActions
```
      An array of CopyAction objects, which contains the details of the copy operation.
- Class com.amazonaws.services.backup.model.BackupRuleInput extends Object implements Serializable
  - Serialized Fields
    - ruleName
```
String ruleName
```
      >An optional display name for a backup rule.
    - targetBackupVaultName
```
String targetBackupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - scheduleExpression
```
String scheduleExpression
```
      A CRON expression specifying when AWS Backup initiates a backup job.
    - startWindowMinutes
```
Long startWindowMinutes
```
      The amount of time in minutes before beginning a backup.
    - completionWindowMinutes
```
Long completionWindowMinutes
```
      The amount of time AWS Backup attempts a backup before canceling the job and returning an error.
    - lifecycle
```
Lifecycle lifecycle
```
      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.
      
      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days”. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    - recoveryPointTags
```
Map<K,V> recoveryPointTags
```
      To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
    - copyActions
```
List<E> copyActions
```
      An array of CopyAction objects, which contains the details of the copy operation.
- Class com.amazonaws.services.backup.model.BackupSelection extends Object implements Serializable
  - Serialized Fields
    - selectionName
```
String selectionName
```
      The display name of a resource selection document.
    - iamRoleArn
```
String iamRoleArn
```
      The ARN of the IAM role that AWS Backup uses to authenticate when restoring the target resource; for example, arn:aws:iam::123456789012:role/S3Access.
    - resources
```
List<E> resources
```
      An array of strings that contain Amazon Resource Names (ARNs) of resources to assign to a backup plan.
    - listOfTags
```
List<E> listOfTags
```
      An array of conditions used to specify a set of resources to assign to a backup plan; for example, "STRINGEQUALS": {"ec2:ResourceTag/Department": "accounting".
- Class com.amazonaws.services.backup.model.BackupSelectionsListMember extends Object implements Serializable
  - Serialized Fields
    - selectionId
```
String selectionId
```
      Uniquely identifies a request to assign a set of resources to a backup plan.
    - selectionName
```
String selectionName
```
      The display name of a resource selection document.
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - creationDate
```
Date creationDate
```
      The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - creatorRequestId
```
String creatorRequestId
```
      A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
    - iamRoleArn
```
String iamRoleArn
```
      Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
- Class com.amazonaws.services.backup.model.BackupVaultListMember extends Object implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - backupVaultArn
```
String backupVaultArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - creationDate
```
Date creationDate
```
      The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - encryptionKeyArn
```
String encryptionKeyArn
```
      The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    - creatorRequestId
```
String creatorRequestId
```
      A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
    - numberOfRecoveryPoints
```
Long numberOfRecoveryPoints
```
      The number of recovery points that are stored in a backup vault.
- Class com.amazonaws.services.backup.model.CalculatedLifecycle extends Object implements Serializable
  - Serialized Fields
    - moveToColdStorageAt
```
Date moveToColdStorageAt
```
      A timestamp that specifies when to transition a recovery point to cold storage.
    - deleteAt
```
Date deleteAt
```
      A timestamp that specifies when to delete a recovery point.
- Class com.amazonaws.services.backup.model.Condition extends Object implements Serializable
  - Serialized Fields
    - conditionType
```
String conditionType
```
      An operation, such as STRINGEQUALS, that is applied to a key-value pair used to filter resources in a selection.
    - conditionKey
```
String conditionKey
```
      The key in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "ec2:ResourceTag/Department" is the key.
    - conditionValue
```
String conditionValue
```
      The value in a key-value pair. For example, in "ec2:ResourceTag/Department": "accounting", "accounting" is the value.
- Class com.amazonaws.services.backup.model.CopyAction extends Object implements Serializable
  - Serialized Fields
    - lifecycle
```
Lifecycle lifecycle
```
    - destinationBackupVaultArn
```
String destinationBackupVaultArn
```
      An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup. For example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
- Class com.amazonaws.services.backup.model.CopyJob extends Object implements Serializable
  - Serialized Fields
    - copyJobId
```
String copyJobId
```
      Uniquely identifies a request to AWS Backup to copy a resource.
    - sourceBackupVaultArn
```
String sourceBackupVaultArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - sourceRecoveryPointArn
```
String sourceRecoveryPointArn
```
      An ARN that uniquely identifies a source recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - destinationBackupVaultArn
```
String destinationBackupVaultArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - destinationRecoveryPointArn
```
String destinationRecoveryPointArn
```
      An ARN that uniquely identifies a destination recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - resourceArn
```
String resourceArn
```
      The type of AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
    - creationDate
```
Date creationDate
```
      The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - completionDate
```
Date completionDate
```
      The date and time a job to create a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - state
```
String state
```
      The current state of a resource recovery point.
    - statusMessage
```
String statusMessage
```
      A detailed message explaining the status of the job that to copy a resource.
    - backupSizeInBytes
```
Long backupSizeInBytes
```
      The size, in bytes, of a copy job.
    - iamRoleArn
```
String iamRoleArn
```
      Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    - createdBy
```
RecoveryPointCreator createdBy
```
    - resourceType
```
String resourceType
```
      The type of AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
- Class com.amazonaws.services.backup.model.CreateBackupPlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupPlan
```
BackupPlanInput backupPlan
```
      Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
    - backupPlanTags
```
Map<K,V> backupPlanTags
```
      To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.
    - creatorRequestId
```
String creatorRequestId
```
      Identifies the request and allows failed requests to be retried without the risk of executing the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.
- Class com.amazonaws.services.backup.model.CreateBackupPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - backupPlanArn
```
String backupPlanArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
    - creationDate
```
Date creationDate
```
      The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - versionId
```
String versionId
```
      Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1024 bytes long. They cannot be edited.
- Class com.amazonaws.services.backup.model.CreateBackupSelectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies the backup plan to be associated with the selection of resources.
    - backupSelection
```
BackupSelection backupSelection
```
      Specifies the body of a request to assign a set of resources to a backup plan.
    - creatorRequestId
```
String creatorRequestId
```
      A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
- Class com.amazonaws.services.backup.model.CreateBackupSelectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - selectionId
```
String selectionId
```
      Uniquely identifies the body of a request to assign a set of resources to a backup plan.
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - creationDate
```
Date creationDate
```
      The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- Class com.amazonaws.services.backup.model.CreateBackupVaultRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - backupVaultTags
```
Map<K,V> backupVaultTags
```
      Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.
    - encryptionKeyArn
```
String encryptionKeyArn
```
      The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    - creatorRequestId
```
String creatorRequestId
```
      A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
- Class com.amazonaws.services.backup.model.CreateBackupVaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - backupVaultArn
```
String backupVaultArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - creationDate
```
Date creationDate
```
      The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- Class com.amazonaws.services.backup.model.DeleteBackupPlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
- Class com.amazonaws.services.backup.model.DeleteBackupPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - backupPlanArn
```
String backupPlanArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
    - deletionDate
```
Date deletionDate
```
      The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - versionId
```
String versionId
```
      Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.
- Class com.amazonaws.services.backup.model.DeleteBackupSelectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - selectionId
```
String selectionId
```
      Uniquely identifies the body of a request to assign a set of resources to a backup plan.
- Class com.amazonaws.services.backup.model.DeleteBackupSelectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.backup.model.DeleteBackupVaultAccessPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
- Class com.amazonaws.services.backup.model.DeleteBackupVaultAccessPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.backup.model.DeleteBackupVaultNotificationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
- Class com.amazonaws.services.backup.model.DeleteBackupVaultNotificationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.backup.model.DeleteBackupVaultRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and theAWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
- Class com.amazonaws.services.backup.model.DeleteBackupVaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.backup.model.DeleteRecoveryPointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - recoveryPointArn
```
String recoveryPointArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
- Class com.amazonaws.services.backup.model.DeleteRecoveryPointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.backup.model.DependencyFailureException extends AWSBackupException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
    - type
```
String type
```
    - context
```
String context
```
- Class com.amazonaws.services.backup.model.DescribeBackupJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupJobId
```
String backupJobId
```
      Uniquely identifies a request to AWS Backup to back up a resource.
- Class com.amazonaws.services.backup.model.DescribeBackupJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupJobId
```
String backupJobId
```
      Uniquely identifies a request to AWS Backup to back up a resource.
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - backupVaultArn
```
String backupVaultArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - recoveryPointArn
```
String recoveryPointArn
```
      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - resourceArn
```
String resourceArn
```
      An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
    - creationDate
```
Date creationDate
```
      The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - completionDate
```
Date completionDate
```
      The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - state
```
String state
```
      The current state of a resource recovery point.
    - statusMessage
```
String statusMessage
```
      A detailed message explaining the status of the job to back up a resource.
    - percentDone
```
String percentDone
```
      Contains an estimated percentage that is complete of a job at the time the job status was queried.
    - backupSizeInBytes
```
Long backupSizeInBytes
```
      The size, in bytes, of a backup.
    - iamRoleArn
```
String iamRoleArn
```
      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    - createdBy
```
RecoveryPointCreator createdBy
```
      Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.
    - resourceType
```
String resourceType
```
      The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
    - bytesTransferred
```
Long bytesTransferred
```
      The size in bytes transferred to a backup vault at the time that the job status was queried.
    - expectedCompletionDate
```
Date expectedCompletionDate
```
      The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - startBy
```
Date startBy
```
      Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- Class com.amazonaws.services.backup.model.DescribeBackupVaultRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
- Class com.amazonaws.services.backup.model.DescribeBackupVaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - backupVaultArn
```
String backupVaultArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - encryptionKeyArn
```
String encryptionKeyArn
```
      The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    - creationDate
```
Date creationDate
```
      The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - creatorRequestId
```
String creatorRequestId
```
      A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
    - numberOfRecoveryPoints
```
Long numberOfRecoveryPoints
```
      The number of recovery points that are stored in a backup vault.
- Class com.amazonaws.services.backup.model.DescribeCopyJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - copyJobId
```
String copyJobId
```
      Uniquely identifies a request to AWS Backup to copy a resource.
- Class com.amazonaws.services.backup.model.DescribeCopyJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - copyJob
```
CopyJob copyJob
```
      Contains detailed information about a copy job.
- Class com.amazonaws.services.backup.model.DescribeProtectedResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- Class com.amazonaws.services.backup.model.DescribeProtectedResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
    - resourceType
```
String resourceType
```
      The type of AWS resource saved as a recovery point; for example, an EBS volume or an Amazon RDS database.
    - lastBackupTime
```
Date lastBackupTime
```
      The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- Class com.amazonaws.services.backup.model.DescribeRecoveryPointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - recoveryPointArn
```
String recoveryPointArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
- Class com.amazonaws.services.backup.model.DescribeRecoveryPointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - recoveryPointArn
```
String recoveryPointArn
```
      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - backupVaultArn
```
String backupVaultArn
```
      An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - resourceArn
```
String resourceArn
```
      An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.
    - resourceType
```
String resourceType
```
      The type of AWS resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
    - createdBy
```
RecoveryPointCreator createdBy
```
      Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.
    - iamRoleArn
```
String iamRoleArn
```
      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    - status
```
String status
```
      A status code specifying the state of the recovery point.
      
      A partial status indicates that the recovery point was not successfully re-created and must be retried.
    - creationDate
```
Date creationDate
```
      The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - completionDate
```
Date completionDate
```
      The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - backupSizeInBytes
```
Long backupSizeInBytes
```
      The size, in bytes, of a backup.
    - calculatedLifecycle
```
CalculatedLifecycle calculatedLifecycle
```
      A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
    - lifecycle
```
Lifecycle lifecycle
```
      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
      
      Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    - encryptionKeyArn
```
String encryptionKeyArn
```
      The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    - isEncrypted
```
Boolean isEncrypted
```
      A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.
    - storageClass
```
String storageClass
```
      Specifies the storage class of the recovery point. Valid values are WARM or COLD.
    - lastRestoreTime
```
Date lastRestoreTime
```
      The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- Class com.amazonaws.services.backup.model.DescribeRestoreJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restoreJobId
```
String restoreJobId
```
      Uniquely identifies the job that restores a recovery point.
- Class com.amazonaws.services.backup.model.DescribeRestoreJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - restoreJobId
```
String restoreJobId
```
      Uniquely identifies the job that restores a recovery point.
    - recoveryPointArn
```
String recoveryPointArn
```
      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - creationDate
```
Date creationDate
```
      The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - completionDate
```
Date completionDate
```
      The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - status
```
String status
```
      Status code specifying the state of the job that is initiated by AWS Backup to restore a recovery point.
    - statusMessage
```
String statusMessage
```
      A detailed message explaining the status of a job to restore a recovery point.
    - percentDone
```
String percentDone
```
      Contains an estimated percentage that is complete of a job at the time the job status was queried.
    - backupSizeInBytes
```
Long backupSizeInBytes
```
      The size, in bytes, of the restored resource.
    - iamRoleArn
```
String iamRoleArn
```
      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    - expectedCompletionTimeMinutes
```
Long expectedCompletionTimeMinutes
```
      The amount of time in minutes that a job restoring a recovery point is expected to take.
    - createdResourceArn
```
String createdResourceArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.
- Class com.amazonaws.services.backup.model.ExportBackupPlanTemplateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
- Class com.amazonaws.services.backup.model.ExportBackupPlanTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupPlanTemplateJson
```
String backupPlanTemplateJson
```
      The body of a backup plan template in JSON format.
      
      This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.
- Class com.amazonaws.services.backup.model.GetBackupPlanFromJSONRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupPlanTemplateJson
```
String backupPlanTemplateJson
```
      A customer-supplied backup plan document in JSON format.
- Class com.amazonaws.services.backup.model.GetBackupPlanFromJSONResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupPlan
```
BackupPlan backupPlan
```
      Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
- Class com.amazonaws.services.backup.model.GetBackupPlanFromTemplateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupPlanTemplateId
```
String backupPlanTemplateId
```
      Uniquely identifies a stored backup plan template.
- Class com.amazonaws.services.backup.model.GetBackupPlanFromTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupPlanDocument
```
BackupPlan backupPlanDocument
```
      Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.
- Class com.amazonaws.services.backup.model.GetBackupPlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - versionId
```
String versionId
```
      Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
- Class com.amazonaws.services.backup.model.GetBackupPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupPlan
```
BackupPlan backupPlan
```
      Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - backupPlanArn
```
String backupPlanArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
    - versionId
```
String versionId
```
      Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
    - creatorRequestId
```
String creatorRequestId
```
      A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
    - creationDate
```
Date creationDate
```
      The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - deletionDate
```
Date deletionDate
```
      The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - lastExecutionDate
```
Date lastExecutionDate
```
      The last time a job to back up resources was executed with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- Class com.amazonaws.services.backup.model.GetBackupSelectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - selectionId
```
String selectionId
```
      Uniquely identifies the body of a request to assign a set of resources to a backup plan.
- Class com.amazonaws.services.backup.model.GetBackupSelectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupSelection
```
BackupSelection backupSelection
```
      Specifies the body of a request to assign a set of resources to a backup plan.
    - selectionId
```
String selectionId
```
      Uniquely identifies the body of a request to assign a set of resources to a backup plan.
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - creationDate
```
Date creationDate
```
      The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - creatorRequestId
```
String creatorRequestId
```
      A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
- Class com.amazonaws.services.backup.model.GetBackupVaultAccessPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
- Class com.amazonaws.services.backup.model.GetBackupVaultAccessPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - backupVaultArn
```
String backupVaultArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - policy
```
String policy
```
      The backup vault access policy document in JSON format.
- Class com.amazonaws.services.backup.model.GetBackupVaultNotificationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
- Class com.amazonaws.services.backup.model.GetBackupVaultNotificationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - backupVaultArn
```
String backupVaultArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - sNSTopicArn
```
String sNSTopicArn
```
      An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.
    - backupVaultEvents
```
List<E> backupVaultEvents
```
      An array of events that indicate the status of jobs to back up resources to the backup vault.
- Class com.amazonaws.services.backup.model.GetRecoveryPointRestoreMetadataRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - recoveryPointArn
```
String recoveryPointArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
- Class com.amazonaws.services.backup.model.GetRecoveryPointRestoreMetadataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupVaultArn
```
String backupVaultArn
```
      An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - recoveryPointArn
```
String recoveryPointArn
```
      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - restoreMetadata
```
Map<K,V> restoreMetadata
```
      The set of metadata key-value pairs that describes the original configuration of the backed-up resource. These values vary depending on the service that is being restored.
- Class com.amazonaws.services.backup.model.GetSupportedResourceTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.backup.model.GetSupportedResourceTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - resourceTypes
```
List<E> resourceTypes
```
      Contains a string with the supported AWS resource types:
      
      EBS for Amazon Elastic Block Store
      
      Storage Gateway for AWS Storage Gateway
      
      RDS for Amazon Relational Database Service
      
      DDB for Amazon DynamoDB
      
      EFS for Amazon Elastic File System
- Class com.amazonaws.services.backup.model.InvalidParameterValueException extends AWSBackupException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
    - type
```
String type
```
    - context
```
String context
```
- Class com.amazonaws.services.backup.model.InvalidRequestException extends AWSBackupException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
    - type
```
String type
```
    - context
```
String context
```
- Class com.amazonaws.services.backup.model.Lifecycle extends Object implements Serializable
  - Serialized Fields
    - moveToColdStorageAfterDays
```
Long moveToColdStorageAfterDays
```
      Specifies the number of days after creation that a recovery point is moved to cold storage.
    - deleteAfterDays
```
Long deleteAfterDays
```
      Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.
- Class com.amazonaws.services.backup.model.LimitExceededException extends AWSBackupException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
    - type
```
String type
```
    - context
```
String context
```
- Class com.amazonaws.services.backup.model.ListBackupJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to be returned.
    - byResourceArn
```
String byResourceArn
```
      Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).
    - byState
```
String byState
```
      Returns only backup jobs that are in the specified state.
    - byBackupVaultName
```
String byBackupVaultName
```
      Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - byCreatedBefore
```
Date byCreatedBefore
```
      Returns only backup jobs that were created before the specified date.
    - byCreatedAfter
```
Date byCreatedAfter
```
      Returns only backup jobs that were created after the specified date.
    - byResourceType
```
String byResourceType
```
      Returns only backup jobs for the specified resources:
      
      DynamoDB for Amazon DynamoDB
      
      EBS for Amazon Elastic Block Store
      
      EFS for Amazon Elastic File System
      
      RDS for Amazon Relational Database Service
      
      Storage Gateway for AWS Storage Gateway
- Class com.amazonaws.services.backup.model.ListBackupJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupJobs
```
List<E> backupJobs
```
      An array of structures containing metadata about your backup jobs returned in JSON format.
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
- Class com.amazonaws.services.backup.model.ListBackupPlansRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to be returned.
    - includeDeleted
```
Boolean includeDeleted
```
      A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.
- Class com.amazonaws.services.backup.model.ListBackupPlansResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - backupPlansList
```
List<E> backupPlansList
```
      An array of backup plan list items containing metadata about your saved backup plans.
- Class com.amazonaws.services.backup.model.ListBackupPlanTemplatesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to be returned.
- Class com.amazonaws.services.backup.model.ListBackupPlanTemplatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - backupPlanTemplatesList
```
List<E> backupPlanTemplatesList
```
      An array of template list items containing metadata about your saved templates.
- Class com.amazonaws.services.backup.model.ListBackupPlanVersionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to be returned.
- Class com.amazonaws.services.backup.model.ListBackupPlanVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - backupPlanVersionsList
```
List<E> backupPlanVersionsList
```
      An array of version list items containing metadata about your backup plans.
- Class com.amazonaws.services.backup.model.ListBackupSelectionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to be returned.
- Class com.amazonaws.services.backup.model.ListBackupSelectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - backupSelectionsList
```
List<E> backupSelectionsList
```
      An array of backup selection list items containing metadata about each resource in the list.
- Class com.amazonaws.services.backup.model.ListBackupVaultsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to be returned.
- Class com.amazonaws.services.backup.model.ListBackupVaultsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupVaultList
```
List<E> backupVaultList
```
      An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
- Class com.amazonaws.services.backup.model.ListCopyJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to be returned.
    - byResourceArn
```
String byResourceArn
```
      Returns only copy jobs that match the specified resource Amazon Resource Name (ARN).
    - byState
```
String byState
```
      Returns only copy jobs that are in the specified state.
    - byCreatedBefore
```
Date byCreatedBefore
```
      Returns only copy jobs that were created before the specified date.
    - byCreatedAfter
```
Date byCreatedAfter
```
      Returns only copy jobs that were created after the specified date.
    - byResourceType
```
String byResourceType
```
      Returns only backup jobs for the specified resources:
      
      DynamoDB for Amazon DynamoDB
      
      EBS for Amazon Elastic Block Store
      
      EFS for Amazon Elastic File System
      
      RDS for Amazon Relational Database Service
      
      Storage Gateway for AWS Storage Gateway
    - byDestinationVaultArn
```
String byDestinationVaultArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
- Class com.amazonaws.services.backup.model.ListCopyJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - copyJobs
```
List<E> copyJobs
```
      An array of structures containing metadata about your copy jobs returned in JSON format.
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
- Class com.amazonaws.services.backup.model.ListProtectedResourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to be returned.
- Class com.amazonaws.services.backup.model.ListProtectedResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - results
```
List<E> results
```
      An array of resources successfully backed up by AWS Backup including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
- Class com.amazonaws.services.backup.model.ListRecoveryPointsByBackupVaultRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to be returned.
    - byResourceArn
```
String byResourceArn
```
      Returns only recovery points that match the specified resource Amazon Resource Name (ARN).
    - byResourceType
```
String byResourceType
```
      Returns only recovery points that match the specified resource type.
    - byBackupPlanId
```
String byBackupPlanId
```
      Returns only recovery points that match the specified backup plan ID.
    - byCreatedBefore
```
Date byCreatedBefore
```
      Returns only recovery points that were created before the specified timestamp.
    - byCreatedAfter
```
Date byCreatedAfter
```
      Returns only recovery points that were created after the specified timestamp.
- Class com.amazonaws.services.backup.model.ListRecoveryPointsByBackupVaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - recoveryPoints
```
List<E> recoveryPoints
```
      An array of objects that contain detailed information about recovery points saved in a backup vault.
- Class com.amazonaws.services.backup.model.ListRecoveryPointsByResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to be returned.
- Class com.amazonaws.services.backup.model.ListRecoveryPointsByResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - recoveryPoints
```
List<E> recoveryPoints
```
      An array of objects that contain detailed information about recovery points of the specified resource type.
- Class com.amazonaws.services.backup.model.ListRestoreJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to be returned.
- Class com.amazonaws.services.backup.model.ListRestoreJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - restoreJobs
```
List<E> restoreJobs
```
      An array of objects that contain detailed information about jobs to restore saved resources.
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
- Class com.amazonaws.services.backup.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to be returned.
- Class com.amazonaws.services.backup.model.ListTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.
    - tags
```
Map<K,V> tags
```
      To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.
- Class com.amazonaws.services.backup.model.MissingParameterValueException extends AWSBackupException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
    - type
```
String type
```
    - context
```
String context
```
- Class com.amazonaws.services.backup.model.ProtectedResource extends Object implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    - resourceType
```
String resourceType
```
      The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
    - lastBackupTime
```
Date lastBackupTime
```
      The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- Class com.amazonaws.services.backup.model.PutBackupVaultAccessPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - policy
```
String policy
```
      The backup vault access policy document in JSON format.
- Class com.amazonaws.services.backup.model.PutBackupVaultAccessPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.backup.model.PutBackupVaultNotificationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - sNSTopicArn
```
String sNSTopicArn
```
      The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.
    - backupVaultEvents
```
List<E> backupVaultEvents
```
      An array of events that indicate the status of jobs to back up resources to the backup vault.
- Class com.amazonaws.services.backup.model.PutBackupVaultNotificationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.backup.model.RecoveryPointByBackupVault extends Object implements Serializable
  - Serialized Fields
    - recoveryPointArn
```
String recoveryPointArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - backupVaultArn
```
String backupVaultArn
```
      An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - resourceArn
```
String resourceArn
```
      An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
    - resourceType
```
String resourceType
```
      The type of AWS resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
    - createdBy
```
RecoveryPointCreator createdBy
```
      Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.
    - iamRoleArn
```
String iamRoleArn
```
      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    - status
```
String status
```
      A status code specifying the state of the recovery point.
    - creationDate
```
Date creationDate
```
      The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - completionDate
```
Date completionDate
```
      The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - backupSizeInBytes
```
Long backupSizeInBytes
```
      The size, in bytes, of a backup.
    - calculatedLifecycle
```
CalculatedLifecycle calculatedLifecycle
```
      A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
    - lifecycle
```
Lifecycle lifecycle
```
      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
      
      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    - encryptionKeyArn
```
String encryptionKeyArn
```
      The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    - isEncrypted
```
Boolean isEncrypted
```
      A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.
    - lastRestoreTime
```
Date lastRestoreTime
```
      The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- Class com.amazonaws.services.backup.model.RecoveryPointByResource extends Object implements Serializable
  - Serialized Fields
    - recoveryPointArn
```
String recoveryPointArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - creationDate
```
Date creationDate
```
      The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - status
```
String status
```
      A status code specifying the state of the recovery point.
    - encryptionKeyArn
```
String encryptionKeyArn
```
      The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
    - backupSizeBytes
```
Long backupSizeBytes
```
      The size, in bytes, of a backup.
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
- Class com.amazonaws.services.backup.model.RecoveryPointCreator extends Object implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - backupPlanArn
```
String backupPlanArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
    - backupPlanVersion
```
String backupPlanVersion
```
      Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.
    - backupRuleId
```
String backupRuleId
```
      Uniquely identifies a rule used to schedule the backup of a selection of resources.
- Class com.amazonaws.services.backup.model.ResourceNotFoundException extends AWSBackupException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
    - type
```
String type
```
    - context
```
String context
```
- Class com.amazonaws.services.backup.model.RestoreJobsListMember extends Object implements Serializable
  - Serialized Fields
    - restoreJobId
```
String restoreJobId
```
      Uniquely identifies the job that restores a recovery point.
    - recoveryPointArn
```
String recoveryPointArn
```
      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - creationDate
```
Date creationDate
```
      The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - completionDate
```
Date completionDate
```
      The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - status
```
String status
```
      A status code specifying the state of the job initiated by AWS Backup to restore a recovery point.
    - statusMessage
```
String statusMessage
```
      A detailed message explaining the status of the job to restore a recovery point.
    - percentDone
```
String percentDone
```
      Contains an estimated percentage complete of a job at the time the job status was queried.
    - backupSizeInBytes
```
Long backupSizeInBytes
```
      The size, in bytes, of the restored resource.
    - iamRoleArn
```
String iamRoleArn
```
      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    - expectedCompletionTimeMinutes
```
Long expectedCompletionTimeMinutes
```
      The amount of time in minutes that a job restoring a recovery point is expected to take.
    - createdResourceArn
```
String createdResourceArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
- Class com.amazonaws.services.backup.model.ServiceUnavailableException extends AWSBackupException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
    - type
```
String type
```
    - context
```
String context
```
- Class com.amazonaws.services.backup.model.StartBackupJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - resourceArn
```
String resourceArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    - iamRoleArn
```
String iamRoleArn
```
      Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    - idempotencyToken
```
String idempotencyToken
```
      A customer chosen string that can be used to distinguish between calls to StartBackupJob.
    - startWindowMinutes
```
Long startWindowMinutes
```
      The amount of time in minutes before beginning a backup.
    - completeWindowMinutes
```
Long completeWindowMinutes
```
      The amount of time AWS Backup attempts a backup before canceling the job and returning an error.
    - lifecycle
```
Lifecycle lifecycle
```
      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.
      
      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    - recoveryPointTags
```
Map<K,V> recoveryPointTags
```
      To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.
- Class com.amazonaws.services.backup.model.StartBackupJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupJobId
```
String backupJobId
```
      Uniquely identifies a request to AWS Backup to back up a resource.
    - recoveryPointArn
```
String recoveryPointArn
```
      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - creationDate
```
Date creationDate
```
      The date and time that a backup job is started, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- Class com.amazonaws.services.backup.model.StartCopyJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - recoveryPointArn
```
String recoveryPointArn
```
      An ARN that uniquely identifies a recovery point to use for the copy job; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - sourceBackupVaultName
```
String sourceBackupVaultName
```
      The name of a logical source container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens. >
    - destinationBackupVaultArn
```
String destinationBackupVaultArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a destination backup vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - iamRoleArn
```
String iamRoleArn
```
      Specifies the IAM role ARN used to copy the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    - idempotencyToken
```
String idempotencyToken
```
      A customer chosen string that can be used to distinguish between calls to StartCopyJob.
    - lifecycle
```
Lifecycle lifecycle
```
- Class com.amazonaws.services.backup.model.StartCopyJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - copyJobId
```
String copyJobId
```
      Uniquely identifies a request to AWS Backup to copy a resource.
    - creationDate
```
Date creationDate
```
      The date and time that a backup job is started, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. >
- Class com.amazonaws.services.backup.model.StartRestoreJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - recoveryPointArn
```
String recoveryPointArn
```
      An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - metadata
```
Map<K,V> metadata
```
      A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.
      
      You can get configuration metadata about a resource at the time it was backed-up by calling GetRecoveryPointRestoreMetadata. However, values in addition to those provided by GetRecoveryPointRestoreMetadata might be required to restore a resource. For example, you might need to provide a new resource name if the original already exists.
      
      You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
      
      file-system-id: ID of the Amazon EFS file system that is backed up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.
      
      Encrypted: A Boolean value that, if true, specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
      
      KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored file system.
      
      PerformanceMode: Specifies the throughput mode of the file system.
      
      CreationToken: A user-supplied value that ensures the uniqueness (idempotency) of the request.
      
      newFileSystem: A Boolean value that, if true, specifies that the recovery point is restored to a new Amazon EFS file system.
    - iamRoleArn
```
String iamRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
    - idempotencyToken
```
String idempotencyToken
```
      A customer chosen string that can be used to distinguish between calls to StartRestoreJob.
    - resourceType
```
String resourceType
```
      Starts a job to restore a recovery point for one of the following resources:
      
      EBS for Amazon Elastic Block Store
      
      Storage Gateway for AWS Storage Gateway
      
      RDS for Amazon Relational Database Service
      
      DDB for Amazon DynamoDB
      
      EFS for Amazon Elastic File System
- Class com.amazonaws.services.backup.model.StartRestoreJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - restoreJobId
```
String restoreJobId
```
      Uniquely identifies the job that restores a recovery point.
- Class com.amazonaws.services.backup.model.StopBackupJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupJobId
```
String backupJobId
```
      Uniquely identifies a request to AWS Backup to back up a resource.
- Class com.amazonaws.services.backup.model.StopBackupJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.backup.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
    - tags
```
Map<K,V> tags
```
      Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create.
- Class com.amazonaws.services.backup.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.backup.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.
    - tagKeyList
```
List<E> tagKeyList
```
      A list of keys to identify which key-value tags to remove from a resource.
- Class com.amazonaws.services.backup.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.backup.model.UpdateBackupPlanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - backupPlan
```
BackupPlanInput backupPlan
```
      Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.
- Class com.amazonaws.services.backup.model.UpdateBackupPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupPlanId
```
String backupPlanId
```
      Uniquely identifies a backup plan.
    - backupPlanArn
```
String backupPlanArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
    - creationDate
```
Date creationDate
```
      The date and time a backup plan is updated, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
    - versionId
```
String versionId
```
      Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.
- Class com.amazonaws.services.backup.model.UpdateRecoveryPointLifecycleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - backupVaultName
```
String backupVaultName
```
      The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
    - recoveryPointArn
```
String recoveryPointArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - lifecycle
```
Lifecycle lifecycle
```
      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
      
      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
- Class com.amazonaws.services.backup.model.UpdateRecoveryPointLifecycleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - backupVaultArn
```
String backupVaultArn
```
      An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
    - recoveryPointArn
```
String recoveryPointArn
```
      An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
    - lifecycle
```
Lifecycle lifecycle
```
      The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.
      
      Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.
    - calculatedLifecycle
```
CalculatedLifecycle calculatedLifecycle
```
      A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
Package com.amazonaws.services.batch.model
- Class com.amazonaws.services.batch.model.ArrayProperties extends Object implements Serializable
  - Serialized Fields
    - size
```
Integer size
```
      The size of the array job.
- Class com.amazonaws.services.batch.model.ArrayPropertiesDetail extends Object implements Serializable
  - Serialized Fields
    - statusSummary
```
Map<K,V> statusSummary
```
      A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.
    - size
```
Integer size
```
      The size of the array job. This parameter is returned for parent array jobs.
    - index
```
Integer index
```
      The job index within the array that is associated with this job. This parameter is returned for array job children.
- Class com.amazonaws.services.batch.model.ArrayPropertiesSummary extends Object implements Serializable
  - Serialized Fields
    - size
```
Integer size
```
      The size of the array job. This parameter is returned for parent array jobs.
    - index
```
Integer index
```
      The job index within the array that is associated with this job. This parameter is returned for children of array jobs.
- Class com.amazonaws.services.batch.model.AttemptContainerDetail extends Object implements Serializable
  - Serialized Fields
    - containerInstanceArn
```
String containerInstanceArn
```
      The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
    - taskArn
```
String taskArn
```
      The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt. Each container attempt receives a task ARN when they reach the STARTING status.
    - exitCode
```
Integer exitCode
```
      The exit code for the job attempt. A non-zero exit code is considered a failure.
    - reason
```
String reason
```
      A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
    - logStreamName
```
String logStreamName
```
      The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.
    - networkInterfaces
```
List<E> networkInterfaces
```
      The network interfaces associated with the job attempt.
- Class com.amazonaws.services.batch.model.AttemptDetail extends Object implements Serializable
  - Serialized Fields
    - container
```
AttemptContainerDetail container
```
      Details about the container in this job attempt.
    - startedAt
```
Long startedAt
```
      The Unix timestamp (in seconds and milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).
    - stoppedAt
```
Long stoppedAt
```
      The Unix timestamp (in seconds and milliseconds) for when the attempt was stopped (when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
    - statusReason
```
String statusReason
```
      A short, human-readable string to provide additional details about the current status of the job attempt.
- Class com.amazonaws.services.batch.model.AWSBatchException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.batch.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The AWS Batch job ID of the job to cancel.
    - reason
```
String reason
```
      A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.
- Class com.amazonaws.services.batch.model.CancelJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.batch.model.ClientException extends AWSBatchException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.batch.model.ComputeEnvironmentDetail extends Object implements Serializable
  - Serialized Fields
    - computeEnvironmentName
```
String computeEnvironmentName
```
      The name of the compute environment.
    - computeEnvironmentArn
```
String computeEnvironmentArn
```
      The Amazon Resource Name (ARN) of the compute environment.
    - ecsClusterArn
```
String ecsClusterArn
```
      The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
    - type
```
String type
```
      The type of the compute environment.
    - state
```
String state
```
      The state of the compute environment. The valid values are ENABLED or DISABLED.
      
      If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.
      
      If the state is DISABLED, then the AWS Batch scheduler does not attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state do not scale out. However, they scale in to minvCpus value after instances become idle.
    - status
```
String status
```
      The current status of the compute environment (for example, CREATING or VALID).
    - statusReason
```
String statusReason
```
      A short, human-readable string to provide additional details about the current status of the compute environment.
    - computeResources
```
ComputeResource computeResources
```
      The compute resources defined for the compute environment.
    - serviceRole
```
String serviceRole
```
      The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.
- Class com.amazonaws.services.batch.model.ComputeEnvironmentOrder extends Object implements Serializable
  - Serialized Fields
    - order
```
Integer order
```
      The order of the compute environment.
    - computeEnvironment
```
String computeEnvironment
```
      The Amazon Resource Name (ARN) of the compute environment.
- Class com.amazonaws.services.batch.model.ComputeResource extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of compute environment: EC2 or SPOT.
    - allocationStrategy
```
String allocationStrategy
```
      The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated. This could be due to availability of the instance type in the region or Amazon EC2 service limits. If this is not specified, the default is BEST_FIT, which will use only the best fitting instance type, waiting for additional capacity if it's not available. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with BEST_FIT then the Spot Fleet IAM Role must be specified. BEST_FIT_PROGRESSIVE will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per vCPU. SPOT_CAPACITY_OPTIMIZED is only available for Spot Instance compute resources and will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. For more information, see Allocation Strategies in the AWS Batch User Guide.
    - minvCpus
```
Integer minvCpus
```
      The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).
    - maxvCpus
```
Integer maxvCpus
```
      The maximum number of Amazon EC2 vCPUs that an environment can reach.
    - desiredvCpus
```
Integer desiredvCpus
```
      The desired number of Amazon EC2 vCPUS in the compute environment.
    - instanceTypes
```
List<E> instanceTypes
```
      The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to pick instance types (from the C, M, and R instance families) on the fly that match the demand of your job queues.
    - imageId
```
String imageId
```
      The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
    - subnets
```
List<E> subnets
```
      The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the Amazon VPC User Guide.
    - securityGroupIds
```
List<E> securityGroupIds
```
      The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds will be used.
    - ec2KeyPair
```
String ec2KeyPair
```
      The Amazon EC2 key pair that is used for instances launched in the compute environment.
    - instanceRole
```
String instanceRole
```
      The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.
    - tags
```
Map<K,V> tags
```
      Key-value pair tags to be applied to resources that are launched in the compute environment. For AWS Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value—for example, { "Name": "AWS Batch Instance - C4OnDemand" }.
    - placementGroup
```
String placementGroup
```
      The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.
    - bidPercentage
```
Integer bidPercentage
```
      The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.
    - spotIamFleetRole
```
String spotIamFleetRole
```
      The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy is not specified. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide.
    - launchTemplate
```
LaunchTemplateSpecification launchTemplate
```
      The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch Template Support in the AWS Batch User Guide.
- Class com.amazonaws.services.batch.model.ComputeResourceUpdate extends Object implements Serializable
  - Serialized Fields
    - minvCpus
```
Integer minvCpus
```
      The minimum number of Amazon EC2 vCPUs that an environment should maintain.
    - maxvCpus
```
Integer maxvCpus
```
      The maximum number of Amazon EC2 vCPUs that an environment can reach.
    - desiredvCpus
```
Integer desiredvCpus
```
      The desired number of Amazon EC2 vCPUS in the compute environment.
- Class com.amazonaws.services.batch.model.ContainerDetail extends Object implements Serializable
  - Serialized Fields
    - image
```
String image
```
      The image used to start the container.
    - vcpus
```
Integer vcpus
```
      The number of VCPUs allocated for the job.
    - memory
```
Integer memory
```
      The number of MiB of memory reserved for the job.
    - command
```
List<E> command
```
      The command that is passed to the container.
    - jobRoleArn
```
String jobRoleArn
```
      The Amazon Resource Name (ARN) associated with the job upon execution.
    - volumes
```
List<E> volumes
```
      A list of volumes associated with the job.
    - environment
```
List<E> environment
```
      The environment variables to pass to a container.
      
      Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
    - mountPoints
```
List<E> mountPoints
```
      The mount points for data volumes in your container.
    - readonlyRootFilesystem
```
Boolean readonlyRootFilesystem
```
      When this parameter is true, the container is given read-only access to its root file system.
    - ulimits
```
List<E> ulimits
```
      A list of ulimit values to set in the container.
    - privileged
```
Boolean privileged
```
      When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
    - user
```
String user
```
      The user name to use inside the container.
    - exitCode
```
Integer exitCode
```
      The exit code to return upon completion.
    - reason
```
String reason
```
      A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
    - containerInstanceArn
```
String containerInstanceArn
```
      The Amazon Resource Name (ARN) of the container instance on which the container is running.
    - taskArn
```
String taskArn
```
      The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.
    - logStreamName
```
String logStreamName
```
      The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.
    - instanceType
```
String instanceType
```
      The instance type of the underlying host infrastructure of a multi-node parallel job.
    - networkInterfaces
```
List<E> networkInterfaces
```
      The network interfaces associated with the job.
    - resourceRequirements
```
List<E> resourceRequirements
```
      The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
    - linuxParameters
```
LinuxParameters linuxParameters
```
      Linux-specific modifications that are applied to the container, such as details for device mappings.
- Class com.amazonaws.services.batch.model.ContainerOverrides extends Object implements Serializable
  - Serialized Fields
    - vcpus
```
Integer vcpus
```
      The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.
    - memory
```
Integer memory
```
      The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
    - command
```
List<E> command
```
      The command to send to the container that overrides the default command from the Docker image or the job definition.
    - instanceType
```
String instanceType
```
      The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.
    - environment
```
List<E> 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 job definition.
      
      Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
    - resourceRequirements
```
List<E> resourceRequirements
```
      The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.
- Class com.amazonaws.services.batch.model.ContainerProperties extends Object implements Serializable
  - Serialized Fields
    - 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 Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
      
      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).
    - vcpus
```
Integer vcpus
```
      The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
    - memory
```
Integer memory
```
      The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified 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. You must specify at least 4 MiB of memory for a job.
      
      If you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
    - command
```
List<E> 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/engine/reference/builder/#cmd.
    - jobRoleArn
```
String jobRoleArn
```
      The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
    - volumes
```
List<E> volumes
```
      A list of data volumes used in a job.
    - environment
```
List<E> 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 plaintext environment variables for sensitive information, such as credential data.
      
      Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
    - mountPoints
```
List<E> 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.
    - 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.
    - 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.
    - ulimits
```
List<E> 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.
    - 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.
    - instanceType
```
String instanceType
```
      The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
    - resourceRequirements
```
List<E> resourceRequirements
```
      The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
    - linuxParameters
```
LinuxParameters linuxParameters
```
      Linux-specific modifications that are applied to the container, such as details for device mappings.
- Class com.amazonaws.services.batch.model.ContainerSummary extends Object implements Serializable
  - Serialized Fields
    - exitCode
```
Integer exitCode
```
      The exit code to return upon completion.
    - reason
```
String reason
```
      A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
- Class com.amazonaws.services.batch.model.CreateComputeEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - computeEnvironmentName
```
String computeEnvironmentName
```
      The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    - type
```
String type
```
      The type of the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.
    - state
```
String state
```
      The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.
    - computeResources
```
ComputeResource computeResources
```
      Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.
    - serviceRole
```
String serviceRole
```
      The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
      
      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.
      
      Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
- Class com.amazonaws.services.batch.model.CreateComputeEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - computeEnvironmentName
```
String computeEnvironmentName
```
      The name of the compute environment.
    - computeEnvironmentArn
```
String computeEnvironmentArn
```
      The Amazon Resource Name (ARN) of the compute environment.
- Class com.amazonaws.services.batch.model.CreateJobQueueRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobQueueName
```
String jobQueueName
```
      The name of the job queue.
    - state
```
String state
```
      The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs.
    - priority
```
Integer priority
```
      The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1.
    - computeEnvironmentOrder
```
List<E> computeEnvironmentOrder
```
      The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue.
- Class com.amazonaws.services.batch.model.CreateJobQueueResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobQueueName
```
String jobQueueName
```
      The name of the job queue.
    - jobQueueArn
```
String jobQueueArn
```
      The Amazon Resource Name (ARN) of the job queue.
- Class com.amazonaws.services.batch.model.DeleteComputeEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - computeEnvironment
```
String computeEnvironment
```
      The name or Amazon Resource Name (ARN) of the compute environment to delete.
- Class com.amazonaws.services.batch.model.DeleteComputeEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.batch.model.DeleteJobQueueRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobQueue
```
String jobQueue
```
      The short name or full Amazon Resource Name (ARN) of the queue to delete.
- Class com.amazonaws.services.batch.model.DeleteJobQueueResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.batch.model.DeregisterJobDefinitionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobDefinition
```
String jobDefinition
```
      The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.
- Class com.amazonaws.services.batch.model.DeregisterJobDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.batch.model.DescribeComputeEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - computeEnvironments
```
List<E> computeEnvironments
```
      A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
    - maxResults
```
Integer maxResults
```
      The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments 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 DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.
    - nextToken
```
String nextToken
```
      The nextToken value returned from a previous paginated DescribeComputeEnvironments 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.batch.model.DescribeComputeEnvironmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - computeEnvironments
```
List<E> computeEnvironments
```
      The list of compute environments.
    - nextToken
```
String nextToken
```
      The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeJobDefinitions 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.batch.model.DescribeJobDefinitionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobDefinitions
```
List<E> jobDefinitions
```
      A list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.
    - maxResults
```
Integer maxResults
```
      The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions 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 DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.
    - jobDefinitionName
```
String jobDefinitionName
```
      The name of the job definition to describe.
    - status
```
String status
```
      The status with which to filter job definitions.
    - nextToken
```
String nextToken
```
      The nextToken value returned from a previous paginated DescribeJobDefinitions 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.batch.model.DescribeJobDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobDefinitions
```
List<E> jobDefinitions
```
      The list of job definitions.
    - nextToken
```
String nextToken
```
      The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions 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.batch.model.DescribeJobQueuesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobQueues
```
List<E> jobQueues
```
      A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
    - maxResults
```
Integer maxResults
```
      The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues 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 DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.
    - nextToken
```
String nextToken
```
      The nextToken value returned from a previous paginated DescribeJobQueues 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.batch.model.DescribeJobQueuesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobQueues
```
List<E> jobQueues
```
      The list of job queues.
    - nextToken
```
String nextToken
```
      The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues 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.batch.model.DescribeJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobs
```
List<E> jobs
```
      A list of up to 100 job IDs.
- Class com.amazonaws.services.batch.model.DescribeJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobs
```
List<E> jobs
```
      The list of jobs.
- Class com.amazonaws.services.batch.model.Device extends Object implements Serializable
  - Serialized Fields
    - hostPath
```
String hostPath
```
      The path for the device on the host container instance.
    - containerPath
```
String containerPath
```
      The path inside the container at which to expose the host device. By default the hostPath value is used.
    - permissions
```
List<E> permissions
```
      The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.
- Class com.amazonaws.services.batch.model.Host 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 this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
- Class com.amazonaws.services.batch.model.JobDefinition extends Object implements Serializable
  - Serialized Fields
    - jobDefinitionName
```
String jobDefinitionName
```
      The name of the job definition.
    - jobDefinitionArn
```
String jobDefinitionArn
```
      The Amazon Resource Name (ARN) for the job definition.
    - revision
```
Integer revision
```
      The revision of the job definition.
    - status
```
String status
```
      The status of the job definition.
    - type
```
String type
```
      The type of job definition.
    - parameters
```
Map<K,V> parameters
```
      Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters in the AWS Batch User Guide.
    - retryStrategy
```
RetryStrategy retryStrategy
```
      The retry strategy to use for failed jobs that are submitted with this job definition.
    - containerProperties
```
ContainerProperties containerProperties
```
      An object with various properties specific to container-based jobs.
    - timeout
```
JobTimeout timeout
```
      The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.
    - nodeProperties
```
NodeProperties nodeProperties
```
      An object with various properties specific to multi-node parallel jobs.
- Class com.amazonaws.services.batch.model.JobDependency extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The job ID of the AWS Batch job associated with this dependency.
    - type
```
String type
```
      The type of the job dependency.
- Class com.amazonaws.services.batch.model.JobDetail extends Object implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
      The name of the job.
    - jobId
```
String jobId
```
      The ID for the job.
    - jobQueue
```
String jobQueue
```
      The Amazon Resource Name (ARN) of the job queue with which the job is associated.
    - status
```
String status
```
      The current status for the job.
      
      If your jobs do not progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.
    - attempts
```
List<E> attempts
```
      A list of job attempts associated with this job.
    - statusReason
```
String statusReason
```
      A short, human-readable string to provide additional details about the current status of the job.
    - createdAt
```
Long createdAt
```
      The Unix timestamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.
    - retryStrategy
```
RetryStrategy retryStrategy
```
      The retry strategy to use for this job if an attempt fails.
    - startedAt
```
Long startedAt
```
      The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
    - stoppedAt
```
Long stoppedAt
```
      The Unix timestamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
    - dependsOn
```
List<E> dependsOn
```
      A list of job IDs on which this job depends.
    - jobDefinition
```
String jobDefinition
```
      The job definition that is used by this job.
    - parameters
```
Map<K,V> parameters
```
      Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
    - container
```
ContainerDetail container
```
      An object representing the details of the container that is associated with the job.
    - nodeDetails
```
NodeDetails nodeDetails
```
      An object representing the details of a node that is associated with a multi-node parallel job.
    - nodeProperties
```
NodeProperties nodeProperties
```
      An object representing the node properties of a multi-node parallel job.
    - arrayProperties
```
ArrayPropertiesDetail arrayProperties
```
      The array properties of the job, if it is an array job.
    - timeout
```
JobTimeout timeout
```
      The timeout configuration for the job.
- Class com.amazonaws.services.batch.model.JobQueueDetail extends Object implements Serializable
  - Serialized Fields
    - jobQueueName
```
String jobQueueName
```
      The name of the job queue.
    - jobQueueArn
```
String jobQueueArn
```
      The Amazon Resource Name (ARN) of the job queue.
    - state
```
String state
```
      Describes the ability of the queue to accept new jobs.
    - status
```
String status
```
      The status of the job queue (for example, CREATING or VALID).
    - statusReason
```
String statusReason
```
      A short, human-readable string to provide additional details about the current status of the job queue.
    - priority
```
Integer priority
```
      The priority of the job queue.
    - computeEnvironmentOrder
```
List<E> computeEnvironmentOrder
```
      The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.
- Class com.amazonaws.services.batch.model.JobSummary extends Object implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The ID of the job.
    - jobName
```
String jobName
```
      The name of the job.
    - createdAt
```
Long createdAt
```
      The Unix timestamp for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.
    - status
```
String status
```
      The current status for the job.
    - statusReason
```
String statusReason
```
      A short, human-readable string to provide additional details about the current status of the job.
    - startedAt
```
Long startedAt
```
      The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
    - stoppedAt
```
Long stoppedAt
```
      The Unix timestamp for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
    - container
```
ContainerSummary container
```
      An object representing the details of the container that is associated with the job.
    - arrayProperties
```
ArrayPropertiesSummary arrayProperties
```
      The array properties of the job, if it is an array job.
    - nodeProperties
```
NodePropertiesSummary nodeProperties
```
      The node properties for a single node in a job summary list.
- Class com.amazonaws.services.batch.model.JobTimeout extends Object implements Serializable
  - Serialized Fields
    - attemptDurationSeconds
```
Integer attemptDurationSeconds
```
      The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS Batch terminates your jobs if they have not finished.
- Class com.amazonaws.services.batch.model.KeyValuePair extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the key-value pair. For environment variables, this is the name of the environment variable.
    - value
```
String value
```
      The value of the key-value pair. For environment variables, this is the value of the environment variable.
- Class com.amazonaws.services.batch.model.LaunchTemplateSpecification extends Object implements Serializable
  - Serialized Fields
    - launchTemplateId
```
String launchTemplateId
```
      The ID of the launch template.
    - launchTemplateName
```
String launchTemplateName
```
      The name of the launch template.
    - version
```
String version
```
      The version number of the launch template.
      
      Default: The default version of the launch template.
- Class com.amazonaws.services.batch.model.LinuxParameters extends Object implements Serializable
  - Serialized Fields
    - devices
```
List<E> devices
```
      Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
- Class com.amazonaws.services.batch.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobQueue
```
String jobQueue
```
      The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.
    - arrayJobId
```
String arrayJobId
```
      The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.
    - multiNodeJobId
```
String multiNodeJobId
```
      The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.
    - jobStatus
```
String jobStatus
```
      The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.
    - maxResults
```
Integer maxResults
```
      The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs 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 ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListJobs returns up to 100 results and a nextToken value if applicable.
    - nextToken
```
String nextToken
```
      The nextToken value returned from a previous paginated ListJobs 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.batch.model.ListJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobSummaryList
```
List<E> jobSummaryList
```
      A list of job summaries that match the request.
    - nextToken
```
String nextToken
```
      The nextToken value to include in a future ListJobs request. When the results of a ListJobs 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.batch.model.MountPoint extends Object implements Serializable
  - Serialized Fields
    - containerPath
```
String containerPath
```
      The path on the container at which to mount the host volume.
    - readOnly
```
Boolean readOnly
```
      If this value is true, the container has read-only access to the volume; otherwise, 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.batch.model.NetworkInterface extends Object implements Serializable
  - Serialized Fields
    - attachmentId
```
String attachmentId
```
      The attachment ID for the network interface.
    - ipv6Address
```
String ipv6Address
```
      The private IPv6 address for the network interface.
    - privateIpv4Address
```
String privateIpv4Address
```
      The private IPv4 address for the network interface.
- Class com.amazonaws.services.batch.model.NodeDetails extends Object implements Serializable
  - Serialized Fields
    - nodeIndex
```
Integer nodeIndex
```
      The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
    - isMainNode
```
Boolean isMainNode
```
      Specifies whether the current node is the main node for a multi-node parallel job.
- Class com.amazonaws.services.batch.model.NodeOverrides extends Object implements Serializable
  - Serialized Fields
    - numNodes
```
Integer numNodes
```
      The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:
      
      There must be at least one node range in your job definition that has an open upper boundary (such as : or n:).
      
      The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override.
      
      The main node index specified in the job definition must be fewer than the number of nodes specified in the override.
    - nodePropertyOverrides
```
List<E> nodePropertyOverrides
```
      The node property overrides for the job.
- Class com.amazonaws.services.batch.model.NodeProperties extends Object implements Serializable
  - Serialized Fields
    - numNodes
```
Integer numNodes
```
      The number of nodes associated with a multi-node parallel job.
    - mainNode
```
Integer mainNode
```
      Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.
    - nodeRangeProperties
```
List<E> nodeRangeProperties
```
      A list of node ranges and their properties associated with a multi-node parallel job.
- Class com.amazonaws.services.batch.model.NodePropertiesSummary extends Object implements Serializable
  - Serialized Fields
    - isMainNode
```
Boolean isMainNode
```
      Specifies whether the current node is the main node for a multi-node parallel job.
    - numNodes
```
Integer numNodes
```
      The number of nodes associated with a multi-node parallel job.
    - nodeIndex
```
Integer nodeIndex
```
      The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
- Class com.amazonaws.services.batch.model.NodePropertyOverride extends Object implements Serializable
  - Serialized Fields
    - targetNodes
```
String targetNodes
```
      The range of nodes, using node index values, with which to override. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted ( :n), then 0 is used to start the range. If the ending range value is omitted ( n:), then the highest possible node index is used to end the range.
    - containerOverrides
```
ContainerOverrides containerOverrides
```
      The overrides that should be sent to a node range.
- Class com.amazonaws.services.batch.model.NodeRangeProperty extends Object implements Serializable
  - Serialized Fields
    - targetNodes
```
String targetNodes
```
      The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.
    - container
```
ContainerProperties container
```
      The container details for the node range.
- Class com.amazonaws.services.batch.model.RegisterJobDefinitionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobDefinitionName
```
String jobDefinitionName
```
      The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    - type
```
String type
```
      The type of job definition.
    - parameters
```
Map<K,V> parameters
```
      Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
    - containerProperties
```
ContainerProperties containerProperties
```
      An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.
    - nodeProperties
```
NodeProperties nodeProperties
```
      An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.
    - retryStrategy
```
RetryStrategy retryStrategy
```
      The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.
    - timeout
```
JobTimeout timeout
```
      The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
- Class com.amazonaws.services.batch.model.RegisterJobDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobDefinitionName
```
String jobDefinitionName
```
      The name of the job definition.
    - jobDefinitionArn
```
String jobDefinitionArn
```
      The Amazon Resource Name (ARN) of the job definition.
    - revision
```
Integer revision
```
      The revision of the job definition.
- Class com.amazonaws.services.batch.model.ResourceRequirement extends Object implements Serializable
  - Serialized Fields
    - value
```
String value
```
      The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.
    - type
```
String type
```
      The type of resource to assign to a container. Currently, the only supported resource type is GPU.
- Class com.amazonaws.services.batch.model.RetryStrategy extends Object implements Serializable
  - Serialized Fields
    - attempts
```
Integer attempts
```
      The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
- Class com.amazonaws.services.batch.model.ServerException extends AWSBatchException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.batch.model.SubmitJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
      The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
    - jobQueue
```
String jobQueue
```
      The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
    - arrayProperties
```
ArrayProperties arrayProperties
```
      The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.
    - dependsOn
```
List<E> dependsOn
```
      A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
    - jobDefinition
```
String jobDefinition
```
      The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
    - parameters
```
Map<K,V> parameters
```
      Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
    - containerOverrides
```
ContainerOverrides containerOverrides
```
      A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.
    - nodeOverrides
```
NodeOverrides nodeOverrides
```
      A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.
    - retryStrategy
```
RetryStrategy retryStrategy
```
      The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
    - timeout
```
JobTimeout timeout
```
      The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
- Class com.amazonaws.services.batch.model.SubmitJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobName
```
String jobName
```
      The name of the job.
    - jobId
```
String jobId
```
      The unique identifier for the job.
- Class com.amazonaws.services.batch.model.TerminateJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The AWS Batch job ID of the job to terminate.
    - reason
```
String reason
```
      A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.
- Class com.amazonaws.services.batch.model.TerminateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.batch.model.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.batch.model.UpdateComputeEnvironmentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - computeEnvironment
```
String computeEnvironment
```
      The name or full Amazon Resource Name (ARN) of the compute environment to update.
    - state
```
String state
```
      The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.
    - computeResources
```
ComputeResourceUpdate computeResources
```
      Details of the compute resources managed by the compute environment. Required for a managed compute environment.
    - serviceRole
```
String serviceRole
```
      The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.
      
      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.
      
      Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.
- Class com.amazonaws.services.batch.model.UpdateComputeEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - computeEnvironmentName
```
String computeEnvironmentName
```
      The name of the compute environment.
    - computeEnvironmentArn
```
String computeEnvironmentArn
```
      The Amazon Resource Name (ARN) of the compute environment.
- Class com.amazonaws.services.batch.model.UpdateJobQueueRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobQueue
```
String jobQueue
```
      The name or the Amazon Resource Name (ARN) of the job queue.
    - state
```
String state
```
      Describes the queue's ability to accept new jobs.
    - priority
```
Integer priority
```
      The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1.
    - computeEnvironmentOrder
```
List<E> computeEnvironmentOrder
```
      Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should execute a given job.
- Class com.amazonaws.services.batch.model.UpdateJobQueueResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - jobQueueName
```
String jobQueueName
```
      The name of the job queue.
    - jobQueueArn
```
String jobQueueArn
```
      The Amazon Resource Name (ARN) of the job queue.
- Class com.amazonaws.services.batch.model.Volume extends Object implements Serializable
  - Serialized Fields
    - host
```
Host 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. However, 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.
Package com.amazonaws.services.budgets.model
- Class com.amazonaws.services.budgets.model.AccessDeniedException extends AWSBudgetsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.budgets.model.AWSBudgetsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.budgets.model.Budget extends Object implements Serializable
  - Serialized Fields
    - budgetName
```
String budgetName
```
      The name of a budget. The name must be unique within an account. The : and \ characters aren't allowed in BudgetName.
    - budgetLimit
```
Spend budgetLimit
```
      The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.
      
      BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100, which is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.
    - plannedBudgetLimits
```
Map<K,V> plannedBudgetLimits
```
      A map containing multiple BudgetLimit, including current or future limits.
      
      PlannedBudgetLimits is available for cost or usage budget and supports monthly and quarterly TimeUnit.
      
      For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.
      
      For quarterly budgets, provide 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.
      
      If the planned budget expires before 12 months for monthly or 4 quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.
      
      If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.
      
      After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.
      
      DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.
    - costFilters
```
Map<K,V> costFilters
```
      The cost filters, such as service or tag, that are applied to a budget.
      
      AWS Budgets supports the following services as a filter for RI budgets:
      
      Amazon Elastic Compute Cloud - Compute
      
      Amazon Redshift
      
      Amazon Relational Database Service
      
      Amazon ElastiCache
      
      Amazon Elasticsearch Service
    - costTypes
```
CostTypes costTypes
```
      The types of costs that are included in this COST budget.
      
      USAGE, RI_UTILIZATION, RI_COVERAGE, Savings_Plans_Utilization , and Savings_Plans_Coverage budgets do not have CostTypes.
    - timeUnit
```
String timeUnit
```
      The length of time until a budget resets the actual and forecasted spend. DAILY is available only for RI_UTILIZATION, RI_COVERAGE, Savings_Plans_Utilization, and Savings_Plans_Coverage budgets.
    - timePeriod
```
TimePeriod timePeriod
```
      The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.
      
      If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
      
      You can change either date with the UpdateBudget operation.
      
      After the end date, AWS deletes the budget and all associated notifications and subscribers.
    - calculatedSpend
```
CalculatedSpend calculatedSpend
```
      The actual and forecasted cost or usage that the budget tracks.
    - budgetType
```
String budgetType
```
      Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
    - lastUpdatedTime
```
Date lastUpdatedTime
```
      The last time that you updated this budget.
- Class com.amazonaws.services.budgets.model.BudgetedAndActualAmounts extends Object implements Serializable
  - Serialized Fields
    - budgetedAmount
```
Spend budgetedAmount
```
      The amount of cost or usage that you created the budget for.
    - actualAmount
```
Spend actualAmount
```
      Your actual costs or usage for a budget period.
    - timePeriod
```
TimePeriod timePeriod
```
      The time period covered by this budget comparison.
- Class com.amazonaws.services.budgets.model.BudgetPerformanceHistory extends Object implements Serializable
  - Serialized Fields
    - budgetName
```
String budgetName
```
    - budgetType
```
String budgetType
```
    - costFilters
```
Map<K,V> costFilters
```
      The history of the cost filters for a budget during the specified time period.
    - costTypes
```
CostTypes costTypes
```
      The history of the cost types for a budget during the specified time period.
    - timeUnit
```
String timeUnit
```
    - budgetedAndActualAmountsList
```
List<E> budgetedAndActualAmountsList
```
      A list of amounts of cost or usage that you created budgets for, compared to your actual costs or usage.
- Class com.amazonaws.services.budgets.model.CalculatedSpend extends Object implements Serializable
  - Serialized Fields
    - actualSpend
```
Spend actualSpend
```
      The amount of cost, usage, or RI units that you have used.
    - forecastedSpend
```
Spend forecastedSpend
```
      The amount of cost, usage, or RI units that you are forecasted to use.
- Class com.amazonaws.services.budgets.model.CostTypes extends Object implements Serializable
  - Serialized Fields
    - includeTax
```
Boolean includeTax
```
      Specifies whether a budget includes taxes.
      
      The default value is true.
    - includeSubscription
```
Boolean includeSubscription
```
      Specifies whether a budget includes subscriptions.
      
      The default value is true.
    - useBlended
```
Boolean useBlended
```
      Specifies whether a budget uses a blended rate.
      
      The default value is false.
    - includeRefund
```
Boolean includeRefund
```
      Specifies whether a budget includes refunds.
      
      The default value is true.
    - includeCredit
```
Boolean includeCredit
```
      Specifies whether a budget includes credits.
      
      The default value is true.
    - includeUpfront
```
Boolean includeUpfront
```
      Specifies whether a budget includes upfront RI costs.
      
      The default value is true.
    - includeRecurring
```
Boolean includeRecurring
```
      Specifies whether a budget includes recurring fees such as monthly RI fees.
      
      The default value is true.
    - includeOtherSubscription
```
Boolean includeOtherSubscription
```
      Specifies whether a budget includes non-RI subscription costs.
      
      The default value is true.
    - includeSupport
```
Boolean includeSupport
```
      Specifies whether a budget includes support subscription fees.
      
      The default value is true.
    - includeDiscount
```
Boolean includeDiscount
```
      Specifies whether a budget includes discounts.
      
      The default value is true.
    - useAmortized
```
Boolean useAmortized
```
      Specifies whether a budget uses the amortized rate.
      
      The default value is false.
- Class com.amazonaws.services.budgets.model.CreateBudgetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budget.
    - budget
```
Budget budget
```
      The budget object that you want to create.
    - notificationsWithSubscribers
```
List<E> notificationsWithSubscribers
```
      A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, AWS creates the notifications and subscribers for you.
- Class com.amazonaws.services.budgets.model.CreateBudgetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.budgets.model.CreateNotificationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budget that you want to create a notification for.
    - budgetName
```
String budgetName
```
      The name of the budget that you want AWS to notify you about. Budget names must be unique within an account.
    - notification
```
Notification notification
```
      The notification that you want to create.
    - subscribers
```
List<E> subscribers
```
      A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.
- Class com.amazonaws.services.budgets.model.CreateNotificationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.budgets.model.CreateSubscriberRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budget that you want to create a subscriber for.
    - budgetName
```
String budgetName
```
      The name of the budget that you want to subscribe to. Budget names must be unique within an account.
    - notification
```
Notification notification
```
      The notification that you want to create a subscriber for.
    - subscriber
```
Subscriber subscriber
```
      The subscriber that you want to associate with a budget notification.
- Class com.amazonaws.services.budgets.model.CreateSubscriberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.budgets.model.CreationLimitExceededException extends AWSBudgetsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.budgets.model.DeleteBudgetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budget that you want to delete.
    - budgetName
```
String budgetName
```
      The name of the budget that you want to delete.
- Class com.amazonaws.services.budgets.model.DeleteBudgetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.budgets.model.DeleteNotificationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budget whose notification you want to delete.
    - budgetName
```
String budgetName
```
      The name of the budget whose notification you want to delete.
    - notification
```
Notification notification
```
      The notification that you want to delete.
- Class com.amazonaws.services.budgets.model.DeleteNotificationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.budgets.model.DeleteSubscriberRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budget whose subscriber you want to delete.
    - budgetName
```
String budgetName
```
      The name of the budget whose subscriber you want to delete.
    - notification
```
Notification notification
```
      The notification whose subscriber you want to delete.
    - subscriber
```
Subscriber subscriber
```
      The subscriber that you want to delete.
- Class com.amazonaws.services.budgets.model.DeleteSubscriberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.budgets.model.DescribeBudgetPerformanceHistoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
    - budgetName
```
String budgetName
```
    - timePeriod
```
TimePeriod timePeriod
```
      Retrieves how often the budget went into an ALARM state for the specified time period.
    - maxResults
```
Integer maxResults
```
    - nextToken
```
String nextToken
```
- Class com.amazonaws.services.budgets.model.DescribeBudgetPerformanceHistoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - budgetPerformanceHistory
```
BudgetPerformanceHistory budgetPerformanceHistory
```
      The history of how often the budget has gone into an ALARM state.
      
      For DAILY budgets, the history saves the state of the budget for the last 60 days. For MONTHLY budgets, the history saves the state of the budget for the current month plus the last 12 months. For QUARTERLY budgets, the history saves the state of the budget for the last four quarters.
    - nextToken
```
String nextToken
```
- Class com.amazonaws.services.budgets.model.DescribeBudgetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budget that you want a description of.
    - budgetName
```
String budgetName
```
      The name of the budget that you want a description of.
- Class com.amazonaws.services.budgets.model.DescribeBudgetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - budget
```
Budget budget
```
      The description of the budget.
- Class com.amazonaws.services.budgets.model.DescribeBudgetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budgets that you want descriptions of.
    - maxResults
```
Integer maxResults
```
      An optional integer that represents how many entries a paginated response contains. The maximum is 100.
    - nextToken
```
String nextToken
```
      The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
- Class com.amazonaws.services.budgets.model.DescribeBudgetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - budgets
```
List<E> budgets
```
      A list of budgets.
    - nextToken
```
String nextToken
```
      The pagination token in the service response that indicates the next set of results that you can retrieve.
- Class com.amazonaws.services.budgets.model.DescribeNotificationsForBudgetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budget whose notifications you want descriptions of.
    - budgetName
```
String budgetName
```
      The name of the budget whose notifications you want descriptions of.
    - maxResults
```
Integer maxResults
```
      An optional integer that represents how many entries a paginated response contains. The maximum is 100.
    - nextToken
```
String nextToken
```
      The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
- Class com.amazonaws.services.budgets.model.DescribeNotificationsForBudgetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - notifications
```
List<E> notifications
```
      A list of notifications that are associated with a budget.
    - nextToken
```
String nextToken
```
      The pagination token in the service response that indicates the next set of results that you can retrieve.
- Class com.amazonaws.services.budgets.model.DescribeSubscribersForNotificationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budget whose subscribers you want descriptions of.
    - budgetName
```
String budgetName
```
      The name of the budget whose subscribers you want descriptions of.
    - notification
```
Notification notification
```
      The notification whose subscribers you want to list.
    - maxResults
```
Integer maxResults
```
      An optional integer that represents how many entries a paginated response contains. The maximum is 100.
    - nextToken
```
String nextToken
```
      The pagination token that you include in your request to indicate the next set of results that you want to retrieve.
- Class com.amazonaws.services.budgets.model.DescribeSubscribersForNotificationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - subscribers
```
List<E> subscribers
```
      A list of subscribers that are associated with a notification.
    - nextToken
```
String nextToken
```
      The pagination token in the service response that indicates the next set of results that you can retrieve.
- Class com.amazonaws.services.budgets.model.DuplicateRecordException extends AWSBudgetsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.budgets.model.ExpiredNextTokenException extends AWSBudgetsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.budgets.model.InternalErrorException extends AWSBudgetsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.budgets.model.InvalidNextTokenException extends AWSBudgetsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.budgets.model.InvalidParameterException extends AWSBudgetsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.budgets.model.NotFoundException extends AWSBudgetsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.budgets.model.Notification extends Object implements Serializable
  - Serialized Fields
    - notificationType
```
String notificationType
```
      Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).
    - comparisonOperator
```
String comparisonOperator
```
      The comparison that is used for this notification.
    - threshold
```
Double threshold
```
      The threshold that is associated with a notification. Thresholds are always a percentage.
    - thresholdType
```
String thresholdType
```
      The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.
    - notificationState
```
String notificationState
```
      Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.
- Class com.amazonaws.services.budgets.model.NotificationWithSubscribers extends Object implements Serializable
  - Serialized Fields
    - notification
```
Notification notification
```
      The notification that is associated with a budget.
    - subscribers
```
List<E> subscribers
```
      A list of subscribers who are subscribed to this notification.
- Class com.amazonaws.services.budgets.model.Spend extends Object implements Serializable
  - Serialized Fields
    - amount
```
BigDecimal amount
```
      The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.
    - unit
```
String unit
```
      The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.
- Class com.amazonaws.services.budgets.model.Subscriber extends Object implements Serializable
  - Serialized Fields
    - subscriptionType
```
String subscriptionType
```
      The type of notification that AWS sends to a subscriber.
    - address
```
String address
```
      The address that AWS sends budget notifications to, either an SNS topic or an email.
      
      When you create a subscriber, the value of Address can't contain line breaks.
- Class com.amazonaws.services.budgets.model.TimePeriod extends Object implements Serializable
  - Serialized Fields
    - start
```
Date start
```
      The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
      
      You can change your start date with the UpdateBudget operation.
    - end
```
Date end
```
      The end date for a budget. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.
      
      After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the UpdateBudget operation.
- Class com.amazonaws.services.budgets.model.UpdateBudgetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budget that you want to update.
    - newBudget
```
Budget newBudget
```
      The budget that you want to update your budget to.
- Class com.amazonaws.services.budgets.model.UpdateBudgetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.budgets.model.UpdateNotificationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budget whose notification you want to update.
    - budgetName
```
String budgetName
```
      The name of the budget whose notification you want to update.
    - oldNotification
```
Notification oldNotification
```
      The previous notification that is associated with a budget.
    - newNotification
```
Notification newNotification
```
      The updated notification to be associated with a budget.
- Class com.amazonaws.services.budgets.model.UpdateNotificationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.budgets.model.UpdateSubscriberRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The accountId that is associated with the budget whose subscriber you want to update.
    - budgetName
```
String budgetName
```
      The name of the budget whose subscriber you want to update.
    - notification
```
Notification notification
```
      The notification whose subscriber you want to update.
    - oldSubscriber
```
Subscriber oldSubscriber
```
      The previous subscriber that is associated with a budget notification.
    - newSubscriber
```
Subscriber newSubscriber
```
      The updated subscriber that is associated with a budget notification.
- Class com.amazonaws.services.budgets.model.UpdateSubscriberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
Package com.amazonaws.services.certificatemanager.model
- Class com.amazonaws.services.certificatemanager.model.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<E> tags
```
      The key-value pair that defines the tag. The tag value is optional.
- Class com.amazonaws.services.certificatemanager.model.AddTagsToCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.certificatemanager.model.AWSCertificateManagerException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.certificatemanager.model.CertificateDetail extends Object implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
    - domainName
```
String domainName
```
      The fully qualified domain name for the certificate, such as www.example.com or example.com.
    - subjectAlternativeNames
```
List<E> subjectAlternativeNames
```
      One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
    - domainValidationOptions
```
List<E> domainValidationOptions
```
      Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED .
    - serial
```
String serial
```
      The serial number of the certificate.
    - subject
```
String subject
```
      The name of the entity that is associated with the public key contained in the certificate.
    - issuer
```
String issuer
```
      The name of the certificate authority that issued and signed the certificate.
    - createdAt
```
Date createdAt
```
      The time at which the certificate was requested. This value exists only when the certificate type is AMAZON_ISSUED.
    - issuedAt
```
Date issuedAt
```
      The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.
    - importedAt
```
Date importedAt
```
      The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED.
    - status
```
String status
```
      The status of the certificate.
    - revokedAt
```
Date revokedAt
```
      The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.
    - revocationReason
```
String revocationReason
```
      The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.
    - notBefore
```
Date notBefore
```
      The time before which the certificate is not valid.
    - notAfter
```
Date notAfter
```
      The time after which the certificate is not valid.
    - keyAlgorithm
```
String keyAlgorithm
```
      The algorithm that was used to generate the public-private key pair.
    - signatureAlgorithm
```
String signatureAlgorithm
```
      The algorithm that was used to sign the certificate.
    - inUseBy
```
List<E> inUseBy
```
      A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.
    - failureReason
```
String failureReason
```
      The reason the certificate request failed. This value exists only when the certificate status is FAILED. For more information, see Certificate Request Failed in the AWS Certificate Manager User Guide.
    - type
```
String type
```
      The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.
    - renewalSummary
```
RenewalSummary renewalSummary
```
      Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.
    - keyUsages
```
List<E> keyUsages
```
      A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
    - extendedKeyUsages
```
List<E> extendedKeyUsages
```
      Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
    - certificateAuthorityArn
```
String certificateAuthorityArn
```
      The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued the certificate. This has the following format:
      
      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
    - renewalEligibility
```
String renewalEligibility
```
      Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
    - options
```
CertificateOptions options
```
      Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.
- Class com.amazonaws.services.certificatemanager.model.CertificateOptions extends Object implements Serializable
  - Serialized Fields
    - certificateTransparencyLoggingPreference
```
String certificateTransparencyLoggingPreference
```
      You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.
- Class com.amazonaws.services.certificatemanager.model.CertificateSummary extends Object implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      Amazon Resource Name (ARN) of the certificate. This is of the form:
      
      arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
      
      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    - domainName
```
String domainName
```
      Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
- Class com.amazonaws.services.certificatemanager.model.DeleteCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      String that contains the ARN of the ACM certificate to be deleted. This must be of the form:
      
      arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
      
      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
- Class com.amazonaws.services.certificatemanager.model.DeleteCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.certificatemanager.model.DescribeCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:
      
      arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
      
      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
- Class com.amazonaws.services.certificatemanager.model.DescribeCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - certificate
```
CertificateDetail certificate
```
      Metadata about an ACM certificate.
- Class com.amazonaws.services.certificatemanager.model.DomainValidation extends Object implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.
    - validationEmails
```
List<E> validationEmails
```
      A list of email addresses that ACM used to send domain validation emails.
    - validationDomain
```
String validationDomain
```
      The domain name that ACM used to send domain validation emails.
    - validationStatus
```
String validationStatus
```
      The validation status of the domain name. This can be one of the following values:
      
      PENDING_VALIDATION
      
      SUCCESS
      FAILED



Package com.amazonaws.services.chime.model




Class com.amazonaws.services.chime.model.AccessDeniedException extends AmazonChimeException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.chime.model.Account extends Object implements Serializable


Serialized Fields


awsAccountId
String awsAccountId

 The AWS account ID.
 


accountId
String accountId

 The Amazon Chime account ID.
 


name
String name

 The Amazon Chime account name.
 


accountType
String accountType

 The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime
 Accounts in the Amazon Chime Administration Guide.
 


createdTimestamp
Date createdTimestamp

 The Amazon Chime account creation timestamp, in ISO 8601 format.
 


defaultLicense
String defaultLicense

 The default license for the Amazon Chime account.
 


supportedLicenses
List<E> supportedLicenses

 Supported licenses for the Amazon Chime account.
 


signinDelegateGroups
List<E> signinDelegateGroups

 The sign-in delegate groups associated with the account.
 








Class com.amazonaws.services.chime.model.AccountSettings extends Object implements Serializable


Serialized Fields


disableRemoteControl
Boolean disableRemoteControl

 Setting that stops or starts remote control of shared screens during meetings.
 


enableDialOut
Boolean enableDialOut

 Setting that allows meeting participants to choose the Call me at a phone number option. For more
 information, see Join a Meeting
 without the Amazon Chime App.
 








Class com.amazonaws.services.chime.model.AlexaForBusinessMetadata extends Object implements Serializable


Serialized Fields


isAlexaForBusinessEnabled
Boolean isAlexaForBusinessEnabled

 Starts or stops Alexa for Business.
 


alexaForBusinessRoomArn
String alexaForBusinessRoomArn

 The ARN of the room resource.
 








Class com.amazonaws.services.chime.model.AmazonChimeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.chime.model.AssociatePhoneNumbersWithVoiceConnectorGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorGroupId
String voiceConnectorGroupId

 The Amazon Chime Voice Connector group ID.
 


e164PhoneNumbers
List<E> e164PhoneNumbers

 List of phone numbers, in E.164 format.
 


forceAssociate
Boolean forceAssociate

 If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes
 any previously existing associations. If false, does not associate any phone numbers that have previously
 existing associations.
 








Class com.amazonaws.services.chime.model.AssociatePhoneNumbersWithVoiceConnectorGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumberErrors
List<E> phoneNumberErrors

 If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned,
 along with error codes and error messages.
 








Class com.amazonaws.services.chime.model.AssociatePhoneNumbersWithVoiceConnectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 


e164PhoneNumbers
List<E> e164PhoneNumbers

 List of phone numbers, in E.164 format.
 


forceAssociate
Boolean forceAssociate

 If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector and removes any
 previously existing associations. If false, does not associate any phone numbers that have previously existing
 associations.
 








Class com.amazonaws.services.chime.model.AssociatePhoneNumbersWithVoiceConnectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumberErrors
List<E> phoneNumberErrors

 If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned,
 along with error codes and error messages.
 








Class com.amazonaws.services.chime.model.AssociatePhoneNumberWithUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


userId
String userId

 The user ID.
 


e164PhoneNumber
String e164PhoneNumber

 The phone number, in E.164 format.
 








Class com.amazonaws.services.chime.model.AssociatePhoneNumberWithUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.AssociateSigninDelegateGroupsWithAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


signinDelegateGroups
List<E> signinDelegateGroups

 The sign-in delegate groups.
 








Class com.amazonaws.services.chime.model.AssociateSigninDelegateGroupsWithAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.Attendee extends Object implements Serializable


Serialized Fields


externalUserId
String externalUserId

 The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.
 


attendeeId
String attendeeId

 The Amazon Chime SDK attendee ID.
 


joinToken
String joinToken

 The join token used by the Amazon Chime SDK attendee.
 








Class com.amazonaws.services.chime.model.BadRequestException extends AmazonChimeException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.chime.model.BatchCreateAttendeeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


meetingId
String meetingId

 The Amazon Chime SDK meeting ID.
 


attendees
List<E> attendees

 The request containing the attendees to create.
 








Class com.amazonaws.services.chime.model.BatchCreateAttendeeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attendees
List<E> attendees

 The attendee information, including attendees IDs and join tokens.
 


errors
List<E> errors

 If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along
 with error codes and error messages.
 








Class com.amazonaws.services.chime.model.BatchCreateRoomMembershipRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


roomId
String roomId

 The room ID.
 


membershipItemList
List<E> membershipItemList

 The list of membership items.
 








Class com.amazonaws.services.chime.model.BatchCreateRoomMembershipResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


errors
List<E> errors

 If the action fails for one or more of the member IDs in the request, a list of the member IDs is returned, along
 with error codes and error messages.
 








Class com.amazonaws.services.chime.model.BatchDeletePhoneNumberRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


phoneNumberIds
List<E> phoneNumberIds

 List of phone number IDs.
 








Class com.amazonaws.services.chime.model.BatchDeletePhoneNumberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumberErrors
List<E> phoneNumberErrors

 If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned,
 along with error codes and error messages.
 








Class com.amazonaws.services.chime.model.BatchSuspendUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


userIdList
List<E> userIdList

 The request containing the user IDs to suspend.
 








Class com.amazonaws.services.chime.model.BatchSuspendUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userErrors
List<E> userErrors

 If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user
 IDs is returned, along with error codes and error messages.
 








Class com.amazonaws.services.chime.model.BatchUnsuspendUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


userIdList
List<E> userIdList

 The request containing the user IDs to unsuspend.
 








Class com.amazonaws.services.chime.model.BatchUnsuspendUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userErrors
List<E> userErrors

 If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user
 IDs is returned, along with error codes and error messages.
 








Class com.amazonaws.services.chime.model.BatchUpdatePhoneNumberRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


updatePhoneNumberRequestItems
List<E> updatePhoneNumberRequestItems

 The request containing the phone number IDs and product types or calling names to update.
 








Class com.amazonaws.services.chime.model.BatchUpdatePhoneNumberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumberErrors
List<E> phoneNumberErrors

 If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned,
 along with error codes and error messages.
 








Class com.amazonaws.services.chime.model.BatchUpdateUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


updateUserRequestItems
List<E> updateUserRequestItems

 The request containing the user IDs and details to update.
 








Class com.amazonaws.services.chime.model.BatchUpdateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userErrors
List<E> userErrors

 If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs
 is returned, along with error codes and error messages.
 








Class com.amazonaws.services.chime.model.Bot extends Object implements Serializable


Serialized Fields


botId
String botId

 The bot ID.
 


userId
String userId

 The unique ID for the bot user.
 


displayName
String displayName

 The bot display name.
 


botType
String botType

 The bot type.
 


disabled
Boolean disabled

 When true, the bot is stopped from running in your account.
 


createdTimestamp
Date createdTimestamp

 The bot creation timestamp, in ISO 8601 format.
 


updatedTimestamp
Date updatedTimestamp

 The updated bot timestamp, in ISO 8601 format.
 


botEmail
String botEmail

 The bot email address.
 


securityToken
String securityToken

 The security token used to authenticate Amazon Chime with the outgoing event endpoint.
 








Class com.amazonaws.services.chime.model.BusinessCallingSettings extends Object implements Serializable


Serialized Fields


cdrBucket
String cdrBucket

 The Amazon S3 bucket designated for call detail record storage.
 








Class com.amazonaws.services.chime.model.ConflictException extends AmazonChimeException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.chime.model.CreateAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the Amazon Chime account.
 








Class com.amazonaws.services.chime.model.CreateAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


account
Account account

 The Amazon Chime account details.
 








Class com.amazonaws.services.chime.model.CreateAttendeeError extends Object implements Serializable


Serialized Fields


externalUserId
String externalUserId

 The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.
 


errorCode
String errorCode

 The error code.
 


errorMessage
String errorMessage

 The error message.
 








Class com.amazonaws.services.chime.model.CreateAttendeeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


meetingId
String meetingId

 The Amazon Chime SDK meeting ID.
 


externalUserId
String externalUserId

 The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.
 








Class com.amazonaws.services.chime.model.CreateAttendeeRequestItem extends Object implements Serializable


Serialized Fields


externalUserId
String externalUserId

 The Amazon Chime SDK external user ID. Links the attendee to an identity managed by a builder application.
 








Class com.amazonaws.services.chime.model.CreateAttendeeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attendee
Attendee attendee

 The attendee information, including attendee ID and join token.
 








Class com.amazonaws.services.chime.model.CreateBotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


displayName
String displayName

 The bot display name.
 


domain
String domain

 The domain of the Amazon Chime Enterprise account.
 








Class com.amazonaws.services.chime.model.CreateBotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bot
Bot bot

 The bot details.
 








Class com.amazonaws.services.chime.model.CreateMeetingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientRequestToken
String clientRequestToken

 The unique identifier for the client request. Use a different token for different meetings.
 


meetingHostId
String meetingHostId

 Reserved.
 


mediaRegion
String mediaRegion

 The Region in which to create the meeting. Available values: ap-northeast-1,
 ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1,
 eu-north-1, eu-west-1, eu-west-2, eu-west-3,
 sa-east-1, us-east-1, us-east-2, us-west-1,
 us-west-2.
 


notificationsConfiguration
MeetingNotificationConfiguration notificationsConfiguration

 The configuration for resource targets to receive notifications when meeting and attendee events occur.
 








Class com.amazonaws.services.chime.model.CreateMeetingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


meeting
Meeting meeting

 The meeting information, including the meeting ID and MediaPlacement.
 








Class com.amazonaws.services.chime.model.CreatePhoneNumberOrderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


productType
String productType

 The phone number product type.
 


e164PhoneNumbers
List<E> e164PhoneNumbers

 List of phone numbers, in E.164 format.
 








Class com.amazonaws.services.chime.model.CreatePhoneNumberOrderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumberOrder
PhoneNumberOrder phoneNumberOrder

 The phone number order details.
 








Class com.amazonaws.services.chime.model.CreateRoomMembershipRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


roomId
String roomId

 The room ID.
 


memberId
String memberId

 The Amazon Chime member ID (user ID or bot ID).
 


role
String role

 The role of the member.
 








Class com.amazonaws.services.chime.model.CreateRoomMembershipResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roomMembership
RoomMembership roomMembership

 The room membership details.
 








Class com.amazonaws.services.chime.model.CreateRoomRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


name
String name

 The room name.
 


clientRequestToken
String clientRequestToken

 The idempotency token for the request.
 








Class com.amazonaws.services.chime.model.CreateRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


room
Room room

 The room details.
 








Class com.amazonaws.services.chime.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


username
String username

 The user name.
 


email
String email

 The user's email address.
 


userType
String userType

 The user type.
 








Class com.amazonaws.services.chime.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


user
User user








Class com.amazonaws.services.chime.model.CreateVoiceConnectorGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the Amazon Chime Voice Connector group.
 


voiceConnectorItems
List<E> voiceConnectorItems

 The Amazon Chime Voice Connectors to route inbound calls to.
 








Class com.amazonaws.services.chime.model.CreateVoiceConnectorGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


voiceConnectorGroup
VoiceConnectorGroup voiceConnectorGroup

 The Amazon Chime Voice Connector group details.
 








Class com.amazonaws.services.chime.model.CreateVoiceConnectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the Amazon Chime Voice Connector.
 


awsRegion
String awsRegion

 The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1.
 


requireEncryption
Boolean requireEncryption

 When enabled, requires encryption for the Amazon Chime Voice Connector.
 








Class com.amazonaws.services.chime.model.CreateVoiceConnectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


voiceConnector
VoiceConnector voiceConnector

 The Amazon Chime Voice Connector details.
 








Class com.amazonaws.services.chime.model.Credential extends Object implements Serializable


Serialized Fields


username
String username

 The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.
 


password
String password

 The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.
 








Class com.amazonaws.services.chime.model.DeleteAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 








Class com.amazonaws.services.chime.model.DeleteAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DeleteAttendeeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


meetingId
String meetingId

 The Amazon Chime SDK meeting ID.
 


attendeeId
String attendeeId

 The Amazon Chime SDK attendee ID.
 








Class com.amazonaws.services.chime.model.DeleteAttendeeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DeleteEventsConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


botId
String botId

 The bot ID.
 








Class com.amazonaws.services.chime.model.DeleteEventsConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DeleteMeetingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


meetingId
String meetingId

 The Amazon Chime SDK meeting ID.
 








Class com.amazonaws.services.chime.model.DeleteMeetingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DeletePhoneNumberRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


phoneNumberId
String phoneNumberId

 The phone number ID.
 








Class com.amazonaws.services.chime.model.DeletePhoneNumberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DeleteRoomMembershipRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


roomId
String roomId

 The room ID.
 


memberId
String memberId

 The member ID (user ID or bot ID).
 








Class com.amazonaws.services.chime.model.DeleteRoomMembershipResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DeleteRoomRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


roomId
String roomId

 The chat room ID.
 








Class com.amazonaws.services.chime.model.DeleteRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DeleteVoiceConnectorGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorGroupId
String voiceConnectorGroupId

 The Amazon Chime Voice Connector group ID.
 








Class com.amazonaws.services.chime.model.DeleteVoiceConnectorGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DeleteVoiceConnectorOriginationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 








Class com.amazonaws.services.chime.model.DeleteVoiceConnectorOriginationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DeleteVoiceConnectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 








Class com.amazonaws.services.chime.model.DeleteVoiceConnectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DeleteVoiceConnectorStreamingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 








Class com.amazonaws.services.chime.model.DeleteVoiceConnectorStreamingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DeleteVoiceConnectorTerminationCredentialsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 


usernames
List<E> usernames

 The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.
 








Class com.amazonaws.services.chime.model.DeleteVoiceConnectorTerminationCredentialsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DeleteVoiceConnectorTerminationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 








Class com.amazonaws.services.chime.model.DeleteVoiceConnectorTerminationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DisassociatePhoneNumberFromUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


userId
String userId

 The user ID.
 








Class com.amazonaws.services.chime.model.DisassociatePhoneNumberFromUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.DisassociatePhoneNumbersFromVoiceConnectorGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorGroupId
String voiceConnectorGroupId

 The Amazon Chime Voice Connector group ID.
 


e164PhoneNumbers
List<E> e164PhoneNumbers

 List of phone numbers, in E.164 format.
 








Class com.amazonaws.services.chime.model.DisassociatePhoneNumbersFromVoiceConnectorGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumberErrors
List<E> phoneNumberErrors

 If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned,
 along with error codes and error messages.
 








Class com.amazonaws.services.chime.model.DisassociatePhoneNumbersFromVoiceConnectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 


e164PhoneNumbers
List<E> e164PhoneNumbers

 List of phone numbers, in E.164 format.
 








Class com.amazonaws.services.chime.model.DisassociatePhoneNumbersFromVoiceConnectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumberErrors
List<E> phoneNumberErrors

 If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned,
 along with error codes and error messages.
 








Class com.amazonaws.services.chime.model.DisassociateSigninDelegateGroupsFromAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


groupNames
List<E> groupNames

 The sign-in delegate group names.
 








Class com.amazonaws.services.chime.model.DisassociateSigninDelegateGroupsFromAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.EventsConfiguration extends Object implements Serializable


Serialized Fields


botId
String botId

 The bot ID.
 


outboundEventsHTTPSEndpoint
String outboundEventsHTTPSEndpoint

 HTTPS endpoint that allows a bot to receive outgoing events.
 


lambdaFunctionArn
String lambdaFunctionArn

 Lambda function ARN that allows a bot to receive outgoing events.
 








Class com.amazonaws.services.chime.model.ForbiddenException extends AmazonChimeException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.chime.model.GetAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 








Class com.amazonaws.services.chime.model.GetAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


account
Account account

 The Amazon Chime account details.
 








Class com.amazonaws.services.chime.model.GetAccountSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 








Class com.amazonaws.services.chime.model.GetAccountSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accountSettings
AccountSettings accountSettings

 The Amazon Chime account settings.
 








Class com.amazonaws.services.chime.model.GetAttendeeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


meetingId
String meetingId

 The Amazon Chime SDK meeting ID.
 


attendeeId
String attendeeId

 The Amazon Chime SDK attendee ID.
 








Class com.amazonaws.services.chime.model.GetAttendeeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attendee
Attendee attendee

 The Amazon Chime SDK attendee information.
 








Class com.amazonaws.services.chime.model.GetBotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


botId
String botId

 The bot ID.
 








Class com.amazonaws.services.chime.model.GetBotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bot
Bot bot

 The chat bot details.
 








Class com.amazonaws.services.chime.model.GetEventsConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


botId
String botId

 The bot ID.
 








Class com.amazonaws.services.chime.model.GetEventsConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventsConfiguration
EventsConfiguration eventsConfiguration

 The events configuration details.
 








Class com.amazonaws.services.chime.model.GetGlobalSettingsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.chime.model.GetGlobalSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


businessCalling
BusinessCallingSettings businessCalling

 The Amazon Chime Business Calling settings.
 


voiceConnector
VoiceConnectorSettings voiceConnector

 The Amazon Chime Voice Connector settings.
 








Class com.amazonaws.services.chime.model.GetMeetingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


meetingId
String meetingId

 The Amazon Chime SDK meeting ID.
 








Class com.amazonaws.services.chime.model.GetMeetingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


meeting
Meeting meeting

 The Amazon Chime SDK meeting information.
 








Class com.amazonaws.services.chime.model.GetPhoneNumberOrderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


phoneNumberOrderId
String phoneNumberOrderId

 The ID for the phone number order.
 








Class com.amazonaws.services.chime.model.GetPhoneNumberOrderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumberOrder
PhoneNumberOrder phoneNumberOrder

 The phone number order details.
 








Class com.amazonaws.services.chime.model.GetPhoneNumberRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


phoneNumberId
String phoneNumberId

 The phone number ID.
 








Class com.amazonaws.services.chime.model.GetPhoneNumberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumber
PhoneNumber phoneNumber

 The phone number details.
 








Class com.amazonaws.services.chime.model.GetPhoneNumberSettingsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.chime.model.GetPhoneNumberSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


callingName
String callingName

 The default outbound calling name for the account.
 


callingNameUpdatedTimestamp
Date callingNameUpdatedTimestamp

 The updated outbound calling name timestamp, in ISO 8601 format.
 








Class com.amazonaws.services.chime.model.GetRoomRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


roomId
String roomId

 The room ID.
 








Class com.amazonaws.services.chime.model.GetRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


room
Room room

 The room details.
 








Class com.amazonaws.services.chime.model.GetUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


userId
String userId

 The user ID.
 








Class com.amazonaws.services.chime.model.GetUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


user
User user

 The user details.
 








Class com.amazonaws.services.chime.model.GetUserSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


userId
String userId

 The user ID.
 








Class com.amazonaws.services.chime.model.GetUserSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userSettings
UserSettings userSettings

 The user settings.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorGroupId
String voiceConnectorGroupId

 The Amazon Chime Voice Connector group ID.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


voiceConnectorGroup
VoiceConnectorGroup voiceConnectorGroup

 The Amazon Chime Voice Connector group details.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorLoggingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorLoggingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loggingConfiguration
LoggingConfiguration loggingConfiguration

 The logging configuration details.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorOriginationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorOriginationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


origination
Origination origination

 The origination setting details.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


voiceConnector
VoiceConnector voiceConnector

 The Amazon Chime Voice Connector details.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorStreamingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorStreamingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamingConfiguration
StreamingConfiguration streamingConfiguration

 The streaming configuration details.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorTerminationHealthRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorTerminationHealthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


terminationHealth
TerminationHealth terminationHealth

 The termination health details.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorTerminationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 








Class com.amazonaws.services.chime.model.GetVoiceConnectorTerminationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


termination
Termination termination

 The termination setting details.
 








Class com.amazonaws.services.chime.model.Invite extends Object implements Serializable


Serialized Fields


inviteId
String inviteId

 The invite ID.
 


status
String status

 The status of the invite.
 


emailAddress
String emailAddress

 The email address to which the invite is sent.
 


emailStatus
String emailStatus

 The status of the invite email.
 








Class com.amazonaws.services.chime.model.InviteUsersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


userEmailList
List<E> userEmailList

 The user email addresses to which to send the email invitation.
 


userType
String userType

 The user type.
 








Class com.amazonaws.services.chime.model.InviteUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


invites
List<E> invites

 The email invitation details.
 








Class com.amazonaws.services.chime.model.ListAccountsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Amazon Chime account name prefix with which to filter results.
 


userEmail
String userEmail

 User email address with which to filter results.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call. Defaults to 100.
 








Class com.amazonaws.services.chime.model.ListAccountsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accounts
List<E> accounts

 List of Amazon Chime accounts and account details.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListAttendeesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


meetingId
String meetingId

 The Amazon Chime SDK meeting ID.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 








Class com.amazonaws.services.chime.model.ListAttendeesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attendees
List<E> attendees

 The Amazon Chime SDK attendee information.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListBotsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call. The default is 10.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListBotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bots
List<E> bots

 List of bots and bot details.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListMeetingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 








Class com.amazonaws.services.chime.model.ListMeetingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


meetings
List<E> meetings

 The Amazon Chime SDK meeting information.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListPhoneNumberOrdersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 








Class com.amazonaws.services.chime.model.ListPhoneNumberOrdersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumberOrders
List<E> phoneNumberOrders

 The phone number order details.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListPhoneNumbersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


status
String status

 The phone number status.
 


productType
String productType

 The phone number product type.
 


filterName
String filterName

 The filter to use to limit the number of results.
 


filterValue
String filterValue

 The value to use for the filter.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListPhoneNumbersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumbers
List<E> phoneNumbers

 The phone number details.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListRoomMembershipsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


roomId
String roomId

 The room ID.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListRoomMembershipsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roomMemberships
List<E> roomMemberships

 The room membership details.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListRoomsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


memberId
String memberId

 The member ID (user ID or bot ID).
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListRoomsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rooms
List<E> rooms

 The room details.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


userEmail
String userEmail

 Optional. The user email address used to filter results. Maximum 1.
 


userType
String userType

 The user type.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call. Defaults to 100.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


users
List<E> users

 List of users and user details.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListVoiceConnectorGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 








Class com.amazonaws.services.chime.model.ListVoiceConnectorGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


voiceConnectorGroups
List<E> voiceConnectorGroups

 The details of the Amazon Chime Voice Connector groups.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListVoiceConnectorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 








Class com.amazonaws.services.chime.model.ListVoiceConnectorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


voiceConnectors
List<E> voiceConnectors

 The details of the Amazon Chime Voice Connectors.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.ListVoiceConnectorTerminationCredentialsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 








Class com.amazonaws.services.chime.model.ListVoiceConnectorTerminationCredentialsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


usernames
List<E> usernames

 A list of user names.
 








Class com.amazonaws.services.chime.model.LoggingConfiguration extends Object implements Serializable


Serialized Fields


enableSIPLogs
Boolean enableSIPLogs

 When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
 








Class com.amazonaws.services.chime.model.LogoutUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


userId
String userId

 The user ID.
 








Class com.amazonaws.services.chime.model.LogoutUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.MediaPlacement extends Object implements Serializable


Serialized Fields


audioHostUrl
String audioHostUrl

 The audio host URL.
 


screenDataUrl
String screenDataUrl

 The screen data URL.
 


screenSharingUrl
String screenSharingUrl

 The screen sharing URL.
 


screenViewingUrl
String screenViewingUrl

 The screen viewing URL.
 


signalingUrl
String signalingUrl

 The signaling URL.
 


turnControlUrl
String turnControlUrl

 The turn control URL.
 








Class com.amazonaws.services.chime.model.Meeting extends Object implements Serializable


Serialized Fields


meetingId
String meetingId

 The Amazon Chime SDK meeting ID.
 


mediaPlacement
MediaPlacement mediaPlacement

 The media placement for the meeting.
 


mediaRegion
String mediaRegion

 The Region in which to create the meeting. Available values: ap-northeast-1,
 ap-southeast-1, ap-southeast-2, ca-central-1, eu-central-1,
 eu-north-1, eu-west-1, eu-west-2, eu-west-3,
 sa-east-1, us-east-1, us-east-2, us-west-1,
 us-west-2.
 








Class com.amazonaws.services.chime.model.MeetingNotificationConfiguration extends Object implements Serializable


Serialized Fields


snsTopicArn
String snsTopicArn

 The SNS topic ARN.
 


sqsQueueArn
String sqsQueueArn

 The SQS queue ARN.
 








Class com.amazonaws.services.chime.model.Member extends Object implements Serializable


Serialized Fields


memberId
String memberId

 The member ID (user ID or bot ID).
 


memberType
String memberType

 The member type.
 


email
String email

 The member email address.
 


fullName
String fullName

 The member name.
 


accountId
String accountId

 The Amazon Chime account ID.
 








Class com.amazonaws.services.chime.model.MemberError extends Object implements Serializable


Serialized Fields


memberId
String memberId

 The member ID.
 


errorCode
String errorCode

 The error code.
 


errorMessage
String errorMessage

 The error message.
 








Class com.amazonaws.services.chime.model.MembershipItem extends Object implements Serializable


Serialized Fields


memberId
String memberId

 The member ID.
 


role
String role

 The member role.
 








Class com.amazonaws.services.chime.model.NotFoundException extends AmazonChimeException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.chime.model.OrderedPhoneNumber extends Object implements Serializable


Serialized Fields


e164PhoneNumber
String e164PhoneNumber

 The phone number, in E.164 format.
 


status
String status

 The phone number status.
 








Class com.amazonaws.services.chime.model.Origination extends Object implements Serializable


Serialized Fields


routes
List<E> routes

 The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of
 20.
 


disabled
Boolean disabled

 When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
 








Class com.amazonaws.services.chime.model.OriginationRoute extends Object implements Serializable


Serialized Fields


host
String host

 The FQDN or IP address to contact for origination traffic.
 


port
Integer port

 The designated origination route port. Defaults to 5060.
 


protocol
String protocol

 The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol
 by default.
 


priority
Integer priority

 The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted
 first.
 


weight
Integer weight

 The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on
 their relative weight.
 








Class com.amazonaws.services.chime.model.PhoneNumber extends Object implements Serializable


Serialized Fields


phoneNumberId
String phoneNumberId

 The phone number ID.
 


e164PhoneNumber
String e164PhoneNumber

 The phone number, in E.164 format.
 


type
String type

 The phone number type.
 


productType
String productType

 The phone number product type.
 


status
String status

 The phone number status.
 


capabilities
PhoneNumberCapabilities capabilities

 The phone number capabilities.
 


associations
List<E> associations

 The phone number associations.
 


callingName
String callingName

 The outbound calling name associated with the phone number.
 


callingNameStatus
String callingNameStatus

 The outbound calling name status.
 


createdTimestamp
Date createdTimestamp

 The phone number creation timestamp, in ISO 8601 format.
 


updatedTimestamp
Date updatedTimestamp

 The updated phone number timestamp, in ISO 8601 format.
 


deletionTimestamp
Date deletionTimestamp

 The deleted phone number timestamp, in ISO 8601 format.
 








Class com.amazonaws.services.chime.model.PhoneNumberAssociation extends Object implements Serializable


Serialized Fields


value
String value

 Contains the ID for the entity specified in Name.
 


name
String name

 Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon
 Chime Voice Connector group ID.
 


associatedTimestamp
Date associatedTimestamp

 The timestamp of the phone number association, in ISO 8601 format.
 








Class com.amazonaws.services.chime.model.PhoneNumberCapabilities extends Object implements Serializable


Serialized Fields


inboundCall
Boolean inboundCall

 Allows or denies inbound calling for the specified phone number.
 


outboundCall
Boolean outboundCall

 Allows or denies outbound calling for the specified phone number.
 


inboundSMS
Boolean inboundSMS

 Allows or denies inbound SMS messaging for the specified phone number.
 


outboundSMS
Boolean outboundSMS

 Allows or denies outbound SMS messaging for the specified phone number.
 


inboundMMS
Boolean inboundMMS

 Allows or denies inbound MMS messaging for the specified phone number.
 


outboundMMS
Boolean outboundMMS

 Allows or denies outbound MMS messaging for the specified phone number.
 








Class com.amazonaws.services.chime.model.PhoneNumberError extends Object implements Serializable


Serialized Fields


phoneNumberId
String phoneNumberId

 The phone number ID for which the action failed.
 


errorCode
String errorCode

 The error code.
 


errorMessage
String errorMessage

 The error message.
 








Class com.amazonaws.services.chime.model.PhoneNumberOrder extends Object implements Serializable


Serialized Fields


phoneNumberOrderId
String phoneNumberOrderId

 The phone number order ID.
 


productType
String productType

 The phone number order product type.
 


status
String status

 The status of the phone number order.
 


orderedPhoneNumbers
List<E> orderedPhoneNumbers

 The ordered phone number details, such as the phone number in E.164 format and the phone number status.
 


createdTimestamp
Date createdTimestamp

 The phone number order creation timestamp, in ISO 8601 format.
 


updatedTimestamp
Date updatedTimestamp

 The updated phone number order timestamp, in ISO 8601 format.
 








Class com.amazonaws.services.chime.model.PutEventsConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


botId
String botId

 The bot ID.
 


outboundEventsHTTPSEndpoint
String outboundEventsHTTPSEndpoint

 HTTPS endpoint that allows the bot to receive outgoing events.
 


lambdaFunctionArn
String lambdaFunctionArn

 Lambda function ARN that allows the bot to receive outgoing events.
 








Class com.amazonaws.services.chime.model.PutEventsConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventsConfiguration
EventsConfiguration eventsConfiguration








Class com.amazonaws.services.chime.model.PutVoiceConnectorLoggingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 


loggingConfiguration
LoggingConfiguration loggingConfiguration

 The logging configuration details to add.
 








Class com.amazonaws.services.chime.model.PutVoiceConnectorLoggingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loggingConfiguration
LoggingConfiguration loggingConfiguration

 The updated logging configuration details.
 








Class com.amazonaws.services.chime.model.PutVoiceConnectorOriginationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 


origination
Origination origination

 The origination setting details to add.
 








Class com.amazonaws.services.chime.model.PutVoiceConnectorOriginationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


origination
Origination origination

 The updated origination setting details.
 








Class com.amazonaws.services.chime.model.PutVoiceConnectorStreamingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 


streamingConfiguration
StreamingConfiguration streamingConfiguration

 The streaming configuration details to add.
 








Class com.amazonaws.services.chime.model.PutVoiceConnectorStreamingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamingConfiguration
StreamingConfiguration streamingConfiguration

 The updated streaming configuration details.
 








Class com.amazonaws.services.chime.model.PutVoiceConnectorTerminationCredentialsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 


credentials
List<E> credentials

 The termination SIP credentials.
 








Class com.amazonaws.services.chime.model.PutVoiceConnectorTerminationCredentialsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.PutVoiceConnectorTerminationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 


termination
Termination termination

 The termination setting details to add.
 








Class com.amazonaws.services.chime.model.PutVoiceConnectorTerminationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


termination
Termination termination

 The updated termination setting details.
 








Class com.amazonaws.services.chime.model.RegenerateSecurityTokenRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


botId
String botId

 The bot ID.
 








Class com.amazonaws.services.chime.model.RegenerateSecurityTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bot
Bot bot








Class com.amazonaws.services.chime.model.ResetPersonalPINRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


userId
String userId

 The user ID.
 








Class com.amazonaws.services.chime.model.ResetPersonalPINResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


user
User user

 The user details and new personal meeting PIN.
 








Class com.amazonaws.services.chime.model.ResourceLimitExceededException extends AmazonChimeException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.chime.model.RestorePhoneNumberRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


phoneNumberId
String phoneNumberId

 The phone number.
 








Class com.amazonaws.services.chime.model.RestorePhoneNumberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumber
PhoneNumber phoneNumber

 The phone number details.
 








Class com.amazonaws.services.chime.model.Room extends Object implements Serializable


Serialized Fields


roomId
String roomId

 The room ID.
 


name
String name

 The room name.
 


accountId
String accountId

 The Amazon Chime account ID.
 


createdBy
String createdBy

 The identifier of the room creator.
 


createdTimestamp
Date createdTimestamp

 The room creation timestamp, in ISO 8601 format.
 


updatedTimestamp
Date updatedTimestamp

 The room update timestamp, in ISO 8601 format.
 








Class com.amazonaws.services.chime.model.RoomMembership extends Object implements Serializable


Serialized Fields


roomId
String roomId

 The room ID.
 


member
Member member


role
String role

 The membership role.
 


invitedBy
String invitedBy

 The identifier of the user that invited the room member.
 


updatedTimestamp
Date updatedTimestamp

 The room membership update timestamp, in ISO 8601 format.
 








Class com.amazonaws.services.chime.model.SearchAvailablePhoneNumbersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


areaCode
String areaCode

 The area code used to filter results.
 


city
String city

 The city used to filter results.
 


country
String country

 The country used to filter results.
 


state
String state

 The state used to filter results.
 


tollFreePrefix
String tollFreePrefix

 The toll-free prefix that you use to filter results.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.chime.model.SearchAvailablePhoneNumbersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


e164PhoneNumbers
List<E> e164PhoneNumbers

 List of phone numbers, in E.164 format.
 








Class com.amazonaws.services.chime.model.ServiceFailureException extends AmazonChimeException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.chime.model.ServiceUnavailableException extends AmazonChimeException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.chime.model.SigninDelegateGroup extends Object implements Serializable


Serialized Fields


groupName
String groupName

 The group name.
 








Class com.amazonaws.services.chime.model.StreamingConfiguration extends Object implements Serializable


Serialized Fields


dataRetentionInHours
Integer dataRetentionInHours

 The retention period, in hours, for the Amazon Kinesis data.
 


disabled
Boolean disabled

 When true, media streaming to Amazon Kinesis is turned off.
 








Class com.amazonaws.services.chime.model.TelephonySettings extends Object implements Serializable


Serialized Fields


inboundCalling
Boolean inboundCalling

 Allows or denies inbound calling.
 


outboundCalling
Boolean outboundCalling

 Allows or denies outbound calling.
 


sMS
Boolean sMS

 Allows or denies SMS messaging.
 








Class com.amazonaws.services.chime.model.Termination extends Object implements Serializable


Serialized Fields


cpsLimit
Integer cpsLimit

 The limit on calls per second. Max value based on account service limit. Default value of 1.
 


defaultPhoneNumber
String defaultPhoneNumber

 The default caller ID phone number.
 


callingRegions
List<E> callingRegions

 The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.
 


cidrAllowedList
List<E> cidrAllowedList

 The IP addresses allowed to make calls, in CIDR format. Required.
 


disabled
Boolean disabled

 When termination settings are disabled, outbound calls can not be made.
 








Class com.amazonaws.services.chime.model.TerminationHealth extends Object implements Serializable


Serialized Fields


timestamp
Date timestamp

 The timestamp, in ISO 8601 format.
 


source
String source

 The source IP address.
 








Class com.amazonaws.services.chime.model.ThrottledClientException extends AmazonChimeException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.chime.model.UnauthorizedClientException extends AmazonChimeException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.chime.model.UnprocessableEntityException extends AmazonChimeException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.chime.model.UpdateAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


name
String name

 The new name for the specified Amazon Chime account.
 








Class com.amazonaws.services.chime.model.UpdateAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


account
Account account

 The updated Amazon Chime account details.
 








Class com.amazonaws.services.chime.model.UpdateAccountSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


accountSettings
AccountSettings accountSettings

 The Amazon Chime account settings to update.
 








Class com.amazonaws.services.chime.model.UpdateAccountSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.UpdateBotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


botId
String botId

 The bot ID.
 


disabled
Boolean disabled

 When true, stops the specified bot from running in your account.
 








Class com.amazonaws.services.chime.model.UpdateBotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bot
Bot bot

 The updated bot details.
 








Class com.amazonaws.services.chime.model.UpdateGlobalSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


businessCalling
BusinessCallingSettings businessCalling

 The Amazon Chime Business Calling settings.
 


voiceConnector
VoiceConnectorSettings voiceConnector

 The Amazon Chime Voice Connector settings.
 








Class com.amazonaws.services.chime.model.UpdateGlobalSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.UpdatePhoneNumberRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


phoneNumberId
String phoneNumberId

 The phone number ID.
 


productType
String productType

 The product type.
 


callingName
String callingName

 The outbound calling name associated with the phone number.
 








Class com.amazonaws.services.chime.model.UpdatePhoneNumberRequestItem extends Object implements Serializable


Serialized Fields


phoneNumberId
String phoneNumberId

 The phone number ID to update.
 


productType
String productType

 The product type to update.
 


callingName
String callingName

 The outbound calling name to update.
 








Class com.amazonaws.services.chime.model.UpdatePhoneNumberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumber
PhoneNumber phoneNumber

 The updated phone number details.
 








Class com.amazonaws.services.chime.model.UpdatePhoneNumberSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


callingName
String callingName

 The default outbound calling name for the account.
 








Class com.amazonaws.services.chime.model.UpdatePhoneNumberSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.UpdateRoomMembershipRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


roomId
String roomId

 The room ID.
 


memberId
String memberId

 The member ID.
 


role
String role

 The role of the member.
 








Class com.amazonaws.services.chime.model.UpdateRoomMembershipResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roomMembership
RoomMembership roomMembership

 The room membership details.
 








Class com.amazonaws.services.chime.model.UpdateRoomRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


roomId
String roomId

 The room ID.
 


name
String name

 The room name.
 








Class com.amazonaws.services.chime.model.UpdateRoomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


room
Room room

 The room details.
 








Class com.amazonaws.services.chime.model.UpdateUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


userId
String userId

 The user ID.
 


licenseType
String licenseType

 The user license type to update. This must be a supported license type for the Amazon Chime account that the user
 belongs to.
 


userType
String userType

 The user type.
 


alexaForBusinessMetadata
AlexaForBusinessMetadata alexaForBusinessMetadata

 The Alexa for Business metadata.
 








Class com.amazonaws.services.chime.model.UpdateUserRequestItem extends Object implements Serializable


Serialized Fields


userId
String userId

 The user ID.
 


licenseType
String licenseType

 The user license type.
 


userType
String userType

 The user type.
 


alexaForBusinessMetadata
AlexaForBusinessMetadata alexaForBusinessMetadata

 The Alexa for Business metadata.
 








Class com.amazonaws.services.chime.model.UpdateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


user
User user

 The updated user details.
 








Class com.amazonaws.services.chime.model.UpdateUserSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The Amazon Chime account ID.
 


userId
String userId

 The user ID.
 


userSettings
UserSettings userSettings

 The user settings to update.
 








Class com.amazonaws.services.chime.model.UpdateUserSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.chime.model.UpdateVoiceConnectorGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorGroupId
String voiceConnectorGroupId

 The Amazon Chime Voice Connector group ID.
 


name
String name

 The name of the Amazon Chime Voice Connector group.
 


voiceConnectorItems
List<E> voiceConnectorItems

 The VoiceConnectorItems to associate with the group.
 








Class com.amazonaws.services.chime.model.UpdateVoiceConnectorGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


voiceConnectorGroup
VoiceConnectorGroup voiceConnectorGroup

 The updated Amazon Chime Voice Connector group details.
 








Class com.amazonaws.services.chime.model.UpdateVoiceConnectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 


name
String name

 The name of the Amazon Chime Voice Connector.
 


requireEncryption
Boolean requireEncryption

 When enabled, requires encryption for the Amazon Chime Voice Connector.
 








Class com.amazonaws.services.chime.model.UpdateVoiceConnectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


voiceConnector
VoiceConnector voiceConnector

 The updated Amazon Chime Voice Connector details.
 








Class com.amazonaws.services.chime.model.User extends Object implements Serializable


Serialized Fields


userId
String userId

 The user ID.
 


accountId
String accountId

 The Amazon Chime account ID.
 


primaryEmail
String primaryEmail

 The primary email address of the user.
 


primaryProvisionedNumber
String primaryProvisionedNumber

 The primary phone number associated with the user.
 


displayName
String displayName

 The display name of the user.
 


licenseType
String licenseType

 The license type for the user.
 


userType
String userType

 The user type.
 


userRegistrationStatus
String userRegistrationStatus

 The user registration status.
 


userInvitationStatus
String userInvitationStatus

 The user invite status.
 


registeredOn
Date registeredOn

 Date and time when the user is registered, in ISO 8601 format.
 


invitedOn
Date invitedOn

 Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.
 


alexaForBusinessMetadata
AlexaForBusinessMetadata alexaForBusinessMetadata

 The Alexa for Business metadata.
 


personalPIN
String personalPIN

 The user's personal meeting PIN.
 








Class com.amazonaws.services.chime.model.UserError extends Object implements Serializable


Serialized Fields


userId
String userId

 The user ID for which the action failed.
 


errorCode
String errorCode

 The error code.
 


errorMessage
String errorMessage

 The error message.
 








Class com.amazonaws.services.chime.model.UserSettings extends Object implements Serializable


Serialized Fields


telephony
TelephonySettings telephony

 The telephony settings associated with the user.
 








Class com.amazonaws.services.chime.model.VoiceConnector extends Object implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 


awsRegion
String awsRegion

 The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.
 


name
String name

 The name of the Amazon Chime Voice Connector.
 


outboundHostName
String outboundHostName

 The outbound host name for the Amazon Chime Voice Connector.
 


requireEncryption
Boolean requireEncryption

 Designates whether encryption is required for the Amazon Chime Voice Connector.
 


createdTimestamp
Date createdTimestamp

 The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
 


updatedTimestamp
Date updatedTimestamp

 The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
 








Class com.amazonaws.services.chime.model.VoiceConnectorGroup extends Object implements Serializable


Serialized Fields


voiceConnectorGroupId
String voiceConnectorGroupId

 The Amazon Chime Voice Connector group ID.
 


name
String name

 The name of the Amazon Chime Voice Connector group.
 


voiceConnectorItems
List<E> voiceConnectorItems

 The Amazon Chime Voice Connectors to which to route inbound calls.
 


createdTimestamp
Date createdTimestamp

 The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.
 


updatedTimestamp
Date updatedTimestamp

 The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.
 








Class com.amazonaws.services.chime.model.VoiceConnectorItem extends Object implements Serializable


Serialized Fields


voiceConnectorId
String voiceConnectorId

 The Amazon Chime Voice Connector ID.
 


priority
Integer priority

 The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority
 Amazon Chime Voice Connectors are attempted first.
 








Class com.amazonaws.services.chime.model.VoiceConnectorSettings extends Object implements Serializable


Serialized Fields


cdrBucket
String cdrBucket

 The Amazon S3 bucket designated for call detail record storage.
 








Package com.amazonaws.services.cloud9.model




Class com.amazonaws.services.cloud9.model.AWSCloud9Exception extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloud9.model.BadRequestException extends AWSCloud9Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloud9.model.ConflictException extends AWSCloud9Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloud9.model.CreateEnvironmentEC2Request extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the environment to create.
 
 
 This name is visible to other AWS IAM users in the same AWS account.
 


description
String description

 The description of the environment to create.
 


clientRequestToken
String clientRequestToken

 A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time.
 
 
 For more information, see Client Tokens in
 the Amazon EC2 API Reference.
 


instanceType
String instanceType

 The type of instance to connect to the environment (for example, t2.micro).
 


subnetId
String subnetId

 The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.
 


automaticStopTimeMinutes
Integer automaticStopTimeMinutes

 The number of minutes until the running instance is shut down after the environment has last been used.
 


ownerArn
String ownerArn

 The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If
 this value is not specified, the ARN defaults to this environment's creator.
 








Class com.amazonaws.services.cloud9.model.CreateEnvironmentEC2Result extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the environment that was created.
 








Class com.amazonaws.services.cloud9.model.CreateEnvironmentMembershipRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the environment that contains the environment member you want to add.
 


userArn
String userArn

 The Amazon Resource Name (ARN) of the environment member you want to add.
 


permissions
String permissions

 The type of environment member permissions you want to associate with this environment member. Available values
 include:
 
 
 
 
 read-only: Has read-only access to the environment.
 
 
 
 
 read-write: Has read-write access to the environment.
 
 
 








Class com.amazonaws.services.cloud9.model.CreateEnvironmentMembershipResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


membership
EnvironmentMember membership

 Information about the environment member that was added.
 








Class com.amazonaws.services.cloud9.model.DeleteEnvironmentMembershipRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the environment to delete the environment member from.
 


userArn
String userArn

 The Amazon Resource Name (ARN) of the environment member to delete from the environment.
 








Class com.amazonaws.services.cloud9.model.DeleteEnvironmentMembershipResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloud9.model.DeleteEnvironmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the environment to delete.
 








Class com.amazonaws.services.cloud9.model.DeleteEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloud9.model.DescribeEnvironmentMembershipsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userArn
String userArn

 The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is
 specified, information about all environment members are returned.
 


environmentId
String environmentId

 The ID of the environment to get environment member information about.
 


permissions
List<E> permissions

 The type of environment member permissions to get information about. Available values include:
 
 
 
 
 owner: Owns the environment.
 
 
 
 
 read-only: Has read-only access to the environment.
 
 
 
 
 read-write: Has read-write access to the environment.
 
 
 
 
 If no value is specified, information about all environment members are returned.
 


nextToken
String nextToken

 During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along
 with a unique string called a next token. To get the next batch of items in the list, call this operation
 again, adding the next token to the call. To get all of the items in the list, keep calling this operation with
 each subsequent next token that is returned, until no more next tokens are returned.
 


maxResults
Integer maxResults

 The maximum number of environment members to get information about.
 








Class com.amazonaws.services.cloud9.model.DescribeEnvironmentMembershipsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


memberships
List<E> memberships

 Information about the environment members for the environment.
 


nextToken
String nextToken

 If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string
 called a next token. To get the next batch of items in the list, call this operation again, adding the
 next token to the call.
 








Class com.amazonaws.services.cloud9.model.DescribeEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentIds
List<E> environmentIds

 The IDs of individual environments to get information about.
 








Class com.amazonaws.services.cloud9.model.DescribeEnvironmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


environments
List<E> environments

 Information about the environments that are returned.
 








Class com.amazonaws.services.cloud9.model.DescribeEnvironmentStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the environment to get status information about.
 








Class com.amazonaws.services.cloud9.model.DescribeEnvironmentStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The status of the environment. Available values include:
 
 
 
 
 connecting: The environment is connecting.
 
 
 
 
 creating: The environment is being created.
 
 
 
 
 deleting: The environment is being deleted.
 
 
 
 
 error: The environment is in an error state.
 
 
 
 
 ready: The environment is ready.
 
 
 
 
 stopped: The environment is stopped.
 
 
 
 
 stopping: The environment is stopping.
 
 
 


message
String message

 Any informational message about the status of the environment.
 








Class com.amazonaws.services.cloud9.model.Environment extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the environment.
 


name
String name

 The name of the environment.
 


description
String description

 The description for the environment.
 


type
String type

 The type of environment. Valid values include the following:
 
 
 
 
 ec2: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.
 
 
 
 
 ssh: Your own server connects to the environment.
 
 
 


arn
String arn

 The Amazon Resource Name (ARN) of the environment.
 


ownerArn
String ownerArn

 The Amazon Resource Name (ARN) of the environment owner.
 


lifecycle
EnvironmentLifecycle lifecycle

 The state of the environment in its creation or deletion lifecycle.
 








Class com.amazonaws.services.cloud9.model.EnvironmentLifecycle extends Object implements Serializable


Serialized Fields


status
String status

 The current creation or deletion lifecycle state of the environment.
 
 
 
 
 CREATING: The environment is in the process of being created.
 
 
 
 
 CREATED: The environment was successfully created.
 
 
 
 
 CREATE_FAILED: The environment failed to be created.
 
 
 
 
 DELETING: The environment is in the process of being deleted.
 
 
 
 
 DELETE_FAILED: The environment failed to delete.
 
 
 


reason
String reason

 Any informational message about the lifecycle state of the environment.
 


failureResource
String failureResource

 If the environment failed to delete, the Amazon Resource Name (ARN) of the related AWS resource.
 








Class com.amazonaws.services.cloud9.model.EnvironmentMember extends Object implements Serializable


Serialized Fields


permissions
String permissions

 The type of environment member permissions associated with this environment member. Available values include:
 
 
 
 
 owner: Owns the environment.
 
 
 
 
 read-only: Has read-only access to the environment.
 
 
 
 
 read-write: Has read-write access to the environment.
 
 
 


userId
String userId

 The user ID in AWS Identity and Access Management (AWS IAM) of the environment member.
 


userArn
String userArn

 The Amazon Resource Name (ARN) of the environment member.
 


environmentId
String environmentId

 The ID of the environment for the environment member.
 


lastAccess
Date lastAccess

 The time, expressed in epoch time format, when the environment member last opened the environment.
 








Class com.amazonaws.services.cloud9.model.ForbiddenException extends AWSCloud9Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloud9.model.InternalServerErrorException extends AWSCloud9Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloud9.model.LimitExceededException extends AWSCloud9Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloud9.model.ListEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along
 with a unique string called a next token. To get the next batch of items in the list, call this operation
 again, adding the next token to the call. To get all of the items in the list, keep calling this operation with
 each subsequent next token that is returned, until no more next tokens are returned.
 


maxResults
Integer maxResults

 The maximum number of environments to get identifiers for.
 








Class com.amazonaws.services.cloud9.model.ListEnvironmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string
 called a next token. To get the next batch of items in the list, call this operation again, adding the
 next token to the call.
 


environmentIds
List<E> environmentIds

 The list of environment identifiers.
 








Class com.amazonaws.services.cloud9.model.NotFoundException extends AWSCloud9Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloud9.model.TooManyRequestsException extends AWSCloud9Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloud9.model.UpdateEnvironmentMembershipRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the environment for the environment member whose settings you want to change.
 


userArn
String userArn

 The Amazon Resource Name (ARN) of the environment member whose settings you want to change.
 


permissions
String permissions

 The replacement type of environment member permissions you want to associate with this environment member.
 Available values include:
 
 
 
 
 read-only: Has read-only access to the environment.
 
 
 
 
 read-write: Has read-write access to the environment.
 
 
 








Class com.amazonaws.services.cloud9.model.UpdateEnvironmentMembershipResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


membership
EnvironmentMember membership

 Information about the environment member whose settings were changed.
 








Class com.amazonaws.services.cloud9.model.UpdateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the environment to change settings.
 


name
String name

 A replacement name for the environment.
 


description
String description

 Any new or replacement description for the environment.
 








Class com.amazonaws.services.cloud9.model.UpdateEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.clouddirectory.model




Class com.amazonaws.services.clouddirectory.model.AccessDeniedException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.AddFacetToObjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more
 information, see arns.
 


schemaFacet
SchemaFacet schemaFacet

 Identifiers for the facet that you are adding to the object. See SchemaFacet for details.
 


objectAttributeList
List<E> objectAttributeList

 Attributes on the facet that you are adding to the object.
 


objectReference
ObjectReference objectReference

 A reference to the object you are adding the specified facet to.
 








Class com.amazonaws.services.clouddirectory.model.AddFacetToObjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.AmazonCloudDirectoryException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.ApplySchemaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


publishedSchemaArn
String publishedSchemaArn

 Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see arns.
 


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory into which the schema is copied. For
 more information, see arns.
 








Class com.amazonaws.services.clouddirectory.model.ApplySchemaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appliedSchemaArn
String appliedSchemaArn

 The applied schema ARN that is associated with the copied schema in the Directory. You can use this ARN to
 describe the schema information applied on this directory. For more information, see arns.
 


directoryArn
String directoryArn

 The ARN that is associated with the Directory. For more information, see arns.
 








Class com.amazonaws.services.clouddirectory.model.AttachObjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more
 information, see arns.
 


parentReference
ObjectReference parentReference

 The parent object reference.
 


childReference
ObjectReference childReference

 The child object reference to be attached to the object.
 


linkName
String linkName

 The link name with which the child object is attached to the parent.
 








Class com.amazonaws.services.clouddirectory.model.AttachObjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attachedObjectIdentifier
String attachedObjectIdentifier

 The attached ObjectIdentifier, which is the child ObjectIdentifier.
 








Class com.amazonaws.services.clouddirectory.model.AttachPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more
 information, see arns.
 


policyReference
ObjectReference policyReference

 The reference that is associated with the policy object.
 


objectReference
ObjectReference objectReference

 The reference that identifies the object to which the policy will be attached.
 








Class com.amazonaws.services.clouddirectory.model.AttachPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.AttachToIndexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) of the directory where the object and index exist.
 


indexReference
ObjectReference indexReference

 A reference to the index that you are attaching the object to.
 


targetReference
ObjectReference targetReference

 A reference to the object that you are attaching to the index.
 








Class com.amazonaws.services.clouddirectory.model.AttachToIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attachedObjectIdentifier
String attachedObjectIdentifier

 The ObjectIdentifier of the object that was attached to the index.
 








Class com.amazonaws.services.clouddirectory.model.AttachTypedLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.
 


sourceObjectReference
ObjectReference sourceObjectReference

 Identifies the source object that the typed link will attach to.
 


targetObjectReference
ObjectReference targetObjectReference

 Identifies the target object that the typed link will attach to.
 


typedLinkFacet
TypedLinkSchemaAndFacetName typedLinkFacet

 Identifies the typed link facet that is associated with the typed link.
 


attributes
List<E> attributes

 A set of attributes that are associated with the typed link.
 








Class com.amazonaws.services.clouddirectory.model.AttachTypedLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


typedLinkSpecifier
TypedLinkSpecifier typedLinkSpecifier

 Returns a typed link specifier as output.
 








Class com.amazonaws.services.clouddirectory.model.AttributeKey extends Object implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.
 


facetName
String facetName

 The name of the facet that the attribute exists within.
 


name
String name

 The name of the attribute.
 








Class com.amazonaws.services.clouddirectory.model.AttributeKeyAndValue extends Object implements Serializable


Serialized Fields


key
AttributeKey key

 The key of the attribute.
 


value
TypedAttributeValue value

 The value of the attribute.
 








Class com.amazonaws.services.clouddirectory.model.AttributeNameAndValue extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 The attribute name of the typed link.
 


value
TypedAttributeValue value

 The value for the typed link.
 








Class com.amazonaws.services.clouddirectory.model.BatchAddFacetToObject extends Object implements Serializable


Serialized Fields


schemaFacet
SchemaFacet schemaFacet

 Represents the facet being added to the object.
 


objectAttributeList
List<E> objectAttributeList

 The attributes to set on the object.
 


objectReference
ObjectReference objectReference

 A reference to the object being mutated.
 








Class com.amazonaws.services.clouddirectory.model.BatchAddFacetToObjectResponse extends Object implements Serializable




Class com.amazonaws.services.clouddirectory.model.BatchAttachObject extends Object implements Serializable


Serialized Fields


parentReference
ObjectReference parentReference

 The parent object reference.
 


childReference
ObjectReference childReference

 The child object reference that is to be attached to the object.
 


linkName
String linkName

 The name of the link.
 








Class com.amazonaws.services.clouddirectory.model.BatchAttachObjectResponse extends Object implements Serializable


Serialized Fields


attachedObjectIdentifier
String attachedObjectIdentifier

 The ObjectIdentifier of the object that has been attached.
 








Class com.amazonaws.services.clouddirectory.model.BatchAttachPolicy extends Object implements Serializable


Serialized Fields


policyReference
ObjectReference policyReference

 The reference that is associated with the policy object.
 


objectReference
ObjectReference objectReference

 The reference that identifies the object to which the policy will be attached.
 








Class com.amazonaws.services.clouddirectory.model.BatchAttachPolicyResponse extends Object implements Serializable




Class com.amazonaws.services.clouddirectory.model.BatchAttachToIndex extends Object implements Serializable


Serialized Fields


indexReference
ObjectReference indexReference

 A reference to the index that you are attaching the object to.
 


targetReference
ObjectReference targetReference

 A reference to the object that you are attaching to the index.
 








Class com.amazonaws.services.clouddirectory.model.BatchAttachToIndexResponse extends Object implements Serializable


Serialized Fields


attachedObjectIdentifier
String attachedObjectIdentifier

 The ObjectIdentifier of the object that was attached to the index.
 








Class com.amazonaws.services.clouddirectory.model.BatchAttachTypedLink extends Object implements Serializable


Serialized Fields


sourceObjectReference
ObjectReference sourceObjectReference

 Identifies the source object that the typed link will attach to.
 


targetObjectReference
ObjectReference targetObjectReference

 Identifies the target object that the typed link will attach to.
 


typedLinkFacet
TypedLinkSchemaAndFacetName typedLinkFacet

 Identifies the typed link facet that is associated with the typed link.
 


attributes
List<E> attributes

 A set of attributes that are associated with the typed link.
 








Class com.amazonaws.services.clouddirectory.model.BatchAttachTypedLinkResponse extends Object implements Serializable


Serialized Fields


typedLinkSpecifier
TypedLinkSpecifier typedLinkSpecifier

 Returns a typed link specifier as output.
 








Class com.amazonaws.services.clouddirectory.model.BatchCreateIndex extends Object implements Serializable


Serialized Fields


orderedIndexedAttributeList
List<E> orderedIndexedAttributeList

 Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
 


isUnique
Boolean isUnique

 Indicates whether the attribute that is being indexed has unique values or not.
 


parentReference
ObjectReference parentReference

 A reference to the parent object that contains the index object.
 


linkName
String linkName

 The name of the link between the parent object and the index object.
 


batchReferenceName
String batchReferenceName

 The batch reference name. See Transaction
 Support for more information.
 








Class com.amazonaws.services.clouddirectory.model.BatchCreateIndexResponse extends Object implements Serializable


Serialized Fields


objectIdentifier
String objectIdentifier

 The ObjectIdentifier of the index created by this operation.
 








Class com.amazonaws.services.clouddirectory.model.BatchCreateObject extends Object implements Serializable


Serialized Fields


schemaFacet
List<E> schemaFacet

 A list of FacetArns that will be associated with the object. For more information, see arns.
 


objectAttributeList
List<E> objectAttributeList

 An attribute map, which contains an attribute ARN as the key and attribute value as the map value.
 


parentReference
ObjectReference parentReference

 If specified, the parent reference to which this object will be attached.
 


linkName
String linkName

 The name of the link.
 


batchReferenceName
String batchReferenceName

 The batch reference name. See Transaction
 Support for more information.
 








Class com.amazonaws.services.clouddirectory.model.BatchCreateObjectResponse extends Object implements Serializable


Serialized Fields


objectIdentifier
String objectIdentifier

 The ID that is associated with the object.
 








Class com.amazonaws.services.clouddirectory.model.BatchDeleteObject extends Object implements Serializable


Serialized Fields


objectReference
ObjectReference objectReference

 The reference that identifies the object.
 








Class com.amazonaws.services.clouddirectory.model.BatchDeleteObjectResponse extends Object implements Serializable




Class com.amazonaws.services.clouddirectory.model.BatchDetachFromIndex extends Object implements Serializable


Serialized Fields


indexReference
ObjectReference indexReference

 A reference to the index object.
 


targetReference
ObjectReference targetReference

 A reference to the object being detached from the index.
 








Class com.amazonaws.services.clouddirectory.model.BatchDetachFromIndexResponse extends Object implements Serializable


Serialized Fields


detachedObjectIdentifier
String detachedObjectIdentifier

 The ObjectIdentifier of the object that was detached from the index.
 








Class com.amazonaws.services.clouddirectory.model.BatchDetachObject extends Object implements Serializable


Serialized Fields


parentReference
ObjectReference parentReference

 Parent reference from which the object with the specified link name is detached.
 


linkName
String linkName

 The name of the link.
 


batchReferenceName
String batchReferenceName

 The batch reference name. See Transaction
 Support for more information.
 








Class com.amazonaws.services.clouddirectory.model.BatchDetachObjectResponse extends Object implements Serializable


Serialized Fields


detachedObjectIdentifier
String detachedObjectIdentifier

 The ObjectIdentifier of the detached object.
 








Class com.amazonaws.services.clouddirectory.model.BatchDetachPolicy extends Object implements Serializable


Serialized Fields


policyReference
ObjectReference policyReference

 Reference that identifies the policy object.
 


objectReference
ObjectReference objectReference

 Reference that identifies the object whose policy object will be detached.
 








Class com.amazonaws.services.clouddirectory.model.BatchDetachPolicyResponse extends Object implements Serializable




Class com.amazonaws.services.clouddirectory.model.BatchDetachTypedLink extends Object implements Serializable


Serialized Fields


typedLinkSpecifier
TypedLinkSpecifier typedLinkSpecifier

 Used to accept a typed link specifier as input.
 








Class com.amazonaws.services.clouddirectory.model.BatchDetachTypedLinkResponse extends Object implements Serializable




Class com.amazonaws.services.clouddirectory.model.BatchGetLinkAttributes extends Object implements Serializable


Serialized Fields


typedLinkSpecifier
TypedLinkSpecifier typedLinkSpecifier

 Allows a typed link specifier to be accepted as input.
 


attributeNames
List<E> attributeNames

 A list of attribute names whose values will be retrieved.
 








Class com.amazonaws.services.clouddirectory.model.BatchGetLinkAttributesResponse extends Object implements Serializable


Serialized Fields


attributes
List<E> attributes

 The attributes that are associated with the typed link.
 








Class com.amazonaws.services.clouddirectory.model.BatchGetObjectAttributes extends Object implements Serializable


Serialized Fields


objectReference
ObjectReference objectReference

 Reference that identifies the object whose attributes will be retrieved.
 


schemaFacet
SchemaFacet schemaFacet

 Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.
 


attributeNames
List<E> attributeNames

 List of attribute names whose values will be retrieved.
 








Class com.amazonaws.services.clouddirectory.model.BatchGetObjectAttributesResponse extends Object implements Serializable


Serialized Fields


attributes
List<E> attributes

 The attribute values that are associated with an object.
 








Class com.amazonaws.services.clouddirectory.model.BatchGetObjectInformation extends Object implements Serializable


Serialized Fields


objectReference
ObjectReference objectReference

 A reference to the object.
 








Class com.amazonaws.services.clouddirectory.model.BatchGetObjectInformationResponse extends Object implements Serializable


Serialized Fields


schemaFacets
List<E> schemaFacets

 The facets attached to the specified object.
 


objectIdentifier
String objectIdentifier

 The ObjectIdentifier of the specified object.
 








Class com.amazonaws.services.clouddirectory.model.BatchListAttachedIndices extends Object implements Serializable


Serialized Fields


targetReference
ObjectReference targetReference

 A reference to the object that has indices attached.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.BatchListAttachedIndicesResponse extends Object implements Serializable


Serialized Fields


indexAttachments
List<E> indexAttachments

 The indices attached to the specified object.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.BatchListIncomingTypedLinks extends Object implements Serializable


Serialized Fields


objectReference
ObjectReference objectReference

 The reference that identifies the object whose attributes will be listed.
 


filterAttributeRanges
List<E> filterAttributeRanges

 Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges
 must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire
 range.
 


filterTypedLink
TypedLinkSchemaAndFacetName filterTypedLink

 Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are
 supplied to any API calls.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.BatchListIncomingTypedLinksResponse extends Object implements Serializable


Serialized Fields


linkSpecifiers
List<E> linkSpecifiers

 Returns one or more typed link specifiers as output.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.BatchListIndex extends Object implements Serializable


Serialized Fields


rangesOnIndexedValues
List<E> rangesOnIndexedValues

 Specifies the ranges of indexed values that you want to query.
 


indexReference
ObjectReference indexReference

 The reference to the index to list.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.BatchListIndexResponse extends Object implements Serializable


Serialized Fields


indexAttachments
List<E> indexAttachments

 The objects and indexed values attached to the index.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.BatchListObjectAttributes extends Object implements Serializable


Serialized Fields


objectReference
ObjectReference objectReference

 Reference of the object whose attributes need to be listed.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of items to be retrieved in a single call. This is an approximate number.
 


facetFilter
SchemaFacet facetFilter

 Used to filter the list of object attributes that are associated with a certain facet.
 








Class com.amazonaws.services.clouddirectory.model.BatchListObjectAttributesResponse extends Object implements Serializable


Serialized Fields


attributes
List<E> attributes

 The attributes map that is associated with the object. AttributeArn is the key; attribute value is
 the value.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.BatchListObjectChildren extends Object implements Serializable


Serialized Fields


objectReference
ObjectReference objectReference

 Reference of the object for which child objects are being listed.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 Maximum number of items to be retrieved in a single call. This is an approximate number.
 








Class com.amazonaws.services.clouddirectory.model.BatchListObjectChildrenResponse extends Object implements Serializable


Serialized Fields


children
Map<K,V> children

 The children structure, which is a map with the key as the LinkName and
 ObjectIdentifier as the value.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.BatchListObjectParentPaths extends Object implements Serializable


Serialized Fields


objectReference
ObjectReference objectReference

 The reference that identifies the object whose attributes will be listed.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.BatchListObjectParentPathsResponse extends Object implements Serializable


Serialized Fields


pathToObjectIdentifiersList
List<E> pathToObjectIdentifiersList

 Returns the path to the ObjectIdentifiers that are associated with the directory.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.BatchListObjectParents extends Object implements Serializable


Serialized Fields


objectReference
ObjectReference objectReference


nextToken
String nextToken


maxResults
Integer maxResults








Class com.amazonaws.services.clouddirectory.model.BatchListObjectParentsResponse extends Object implements Serializable


Serialized Fields


parentLinks
List<E> parentLinks


nextToken
String nextToken








Class com.amazonaws.services.clouddirectory.model.BatchListObjectPolicies extends Object implements Serializable


Serialized Fields


objectReference
ObjectReference objectReference

 The reference that identifies the object whose attributes will be listed.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.BatchListObjectPoliciesResponse extends Object implements Serializable


Serialized Fields


attachedPolicyIds
List<E> attachedPolicyIds

 A list of policy ObjectIdentifiers, that are attached to the object.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.BatchListOutgoingTypedLinks extends Object implements Serializable


Serialized Fields


objectReference
ObjectReference objectReference

 The reference that identifies the object whose attributes will be listed.
 


filterAttributeRanges
List<E> filterAttributeRanges

 Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges
 must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire
 range.
 


filterTypedLink
TypedLinkSchemaAndFacetName filterTypedLink

 Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are
 supplied to any API calls.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.BatchListOutgoingTypedLinksResponse extends Object implements Serializable


Serialized Fields


typedLinkSpecifiers
List<E> typedLinkSpecifiers

 Returns a typed link specifier as output.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.BatchListPolicyAttachments extends Object implements Serializable


Serialized Fields


policyReference
ObjectReference policyReference

 The reference that identifies the policy object.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.BatchListPolicyAttachmentsResponse extends Object implements Serializable


Serialized Fields


objectIdentifiers
List<E> objectIdentifiers

 A list of ObjectIdentifiers to which the policy is attached.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.BatchLookupPolicy extends Object implements Serializable


Serialized Fields


objectReference
ObjectReference objectReference

 Reference that identifies the object whose policies will be looked up.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.BatchLookupPolicyResponse extends Object implements Serializable


Serialized Fields


policyToPathList
List<E> policyToPathList

 Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and
 PolicyType. For more information, see Policies.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.BatchReadException extends Object implements Serializable


Serialized Fields


type
String type

 A type of exception, such as InvalidArnException.
 


message
String message

 An exception message that is associated with the failure.
 








Class com.amazonaws.services.clouddirectory.model.BatchReadOperation extends Object implements Serializable


Serialized Fields


listObjectAttributes
BatchListObjectAttributes listObjectAttributes

 Lists all attributes that are associated with an object.
 


listObjectChildren
BatchListObjectChildren listObjectChildren

 Returns a paginated list of child objects that are associated with a given object.
 


listAttachedIndices
BatchListAttachedIndices listAttachedIndices

 Lists indices attached to an object.
 


listObjectParentPaths
BatchListObjectParentPaths listObjectParentPaths

 Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node
 objects. For more information about objects, see Directory Structure.
 


getObjectInformation
BatchGetObjectInformation getObjectInformation

 Retrieves metadata about an object.
 


getObjectAttributes
BatchGetObjectAttributes getObjectAttributes

 Retrieves attributes within a facet that are associated with an object.
 


listObjectParents
BatchListObjectParents listObjectParents


listObjectPolicies
BatchListObjectPolicies listObjectPolicies

 Returns policies attached to an object in pagination fashion.
 


listPolicyAttachments
BatchListPolicyAttachments listPolicyAttachments

 Returns all of the ObjectIdentifiers to which a given policy is attached.
 


lookupPolicy
BatchLookupPolicy lookupPolicy

 Lists all policies from the root of the Directory to the object specified. If there are no policies
 present, an empty list is returned. If policies are present, and if some objects don't have the policies
 attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns
 ObjectIdentifier, policyId, and policyType. Paths that don't lead to the
 root from the target object are ignored. For more information, see Policies.
 


listIndex
BatchListIndex listIndex

 Lists objects attached to the specified index.
 


listOutgoingTypedLinks
BatchListOutgoingTypedLinks listOutgoingTypedLinks

 Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also
 supports filtering by typed link facet and identity attributes. For more information, see Typed Links.
 


listIncomingTypedLinks
BatchListIncomingTypedLinks listIncomingTypedLinks

 Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also
 supports filtering by typed link facet and identity attributes. For more information, see Typed Links.
 


getLinkAttributes
BatchGetLinkAttributes getLinkAttributes

 Retrieves attributes that are associated with a typed link.
 








Class com.amazonaws.services.clouddirectory.model.BatchReadOperationResponse extends Object implements Serializable


Serialized Fields


successfulResponse
BatchReadSuccessfulResponse successfulResponse

 Identifies which operation in a batch has succeeded.
 


exceptionResponse
BatchReadException exceptionResponse

 Identifies which operation in a batch has failed.
 








Class com.amazonaws.services.clouddirectory.model.BatchReadRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see
 arns.
 


operations
List<E> operations

 A list of operations that are part of the batch.
 


consistencyLevel
String consistencyLevel

 Represents the manner and timing in which the successful write or update of an object is reflected in a
 subsequent read operation of that same object.
 








Class com.amazonaws.services.clouddirectory.model.BatchReadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


responses
List<E> responses

 A list of all the responses for each batch read.
 








Class com.amazonaws.services.clouddirectory.model.BatchReadSuccessfulResponse extends Object implements Serializable


Serialized Fields


listObjectAttributes
BatchListObjectAttributesResponse listObjectAttributes

 Lists all attributes that are associated with an object.
 


listObjectChildren
BatchListObjectChildrenResponse listObjectChildren

 Returns a paginated list of child objects that are associated with a given object.
 


getObjectInformation
BatchGetObjectInformationResponse getObjectInformation

 Retrieves metadata about an object.
 


getObjectAttributes
BatchGetObjectAttributesResponse getObjectAttributes

 Retrieves attributes within a facet that are associated with an object.
 


listAttachedIndices
BatchListAttachedIndicesResponse listAttachedIndices

 Lists indices attached to an object.
 


listObjectParentPaths
BatchListObjectParentPathsResponse listObjectParentPaths

 Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node
 objects. For more information about objects, see Directory Structure.
 


listObjectPolicies
BatchListObjectPoliciesResponse listObjectPolicies

 Returns policies attached to an object in pagination fashion.
 


listPolicyAttachments
BatchListPolicyAttachmentsResponse listPolicyAttachments

 Returns all of the ObjectIdentifiers to which a given policy is attached.
 


lookupPolicy
BatchLookupPolicyResponse lookupPolicy

 Lists all policies from the root of the Directory to the object specified. If there are no policies
 present, an empty list is returned. If policies are present, and if some objects don't have the policies
 attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns
 ObjectIdentifier, policyId, and policyType. Paths that don't lead to the
 root from the target object are ignored. For more information, see Policies.
 


listIndex
BatchListIndexResponse listIndex

 Lists objects attached to the specified index.
 


listOutgoingTypedLinks
BatchListOutgoingTypedLinksResponse listOutgoingTypedLinks

 Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also
 supports filtering by typed link facet and identity attributes. For more information, see Typed Links.
 


listIncomingTypedLinks
BatchListIncomingTypedLinksResponse listIncomingTypedLinks

 Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also
 supports filtering by typed link facet and identity attributes. For more information, see Typed Links.
 


getLinkAttributes
BatchGetLinkAttributesResponse getLinkAttributes

 The list of attributes to retrieve from the typed link.
 


listObjectParents
BatchListObjectParentsResponse listObjectParents








Class com.amazonaws.services.clouddirectory.model.BatchRemoveFacetFromObject extends Object implements Serializable


Serialized Fields


schemaFacet
SchemaFacet schemaFacet

 The facet to remove from the object.
 


objectReference
ObjectReference objectReference

 A reference to the object whose facet will be removed.
 








Class com.amazonaws.services.clouddirectory.model.BatchRemoveFacetFromObjectResponse extends Object implements Serializable




Class com.amazonaws.services.clouddirectory.model.BatchUpdateLinkAttributes extends Object implements Serializable


Serialized Fields


typedLinkSpecifier
TypedLinkSpecifier typedLinkSpecifier

 Allows a typed link specifier to be accepted as input.
 


attributeUpdates
List<E> attributeUpdates

 The attributes update structure.
 








Class com.amazonaws.services.clouddirectory.model.BatchUpdateLinkAttributesResponse extends Object implements Serializable




Class com.amazonaws.services.clouddirectory.model.BatchUpdateObjectAttributes extends Object implements Serializable


Serialized Fields


objectReference
ObjectReference objectReference

 Reference that identifies the object.
 


attributeUpdates
List<E> attributeUpdates

 Attributes update structure.
 








Class com.amazonaws.services.clouddirectory.model.BatchUpdateObjectAttributesResponse extends Object implements Serializable


Serialized Fields


objectIdentifier
String objectIdentifier

 ID that is associated with the object.
 








Class com.amazonaws.services.clouddirectory.model.BatchWriteException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L



Serialized Fields


index
Integer index


type
String type








Class com.amazonaws.services.clouddirectory.model.BatchWriteOperation extends Object implements Serializable


Serialized Fields


createObject
BatchCreateObject createObject

 Creates an object.
 


attachObject
BatchAttachObject attachObject

 Attaches an object to a Directory.
 


detachObject
BatchDetachObject detachObject

 Detaches an object from a Directory.
 


updateObjectAttributes
BatchUpdateObjectAttributes updateObjectAttributes

 Updates a given object's attributes.
 


deleteObject
BatchDeleteObject deleteObject

 Deletes an object in a Directory.
 


addFacetToObject
BatchAddFacetToObject addFacetToObject

 A batch operation that adds a facet to an object.
 


removeFacetFromObject
BatchRemoveFacetFromObject removeFacetFromObject

 A batch operation that removes a facet from an object.
 


attachPolicy
BatchAttachPolicy attachPolicy

 Attaches a policy object to a regular object. An object can have a limited number of attached policies.
 


detachPolicy
BatchDetachPolicy detachPolicy

 Detaches a policy from a Directory.
 


createIndex
BatchCreateIndex createIndex

 Creates an index object. See Indexing and
 search for more information.
 


attachToIndex
BatchAttachToIndex attachToIndex

 Attaches the specified object to the specified index.
 


detachFromIndex
BatchDetachFromIndex detachFromIndex

 Detaches the specified object from the specified index.
 


attachTypedLink
BatchAttachTypedLink attachTypedLink

 Attaches a typed link to a specified source and target object. For more information, see Typed Links.
 


detachTypedLink
BatchDetachTypedLink detachTypedLink

 Detaches a typed link from a specified source and target object. For more information, see Typed Links.
 


updateLinkAttributes
BatchUpdateLinkAttributes updateLinkAttributes

 Updates a given object's attributes.
 








Class com.amazonaws.services.clouddirectory.model.BatchWriteOperationResponse extends Object implements Serializable


Serialized Fields


createObject
BatchCreateObjectResponse createObject

 Creates an object in a Directory.
 


attachObject
BatchAttachObjectResponse attachObject

 Attaches an object to a Directory.
 


detachObject
BatchDetachObjectResponse detachObject

 Detaches an object from a Directory.
 


updateObjectAttributes
BatchUpdateObjectAttributesResponse updateObjectAttributes

 Updates a given object’s attributes.
 


deleteObject
BatchDeleteObjectResponse deleteObject

 Deletes an object in a Directory.
 


addFacetToObject
BatchAddFacetToObjectResponse addFacetToObject

 The result of an add facet to object batch operation.
 


removeFacetFromObject
BatchRemoveFacetFromObjectResponse removeFacetFromObject

 The result of a batch remove facet from object operation.
 


attachPolicy
BatchAttachPolicyResponse attachPolicy

 Attaches a policy object to a regular object. An object can have a limited number of attached policies.
 


detachPolicy
BatchDetachPolicyResponse detachPolicy

 Detaches a policy from a Directory.
 


createIndex
BatchCreateIndexResponse createIndex

 Creates an index object. See Indexing and
 search for more information.
 


attachToIndex
BatchAttachToIndexResponse attachToIndex

 Attaches the specified object to the specified index.
 


detachFromIndex
BatchDetachFromIndexResponse detachFromIndex

 Detaches the specified object from the specified index.
 


attachTypedLink
BatchAttachTypedLinkResponse attachTypedLink

 Attaches a typed link to a specified source and target object. For more information, see Typed Links.
 


detachTypedLink
BatchDetachTypedLinkResponse detachTypedLink

 Detaches a typed link from a specified source and target object. For more information, see Typed Links.
 


updateLinkAttributes
BatchUpdateLinkAttributesResponse updateLinkAttributes

 Represents the output of a BatchWrite response operation.
 








Class com.amazonaws.services.clouddirectory.model.BatchWriteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see
 arns.
 


operations
List<E> operations

 A list of operations that are part of the batch.
 








Class com.amazonaws.services.clouddirectory.model.BatchWriteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


responses
List<E> responses

 A list of all the responses for each batch write.
 








Class com.amazonaws.services.clouddirectory.model.CannotListParentOfRootException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.CreateDirectoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the Directory. Should be unique per account, per region.
 


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For
 more information, see arns.
 








Class com.amazonaws.services.clouddirectory.model.CreateDirectoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN that is associated with the Directory. For more information, see arns.
 


name
String name

 The name of the Directory.
 


objectIdentifier
String objectIdentifier

 The root object node of the created directory.
 


appliedSchemaArn
String appliedSchemaArn

 The ARN of the published schema in the Directory. Once a published schema is copied into the directory, it
 has its own ARN, which is referred to applied schema ARN. For more information, see arns.
 








Class com.amazonaws.services.clouddirectory.model.CreateFacetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The schema ARN in which the new Facet will be created. For more information, see arns.
 


name
String name

 The name of the Facet, which is unique for a given schema.
 


attributes
List<E> attributes

 The attributes that are associated with the Facet.
 


objectType
String objectType

 Specifies whether a given object created from this facet is of type node, leaf node, policy or index.
 
 
 
 
 Node: Can have multiple children but one parent.
 
 
 
 
 
 
 Leaf node: Cannot have children but can have multiple parents.
 
 
 
 
 
 
 Policy: Allows you to store a policy document and policy type. For more information, see Policies.
 
 
 
 
 
 
 Index: Can be created with the Index API.
 
 
 


facetStyle
String facetStyle

 There are two different styles that you can define on any given facet, Static and
 Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets,
 attributes can be defined during data plane operations.
 








Class com.amazonaws.services.clouddirectory.model.CreateFacetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.CreateIndexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the directory where the index should be created.
 


orderedIndexedAttributeList
List<E> orderedIndexedAttributeList

 Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
 


isUnique
Boolean isUnique

 Indicates whether the attribute that is being indexed has unique values or not.
 


parentReference
ObjectReference parentReference

 A reference to the parent object that contains the index object.
 


linkName
String linkName

 The name of the link between the parent object and the index object.
 








Class com.amazonaws.services.clouddirectory.model.CreateIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


objectIdentifier
String objectIdentifier

 The ObjectIdentifier of the index created by this operation.
 








Class com.amazonaws.services.clouddirectory.model.CreateObjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created.
 For more information, see arns.
 


schemaFacets
List<E> schemaFacets

 A list of schema facets to be associated with the object. Do not provide minor version components. See
 SchemaFacet for details.
 


objectAttributeList
List<E> objectAttributeList

 The attribute map whose attribute ARN contains the key and attribute value as the map value.
 


parentReference
ObjectReference parentReference

 If specified, the parent reference to which this object will be attached.
 


linkName
String linkName

 The name of link that is used to attach this object to a parent.
 








Class com.amazonaws.services.clouddirectory.model.CreateObjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


objectIdentifier
String objectIdentifier

 The identifier that is associated with the object.
 








Class com.amazonaws.services.clouddirectory.model.CreateSchemaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name that is associated with the schema. This is unique to each account and in each region.
 








Class com.amazonaws.services.clouddirectory.model.CreateSchemaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
 








Class com.amazonaws.services.clouddirectory.model.CreateTypedLinkFacetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
 


facet
TypedLinkFacet facet

 Facet structure that is associated with the typed link facet.
 








Class com.amazonaws.services.clouddirectory.model.CreateTypedLinkFacetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.DeleteDirectoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the directory to delete.
 








Class com.amazonaws.services.clouddirectory.model.DeleteDirectoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the deleted directory.
 








Class com.amazonaws.services.clouddirectory.model.DeleteFacetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.
 


name
String name

 The name of the facet to delete.
 








Class com.amazonaws.services.clouddirectory.model.DeleteFacetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.DeleteObjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more
 information, see arns.
 


objectReference
ObjectReference objectReference

 A reference that identifies the object.
 








Class com.amazonaws.services.clouddirectory.model.DeleteObjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.DeleteSchemaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) of the development schema. For more information, see arns.
 








Class com.amazonaws.services.clouddirectory.model.DeleteSchemaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The input ARN that is returned as part of the response. For more information, see arns.
 








Class com.amazonaws.services.clouddirectory.model.DeleteTypedLinkFacetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
 


name
String name

 The unique name of the typed link facet.
 








Class com.amazonaws.services.clouddirectory.model.DeleteTypedLinkFacetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.DetachFromIndexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) of the directory the index and object exist in.
 


indexReference
ObjectReference indexReference

 A reference to the index object.
 


targetReference
ObjectReference targetReference

 A reference to the object being detached from the index.
 








Class com.amazonaws.services.clouddirectory.model.DetachFromIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detachedObjectIdentifier
String detachedObjectIdentifier

 The ObjectIdentifier of the object that was detached from the index.
 








Class com.amazonaws.services.clouddirectory.model.DetachObjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more
 information, see arns.
 


parentReference
ObjectReference parentReference

 The parent reference from which the object with the specified link name is detached.
 


linkName
String linkName

 The link name associated with the object that needs to be detached.
 








Class com.amazonaws.services.clouddirectory.model.DetachObjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detachedObjectIdentifier
String detachedObjectIdentifier

 The ObjectIdentifier that was detached from the object.
 








Class com.amazonaws.services.clouddirectory.model.DetachPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more
 information, see arns.
 


policyReference
ObjectReference policyReference

 Reference that identifies the policy object.
 


objectReference
ObjectReference objectReference

 Reference that identifies the object whose policy object will be detached.
 








Class com.amazonaws.services.clouddirectory.model.DetachPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.DetachTypedLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.
 


typedLinkSpecifier
TypedLinkSpecifier typedLinkSpecifier

 Used to accept a typed link specifier as input.
 








Class com.amazonaws.services.clouddirectory.model.DetachTypedLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.Directory extends Object implements Serializable


Serialized Fields


name
String name

 The name of the directory.
 


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the directory. For more information, see arns.
 


state
String state

 The state of the directory. Can be either Enabled, Disabled, or Deleted.
 


creationDateTime
Date creationDateTime

 The date and time when the directory was created.
 








Class com.amazonaws.services.clouddirectory.model.DirectoryAlreadyExistsException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.DirectoryDeletedException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.DirectoryNotDisabledException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.DirectoryNotEnabledException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.DisableDirectoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the directory to disable.
 








Class com.amazonaws.services.clouddirectory.model.DisableDirectoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the directory that has been disabled.
 








Class com.amazonaws.services.clouddirectory.model.EnableDirectoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the directory to enable.
 








Class com.amazonaws.services.clouddirectory.model.EnableDirectoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the enabled directory.
 








Class com.amazonaws.services.clouddirectory.model.Facet extends Object implements Serializable


Serialized Fields


name
String name

 The name of the Facet.
 


objectType
String objectType

 The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.
 


facetStyle
String facetStyle

 There are two different styles that you can define on any given facet, Static and
 Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets,
 attributes can be defined during data plane operations.
 








Class com.amazonaws.services.clouddirectory.model.FacetAlreadyExistsException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.FacetAttribute extends Object implements Serializable


Serialized Fields


name
String name

 The name of the facet attribute.
 


attributeDefinition
FacetAttributeDefinition attributeDefinition

 A facet attribute consists of either a definition or a reference. This structure contains the attribute
 definition. See Attribute References for more information.
 


attributeReference
FacetAttributeReference attributeReference

 An attribute reference that is associated with the attribute. See Attribute References for more information.
 


requiredBehavior
String requiredBehavior

 The required behavior of the FacetAttribute.
 








Class com.amazonaws.services.clouddirectory.model.FacetAttributeDefinition extends Object implements Serializable


Serialized Fields


type
String type

 The type of the attribute.
 


defaultValue
TypedAttributeValue defaultValue

 The default value of the attribute (if configured).
 


isImmutable
Boolean isImmutable

 Whether the attribute is mutable or not.
 


rules
Map<K,V> rules

 Validation rules attached to the attribute definition.
 








Class com.amazonaws.services.clouddirectory.model.FacetAttributeReference extends Object implements Serializable


Serialized Fields


targetFacetName
String targetFacetName

 The target facet name that is associated with the facet reference. See Attribute References for more information.
 


targetAttributeName
String targetAttributeName

 The target attribute name that is associated with the facet reference. See Attribute References for more information.
 








Class com.amazonaws.services.clouddirectory.model.FacetAttributeUpdate extends Object implements Serializable


Serialized Fields


attribute
FacetAttribute attribute

 The attribute to update.
 


action
String action

 The action to perform when updating the attribute.
 








Class com.amazonaws.services.clouddirectory.model.FacetInUseException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.FacetNotFoundException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.FacetValidationException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.GetAppliedSchemaVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The ARN of the applied schema.
 








Class com.amazonaws.services.clouddirectory.model.GetAppliedSchemaVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appliedSchemaArn
String appliedSchemaArn

 Current applied schema ARN, including the minor version in use if one was provided.
 








Class com.amazonaws.services.clouddirectory.model.GetDirectoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the directory.
 








Class com.amazonaws.services.clouddirectory.model.GetDirectoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directory
Directory directory

 Metadata about the directory.
 








Class com.amazonaws.services.clouddirectory.model.GetFacetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.
 


name
String name

 The name of the facet to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.GetFacetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


facet
Facet facet

 The Facet structure that is associated with the facet.
 








Class com.amazonaws.services.clouddirectory.model.GetLinkAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more
 information, see arns or Typed Links.
 


typedLinkSpecifier
TypedLinkSpecifier typedLinkSpecifier

 Allows a typed link specifier to be accepted as input.
 


attributeNames
List<E> attributeNames

 A list of attribute names whose values will be retrieved.
 


consistencyLevel
String consistencyLevel

 The consistency level at which to retrieve the attributes on a typed link.
 








Class com.amazonaws.services.clouddirectory.model.GetLinkAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
List<E> attributes

 The attributes that are associated with the typed link.
 








Class com.amazonaws.services.clouddirectory.model.GetObjectAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where the object resides.
 


objectReference
ObjectReference objectReference

 Reference that identifies the object whose attributes will be retrieved.
 


consistencyLevel
String consistencyLevel

 The consistency level at which to retrieve the attributes on an object.
 


schemaFacet
SchemaFacet schemaFacet

 Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.
 


attributeNames
List<E> attributeNames

 List of attribute names whose values will be retrieved.
 








Class com.amazonaws.services.clouddirectory.model.GetObjectAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
List<E> attributes

 The attributes that are associated with the object.
 








Class com.amazonaws.services.clouddirectory.model.GetObjectInformationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the directory being retrieved.
 


objectReference
ObjectReference objectReference

 A reference to the object.
 


consistencyLevel
String consistencyLevel

 The consistency level at which to retrieve the object information.
 








Class com.amazonaws.services.clouddirectory.model.GetObjectInformationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


schemaFacets
List<E> schemaFacets

 The facets attached to the specified object. Although the response does not include minor version information,
 the most recently applied minor version of each Facet is in effect. See GetAppliedSchemaVersion for
 details.
 


objectIdentifier
String objectIdentifier

 The ObjectIdentifier of the specified object.
 








Class com.amazonaws.services.clouddirectory.model.GetSchemaAsJsonRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The ARN of the schema to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.GetSchemaAsJsonResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the retrieved schema.
 


document
String document

 The JSON representation of the schema document.
 








Class com.amazonaws.services.clouddirectory.model.GetTypedLinkFacetInformationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
 


name
String name

 The unique name of the typed link facet.
 








Class com.amazonaws.services.clouddirectory.model.GetTypedLinkFacetInformationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityAttributeOrder
List<E> identityAttributeOrder

 The order of identity attributes for the facet, from most significant to least significant. The ability to filter
 typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to
 typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range
 specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the
 typed link facet, not the order in which they are supplied to any API calls. For more information about identity
 attributes, see Typed Links.
 








Class com.amazonaws.services.clouddirectory.model.IncompatibleSchemaException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.IndexAttachment extends Object implements Serializable


Serialized Fields


indexedAttributes
List<E> indexedAttributes

 The indexed attribute values.
 


objectIdentifier
String objectIdentifier

 In response to ListIndex, the ObjectIdentifier of the object attached to the index. In
 response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object.
 This field will always contain the ObjectIdentifier of the object on the opposite side of the
 attachment specified in the query.
 








Class com.amazonaws.services.clouddirectory.model.IndexedAttributeMissingException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.InternalServiceException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.InvalidArnException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.InvalidAttachmentException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.InvalidFacetUpdateException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.InvalidNextTokenException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.InvalidRuleException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.InvalidSchemaDocException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.InvalidTaggingRequestException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.LimitExceededException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.LinkAttributeAction extends Object implements Serializable


Serialized Fields


attributeActionType
String attributeActionType

 A type that can be either UPDATE_OR_CREATE or DELETE.
 


attributeUpdateValue
TypedAttributeValue attributeUpdateValue

 The value that you want to update to.
 








Class com.amazonaws.services.clouddirectory.model.LinkAttributeUpdate extends Object implements Serializable


Serialized Fields


attributeKey
AttributeKey attributeKey

 The key of the attribute being updated.
 


attributeAction
LinkAttributeAction attributeAction

 The action to perform as part of the attribute update.
 








Class com.amazonaws.services.clouddirectory.model.LinkNameAlreadyInUseException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.ListAppliedSchemaArnsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the directory you are listing.
 


schemaArn
String schemaArn

 The response for ListAppliedSchemaArns when this parameter is used will list all minor version ARNs
 for a major version.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.ListAppliedSchemaArnsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


schemaArns
List<E> schemaArns

 The ARNs of schemas that are applied to the directory.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListAttachedIndicesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the directory.
 


targetReference
ObjectReference targetReference

 A reference to the object that has indices attached.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 


consistencyLevel
String consistencyLevel

 The consistency level to use for this operation.
 








Class com.amazonaws.services.clouddirectory.model.ListAttachedIndicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


indexAttachments
List<E> indexAttachments

 The indices attached to the specified object.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.ListDevelopmentSchemaArnsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


schemaArns
List<E> schemaArns

 The ARNs of retrieved development schemas.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListDirectoriesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 


state
String state

 The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.
 








Class com.amazonaws.services.clouddirectory.model.ListDirectoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directories
List<E> directories

 Lists all directories that are associated with your account in pagination fashion.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListFacetAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The ARN of the schema where the facet resides.
 


name
String name

 The name of the facet whose attributes will be retrieved.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.ListFacetAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
List<E> attributes

 The attributes attached to the facet.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListFacetNamesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) to retrieve facet names from.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.ListFacetNamesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


facetNames
List<E> facetNames

 The names of facets that exist within the schema.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListIncomingTypedLinksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) of the directory where you want to list the typed links.
 


objectReference
ObjectReference objectReference

 Reference that identifies the object whose attributes will be listed.
 


filterAttributeRanges
List<E> filterAttributeRanges

 Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges
 must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire
 range.
 


filterTypedLink
TypedLinkSchemaAndFacetName filterTypedLink

 Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are
 supplied to any API calls.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 


consistencyLevel
String consistencyLevel

 The consistency level to execute the request at.
 








Class com.amazonaws.services.clouddirectory.model.ListIncomingTypedLinksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


linkSpecifiers
List<E> linkSpecifiers

 Returns one or more typed link specifiers as output.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListIndexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the directory that the index exists in.
 


rangesOnIndexedValues
List<E> rangesOnIndexedValues

 Specifies the ranges of indexed values that you want to query.
 


indexReference
ObjectReference indexReference

 The reference to the index to list.
 


maxResults
Integer maxResults

 The maximum number of objects in a single page to retrieve from the index during a request. For more information,
 see Amazon Cloud Directory
 Limits.
 


nextToken
String nextToken

 The pagination token.
 


consistencyLevel
String consistencyLevel

 The consistency level to execute the request at.
 








Class com.amazonaws.services.clouddirectory.model.ListIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


indexAttachments
List<E> indexAttachments

 The objects and indexed values attached to the index.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListManagedSchemaArnsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The response for ListManagedSchemaArns. When this parameter is used, all minor version ARNs for a major version
 are listed.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.ListManagedSchemaArnsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


schemaArns
List<E> schemaArns

 The ARNs for all AWS managed schemas.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListObjectAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more
 information, see arns.
 


objectReference
ObjectReference objectReference

 The reference that identifies the object whose attributes will be listed.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of items to be retrieved in a single call. This is an approximate number.
 


consistencyLevel
String consistencyLevel

 Represents the manner and timing in which the successful write or update of an object is reflected in a
 subsequent read operation of that same object.
 


facetFilter
SchemaFacet facetFilter

 Used to filter the list of object attributes that are associated with a certain facet.
 








Class com.amazonaws.services.clouddirectory.model.ListObjectAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
List<E> attributes

 Attributes map that is associated with the object. AttributeArn is the key, and attribute value is
 the value.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListObjectChildrenRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more
 information, see arns.
 


objectReference
ObjectReference objectReference

 The reference that identifies the object for which child objects are being listed.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of items to be retrieved in a single call. This is an approximate number.
 


consistencyLevel
String consistencyLevel

 Represents the manner and timing in which the successful write or update of an object is reflected in a
 subsequent read operation of that same object.
 








Class com.amazonaws.services.clouddirectory.model.ListObjectChildrenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


children
Map<K,V> children

 Children structure, which is a map with key as the LinkName and ObjectIdentifier as the
 value.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListObjectParentPathsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the directory to which the parent path applies.
 


objectReference
ObjectReference objectReference

 The reference that identifies the object whose parent paths are listed.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of items to be retrieved in a single call. This is an approximate number.
 








Class com.amazonaws.services.clouddirectory.model.ListObjectParentPathsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pathToObjectIdentifiersList
List<E> pathToObjectIdentifiersList

 Returns the path to the ObjectIdentifiers that are associated with the directory.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListObjectParentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more
 information, see arns.
 


objectReference
ObjectReference objectReference

 The reference that identifies the object for which parent objects are being listed.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of items to be retrieved in a single call. This is an approximate number.
 


consistencyLevel
String consistencyLevel

 Represents the manner and timing in which the successful write or update of an object is reflected in a
 subsequent read operation of that same object.
 


includeAllLinksToEachParent
Boolean includeAllLinksToEachParent

 When set to True, returns all ListObjectParentsResponse$ParentLinks. There could be multiple links between
 a parent-child pair.
 








Class com.amazonaws.services.clouddirectory.model.ListObjectParentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


parents
Map<K,V> parents

 The parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.
 


nextToken
String nextToken

 The pagination token.
 


parentLinks
List<E> parentLinks

 Returns a list of parent reference and LinkName Tuples.
 








Class com.amazonaws.services.clouddirectory.model.ListObjectPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more
 information, see arns.
 


objectReference
ObjectReference objectReference

 Reference that identifies the object for which policies will be listed.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of items to be retrieved in a single call. This is an approximate number.
 


consistencyLevel
String consistencyLevel

 Represents the manner and timing in which the successful write or update of an object is reflected in a
 subsequent read operation of that same object.
 








Class com.amazonaws.services.clouddirectory.model.ListObjectPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attachedPolicyIds
List<E> attachedPolicyIds

 A list of policy ObjectIdentifiers, that are attached to the object.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListOutgoingTypedLinksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) of the directory where you want to list the typed links.
 


objectReference
ObjectReference objectReference

 A reference that identifies the object whose attributes will be listed.
 


filterAttributeRanges
List<E> filterAttributeRanges

 Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges
 must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire
 range.
 


filterTypedLink
TypedLinkSchemaAndFacetName filterTypedLink

 Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are
 supplied to any API calls.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 


consistencyLevel
String consistencyLevel

 The consistency level to execute the request at.
 








Class com.amazonaws.services.clouddirectory.model.ListOutgoingTypedLinksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


typedLinkSpecifiers
List<E> typedLinkSpecifiers

 Returns a typed link specifier as output.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListPolicyAttachmentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more
 information, see arns.
 


policyReference
ObjectReference policyReference

 The reference that identifies the policy object.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of items to be retrieved in a single call. This is an approximate number.
 


consistencyLevel
String consistencyLevel

 Represents the manner and timing in which the successful write or update of an object is reflected in a
 subsequent read operation of that same object.
 








Class com.amazonaws.services.clouddirectory.model.ListPolicyAttachmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


objectIdentifiers
List<E> objectIdentifiers

 A list of ObjectIdentifiers to which the policy is attached.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListPublishedSchemaArnsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The response for ListPublishedSchemaArns when this parameter is used will list all minor version
 ARNs for a major version.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.ListPublishedSchemaArnsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


schemaArns
List<E> schemaArns

 The ARNs of published schemas.
 


nextToken
String nextToken

 The pagination token.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.
 


nextToken
String nextToken

 The pagination token. This is for future use. Currently pagination is not supported for tagging.
 


maxResults
Integer maxResults

 The MaxResults parameter sets the maximum number of results returned in a single page. This is for
 future use and is not supported currently.
 








Class com.amazonaws.services.clouddirectory.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 A list of tag key value pairs that are associated with the response.
 


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.clouddirectory.model.ListTypedLinkFacetAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
 


name
String name

 The unique name of the typed link facet.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.ListTypedLinkFacetAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
List<E> attributes

 An ordered set of attributes associate with the typed link.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.ListTypedLinkFacetNamesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
 


nextToken
String nextToken

 The pagination token.
 


maxResults
Integer maxResults

 The maximum number of results to retrieve.
 








Class com.amazonaws.services.clouddirectory.model.ListTypedLinkFacetNamesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


facetNames
List<E> facetNames

 The names of typed link facets that exist within the schema.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.LookupPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see
 arns.
 


objectReference
ObjectReference objectReference

 Reference that identifies the object whose policies will be looked up.
 


nextToken
String nextToken

 The token to request the next page of results.
 


maxResults
Integer maxResults

 The maximum number of items to be retrieved in a single call. This is an approximate number.
 








Class com.amazonaws.services.clouddirectory.model.LookupPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyToPathList
List<E> policyToPathList

 Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and
 PolicyType. For more information, see Policies.
 


nextToken
String nextToken

 The pagination token.
 








Class com.amazonaws.services.clouddirectory.model.NotIndexException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.NotNodeException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.NotPolicyException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.ObjectAlreadyDetachedException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.ObjectAttributeAction extends Object implements Serializable


Serialized Fields


objectAttributeActionType
String objectAttributeActionType

 A type that can be either Update or Delete.
 


objectAttributeUpdateValue
TypedAttributeValue objectAttributeUpdateValue

 The value that you want to update to.
 








Class com.amazonaws.services.clouddirectory.model.ObjectAttributeRange extends Object implements Serializable


Serialized Fields


attributeKey
AttributeKey attributeKey

 The key of the attribute that the attribute range covers.
 


range
TypedAttributeValueRange range

 The range of attribute values being selected.
 








Class com.amazonaws.services.clouddirectory.model.ObjectAttributeUpdate extends Object implements Serializable


Serialized Fields


objectAttributeKey
AttributeKey objectAttributeKey

 The key of the attribute being updated.
 


objectAttributeAction
ObjectAttributeAction objectAttributeAction

 The action to perform as part of the attribute update.
 








Class com.amazonaws.services.clouddirectory.model.ObjectIdentifierAndLinkNameTuple extends Object implements Serializable


Serialized Fields


objectIdentifier
String objectIdentifier

 The ID that is associated with the object.
 


linkName
String linkName

 The name of the link between the parent and the child object.
 








Class com.amazonaws.services.clouddirectory.model.ObjectNotDetachedException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.ObjectReference extends Object implements Serializable


Serialized Fields


selector
String selector

 A path selector supports easy selection of an object by the parent/child links leading to it from the directory
 root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/)
 and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:
 
 
 
 
 $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When
 creating objects, the system will provide you with the identifier of the created object. An object’s identifier
 is immutable and no two objects will ever share the same object identifier
 
 
 
 
 /some/path - Identifies the object based on path
 
 
 
 
 #SomeBatchReference - Identifies the object in a batch call
 
 
 








Class com.amazonaws.services.clouddirectory.model.PathToObjectIdentifiers extends Object implements Serializable


Serialized Fields


path
String path

 The path that is used to identify the object starting from directory root.
 


objectIdentifiers
List<E> objectIdentifiers

 Lists ObjectIdentifiers starting from directory root to the object in the request.
 








Class com.amazonaws.services.clouddirectory.model.PolicyAttachment extends Object implements Serializable


Serialized Fields


policyId
String policyId

 The ID of PolicyAttachment.
 


objectIdentifier
String objectIdentifier

 The ObjectIdentifier that is associated with PolicyAttachment.
 


policyType
String policyType

 The type of policy that can be associated with PolicyAttachment.
 








Class com.amazonaws.services.clouddirectory.model.PolicyToPath extends Object implements Serializable


Serialized Fields


path
String path

 The path that is referenced from the root.
 


policies
List<E> policies

 List of policy objects.
 








Class com.amazonaws.services.clouddirectory.model.PublishSchemaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


developmentSchemaArn
String developmentSchemaArn

 The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see
 arns.
 


version
String version

 The major version under which the schema will be published. Schemas have both a major and minor version
 associated with them.
 


minorVersion
String minorVersion

 The minor version under which the schema will be published. This parameter is recommended. Schemas have both a
 major and minor version associated with them.
 


name
String name

 The new name under which the schema will be published. If this is not provided, the development schema is
 considered.
 








Class com.amazonaws.services.clouddirectory.model.PublishSchemaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


publishedSchemaArn
String publishedSchemaArn

 The ARN that is associated with the published schema. For more information, see arns.
 








Class com.amazonaws.services.clouddirectory.model.PutSchemaFromJsonRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The ARN of the schema to update.
 


document
String document

 The replacement JSON schema.
 








Class com.amazonaws.services.clouddirectory.model.PutSchemaFromJsonResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN of the schema to update.
 








Class com.amazonaws.services.clouddirectory.model.RemoveFacetFromObjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The ARN of the directory in which the object resides.
 


schemaFacet
SchemaFacet schemaFacet

 The facet to remove. See SchemaFacet for details.
 


objectReference
ObjectReference objectReference

 A reference to the object to remove the facet from.
 








Class com.amazonaws.services.clouddirectory.model.RemoveFacetFromObjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.ResourceNotFoundException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.RetryableConflictException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.Rule extends Object implements Serializable


Serialized Fields


type
String type

 The type of attribute validation rule.
 


parameters
Map<K,V> parameters

 The minimum and maximum parameters that are associated with the rule.
 








Class com.amazonaws.services.clouddirectory.model.SchemaAlreadyExistsException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.SchemaAlreadyPublishedException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.SchemaFacet extends Object implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions.
 


facetName
String facetName

 The name of the facet.
 








Class com.amazonaws.services.clouddirectory.model.StillContainsLinksException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key that is associated with the tag.
 


value
String value

 The value that is associated with the tag.
 








Class com.amazonaws.services.clouddirectory.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.
 


tags
List<E> tags

 A list of tag key-value pairs.
 








Class com.amazonaws.services.clouddirectory.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.TypedAttributeValue extends Object implements Serializable


Serialized Fields


stringValue
String stringValue

 A string data value.
 


binaryValue
ByteBuffer binaryValue

 A binary data value.
 


booleanValue
Boolean booleanValue

 A Boolean data value.
 


numberValue
String numberValue

 A number data value.
 


datetimeValue
Date datetimeValue

 A date and time value.
 








Class com.amazonaws.services.clouddirectory.model.TypedAttributeValueRange extends Object implements Serializable


Serialized Fields


startMode
String startMode

 The inclusive or exclusive range start.
 


startValue
TypedAttributeValue startValue

 The value to start the range at.
 


endMode
String endMode

 The inclusive or exclusive range end.
 


endValue
TypedAttributeValue endValue

 The attribute value to terminate the range at.
 








Class com.amazonaws.services.clouddirectory.model.TypedLinkAttributeDefinition extends Object implements Serializable


Serialized Fields


name
String name

 The unique name of the typed link attribute.
 


type
String type

 The type of the attribute.
 


defaultValue
TypedAttributeValue defaultValue

 The default value of the attribute (if configured).
 


isImmutable
Boolean isImmutable

 Whether the attribute is mutable or not.
 


rules
Map<K,V> rules

 Validation rules that are attached to the attribute definition.
 


requiredBehavior
String requiredBehavior

 The required behavior of the TypedLinkAttributeDefinition.
 








Class com.amazonaws.services.clouddirectory.model.TypedLinkAttributeRange extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 The unique name of the typed link attribute.
 


range
TypedAttributeValueRange range

 The range of attribute values that are being selected.
 








Class com.amazonaws.services.clouddirectory.model.TypedLinkFacet extends Object implements Serializable


Serialized Fields


name
String name

 The unique name of the typed link facet.
 


attributes
List<E> attributes

 A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values
 that are related to the link itself, and not to one of the two objects being linked. Identity attributes also
 serve to distinguish the link from others of the same type between the same objects.
 


identityAttributeOrder
List<E> identityAttributeOrder

 The set of attributes that distinguish links made from this facet from each other, in the order of significance.
 Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and
 ListIncomingTypedLinks for details.
 








Class com.amazonaws.services.clouddirectory.model.TypedLinkFacetAttributeUpdate extends Object implements Serializable


Serialized Fields


attribute
TypedLinkAttributeDefinition attribute

 The attribute to update.
 


action
String action

 The action to perform when updating the attribute.
 








Class com.amazonaws.services.clouddirectory.model.TypedLinkSchemaAndFacetName extends Object implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
 


typedLinkName
String typedLinkName

 The unique name of the typed link facet.
 








Class com.amazonaws.services.clouddirectory.model.TypedLinkSpecifier extends Object implements Serializable


Serialized Fields


typedLinkFacet
TypedLinkSchemaAndFacetName typedLinkFacet

 Identifies the typed link facet that is associated with the typed link.
 


sourceObjectReference
ObjectReference sourceObjectReference

 Identifies the source object that the typed link will attach to.
 


targetObjectReference
ObjectReference targetObjectReference

 Identifies the target object that the typed link will attach to.
 


identityAttributeValues
List<E> identityAttributeValues

 Identifies the attribute value to update.
 








Class com.amazonaws.services.clouddirectory.model.UnsupportedIndexTypeException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.clouddirectory.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.
 


tagKeys
List<E> tagKeys

 Keys of the tag that need to be removed from the resource.
 








Class com.amazonaws.services.clouddirectory.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.UpdateFacetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.
 


name
String name

 The name of the facet.
 


attributeUpdates
List<E> attributeUpdates

 List of attributes that need to be updated in a given schema Facet. Each attribute is followed by
 AttributeAction, which specifies the type of update operation to perform.
 


objectType
String objectType

 The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.
 








Class com.amazonaws.services.clouddirectory.model.UpdateFacetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.UpdateLinkAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For
 more information, see arns or Typed Links.
 


typedLinkSpecifier
TypedLinkSpecifier typedLinkSpecifier

 Allows a typed link specifier to be accepted as input.
 


attributeUpdates
List<E> attributeUpdates

 The attributes update structure.
 








Class com.amazonaws.services.clouddirectory.model.UpdateLinkAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.UpdateObjectAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryArn
String directoryArn

 The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more
 information, see arns.
 


objectReference
ObjectReference objectReference

 The reference that identifies the object.
 


attributeUpdates
List<E> attributeUpdates

 The attributes update structure.
 








Class com.amazonaws.services.clouddirectory.model.UpdateObjectAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


objectIdentifier
String objectIdentifier

 The ObjectIdentifier of the updated object.
 








Class com.amazonaws.services.clouddirectory.model.UpdateSchemaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) of the development schema. For more information, see arns.
 


name
String name

 The name of the schema.
 








Class com.amazonaws.services.clouddirectory.model.UpdateSchemaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The ARN that is associated with the updated schema. For more information, see arns.
 








Class com.amazonaws.services.clouddirectory.model.UpdateTypedLinkFacetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
 


name
String name

 The unique name of the typed link facet.
 


attributeUpdates
List<E> attributeUpdates

 Attributes update structure.
 


identityAttributeOrder
List<E> identityAttributeOrder

 The order of identity attributes for the facet, from most significant to least significant. The ability to filter
 typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to
 a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range
 specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the
 typed link facet, not the order in which they are supplied to any API calls. For more information about identity
 attributes, see Typed Links.
 








Class com.amazonaws.services.clouddirectory.model.UpdateTypedLinkFacetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.clouddirectory.model.UpgradeAppliedSchemaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


publishedSchemaArn
String publishedSchemaArn

 The revision of the published schema to upgrade the directory to.
 


directoryArn
String directoryArn

 The ARN for the directory to which the upgraded schema will be applied.
 


dryRun
Boolean dryRun

 Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails,
 an exception would be thrown else the call would succeed but no changes will be saved. This parameter is
 optional.
 








Class com.amazonaws.services.clouddirectory.model.UpgradeAppliedSchemaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


upgradedSchemaArn
String upgradedSchemaArn

 The ARN of the upgraded schema that is returned as part of the response.
 


directoryArn
String directoryArn

 The ARN of the directory that is returned as part of the response.
 








Class com.amazonaws.services.clouddirectory.model.UpgradePublishedSchemaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


developmentSchemaArn
String developmentSchemaArn

 The ARN of the development schema with the changes used for the upgrade.
 


publishedSchemaArn
String publishedSchemaArn

 The ARN of the published schema to be upgraded.
 


minorVersion
String minorVersion

 Identifies the minor version of the published schema that will be created. This parameter is NOT optional.
 


dryRun
Boolean dryRun

 Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema
 provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call
 would succeed. This parameter is optional and defaults to false.
 








Class com.amazonaws.services.clouddirectory.model.UpgradePublishedSchemaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


upgradedSchemaArn
String upgradedSchemaArn

 The ARN of the upgraded schema that is returned as part of the response.
 








Class com.amazonaws.services.clouddirectory.model.ValidationException extends AmazonCloudDirectoryException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.cloudformation.model




Class com.amazonaws.services.cloudformation.model.AccountGateResult extends Object implements Serializable


Serialized Fields


status
String status

 The status of the account gate function.
 
 
 
 
 SUCCEEDED: The account gate function has determined that the account and region passes any
 requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that
 account and region.
 
 
 
 
 FAILED: The account gate function has determined that the account and region does not meet the
 requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that
 account and region, and sets the stack set operation result status for that account and region to
 FAILED.
 
 
 
 
 SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and
 region, for one of the following reasons:
 
 
 
 
 An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the
 stack set operation in this account and region.
 
 
 
 
 The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions
 to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.
 
 
 
 
 Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set
 operation in this account and region.
 
 
 
 
 


statusReason
String statusReason

 The reason for the account gate status assigned to this account and region for the stack set operation.
 








Class com.amazonaws.services.cloudformation.model.AccountLimit extends Object implements Serializable


Serialized Fields


name
String name

 The name of the account limit.
 
 
 Values: ConcurrentResourcesLimit | StackLimit | StackOutputsLimit
 


value
Integer value

 The value that is associated with the account limit name.
 








Class com.amazonaws.services.cloudformation.model.AlreadyExistsException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.AmazonCloudFormationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.CancelUpdateStackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or the unique stack ID that is associated with the stack.
 


clientRequestToken
String clientRequestToken

 A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry
 requests so that AWS CloudFormation knows that you're not attempting to cancel an update on a stack with the same
 name. You might retry CancelUpdateStack requests to ensure that AWS CloudFormation successfully
 received them.
 








Class com.amazonaws.services.cloudformation.model.CancelUpdateStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudformation.model.CFNRegistryException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.Change extends Object implements Serializable


Serialized Fields


type
String type

 The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource.
 


resourceChange
ResourceChange resourceChange

 A ResourceChange structure that describes the resource and action that AWS CloudFormation will
 perform.
 








Class com.amazonaws.services.cloudformation.model.ChangeSetNotFoundException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.ChangeSetSummary extends Object implements Serializable


Serialized Fields


stackId
String stackId

 The ID of the stack with which the change set is associated.
 


stackName
String stackName

 The name of the stack with which the change set is associated.
 


changeSetId
String changeSetId

 The ID of the change set.
 


changeSetName
String changeSetName

 The name of the change set.
 


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.
 


status
String status

 The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
 FAILED.
 


statusReason
String statusReason

 A description of the change set's status. For example, if your change set is in the FAILED state,
 AWS CloudFormation shows the error message.
 


creationTime
Date creationTime

 The start time when the change set was created, in UTC.
 


description
String description

 Descriptive information about the change set.
 








Class com.amazonaws.services.cloudformation.model.ContinueUpdateRollbackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or the unique ID of the stack that you want to continue rolling back.
 
 
 
 Don't specify the name of a nested stack (a stack that was created by using the
 AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack
 that contains the AWS::CloudFormation::Stack resource).
 
 


roleARN
String roleARN

 The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
 assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS
 CloudFormation always uses this role for all future operations on the stack. As long as users have permission to
 operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it.
 Ensure that the role grants least privilege.
 
 
 If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
 no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
 


resourcesToSkip
SdkInternalList<T> resourcesToSkip

 A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback
 operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback
 failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for
 example, because an update was cancelled. To check why a resource update failed, use the
 DescribeStackResources action, and view the resource status reason.
 
 
 
 Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We
 recommend that you  troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources
 to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state
 of the skipped resources will be inconsistent with the state of the resources in the stack template. Before
 performing another stack update, you must update the stack or resources to be consistent with each other. If you
 don't, subsequent stack updates might fail, and the stack will become unrecoverable.
 
 
 
 Specify the minimum number of resources required to successfully roll back your stack. For example, a failed
 resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the
 dependent resources.
 
 
 To skip resources that are part of nested stacks, use the following format:
 NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (
 Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding
 embedded stack must be in one of the following states: DELETE_IN_PROGRESS,
 DELETE_COMPLETE, or DELETE_FAILED.
 
 
 
 Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example
 of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.
 
 


clientRequestToken
String clientRequestToken

 A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry
 requests so that AWS CloudFormation knows that you're not attempting to continue the rollback to a stack with the
 same name. You might retry ContinueUpdateRollback requests to ensure that AWS CloudFormation
 successfully received them.
 








Class com.amazonaws.services.cloudformation.model.ContinueUpdateRollbackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudformation.model.CreateChangeSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the
 change set by comparing this stack's information with the information that you submit, such as a modified
 template or different parameter input values.
 


templateBody
String templateBody

 A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length
 of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the
 stack that you specified.
 
 
 Conditional: You must specify only TemplateBody or TemplateURL.
 


templateURL
String templateURL

 The location of the file that contains the revised template. The URL must point to a template (max size: 460,800
 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template
 with the stack that you specified.
 
 
 Conditional: You must specify only TemplateBody or TemplateURL.
 


usePreviousTemplate
Boolean usePreviousTemplate

 Whether to reuse the template that is associated with the stack to create the change set.
 


parameters
SdkInternalList<T> parameters

 A list of Parameter structures that specify input parameters for the change set. For more
 information, see the Parameter data type.
 


capabilities
SdkInternalList<T> capabilities

 In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
 for AWS CloudFormation to create the stack.
 
 
 
 
 CAPABILITY_IAM and CAPABILITY_NAMED_IAM
 
 
 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
 this by specifying one of these capabilities.
 
 
 The following IAM resources require you to specify either the CAPABILITY_IAM or
 CAPABILITY_NAMED_IAM capability.
 
 
 
 
 If you have IAM resources, you can specify either capability.
 
 
 
 
 If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
 
 
 
 
 If you don't specify either of these capabilities, AWS CloudFormation returns an
 InsufficientCapabilities error.
 
 
 
 
 If your stack template contains these resources, we recommend that you review all permissions associated with
 them and edit their permissions if necessary.
 
 
 
 
 
 AWS::IAM::AccessKey
 
 
 
 
 
 AWS::IAM::Group
 
 
 
 
 
 AWS::IAM::InstanceProfile
 
 
 
 
 
 AWS::IAM::Policy
 
 
 
 
 
 AWS::IAM::Role
 
 
 
 
 
 AWS::IAM::User
 
 
 
 
 
 AWS::IAM::UserToGroupAddition
 
 
 
 
 For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
 
 
 
 
 CAPABILITY_AUTO_EXPAND
 
 
 Some template contain macros. Macros perform custom processing on templates; this can include simple actions like
 find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users
 typically create a change set from the processed template, so that they can review the changes resulting from the
 macros before actually creating the stack. If your stack template contains one or more macros, and you choose to
 create a stack directly from the processed template, without first reviewing the resulting changes in a change
 set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
 
 
 
 This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.
 
 
 Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template
 that contains macros and nested stacks, you must create or update the stack directly from the template
 using the CreateStack or UpdateStack action, and specifying this capability.
 
 
 
 For more information on macros, see Using AWS
 CloudFormation Macros to Perform Custom Processing on Templates.
 
 
 


resourceTypes
SdkInternalList<T> resourceTypes

 The template resource types that you have permissions to work with if you execute this change set, such as
 AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
 
 
 If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By
 default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM)
 uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access
 with AWS Identity and Access Management in the AWS CloudFormation User Guide.
 


roleARN
String roleARN

 The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
 assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your
 behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have
 permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to
 pass it. Ensure that the role grants least privilege.
 
 
 If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
 no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
 


rollbackConfiguration
RollbackConfiguration rollbackConfiguration

 The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for
 the specified monitoring period afterwards.
 


notificationARNs
SdkInternalList<T> notificationARNs

 The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS
 CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
 


tags
SdkInternalList<T> tags

 Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the
 stack. You can specify a maximum of 50 tags.
 


changeSetName
String changeSetName

 The name of the change set. The name must be unique among all change sets that are associated with the specified
 stack.
 
 
 A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an
 alphabetic character and cannot exceed 128 characters.
 


clientToken
String clientToken

 A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry
 requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same
 name. You might retry CreateChangeSet requests to ensure that AWS CloudFormation successfully
 received them.
 


description
String description

 A description to help you identify this change set.
 


changeSetType
String changeSetType

 The type of change set operation. To create a change set for a new stack, specify CREATE. To create
 a change set for an existing stack, specify UPDATE. To create a change set for an import operation,
 specify IMPORT.
 
 
 If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no
 template or resources. The stack will be in the 
 REVIEW_IN_PROGRESS  state until you execute the change set.
 
 
 By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to
 create a change set for a new stack or the CREATE type to create a change set for an existing stack.
 


resourcesToImport
SdkInternalList<T> resourcesToImport

 The resources to import into your stack.
 








Class com.amazonaws.services.cloudformation.model.CreateChangeSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The Amazon Resource Name (ARN) of the change set.
 


stackId
String stackId

 The unique ID of the stack.
 








Class com.amazonaws.services.cloudformation.model.CreatedButModifiedException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.CreateStackInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name or unique ID of the stack set that you want to create stack instances from.
 


accounts
SdkInternalList<T> accounts

 The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.
 


regions
SdkInternalList<T> regions

 The names of one or more regions where you want to create stack instances using the specified AWS account(s).
 


parameterOverrides
SdkInternalList<T> parameterOverrides

 A list of stack set parameters whose values you want to override in the selected stack instances.
 
 
 Any overridden parameter values will be applied to all stack instances in the specified accounts and regions.
 When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during
 stack instance operations:
 
 
 
 
 To override the current value for a parameter, include the parameter and specify its value.
 
 
 
 
 To leave a parameter set to its present value, you can do one of the following:
 
 
 
 
 Do not include the parameter in the list.
 
 
 
 
 Include the parameter and specify UsePreviousValue as true. (You cannot specify both a
 value and set UsePreviousValue to true.)
 
 
 
 
 
 
 To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do
 not include any parameters.
 
 
 
 
 To leave all parameters set to their present values, do not specify this property at all.
 
 
 
 
 During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their
 overridden value.
 
 
 You can only override the parameter values that are specified in the stack set; to add or delete a
 parameter itself, use UpdateStackSet to update the stack set template.
 


operationPreferences
StackSetOperationPreferences operationPreferences

 Preferences for how AWS CloudFormation performs this stack set operation.
 


operationId
String operationId

 The unique identifier for this stack set operation.
 
 
 The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set
 operation only once, even if you retry the request multiple times. You might retry stack set operation requests
 to ensure that AWS CloudFormation successfully received them.
 
 
 If you don't specify an operation ID, the SDK generates one automatically.
 
 
 Repeating this stack set operation with a new operation ID retries all stack instances whose status is
 OUTDATED.
 








Class com.amazonaws.services.cloudformation.model.CreateStackInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operationId
String operationId

 The unique identifier for this stack set operation.
 








Class com.amazonaws.services.cloudformation.model.CreateStackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name that is associated with the stack. The name must be unique in the region in which you are creating the
 stack.
 
 
 
 A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an
 alphabetic character and cannot be longer than 128 characters.
 
 


templateBody
String templateBody

 Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
 more information, go to Template Anatomy
 in the AWS CloudFormation User Guide.
 
 
 Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
 not both.
 


templateURL
String templateURL

 Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is
 located in an Amazon S3 bucket. For more information, go to the Template Anatomy
 in the AWS CloudFormation User Guide.
 
 
 Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but
 not both.
 


parameters
SdkInternalList<T> parameters

 A list of Parameter structures that specify input parameters for the stack. For more information,
 see the Parameter data
 type.
 


disableRollback
Boolean disableRollback

 Set to true to disable rollback of the stack if stack creation failed. You can specify either
 DisableRollback or OnFailure, but not both.
 
 
 Default: false
 


rollbackConfiguration
RollbackConfiguration rollbackConfiguration

 The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for
 the specified monitoring period afterwards.
 


timeoutInMinutes
Integer timeoutInMinutes

 The amount of time that can pass before the stack status becomes CREATE_FAILED; if DisableRollback
 is not set or is set to false, the stack will be rolled back.
 


notificationARNs
SdkInternalList<T> notificationARNs

 The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic
 ARNs using the SNS console or your Command Line Interface (CLI).
 


capabilities
SdkInternalList<T> capabilities

 In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
 for AWS CloudFormation to create the stack.
 
 
 
 
 CAPABILITY_IAM and CAPABILITY_NAMED_IAM
 
 
 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
 this by specifying one of these capabilities.
 
 
 The following IAM resources require you to specify either the CAPABILITY_IAM or
 CAPABILITY_NAMED_IAM capability.
 
 
 
 
 If you have IAM resources, you can specify either capability.
 
 
 
 
 If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
 
 
 
 
 If you don't specify either of these capabilities, AWS CloudFormation returns an
 InsufficientCapabilities error.
 
 
 
 
 If your stack template contains these resources, we recommend that you review all permissions associated with
 them and edit their permissions if necessary.
 
 
 
 
 
 AWS::IAM::AccessKey
 
 
 
 
 
 AWS::IAM::Group
 
 
 
 
 
 AWS::IAM::InstanceProfile
 
 
 
 
 
 AWS::IAM::Policy
 
 
 
 
 
 AWS::IAM::Role
 
 
 
 
 
 AWS::IAM::User
 
 
 
 
 
 AWS::IAM::UserToGroupAddition
 
 
 
 
 For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
 
 
 
 
 CAPABILITY_AUTO_EXPAND
 
 
 Some template contain macros. Macros perform custom processing on templates; this can include simple actions like
 find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users
 typically create a change set from the processed template, so that they can review the changes resulting from the
 macros before actually creating the stack. If your stack template contains one or more macros, and you choose to
 create a stack directly from the processed template, without first reviewing the resulting changes in a change
 set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
 
 
 Change sets do not currently support nested stacks. If you want to create a stack from a stack template that
 contains macros and nested stacks, you must create the stack directly from the template using this
 capability.
 
 
 
 You should only create stacks directly from a stack template that contains macros if you know what processing the
 macro performs.
 
 
 Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the
 Lambda function owner can update the function operation without AWS CloudFormation being notified.
 
 
 
 For more information, see Using AWS
 CloudFormation Macros to Perform Custom Processing on Templates.
 
 
 


resourceTypes
SdkInternalList<T> resourceTypes

 The template resource types that you have permissions to work with for this create stack action, such as
 AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the
 following syntax to describe template resource types: AWS::* (for all AWS resource),
 Custom::* (for all custom resources), Custom::logical_ID  (for a specific custom
 resource), AWS::service_name::* (for all resources of a particular AWS service), and
 AWS::service_name::resource_logical_ID  (for a specific AWS resource).
 
 
 If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By
 default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM)
 uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access
 with AWS Identity and Access Management.
 


roleARN
String roleARN

 The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
 assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS
 CloudFormation always uses this role for all future operations on the stack. As long as users have permission to
 operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it.
 Ensure that the role grants least privilege.
 
 
 If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
 no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
 


onFailure
String onFailure

 Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or
 DELETE. You can specify either OnFailure or DisableRollback, but not both.
 
 
 Default: ROLLBACK
 


stackPolicyBody
String stackPolicyBody

 Structure containing the stack policy body. For more information, go to  Prevent
 Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the
 StackPolicyBody or the StackPolicyURL parameter, but not both.
 


stackPolicyURL
String stackPolicyURL

 Location of a file containing the stack policy. The URL must point to a policy (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.
 


tags
SdkInternalList<T> tags

 Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources
 created in the stack. A maximum number of 50 tags can be specified.
 


clientRequestToken
String clientRequestToken

 A unique identifier for this CreateStack request. Specify this token if you plan to retry requests
 so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry
 CreateStack requests to ensure that AWS CloudFormation successfully received them.
 
 
 All events triggered by a given stack operation are assigned the same client request token, which you can use to
 track operations. For example, if you execute a CreateStack operation with the token
 token1, then all the StackEvents generated by that operation will have
 ClientRequestToken set as token1.
 
 
 In the console, stack operations display the client request token on the Events tab. Stack operations that are
 initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
 the stack operation . For example, if you create a stack using the console, each stack event would be assigned
 the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
 


enableTerminationProtection
Boolean enableTerminationProtection

 Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with
 termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a
 Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on
 stacks by default.
 
 
 For nested
 stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
 








Class com.amazonaws.services.cloudformation.model.CreateStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackId
String stackId

 Unique identifier of the stack.
 








Class com.amazonaws.services.cloudformation.model.CreateStackSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name to associate with the stack set. The name must be unique in the region where you create your stack set.
 
 
 
 A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an
 alphabetic character and can't be longer than 128 characters.
 
 


description
String description

 A description of the stack set. You can use the description to identify the stack set's purpose or other
 important information.
 


templateBody
String templateBody

 The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200
 bytes. For more information, see 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

 The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800
 bytes) that's located in an Amazon S3 bucket. For more information, see Template Anatomy
 in the AWS CloudFormation User Guide.
 
 
 Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.
 


parameters
SdkInternalList<T> parameters

 The input parameters for the stack set template.
 


capabilities
SdkInternalList<T> capabilities

 In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in
 order for AWS CloudFormation to create the stack set and related stack instances.
 
 
 
 
 CAPABILITY_IAM and CAPABILITY_NAMED_IAM
 
 
 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 stack sets, you must explicitly
 acknowledge this by specifying one of these capabilities.
 
 
 The following IAM resources require you to specify either the CAPABILITY_IAM or
 CAPABILITY_NAMED_IAM capability.
 
 
 
 
 If you have IAM resources, you can specify either capability.
 
 
 
 
 If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
 
 
 
 
 If you don't specify either of these capabilities, AWS CloudFormation returns an
 InsufficientCapabilities error.
 
 
 
 
 If your stack template contains these resources, we recommend that you review all permissions associated with
 them and edit their permissions if necessary.
 
 
 
 
 
 AWS::IAM::AccessKey
 
 
 
 
 
 AWS::IAM::Group
 
 
 
 
 
 AWS::IAM::InstanceProfile
 
 
 
 
 
 AWS::IAM::Policy
 
 
 
 
 
 AWS::IAM::Role
 
 
 
 
 
 AWS::IAM::User
 
 
 
 
 
 AWS::IAM::UserToGroupAddition
 
 
 
 
 For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
 
 
 
 
 CAPABILITY_AUTO_EXPAND
 
 
 Some templates contain macros. If your stack template contains one or more macros, and you choose to create a
 stack directly from the processed template, without first reviewing the resulting changes in a change set, you
 must acknowledge this capability. For more information, see Using AWS
 CloudFormation Macros to Perform Custom Processing on Templates.
 
 
 
 Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this
 capability, if you include a macro in your template the stack set operation will fail.
 
 
 


tags
SdkInternalList<T> tags

 The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also
 propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be
 specified.
 
 
 If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have
 the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails
 with an access denied error, and the stack set is not created.
 


administrationRoleARN
String administrationRoleARN

 The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.
 
 
 Specify an IAM role only if you are using customized administrator roles to control which users or groups can
 manage specific stack sets within the same administrator account. For more information, see Prerequisites:
 Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.
 


executionRoleName
String executionRoleName

 The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS
 CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
 
 
 Specify an IAM role only if you are using customized execution roles to control which stack resources users and
 groups can include in their stack sets.
 


clientRequestToken
String clientRequestToken

 A unique identifier for this CreateStackSet request. Specify this token if you plan to retry
 requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same
 name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully
 received them.
 
 
 If you don't specify an operation ID, the SDK generates one automatically.
 








Class com.amazonaws.services.cloudformation.model.CreateStackSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackSetId
String stackSetId

 The ID of the stack set that you're creating.
 








Class com.amazonaws.services.cloudformation.model.DeleteChangeSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


changeSetName
String changeSetName

 The name or Amazon Resource Name (ARN) of the change set that you want to delete.
 


stackName
String stackName

 If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with
 it.
 








Class com.amazonaws.services.cloudformation.model.DeleteChangeSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudformation.model.DeleteStackInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name or unique ID of the stack set that you want to delete stack instances for.
 


accounts
SdkInternalList<T> accounts

 The names of the AWS accounts that you want to delete stack instances for.
 


regions
SdkInternalList<T> regions

 The regions where you want to delete stack set instances.
 


operationPreferences
StackSetOperationPreferences operationPreferences

 Preferences for how AWS CloudFormation performs this stack set operation.
 


retainStacks
Boolean retainStacks

 Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a
 retained stack or add an existing, saved stack to a new stack set.
 
 
 For more information, see Stack set operation options.
 


operationId
String operationId

 The unique identifier for this stack set operation.
 
 
 If you don't specify an operation ID, the SDK generates one automatically.
 
 
 The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set
 operation only once, even if you retry the request multiple times. You can retry stack set operation requests to
 ensure that AWS CloudFormation successfully received them.
 
 
 Repeating this stack set operation with a new operation ID retries all stack instances whose status is
 OUTDATED.
 








Class com.amazonaws.services.cloudformation.model.DeleteStackInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operationId
String operationId

 The unique identifier for this stack set operation.
 








Class com.amazonaws.services.cloudformation.model.DeleteStackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or the unique stack ID that is associated with the stack.
 


retainResources
SdkInternalList<T> retainResources

 For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the
 resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the
 retained resources.
 
 
 Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to
 delete the stack.
 


roleARN
String roleARN

 The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
 assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.
 
 
 If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
 no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
 


clientRequestToken
String clientRequestToken

 A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests
 so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry
 DeleteStack requests to ensure that AWS CloudFormation successfully received them.
 
 
 All events triggered by a given stack operation are assigned the same client request token, which you can use to
 track operations. For example, if you execute a CreateStack operation with the token
 token1, then all the StackEvents generated by that operation will have
 ClientRequestToken set as token1.
 
 
 In the console, stack operations display the client request token on the Events tab. Stack operations that are
 initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
 the stack operation . For example, if you create a stack using the console, each stack event would be assigned
 the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
 








Class com.amazonaws.services.cloudformation.model.DeleteStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudformation.model.DeleteStackSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name or unique ID of the stack set that you're deleting. You can obtain this value by running
 ListStackSets.
 








Class com.amazonaws.services.cloudformation.model.DeleteStackSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudformation.model.DeregisterTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the type.
 
 
 Conditional: You must specify TypeName or Arn.
 


type
String type

 The kind of type.
 
 
 Currently the only valid value is RESOURCE.
 


typeName
String typeName

 The name of the type.
 
 
 Conditional: You must specify TypeName or Arn.
 


versionId
String versionId

 The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name
 (ARN) assigned to the type version when it is registered.
 








Class com.amazonaws.services.cloudformation.model.DeregisterTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudformation.model.DescribeAccountLimitsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A string that identifies the next page of limits that you want to retrieve.
 








Class com.amazonaws.services.cloudformation.model.DescribeAccountLimitsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accountLimits
SdkInternalList<T> accountLimits

 An account limit structure that contain a list of AWS CloudFormation account limits and their values.
 


nextToken
String nextToken

 If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page
 exists, this value is null.
 








Class com.amazonaws.services.cloudformation.model.DescribeChangeSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


changeSetName
String changeSetName

 The name or Amazon Resource Name (ARN) of the change set that you want to describe.
 


stackName
String stackName

 If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to
 describe.
 


nextToken
String nextToken

 A string (provided by the DescribeChangeSet response output) that identifies the next page of information
 that you want to retrieve.
 








Class com.amazonaws.services.cloudformation.model.DescribeChangeSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


changeSetName
String changeSetName

 The name of the change set.
 


changeSetId
String changeSetId

 The ARN of the change set.
 


stackId
String stackId

 The ARN of the stack that is associated with the change set.
 


stackName
String stackName

 The name of the stack that is associated with the change set.
 


description
String description

 Information about the change set.
 


parameters
SdkInternalList<T> parameters

 A list of Parameter structures that describes the input parameters and their values used to create
 the change set. For more information, see the Parameter data
 type.
 


creationTime
Date creationTime

 The start time when the change set was created, in UTC.
 


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.
 


status
String status

 The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or
 FAILED.
 


statusReason
String statusReason

 A description of the change set's status. For example, if your attempt to create a change set failed, AWS
 CloudFormation shows the error message.
 


notificationARNs
SdkInternalList<T> notificationARNs

 The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if
 you execute the change set.
 


rollbackConfiguration
RollbackConfiguration rollbackConfiguration

 The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for
 the specified monitoring period afterwards.
 


capabilities
SdkInternalList<T> capabilities

 If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was
 created.
 


tags
SdkInternalList<T> tags

 If you execute the change set, the tags that will be associated with the stack.
 


changes
SdkInternalList<T> changes

 A list of Change structures that describes the resources AWS CloudFormation changes if you execute
 the change set.
 


nextToken
String nextToken

 If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page,
 this value is null.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackDriftDetectionStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackDriftDetectionId
String stackDriftDetectionId

 The ID of the drift detection results of this operation.
 
 
 AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run.
 However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackDriftDetectionStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackId
String stackId

 The ID of the stack.
 


stackDriftDetectionId
String stackDriftDetectionId

 The ID of the drift detection results of this operation.
 
 
 AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run.
 However, the number of reports AWS CloudFormation retains for any given stack, and for how long, may vary.
 


stackDriftStatus
String stackDriftStatus

 Status of the stack's actual configuration compared to its expected configuration.
 
 
 
 
 DRIFTED: The stack differs from its expected template configuration. A stack is considered to have
 drifted if one or more of its resources have drifted.
 
 
 
 
 NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template
 configuration.
 
 
 
 
 IN_SYNC: The stack's actual configuration matches its expected template configuration.
 
 
 
 
 UNKNOWN: This value is reserved for future use.
 
 
 


detectionStatus
String detectionStatus

 The status of the stack drift detection operation.
 
 
 
 
 DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources
 in the stack that support drift detection. (Resources that do not currently support stack detection remain
 unchecked.)
 
 
 If you specified logical resource IDs for AWS CloudFormation to use as a filter for the stack drift detection
 operation, only the resources with those logical IDs are checked for drift.
 
 
 
 
 DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the
 stack. Results will be available for resources on which AWS CloudFormation successfully completed drift
 detection.
 
 
 
 
 DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.
 
 
 


detectionStatusReason
String detectionStatusReason

 The reason the stack drift detection operation has its current status.
 


driftedStackResourceCount
Integer driftedStackResourceCount

 Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a
 status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is
 IN_SYNC.
 


timestamp
Date timestamp

 Time at which the stack drift detection operation was initiated.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
 
 
 
 
 Running stacks: You can specify either the stack's name or its unique stack ID.
 
 
 
 
 Deleted stacks: You must specify the unique stack ID.
 
 
 
 
 Default: There is no default value.
 


nextToken
String nextToken

 A string that identifies the next page of events that you want to retrieve.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackEvents
SdkInternalList<T> stackEvents

 A list of StackEvents structures.
 


nextToken
String nextToken

 If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page
 exists, this value is null.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name or the unique stack ID of the stack set that you want to get stack instance information for.
 


stackInstanceAccount
String stackInstanceAccount

 The ID of an AWS account that's associated with this stack instance.
 


stackInstanceRegion
String stackInstanceRegion

 The name of a region that's associated with this stack instance.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackInstance
StackInstance stackInstance

 The stack instance that matches the specified request parameters.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackResourceDriftsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name of the stack for which you want drift information.
 


stackResourceDriftStatusFilters
SdkInternalList<T> stackResourceDriftStatusFilters

 The resource drift status values to use as filters for the resource drift results returned.
 
 
 
 
 DELETED: The resource differs from its expected template configuration in that the resource has been
 deleted.
 
 
 
 
 MODIFIED: One or more resource properties differ from their expected template values.
 
 
 
 
 IN_SYNC: The resources's actual configuration matches its expected template configuration.
 
 
 
 
 NOT_CHECKED: AWS CloudFormation does not currently return this value.
 
 
 


nextToken
String nextToken

 A string that identifies the next page of stack resource drift results.
 


maxResults
Integer maxResults

 The maximum number of results to be returned with a single call. If the number of available results exceeds this
 maximum, the response includes a NextToken value that you can assign to the NextToken
 request parameter to get the next set of results.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackResourceDriftsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackResourceDrifts
SdkInternalList<T> stackResourceDrifts

 Drift information for the resources that have been checked for drift in the specified stack. This includes actual
 and expected configuration values for resources where AWS CloudFormation detects drift.
 
 
 For a given stack, there will be one StackResourceDrift for each stack resource that has been
 checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not
 currently support drift detection are not checked, and so not included. For a list of resources that support
 drift detection, see Resources that Support Drift Detection.
 


nextToken
String nextToken

 If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve
 the next set of results, call DescribeStackResourceDrifts again and assign that token to the request
 object's NextToken parameter. If the request returns all results, NextToken is set to
 null.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
 
 
 
 
 Running stacks: You can specify either the stack's name or its unique stack ID.
 
 
 
 
 Deleted stacks: You must specify the unique stack ID.
 
 
 
 
 Default: There is no default value.
 


logicalResourceId
String logicalResourceId

 The logical name of the resource as specified in the template.
 
 
 Default: There is no default value.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackResourceDetail
StackResourceDetail stackResourceDetail

 A StackResourceDetail structure containing the description of the specified resource in the
 specified stack.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
 
 
 
 
 Running stacks: You can specify either the stack's name or its unique stack ID.
 
 
 
 
 Deleted stacks: You must specify the unique stack ID.
 
 
 
 
 Default: There is no default value.
 
 
 Required: Conditional. If you do not specify StackName, you must specify
 PhysicalResourceId.
 


logicalResourceId
String logicalResourceId

 The logical name of the resource as specified in the template.
 
 
 Default: There is no default value.
 


physicalResourceId
String physicalResourceId

 The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS
 CloudFormation.
 
 
 For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to
 the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources
 to find which stack the instance belongs to and what other resources are part of the stack.
 
 
 Required: Conditional. If you do not specify PhysicalResourceId, you must specify
 StackName.
 
 
 Default: There is no default value.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackResources
SdkInternalList<T> stackResources

 A list of StackResource structures.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackSetOperationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name or the unique stack ID of the stack set for the stack operation.
 


operationId
String operationId

 The unique ID of the stack set operation.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackSetOperationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackSetOperation
StackSetOperation stackSetOperation

 The specified stack set operation.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name or unique ID of the stack set whose description you want.
 








Class com.amazonaws.services.cloudformation.model.DescribeStackSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackSet
StackSet stackSet

 The specified stack set.
 








Class com.amazonaws.services.cloudformation.model.DescribeStacksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
 
 
 
 
 Running stacks: You can specify either the stack's name or its unique stack ID.
 
 
 
 
 Deleted stacks: You must specify the unique stack ID.
 
 
 
 
 Default: There is no default value.
 


nextToken
String nextToken

 A string that identifies the next page of stacks that you want to retrieve.
 








Class com.amazonaws.services.cloudformation.model.DescribeStacksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stacks
SdkInternalList<T> stacks

 A list of stack structures.
 


nextToken
String nextToken

 If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page
 exists, this value is null.
 








Class com.amazonaws.services.cloudformation.model.DescribeTypeRegistrationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


registrationToken
String registrationToken

 The identifier for this registration request.
 
 
 This registration token is generated by CloudFormation when you initiate a registration request using
  RegisterType .
 








Class com.amazonaws.services.cloudformation.model.DescribeTypeRegistrationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


progressStatus
String progressStatus

 The current status of the type registration request.
 


description
String description

 The description of the type registration request.
 


typeArn
String typeArn

 The Amazon Resource Name (ARN) of the type being registered.
 
 
 For registration requests with a ProgressStatus of other than COMPLETE, this will be
 null.
 


typeVersionArn
String typeVersionArn

 The Amazon Resource Name (ARN) of this specific version of the type being registered.
 
 
 For registration requests with a ProgressStatus of other than COMPLETE, this will be
 null.
 








Class com.amazonaws.services.cloudformation.model.DescribeTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


type
String type

 The kind of type.
 
 
 Currently the only valid value is RESOURCE.
 


typeName
String typeName

 The name of the type.
 
 
 Conditional: You must specify TypeName or Arn.
 


arn
String arn

 The Amazon Resource Name (ARN) of the type.
 
 
 Conditional: You must specify TypeName or Arn.
 


versionId
String versionId

 The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name
 (ARN) assigned to the type version when it is registered.
 
 
 If you specify a VersionId, DescribeType returns information about that specific type
 version. Otherwise, it returns information about the default type version.
 








Class com.amazonaws.services.cloudformation.model.DescribeTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the type.
 


type
String type

 The kind of type.
 
 
 Currently the only valid value is RESOURCE.
 


typeName
String typeName

 The name of the registered type.
 


defaultVersionId
String defaultVersionId

 The ID of the default version of the type. The default version is used when the type version is not specified.
 
 
 To set the default version of a type, use  SetTypeDefaultVersion .
 


description
String description

 The description of the registered type.
 


schema
String schema

 The schema that defines the type.
 
 
 For more information on type schemas, see Resource
 Provider Schema in the CloudFormation CLI User Guide.
 


provisioningType
String provisioningType

 The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration,
 based on the types of handlers in the schema handler package submitted.
 
 
 Valid values include:
 
 
 
 
 FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack
 update operations.
 
 
 
 
 IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must
 instead be replaced during stack update operations.
 
 
 
 
 NON_PROVISIONABLE: The type does not include all of the following handlers, and therefore cannot
 actually be provisioned.
 
 
 
 
 create
 
 
 
 
 read
 
 
 
 
 delete
 
 
 
 
 


deprecatedStatus
String deprecatedStatus

 The deprecation status of the type.
 
 
 Valid values include:
 
 
 
 
 LIVE: The type is registered and can be used in CloudFormation operations, dependent on its
 provisioning behavior and visibility scope.
 
 
 
 
 DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.
 
 
 


loggingConfig
LoggingConfig loggingConfig

 Contains logging configuration information for a type.
 


executionRoleArn
String executionRoleArn

 The Amazon Resource Name (ARN) of the IAM execution role used to register the type. If your resource type calls
 AWS APIs in any of its handlers, you must create an  IAM execution role  that includes
 the necessary permissions to call those AWS APIs, and provision that execution role in your account.
 CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
 


visibility
String visibility

 The scope at which the type is visible and usable in CloudFormation operations.
 
 
 Valid values include:
 
 
 
 
 PRIVATE: The type is only visible and usable within the account in which it is registered.
 Currently, AWS CloudFormation marks any types you register as PRIVATE.
 
 
 
 
 PUBLIC: The type is publically visible and usable within any Amazon account.
 
 
 


sourceUrl
String sourceUrl

 The URL of the source code for the type.
 


documentationUrl
String documentationUrl

 The URL of a page providing detailed documentation for this type.
 


lastUpdated
Date lastUpdated

 When the specified type version was registered.
 


timeCreated
Date timeCreated

 When the specified type version was registered.
 








Class com.amazonaws.services.cloudformation.model.DetectStackDriftRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name of the stack for which you want to detect drift.
 


logicalResourceIds
SdkInternalList<T> logicalResourceIds

 The logical names of any resources you want to use as filters.
 








Class com.amazonaws.services.cloudformation.model.DetectStackDriftResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackDriftDetectionId
String stackDriftDetectionId

 The ID of the drift detection results of this operation.
 
 
 AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run.
 However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary.
 








Class com.amazonaws.services.cloudformation.model.DetectStackResourceDriftRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name of the stack to which the resource belongs.
 


logicalResourceId
String logicalResourceId

 The logical name of the resource for which to return drift information.
 








Class com.amazonaws.services.cloudformation.model.DetectStackResourceDriftResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackResourceDrift
StackResourceDrift stackResourceDrift

 Information about whether the resource's actual configuration has drifted from its expected template
 configuration, including actual and expected property values and any differences detected.
 








Class com.amazonaws.services.cloudformation.model.DetectStackSetDriftRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name of the stack set on which to perform the drift detection operation.
 


operationPreferences
StackSetOperationPreferences operationPreferences


operationId
String operationId

 The ID of the stack set operation.
 








Class com.amazonaws.services.cloudformation.model.DetectStackSetDriftResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operationId
String operationId

 The ID of the drift detection stack set operation.
 
 
 you can use this operation id with  DescribeStackSetOperation  to monitor the progress of the
 drift detection operation.
 








Class com.amazonaws.services.cloudformation.model.EstimateTemplateCostRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateBody
String templateBody

 Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For
 more information, go to Template Anatomy
 in the AWS CloudFormation User Guide.)
 
 
 Conditional: You must pass TemplateBody or TemplateURL. If both are passed, only
 TemplateBody is used.
 


templateURL
String templateURL

 Location of file containing the template body. The URL must point to a template that is located in an Amazon S3
 bucket. For more information, go to Template Anatomy
 in the AWS CloudFormation User Guide.
 
 
 Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only
 TemplateBody is used.
 


parameters
SdkInternalList<T> parameters

 A list of Parameter structures that specify input parameters.
 








Class com.amazonaws.services.cloudformation.model.EstimateTemplateCostResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


url
String url

 An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the
 template.
 








Class com.amazonaws.services.cloudformation.model.ExecuteChangeSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


changeSetName
String changeSetName

 The name or ARN of the change set that you want use to update the specified stack.
 


stackName
String stackName

 If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change
 set you want to execute.
 


clientRequestToken
String clientRequestToken

 A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry
 requests so that AWS CloudFormation knows that you're not attempting to execute a change set to update a stack
 with the same name. You might retry ExecuteChangeSet requests to ensure that AWS CloudFormation
 successfully received them.
 








Class com.amazonaws.services.cloudformation.model.ExecuteChangeSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudformation.model.Export extends Object implements Serializable


Serialized Fields


exportingStackId
String exportingStackId

 The stack that contains the exported output name and value.
 


name
String name

 The name of exported output value. Use this name and the Fn::ImportValue function to import the
 associated value into other stacks. The name is defined in the Export field in the associated
 stack's Outputs section.
 


value
String value

 The value of the exported output, such as a resource physical ID. This value is defined in the
 Export field in the associated stack's Outputs section.
 








Class com.amazonaws.services.cloudformation.model.GetStackPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or unique stack ID that is associated with the stack whose policy you want to get.
 








Class com.amazonaws.services.cloudformation.model.GetStackPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackPolicyBody
String stackPolicyBody

 Structure containing the stack policy body. (For more information, go to  Prevent
 Updates to Stack Resources in the AWS CloudFormation User Guide.)
 








Class com.amazonaws.services.cloudformation.model.GetTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
 
 
 
 
 Running stacks: You can specify either the stack's name or its unique stack ID.
 
 
 
 
 Deleted stacks: You must specify the unique stack ID.
 
 
 
 
 Default: There is no default value.
 


changeSetName
String changeSetName

 The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated
 template. If you specify a name, you must also specify the StackName.
 


templateStage
String templateStage

 For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the
 user-submitted template, specify Original. To get the template after AWS CloudFormation has
 processed all transforms, specify Processed.
 
 
 If the template doesn't include transforms, Original and Processed return the same
 template. By default, AWS CloudFormation specifies Original.
 








Class com.amazonaws.services.cloudformation.model.GetTemplateResult extends AmazonWebServiceResult<ResponseMetadata> 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.)
 
 
 AWS CloudFormation returns the same template that was used when the stack was created.
 


stagesAvailable
SdkInternalList<T> stagesAvailable

 The stage of the template that you can retrieve. For stacks, the Original and Processed
 templates are always available. For change sets, the Original template is always available. After
 AWS CloudFormation finishes creating the change set, the Processed template becomes available.
 








Class com.amazonaws.services.cloudformation.model.GetTemplateSummaryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateBody
String templateBody

 Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
 more information about templates, see Template Anatomy
 in the AWS CloudFormation User Guide.
 
 
 Conditional: You must specify only one of the following parameters: StackName,
 StackSetName, 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,
 StackSetName, TemplateBody, or TemplateURL.
 


stackName
String stackName

 The name or the stack ID that is associated with the stack, which are not always interchangeable. For running
 stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the
 unique stack ID.
 
 
 Conditional: You must specify only one of the following parameters: StackName,
 StackSetName, TemplateBody, or TemplateURL.
 


stackSetName
String stackSetName

 The name or unique ID of the stack set from which the stack was created.
 
 
 Conditional: You must specify only one of the following parameters: StackName,
 StackSetName, TemplateBody, or TemplateURL.
 








Class com.amazonaws.services.cloudformation.model.GetTemplateSummaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


parameters
SdkInternalList<T> parameters

 A list of parameter declarations that describe various properties for each parameter.
 


description
String description

 The value that is defined in the Description property of the template.
 


capabilities
SdkInternalList<T> capabilities

 The capabilities found within the template. If your template contains IAM resources, you must specify the
 CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or
 UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
 
 
 For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
 


capabilitiesReason
String capabilitiesReason

 The list of resources that generated the values in the Capabilities response element.
 


resourceTypes
SdkInternalList<T> resourceTypes

 A list of all the template resource types that are defined in the template, such as
 AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
 


version
String version

 The AWS template format version, which identifies the capabilities of the template.
 


metadata
String metadata

 The value that is defined for the Metadata property of the template.
 


declaredTransforms
SdkInternalList<T> declaredTransforms

 A list of the transforms that are declared in the template.
 


resourceIdentifierSummaries
SdkInternalList<T> resourceIdentifierSummaries

 A list of resource identifier summaries that describe the target resources of an import operation and the
 properties you can provide during the import to identify the target resources. For example,
 BucketName is a possible identifier property for an AWS::S3::Bucket resource.
 








Class com.amazonaws.services.cloudformation.model.InsufficientCapabilitiesException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.InvalidChangeSetStatusException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.InvalidOperationException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.InvalidStateTransitionException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.LimitExceededException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.ListChangeSetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
 


nextToken
String nextToken

 A string (provided by the ListChangeSets response output) that identifies the next page of change sets
 that you want to retrieve.
 








Class com.amazonaws.services.cloudformation.model.ListChangeSetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaries
SdkInternalList<T> summaries

 A list of ChangeSetSummary structures that provides the ID and status of each change set for the
 specified stack.
 


nextToken
String nextToken

 If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional
 page, this value is null.
 








Class com.amazonaws.services.cloudformation.model.ListExportsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A string (provided by the ListExports response output) that identifies the next page of exported output
 values that you asked to retrieve.
 








Class com.amazonaws.services.cloudformation.model.ListExportsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


exports
SdkInternalList<T> exports

 The output for the ListExports action.
 


nextToken
String nextToken

 If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is
 no additional page, this value is null.
 








Class com.amazonaws.services.cloudformation.model.ListImportsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


exportName
String exportName

 The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value.
 


nextToken
String nextToken

 A string (provided by the ListImports response output) that identifies the next page of stacks that are
 importing the specified exported output value.
 








Class com.amazonaws.services.cloudformation.model.ListImportsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


imports
SdkInternalList<T> imports

 A list of stack names that are importing the specified exported output value.
 


nextToken
String nextToken

 A string that identifies the next page of exports. If there is no additional page, this value is null.
 








Class com.amazonaws.services.cloudformation.model.ListStackInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name or unique ID of the stack set that you want to list stack instances for.
 


nextToken
String nextToken

 If the previous request didn't return all of the remaining results, the response's NextToken
 parameter value is set to a token. To retrieve the next set of results, call ListStackInstances
 again and assign that token to the request object's NextToken parameter. If there are no remaining
 results, the previous response object's NextToken parameter is set to null.
 


maxResults
Integer maxResults

 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.
 


stackInstanceAccount
String stackInstanceAccount

 The name of the AWS account that you want to list stack instances for.
 


stackInstanceRegion
String stackInstanceRegion

 The name of the region where you want to list stack instances.
 








Class com.amazonaws.services.cloudformation.model.ListStackInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaries
SdkInternalList<T> summaries

 A list of StackInstanceSummary structures that contain information about the specified stack
 instances.
 


nextToken
String nextToken

 If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve
 the next set of results, call ListStackInstances again and assign that token to the request object's
 NextToken parameter. If the request returns all results, NextToken is set to
 null.
 








Class com.amazonaws.services.cloudformation.model.ListStackResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
 
 
 
 
 Running stacks: You can specify either the stack's name or its unique stack ID.
 
 
 
 
 Deleted stacks: You must specify the unique stack ID.
 
 
 
 
 Default: There is no default value.
 


nextToken
String nextToken

 A string that identifies the next page of stack resources that you want to retrieve.
 








Class com.amazonaws.services.cloudformation.model.ListStackResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackResourceSummaries
SdkInternalList<T> stackResourceSummaries

 A list of StackResourceSummary structures.
 


nextToken
String nextToken

 If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page
 exists, this value is null.
 








Class com.amazonaws.services.cloudformation.model.ListStackSetOperationResultsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name or unique ID of the stack set that you want to get operation results for.
 


operationId
String operationId

 The ID of the stack set operation.
 


nextToken
String nextToken

 If the previous request didn't return all of the remaining results, the response object's NextToken
 parameter value is set to a token. To retrieve the next set of results, call
 ListStackSetOperationResults again and assign that token to the request object's
 NextToken parameter. If there are no remaining results, the previous response object's
 NextToken parameter is set to null.
 


maxResults
Integer maxResults

 The maximum number of results to be returned with a single call. If the number of available results exceeds this
 maximum, the response includes a NextToken value that you can assign to the NextToken
 request parameter to get the next set of results.
 








Class com.amazonaws.services.cloudformation.model.ListStackSetOperationResultsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaries
SdkInternalList<T> summaries

 A list of StackSetOperationResultSummary structures that contain information about the specified
 operation results, for accounts and regions that are included in the operation.
 


nextToken
String nextToken

 If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of
 results, call ListOperationResults again and assign that token to the request object's
 NextToken parameter. If there are no remaining results, NextToken is set to
 null.
 








Class com.amazonaws.services.cloudformation.model.ListStackSetOperationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name or unique ID of the stack set that you want to get operation summaries for.
 


nextToken
String nextToken

 If the previous paginated request didn't return all of the remaining results, the response object's
 NextToken parameter value is set to a token. To retrieve the next set of results, call
 ListStackSetOperations again and assign that token to the request object's NextToken
 parameter. If there are no remaining results, the previous response object's NextToken parameter is
 set to null.
 


maxResults
Integer maxResults

 The maximum number of results to be returned with a single call. If the number of available results exceeds this
 maximum, the response includes a NextToken value that you can assign to the NextToken
 request parameter to get the next set of results.
 








Class com.amazonaws.services.cloudformation.model.ListStackSetOperationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaries
SdkInternalList<T> summaries

 A list of StackSetOperationSummary structures that contain summary information about operations for
 the specified stack set.
 


nextToken
String nextToken

 If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of
 results, call ListOperationResults again and assign that token to the request object's
 NextToken parameter. If there are no remaining results, NextToken is set to
 null.
 








Class com.amazonaws.services.cloudformation.model.ListStackSetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If the previous paginated request didn't return all of the remaining results, the response object's
 NextToken parameter value is set to a token. To retrieve the next set of results, call
 ListStackSets again and assign that token to the request object's NextToken parameter.
 If there are no remaining results, the previous response object's NextToken parameter is set to
 null.
 


maxResults
Integer maxResults

 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.
 


status
String status

 The status of the stack sets that you want to get summary information about.
 








Class com.amazonaws.services.cloudformation.model.ListStackSetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaries
SdkInternalList<T> summaries

 A list of StackSetSummary structures that contain information about the user's stack sets.
 


nextToken
String nextToken

 If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve
 the next set of results, call ListStackInstances again and assign that token to the request object's
 NextToken parameter. If the request returns all results, NextToken is set to
 null.
 








Class com.amazonaws.services.cloudformation.model.ListStacksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A string that identifies the next page of stacks that you want to retrieve.
 


stackStatusFilters
SdkInternalList<T> stackStatusFilters

 Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified
 status codes. For a complete list of stack status codes, see the StackStatus parameter of the
 Stack data type.
 








Class com.amazonaws.services.cloudformation.model.ListStacksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackSummaries
SdkInternalList<T> stackSummaries

 A list of StackSummary structures containing information about the specified stacks.
 


nextToken
String nextToken

 If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page
 exists, this value is null.
 








Class com.amazonaws.services.cloudformation.model.ListTypeRegistrationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


type
String type

 The kind of type.
 
 
 Currently the only valid value is RESOURCE.
 


typeName
String typeName

 The name of the type.
 
 
 Conditional: You must specify TypeName or Arn.
 


typeArn
String typeArn

 The Amazon Resource Name (ARN) of the type.
 
 
 Conditional: You must specify TypeName or Arn.
 


registrationStatusFilter
String registrationStatusFilter

 The current status of the type registration request.
 


maxResults
Integer maxResults

 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 didn't return all of the remaining results, the response object's
 NextToken parameter value is set to a token. To retrieve the next set of results, call this action
 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.
 








Class com.amazonaws.services.cloudformation.model.ListTypeRegistrationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registrationTokenList
SdkInternalList<T> registrationTokenList

 A list of type registration tokens.
 
 
 Use  DescribeTypeRegistration  to return detailed information about a type registration
 request.
 


nextToken
String nextToken

 If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve
 the next set of results, call this action again and assign that token to the request object's
 NextToken parameter. If the request returns all results, NextToken is set to
 null.
 








Class com.amazonaws.services.cloudformation.model.ListTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


visibility
String visibility

 The scope at which the type is visible and usable in CloudFormation operations.
 
 
 Valid values include:
 
 
 
 
 PRIVATE: The type is only visible and usable within the account in which it is registered.
 Currently, AWS CloudFormation marks any types you create as PRIVATE.
 
 
 
 
 PUBLIC: The type is publically visible and usable within any Amazon account.
 
 
 


provisioningType
String provisioningType

 The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration,
 based on the types of handlers in the schema handler package submitted.
 
 
 Valid values include:
 
 
 
 
 FULLY_MUTABLE: The type includes an update handler to process updates to the type during stack
 update operations.
 
 
 
 
 IMMUTABLE: The type does not include an update handler, so the type cannot be updated and must
 instead be replaced during stack update operations.
 
 
 
 
 NON_PROVISIONABLE: The type does not include create, read, and delete handlers, and therefore cannot
 actually be provisioned.
 
 
 


deprecatedStatus
String deprecatedStatus

 The deprecation status of the types that you want to get summary information about.
 
 
 Valid values include:
 
 
 
 
 LIVE: The type is registered for use in CloudFormation operations.
 
 
 
 
 DEPRECATED: The type has been deregistered and can no longer be used in CloudFormation operations.
 
 
 


maxResults
Integer maxResults

 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 didn't return all of the remaining results, the response object's
 NextToken parameter value is set to a token. To retrieve the next set of results, call this action
 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.
 








Class com.amazonaws.services.cloudformation.model.ListTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


typeSummaries
SdkInternalList<T> typeSummaries

 A list of TypeSummary structures that contain information about the specified types.
 


nextToken
String nextToken

 If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve
 the next set of results, call this action again and assign that token to the request object's
 NextToken parameter. If the request returns all results, NextToken is set to
 null.
 








Class com.amazonaws.services.cloudformation.model.ListTypeVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


type
String type

 The kind of the type.
 
 
 Currently the only valid value is RESOURCE.
 


typeName
String typeName

 The name of the type for which you want version summary information.
 
 
 Conditional: You must specify TypeName or Arn.
 


arn
String arn

 The Amazon Resource Name (ARN) of the type for which you want version summary information.
 
 
 Conditional: You must specify TypeName or Arn.
 


maxResults
Integer maxResults

 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 didn't return all of the remaining results, the response object's
 NextToken parameter value is set to a token. To retrieve the next set of results, call this action
 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.
 


deprecatedStatus
String deprecatedStatus

 The deprecation status of the type versions that you want to get summary information about.
 
 
 Valid values include:
 
 
 
 
 LIVE: The type version is registered and can be used in CloudFormation operations, dependent on its
 provisioning behavior and visibility scope.
 
 
 
 
 DEPRECATED: The type version has been deregistered and can no longer be used in CloudFormation
 operations.
 
 
 








Class com.amazonaws.services.cloudformation.model.ListTypeVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


typeVersionSummaries
SdkInternalList<T> typeVersionSummaries

 A list of TypeVersionSummary structures that contain information about the specified type's
 versions.
 


nextToken
String nextToken

 If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve
 the next set of results, call this action again and assign that token to the request object's
 NextToken parameter. If the request returns all results, NextToken is set to
 null.
 








Class com.amazonaws.services.cloudformation.model.LoggingConfig extends Object implements Serializable


Serialized Fields


logRoleArn
String logRoleArn

 The ARN of the role that CloudFormation should assume when sending log entries to CloudWatch logs.
 


logGroupName
String logGroupName

 The Amazon CloudWatch log group to which CloudFormation sends error logging information when invoking the type's
 handlers.
 








Class com.amazonaws.services.cloudformation.model.NameAlreadyExistsException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.OperationIdAlreadyExistsException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.OperationInProgressException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.OperationNotFoundException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.OperationStatusCheckFailedException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.Output extends Object implements Serializable


Serialized Fields


outputKey
String outputKey

 The key associated with the output.
 


outputValue
String outputValue

 The value associated with the output.
 


description
String description

 User defined description associated with the output.
 


exportName
String exportName

 The name of the export associated with the output.
 








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


Serialized Fields


parameterKey
String parameterKey

 The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS
 CloudFormation uses the default value that is specified in your template.
 


parameterValue
String parameterValue

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


resolvedValue
String resolvedValue

 Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for  SSM parameter types in the template.
 








Class com.amazonaws.services.cloudformation.model.ParameterConstraints extends Object implements Serializable


Serialized Fields


allowedValues
SdkInternalList<T> allowedValues

 A list of values that are permitted for a parameter.
 








Class com.amazonaws.services.cloudformation.model.ParameterDeclaration extends Object implements Serializable


Serialized Fields


parameterKey
String parameterKey

 The name that is associated with the parameter.
 


defaultValue
String defaultValue

 The default value of the parameter.
 


parameterType
String parameterType

 The type of parameter.
 


noEcho
Boolean noEcho

 Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.
 


description
String description

 The description that is associate with the parameter.
 


parameterConstraints
ParameterConstraints parameterConstraints

 The criteria that AWS CloudFormation uses to validate parameter values.
 








Class com.amazonaws.services.cloudformation.model.PhysicalResourceIdContextKeyValuePair extends Object implements Serializable


Serialized Fields


key
String key

 The resource context key.
 


value
String value

 The resource context value.
 








Class com.amazonaws.services.cloudformation.model.PropertyDifference extends Object implements Serializable


Serialized Fields


propertyPath
String propertyPath

 The fully-qualified path to the resource property.
 


expectedValue
String expectedValue

 The expected property value of the resource property, as defined in the stack template and any values specified
 as template parameters.
 


actualValue
String actualValue

 The actual property value of the resource property.
 


differenceType
String differenceType

 The type of property difference.
 
 
 
 
 ADD: A value has been added to a resource property that is an array or list data type.
 
 
 
 
 REMOVE: The property has been removed from the current resource configuration.
 
 
 
 
 NOT_EQUAL: The current property value differs from its expected value (as defined in the stack
 template and any values specified as template parameters).
 
 
 








Class com.amazonaws.services.cloudformation.model.RecordHandlerProgressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


bearerToken
String bearerToken

 Reserved for use by the CloudFormation CLI.
 


operationStatus
String operationStatus

 Reserved for use by the CloudFormation CLI.
 


currentOperationStatus
String currentOperationStatus

 Reserved for use by the CloudFormation CLI.
 


statusMessage
String statusMessage

 Reserved for use by the CloudFormation CLI.
 


errorCode
String errorCode

 Reserved for use by the CloudFormation CLI.
 


resourceModel
String resourceModel

 Reserved for use by the CloudFormation CLI.
 


clientRequestToken
String clientRequestToken

 Reserved for use by the CloudFormation CLI.
 








Class com.amazonaws.services.cloudformation.model.RecordHandlerProgressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudformation.model.RegisterTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


type
String type

 The kind of type.
 
 
 Currently, the only valid value is RESOURCE.
 


typeName
String typeName

 The name of the type being registered.
 
 
 We recommend that type names adhere to the following pattern:
 company_or_organization::service::type.
 
 
 
 The following organization namespaces are reserved and cannot be used in your resource type names:
 
 
 
 
 Alexa
 
 
 
 
 AMZN
 
 
 
 
 Amazon
 
 
 
 
 AWS
 
 
 
 
 Custom
 
 
 
 
 Dev
 
 
 
 


schemaHandlerPackage
String schemaHandlerPackage

 A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and
 associated files for the type you want to register.
 
 
 For information on generating a schema handler package for the type you want to register, see submit
 in the CloudFormation CLI User Guide.
 


loggingConfig
LoggingConfig loggingConfig

 Specifies logging configuration information for a type.
 


executionRoleArn
String executionRoleArn

 The Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls
 AWS APIs in any of its handlers, you must create an  IAM execution role  that includes
 the necessary permissions to call those AWS APIs, and provision that execution role in your account.
 CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
 


clientRequestToken
String clientRequestToken

 A unique identifier that acts as an idempotency key for this registration request. Specifying a client request
 token prevents CloudFormation from generating more than one version of a type from the same registeration
 request, even if the request is submitted multiple times.
 








Class com.amazonaws.services.cloudformation.model.RegisterTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registrationToken
String registrationToken

 The identifier for this registration request.
 
 
 Use this registration token when calling  DescribeTypeRegistration , which returns
 information about the status and IDs of the type registration.
 








Class com.amazonaws.services.cloudformation.model.ResourceChange extends Object implements Serializable


Serialized Fields


action
String action

 The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource),
 Modify (changes a resource), or Remove (deletes a resource).
 


logicalResourceId
String logicalResourceId

 The resource's logical ID, which is defined in the stack's template.
 


physicalResourceId
String physicalResourceId

 The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they
 haven't been created.
 


resourceType
String resourceType

 The type of AWS CloudFormation resource, such as AWS::S3::Bucket.
 


replacement
String replacement

 For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a
 new one and deleting the old one. This value depends on the value of the RequiresRecreation property
 in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field
 is Always and the Evaluation field is Static, Replacement is
 True. If the RequiresRecreation field is Always and the
 Evaluation field is Dynamic, Replacement is Conditionally.
 
 
 If you have multiple changes with different RequiresRecreation values, the Replacement
 value depends on the change with the most impact. A RequiresRecreation value of Always
 has the most impact, followed by Conditionally, and then Never.
 


scope
SdkInternalList<T> scope

 For the Modify action, indicates which resource attribute is triggering this update, such as a
 change in the resource attribute's Metadata, Properties, or Tags.
 


details
SdkInternalList<T> details

 For the Modify action, a list of ResourceChangeDetail structures that describes the
 changes that AWS CloudFormation will make to the resource.
 








Class com.amazonaws.services.cloudformation.model.ResourceChangeDetail extends Object implements Serializable


Serialized Fields


target
ResourceTargetDefinition target

 A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change
 and whether the resource will be recreated.
 


evaluation
String evaluation

 Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change
 before you execute a change set.
 
 
 For Static evaluations, AWS CloudFormation can determine that the target value will change, and its
 value. For example, if you directly modify the InstanceType property of an EC2 instance, AWS
 CloudFormation knows that this property value will change, and its value, so this is a Static
 evaluation.
 
 
 For Dynamic evaluations, cannot determine the target value because it depends on the result of an
 intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is
 updated. For example, if your template includes a reference to a resource that is conditionally recreated, the
 value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated.
 If the resource is recreated, it will have a new physical ID, so all references to that resource will also be
 updated.
 


changeSource
String changeSource

 The group to which the CausingEntity value belongs. There are five entity groups:
 
 
 
 
 ResourceReference entities are Ref intrinsic functions that refer to resources in the
 template, such as { "Ref" : "MyEC2InstanceResource" }.
 
 
 
 
 ParameterReference entities are Ref intrinsic functions that get template parameter
 values, such as { "Ref" : "MyPasswordParameter" }.
 
 
 
 
 ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource
 attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] }.
 
 
 
 
 DirectModification entities are changes that are made directly to the template.
 
 
 
 
 Automatic entities are AWS::CloudFormation::Stack resource types, which are also known
 as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, AWS
 CloudFormation sets the ChangeSource to Automatic because the nested stack's template
 might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an
 update on the parent stack.
 
 
 


causingEntity
String causingEntity

 The identity of the entity that triggered this change. This entity is a member of the group that is specified by
 the ChangeSource field. For example, if you modified the value of the KeyPairName
 parameter, the CausingEntity is the name of the parameter (KeyPairName).
 
 
 If the ChangeSource value is DirectModification, no value is given for
 CausingEntity.
 








Class com.amazonaws.services.cloudformation.model.ResourceIdentifierSummary extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The template resource type of the target resources, such as AWS::S3::Bucket.
 


logicalResourceIds
SdkInternalList<T> logicalResourceIds

 The logical IDs of the target resources of the specified ResourceType, as defined in the import
 template.
 


resourceIdentifiers
SdkInternalList<T> resourceIdentifiers

 The resource properties you can provide during the import to identify your target resources. For example,
 BucketName is a possible identifier property for AWS::S3::Bucket resources.
 








Class com.amazonaws.services.cloudformation.model.ResourceTargetDefinition extends Object implements Serializable


Serialized Fields


attribute
String attribute

 Indicates which resource attribute is triggering this update, such as a change in the resource attribute's
 Metadata, Properties, or Tags.
 


name
String name

 If the Attribute value is Properties, the name of the property. For all other
 attributes, the value is null.
 


requiresRecreation
String requiresRecreation

 If the Attribute value is Properties, indicates whether a change to this property
 causes the resource to be recreated. The value can be Never, Always, or
 Conditionally. To determine the conditions for a Conditionally recreation, see the
 update behavior for that property in the AWS CloudFormation User Guide.
 








Class com.amazonaws.services.cloudformation.model.ResourceToImport extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of resource to import into your stack, such as AWS::S3::Bucket.
 


logicalResourceId
String logicalResourceId

 The logical ID of the target resource as specified in the template.
 


resourceIdentifier
Map<K,V> resourceIdentifier

 A key-value pair that identifies the target resource. The key is an identifier property (for example,
 BucketName for AWS::S3::Bucket resources) and the value is the actual property value
 (for example, MyS3Bucket).
 








Class com.amazonaws.services.cloudformation.model.RollbackConfiguration extends Object implements Serializable


Serialized Fields


rollbackTriggers
SdkInternalList<T> rollbackTriggers

 The triggers to monitor during stack creation or update actions.
 
 
 By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them to any
 subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for
 this parameter, those triggers replace any list of triggers previously specified for the stack. This means:
 
 
 
 
 To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.
 
 
 
 
 To specify new or updated rollback triggers, you must specify all the triggers that you want used for this
 stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack
 update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.
 
 
 
 
 To remove all currently specified triggers, specify an empty list for this parameter.
 
 
 
 
 If a specified trigger is missing, the entire stack operation fails and is rolled back.
 


monitoringTimeInMinutes
Integer monitoringTimeInMinutes

 The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the
 stack creation or update operation deploys all necessary resources.
 
 
 The default is 0 minutes.
 
 
 If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the
 specified period of time before cleaning up old resources after update operations. You can use this monitoring
 period to perform any manual stack validation desired, and manually cancel the stack creation or update (using 
 CancelUpdateStack, for example) as necessary.
 
 
 If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack
 creation and update operations. Then, for update operations, it begins disposing of old resources immediately
 once the operation completes.
 








Class com.amazonaws.services.cloudformation.model.RollbackTrigger extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the rollback trigger.
 
 
 If a specified trigger is missing, the entire stack operation fails and is rolled back.
 


type
String type

 The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.
 








Class com.amazonaws.services.cloudformation.model.SetStackPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or unique stack ID that you want to associate a policy with.
 


stackPolicyBody
String stackPolicyBody

 Structure containing the stack policy body. For more information, go to  Prevent
 Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the
 StackPolicyBody or the StackPolicyURL parameter, but not both.
 


stackPolicyURL
String stackPolicyURL

 Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in
 an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the
 StackPolicyURL parameter, but not both.
 








Class com.amazonaws.services.cloudformation.model.SetStackPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudformation.model.SetTypeDefaultVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the type for which you want version summary information.
 
 
 Conditional: You must specify TypeName or Arn.
 


type
String type

 The kind of type.
 


typeName
String typeName

 The name of the type.
 
 
 Conditional: You must specify TypeName or Arn.
 


versionId
String versionId

 The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name
 (ARN) assigned to the type version when it is registered.
 








Class com.amazonaws.services.cloudformation.model.SetTypeDefaultVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudformation.model.SignalResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The stack name or unique stack ID that includes the resource that you want to signal.
 


logicalResourceId
String logicalResourceId

 The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in
 the template.
 


uniqueId
String uniqueId

 A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID
 that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a
 wait condition), each signal requires a different unique ID.
 


status
String status

 The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to
 immediately fail the stack creation or update.
 








Class com.amazonaws.services.cloudformation.model.SignalResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudformation.model.Stack extends Object implements Serializable


Serialized Fields


stackId
String stackId

 Unique identifier of the stack.
 


stackName
String stackName

 The name associated with the stack.
 


changeSetId
String changeSetId

 The unique ID of the change set.
 


description
String description

 A user-defined description associated with the stack.
 


parameters
SdkInternalList<T> parameters

 A list of Parameter structures.
 


creationTime
Date creationTime

 The time at which 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.
 


rollbackConfiguration
RollbackConfiguration rollbackConfiguration

 The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for
 the specified monitoring period afterwards.
 


stackStatus
String stackStatus

 Current status of the stack.
 


stackStatusReason
String stackStatusReason

 Success/failure message associated with the stack status.
 


disableRollback
Boolean disableRollback

 Boolean to enable or disable rollback on stack creation failures:
 
 
 
 
 true: disable rollback
 
 
 
 
 false: enable rollback
 
 
 


notificationARNs
SdkInternalList<T> notificationARNs

 SNS topic ARNs to which stack related events are published.
 


timeoutInMinutes
Integer timeoutInMinutes

 The amount of time within which stack creation should complete.
 


capabilities
SdkInternalList<T> capabilities

 The capabilities allowed in the stack.
 


outputs
SdkInternalList<T> outputs

 A list of output structures.
 


roleARN
String roleARN

 The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the
 stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.
 


tags
SdkInternalList<T> tags

 A list of Tags that specify information about the stack.
 


enableTerminationProtection
Boolean enableTerminationProtection

 Whether termination protection is enabled for the stack.
 
 
 For nested
 stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.
 For more information, see Protecting a
 Stack From Being Deleted in the AWS CloudFormation User Guide.
 


parentId
String parentId

 For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this
 stack. For the first level of nested stacks, the root stack is also the parent stack.
 
 
 For more information, see Working with
 Nested Stacks in the AWS CloudFormation User Guide.
 


rootId
String rootId

 For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which
 the nested stack ultimately belongs.
 
 
 For more information, see Working with
 Nested Stacks in the AWS CloudFormation User Guide.
 


driftInformation
StackDriftInformation driftInformation

 Information on whether a stack's actual configuration differs, or has drifted, from it's expected
 configuration, as defined in the stack template and any values specified as template parameters. For more
 information, see Detecting
 Unregulated Configuration Changes to Stacks and Resources.
 








Class com.amazonaws.services.cloudformation.model.StackDriftInformation extends Object implements Serializable


Serialized Fields


stackDriftStatus
String stackDriftStatus

 Status of the stack's actual configuration compared to its expected template configuration.
 
 
 
 
 DRIFTED: The stack differs from its expected template configuration. A stack is considered to have
 drifted if one or more of its resources have drifted.
 
 
 
 
 NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template
 configuration.
 
 
 
 
 IN_SYNC: The stack's actual configuration matches its expected template configuration.
 
 
 
 
 UNKNOWN: This value is reserved for future use.
 
 
 


lastCheckTimestamp
Date lastCheckTimestamp

 Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources
 that support drift detection.
 








Class com.amazonaws.services.cloudformation.model.StackDriftInformationSummary extends Object implements Serializable


Serialized Fields


stackDriftStatus
String stackDriftStatus

 Status of the stack's actual configuration compared to its expected template configuration.
 
 
 
 
 DRIFTED: The stack differs from its expected template configuration. A stack is considered to have
 drifted if one or more of its resources have drifted.
 
 
 
 
 NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template
 configuration.
 
 
 
 
 IN_SYNC: The stack's actual configuration matches its expected template configuration.
 
 
 
 
 UNKNOWN: This value is reserved for future use.
 
 
 


lastCheckTimestamp
Date lastCheckTimestamp

 Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources
 that support drift detection.
 








Class com.amazonaws.services.cloudformation.model.StackEvent extends Object implements Serializable


Serialized Fields


stackId
String stackId

 The unique ID name of the instance of the stack.
 


eventId
String eventId

 The unique ID of this event.
 


stackName
String stackName

 The name associated with a stack.
 


logicalResourceId
String logicalResourceId

 The logical name of the resource specified in the template.
 


physicalResourceId
String physicalResourceId

 The name or unique identifier associated with the physical instance of the resource.
 


resourceType
String resourceType

 Type of resource. (For more information, go to  AWS
 Resource Types Reference in the AWS CloudFormation User Guide.)
 


timestamp
Date timestamp

 Time the status was updated.
 


resourceStatus
String resourceStatus

 Current status of the resource.
 


resourceStatusReason
String resourceStatusReason

 Success/failure message associated with the resource.
 


resourceProperties
String resourceProperties

 BLOB of the properties used to create the resource.
 


clientRequestToken
String clientRequestToken

 The token passed to the operation that generated this event.
 
 
 All events triggered by a given stack operation are assigned the same client request token, which you can use to
 track operations. For example, if you execute a CreateStack operation with the token
 token1, then all the StackEvents generated by that operation will have
 ClientRequestToken set as token1.
 
 
 In the console, stack operations display the client request token on the Events tab. Stack operations that are
 initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
 the stack operation . For example, if you create a stack using the console, each stack event would be assigned
 the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
 








Class com.amazonaws.services.cloudformation.model.StackInstance extends Object implements Serializable


Serialized Fields


stackSetId
String stackSetId

 The name or unique ID of the stack set that the stack instance is associated with.
 


region
String region

 The name of the AWS region that the stack instance is associated with.
 


account
String account

 The name of the AWS account that the stack instance is associated with.
 


stackId
String stackId

 The ID of the stack instance.
 


parameterOverrides
SdkInternalList<T> parameterOverrides

 A list of parameters from the stack set template whose values have been overridden in this stack instance.
 


status
String status

 The status of the stack instance, in terms of its synchronization with its associated stack set.
 
 
 
 
 INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an
 unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might
 need to perform a DeleteStackInstances operation, with RetainStacks set to
 true, to delete the stack instance, and then delete the stack manually.
 
 
 
 
 OUTDATED: The stack isn't currently up to date with the stack set because:
 
 
 
 
 The associated stack failed during a CreateStackSet or UpdateStackSet operation.
 
 
 
 
 The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was
 stopped before the stack was created or updated.
 
 
 
 
 
 
 CURRENT: The stack is currently up to date with the stack set.
 
 
 


statusReason
String statusReason

 The explanation for the specific status code that is assigned to this stack instance.
 


driftStatus
String driftStatus

 Status of the stack instance's actual configuration compared to the expected template and parameter configuration
 of the stack set to which it belongs.
 
 
 
 
 DRIFTED: The stack differs from the expected template and parameter configuration of the stack set
 to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the
 associated stack have drifted.
 
 
 
 
 NOT_CHECKED: AWS CloudFormation has not checked if the stack instance differs from its expected
 stack set configuration.
 
 
 
 
 IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.
 
 
 
 
 UNKNOWN: This value is reserved for future use.
 
 
 


lastDriftCheckTimestamp
Date lastDriftCheckTimestamp

 Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will
 be NULL for any stack instance on which drift detection has not yet been performed.
 








Class com.amazonaws.services.cloudformation.model.StackInstanceNotFoundException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.StackInstanceSummary extends Object implements Serializable


Serialized Fields


stackSetId
String stackSetId

 The name or unique ID of the stack set that the stack instance is associated with.
 


region
String region

 The name of the AWS region that the stack instance is associated with.
 


account
String account

 The name of the AWS account that the stack instance is associated with.
 


stackId
String stackId

 The ID of the stack instance.
 


status
String status

 The status of the stack instance, in terms of its synchronization with its associated stack set.
 
 
 
 
 INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an
 unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might
 need to perform a DeleteStackInstances operation, with RetainStacks set to
 true, to delete the stack instance, and then delete the stack manually.
 
 
 
 
 OUTDATED: The stack isn't currently up to date with the stack set because:
 
 
 
 
 The associated stack failed during a CreateStackSet or UpdateStackSet operation.
 
 
 
 
 The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was
 stopped before the stack was created or updated.
 
 
 
 
 
 
 CURRENT: The stack is currently up to date with the stack set.
 
 
 


statusReason
String statusReason

 The explanation for the specific status code assigned to this stack instance.
 


driftStatus
String driftStatus

 Status of the stack instance's actual configuration compared to the expected template and parameter configuration
 of the stack set to which it belongs.
 
 
 
 
 DRIFTED: The stack differs from the expected template and parameter configuration of the stack set
 to which it belongs. A stack instance is considered to have drifted if one or more of the resources in the
 associated stack have drifted.
 
 
 
 
 NOT_CHECKED: AWS CloudFormation has not checked if the stack instance differs from its expected
 stack set configuration.
 
 
 
 
 IN_SYNC: The stack instance's actual configuration matches its expected stack set configuration.
 
 
 
 
 UNKNOWN: This value is reserved for future use.
 
 
 


lastDriftCheckTimestamp
Date lastDriftCheckTimestamp

 Most recent time when CloudFormation performed a drift detection operation on the stack instance. This value will
 be NULL for any stack instance on which drift detection has not yet been performed.
 








Class com.amazonaws.services.cloudformation.model.StackResource extends Object implements Serializable


Serialized Fields


stackName
String stackName

 The name associated with the stack.
 


stackId
String stackId

 Unique identifier of the stack.
 


logicalResourceId
String logicalResourceId

 The logical name of the resource specified in the template.
 


physicalResourceId
String physicalResourceId

 The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS
 CloudFormation.
 


resourceType
String resourceType

 Type of resource. (For more information, go to  AWS
 Resource Types Reference in the AWS CloudFormation User Guide.)
 


timestamp
Date timestamp

 Time the status was updated.
 


resourceStatus
String resourceStatus

 Current status of the resource.
 


resourceStatusReason
String resourceStatusReason

 Success/failure message associated with the resource.
 


description
String description

 User defined description associated with the resource.
 


driftInformation
StackResourceDriftInformation driftInformation

 Information about whether the resource's actual configuration differs, or has drifted, from its expected
 configuration, as defined in the stack template and any values specified as template parameters. For more
 information, see Detecting
 Unregulated Configuration Changes to Stacks and Resources.
 








Class com.amazonaws.services.cloudformation.model.StackResourceDetail extends Object implements Serializable


Serialized Fields


stackName
String stackName

 The name associated with the stack.
 


stackId
String stackId

 Unique identifier of the stack.
 


logicalResourceId
String logicalResourceId

 The logical name of the resource specified in the template.
 


physicalResourceId
String physicalResourceId

 The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS
 CloudFormation.
 


resourceType
String resourceType

 Type of resource. ((For more information, go to  AWS
 Resource Types Reference in the AWS CloudFormation User Guide.)
 


lastUpdatedTimestamp
Date lastUpdatedTimestamp

 Time the status was updated.
 


resourceStatus
String resourceStatus

 Current status of the resource.
 


resourceStatusReason
String resourceStatusReason

 Success/failure message associated with the resource.
 


description
String description

 User defined description associated with the resource.
 


metadata
String metadata

 The content of the Metadata attribute declared for the resource. For more information, see Metadata
 Attribute in the AWS CloudFormation User Guide.
 


driftInformation
StackResourceDriftInformation driftInformation

 Information about whether the resource's actual configuration differs, or has drifted, from its expected
 configuration, as defined in the stack template and any values specified as template parameters. For more
 information, see Detecting
 Unregulated Configuration Changes to Stacks and Resources.
 








Class com.amazonaws.services.cloudformation.model.StackResourceDrift extends Object implements Serializable


Serialized Fields


stackId
String stackId

 The ID of the stack.
 


logicalResourceId
String logicalResourceId

 The logical name of the resource specified in the template.
 


physicalResourceId
String physicalResourceId

 The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS
 CloudFormation.
 


physicalResourceIdContext
SdkInternalList<T> physicalResourceIdContext

 Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses
 context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify
 that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.
 


resourceType
String resourceType

 The type of the resource.
 


expectedProperties
String expectedProperties

 A JSON structure containing the expected property values of the stack resource, as defined in the stack template
 and any values specified as template parameters.
 
 
 For resources whose StackResourceDriftStatus is DELETED, this structure will not be
 present.
 


actualProperties
String actualProperties

 A JSON structure containing the actual property values of the stack resource.
 
 
 For resources whose StackResourceDriftStatus is DELETED, this structure will not be
 present.
 


propertyDifferences
SdkInternalList<T> propertyDifferences

 A collection of the resource properties whose actual values differ from their expected values. These will be
 present only for resources whose StackResourceDriftStatus is MODIFIED.
 


stackResourceDriftStatus
String stackResourceDriftStatus

 Status of the resource's actual configuration compared to its expected configuration
 
 
 
 
 DELETED: The resource differs from its expected template configuration because the resource has been
 deleted.
 
 
 
 
 MODIFIED: One or more resource properties differ from their expected values (as defined in the stack
 template and any values specified as template parameters).
 
 
 
 
 IN_SYNC: The resources's actual configuration matches its expected template configuration.
 
 
 
 
 NOT_CHECKED: AWS CloudFormation does not currently return this value.
 
 
 


timestamp
Date timestamp

 Time at which AWS CloudFormation performed drift detection on the stack resource.
 








Class com.amazonaws.services.cloudformation.model.StackResourceDriftInformation extends Object implements Serializable


Serialized Fields


stackResourceDriftStatus
String stackResourceDriftStatus

 Status of the resource's actual configuration compared to its expected configuration
 
 
 
 
 DELETED: The resource differs from its expected configuration in that it has been deleted.
 
 
 
 
 MODIFIED: The resource differs from its expected configuration.
 
 
 
 
 NOT_CHECKED: AWS CloudFormation has not checked if the resource differs from its expected
 configuration.
 
 
 Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more
 information, see Resources that Support Drift Detection.
 
 
 
 
 IN_SYNC: The resources's actual configuration matches its expected configuration.
 
 
 


lastCheckTimestamp
Date lastCheckTimestamp

 When AWS CloudFormation last checked if the resource had drifted from its expected configuration.
 








Class com.amazonaws.services.cloudformation.model.StackResourceDriftInformationSummary extends Object implements Serializable


Serialized Fields


stackResourceDriftStatus
String stackResourceDriftStatus

 Status of the resource's actual configuration compared to its expected configuration
 
 
 
 
 DELETED: The resource differs from its expected configuration in that it has been deleted.
 
 
 
 
 MODIFIED: The resource differs from its expected configuration.
 
 
 
 
 NOT_CHECKED: AWS CloudFormation has not checked if the resource differs from its expected
 configuration.
 
 
 Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more
 information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a
 stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED
 . For more information on skipping resources during rollback operations, see Continue Rolling Back an Update in the AWS CloudFormation User Guide.
 
 
 
 
 IN_SYNC: The resources's actual configuration matches its expected configuration.
 
 
 


lastCheckTimestamp
Date lastCheckTimestamp

 When AWS CloudFormation last checked if the resource had drifted from its expected configuration.
 








Class com.amazonaws.services.cloudformation.model.StackResourceSummary extends Object implements Serializable


Serialized Fields


logicalResourceId
String logicalResourceId

 The logical name of the resource specified in the template.
 


physicalResourceId
String physicalResourceId

 The name or unique identifier that corresponds to a physical instance ID of the resource.
 


resourceType
String resourceType

 Type of resource. (For more information, go to  AWS
 Resource Types Reference in the AWS CloudFormation User Guide.)
 


lastUpdatedTimestamp
Date lastUpdatedTimestamp

 Time the status was updated.
 


resourceStatus
String resourceStatus

 Current status of the resource.
 


resourceStatusReason
String resourceStatusReason

 Success/failure message associated with the resource.
 


driftInformation
StackResourceDriftInformationSummary driftInformation

 Information about whether the resource's actual configuration differs, or has drifted, from its expected
 configuration, as defined in the stack template and any values specified as template parameters. For more
 information, see Detecting
 Unregulated Configuration Changes to Stacks and Resources.
 








Class com.amazonaws.services.cloudformation.model.StackSet extends Object implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name that's associated with the stack set.
 


stackSetId
String stackSetId

 The ID of the stack set.
 


description
String description

 A description of the stack set that you specify when the stack set is created or updated.
 


status
String status

 The status of the stack set.
 


templateBody
String templateBody

 The structure that contains the body of the template that was used to create or update the stack set.
 


parameters
SdkInternalList<T> parameters

 A list of input parameters for a stack set.
 


capabilities
SdkInternalList<T> capabilities

 The capabilities that are allowed in the stack set. Some stack set 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 more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
 


tags
SdkInternalList<T> tags

 A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.
 


stackSetARN
String stackSetARN

 The Amazon Resource Number (ARN) of the stack set.
 


administrationRoleARN
String administrationRoleARN

 The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.
 
 
 Use customized administrator roles to control which users or groups can manage specific stack sets within the
 same administrator account. For more information, see Prerequisites:
 Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.
 


executionRoleName
String executionRoleName

 The name of the IAM execution role used to create or update the stack set.
 
 
 Use customized execution roles to control which stack resources users and groups can include in their stack sets.
 


stackSetDriftDetectionDetails
StackSetDriftDetectionDetails stackSetDriftDetectionDetails

 Detailed information about the drift status of the stack set.
 
 
 For stack sets, contains information about the last completed drift operation performed on the stack set.
 Information about drift operations currently in progress is not included.
 








Class com.amazonaws.services.cloudformation.model.StackSetDriftDetectionDetails extends Object implements Serializable


Serialized Fields


driftStatus
String driftStatus

 Status of the stack set's actual configuration compared to its expected template and parameter configuration. A
 stack set is considered to have drifted if one or more of its stack instances have drifted from their expected
 template and parameter configuration.
 
 
 
 
 DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the
 expected template and parameter configuration. A stack instance is considered to have drifted if one or more of
 the resources in the associated stack have drifted.
 
 
 
 
 NOT_CHECKED: AWS CloudFormation has not checked the stack set for drift.
 
 
 
 
 IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected
 template and parameter configuration.
 
 
 


driftDetectionStatus
String driftDetectionStatus

 The status of the stack set drift detection operation.
 
 
 
 
 COMPLETED: The drift detection operation completed without failing on any stack instances.
 
 
 
 
 FAILED: The drift detection operation exceeded the specified failure tolerance.
 
 
 
 
 PARTIAL_SUCCESS: The drift detection operation completed without exceeding the failure tolerance for
 the operation.
 
 
 
 
 IN_PROGRESS: The drift detection operation is currently being performed.
 
 
 
 
 STOPPED: The user has cancelled the drift detection operation.
 
 
 


lastDriftCheckTimestamp
Date lastDriftCheckTimestamp

 Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be
 NULL for any stack set on which drift detection has not yet been performed.
 


totalStackInstancesCount
Integer totalStackInstancesCount

 The total number of stack instances belonging to this stack set.
 
 
 The total number of stack instances is equal to the total of:
 
 
 
 
 Stack instances that match the stack set configuration.
 
 
 
 
 Stack instances that have drifted from the stack set configuration.
 
 
 
 
 Stack instances where the drift detection operation has failed.
 
 
 
 
 Stack instances currently being checked for drift.
 
 
 


driftedStackInstancesCount
Integer driftedStackInstancesCount

 The number of stack instances that have drifted from the expected template and parameter configuration of the
 stack set. A stack instance is considered to have drifted if one or more of the resources in the associated stack
 do not match their expected configuration.
 


inSyncStackInstancesCount
Integer inSyncStackInstancesCount

 The number of stack instances which match the expected template and parameter configuration of the stack set.
 


inProgressStackInstancesCount
Integer inProgressStackInstancesCount

 The number of stack instances that are currently being checked for drift.
 


failedStackInstancesCount
Integer failedStackInstancesCount

 The number of stack instances for which the drift detection operation failed.
 








Class com.amazonaws.services.cloudformation.model.StackSetNotEmptyException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.StackSetNotFoundException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.StackSetOperation extends Object implements Serializable


Serialized Fields


operationId
String operationId

 The unique ID of a stack set operation.
 


stackSetId
String stackSetId

 The ID of the stack set.
 


action
String action

 The type of stack set operation: CREATE, UPDATE, or DELETE. Create and
 delete operations affect only the specified stack set instances that are associated with the specified stack set.
 Update operations affect both the stack set itself, as well as all associated stack set instances.
 


status
String status

 The status of the operation.
 
 
 
 
 FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that
 you've set for an operation is applied for each region during stack create and update operations. If the number
 of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set
 to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS
 CloudFormation cancels the operation in any remaining regions.
 
 
 
 
 RUNNING: The operation is currently being performed.
 
 
 
 
 STOPPED: The user has cancelled the operation.
 
 
 
 
 STOPPING: The operation is in the process of stopping, at user request.
 
 
 
 
 SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding
 the failure tolerance for the operation.
 
 
 


operationPreferences
StackSetOperationPreferences operationPreferences

 The preferences for how AWS CloudFormation performs this stack set operation.
 


retainStacks
Boolean retainStacks

 For stack set operations of action type DELETE, specifies whether to remove the stack instances from
 the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack, or add an
 existing, saved stack to a new stack set.
 


administrationRoleARN
String administrationRoleARN

 The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation.
 
 
 Use customized administrator roles to control which users or groups can manage specific stack sets within the
 same administrator account. For more information, see Define Permissions
 for Multiple Administrators in the AWS CloudFormation User Guide.
 


executionRoleName
String executionRoleName

 The name of the IAM execution role used to create or update the stack set.
 
 
 Use customized execution roles to control which stack resources users and groups can include in their stack sets.
 


creationTimestamp
Date creationTimestamp

 The time at which the operation was initiated. Note that the creation times for the stack set operation might
 differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to
 perform preparatory work for the operation, such as dispatching the work to the requested regions, before
 actually creating the first stacks.
 


endTimestamp
Date endTimestamp

 The time at which the stack set operation ended, across all accounts and regions specified. Note that this
 doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or
 region.
 


stackSetDriftDetectionDetails
StackSetDriftDetectionDetails stackSetDriftDetectionDetails

 Detailed information about the drift status of the stack set. This includes information about drift operations
 currently being performed on the stack set.
 
 
 this information will only be present for stack set operations whose Action type is
 DETECT_DRIFT.
 
 
 For more information, see Detecting Unmanaged
 Changes in Stack Sets in the AWS CloudFormation User Guide.
 








Class com.amazonaws.services.cloudformation.model.StackSetOperationPreferences extends Object implements Serializable


Serialized Fields


regionOrder
SdkInternalList<T> regionOrder

 The order of the regions in where you want to perform the stack operation.
 


failureToleranceCount
Integer failureToleranceCount

 The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the
 operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the
 operation in any subsequent regions.
 
 
 Conditional: You must specify either FailureToleranceCount or
 FailureTolerancePercentage (but not both).
 


failureTolerancePercentage
Integer failureTolerancePercentage

 The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops
 the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the
 operation in any subsequent regions.
 
 
 When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down
 to the next whole number.
 
 
 Conditional: You must specify either FailureToleranceCount or
 FailureTolerancePercentage, but not both.
 


maxConcurrentCount
Integer maxConcurrentCount

 The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of
 FailureToleranceCount—MaxConcurrentCount is at most one more than the
 FailureToleranceCount .
 
 
 Note that this setting lets you specify the maximum for operations. For large deployments, under certain
 circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
 
 
 Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but
 not both.
 


maxConcurrentPercentage
Integer maxConcurrentPercentage

 The maximum percentage of accounts in which to perform this operation at one time.
 
 
 When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the
 next whole number. This is true except in cases where rounding down would result is zero. In this case,
 CloudFormation sets the number as one instead.
 
 
 Note that this setting lets you specify the maximum for operations. For large deployments, under certain
 circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
 
 
 Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but
 not both.
 








Class com.amazonaws.services.cloudformation.model.StackSetOperationResultSummary extends Object implements Serializable


Serialized Fields


account
String account

 The name of the AWS account for this operation result.
 


region
String region

 The name of the AWS region for this operation result.
 


status
String status

 The result status of the stack set operation for the given account in the given region.
 
 
 
 
 CANCELLED: The operation in the specified account and region has been cancelled. This is either
 because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation
 has been exceeded.
 
 
 
 
 FAILED: The operation in the specified account and region failed.
 
 
 If the stack set operation fails in enough accounts within a region, the failure tolerance for the stack set
 operation as a whole might be exceeded.
 
 
 
 
 RUNNING: The operation in the specified account and region is currently in progress.
 
 
 
 
 PENDING: The operation in the specified account and region has yet to start.
 
 
 
 
 SUCCEEDED: The operation in the specified account and region completed successfully.
 
 
 


statusReason
String statusReason

 The reason for the assigned result status.
 


accountGateResult
AccountGateResult accountGateResult

 The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set
 operations in an account
 








Class com.amazonaws.services.cloudformation.model.StackSetOperationSummary extends Object implements Serializable


Serialized Fields


operationId
String operationId

 The unique ID of the stack set operation.
 


action
String action

 The type of operation: CREATE, UPDATE, or DELETE. Create and delete
 operations affect only the specified stack instances that are associated with the specified stack set. Update
 operations affect both the stack set itself as well as all associated stack set instances.
 


status
String status

 The overall status of the operation.
 
 
 
 
 FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that
 you've set for an operation is applied for each region during stack create and update operations. If the number
 of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set
 to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS
 CloudFormation cancels the operation in any remaining regions.
 
 
 
 
 RUNNING: The operation is currently being performed.
 
 
 
 
 STOPPED: The user has cancelled the operation.
 
 
 
 
 STOPPING: The operation is in the process of stopping, at user request.
 
 
 
 
 SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding
 the failure tolerance for the operation.
 
 
 


creationTimestamp
Date creationTimestamp

 The time at which the operation was initiated. Note that the creation times for the stack set operation might
 differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to
 perform preparatory work for the operation, such as dispatching the work to the requested regions, before
 actually creating the first stacks.
 


endTimestamp
Date endTimestamp

 The time at which the stack set operation ended, across all accounts and regions specified. Note that this
 doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or
 region.
 








Class com.amazonaws.services.cloudformation.model.StackSetSummary extends Object implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name of the stack set.
 


stackSetId
String stackSetId

 The ID of the stack set.
 


description
String description

 A description of the stack set that you specify when the stack set is created or updated.
 


status
String status

 The status of the stack set.
 


driftStatus
String driftStatus

 Status of the stack set's actual configuration compared to its expected template and parameter configuration. A
 stack set is considered to have drifted if one or more of its stack instances have drifted from their expected
 template and parameter configuration.
 
 
 
 
 DRIFTED: One or more of the stack instances belonging to the stack set stack differs from the
 expected template and parameter configuration. A stack instance is considered to have drifted if one or more of
 the resources in the associated stack have drifted.
 
 
 
 
 NOT_CHECKED: AWS CloudFormation has not checked the stack set for drift.
 
 
 
 
 IN_SYNC: All of the stack instances belonging to the stack set stack match from the expected
 template and parameter configuration.
 
 
 
 
 UNKNOWN: This value is reserved for future use.
 
 
 


lastDriftCheckTimestamp
Date lastDriftCheckTimestamp

 Most recent time when CloudFormation performed a drift detection operation on the stack set. This value will be
 NULL for any stack set on which drift detection has not yet been performed.
 








Class com.amazonaws.services.cloudformation.model.StackSummary extends Object implements Serializable


Serialized Fields


stackId
String stackId

 Unique stack identifier.
 


stackName
String stackName

 The name associated with the stack.
 


templateDescription
String templateDescription

 The template description of the template used to create the stack.
 


creationTime
Date creationTime

 The time the stack was created.
 


lastUpdatedTime
Date lastUpdatedTime

 The time the stack was last updated. This field will only be returned if the stack has been updated at least
 once.
 


deletionTime
Date deletionTime

 The time the stack was deleted.
 


stackStatus
String stackStatus

 The current status of the stack.
 


stackStatusReason
String stackStatusReason

 Success/Failure message associated with the stack status.
 


parentId
String parentId

 For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this
 stack. For the first level of nested stacks, the root stack is also the parent stack.
 
 
 For more information, see Working with
 Nested Stacks in the AWS CloudFormation User Guide.
 


rootId
String rootId

 For nested stacks--stacks created as resources for another stack--the stack ID of the top-level stack to which
 the nested stack ultimately belongs.
 
 
 For more information, see Working with
 Nested Stacks in the AWS CloudFormation User Guide.
 


driftInformation
StackDriftInformationSummary driftInformation

 Summarizes information on whether a stack's actual configuration differs, or has drifted, from it's
 expected configuration, as defined in the stack template and any values specified as template parameters. For
 more information, see Detecting
 Unregulated Configuration Changes to Stacks and Resources.
 








Class com.amazonaws.services.cloudformation.model.StaleRequestException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.StopStackSetOperationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name or unique ID of the stack set that you want to stop the operation for.
 


operationId
String operationId

 The ID of the stack operation.
 








Class com.amazonaws.services.cloudformation.model.StopStackSetOperationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudformation.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key.
 Tags owned by Amazon Web Services (AWS) have the reserved prefix: aws:.
 


value
String value

 Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a
 tag value.
 








Class com.amazonaws.services.cloudformation.model.TemplateParameter extends Object implements Serializable


Serialized Fields


parameterKey
String parameterKey

 The name associated with the parameter.
 


defaultValue
String defaultValue

 The default value associated with the parameter.
 


noEcho
Boolean noEcho

 Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
 


description
String description

 User defined description associated with the parameter.
 








Class com.amazonaws.services.cloudformation.model.TokenAlreadyExistsException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.TypeNotFoundException extends AmazonCloudFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudformation.model.TypeSummary extends Object implements Serializable


Serialized Fields


type
String type

 The kind of type.
 


typeName
String typeName

 The name of the type.
 


defaultVersionId
String defaultVersionId

 The ID of the default version of the type. The default version is used when the type version is not specified.
 
 
 To set the default version of a type, use  SetTypeDefaultVersion .
 


typeArn
String typeArn

 The Amazon Resource Name (ARN) of the type.
 


lastUpdated
Date lastUpdated

 When the current default version of the type was registered.
 


description
String description

 The description of the type.
 








Class com.amazonaws.services.cloudformation.model.TypeVersionSummary extends Object implements Serializable


Serialized Fields


type
String type

 The kind of type.
 


typeName
String typeName

 The name of the type.
 


versionId
String versionId

 The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name
 (ARN) assigned to the type version when it is registered.
 


arn
String arn

 The Amazon Resource Name (ARN) of the type version.
 


timeCreated
Date timeCreated

 When the version was registered.
 


description
String description

 The description of the type version.
 








Class com.amazonaws.services.cloudformation.model.UpdateStackInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name or unique ID of the stack set associated with the stack instances.
 


accounts
SdkInternalList<T> accounts

 The names of one or more AWS accounts for which you want to update parameter values for stack instances. The
 overridden parameter values will be applied to all stack instances in the specified accounts and regions.
 


regions
SdkInternalList<T> regions

 The names of one or more regions in which you want to update parameter values for stack instances. The overridden
 parameter values will be applied to all stack instances in the specified accounts and regions.
 


parameterOverrides
SdkInternalList<T> parameterOverrides

 A list of input parameters whose values you want to update for the specified stack instances.
 
 
 Any overridden parameter values will be applied to all stack instances in the specified accounts and regions.
 When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during
 stack instance update operations:
 
 
 
 
 To override the current value for a parameter, include the parameter and specify its value.
 
 
 
 
 To leave a parameter set to its present value, you can do one of the following:
 
 
 
 
 Do not include the parameter in the list.
 
 
 
 
 Include the parameter and specify UsePreviousValue as true. (You cannot specify both a
 value and set UsePreviousValue to true.)
 
 
 
 
 
 
 To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do
 not include any parameters.
 
 
 
 
 To leave all parameters set to their present values, do not specify this property at all.
 
 
 
 
 During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their
 overridden value.
 
 
 You can only override the parameter values that are specified in the stack set; to add or delete a
 parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a
 template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the
 stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter
 value using UpdateStackInstances.
 


operationPreferences
StackSetOperationPreferences operationPreferences

 Preferences for how AWS CloudFormation performs this stack set operation.
 


operationId
String operationId

 The unique identifier for this stack set operation.
 
 
 The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set
 operation only once, even if you retry the request multiple times. You might retry stack set operation requests
 to ensure that AWS CloudFormation successfully received them.
 
 
 If you don't specify an operation ID, the SDK generates one automatically.
 








Class com.amazonaws.services.cloudformation.model.UpdateStackInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operationId
String operationId

 The unique identifier for this stack set operation.
 








Class com.amazonaws.services.cloudformation.model.UpdateStackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackName
String stackName

 The name or unique stack ID of the stack to update.
 


templateBody
String templateBody

 Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For
 more information, go to Template Anatomy
 in the AWS CloudFormation User Guide.)
 
 
 Conditional: You must specify only one of the following parameters: TemplateBody,
 TemplateURL, or set the UsePreviousTemplate to true.
 


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 only one of the following parameters: TemplateBody,
 TemplateURL, or set the UsePreviousTemplate to true.
 


usePreviousTemplate
Boolean usePreviousTemplate

 Reuse the existing template that is associated with the stack that you are updating.
 
 
 Conditional: You must specify only one of the following parameters: TemplateBody,
 TemplateURL, or set the UsePreviousTemplate to true.
 


stackPolicyDuringUpdateBody
String stackPolicyDuringUpdateBody

 Structure containing the temporary overriding stack policy body. You can specify either the
 StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
 
 
 If you want to update protected resources, specify a temporary overriding stack policy during this update. If you
 do not specify a stack policy, the current policy that is associated with the stack will be used.
 


stackPolicyDuringUpdateURL
String stackPolicyDuringUpdateURL

 Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size:
 16KB) located in an S3 bucket in the same region as the stack. You can specify either the
 StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.
 
 
 If you want to update protected resources, specify a temporary overriding stack policy during this update. If you
 do not specify a stack policy, the current policy that is associated with the stack will be used.
 


parameters
SdkInternalList<T> parameters

 A list of Parameter structures that specify input parameters for the stack. For more information,
 see the Parameter data
 type.
 


capabilities
SdkInternalList<T> capabilities

 In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
 for AWS CloudFormation to update the stack.
 
 
 
 
 CAPABILITY_IAM and CAPABILITY_NAMED_IAM
 
 
 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
 this by specifying one of these capabilities.
 
 
 The following IAM resources require you to specify either the CAPABILITY_IAM or
 CAPABILITY_NAMED_IAM capability.
 
 
 
 
 If you have IAM resources, you can specify either capability.
 
 
 
 
 If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
 
 
 
 
 If you don't specify either of these capabilities, AWS CloudFormation returns an
 InsufficientCapabilities error.
 
 
 
 
 If your stack template contains these resources, we recommend that you review all permissions associated with
 them and edit their permissions if necessary.
 
 
 
 
 
 AWS::IAM::AccessKey
 
 
 
 
 
 AWS::IAM::Group
 
 
 
 
 
 AWS::IAM::InstanceProfile
 
 
 
 
 
 AWS::IAM::Policy
 
 
 
 
 
 AWS::IAM::Role
 
 
 
 
 
 AWS::IAM::User
 
 
 
 
 
 AWS::IAM::UserToGroupAddition
 
 
 
 
 For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
 
 
 
 
 CAPABILITY_AUTO_EXPAND
 
 
 Some template contain macros. Macros perform custom processing on templates; this can include simple actions like
 find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users
 typically create a change set from the processed template, so that they can review the changes resulting from the
 macros before actually updating the stack. If your stack template contains one or more macros, and you choose to
 update a stack directly from the processed template, without first reviewing the resulting changes in a change
 set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.
 
 
 Change sets do not currently support nested stacks. If you want to update a stack from a stack template that
 contains macros and nested stacks, you must update the stack directly from the template using this
 capability.
 
 
 
 You should only update stacks directly from a stack template that contains macros if you know what processing the
 macro performs.
 
 
 Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the
 Lambda function owner can update the function operation without AWS CloudFormation being notified.
 
 
 
 For more information, see Using AWS
 CloudFormation Macros to Perform Custom Processing on Templates.
 
 
 


resourceTypes
SdkInternalList<T> resourceTypes

 The template resource types that you have permissions to work with for this update stack action, such as
 AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
 
 
 If the list of resource types doesn't include a resource that you're updating, the stack update fails. By
 default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM)
 uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access
 with AWS Identity and Access Management.
 


roleARN
String roleARN

 The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation
 assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS
 CloudFormation always uses this role for all future operations on the stack. As long as users have permission to
 operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it.
 Ensure that the role grants least privilege.
 
 
 If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If
 no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.
 


rollbackConfiguration
RollbackConfiguration rollbackConfiguration

 The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for
 the specified monitoring period afterwards.
 


stackPolicyBody
String stackPolicyBody

 Structure containing a new stack policy body. You can specify either the StackPolicyBody or the
 StackPolicyURL parameter, but not both.
 
 
 You might update the stack policy, for example, in order to protect a new resource that you created during a
 stack update. If you do not specify a stack policy, the current policy that is associated with the stack is
 unchanged.
 


stackPolicyURL
String stackPolicyURL

 Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located
 in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the
 StackPolicyURL parameter, but not both.
 
 
 You might update the stack policy, for example, in order to protect a new resource that you created during a
 stack update. If you do not specify a stack policy, the current policy that is associated with the stack is
 unchanged.
 


notificationARNs
SdkInternalList<T> notificationARNs

 Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the
 stack. Specify an empty list to remove all notification topics.
 


tags
SdkInternalList<T> tags

 Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported
 resources in the stack. You can specify a maximum number of 50 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.
 


clientRequestToken
String clientRequestToken

 A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests
 so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry
 UpdateStack requests to ensure that AWS CloudFormation successfully received them.
 
 
 All events triggered by a given stack operation are assigned the same client request token, which you can use to
 track operations. For example, if you execute a CreateStack operation with the token
 token1, then all the StackEvents generated by that operation will have
 ClientRequestToken set as token1.
 
 
 In the console, stack operations display the client request token on the Events tab. Stack operations that are
 initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify
 the stack operation . For example, if you create a stack using the console, each stack event would be assigned
 the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.
 








Class com.amazonaws.services.cloudformation.model.UpdateStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackId
String stackId

 Unique identifier of the stack.
 








Class com.amazonaws.services.cloudformation.model.UpdateStackSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackSetName
String stackSetName

 The name or unique ID of the stack set that you want to update.
 


description
String description

 A brief description of updates that you are making.
 


templateBody
String templateBody

 The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200
 bytes. For more information, see Template Anatomy
 in the AWS CloudFormation User Guide.
 
 
 Conditional: You must specify only one of the following parameters: TemplateBody or
 TemplateURL—or set UsePreviousTemplate to true.
 


templateURL
String templateURL

 The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800
 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy
 in the AWS CloudFormation User Guide.
 
 
 Conditional: You must specify only one of the following parameters: TemplateBody or
 TemplateURL—or set UsePreviousTemplate to true.
 


usePreviousTemplate
Boolean usePreviousTemplate

 Use the existing template that's associated with the stack set that you're updating.
 
 
 Conditional: You must specify only one of the following parameters: TemplateBody or
 TemplateURL—or set UsePreviousTemplate to true.
 


parameters
SdkInternalList<T> parameters

 A list of input parameters for the stack set template.
 


capabilities
SdkInternalList<T> capabilities

 In some cases, you must explicitly acknowledge that your stack template contains certain capabilities in order
 for AWS CloudFormation to update the stack set and its associated stack instances.
 
 
 
 
 CAPABILITY_IAM and CAPABILITY_NAMED_IAM
 
 
 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 sets, you must explicitly
 acknowledge this by specifying one of these capabilities.
 
 
 The following IAM resources require you to specify either the CAPABILITY_IAM or
 CAPABILITY_NAMED_IAM capability.
 
 
 
 
 If you have IAM resources, you can specify either capability.
 
 
 
 
 If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.
 
 
 
 
 If you don't specify either of these capabilities, AWS CloudFormation returns an
 InsufficientCapabilities error.
 
 
 
 
 If your stack template contains these resources, we recommend that you review all permissions associated with
 them and edit their permissions if necessary.
 
 
 
 
 
 AWS::IAM::AccessKey
 
 
 
 
 
 AWS::IAM::Group
 
 
 
 
 
 AWS::IAM::InstanceProfile
 
 
 
 
 
 AWS::IAM::Policy
 
 
 
 
 
 AWS::IAM::Role
 
 
 
 
 
 AWS::IAM::User
 
 
 
 
 
 AWS::IAM::UserToGroupAddition
 
 
 
 
 For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
 
 
 
 
 CAPABILITY_AUTO_EXPAND
 
 
 Some templates contain macros. If your stack template contains one or more macros, and you choose to update a
 stack directly from the processed template, without first reviewing the resulting changes in a change set, you
 must acknowledge this capability. For more information, see Using AWS
 CloudFormation Macros to Perform Custom Processing on Templates.
 
 
 
 Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this
 capability, if you include a macro in your template the stack set operation will fail.
 
 
 


tags
SdkInternalList<T> tags

 The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also
 propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of
 50 tags.
 
 
 If you specify tags for this parameter, those tags replace any list of tags that are currently associated with
 this stack set. This means:
 
 
 
 
 If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.
 
 
 
 
 If you specify any tags using this parameter, you must specify all the tags that you want
 associated with this stack set, even tags you've specifed before (for example, when creating the stack set or
 during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are
 removed from the stack set, and therefore from the stacks and resources as well.
 
 
 
 
 If you specify an empty value, AWS CloudFormation removes all currently associated tags.
 
 
 
 
 If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you
 have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack
 set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the
 stack set, and checks to see if you have permission to untag resources. If you don't have the necessary
 permission(s), the entire UpdateStackSet action fails with an access denied error, and
 the stack set is not updated.
 


operationPreferences
StackSetOperationPreferences operationPreferences

 Preferences for how AWS CloudFormation performs this stack set operation.
 


administrationRoleARN
String administrationRoleARN

 The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.
 
 
 Specify an IAM role only if you are using customized administrator roles to control which users or groups can
 manage specific stack sets within the same administrator account. For more information, see Granting Permissions
 for Stack Set Operations in the AWS CloudFormation User Guide.
 
 
 If you specified a customized administrator role when you created the stack set, you must specify a customized
 administrator role, even if it is the same customized administrator role used with this stack set previously.
 


executionRoleName
String executionRoleName

 The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS
 CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
 
 
 Specify an IAM role only if you are using customized execution roles to control which stack resources users and
 groups can include in their stack sets.
 
 
 If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not
 specify a customized execution role, AWS CloudFormation performs the update using the role previously associated
 with the stack set, so long as you have permissions to perform operations on the stack set.
 


operationId
String operationId

 The unique ID for this stack set operation.
 
 
 The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set
 operation only once, even if you retry the request multiple times. You might retry stack set operation requests
 to ensure that AWS CloudFormation successfully received them.
 
 
 If you don't specify an operation ID, AWS CloudFormation generates one automatically.
 
 
 Repeating this stack set operation with a new operation ID retries all stack instances whose status is
 OUTDATED.
 


accounts
SdkInternalList<T> accounts

 The accounts in which to update associated stack instances. If you specify accounts, you must also specify the
 regions in which to update stack set instances.
 
 
 To update all the stack instances associated with this stack set, do not specify the Accounts
 or Regions properties.
 
 
 If the stack set update includes changes to the template (that is, if the TemplateBody or
 TemplateURL properties are specified), or the Parameters property, AWS CloudFormation
 marks all stack instances with a status of OUTDATED prior to updating the stack instances in the
 specified accounts and regions. If the stack set update does not include changes to the template or parameters,
 AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other
 stack instances with their existing stack instance status.
 


regions
SdkInternalList<T> regions

 The regions in which to update associated stack instances. If you specify regions, you must also specify accounts
 in which to update stack set instances.
 
 
 To update all the stack instances associated with this stack set, do not specify the Accounts
 or Regions properties.
 
 
 If the stack set update includes changes to the template (that is, if the TemplateBody or
 TemplateURL properties are specified), or the Parameters property, AWS CloudFormation
 marks all stack instances with a status of OUTDATED prior to updating the stack instances in the
 specified accounts and regions. If the stack set update does not include changes to the template or parameters,
 AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other
 stack instances with their existing stack instance status.
 








Class com.amazonaws.services.cloudformation.model.UpdateStackSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operationId
String operationId

 The unique ID for this stack set operation.
 








Class com.amazonaws.services.cloudformation.model.UpdateTerminationProtectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


enableTerminationProtection
Boolean enableTerminationProtection

 Whether to enable termination protection on the specified stack.
 


stackName
String stackName

 The name or unique ID of the stack for which you want to set termination protection.
 








Class com.amazonaws.services.cloudformation.model.UpdateTerminationProtectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackId
String stackId

 The unique ID of the stack.
 








Class com.amazonaws.services.cloudformation.model.ValidateTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateBody
String templateBody

 Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
 more information, go to Template Anatomy
 in the AWS CloudFormation User Guide.
 
 
 Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only
 TemplateBody is used.
 


templateURL
String templateURL

 Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is
 located in an Amazon S3 bucket. For more information, go to Template Anatomy
 in the AWS CloudFormation User Guide.
 
 
 Conditional: You must pass TemplateURL or TemplateBody. If both are passed, only
 TemplateBody is used.
 








Class com.amazonaws.services.cloudformation.model.ValidateTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


parameters
SdkInternalList<T> parameters

 A list of TemplateParameter structures.
 


description
String description

 The description found within the template.
 


capabilities
SdkInternalList<T> capabilities

 The capabilities found within the template. If your template contains IAM resources, you must specify the
 CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or
 UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.
 
 
 For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
 


capabilitiesReason
String capabilitiesReason

 The list of resources that generated the values in the Capabilities response element.
 


declaredTransforms
SdkInternalList<T> declaredTransforms

 A list of the transforms that are declared in the template.
 








Package com.amazonaws.services.cloudfront.model




Class com.amazonaws.services.cloudfront.model.AccessDeniedException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.ActiveTrustedSigners extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type
 for this distribution have active CloudFront key pairs. If not, Enabled is false.
 


quantity
Integer quantity

 The number of trusted signers specified in the TrustedSigners complex type.
 


items
SdkInternalList<T> items

 A complex type that contains one Signer complex type for each trusted signer that is specified in
 the TrustedSigners complex type.
 








Class com.amazonaws.services.cloudfront.model.Aliases extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of CNAME aliases, if any, that you want to associate with this distribution.
 


items
SdkInternalList<T> items

 A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.
 








Class com.amazonaws.services.cloudfront.model.AliasICPRecordal extends Object implements Serializable


Serialized Fields


cNAME
String cNAME

 A domain name associated with a distribution.
 


iCPRecordalStatus
String iCPRecordalStatus

 The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all
 CNAMEs (aliases) in regions outside of China.
 
 
 The status values returned are the following:
 
 
 
 
 APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be
 associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED,
 that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.
 
 
 
 
 SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.
 
 
 
 
 PENDING indicates that CloudFront can't determine the ICP recordal status of the CNAME associated with the
 distribution because there was an error in trying to determine the status. You can try again to see if the error
 is resolved in which case CloudFront returns an APPROVED or SUSPENDED status.
 
 
 








Class com.amazonaws.services.cloudfront.model.AllowedMethods extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for
 GET and HEAD requests), 3 (for GET, HEAD, and
 OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and
 DELETE requests).
 


items
SdkInternalList<T> items

 A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
 


cachedMethods
CachedMethods cachedMethods








Class com.amazonaws.services.cloudfront.model.AmazonCloudFrontException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.BatchTooLargeException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.CacheBehavior extends Object implements Serializable


Serialized Fields


pathPattern
String pathPattern

 The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When
 CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which
 cache behaviors are listed in the distribution.
 
 
 
 You can optionally include a slash (/) at the beginning of the path pattern. For example,
 /images/*.jpg. CloudFront behavior is the same with or without the leading /.
 
 
 
 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.
 
 
 For more information, see Path Pattern in the  Amazon CloudFront Developer Guide.
 


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 in your distribution.
 


forwardedValues
ForwardedValues forwardedValues

 A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
 


trustedSigners
TrustedSigners trustedSigners

 A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private
 content.
 
 
 If you want to require signed URLs in requests for objects in the target origin that match the
 PathPattern for this cache behavior, specify true for Enabled, and specify
 the applicable values for Quantity and Items. For more information, see Serving Private
 Content through CloudFront 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

 The protocol that viewers can use to access the files in the origin specified by TargetOriginId when
 a request matches the path pattern in PathPattern. You can specify the following options:
 
 
 
 
 allow-all: Viewers can use HTTP or HTTPS.
 
 
 
 
 redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of
 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the
 new URL.
 
 
 
 
 https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403
 (Forbidden).
 
 
 
 
 For more information about requiring the HTTPS protocol, see Using an HTTPS
 Connection to Access Your Objects in the Amazon CloudFront Developer Guide.
 
 
 
 The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never
 to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that
 you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will
 return an object from the cache regardless of whether the current request protocol matches the protocol used
 previously. For more information, see Managing How Long
 Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
 
 


minTTL
Long minTTL

 The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another
 request to your origin to determine whether the object has been updated. For more information, see  Managing How Long
 Content Stays in an Edge Cache (Expiration) in the  Amazon CloudFront Developer Guide.
 
 
 You must specify 0 for MinTTL if you configure CloudFront to forward all headers to
 your origin (under Headers, if you specify 1 for Quantity and
 * for Name).
 


allowedMethods
AllowedMethods allowedMethods


smoothStreaming
Boolean smoothStreaming

 Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin
 that is associated with this cache behavior. If so, specify true; if not, specify false
 . If you specify true for SmoothStreaming, you can still distribute other content using
 this cache behavior if the content matches the value of PathPattern.
 


defaultTTL
Long defaultTTL

 The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long
 Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
 


maxTTL
Long maxTTL

 The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long
 Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
 


compress
Boolean compress

 Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true;
 if not, specify false. For more information, see Serving
 Compressed Files in the Amazon CloudFront Developer Guide.
 


lambdaFunctionAssociations
LambdaFunctionAssociations lambdaFunctionAssociations

 A complex type that contains zero or more Lambda function associations for a cache behavior.
 


fieldLevelEncryptionId
String fieldLevelEncryptionId

 The value of ID for the field-level encryption configuration that you want CloudFront to use for
 encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.
 








Class com.amazonaws.services.cloudfront.model.CacheBehaviors extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of cache behaviors for this distribution.
 


items
SdkInternalList<T> items

 Optional: A complex type that contains cache behaviors for this distribution. If Quantity is
 0, you can omit Items.
 








Class com.amazonaws.services.cloudfront.model.CachedMethods extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for
 caching responses to GET and HEAD requests) and 3 (for caching responses
 to GET, HEAD, and OPTIONS requests).
 


items
SdkInternalList<T> items

 A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
 








Class com.amazonaws.services.cloudfront.model.CannotChangeImmutablePublicKeyFieldsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentity extends Object implements Serializable


Serialized Fields


id
String id

 The ID for the origin access identity, for example, E74FTE3AJFJ256A.
 


s3CanonicalUserId
String s3CanonicalUserId

 The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read
 permission to an object in Amazon S3.
 


cloudFrontOriginAccessIdentityConfig
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig

 The current configuration information for the identity.
 








Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityAlreadyExistsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityConfig extends Object implements Serializable


Serialized Fields


callerReference
String callerReference

 A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
 
 
 If the value of CallerReference is new (regardless of the content of the
 CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.
 
 
 If the CallerReference is a value already sent in a previous identity request, and the content of
 the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white
 space), the response includes the same information returned to the original request.
 
 
 If the CallerReference is a value you already sent in a previous request to create an identity, but
 the content of the CloudFrontOriginAccessIdentityConfig is different from the original request,
 CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.
 


comment
String comment

 Any comments you want to include about the origin access identity.
 








Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityInUseException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityList extends Object 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).
 


nextMarker
String nextMarker

 If IsTruncated is true, this element is present and contains the value you can use for
 the Marker request parameter to continue listing your origin access identities where they left off.
 


maxItems
Integer maxItems

 The maximum number of origin access identities you want in the response body.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether more origin access identities remain to be listed. If your results were truncated,
 you can make a follow-up pagination request using the Marker request parameter to retrieve more
 items in the list.
 


quantity
Integer quantity

 The number of CloudFront origin access identities that were created by the current AWS account.
 


items
SdkInternalList<T> items

 A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin
 access identity that was created by the current AWS account.
 








Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentitySummary extends Object implements Serializable


Serialized Fields


id
String id

 The ID for the origin access identity. For example: E74FTE3AJFJ256A.
 


s3CanonicalUserId
String s3CanonicalUserId

 The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access
 identity read permission to an object in Amazon S3.
 


comment
String comment

 The comment for this origin access identity, as originally specified when created.
 








Class com.amazonaws.services.cloudfront.model.CNAMEAlreadyExistsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.ContentTypeProfile extends Object implements Serializable


Serialized Fields


format
String format

 The format for a field-level encryption content type-profile mapping.
 


profileId
String profileId

 The profile ID for a field-level encryption content type-profile mapping.
 


contentType
String contentType

 The content type for a field-level encryption content type-profile mapping.
 








Class com.amazonaws.services.cloudfront.model.ContentTypeProfileConfig extends Object implements Serializable


Serialized Fields


forwardWhenContentTypeIsUnknown
Boolean forwardWhenContentTypeIsUnknown

 The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown
 content type is provided for the profile. If true, content is forwarded without being encrypted when the content
 type is unknown. If false (the default), an error is returned when the content type is unknown.
 


contentTypeProfiles
ContentTypeProfiles contentTypeProfiles

 The configuration for a field-level encryption content type-profile.
 








Class com.amazonaws.services.cloudfront.model.ContentTypeProfiles extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of field-level encryption content type-profile mappings.
 


items
SdkInternalList<T> items

 Items in a field-level encryption content type-profile mapping.
 








Class com.amazonaws.services.cloudfront.model.CookieNames extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of different cookies that you want CloudFront to forward to the origin for this cache behavior. The
 value must equal the number of items that are in the Items field.
 
 
 When you set Forward = whitelist (in the CookiePreferences object), this value must be
 1 or higher.
 


items
SdkInternalList<T> items

 A complex type that contains one Name element for each cookie that you want CloudFront to forward to
 the origin for this cache behavior. It must contain the same number of items that is specified in the
 Quantity field.
 
 
 When you set Forward = whitelist (in the CookiePreferences object), this field must
 contain at least one item.
 








Class com.amazonaws.services.cloudfront.model.CookiePreference extends Object implements Serializable


Serialized Fields


forward
String forward

 Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies
 specified in the WhitelistedNames complex type.
 
 
 Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify
 none for the Forward element.
 


whitelistedNames
CookieNames whitelistedNames

 Required if you specify whitelist for the value of Forward. A complex type that
 specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if
 you want to forward selected cookies, the names of those cookies.
 
 
 If you specify all or none for the value of Forward, omit
 WhitelistedNames. If you change the value of Forward from whitelist to
 all or none and you don't delete the WhitelistedNames element and its
 child elements, CloudFront deletes them automatically.
 
 
 For the current limit on the number of cookie names that you can whitelist for each cache behavior, see  CloudFront
 Limits in the AWS General Reference.
 








Class com.amazonaws.services.cloudfront.model.CreateCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cloudFrontOriginAccessIdentityConfig
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig

 The current configuration information for the identity.
 








Class com.amazonaws.services.cloudfront.model.CreateCloudFrontOriginAccessIdentityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cloudFrontOriginAccessIdentity
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity

 The origin access identity's information.
 


location
String location

 The fully qualified URI of the new origin access identity just created. For example:
 https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.
 


eTag
String eTag

 The current version of the origin access identity created.
 








Class com.amazonaws.services.cloudfront.model.CreateDistributionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


distributionConfig
DistributionConfig distributionConfig

 The distribution's configuration information.
 








Class com.amazonaws.services.cloudfront.model.CreateDistributionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


distribution
Distribution distribution

 The distribution's information.
 


location
String location

 The fully qualified URI of the new distribution resource just created. For example:
 https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.
 


eTag
String eTag

 The current version of the distribution created.
 








Class com.amazonaws.services.cloudfront.model.CreateDistributionWithTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


distributionConfigWithTags
DistributionConfigWithTags distributionConfigWithTags

 The distribution's configuration information.
 








Class com.amazonaws.services.cloudfront.model.CreateDistributionWithTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


distribution
Distribution distribution

 The distribution's information.
 


location
String location

 The fully qualified URI of the new distribution resource just created. For example:
 https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.
 


eTag
String eTag

 The current version of the distribution created.
 








Class com.amazonaws.services.cloudfront.model.CreateFieldLevelEncryptionConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fieldLevelEncryptionConfig
FieldLevelEncryptionConfig fieldLevelEncryptionConfig

 The request to create a new field-level encryption configuration.
 








Class com.amazonaws.services.cloudfront.model.CreateFieldLevelEncryptionConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fieldLevelEncryption
FieldLevelEncryption fieldLevelEncryption

 Returned when you create a new field-level encryption configuration.
 


location
String location

 The fully qualified URI of the new configuration resource just created. For example:
 https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-config/EDFDVBD632BHDS5.
 


eTag
String eTag

 The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.CreateFieldLevelEncryptionProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fieldLevelEncryptionProfileConfig
FieldLevelEncryptionProfileConfig fieldLevelEncryptionProfileConfig

 The request to create a field-level encryption profile.
 








Class com.amazonaws.services.cloudfront.model.CreateFieldLevelEncryptionProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fieldLevelEncryptionProfile
FieldLevelEncryptionProfile fieldLevelEncryptionProfile

 Returned when you create a new field-level encryption profile.
 


location
String location

 The fully qualified URI of the new profile resource just created. For example:
 https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-profile/EDFDVBD632BHDS5.
 


eTag
String eTag

 The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.CreateInvalidationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


distributionId
String distributionId

 The distribution's id.
 


invalidationBatch
InvalidationBatch invalidationBatch

 The batch information for the invalidation.
 








Class com.amazonaws.services.cloudfront.model.CreateInvalidationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


location
String location

 The fully qualified URI of the distribution and invalidation batch request, including the
 Invalidation ID.
 


invalidation
Invalidation invalidation

 The invalidation's information.
 








Class com.amazonaws.services.cloudfront.model.CreatePublicKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


publicKeyConfig
PublicKeyConfig publicKeyConfig

 The request to add a public key to CloudFront.
 








Class com.amazonaws.services.cloudfront.model.CreatePublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


publicKey
PublicKey publicKey

 Returned when you add a public key.
 


location
String location

 The fully qualified URI of the new public key resource just created. For example:
 https://cloudfront.amazonaws.com/2010-11-01/cloudfront-public-key/EDFDVBD632BHDS5.
 


eTag
String eTag

 The current version of the public key. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.CreateStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamingDistributionConfig
StreamingDistributionConfig streamingDistributionConfig

 The streaming distribution's configuration information.
 








Class com.amazonaws.services.cloudfront.model.CreateStreamingDistributionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamingDistribution
StreamingDistribution streamingDistribution

 The streaming distribution's information.
 


location
String location

 The fully qualified URI of the new streaming distribution resource just created. For example:
 https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.
 


eTag
String eTag

 The current version of the streaming distribution created.
 








Class com.amazonaws.services.cloudfront.model.CreateStreamingDistributionWithTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamingDistributionConfigWithTags
StreamingDistributionConfigWithTags streamingDistributionConfigWithTags

 The streaming distribution's configuration information.
 








Class com.amazonaws.services.cloudfront.model.CreateStreamingDistributionWithTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamingDistribution
StreamingDistribution streamingDistribution

 The streaming distribution's information.
 


location
String location

 The fully qualified URI of the new streaming distribution resource just created. For example:
  https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.
 


eTag
String eTag

 The current version of the distribution created.
 








Class com.amazonaws.services.cloudfront.model.CustomErrorResponse extends Object implements Serializable


Serialized Fields


errorCode
Integer errorCode

 The HTTP status code for which you want to specify a custom error page and/or a caching duration.
 


responsePagePath
String responsePagePath

 The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the
 HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html.
 If you want to store your objects and your custom error pages in different locations, your distribution must
 include a cache behavior for which the following is true:
 
 
 
 
 The value of PathPattern matches the path to your custom error messages. For example, suppose you
 saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors.
 Your distribution must include a cache behavior for which the path pattern routes requests for your custom error
 pages to that location, for example, /4xx-errors/*.
 
 
 
 
 The value of TargetOriginId specifies the value of the ID element for the origin that
 contains your custom error pages.
 
 
 
 
 If you specify a value for ResponsePagePath, you must also specify a value for
 ResponseCode.
 
 
 We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP
 server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to
 viewers because the origin server is unavailable.
 


responseCode
String responseCode

 The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are
 a variety of reasons that you might want CloudFront to return a status code different from the status code that
 your origin returned to CloudFront, for example:
 
 
 
 
 Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent
 the response from being returned to the viewer. If you substitute 200, the response typically won't
 be intercepted.
 
 
 
 
 If you don't care about distinguishing among different client errors or server errors, you can specify
 400 or 500 as the ResponseCode for all 4xx or 5xx errors.
 
 
 
 
 You might want to return a 200 status code (OK) and static website so your customers don't know that
 your website is down.
 
 
 
 
 If you specify a value for ResponseCode, you must also specify a value for
 ResponsePagePath.
 


errorCachingMinTTL
Long errorCachingMinTTL

 The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in
 ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the
 problem that caused the error has been resolved and the requested object is now available.
 
 
 For more information, see Customizing
 Error Responses in the Amazon CloudFront Developer Guide.
 








Class com.amazonaws.services.cloudfront.model.CustomErrorResponses extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If
 Quantity is 0, you can omit Items.
 


items
SdkInternalList<T> items

 A complex type that contains a CustomErrorResponse element for each HTTP status code for which you
 want to specify a custom error page and/or a caching duration.
 








Class com.amazonaws.services.cloudfront.model.CustomHeaders extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of custom headers, if any, for this distribution.
 


items
SdkInternalList<T> items

 Optional: A list that contains one OriginCustomHeader element for each custom header that you
 want CloudFront to forward to the origin. If Quantity is 0, omit Items.
 








Class com.amazonaws.services.cloudfront.model.CustomOriginConfig extends Object implements Serializable


Serialized Fields


hTTPPort
Integer hTTPPort

 The HTTP port the custom origin listens on.
 


hTTPSPort
Integer hTTPSPort

 The HTTPS port the custom origin listens on.
 


originProtocolPolicy
String originProtocolPolicy

 The origin protocol policy to apply to your origin.
 


originSslProtocols
OriginSslProtocols originSslProtocols

 The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.
 


originReadTimeout
Integer originReadTimeout

 You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is
 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is
 4 seconds; the maximum is 60 seconds.
 
 
 If you need to increase the maximum time limit, contact the AWS Support Center.
 


originKeepaliveTimeout
Integer originKeepaliveTimeout

 You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5
 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1
 second; the maximum is 60 seconds.
 
 
 If you need to increase the maximum time limit, contact the AWS Support Center.
 








Class com.amazonaws.services.cloudfront.model.DefaultCacheBehavior extends Object implements Serializable


Serialized Fields


targetOriginId
String targetOriginId

 The value of ID for the origin that you want CloudFront to route requests to when a request matches
 the path pattern either for a cache behavior or for the default cache behavior in your distribution.
 


forwardedValues
ForwardedValues forwardedValues

 A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers.
 


trustedSigners
TrustedSigners trustedSigners

 A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private
 content.
 
 
 If you want to require signed URLs in requests for objects in the target origin that match the
 PathPattern for this cache behavior, specify true for Enabled, and specify
 the applicable values for Quantity and Items. For more information, see Serving Private
 Content through CloudFront 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

 The protocol that viewers can use to access the files in the origin specified by TargetOriginId when
 a request matches the path pattern in PathPattern. You can specify the following options:
 
 
 
 
 allow-all: Viewers can use HTTP or HTTPS.
 
 
 
 
 redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of
 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the
 new URL.
 
 
 
 
 https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403
 (Forbidden).
 
 
 
 
 For more information about requiring the HTTPS protocol, see Using an HTTPS
 Connection to Access Your Objects in the Amazon CloudFront Developer Guide.
 
 
 
 The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never
 to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that
 you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will
 return an object from the cache regardless of whether the current request protocol matches the protocol used
 previously. For more information, see Managing How Long
 Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
 
 


minTTL
Long minTTL

 The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another
 request to your origin to determine whether the object has been updated. For more information, see Managing How Long
 Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
 
 
 You must specify 0 for MinTTL if you configure CloudFront to forward all headers to
 your origin (under Headers, if you specify 1 for Quantity and
 * for Name).
 


allowedMethods
AllowedMethods allowedMethods


smoothStreaming
Boolean smoothStreaming

 Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin
 that is associated with this cache behavior. If so, specify true; if not, specify false
 . If you specify true for SmoothStreaming, you can still distribute other content using
 this cache behavior if the content matches the value of PathPattern.
 


defaultTTL
Long defaultTTL

 The default amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long
 Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
 


maxTTL
Long maxTTL

 The maximum amount of time that you want objects to stay in CloudFront caches 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. For more information, see Managing How Long
 Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.
 


compress
Boolean compress

 Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify
 true; if not, specify false. For more information, see Serving
 Compressed Files in the Amazon CloudFront Developer Guide.
 


lambdaFunctionAssociations
LambdaFunctionAssociations lambdaFunctionAssociations

 A complex type that contains zero or more Lambda function associations for a cache behavior.
 


fieldLevelEncryptionId
String fieldLevelEncryptionId

 The value of ID for the field-level encryption configuration that you want CloudFront to use for
 encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.
 








Class com.amazonaws.services.cloudfront.model.DeleteCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The origin access identity's ID.
 


ifMatch
String ifMatch

 The value of the ETag header you received from a previous GET or PUT
 request. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.DeleteCloudFrontOriginAccessIdentityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudfront.model.DeleteDistributionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The distribution ID.
 


ifMatch
String ifMatch

 The value of the ETag header that you received when you disabled the distribution. For example:
 E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.DeleteDistributionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudfront.model.DeleteFieldLevelEncryptionConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the configuration you want to delete from CloudFront.
 


ifMatch
String ifMatch

 The value of the ETag header that you received when retrieving the configuration identity to delete.
 For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.DeleteFieldLevelEncryptionConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudfront.model.DeleteFieldLevelEncryptionProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 Request the ID of the profile you want to delete from CloudFront.
 


ifMatch
String ifMatch

 The value of the ETag header that you received when retrieving the profile to delete. For example:
 E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.DeleteFieldLevelEncryptionProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudfront.model.DeletePublicKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the public key you want to remove from CloudFront.
 


ifMatch
String ifMatch

 The value of the ETag header that you received when retrieving the public key identity to delete.
 For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.DeletePublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudfront.model.DeleteStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The distribution ID.
 


ifMatch
String ifMatch

 The value of the ETag header that you received when you disabled the streaming distribution. For
 example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.DeleteStreamingDistributionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudfront.model.Distribution extends Object implements Serializable


Serialized Fields


id
String id

 The identifier for the distribution. For example: EDFDVBD632BHDS5.
 


aRN
String aRN

 The ARN (Amazon Resource Name) for the distribution. For example:
 arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is
 your AWS account ID.
 


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 to all CloudFront edge locations.
 


lastModifiedTime
Date lastModifiedTime

 The date and time the distribution was last modified.
 


inProgressInvalidationBatches
Integer inProgressInvalidationBatches

 The number of invalidation batches currently in progress.
 


domainName
String domainName

 The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.
 


activeTrustedSigners
ActiveTrustedSigners activeTrustedSigners

 CloudFront automatically adds this element to the response only if you've set up the distribution to serve
 private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted
 signer. The Signer child element lists the AWS account number of the trusted signer (or an empty
 Self element if the signer is you). The Signer element also includes the IDs of any
 active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears
 for a Signer, that signer can't create working signed URLs.
 


distributionConfig
DistributionConfig distributionConfig

 The current configuration information for the distribution. Send a GET request to the
 /CloudFront API version/distribution ID/config resource.
 


aliasICPRecordals
SdkInternalList<T> aliasICPRecordals

 AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve
 content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront.
 AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.
 
 
 For more information about ICP recordals, see  Signup, Accounts, and
 Credentials in Getting Started with AWS services in China.
 








Class com.amazonaws.services.cloudfront.model.DistributionAlreadyExistsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.DistributionConfig extends Object implements Serializable


Serialized Fields


callerReference
String callerReference

 A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
 
 
 If the value of CallerReference is new (regardless of the content of the
 DistributionConfig object), CloudFront creates a new distribution.
 
 
 If CallerReference is a value that you already sent in a previous request to create a distribution,
 CloudFront returns a DistributionAlreadyExists error.
 


aliases
Aliases aliases

 A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
 


defaultRootObject
String defaultRootObject

 The object that you want CloudFront to request from your origin (for example, index.html) when a
 viewer requests the root URL for your distribution (http://www.example.com) instead of an object in
 your distribution (http://www.example.com/product-description.html). Specifying a default root
 object avoids exposing the contents of your distribution.
 
 
 Specify only the object name, for example, index.html. Don't add a / before the object
 name.
 
 
 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.
 
 
 For more information about the default root object, see Creating a
 Default Root Object in the Amazon CloudFront Developer Guide.
 


origins
Origins origins

 A complex type that contains information about origins for this distribution.
 


originGroups
OriginGroups originGroups

 A complex type that contains information about origin groups for this distribution.
 


defaultCacheBehavior
DefaultCacheBehavior defaultCacheBehavior

 A complex type that describes the default cache behavior if you don't specify a CacheBehavior
 element or if files don't match any of the values of PathPattern in CacheBehavior
 elements. You must create exactly one default cache behavior.
 


cacheBehaviors
CacheBehaviors cacheBehaviors

 A complex type that contains zero or more CacheBehavior elements.
 


customErrorResponses
CustomErrorResponses customErrorResponses

 A complex type that controls the following:
 
 
 
 
 Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before
 returning the response to the viewer.
 
 
 
 
 How long CloudFront caches HTTP status codes in the 4xx and 5xx range.
 
 
 
 
 For more information about custom error pages, see Customizing
 Error Responses in the Amazon CloudFront Developer Guide.
 


comment
String comment

 Any comments you want to include about the distribution.
 
 
 If you don't want to specify a comment, include an empty Comment element.
 
 
 To delete an existing comment, update the distribution configuration and include an empty Comment
 element.
 
 
 To add or change a comment, update the distribution configuration and specify the new comment.
 


logging
LoggingConfig logging

 A complex type that controls whether access logs are written for the distribution.
 
 
 For more information about logging, see Access Logs in the
 Amazon CloudFront Developer Guide.
 


priceClass
String priceClass

 The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you
 specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge
 locations.
 
 
 If you specify a price class other than PriceClass_All, CloudFront serves your objects from the
 CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who
 are in or near regions that are excluded from your specified price class may encounter slower performance.
 
 
 For more information about price classes, see Choosing the Price
 Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about
 CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. For price class information,
 scroll down to see the table at the bottom of the page.
 


enabled
Boolean enabled

 From this field, you can enable or disable the selected distribution.
 


viewerCertificate
ViewerCertificate viewerCertificate

 A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
 


restrictions
Restrictions restrictions

 A complex type that identifies ways in which you want to restrict distribution of your content.
 


webACLId
String webACLId

 A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution. To specify a
 web ACL created using the latest version of AWS WAF, use the ACL ARN, for example
 arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a
 . To specify a web ACL created using AWS WAF Classic, use the ACL ID, for example
 473e64fd-f30b-4765-81a0-62ad96dd167a.
 
 
 AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to
 CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP
 addresses that requests originate from or the values of query strings, CloudFront responds to requests either
 with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to
 return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.
 


httpVersion
String httpVersion

 (Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The
 default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier
 HTTP version.
 
 
 For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name
 Identification (SNI).
 
 
 In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve
 performance by optimizing for HTTP/2. For more information, do an Internet search for "http/2 optimization."
 


isIPV6Enabled
Boolean isIPV6Enabled

 If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify
 true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS
 response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for
 an IPv4 address for your distribution.
 
 
 In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However,
 if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom
 policy that includes the IpAddress parameter to restrict the IP addresses that can access your
 content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access
 to other content (or restrict access but not by IP address), you can create two distributions. For more
 information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.
 
 
 If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution,
 you need to create a second alias resource record set when both of the following are true:
 
 
 
 
 You enable IPv6 for the distribution
 
 
 
 
 You're using alternate domain names in the URLs for your objects
 
 
 
 
 For more information, see Routing
 Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53
 Developer Guide.
 
 
 If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't
 need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address
 format of the viewer request.
 








Class com.amazonaws.services.cloudfront.model.DistributionConfigWithTags extends Object implements Serializable


Serialized Fields


distributionConfig
DistributionConfig distributionConfig

 A distribution configuration.
 


tags
Tags tags

 A complex type that contains zero or more Tag elements.
 








Class com.amazonaws.services.cloudfront.model.DistributionList extends Object implements Serializable


Serialized Fields


marker
String marker

 The value you provided for the Marker request parameter.
 


nextMarker
String nextMarker

 If IsTruncated is true, this element is present and contains the value you can use for
 the Marker request parameter to continue listing your distributions where they left off.
 


maxItems
Integer maxItems

 The value you provided for the MaxItems request parameter.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can
 make a follow-up pagination request using the Marker request parameter to retrieve more
 distributions in the list.
 


quantity
Integer quantity

 The number of distributions that were created by the current AWS account.
 


items
SdkInternalList<T> items

 A complex type that contains one DistributionSummary element for each distribution that was created
 by the current AWS account.
 








Class com.amazonaws.services.cloudfront.model.DistributionNotDisabledException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.DistributionSummary extends Object implements Serializable


Serialized Fields


id
String id

 The identifier for the distribution. For example: EDFDVBD632BHDS5.
 


aRN
String aRN

 The ARN (Amazon Resource Name) for the distribution. For example:
 arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is
 your AWS account ID.
 


status
String status

 The current status of the distribution. When the status is Deployed, the distribution's information
 is propagated to all CloudFront edge locations.
 


lastModifiedTime
Date lastModifiedTime

 The date and time the distribution was last modified.
 


domainName
String domainName

 The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.
 


aliases
Aliases aliases

 A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
 


origins
Origins origins

 A complex type that contains information about origins for this distribution.
 


originGroups
OriginGroups originGroups

 A complex type that contains information about origin groups for this distribution.
 


defaultCacheBehavior
DefaultCacheBehavior defaultCacheBehavior

 A complex type that describes the default cache behavior if you don't specify a CacheBehavior
 element or if files don't match any of the values of PathPattern in CacheBehavior
 elements. You must create exactly one default cache behavior.
 


cacheBehaviors
CacheBehaviors cacheBehaviors

 A complex type that contains zero or more CacheBehavior elements.
 


customErrorResponses
CustomErrorResponses customErrorResponses

 A complex type that contains zero or more CustomErrorResponses elements.
 


comment
String comment

 The comment originally specified when this distribution was created.
 


priceClass
String priceClass

 A complex type that contains information about price class for this streaming distribution.
 


enabled
Boolean enabled

 Whether the distribution is enabled to accept user requests for content.
 


viewerCertificate
ViewerCertificate viewerCertificate

 A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.
 


restrictions
Restrictions restrictions

 A complex type that identifies ways in which you want to restrict distribution of your content.
 


webACLId
String webACLId

 The Web ACL Id (if any) associated with the distribution.
 


httpVersion
String httpVersion

 Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value
 for new web distributions is http2. Viewers that don't support HTTP/2 will
 automatically use an earlier version.
 


isIPV6Enabled
Boolean isIPV6Enabled

 Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.
 


aliasICPRecordals
SdkInternalList<T> aliasICPRecordals

 AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve
 content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront.
 AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.
 
 
 For more information about ICP recordals, see  Signup, Accounts, and
 Credentials in Getting Started with AWS services in China.
 








Class com.amazonaws.services.cloudfront.model.EncryptionEntities extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 Number of field pattern items in a field-level encryption content type-profile mapping.
 


items
SdkInternalList<T> items

 An array of field patterns in a field-level encryption content type-profile mapping.
 








Class com.amazonaws.services.cloudfront.model.EncryptionEntity extends Object implements Serializable


Serialized Fields


publicKeyId
String publicKeyId

 The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields
 that match the patterns.
 


providerId
String providerId

 The provider associated with the public key being used for encryption. This value must also be provided with the
 private key for applications to be able to decrypt data.
 


fieldPatterns
FieldPatterns fieldPatterns

 Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted.
 You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap
 field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.
 








Class com.amazonaws.services.cloudfront.model.FieldLevelEncryption extends Object implements Serializable


Serialized Fields


id
String id

 The configuration ID for a field-level encryption configuration which includes a set of profiles that specify
 certain selected data fields to be encrypted by specific public keys.
 


lastModifiedTime
Date lastModifiedTime

 The last time the field-level encryption configuration was changed.
 


fieldLevelEncryptionConfig
FieldLevelEncryptionConfig fieldLevelEncryptionConfig

 A complex data type that includes the profile configurations specified for field-level encryption.
 








Class com.amazonaws.services.cloudfront.model.FieldLevelEncryptionConfig extends Object implements Serializable


Serialized Fields


callerReference
String callerReference

 A unique number that ensures the request can't be replayed.
 


comment
String comment

 An optional comment about the configuration.
 


queryArgProfileConfig
QueryArgProfileConfig queryArgProfileConfig

 A complex data type that specifies when to forward content if a profile isn't found and the profile that can be
 provided as a query argument in a request.
 


contentTypeProfileConfig
ContentTypeProfileConfig contentTypeProfileConfig

 A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use
 as by default in a request if a query argument doesn't specify a profile to use.
 








Class com.amazonaws.services.cloudfront.model.FieldLevelEncryptionConfigAlreadyExistsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.FieldLevelEncryptionConfigInUseException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.FieldLevelEncryptionList extends Object implements Serializable


Serialized Fields


nextMarker
String nextMarker

 If there are more elements to be listed, this element is present and contains the value that you can use for the
 Marker request parameter to continue listing your configurations where you left off.
 


maxItems
Integer maxItems

 The maximum number of elements you want in the response body.
 


quantity
Integer quantity

 The number of field-level encryption items.
 


items
SdkInternalList<T> items

 An array of field-level encryption items.
 








Class com.amazonaws.services.cloudfront.model.FieldLevelEncryptionProfile extends Object implements Serializable


Serialized Fields


id
String id

 The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain
 selected data fields to be encrypted by specific public keys.
 


lastModifiedTime
Date lastModifiedTime

 The last time the field-level encryption profile was updated.
 


fieldLevelEncryptionProfileConfig
FieldLevelEncryptionProfileConfig fieldLevelEncryptionProfileConfig

 A complex data type that includes the profile name and the encryption entities for the field-level encryption
 profile.
 








Class com.amazonaws.services.cloudfront.model.FieldLevelEncryptionProfileAlreadyExistsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.FieldLevelEncryptionProfileConfig extends Object implements Serializable


Serialized Fields


name
String name

 Profile name for the field-level encryption profile.
 


callerReference
String callerReference

 A unique number that ensures that the request can't be replayed.
 


comment
String comment

 An optional comment for the field-level encryption profile.
 


encryptionEntities
EncryptionEntities encryptionEntities

 A complex data type of encryption entities for the field-level encryption profile that include the public key ID,
 provider, and field patterns for specifying which fields to encrypt with this key.
 








Class com.amazonaws.services.cloudfront.model.FieldLevelEncryptionProfileInUseException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.FieldLevelEncryptionProfileList extends Object implements Serializable


Serialized Fields


nextMarker
String nextMarker

 If there are more elements to be listed, this element is present and contains the value that you can use for the
 Marker request parameter to continue listing your profiles where you left off.
 


maxItems
Integer maxItems

 The maximum number of field-level encryption profiles you want in the response body.
 


quantity
Integer quantity

 The number of field-level encryption profiles.
 


items
SdkInternalList<T> items

 The field-level encryption profile items.
 








Class com.amazonaws.services.cloudfront.model.FieldLevelEncryptionProfileSizeExceededException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.FieldLevelEncryptionProfileSummary extends Object implements Serializable


Serialized Fields


id
String id

 ID for the field-level encryption profile summary.
 


lastModifiedTime
Date lastModifiedTime

 The time when the the field-level encryption profile summary was last updated.
 


name
String name

 Name for the field-level encryption profile summary.
 


encryptionEntities
EncryptionEntities encryptionEntities

 A complex data type of encryption entities for the field-level encryption profile that include the public key ID,
 provider, and field patterns for specifying which fields to encrypt with this key.
 


comment
String comment

 An optional comment for the field-level encryption profile summary.
 








Class com.amazonaws.services.cloudfront.model.FieldLevelEncryptionSummary extends Object implements Serializable


Serialized Fields


id
String id

 The unique ID of a field-level encryption item.
 


lastModifiedTime
Date lastModifiedTime

 The last time that the summary of field-level encryption items was modified.
 


comment
String comment

 An optional comment about the field-level encryption item.
 


queryArgProfileConfig
QueryArgProfileConfig queryArgProfileConfig

 A summary of a query argument-profile mapping.
 


contentTypeProfileConfig
ContentTypeProfileConfig contentTypeProfileConfig

 A summary of a content type-profile mapping.
 








Class com.amazonaws.services.cloudfront.model.FieldPatterns extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of field-level encryption field patterns.
 


items
SdkInternalList<T> items

 An array of the field-level encryption field patterns.
 








Class com.amazonaws.services.cloudfront.model.ForwardedValues extends Object implements Serializable


Serialized Fields


queryString
Boolean queryString

 Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache
 behavior and cache based on the query string parameters. CloudFront behavior depends on the value of
 QueryString and on the values that you specify for QueryStringCacheKeys, if any:
 
 
 If you specify true for QueryString and you don't specify any values for
 QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based
 on all query string parameters. Depending on how many query string parameters and values you have, this can
 adversely affect performance because CloudFront must forward more requests to the origin.
 
 
 If you specify true for QueryString and you specify one or more values for
 QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only
 caches based on the query string parameters that you specify.
 
 
 If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the
 origin, and doesn't cache based on query string parameters.
 
 
 For more information, see Configuring
 CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.
 


cookies
CookiePreference cookies

 A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which
 ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards,
 Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.
 


headers
Headers headers

 A complex type that specifies the Headers, if any, that you want CloudFront to forward to the origin
 for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate
 versions of a specified object that is based on the header values in viewer requests.
 
 
 For more information, see  Caching Content
 Based on Request Headers in the Amazon CloudFront Developer Guide.
 


queryStringCacheKeys
QueryStringCacheKeys queryStringCacheKeys

 A complex type that contains information about the query string parameters that you want CloudFront to use for
 caching for this cache behavior.
 








Class com.amazonaws.services.cloudfront.model.GeoRestriction extends Object implements Serializable


Serialized Fields


restrictionType
String restrictionType

 The method that you want to use to restrict distribution of your content by country:
 
 
 
 
 none: No geo restriction is enabled, meaning access to content is not restricted by client geo
 location.
 
 
 
 
 blacklist: The Location elements specify the countries in which you don't want
 CloudFront to distribute your content.
 
 
 
 
 whitelist: The Location elements specify the countries in which you want CloudFront to
 distribute your content.
 
 
 


quantity
Integer quantity

 When geo restriction is enabled, this is the number of countries in your whitelist or
 blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can
 omit Items.
 


items
SdkInternalList<T> items

 A complex type that contains a Location element for each country in which you want CloudFront either
 to distribute your content (whitelist) or not distribute your content (blacklist).
 
 
 The Location element is a two-letter, uppercase country code for a country that you want to include
 in your blacklist or whitelist. Include one Location element for each
 country.
 
 
 CloudFront and MaxMind both use ISO 3166 country codes. For the current list of
 countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International
 Organization for Standardization website. You can also refer to the country list on the CloudFront console,
 which includes both country names and codes.
 








Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identity's ID.
 








Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cloudFrontOriginAccessIdentityConfig
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig

 The origin access identity's configuration information.
 


eTag
String eTag

 The current version of the configuration. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identity's ID.
 








Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cloudFrontOriginAccessIdentity
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity

 The origin access identity's information.
 


eTag
String eTag

 The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.GetDistributionConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
 








Class com.amazonaws.services.cloudfront.model.GetDistributionConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


distributionConfig
DistributionConfig distributionConfig

 The distribution's configuration information.
 


eTag
String eTag

 The current version of the configuration. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.GetDistributionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The distribution's ID. If the ID is empty, an empty distribution configuration is returned.
 








Class com.amazonaws.services.cloudfront.model.GetDistributionResult extends AmazonWebServiceResult<ResponseMetadata> 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.GetFieldLevelEncryptionConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 Request the ID for the field-level encryption configuration information.
 








Class com.amazonaws.services.cloudfront.model.GetFieldLevelEncryptionConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fieldLevelEncryptionConfig
FieldLevelEncryptionConfig fieldLevelEncryptionConfig

 Return the field-level encryption configuration information.
 


eTag
String eTag

 The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.GetFieldLevelEncryptionProfileConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 Get the ID for the field-level encryption profile configuration information.
 








Class com.amazonaws.services.cloudfront.model.GetFieldLevelEncryptionProfileConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fieldLevelEncryptionProfileConfig
FieldLevelEncryptionProfileConfig fieldLevelEncryptionProfileConfig

 Return the field-level encryption profile configuration information.
 


eTag
String eTag

 The current version of the field-level encryption profile configuration result. For example:
 E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.GetFieldLevelEncryptionProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 Get the ID for the field-level encryption profile information.
 








Class com.amazonaws.services.cloudfront.model.GetFieldLevelEncryptionProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fieldLevelEncryptionProfile
FieldLevelEncryptionProfile fieldLevelEncryptionProfile

 Return the field-level encryption profile information.
 


eTag
String eTag

 The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.GetFieldLevelEncryptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 Request the ID for the field-level encryption configuration information.
 








Class com.amazonaws.services.cloudfront.model.GetFieldLevelEncryptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fieldLevelEncryption
FieldLevelEncryption fieldLevelEncryption

 Return the field-level encryption configuration information.
 


eTag
String eTag

 The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.GetInvalidationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


distributionId
String distributionId

 The distribution's ID.
 


id
String id

 The identifier for the invalidation request, for example, IDFDVBD632BHDS5.
 








Class com.amazonaws.services.cloudfront.model.GetInvalidationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


invalidation
Invalidation invalidation

 The invalidation's information. For more information, see Invalidation
 Complex Type.
 








Class com.amazonaws.services.cloudfront.model.GetPublicKeyConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 Request the ID for the public key configuration.
 








Class com.amazonaws.services.cloudfront.model.GetPublicKeyConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


publicKeyConfig
PublicKeyConfig publicKeyConfig

 Return the result for the public key configuration.
 


eTag
String eTag

 The current version of the public key configuration. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.GetPublicKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 Request the ID for the public key.
 








Class com.amazonaws.services.cloudfront.model.GetPublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


publicKey
PublicKey publicKey

 Return the public key.
 


eTag
String eTag

 The current version of the public key. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The streaming distribution's ID.
 








Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamingDistributionConfig
StreamingDistributionConfig streamingDistributionConfig

 The streaming distribution's configuration information.
 


eTag
String eTag

 The current version of the configuration. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The streaming distribution's ID.
 








Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamingDistribution
StreamingDistribution streamingDistribution

 The streaming distribution's information.
 


eTag
String eTag

 The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.Headers extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of different headers that you want CloudFront to base caching on for this cache behavior. You can
 configure each cache behavior in a web distribution to do one of the following:
 
 
 
 
 Forward all headers to your origin: Specify 1 for Quantity and *
 for Name.
 
 
 
 CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends
 every request to the origin.
 
 
 
 
 Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base
 caching on. Then specify the header names in Name elements. CloudFront caches your objects based on
 the values in the specified headers.
 
 
 
 
 Forward only the default headers: Specify 0 for Quantity and omit
 Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.
 
 
 
 
 Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is
 an S3 bucket or a custom origin. See the following documentation:
 
 
 
 
 S3 bucket: See HTTP Request Headers That CloudFront Removes or Updates
 
 
 
 
 Custom origin: See HTTP Request Headers and CloudFront Behavior
 
 
 


items
SdkInternalList<T> items

 A list that contains one Name element for each header that you want CloudFront to use for caching in
 this cache behavior. If Quantity is 0, omit Items.
 








Class com.amazonaws.services.cloudfront.model.IllegalFieldLevelEncryptionConfigAssociationWithCacheBehaviorException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.IllegalUpdateException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InconsistentQuantitiesException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidArgumentException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.Invalidation extends Object implements Serializable


Serialized Fields


id
String id

 The identifier for the invalidation request. For example: IDFDVBD632BHDS5.
 


status
String status

 The status of the invalidation request. When the invalidation batch is finished, the status is
 Completed.
 


createTime
Date createTime

 The date and time the invalidation request was first made.
 


invalidationBatch
InvalidationBatch invalidationBatch

 The current invalidation information for the batch request.
 








Class com.amazonaws.services.cloudfront.model.InvalidationBatch extends Object implements Serializable


Serialized Fields


paths
Paths paths

 A complex type that contains information about the objects that you want to invalidate. For more information, see
 Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.
 


callerReference
String callerReference

 A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you
 from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must
 specify a new value for CallerReference and change other values in the request as applicable. One
 way to ensure that the value of CallerReference is unique is to use a timestamp, for
 example, 20120301090000.
 
 
 If you make a second invalidation request with the same value for CallerReference, and if the rest
 of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns
 information about the invalidation request that you previously created with the same CallerReference
 .
 
 
 If CallerReference is a value you already sent in a previous invalidation batch request but the
 content of any Path is different from the original request, CloudFront returns an
 InvalidationBatchAlreadyExists error.
 








Class com.amazonaws.services.cloudfront.model.InvalidationList extends Object implements Serializable


Serialized Fields


marker
String marker

 The value that you provided for the Marker request parameter.
 


nextMarker
String nextMarker

 If IsTruncated is true, this element is present and contains the value that you can use
 for the Marker request parameter to continue listing your invalidation batches where they left off.
 


maxItems
Integer maxItems

 The value that you provided for the MaxItems request parameter.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether more invalidation batch requests remain to be listed. If your results were
 truncated, you can make a follow-up pagination request using the Marker request parameter to
 retrieve more invalidation batches in the list.
 


quantity
Integer quantity

 The number of invalidation batches that were created by the current AWS account.
 


items
SdkInternalList<T> items

 A complex type that contains one InvalidationSummary element for each invalidation batch created by
 the current AWS account.
 








Class com.amazonaws.services.cloudfront.model.InvalidationSummary extends Object implements Serializable


Serialized Fields


id
String id

 The unique ID for an invalidation request.
 


createTime
Date createTime

 The time that an invalidation request was created.
 


status
String status

 The status of an invalidation request.
 








Class com.amazonaws.services.cloudfront.model.InvalidDefaultRootObjectException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidErrorCodeException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidForwardCookiesException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidGeoRestrictionParameterException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidHeadersForS3OriginException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidIfMatchVersionException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidLambdaFunctionAssociationException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidLocationCodeException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidMinimumProtocolVersionException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidOriginAccessIdentityException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidOriginException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidOriginKeepaliveTimeoutException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidOriginReadTimeoutException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidProtocolSettingsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidQueryStringParametersException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidRelativePathException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidRequiredProtocolException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidResponseCodeException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidTaggingException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidTTLOrderException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidViewerCertificateException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.InvalidWebACLIdException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.KeyPairIds extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of active CloudFront key pairs for AwsAccountNumber.
 
 
 For more information, see ActiveTrustedSigners.
 


items
SdkInternalList<T> items

 A complex type that lists the active CloudFront key pairs, if any, that are associated with
 AwsAccountNumber.
 
 
 For more information, see ActiveTrustedSigners.
 








Class com.amazonaws.services.cloudfront.model.LambdaFunctionAssociation extends Object implements Serializable


Serialized Fields


lambdaFunctionARN
String lambdaFunctionARN

 The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias
 or $LATEST.
 


eventType
String eventType

 Specifies the event type that triggers a Lambda function invocation. You can specify the following values:
 
 
 
 
 viewer-request: The function executes when CloudFront receives a request from a viewer and before it
 checks to see whether the requested object is in the edge cache.
 
 
 
 
 origin-request: The function executes only when CloudFront forwards a request to your origin. When
 the requested object is in the edge cache, the function doesn't execute.
 
 
 
 
 origin-response: The function executes after CloudFront receives a response from the origin and
 before it caches the object in the response. When the requested object is in the edge cache, the function doesn't
 execute.
 
 
 
 
 viewer-response: The function executes before CloudFront returns the requested object to the viewer.
 The function executes regardless of whether the object was already in the edge cache.
 
 
 If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.
 
 
 


includeBody
Boolean includeBody

 A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.
 








Class com.amazonaws.services.cloudfront.model.LambdaFunctionAssociations extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of Lambda function associations for this cache behavior.
 


items
SdkInternalList<T> items

 Optional: A complex type that contains LambdaFunctionAssociation items for this cache
 behavior. If Quantity is 0, you can omit Items.
 








Class com.amazonaws.services.cloudfront.model.ListCloudFrontOriginAccessIdentitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


marker
String marker

 Use this when paginating results to indicate where to begin in your list of origin access identities. The results
 include identities in the list that occur after the marker. To get the next page of results, set the
 Marker to the value of the NextMarker from the current page's response (which is also
 the ID of the last identity on that page).
 


maxItems
String maxItems

 The maximum number of origin access identities you want in the response body.
 








Class com.amazonaws.services.cloudfront.model.ListCloudFrontOriginAccessIdentitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cloudFrontOriginAccessIdentityList
CloudFrontOriginAccessIdentityList cloudFrontOriginAccessIdentityList

 The CloudFrontOriginAccessIdentityList type.
 








Class com.amazonaws.services.cloudfront.model.ListDistributionsByWebACLIdRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


marker
String marker

 Use Marker and MaxItems to control pagination of results. If you have more than
 MaxItems distributions that satisfy the request, the response includes a NextMarker
 element. To get the next page of results, submit another request. For the value of Marker, specify
 the value of NextMarker from the last response. (For the first request, omit Marker.)
 


maxItems
String maxItems

 The maximum number of distributions that you want CloudFront to return in the response body. The maximum and
 default values are both 100.
 


webACLId
String webACLId

 The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify "null" for the
 ID, the request returns a list of the distributions that aren't associated with a web ACL.
 








Class com.amazonaws.services.cloudfront.model.ListDistributionsByWebACLIdResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


distributionList
DistributionList distributionList

 The DistributionList type.
 








Class com.amazonaws.services.cloudfront.model.ListDistributionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


marker
String marker

 Use this when paginating results to indicate where to begin in your list of 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 distributions you want in the response body.
 








Class com.amazonaws.services.cloudfront.model.ListDistributionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


distributionList
DistributionList distributionList

 The DistributionList type.
 








Class com.amazonaws.services.cloudfront.model.ListFieldLevelEncryptionConfigsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


marker
String marker

 Use this when paginating results to indicate where to begin in your list of configurations. The results include
 configurations 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 configuration on that page).
 


maxItems
String maxItems

 The maximum number of field-level encryption configurations you want in the response body.
 








Class com.amazonaws.services.cloudfront.model.ListFieldLevelEncryptionConfigsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fieldLevelEncryptionList
FieldLevelEncryptionList fieldLevelEncryptionList

 Returns a list of all field-level encryption configurations that have been created in CloudFront for this
 account.
 








Class com.amazonaws.services.cloudfront.model.ListFieldLevelEncryptionProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


marker
String marker

 Use this when paginating results to indicate where to begin in your list of profiles. The results include
 profiles 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
 profile on that page).
 


maxItems
String maxItems

 The maximum number of field-level encryption profiles you want in the response body.
 








Class com.amazonaws.services.cloudfront.model.ListFieldLevelEncryptionProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fieldLevelEncryptionProfileList
FieldLevelEncryptionProfileList fieldLevelEncryptionProfileList

 Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.
 








Class com.amazonaws.services.cloudfront.model.ListInvalidationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


distributionId
String distributionId

 The distribution's ID.
 


marker
String marker

 Use this parameter when paginating results to indicate where to begin in your list of invalidation batches.
 Because the results are returned in decreasing order from most recent to oldest, the most recent results are on
 the first page, the second page will contain earlier results, and so on. To get the next page of results, set
 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 that you want in the response body.
 








Class com.amazonaws.services.cloudfront.model.ListInvalidationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


invalidationList
InvalidationList invalidationList

 Information about invalidation batches.
 








Class com.amazonaws.services.cloudfront.model.ListPublicKeysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


marker
String marker

 Use this when paginating results to indicate where to begin in your list of public keys. The results include
 public keys 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
 public key on that page).
 


maxItems
String maxItems

 The maximum number of public keys you want in the response body.
 








Class com.amazonaws.services.cloudfront.model.ListPublicKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


publicKeyList
PublicKeyList publicKeyList

 Returns a list of all public keys that have been added to CloudFront for this account.
 








Class com.amazonaws.services.cloudfront.model.ListStreamingDistributionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


marker
String marker

 The value that you provided for the Marker request parameter.
 


maxItems
String maxItems

 The value that you provided for the MaxItems request parameter.
 








Class com.amazonaws.services.cloudfront.model.ListStreamingDistributionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamingDistributionList
StreamingDistributionList streamingDistributionList

 The StreamingDistributionList type.
 








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


Serialized Fields


resource
String resource

 An ARN of a CloudFront resource.
 








Class com.amazonaws.services.cloudfront.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Tags tags

 A complex type that contains zero or more Tag elements.
 








Class com.amazonaws.services.cloudfront.model.LoggingConfig extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't 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 don't want to include cookies when you create
 a distribution or if you want to disable include cookies for an existing distribution, specify false
 for IncludeCookies.
 


bucket
String bucket

 The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
 


prefix
String prefix

 An optional string that you want CloudFront to prefix to the access log filenames for this
 distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a
 prefix, you still must include an empty Prefix element in the Logging element.
 








Class com.amazonaws.services.cloudfront.model.MissingBodyException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.NoSuchCloudFrontOriginAccessIdentityException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.NoSuchDistributionException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.NoSuchFieldLevelEncryptionConfigException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.NoSuchFieldLevelEncryptionProfileException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.NoSuchInvalidationException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.NoSuchOriginException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.NoSuchPublicKeyException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.NoSuchResourceException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.NoSuchStreamingDistributionException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.Origin extends Object implements Serializable


Serialized Fields


id
String id

 A unique identifier for the origin or origin group. The value of Id must be unique within the
 distribution.
 
 
 When you specify the value of TargetOriginId for the default cache behavior or for another cache
 behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value
 of the Id element for that origin. When a request matches the path pattern for that cache behavior,
 CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
 


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. If you set up your bucket to be configured
 as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.
 
 
 For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.
 
 
 Constraints for Amazon S3 origins:
 
 
 
 
 If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate
 endpoint for DomainName.
 
 
 
 
 The bucket name must be between 3 and 63 characters long (inclusive).
 
 
 
 
 The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.
 
 
 
 
 The bucket name must not contain adjacent periods.
 
 
 
 
 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.
 
 
 Constraints for custom origins:
 
 
 
 
 DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or
 underscore (_) characters.
 
 
 
 
 The name cannot exceed 128 characters.
 
 
 


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, for
 example, example.com/production. Do not include a / at the end of the directory name.
 
 
 For example, suppose you've specified the following values for your distribution:
 
 
 
 
 DomainName: An Amazon S3 bucket named myawsbucket.
 
 
 
 
 OriginPath: /production
 
 
 
 
 CNAME: example.com
 
 
 
 
 When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for
 myawsbucket/production/index.html.
 
 
 When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3
 for myawsbucket/production/acme/index.html.
 


customHeaders
CustomHeaders customHeaders

 A complex type that contains names and values for the custom headers that you want.
 


s3OriginConfig
S3OriginConfig s3OriginConfig

 A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the
 CustomOriginConfig element instead.
 


customOriginConfig
CustomOriginConfig customOriginConfig

 A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the
 S3OriginConfig element instead.
 








Class com.amazonaws.services.cloudfront.model.OriginCustomHeader extends Object implements Serializable


Serialized Fields


headerName
String headerName

 The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding
 Custom Headers to Your Origin (Web Distributions Only) in the  Amazon CloudFront Developer Guide.
 


headerValue
String headerValue

 The value for the header that you specified in the HeaderName field.
 








Class com.amazonaws.services.cloudfront.model.OriginGroup extends Object implements Serializable


Serialized Fields


id
String id

 The origin group's ID.
 


failoverCriteria
OriginGroupFailoverCriteria failoverCriteria

 A complex type that contains information about the failover criteria for an origin group.
 


members
OriginGroupMembers members

 A complex type that contains information about the origins in an origin group.
 








Class com.amazonaws.services.cloudfront.model.OriginGroupFailoverCriteria extends Object implements Serializable


Serialized Fields


statusCodes
StatusCodes statusCodes

 The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second
 origin.
 








Class com.amazonaws.services.cloudfront.model.OriginGroupMember extends Object implements Serializable


Serialized Fields


originId
String originId

 The ID for an origin in an origin group.
 








Class com.amazonaws.services.cloudfront.model.OriginGroupMembers extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of origins in an origin group.
 


items
SdkInternalList<T> items

 Items (origins) in an origin group.
 








Class com.amazonaws.services.cloudfront.model.OriginGroups extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of origin groups.
 


items
SdkInternalList<T> items

 The items (origin groups) in a distribution.
 








Class com.amazonaws.services.cloudfront.model.Origins extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of origins or origin groups for this distribution.
 


items
SdkInternalList<T> items

 A complex type that contains origins or origin groups for this distribution.
 








Class com.amazonaws.services.cloudfront.model.OriginSslProtocols extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection
 with this origin.
 


items
SdkInternalList<T> items

 A list that contains allowed SSL/TLS protocols for this distribution.
 








Class com.amazonaws.services.cloudfront.model.Paths extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of invalidation paths specified for the objects that you want to invalidate.
 


items
SdkInternalList<T> items

 A complex type that contains a list of the paths that you want to invalidate.
 








Class com.amazonaws.services.cloudfront.model.PreconditionFailedException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.PublicKey extends Object implements Serializable


Serialized Fields


id
String id

 A unique ID assigned to a public key you've added to CloudFront.
 


createdTime
Date createdTime

 A time you added a public key to CloudFront.
 


publicKeyConfig
PublicKeyConfig publicKeyConfig

 A complex data type for a public key you add to CloudFront to use with features like field-level encryption.
 








Class com.amazonaws.services.cloudfront.model.PublicKeyAlreadyExistsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.PublicKeyConfig extends Object implements Serializable


Serialized Fields


callerReference
String callerReference

 A unique number that ensures that the request can't be replayed.
 


name
String name

 The name for a public key you add to CloudFront to use with features like field-level encryption.
 


encodedKey
String encodedKey

 The encoded public key that you want to add to CloudFront to use with features like field-level encryption.
 


comment
String comment

 An optional comment about a public key.
 








Class com.amazonaws.services.cloudfront.model.PublicKeyInUseException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.PublicKeyList extends Object implements Serializable


Serialized Fields


nextMarker
String nextMarker

 If there are more elements to be listed, this element is present and contains the value that you can use for the
 Marker request parameter to continue listing your public keys where you left off.
 


maxItems
Integer maxItems

 The maximum number of public keys you want in the response body.
 


quantity
Integer quantity

 The number of public keys you added to CloudFront to use with features like field-level encryption.
 


items
SdkInternalList<T> items

 An array of information about a public key you add to CloudFront to use with features like field-level
 encryption.
 








Class com.amazonaws.services.cloudfront.model.PublicKeySummary extends Object implements Serializable


Serialized Fields


id
String id

 ID for public key information summary.
 


name
String name

 Name for public key information summary.
 


createdTime
Date createdTime

 Creation time for public key information summary.
 


encodedKey
String encodedKey

 Encoded key for public key information summary.
 


comment
String comment

 Comment for public key information summary.
 








Class com.amazonaws.services.cloudfront.model.QueryArgProfile extends Object implements Serializable


Serialized Fields


queryArg
String queryArg

 Query argument for field-level encryption query argument-profile mapping.
 


profileId
String profileId

 ID of profile to use for field-level encryption query argument-profile mapping
 








Class com.amazonaws.services.cloudfront.model.QueryArgProfileConfig extends Object implements Serializable


Serialized Fields


forwardWhenQueryArgProfileIsUnknown
Boolean forwardWhenQueryArgProfileIsUnknown

 Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level
 encryption query argument, fle-profile, is unknown.
 


queryArgProfiles
QueryArgProfiles queryArgProfiles

 Profiles specified for query argument-profile mapping for field-level encryption.
 








Class com.amazonaws.services.cloudfront.model.QueryArgProfileEmptyException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.QueryArgProfiles extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 Number of profiles for query argument-profile mapping for field-level encryption.
 


items
SdkInternalList<T> items

 Number of items for query argument-profile mapping for field-level encryption.
 








Class com.amazonaws.services.cloudfront.model.QueryStringCacheKeys extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of whitelisted query string parameters for a cache behavior.
 


items
SdkInternalList<T> items

 A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a
 cache behavior. If Quantity is 0, you can omit Items.
 








Class com.amazonaws.services.cloudfront.model.Restrictions extends Object implements Serializable


Serialized Fields


geoRestriction
GeoRestriction geoRestriction

 A complex type that controls the countries in which your content is distributed. CloudFront determines the
 location of your users using MaxMind GeoIP databases.
 








Class com.amazonaws.services.cloudfront.model.S3Origin extends Object implements Serializable


Serialized Fields


domainName
String domainName

 The DNS name of the Amazon S3 origin.
 


originAccessIdentity
String originAccessIdentity

 The CloudFront origin access identity to associate with the distribution. Use an origin access identity to
 configure the distribution 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.
 
 
 For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the  Amazon CloudFront
 Developer Guide.
 








Class com.amazonaws.services.cloudfront.model.S3OriginConfig extends Object implements Serializable


Serialized Fields


originAccessIdentity
String originAccessIdentity

 The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure
 the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format
 of the value is:
 
 
 origin-access-identity/cloudfront/ID-of-origin-access-identity
 
 
 where  ID-of-origin-access-identity  is the value that CloudFront returned in the
 ID element when you created the origin access identity.
 
 
 If you want viewers 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.
 
 
 For more information about the origin access identity, see Serving Private
 Content through CloudFront in the Amazon CloudFront Developer Guide.
 








Class com.amazonaws.services.cloudfront.model.Signer extends Object implements Serializable


Serialized Fields


awsAccountNumber
String awsAccountNumber

 An AWS account that is included in the TrustedSigners complex type for this distribution. Valid
 values include:
 
 
 
 
 self, which is the AWS account used to create the distribution.
 
 
 
 
 An AWS 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.StatusCodes extends Object implements Serializable


Serialized Fields


quantity
Integer quantity

 The number of status codes.
 


items
SdkInternalList<T> items

 The items (status codes) for an origin group.
 








Class com.amazonaws.services.cloudfront.model.StreamingDistribution extends Object implements Serializable


Serialized Fields


id
String id

 The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.
 


aRN
String aRN

 The ARN (Amazon Resource Name) for the distribution. For example:
 arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is
 your AWS account ID.
 


status
String status

 The current status of the RTMP distribution. When the status is Deployed, the distribution's
 information is propagated to all CloudFront edge locations.
 


lastModifiedTime
Date lastModifiedTime

 The date and time that the distribution was last modified.
 


domainName
String domainName

 The domain name that corresponds to the streaming distribution, for example,
 s5c39gqb8ow64r.cloudfront.net.
 


activeTrustedSigners
ActiveTrustedSigners activeTrustedSigners

 A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex
 type for this distribution. These are the accounts that you want to allow to create signed URLs for private
 content.
 
 
 The Signer complex type lists the AWS account number of the trusted signer or self if
 the signer is the AWS account that created the distribution. The Signer element also includes the
 IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no
 KeyPairId element appears for a Signer, that signer can't create signed URLs.
 
 
 For more information, see Serving Private
 Content through CloudFront in the Amazon CloudFront Developer Guide.
 


streamingDistributionConfig
StreamingDistributionConfig streamingDistributionConfig

 The current configuration information for the RTMP distribution.
 








Class com.amazonaws.services.cloudfront.model.StreamingDistributionAlreadyExistsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.StreamingDistributionConfig extends Object implements Serializable


Serialized Fields


callerReference
String callerReference

 A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.
 
 
 If the value of CallerReference is new (regardless of the content of the
 StreamingDistributionConfig object), CloudFront creates a new distribution.
 
 
 If CallerReference is a value that you already sent in a previous request to create a distribution,
 CloudFront returns a DistributionAlreadyExists error.
 


s3Origin
S3Origin s3Origin

 A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your
 media files for distribution.
 


aliases
Aliases aliases

 A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming
 distribution.
 


comment
String comment

 Any comments you want to include about the streaming distribution.
 


logging
StreamingLoggingConfig logging

 A complex type that controls whether access logs are written for the streaming distribution.
 


trustedSigners
TrustedSigners trustedSigners

 A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content.
 If you want the distribution to use signed URLs, include this element; if you want the distribution to use public
 URLs, remove this element. For more information, see Serving Private
 Content through CloudFront in the Amazon CloudFront Developer Guide.
 


priceClass
String priceClass

 A complex type that contains information about price class for this streaming distribution.
 


enabled
Boolean enabled

 Whether the streaming distribution is enabled to accept user requests for content.
 








Class com.amazonaws.services.cloudfront.model.StreamingDistributionConfigWithTags extends Object implements Serializable


Serialized Fields


streamingDistributionConfig
StreamingDistributionConfig streamingDistributionConfig

 A streaming distribution Configuration.
 


tags
Tags tags

 A complex type that contains zero or more Tag elements.
 








Class com.amazonaws.services.cloudfront.model.StreamingDistributionList extends Object implements Serializable


Serialized Fields


marker
String marker

 The value you provided for the Marker request parameter.
 


nextMarker
String nextMarker

 If IsTruncated is true, this element is present and contains the value you can use for
 the Marker request parameter to continue listing your RTMP distributions where they left off.
 


maxItems
Integer maxItems

 The value you provided for the MaxItems request parameter.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated,
 you can make a follow-up pagination request using the Marker request parameter to retrieve more
 distributions in the list.
 


quantity
Integer quantity

 The number of streaming distributions that were created by the current AWS account.
 


items
SdkInternalList<T> items

 A complex type that contains one StreamingDistributionSummary element for each distribution that was
 created by the current AWS account.
 








Class com.amazonaws.services.cloudfront.model.StreamingDistributionNotDisabledException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.StreamingDistributionSummary extends Object implements Serializable


Serialized Fields


id
String id

 The identifier for the distribution, for example, EDFDVBD632BHDS5.
 


aRN
String aRN

 The ARN (Amazon Resource Name) for the streaming distribution. For example:
 arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where
 123456789012 is your AWS account ID.
 


status
String status

 Indicates the current status of the distribution. When the status is Deployed, the distribution's
 information is fully propagated throughout the Amazon CloudFront system.
 


lastModifiedTime
Date lastModifiedTime

 The date and time the distribution was last modified.
 


domainName
String domainName

 The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.
 


s3Origin
S3Origin s3Origin

 A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your
 media files for distribution.
 


aliases
Aliases aliases

 A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming
 distribution.
 


trustedSigners
TrustedSigners trustedSigners

 A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private
 content. If you want to require signed URLs in requests for objects in the target origin that match the
 PathPattern for this cache behavior, specify true for Enabled, and specify
 the applicable values for Quantity and Items.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.
 
 
 For more information, see Serving Private
 Content through CloudFront in the Amazon CloudFront Developer Guide.
 


comment
String comment

 The comment originally specified when this distribution was created.
 


priceClass
String priceClass

 A complex type that contains information about price class for this streaming distribution.
 


enabled
Boolean enabled

 Whether the distribution is enabled to accept end user requests for content.
 








Class com.amazonaws.services.cloudfront.model.StreamingLoggingConfig extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable
 logging when you create a streaming distribution or if you want to disable logging for an existing streaming
 distribution, specify false for Enabled, and specify empty Bucket and
 Prefix elements. If you specify false for Enabled but you specify values
 for Bucket and Prefix, the values are automatically deleted.
 


bucket
String bucket

 The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
 


prefix
String prefix

 An optional string that you want CloudFront to prefix to the access log filenames for this streaming
 distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a
 prefix, you still must include an empty Prefix element in the Logging element.
 








Class com.amazonaws.services.cloudfront.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A string that contains Tag key.
 
 
 The string length should be between 1 and 128 characters. Valid characters include a-z,
 A-Z, 0-9, space, and the special characters _ - . : / = + @.
 


value
String value

 A string that contains an optional Tag value.
 
 
 The string length should be between 0 and 256 characters. Valid characters include a-z,
 A-Z, 0-9, space, and the special characters _ - . : / = + @.
 








Class com.amazonaws.services.cloudfront.model.TagKeys extends Object implements Serializable


Serialized Fields


items
SdkInternalList<T> items

 A complex type that contains Tag key elements.
 








Class com.amazonaws.services.cloudfront.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resource
String resource

 An ARN of a CloudFront resource.
 


tags
Tags tags

 A complex type that contains zero or more Tag elements.
 








Class com.amazonaws.services.cloudfront.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudfront.model.Tags extends Object implements Serializable


Serialized Fields


items
SdkInternalList<T> items

 A complex type that contains Tag elements.
 








Class com.amazonaws.services.cloudfront.model.TooManyCacheBehaviorsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyCertificatesException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyCloudFrontOriginAccessIdentitiesException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyCookieNamesInWhiteListException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyDistributionCNAMEsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyDistributionsAssociatedToFieldLevelEncryptionConfigException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyDistributionsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyDistributionsWithLambdaAssociationsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyFieldLevelEncryptionConfigsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyFieldLevelEncryptionContentTypeProfilesException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyFieldLevelEncryptionEncryptionEntitiesException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyFieldLevelEncryptionFieldPatternsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyFieldLevelEncryptionProfilesException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyFieldLevelEncryptionQueryArgProfilesException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyHeadersInForwardedValuesException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyInvalidationsInProgressException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyLambdaFunctionAssociationsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyOriginCustomHeadersException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyOriginGroupsPerDistributionException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyOriginsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyPublicKeysException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyQueryStringParametersException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyStreamingDistributionCNAMEsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyStreamingDistributionsException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TooManyTrustedSignersException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TrustedSignerDoesNotExistException extends AmazonCloudFrontException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudfront.model.TrustedSigners extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specifies whether you want to require viewers to use signed URLs to access the files specified by
 PathPattern and TargetOriginId.
 


quantity
Integer quantity

 The number of trusted signers for this cache behavior.
 


items
SdkInternalList<T> items

 Optional: A complex type that contains trusted signers for this cache behavior. If Quantity
 is 0, you can omit Items.
 








Class com.amazonaws.services.cloudfront.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resource
String resource

 An ARN of a CloudFront resource.
 


tagKeys
TagKeys tagKeys

 A complex type that contains zero or more Tag key elements.
 








Class com.amazonaws.services.cloudfront.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudfront.model.UpdateCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cloudFrontOriginAccessIdentityConfig
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig

 The identity's configuration information.
 


id
String id

 The identity's id.
 


ifMatch
String ifMatch

 The value of the ETag header that you received when retrieving the identity's configuration. For
 example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.UpdateCloudFrontOriginAccessIdentityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cloudFrontOriginAccessIdentity
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity

 The origin access identity's information.
 


eTag
String eTag

 The current version of the configuration. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.UpdateDistributionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


distributionConfig
DistributionConfig distributionConfig

 The distribution's configuration information.
 


id
String id

 The distribution's id.
 


ifMatch
String ifMatch

 The value of the ETag header that you received when retrieving the distribution's configuration. For
 example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.UpdateDistributionResult extends AmazonWebServiceResult<ResponseMetadata> 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.UpdateFieldLevelEncryptionConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fieldLevelEncryptionConfig
FieldLevelEncryptionConfig fieldLevelEncryptionConfig

 Request to update a field-level encryption configuration.
 


id
String id

 The ID of the configuration you want to update.
 


ifMatch
String ifMatch

 The value of the ETag header that you received when retrieving the configuration identity to update.
 For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.UpdateFieldLevelEncryptionConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fieldLevelEncryption
FieldLevelEncryption fieldLevelEncryption

 Return the results of updating the configuration.
 


eTag
String eTag

 The value of the ETag header that you received when updating the configuration. For example:
 E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.UpdateFieldLevelEncryptionProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fieldLevelEncryptionProfileConfig
FieldLevelEncryptionProfileConfig fieldLevelEncryptionProfileConfig

 Request to update a field-level encryption profile.
 


id
String id

 The ID of the field-level encryption profile request.
 


ifMatch
String ifMatch

 The value of the ETag header that you received when retrieving the profile identity to update. For
 example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.UpdateFieldLevelEncryptionProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fieldLevelEncryptionProfile
FieldLevelEncryptionProfile fieldLevelEncryptionProfile

 Return the results of updating the profile.
 


eTag
String eTag

 The result of the field-level encryption profile request.
 








Class com.amazonaws.services.cloudfront.model.UpdatePublicKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


publicKeyConfig
PublicKeyConfig publicKeyConfig

 Request to update public key information.
 


id
String id

 ID of the public key to be updated.
 


ifMatch
String ifMatch

 The value of the ETag header that you received when retrieving the public key to update. For
 example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.UpdatePublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


publicKey
PublicKey publicKey

 Return the results of updating the public key.
 


eTag
String eTag

 The current version of the update public key result. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.UpdateStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamingDistributionConfig
StreamingDistributionConfig streamingDistributionConfig

 The streaming distribution's configuration information.
 


id
String id

 The streaming distribution's id.
 


ifMatch
String ifMatch

 The value of the ETag header that you received when retrieving the streaming distribution's
 configuration. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.UpdateStreamingDistributionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamingDistribution
StreamingDistribution streamingDistribution

 The streaming distribution's information.
 


eTag
String eTag

 The current version of the configuration. For example: E2QWRUHAPOMQZL.
 








Class com.amazonaws.services.cloudfront.model.ViewerCertificate extends Object implements Serializable


Serialized Fields


cloudFrontDefaultCertificate
Boolean cloudFrontDefaultCertificate

 If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, set this
 field to true.
 
 
 If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to
 false and specify values for the following fields:
 
 
 
 
 ACMCertificateArn or IAMCertificateId (specify a value for one, not both)
 
 
 
 
 MinimumProtocolVersion
 
 
 
 
 SSLSupportMethod
 
 
 


iAMCertificateId
String iAMCertificateId

 If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is
 stored in AWS
 Identity and Access Management (AWS IAM), provide the ID of the IAM certificate.
 
 
 If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVerison and
 SSLSupportMethod.
 


aCMCertificateArn
String aCMCertificateArn

 If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is
 stored in AWS Certificate Manager
 (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM
 certificates in the US East (N. Virginia) Region (us-east-1).
 
 
 If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVerison and
 SSLSupportMethod.
 


sSLSupportMethod
String sSLSupportMethod

 If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the
 distribution accepts HTTPS connections from.
 
 
 
 
 sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is
 recommended. Most browsers and clients released after 2010 support SNI.
 
 
 
 
 vip – The distribution accepts HTTPS connections from all viewers including those that don’t support
 SNI. This is not recommended, and results in additional monthly charges from CloudFront.
 
 
 
 
 If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set
 a value for this field.
 


minimumProtocolVersion
String minimumProtocolVersion

 If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy
 that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
 
 
 
 
 The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
 
 
 
 
 The ciphers that CloudFront can use to encrypt the content that it returns to viewers.
 
 
 
 
 For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer
 Guide.
 
 
 
 On the CloudFront console, this setting is called Security Policy.
 
 
 
 We recommend that you specify TLSv1.2_2018 unless your viewers are using browsers or devices that
 don’t support TLSv1.2.
 
 
 When you’re using SNI only (you set SSLSupportMethod to sni-only), you must specify
 TLSv1 or higher.
 
 
 If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set
 CloudFrontDefaultCertificate to true), CloudFront automatically sets the security
 policy to TLSv1 regardless of the value that you set here.
 


certificate
String certificate
Deprecated. 

 This field is deprecated. Use one of the following fields instead:
 
 
 
 
 ACMCertificateArn
 
 
 
 
 IAMCertificateId
 
 
 
 
 CloudFrontDefaultCertificate
 
 
 


certificateSource
String certificateSource
Deprecated. 

 This field is deprecated. Use one of the following fields instead:
 
 
 
 
 ACMCertificateArn
 
 
 
 
 IAMCertificateId
 
 
 
 
 CloudFrontDefaultCertificate
 
 
 








Package com.amazonaws.services.cloudhsm.model




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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.
 


tagList
SdkInternalList<T> tagList

 One or more tags.
 








Class com.amazonaws.services.cloudhsm.model.AddTagsToResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The status of the operation.
 








Class com.amazonaws.services.cloudhsm.model.AWSCloudHSMException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudhsm.model.CloudHsmInternalException extends AWSCloudHSMException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudhsm.model.CloudHsmServiceException extends AWSCloudHSMException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudhsm.model.CreateHapgRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


label
String label

 The label of the new high-availability partition group.
 








Class com.amazonaws.services.cloudhsm.model.CreateHapgResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hapgArn
String hapgArn

 The ARN of the high-availability partition group.
 








Class com.amazonaws.services.cloudhsm.model.CreateHsmRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subnetId
String subnetId

 The identifier of the subnet in your VPC in which to place the HSM.
 


sshKey
String sshKey

 The SSH public key to install on the HSM.
 


eniIp
String eniIp

 The IP address to assign to the HSM's ENI.
 
 
 If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.
 


iamRoleArn
String iamRoleArn

 The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
 


externalId
String externalId

 The external ID from IamRoleArn, if present.
 


subscriptionType
String subscriptionType


clientToken
String clientToken

 A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be
 ignored.
 


syslogIp
String syslogIp

 The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring
 server.
 








Class com.amazonaws.services.cloudhsm.model.CreateHsmResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hsmArn
String hsmArn

 The ARN of the HSM.
 








Class com.amazonaws.services.cloudhsm.model.CreateLunaClientRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


label
String label

 The label for the client.
 


certificate
String certificate

 The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.
 








Class com.amazonaws.services.cloudhsm.model.CreateLunaClientResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientArn
String clientArn

 The ARN of the client.
 








Class com.amazonaws.services.cloudhsm.model.DeleteHapgRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hapgArn
String hapgArn

 The ARN of the high-availability partition group to delete.
 








Class com.amazonaws.services.cloudhsm.model.DeleteHapgResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The status of the action.
 








Class com.amazonaws.services.cloudhsm.model.DeleteHsmRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hsmArn
String hsmArn

 The ARN of the HSM to delete.
 








Class com.amazonaws.services.cloudhsm.model.DeleteHsmResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The status of the operation.
 








Class com.amazonaws.services.cloudhsm.model.DeleteLunaClientRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientArn
String clientArn

 The ARN of the client to delete.
 








Class com.amazonaws.services.cloudhsm.model.DeleteLunaClientResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The status of the action.
 








Class com.amazonaws.services.cloudhsm.model.DescribeHapgRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hapgArn
String hapgArn

 The ARN of the high-availability partition group to describe.
 








Class com.amazonaws.services.cloudhsm.model.DescribeHapgResult extends AmazonWebServiceResult<ResponseMetadata> 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
SdkInternalList<T> hsmsLastActionFailed



hsmsPendingDeletion
SdkInternalList<T> hsmsPendingDeletion



hsmsPendingRegistration
SdkInternalList<T> hsmsPendingRegistration



label
String label

 The label for the high-availability partition group.
 


lastModifiedTimestamp
String lastModifiedTimestamp

 The date and time the high-availability partition group was last modified.
 


partitionSerialList
SdkInternalList<T> partitionSerialList

 The list of partition serial numbers that belong to the high-availability partition group.
 


state
String state

 The state of the high-availability partition group.
 








Class com.amazonaws.services.cloudhsm.model.DescribeHsmRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hsmArn
String hsmArn

 The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.
 


hsmSerialNumber
String hsmSerialNumber

 The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must
 be specified.
 








Class com.amazonaws.services.cloudhsm.model.DescribeHsmResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hsmArn
String hsmArn

 The ARN of the HSM.
 


status
String status

 The status of the HSM.
 


statusDetails
String statusDetails

 Contains additional information about the status of the HSM.
 


availabilityZone
String availabilityZone

 The Availability Zone that the HSM is in.
 


eniId
String eniId

 The identifier of the elastic network interface (ENI) attached to the HSM.
 


eniIp
String eniIp

 The IP address assigned to the HSM's ENI.
 


subscriptionType
String subscriptionType


subscriptionStartDate
String subscriptionStartDate

 The subscription start date.
 


subscriptionEndDate
String subscriptionEndDate

 The subscription end date.
 


vpcId
String vpcId

 The identifier of the VPC that the HSM is in.
 


subnetId
String subnetId

 The identifier of the subnet that the HSM is in.
 


iamRoleArn
String iamRoleArn

 The ARN of the IAM role assigned to the HSM.
 


serialNumber
String serialNumber

 The serial number of the HSM.
 


vendorName
String vendorName

 The name of the HSM vendor.
 


hsmType
String hsmType

 The HSM model type.
 


softwareVersion
String softwareVersion

 The HSM software version.
 


sshPublicKey
String sshPublicKey

 The public SSH key.
 


sshKeyLastUpdated
String sshKeyLastUpdated

 The date and time that the SSH key was last updated.
 


serverCertUri
String serverCertUri

 The URI of the certificate server.
 


serverCertLastUpdated
String serverCertLastUpdated

 The date and time that the server certificate was last updated.
 


partitions
SdkInternalList<T> partitions

 The list of partitions on the HSM.
 








Class com.amazonaws.services.cloudhsm.model.DescribeLunaClientRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientArn
String clientArn

 The ARN of the client.
 


certificateFingerprint
String certificateFingerprint

 The certificate fingerprint.
 








Class com.amazonaws.services.cloudhsm.model.DescribeLunaClientResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientArn
String clientArn

 The ARN of the client.
 


certificate
String certificate

 The certificate installed on the HSMs used by this client.
 


certificateFingerprint
String certificateFingerprint

 The certificate fingerprint.
 


lastModifiedTimestamp
String lastModifiedTimestamp

 The date and time the client was last modified.
 


label
String label

 The label of the client.
 








Class com.amazonaws.services.cloudhsm.model.GetConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientArn
String clientArn

 The ARN of the client.
 


clientVersion
String clientVersion

 The client version.
 


hapgList
SdkInternalList<T> hapgList

 A list of ARNs that identify the high-availability partition groups that are associated with the client.
 








Class com.amazonaws.services.cloudhsm.model.GetConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configType
String configType

 The type of credentials.
 


configFile
String configFile

 The chrystoki.conf configuration file.
 


configCred
String configCred

 The certificate file containing the server.pem files of the HSMs.
 








Class com.amazonaws.services.cloudhsm.model.InvalidRequestException extends AWSCloudHSMException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudhsm.model.ListAvailableZonesRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.cloudhsm.model.ListAvailableZonesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


aZList
SdkInternalList<T> aZList

 The list of Availability Zones that have available AWS CloudHSM capacity.
 








Class com.amazonaws.services.cloudhsm.model.ListHapgsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The NextToken value from a previous call to ListHapgs. Pass null if this is the first
 call.
 








Class com.amazonaws.services.cloudhsm.model.ListHapgsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hapgList
SdkInternalList<T> hapgList

 The list of high-availability partition groups.
 


nextToken
String nextToken

 If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of
 items.
 








Class com.amazonaws.services.cloudhsm.model.ListHsmsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The NextToken value from a previous call to ListHsms. Pass null if this is the first
 call.
 








Class com.amazonaws.services.cloudhsm.model.ListHsmsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hsmList
SdkInternalList<T> hsmList

 The list of ARNs that identify the HSMs.
 


nextToken
String nextToken

 If not null, more results are available. Pass this value to ListHsms to retrieve the next set of
 items.
 








Class com.amazonaws.services.cloudhsm.model.ListLunaClientsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The NextToken value from a previous call to ListLunaClients. Pass null if this is the
 first call.
 








Class com.amazonaws.services.cloudhsm.model.ListLunaClientsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientList
SdkInternalList<T> clientList

 The list of clients.
 


nextToken
String nextToken

 If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of
 items.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
 








Class com.amazonaws.services.cloudhsm.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagList
SdkInternalList<T> tagList

 One or more tags.
 








Class com.amazonaws.services.cloudhsm.model.ModifyHapgRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hapgArn
String hapgArn

 The ARN of the high-availability partition group to modify.
 


label
String label

 The new label for the high-availability partition group.
 


partitionSerialList
SdkInternalList<T> partitionSerialList

 The list of partition serial numbers to make members of the high-availability partition group.
 








Class com.amazonaws.services.cloudhsm.model.ModifyHapgResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hapgArn
String hapgArn

 The ARN of the high-availability partition group.
 








Class com.amazonaws.services.cloudhsm.model.ModifyHsmRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hsmArn
String hsmArn

 The ARN of the HSM to modify.
 


subnetId
String subnetId

 The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the
 current subnet.
 


eniIp
String eniIp

 The new IP address for the elastic network interface (ENI) attached to the HSM.
 
 
 If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly
 chosen from the CIDR range of the new subnet.
 


iamRoleArn
String iamRoleArn

 The new IAM role ARN.
 


externalId
String externalId

 The new external ID.
 


syslogIp
String syslogIp

 The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring
 server.
 








Class com.amazonaws.services.cloudhsm.model.ModifyHsmResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hsmArn
String hsmArn

 The ARN of the HSM.
 








Class com.amazonaws.services.cloudhsm.model.ModifyLunaClientRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientArn
String clientArn

 The ARN of the client.
 


certificate
String certificate

 The new certificate for the client.
 








Class com.amazonaws.services.cloudhsm.model.ModifyLunaClientResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientArn
String clientArn

 The ARN of the client.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
 


tagKeyList
SdkInternalList<T> tagKeyList

 The tag key or keys to remove.
 
 
 Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use
 AddTagsToResource.
 








Class com.amazonaws.services.cloudhsm.model.RemoveTagsFromResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The status of the operation.
 








Class com.amazonaws.services.cloudhsm.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key of the tag.
 


value
String value

 The value of the tag.
 








Package com.amazonaws.services.cloudhsmv2.model




Class com.amazonaws.services.cloudhsmv2.model.AWSCloudHSMV2Exception extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudhsmv2.model.Backup extends Object implements Serializable


Serialized Fields


backupId
String backupId

 The identifier (ID) of the backup.
 


backupState
String backupState

 The state of the backup.
 


clusterId
String clusterId

 The identifier (ID) of the cluster that was backed up.
 


createTimestamp
Date createTimestamp

 The date and time when the backup was created.
 


copyTimestamp
Date copyTimestamp

 The date and time when the backup was copied from a source backup.
 


sourceRegion
String sourceRegion

 The AWS region that contains the source backup from which the new backup was copied.
 


sourceBackup
String sourceBackup

 The identifier (ID) of the source backup from which the new backup was copied.
 


sourceCluster
String sourceCluster

 The identifier (ID) of the cluster containing the source backup from which the new backup was copied. .
 


deleteTimestamp
Date deleteTimestamp

 The date and time when the backup will be permanently deleted.
 


tagList
List<E> tagList








Class com.amazonaws.services.cloudhsmv2.model.Certificates extends Object implements Serializable


Serialized Fields


clusterCsr
String clusterCsr

 The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is
 UNINITIALIZED.
 


hsmCertificate
String hsmCertificate

 The HSM certificate issued (signed) by the HSM hardware.
 


awsHardwareCertificate
String awsHardwareCertificate

 The HSM hardware certificate issued (signed) by AWS CloudHSM.
 


manufacturerHardwareCertificate
String manufacturerHardwareCertificate

 The HSM hardware certificate issued (signed) by the hardware manufacturer.
 


clusterCertificate
String clusterCertificate

 The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.
 








Class com.amazonaws.services.cloudhsmv2.model.CloudHsmAccessDeniedException extends AWSCloudHSMV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudhsmv2.model.CloudHsmInternalFailureException extends AWSCloudHSMV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudhsmv2.model.CloudHsmInvalidRequestException extends AWSCloudHSMV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudhsmv2.model.CloudHsmResourceNotFoundException extends AWSCloudHSMV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudhsmv2.model.CloudHsmServiceException extends AWSCloudHSMV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudhsmv2.model.CloudHsmTagException extends AWSCloudHSMV2Exception implements Serializable

serialVersionUID:
1L





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


Serialized Fields


backupPolicy
String backupPolicy

 The cluster's backup policy.
 


clusterId
String clusterId

 The cluster's identifier (ID).
 


createTimestamp
Date createTimestamp

 The date and time when the cluster was created.
 


hsms
List<E> hsms

 Contains information about the HSMs in the cluster.
 


hsmType
String hsmType

 The type of HSM that the cluster contains.
 


preCoPassword
String preCoPassword

 The default password for the cluster's Pre-Crypto Officer (PRECO) user.
 


securityGroup
String securityGroup

 The identifier (ID) of the cluster's security group.
 


sourceBackupId
String sourceBackupId

 The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created
 from a backup.
 


state
String state

 The cluster's state.
 


stateMessage
String stateMessage

 A description of the cluster's state.
 


subnetMapping
Map<K,V> subnetMapping

 A map from availability zone to the cluster’s subnet in that availability zone.
 


vpcId
String vpcId

 The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
 


certificates
Certificates certificates

 Contains one or more certificates or a certificate signing request (CSR).
 


tagList
List<E> tagList








Class com.amazonaws.services.cloudhsmv2.model.CopyBackupToRegionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationRegion
String destinationRegion

 The AWS region that will contain your copied CloudHSM cluster backup.
 


backupId
String backupId

 The ID of the backup that will be copied to the destination region.
 


tagList
List<E> tagList








Class com.amazonaws.services.cloudhsmv2.model.CopyBackupToRegionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


destinationBackup
DestinationBackup destinationBackup

 Information on the backup that will be copied to the destination region, including CreateTimestamp, SourceBackup,
 SourceCluster, and Source Region. CreateTimestamp of the destination backup will be the same as that of the
 source backup.
 
 
 You will need to use the sourceBackupID returned in this operation to use the DescribeBackups
 operation on the backup that will be copied to the destination region.
 








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


Serialized Fields


subnetIds
List<E> subnetIds

 The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If
 you specify multiple subnets, they must meet the following criteria:
 
 
 
 
 All subnets must be in the same virtual private cloud (VPC).
 
 
 
 
 You can specify only one subnet per Availability Zone.
 
 
 


hsmType
String hsmType

 The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium.
 


sourceBackupId
String sourceBackupId

 The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead
 of creating a new cluster. To find the backup ID, use DescribeBackups.
 


tagList
List<E> tagList








Class com.amazonaws.services.cloudhsmv2.model.CreateClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 Information about the cluster that was created.
 








Class com.amazonaws.services.cloudhsmv2.model.CreateHsmRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.
 


availabilityZone
String availabilityZone

 The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use
 DescribeClusters.
 


ipAddress
String ipAddress

 The HSM's IP address. If you specify an IP address, use an available address from the subnet that maps to the
 Availability Zone where you are creating the HSM. If you don't specify an IP address, one is chosen for you from
 that subnet.
 








Class com.amazonaws.services.cloudhsmv2.model.CreateHsmResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hsm
Hsm hsm

 Information about the HSM that was created.
 








Class com.amazonaws.services.cloudhsmv2.model.DeleteBackupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


backupId
String backupId

 The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.
 








Class com.amazonaws.services.cloudhsmv2.model.DeleteBackupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


backup
Backup backup

 Information on the Backup object deleted.
 








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


Serialized Fields


clusterId
String clusterId

 The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.
 








Class com.amazonaws.services.cloudhsmv2.model.DeleteClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 Information about the cluster that was deleted.
 








Class com.amazonaws.services.cloudhsmv2.model.DeleteHsmRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The identifier (ID) of the cluster that contains the HSM that you are deleting.
 


hsmId
String hsmId

 The identifier (ID) of the HSM that you are deleting.
 


eniId
String eniId

 The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.
 


eniIp
String eniIp

 The IP address of the elastic network interface (ENI) of the HSM that you are deleting.
 








Class com.amazonaws.services.cloudhsmv2.model.DeleteHsmResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hsmId
String hsmId

 The identifier (ID) of the HSM that was deleted.
 








Class com.amazonaws.services.cloudhsmv2.model.DescribeBackupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The NextToken value that you received in the previous response. Use this value to get more backups.
 


maxResults
Integer maxResults

 The maximum number of backups to return in the response. When there are more backups than the number you specify,
 the response contains a NextToken value.
 


filters
Map<K,V> filters

 One or more filters to limit the items returned in the response.
 
 
 Use the backupIds filter to return only the specified backups. Specify backups by their backup
 identifier (ID).
 
 
 Use the sourceBackupIds filter to return only the backups created from a source backup. The
 sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.
 
 
 Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by
 their cluster identifier (ID).
 
 
 Use the states filter to return only backups that match the specified state.
 


sortAscending
Boolean sortAscending

 Designates whether or not to sort the return backups by ascending chronological order of generation.
 








Class com.amazonaws.services.cloudhsmv2.model.DescribeBackupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


backups
List<E> backups

 A list of backups.
 


nextToken
String nextToken

 An opaque string that indicates that the response contains only a subset of backups. Use this value in a
 subsequent DescribeBackups request to get more backups.
 








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


Serialized Fields


filters
Map<K,V> filters

 One or more filters to limit the items returned in the response.
 
 
 Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster
 identifier (ID).
 
 
 Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs).
 Specify VPCs by their VPC identifier (ID).
 
 
 Use the states filter to return only clusters that match the specified state.
 


nextToken
String nextToken

 The NextToken value that you received in the previous response. Use this value to get more clusters.
 


maxResults
Integer maxResults

 The maximum number of clusters to return in the response. When there are more clusters than the number you
 specify, the response contains a NextToken value.
 








Class com.amazonaws.services.cloudhsmv2.model.DescribeClustersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusters
List<E> clusters

 A list of clusters.
 


nextToken
String nextToken

 An opaque string that indicates that the response contains only a subset of clusters. Use this value in a
 subsequent DescribeClusters request to get more clusters.
 








Class com.amazonaws.services.cloudhsmv2.model.DestinationBackup extends Object implements Serializable


Serialized Fields


createTimestamp
Date createTimestamp

 The date and time when both the source backup was created.
 


sourceRegion
String sourceRegion

 The AWS region that contains the source backup from which the new backup was copied.
 


sourceBackup
String sourceBackup

 The identifier (ID) of the source backup from which the new backup was copied.
 


sourceCluster
String sourceCluster

 The identifier (ID) of the cluster containing the source backup from which the new backup was copied.
 








Class com.amazonaws.services.cloudhsmv2.model.Hsm extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone that contains the HSM.
 


clusterId
String clusterId

 The identifier (ID) of the cluster that contains the HSM.
 


subnetId
String subnetId

 The subnet that contains the HSM's elastic network interface (ENI).
 


eniId
String eniId

 The identifier (ID) of the HSM's elastic network interface (ENI).
 


eniIp
String eniIp

 The IP address of the HSM's elastic network interface (ENI).
 


hsmId
String hsmId

 The HSM's identifier (ID).
 


state
String state

 The HSM's state.
 


stateMessage
String stateMessage

 A description of the HSM's state.
 








Class com.amazonaws.services.cloudhsmv2.model.InitializeClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.
 


signedCert
String signedCert

 The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in
 PEM format and can contain a maximum of 5000 characters.
 


trustAnchor
String trustAnchor

 The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate.
 You must use a self-signed certificate. The certificate used to sign the HSM CSR must be directly available, and
 thus must be the root certificate. The certificate must be in PEM format and can contain a maximum of 5000
 characters.
 








Class com.amazonaws.services.cloudhsmv2.model.InitializeClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


state
String state

 The cluster's state.
 


stateMessage
String stateMessage

 A description of the cluster's state.
 








Class com.amazonaws.services.cloudhsmv2.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceId
String resourceId

 The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use
 DescribeClusters.
 


nextToken
String nextToken

 The NextToken value that you received in the previous response. Use this value to get more tags.
 


maxResults
Integer maxResults

 The maximum number of tags to return in the response. When there are more tags than the number you specify, the
 response contains a NextToken value.
 








Class com.amazonaws.services.cloudhsmv2.model.ListTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagList
List<E> tagList

 A list of tags.
 


nextToken
String nextToken

 An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent
 ListTags request to get more tags.
 








Class com.amazonaws.services.cloudhsmv2.model.RestoreBackupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


backupId
String backupId

 The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.
 








Class com.amazonaws.services.cloudhsmv2.model.RestoreBackupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


backup
Backup backup

 Information on the Backup object created.
 








Class com.amazonaws.services.cloudhsmv2.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key of the tag.
 


value
String value

 The value of the tag.
 








Class com.amazonaws.services.cloudhsmv2.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceId
String resourceId

 The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use
 DescribeClusters.
 


tagList
List<E> tagList

 A list of one or more tags.
 








Class com.amazonaws.services.cloudhsmv2.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudhsmv2.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceId
String resourceId

 The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use
 DescribeClusters.
 


tagKeyList
List<E> tagKeyList

 A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.
 








Class com.amazonaws.services.cloudhsmv2.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.cloudsearchdomain.model




Class com.amazonaws.services.cloudsearchdomain.model.AmazonCloudSearchDomainException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudsearchdomain.model.Bucket extends Object implements Serializable


Serialized Fields


value
String value

 The facet value being counted.
 


count
Long count

 The number of hits that contain the facet value in the specified facet field.
 








Class com.amazonaws.services.cloudsearchdomain.model.BucketInfo extends Object implements Serializable


Serialized Fields


buckets
SdkInternalList<T> buckets

 A list of the calculated facet values and counts.
 








Class com.amazonaws.services.cloudsearchdomain.model.DocumentServiceException extends AmazonCloudSearchDomainException implements Serializable

serialVersionUID:
1L



Serialized Fields


status
String status

 The return status of a document upload request, error or success.
 








Class com.amazonaws.services.cloudsearchdomain.model.DocumentServiceWarning extends Object implements Serializable


Serialized Fields


message
String message

 The description for a warning returned by the document service.
 








Class com.amazonaws.services.cloudsearchdomain.model.FieldStats extends Object implements Serializable


Serialized Fields


min
String min

 The minimum value found in the specified field in the result set.
 
 
 If the field is numeric (int, int-array, double, or
 double-array), min is the string representation of a double-precision 64-bit floating
 point value. If the field is date or date-array, min is the string
 representation of a date with the format specified in IETF
 RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
 


max
String max

 The maximum value found in the specified field in the result set.
 
 
 If the field is numeric (int, int-array, double, or
 double-array), max is the string representation of a double-precision 64-bit floating
 point value. If the field is date or date-array, max is the string
 representation of a date with the format specified in IETF
 RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
 


count
Long count

 The number of documents that contain a value in the specified field in the result set.
 


missing
Long missing

 The number of documents that do not contain a value in the specified field in the result set.
 


sum
Double sum

 The sum of the field values across the documents in the result set. null for date fields.
 


sumOfSquares
Double sumOfSquares

 The sum of all field values in the result set squared.
 


mean
String mean

 The average of the values found in the specified field in the result set.
 
 
 If the field is numeric (int, int-array, double, or
 double-array), mean is the string representation of a double-precision 64-bit floating
 point value. If the field is date or date-array, mean is the string
 representation of a date with the format specified in IETF
 RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
 


stddev
Double stddev

 The standard deviation of the values in the specified field in the result set.
 








Class com.amazonaws.services.cloudsearchdomain.model.Hit extends Object implements Serializable


Serialized Fields


id
String id

 The document ID of a document that matches the search request.
 


fields
SdkInternalMap<K,V> fields

 The fields returned from a document that matches the search request.
 


exprs
SdkInternalMap<K,V> exprs

 The expressions returned from a document that matches the search request.
 


highlights
SdkInternalMap<K,V> highlights

 The highlights returned from a document that matches the search request.
 








Class com.amazonaws.services.cloudsearchdomain.model.Hits extends Object implements Serializable


Serialized Fields


found
Long found

 The total number of documents that match the search request.
 


start
Long start

 The index of the first matching document.
 


cursor
String cursor

 A cursor that can be used to retrieve the next set of matching documents when you want to page through a large
 result set.
 


hit
SdkInternalList<T> hit

 A document that matches the search request.
 








Class com.amazonaws.services.cloudsearchdomain.model.SearchException extends AmazonCloudSearchDomainException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudsearchdomain.model.SearchRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cursor
String cursor

 Retrieves a cursor value you can use to page through large result sets. Use the size parameter to
 control the number of hits to include in each response. You can specify either the cursor or
 start parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor
 value to initial. In subsequent requests, specify the cursor value returned in the hits section of
 the response.
 
 
 For more information, see Paginating
 Results in the Amazon CloudSearch Developer Guide.
 


expr
String expr

 Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria.
 You can also specify expressions as return fields.
 
 
 You specify the expressions in JSON using the form {"EXPRESSIONNAME":"EXPRESSION"}. You can define
 and use multiple expressions in a search request. For example:
 
 
  {"expression1":"_score*rating", "expression2":"(1/rank)*year"} 
 
 
 For information about the variables, operators, and functions you can use in expressions, see Writing Expressions in the Amazon CloudSearch Developer Guide.
 


facet
String facet

 Specifies one or more fields for which to get facet information, and options that control how the facet
 information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and
 options are specified in JSON using the form
 {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}.
 
 
 You can specify the following faceting options:
 
 
 
 
 buckets specifies an array of the facet values or ranges to count. Ranges are specified using the
 same syntax that you use to search for a range of values. For more information, see  Searching for a Range
 of Values in the Amazon CloudSearch Developer Guide. Buckets are returned in the order they are
 specified in the request. The sort and size options are not valid if you specify
 buckets.
 
 
 
 
 size specifies the maximum number of facets to include in the results. By default, Amazon
 CloudSearch returns counts for the top 10. The size parameter is only valid when you specify the
 sort option; it cannot be used in conjunction with buckets.
 
 
 
 
 sort specifies how you want to sort the facets in the results: bucket or
 count. Specify bucket to sort alphabetically or numerically by facet value (in
 ascending order). Specify count to sort by the facet counts computed for each facet value (in
 descending order). To retrieve facet counts for particular values or ranges of values, use the
 buckets option instead of sort.
 
 
 
 
 If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet
 count, and the top 10 facets are returned in the results.
 
 
 To count particular buckets of values, use the buckets option. For example, the following request
 uses the buckets option to calculate and return facet counts by decade.
 
 
  {"year":{"buckets":["[1970,1979]","[1980,1989]","[1990,1999]","[2000,2009]","[2010,}"]}} 
 
 
 To sort facets by facet count, use the count option. For example, the following request sets the
 sort option to count to sort the facet values by facet count, with the facet values
 that have the most matching documents listed first. Setting the size option to 3 returns only the
 top three facet values.
 
 
  {"year":{"sort":"count","size":3}} 
 
 
 To sort the facets by value, use the bucket option. For example, the following request sets the
 sort option to bucket to sort the facet values numerically by year, with earliest year
 listed first.
 
 
  {"year":{"sort":"bucket"}} 
 
 
 For more information, see Getting and Using Facet
 Information in the Amazon CloudSearch Developer Guide.
 


filterQuery
String filterQuery

 Specifies a structured query that filters the results of a search without affecting how the results are scored
 and sorted. You use filterQuery in conjunction with the query parameter to filter the
 documents that match the constraints specified in the query parameter. Specifying a filter controls
 only which matching documents are included in the results, it has no effect on how they are scored and sorted.
 The filterQuery parameter supports the full structured query syntax.
 
 
 For more information about using filters, see Filtering Matching
 Documents in the Amazon CloudSearch Developer Guide.
 


highlight
String highlight

 Retrieves highlights for matches in the specified text or text-array fields. Each
 specified field must be highlight enabled in the domain configuration. The fields and options are specified in
 JSON using the form
 {"FIELD":{"OPTION":VALUE,"OPTION:"STRING"},"FIELD":{"OPTION":VALUE,"OPTION":"STRING"}}.
 
 
 You can specify the following highlight options:
 
 
  format: specifies the format of the data in the text field: text or
 html. When data is returned as HTML, all non-alphanumeric characters are encoded. The default is
 html.
  max_phrases: specifies the maximum number of occurrences of the search term(s) you want to
 highlight. By default, the first occurrence is highlighted.
  pre_tag: specifies the string to prepend to an occurrence of a search term. The default for HTML
 highlights is &lt;em&gt;. 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 &lt;/em&gt;. 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: &lt;em>search-term&lt;/em&gt;.
 
 
 For example, the following request retrieves highlights for the actors and title
 fields.
 
 
 { "actors": {}, "title": {"format": "text","max_phrases": 2,"pre_tag": "","post_tag": ""} }
 


partial
Boolean partial

 Enables partial results to be returned if one or more index partitions are unavailable. When your search index is
 partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every
 partition can be queried. This means that the failure of a single search instance can result in 5xx (internal
 server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and
 includes the percentage of documents searched in the search results (percent-searched). This enables you to more
 gracefully degrade your users' search experience. For example, rather than displaying no results, you could
 display the partial results and a message indicating that the results might be incomplete due to a temporary
 system outage.
 


query
String query

 Specifies the search criteria for the request. How you specify the search criteria depends on the query parser
 used for the request and the parser options specified in the queryOptions parameter. By default, the
 simple query parser is used to process requests. To use the structured,
 lucene, or dismax query parser, you must also specify the queryParser
 parameter.
 
 
 For more information about specifying search criteria, see Searching Your Data in the
 Amazon CloudSearch Developer Guide.
 


queryOptions
String queryOptions

 Configures options for the query parser specified in the queryParser parameter. You specify the
 options in JSON using the following form
 {"OPTION1":"VALUE1","OPTION2":VALUE2"..."OPTIONN":"VALUEN"}.
 
 
 The options you can configure vary according to which parser you use:
 
 
 defaultOperator: The default operator used to combine individual terms in the search string. For
 example: defaultOperator: 'or'. For the dismax parser, you specify a percentage that
 represents the percentage of terms in the search string (rounded down) that must match, rather than a default
 operator. A value of 0% is the equivalent to OR, and a value of 100% is equivalent to
 AND. The percentage must be specified as a value in the range 0-100 followed by the percent (%) symbol. For
 example, defaultOperator: 50%. Valid values: and, or, a percentage in the
 range 0%-100% (dismax). Default: and (simple, structured,
 lucene) or 100 (dismax). Valid for: simple,
 structured, lucene, and dismax.
 fields: An array of the fields to search when no fields are specified in a search. If no fields
 are specified in a search and this option is not specified, all text and text-array fields are searched. You can
 specify a weight for each field to control the relative importance of each field when Amazon CloudSearch
 calculates relevance scores. To specify a field weight, append a caret (^) symbol and the weight to
 the field name. For example, to boost the importance of the title field over the
 description field you could specify: "fields":["title^5","description"]. Valid values:
 The name of any configured field and an optional numeric value greater than zero. Default: All text
 and text-array fields. Valid for: simple, structured, lucene,
 and dismax.
 operators: An array of the operators or special characters you want to disable for the simple
 query parser. If you disable the and, or, or not operators, the
 corresponding operators (+, |, -) have no special meaning and are dropped
 from the search string. Similarly, disabling prefix disables the wildcard operator (*)
 and disabling phrase disables the ability to search for phrases by enclosing phrases in double
 quotes. Disabling precedence disables the ability to control order of precedence using parentheses. Disabling
 near disables the ability to use the ~ operator to perform a sloppy phrase search. Disabling the
 fuzzy operator disables the ability to use the ~ operator to perform a fuzzy search.
 escape disables the ability to use a backslash (\) to escape special characters within
 the search string. Disabling whitespace is an advanced option that prevents the parser from tokenizing on
 whitespace, which can be useful for Vietnamese. (It prevents Vietnamese words from being split incorrectly.) For
 example, you could disable all operators other than the phrase operator to support just simple term and phrase
 queries: "operators":["and","not","or", "prefix"]. Valid values: and,
 escape, fuzzy, near, not, or,
 phrase, precedence, prefix, whitespace. Default: All
 operators and special characters are enabled. Valid for: simple.
 phraseFields: An array of the text or text-array fields you want to
 use for phrase searches. When the terms in the search string appear in close proximity within a field, the field
 scores higher. You can specify a weight for each field to boost that score. The phraseSlop option
 controls how much the matches can deviate from the search string and still be boosted. To specify a field weight,
 append a caret (^) symbol and the weight to the field name. For example, to boost phrase matches in
 the title field over the abstract field, you could specify:
 "phraseFields":["title^3", "plot"] Valid values: The name of any text or
 text-array field and an optional numeric value greater than zero. Default: No fields. If you don't
 specify any fields with phraseFields, proximity scoring is disabled even if phraseSlop
 is specified. Valid for: dismax.
 phraseSlop: An integer value that specifies how much matches can deviate from the search phrase
 and still be boosted according to the weights specified in the phraseFields option; for example,
 phraseSlop: 2. You must also specify phraseFields to enable proximity scoring. Valid
 values: positive integers. Default: 0. Valid for: dismax.
 explicitPhraseSlop: An integer value that specifies how much a match can deviate from the search
 phrase when the phrase is enclosed in double quotes in the search string. (Phrases that exceed this proximity
 distance are not considered a match.) For example, to specify a slop of three for dismax phrase queries, you
 would specify "explicitPhraseSlop":3. Valid values: positive integers. Default: 0. Valid for:
 dismax.
 tieBreaker: When a term in the search string is found in a document's field, a score is
 calculated for that field based on how common the word is in that field compared to other documents. If the term
 occurs in multiple fields within a document, by default only the highest scoring field contributes to the
 document's overall score. You can specify a tieBreaker value to enable the matches in lower-scoring
 fields to contribute to the document's score. That way, if two documents have the same max field score for a
 particular term, the score for the document that has matches in more fields will be higher. The formula for
 calculating the score with a tieBreaker is
 (max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields). Set
 tieBreaker to 0 to disregard all but the highest scoring field (pure max):
 "tieBreaker":0. Set to 1 to sum the scores from all fields (pure sum): "tieBreaker":1.
 Valid values: 0.0 to 1.0. Default: 0.0. Valid for: dismax.
 


queryParser
String queryParser

 Specifies which query parser to use to process the request. If queryParser is not specified, Amazon
 CloudSearch uses the simple query parser.
 
 
 Amazon CloudSearch supports four query parsers:
 
 
  simple: perform simple searches of text and text-array fields. By
 default, the simple query parser searches all text and text-array fields.
 You can specify which fields to search by with the queryOptions parameter. If you prefix a search
 term with a plus sign (+) documents must contain the term to be considered a match. (This is the default, unless
 you configure the default operator with the queryOptions parameter.) You can use the -
 (NOT), | (OR), and * (wildcard) operators to exclude particular terms, find results
 that match any of the specified terms, or search for a prefix. To search for a phrase rather than individual
 terms, enclose the phrase in double quotes. For more information, see Searching for Text in
 the Amazon CloudSearch Developer Guide.
  structured: perform advanced searches by combining multiple expressions to define the search
 criteria. You can also search within particular fields, search for values and ranges of values, and use advanced
 options such as term boosting, matchall, and near. For more information, see Constructing
 Compound Queries in the Amazon CloudSearch Developer Guide.
  lucene: search using the Apache Lucene query parser syntax. For more information, see Apache Lucene Query Parser Syntax.
  dismax: search using the simplified subset of the Apache Lucene query parser syntax defined by
 the DisMax query parser. For more information, see DisMax Query Parser Syntax.
 


returnValue
String returnValue

 Specifies the field and expression values to include in the response. Multiple fields or expressions are
 specified as a comma-separated list. By default, a search response includes all return enabled fields (
 _all_fields). To return only the document IDs for the matching documents, specify
 _no_fields. To retrieve the relevance score calculated for each document, specify
 _score.
 


size
Long size

 Specifies the maximum number of search hits to include in the response.
 


sort
String sort

 Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are
 specified as a comma-separated list. You must specify the sort direction (asc or desc)
 for each field; for example, year desc,title asc. To use a field to sort results, the field must be
 sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no sort
 parameter is specified, results are sorted by their default relevance scores in descending order:
 _score desc. You can also sort by document ID (_id asc) and version (
 _version desc).
 
 
 For more information, see Sorting Results in
 the Amazon CloudSearch Developer Guide.
 


start
Long start

 Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the
 first result is at index 0. You can specify either the start or cursor parameter in a
 request, they are mutually exclusive.
 
 
 For more information, see Paginating
 Results in the Amazon CloudSearch Developer Guide.
 


stats
String stats

 Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled
 in the domain configuration. The fields are specified in JSON using the form:
 
 {"FIELD-A":{},"FIELD-B":{}}
 
 There are currently no options supported for statistics.
 








Class com.amazonaws.services.cloudsearchdomain.model.SearchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
SearchStatus status

 The status information returned for the search request.
 


hits
Hits hits

 The documents that match the search criteria.
 


facets
SdkInternalMap<K,V> facets

 The requested facet information.
 


stats
SdkInternalMap<K,V> stats

 The requested field statistics information.
 








Class com.amazonaws.services.cloudsearchdomain.model.SearchStatus extends Object implements Serializable


Serialized Fields


timems
Long timems

 How long it took to process the request, in milliseconds.
 


rid
String rid

 The encrypted resource ID for the request.
 








Class com.amazonaws.services.cloudsearchdomain.model.SuggestionMatch extends Object implements Serializable


Serialized Fields


suggestion
String suggestion

 The string that matches the query string specified in the SuggestRequest.
 


score
Long score

 The relevance score of a suggested match.
 


id
String id

 The document ID of the suggested document.
 








Class com.amazonaws.services.cloudsearchdomain.model.SuggestModel extends Object implements Serializable


Serialized Fields


query
String query

 The query string specified in the suggest request.
 


found
Long found

 The number of documents that were found to match the query string.
 


suggestions
SdkInternalList<T> suggestions

 The documents that match the query string.
 








Class com.amazonaws.services.cloudsearchdomain.model.SuggestRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


query
String query

 Specifies the string for which you want to get suggestions.
 


suggester
String suggester

 Specifies the name of the suggester to use to find suggested matches.
 


size
Long size

 Specifies the maximum number of suggestions to return.
 








Class com.amazonaws.services.cloudsearchdomain.model.SuggestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
SuggestStatus status

 The status of a SuggestRequest. Contains the resource ID (rid) and how long it took to
 process the request (timems).
 


suggest
SuggestModel suggest

 Container for the matching search suggestion information.
 








Class com.amazonaws.services.cloudsearchdomain.model.SuggestStatus extends Object implements Serializable


Serialized Fields


timems
Long timems

 How long it took to process the request, in milliseconds.
 


rid
String rid

 The encrypted resource ID for the request.
 








Class com.amazonaws.services.cloudsearchdomain.model.UploadDocumentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


documents
InputStream documents

 A batch of documents formatted in JSON or HTML.
 


contentType
String contentType

 The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:
 
 
 application/json
 application/xml
 


contentLength
Long contentLength








Class com.amazonaws.services.cloudsearchdomain.model.UploadDocumentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The status of an UploadDocumentsRequest.
 


adds
Long adds

 The number of documents that were added to the search domain.
 


deletes
Long deletes

 The number of documents that were deleted from the search domain.
 


warnings
SdkInternalList<T> warnings

 Any warnings returned by the document service about the documents being uploaded.
 








Package com.amazonaws.services.cloudsearchv2.model




Class com.amazonaws.services.cloudsearchv2.model.AccessPoliciesStatus extends Object implements Serializable


Serialized Fields


options
String options


status
OptionStatus status








Class com.amazonaws.services.cloudsearchv2.model.AmazonCloudSearchException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudsearchv2.model.AnalysisOptions extends Object implements Serializable


Serialized Fields


synonyms
String synonyms

 A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each
 sub-array is a group of terms where each term in the group is considered a synonym of every other term in the
 group. The aliases value is an object that contains a collection of string:value pairs where the string specifies
 a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of
 the specified term, but the term is not considered a synonym of the alias. For more information about specifying
 synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
 


stopwords
String stopwords

 A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]
 . The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions
 are not supported.
 


stemmingDictionary
String stemmingDictionary

 A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example,
 {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in
 addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to
 correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
 


japaneseTokenizationDictionary
String japaneseTokenizationDictionary

 A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton.
 The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is
 only valid for Japanese language fields.
 


algorithmicStemming
String algorithmicStemming

 The level of algorithmic stemming to perform: none, minimal, light, or
 full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
 








Class com.amazonaws.services.cloudsearchv2.model.AnalysisScheme extends Object implements Serializable


Serialized Fields


analysisSchemeName
String analysisSchemeName


analysisSchemeLanguage
String analysisSchemeLanguage


analysisOptions
AnalysisOptions analysisOptions








Class com.amazonaws.services.cloudsearchv2.model.AnalysisSchemeStatus extends Object implements Serializable


Serialized Fields


options
AnalysisScheme options


status
OptionStatus status








Class com.amazonaws.services.cloudsearchv2.model.AvailabilityOptionsStatus extends Object implements Serializable


Serialized Fields


options
Boolean options

 The availability options configured for the domain.
 


status
OptionStatus status








Class com.amazonaws.services.cloudsearchv2.model.BaseException extends AmazonCloudSearchException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.cloudsearchv2.model.BuildSuggestersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName








Class com.amazonaws.services.cloudsearchv2.model.BuildSuggestersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fieldNames
SdkInternalList<T> fieldNames








Class com.amazonaws.services.cloudsearchv2.model.CreateDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-).
 Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.
 








Class com.amazonaws.services.cloudsearchv2.model.CreateDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainStatus
DomainStatus domainStatus








Class com.amazonaws.services.cloudsearchv2.model.DateArrayOptions extends Object implements Serializable


Serialized Fields


defaultValue
String defaultValue
A value to use for the field if the field isn't specified for a document.


sourceFields
String sourceFields

 A list of source fields to map to the field.
 


facetEnabled
Boolean facetEnabled

 Whether facet information can be returned for the field.
 


searchEnabled
Boolean searchEnabled

 Whether the contents of the field are searchable.
 


returnEnabled
Boolean returnEnabled

 Whether the contents of the field can be returned in the search results.
 








Class com.amazonaws.services.cloudsearchv2.model.DateOptions extends Object implements Serializable


Serialized Fields


defaultValue
String defaultValue
A value to use for the field if the field isn't specified for a document.


sourceField
String sourceField


facetEnabled
Boolean facetEnabled

 Whether facet information can be returned for the field.
 


searchEnabled
Boolean searchEnabled

 Whether the contents of the field are searchable.
 


returnEnabled
Boolean returnEnabled

 Whether the contents of the field can be returned in the search results.
 


sortEnabled
Boolean sortEnabled

 Whether the field can be used to sort the search results.
 








Class com.amazonaws.services.cloudsearchv2.model.DefineAnalysisSchemeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName


analysisScheme
AnalysisScheme analysisScheme








Class com.amazonaws.services.cloudsearchv2.model.DefineAnalysisSchemeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


analysisScheme
AnalysisSchemeStatus analysisScheme








Class com.amazonaws.services.cloudsearchv2.model.DefineExpressionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName


expression
Expression expression








Class com.amazonaws.services.cloudsearchv2.model.DefineExpressionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


expression
ExpressionStatus expression








Class com.amazonaws.services.cloudsearchv2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


indexField
IndexFieldStatus indexField








Class com.amazonaws.services.cloudsearchv2.model.DefineSuggesterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName


suggester
Suggester suggester








Class com.amazonaws.services.cloudsearchv2.model.DefineSuggesterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


suggester
SuggesterStatus suggester








Class com.amazonaws.services.cloudsearchv2.model.DeleteAnalysisSchemeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName


analysisSchemeName
String analysisSchemeName

 The name of the analysis scheme you want to delete.
 








Class com.amazonaws.services.cloudsearchv2.model.DeleteAnalysisSchemeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


analysisScheme
AnalysisSchemeStatus analysisScheme

 The status of the analysis scheme being deleted.
 








Class com.amazonaws.services.cloudsearchv2.model.DeleteDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the domain you want to permanently delete.
 








Class com.amazonaws.services.cloudsearchv2.model.DeleteDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainStatus
DomainStatus domainStatus








Class com.amazonaws.services.cloudsearchv2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


expression
ExpressionStatus expression

 The status of the expression being deleted.
 








Class com.amazonaws.services.cloudsearchv2.model.DeleteIndexFieldRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


indexField
IndexFieldStatus indexField

 The status of the index field being deleted.
 








Class com.amazonaws.services.cloudsearchv2.model.DeleteSuggesterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName


suggesterName
String suggesterName

 Specifies the name of the suggester you want to delete.
 








Class com.amazonaws.services.cloudsearchv2.model.DeleteSuggesterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


suggester
SuggesterStatus suggester

 The status of the suggester being deleted.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeAnalysisSchemesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the domain you want to describe.
 


analysisSchemeNames
SdkInternalList<T> analysisSchemeNames

 The analysis schemes you want to describe.
 


deployed
Boolean deployed

 Whether to display the deployed configuration (true) or include any pending changes (
 false). Defaults to false.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeAnalysisSchemesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


analysisSchemes
SdkInternalList<T> analysisSchemes

 The analysis scheme descriptions.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeAvailabilityOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the domain you want to describe.
 


deployed
Boolean deployed

 Whether to display the deployed configuration (true) or include any pending changes (
 false). Defaults to false.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeAvailabilityOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


availabilityOptions
AvailabilityOptionsStatus availabilityOptions

 The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeDomainsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainNames
SdkInternalList<T> domainNames

 The names of the domains you want to include in the response.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeDomainsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainStatusList
SdkInternalList<T> domainStatusList








Class com.amazonaws.services.cloudsearchv2.model.DescribeExpressionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the domain you want to describe.
 


expressionNames
SdkInternalList<T> expressionNames

 Limits the DescribeExpressions response to the specified expressions. If not specified, all
 expressions are shown.
 


deployed
Boolean deployed

 Whether to display the deployed configuration (true) or include any pending changes (
 false). Defaults to false.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeExpressionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


expressions
SdkInternalList<T> expressions

 The expressions configured for the domain.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeIndexFieldsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the domain you want to describe.
 


fieldNames
SdkInternalList<T> fieldNames

 A list of the index fields you want to describe. If not specified, information is returned for all configured
 index fields.
 


deployed
Boolean deployed

 Whether to display the deployed configuration (true) or include any pending changes (
 false). Defaults to false.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeIndexFieldsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


indexFields
SdkInternalList<T> indexFields

 The index fields configured for the domain.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeScalingParametersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName








Class com.amazonaws.services.cloudsearchv2.model.DescribeScalingParametersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


scalingParameters
ScalingParametersStatus scalingParameters








Class com.amazonaws.services.cloudsearchv2.model.DescribeServiceAccessPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the domain you want to describe.
 


deployed
Boolean deployed

 Whether to display the deployed configuration (true) or include any pending changes (
 false). Defaults to false.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeServiceAccessPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accessPolicies
AccessPoliciesStatus accessPolicies

 The access rules configured for the domain specified in the request.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeSuggestersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the domain you want to describe.
 


suggesterNames
SdkInternalList<T> suggesterNames

 The suggesters you want to describe.
 


deployed
Boolean deployed

 Whether to display the deployed configuration (true) or include any pending changes (
 false). Defaults to false.
 








Class com.amazonaws.services.cloudsearchv2.model.DescribeSuggestersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


suggesters
SdkInternalList<T> suggesters

 The suggesters configured for the domain specified in the request.
 








Class com.amazonaws.services.cloudsearchv2.model.DisabledOperationException extends AmazonCloudSearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudsearchv2.model.DocumentSuggesterOptions extends Object implements Serializable


Serialized Fields


sourceField
String sourceField

 The name of the index field you want to use for suggestions.
 


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.
 








Class com.amazonaws.services.cloudsearchv2.model.DomainStatus extends Object implements Serializable


Serialized Fields


domainId
String domainId


domainName
String domainName


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.
 


searchService
ServiceEndpoint searchService

 The service endpoint for requesting search results from a search domain.
 


requiresIndexDocuments
Boolean requiresIndexDocuments

 True if IndexDocuments needs to be called to activate the current domain configuration.
 


processing
Boolean processing

 True if processing is being done to activate the current domain configuration.
 


searchInstanceType
String searchInstanceType

 The instance type that is being used to process search requests.
 


searchPartitionCount
Integer searchPartitionCount

 The number of partitions across which the search index is spread.
 


searchInstanceCount
Integer searchInstanceCount

 The number of search instances that are available to process search requests.
 


limits
Limits limits








Class com.amazonaws.services.cloudsearchv2.model.DoubleArrayOptions extends Object implements Serializable


Serialized Fields


defaultValue
Double defaultValue
A value to use for the field if the field isn't specified for a document.


sourceFields
String sourceFields

 A list of source fields to map to the field.
 


facetEnabled
Boolean facetEnabled

 Whether facet information can be returned for the field.
 


searchEnabled
Boolean searchEnabled

 Whether the contents of the field are searchable.
 


returnEnabled
Boolean returnEnabled

 Whether the contents of the field can be returned in the search results.
 








Class com.amazonaws.services.cloudsearchv2.model.DoubleOptions extends Object implements Serializable


Serialized Fields


defaultValue
Double defaultValue

 A value to use for the field if the field isn't specified for a document. This can be important if you are using
 the field in an expression and that field is not present in every document.
 


sourceField
String sourceField

 The name of the source field to map to the field.
 


facetEnabled
Boolean facetEnabled

 Whether facet information can be returned for the field.
 


searchEnabled
Boolean searchEnabled

 Whether the contents of the field are searchable.
 


returnEnabled
Boolean returnEnabled

 Whether the contents of the field can be returned in the search results.
 


sortEnabled
Boolean sortEnabled

 Whether the field can be used to sort the search results.
 








Class com.amazonaws.services.cloudsearchv2.model.Expression extends Object implements Serializable


Serialized Fields


expressionName
String expressionName


expressionValue
String expressionValue








Class com.amazonaws.services.cloudsearchv2.model.ExpressionStatus extends Object implements Serializable


Serialized Fields


options
Expression options

 The expression that is evaluated for sorting while processing a search request.
 


status
OptionStatus status








Class com.amazonaws.services.cloudsearchv2.model.IndexDocumentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName








Class com.amazonaws.services.cloudsearchv2.model.IndexDocumentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fieldNames
SdkInternalList<T> fieldNames

 The names of the fields that are currently being indexed.
 








Class com.amazonaws.services.cloudsearchv2.model.IndexField extends Object implements Serializable


Serialized Fields


indexFieldName
String indexFieldName

 A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic
 fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that
 don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's
 indexing options.
 
 
 Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _
 (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only
 character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
 
 
 The name score is reserved and cannot be used as a field name. To reference a document's ID, you can
 use the name _id.
 


indexFieldType
String indexFieldType


intOptions
IntOptions intOptions


doubleOptions
DoubleOptions doubleOptions


literalOptions
LiteralOptions literalOptions


textOptions
TextOptions textOptions


dateOptions
DateOptions dateOptions


latLonOptions
LatLonOptions latLonOptions


intArrayOptions
IntArrayOptions intArrayOptions


doubleArrayOptions
DoubleArrayOptions doubleArrayOptions


literalArrayOptions
LiteralArrayOptions literalArrayOptions


textArrayOptions
TextArrayOptions textArrayOptions


dateArrayOptions
DateArrayOptions dateArrayOptions








Class com.amazonaws.services.cloudsearchv2.model.IndexFieldStatus extends Object implements Serializable


Serialized Fields


options
IndexField options


status
OptionStatus status








Class com.amazonaws.services.cloudsearchv2.model.IntArrayOptions extends Object implements Serializable


Serialized Fields


defaultValue
Long defaultValue
A value to use for the field if the field isn't specified for a document.


sourceFields
String sourceFields

 A list of source fields to map to the field.
 


facetEnabled
Boolean facetEnabled

 Whether facet information can be returned for the field.
 


searchEnabled
Boolean searchEnabled

 Whether the contents of the field are searchable.
 


returnEnabled
Boolean returnEnabled

 Whether the contents of the field can be returned in the search results.
 








Class com.amazonaws.services.cloudsearchv2.model.InternalException extends AmazonCloudSearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudsearchv2.model.IntOptions extends Object implements Serializable


Serialized Fields


defaultValue
Long defaultValue
A value to use for the field if the field isn't specified for a document. This can be important if you are using
 the field in an expression and that field is not present in every document.


sourceField
String sourceField

 The name of the source field to map to the field.
 


facetEnabled
Boolean facetEnabled

 Whether facet information can be returned for the field.
 


searchEnabled
Boolean searchEnabled

 Whether the contents of the field are searchable.
 


returnEnabled
Boolean returnEnabled

 Whether the contents of the field can be returned in the search results.
 


sortEnabled
Boolean sortEnabled

 Whether the field can be used to sort the search results.
 








Class com.amazonaws.services.cloudsearchv2.model.InvalidTypeException extends AmazonCloudSearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudsearchv2.model.LatLonOptions extends Object implements Serializable


Serialized Fields


defaultValue
String defaultValue
A value to use for the field if the field isn't specified for a document.


sourceField
String sourceField


facetEnabled
Boolean facetEnabled

 Whether facet information can be returned for the field.
 


searchEnabled
Boolean searchEnabled

 Whether the contents of the field are searchable.
 


returnEnabled
Boolean returnEnabled

 Whether the contents of the field can be returned in the search results.
 


sortEnabled
Boolean sortEnabled

 Whether the field can be used to sort the search results.
 








Class com.amazonaws.services.cloudsearchv2.model.LimitExceededException extends AmazonCloudSearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudsearchv2.model.Limits extends Object implements Serializable


Serialized Fields


maximumReplicationCount
Integer maximumReplicationCount


maximumPartitionCount
Integer maximumPartitionCount








Class com.amazonaws.services.cloudsearchv2.model.ListDomainNamesRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.cloudsearchv2.model.ListDomainNamesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainNames
SdkInternalMap<K,V> domainNames

 The names of the search domains owned by an account.
 








Class com.amazonaws.services.cloudsearchv2.model.LiteralArrayOptions extends Object implements Serializable


Serialized Fields


defaultValue
String defaultValue
A value to use for the field if the field isn't specified for a document.


sourceFields
String sourceFields

 A list of source fields to map to the field.
 


facetEnabled
Boolean facetEnabled

 Whether facet information can be returned for the field.
 


searchEnabled
Boolean searchEnabled

 Whether the contents of the field are searchable.
 


returnEnabled
Boolean returnEnabled

 Whether the contents of the field can be returned in the search results.
 








Class com.amazonaws.services.cloudsearchv2.model.LiteralOptions extends Object implements Serializable


Serialized Fields


defaultValue
String defaultValue
A value to use for the field if the field isn't specified for a document.


sourceField
String sourceField


facetEnabled
Boolean facetEnabled

 Whether facet information can be returned for the field.
 


searchEnabled
Boolean searchEnabled

 Whether the contents of the field are searchable.
 


returnEnabled
Boolean returnEnabled

 Whether the contents of the field can be returned in the search results.
 


sortEnabled
Boolean sortEnabled

 Whether the field can be used to sort the search results.
 








Class com.amazonaws.services.cloudsearchv2.model.OptionStatus extends Object implements Serializable


Serialized Fields


creationDate
Date creationDate

 A timestamp for when this option was created.
 


updateDate
Date updateDate

 A timestamp for when this option was last updated.
 


updateVersion
Integer updateVersion

 A unique integer that indicates when this option was last updated.
 


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.
 


pendingDeletion
Boolean pendingDeletion

 Indicates that the option will be deleted once processing is complete.
 








Class com.amazonaws.services.cloudsearchv2.model.ResourceNotFoundException extends AmazonCloudSearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudsearchv2.model.ScalingParameters extends Object implements Serializable


Serialized Fields


desiredInstanceType
String desiredInstanceType

 The instance type that you want to preconfigure for your domain. For example, search.m1.small.
 


desiredReplicationCount
Integer desiredReplicationCount

 The number of replicas you want to preconfigure for each index partition.
 


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.
 








Class com.amazonaws.services.cloudsearchv2.model.ScalingParametersStatus extends Object implements Serializable


Serialized Fields


options
ScalingParameters options


status
OptionStatus status








Class com.amazonaws.services.cloudsearchv2.model.ServiceEndpoint extends Object implements Serializable


Serialized Fields


endpoint
String endpoint








Class com.amazonaws.services.cloudsearchv2.model.Suggester extends Object implements Serializable


Serialized Fields


suggesterName
String suggesterName


documentSuggesterOptions
DocumentSuggesterOptions documentSuggesterOptions








Class com.amazonaws.services.cloudsearchv2.model.SuggesterStatus extends Object implements Serializable


Serialized Fields


options
Suggester options


status
OptionStatus status








Class com.amazonaws.services.cloudsearchv2.model.TextArrayOptions extends Object implements Serializable


Serialized Fields


defaultValue
String defaultValue
A value to use for the field if the field isn't specified for a document.


sourceFields
String sourceFields

 A list of source fields to map to the field.
 


returnEnabled
Boolean returnEnabled

 Whether the contents of the field can be returned in the search results.
 


highlightEnabled
Boolean highlightEnabled

 Whether highlights can be returned for the field.
 


analysisScheme
String analysisScheme

 The name of an analysis scheme for a text-array field.
 








Class com.amazonaws.services.cloudsearchv2.model.TextOptions extends Object implements Serializable


Serialized Fields


defaultValue
String defaultValue
A value to use for the field if the field isn't specified for a document.


sourceField
String sourceField


returnEnabled
Boolean returnEnabled

 Whether the contents of the field can be returned in the search results.
 


sortEnabled
Boolean sortEnabled

 Whether the field can be used to sort the search results.
 


highlightEnabled
Boolean highlightEnabled

 Whether highlights can be returned for the field.
 


analysisScheme
String analysisScheme

 The name of an analysis scheme for a text field.
 








Class com.amazonaws.services.cloudsearchv2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


availabilityOptions
AvailabilityOptionsStatus availabilityOptions

 The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.
 








Class com.amazonaws.services.cloudsearchv2.model.UpdateScalingParametersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName


scalingParameters
ScalingParameters scalingParameters








Class com.amazonaws.services.cloudsearchv2.model.UpdateScalingParametersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


scalingParameters
ScalingParametersStatus scalingParameters








Class com.amazonaws.services.cloudsearchv2.model.UpdateServiceAccessPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName


accessPolicies
String accessPolicies

 The access rules you want to configure. These rules replace any existing rules.
 








Class com.amazonaws.services.cloudsearchv2.model.UpdateServiceAccessPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accessPolicies
AccessPoliciesStatus accessPolicies

 The access rules configured for the domain.
 








Package com.amazonaws.services.cloudtrail.model




Class com.amazonaws.services.cloudtrail.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceId
String resourceId

 Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 


tagsList
SdkInternalList<T> tagsList

 Contains a list of CloudTrail tags, up to a limit of 50
 








Class com.amazonaws.services.cloudtrail.model.AddTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudtrail.model.AWSCloudTrailException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.CloudTrailAccessNotEnabledException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.CloudTrailARNInvalidException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.CloudWatchLogsDeliveryUnavailableException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.CreateTrailRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Specifies the name of the trail. The name must meet the following requirements:
 
 
 
 
 Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
 
 
 
 
 Start with a letter or number, and end with a letter or number
 
 
 
 
 Be between 3 and 128 characters
 
 
 
 
 Have no adjacent periods, underscores or dashes. Names like my-_namespace and
 my--namespace are invalid.
 
 
 
 
 Not be in IP address format (for example, 192.168.5.4)
 
 
 


s3BucketName
String s3BucketName

 Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3
 Bucket Naming Requirements.
 


s3KeyPrefix
String s3KeyPrefix

 Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file
 delivery. For more information, see Finding Your
 CloudTrail Log Files. The maximum length is 200 characters.
 


snsTopicName
String snsTopicName

 Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is
 256 characters.
 


includeGlobalServiceEvents
Boolean includeGlobalServiceEvents

 Specifies whether the trail is publishing events from global services such as IAM to the log files.
 


isMultiRegionTrail
Boolean isMultiRegionTrail

 Specifies whether the trail is created in the current region or in all regions. The default is false, which
 creates a trail only in the region where you are signed in. As a best practice, consider creating trails that log
 events in all regions.
 


enableLogFileValidation
Boolean enableLogFileValidation

 Specifies whether log file integrity validation is enabled. The default is false.
 
 
 
 When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail
 will not create digest files for log files that were delivered during a period in which log file integrity
 validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable
 it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log
 files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail
 logging or delete a trail.
 
 


cloudWatchLogsLogGroupArn
String cloudWatchLogsLogGroupArn

 Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group
 to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
 


cloudWatchLogsRoleArn
String cloudWatchLogsRoleArn

 Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
 


kmsKeyId
String kmsKeyId

 Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be 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-2:123456789012:alias/MyAliasName
 
 
 
 
 arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
 
 
 
 
 12345678-1234-1234-1234-123456789012
 
 
 


isOrganizationTrail
Boolean isOrganizationTrail

 Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the
 current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account
 that is the master account for an organization in AWS Organizations.
 


tagsList
SdkInternalList<T> tagsList








Class com.amazonaws.services.cloudtrail.model.CreateTrailResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 Specifies the name of the trail.
 


s3BucketName
String s3BucketName

 Specifies the name of the Amazon S3 bucket designated for publishing log files.
 


s3KeyPrefix
String s3KeyPrefix

 Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file
 delivery. For more information, see Finding Your
 CloudTrail Log Files.
 


snsTopicName
String snsTopicName
Deprecated. 

 This field is no longer in use. Use SnsTopicARN.
 


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-2:123456789012:MyTopic
 


includeGlobalServiceEvents
Boolean includeGlobalServiceEvents

 Specifies whether the trail is publishing events from global services such as IAM to the log files.
 


isMultiRegionTrail
Boolean isMultiRegionTrail

 Specifies whether the trail exists in one region or in all regions.
 


trailARN
String trailARN

 Specifies the ARN of the trail that was created. The format of a trail ARN is:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 


logFileValidationEnabled
Boolean logFileValidationEnabled

 Specifies whether log file integrity validation is enabled.
 


cloudWatchLogsLogGroupArn
String cloudWatchLogsLogGroupArn

 Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
 


cloudWatchLogsRoleArn
String cloudWatchLogsRoleArn

 Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
 


kmsKeyId
String kmsKeyId

 Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a
 KMS key in the format:
 
 
 arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
 


isOrganizationTrail
Boolean isOrganizationTrail

 Specifies whether the trail is an organization trail.
 








Class com.amazonaws.services.cloudtrail.model.DataResource extends Object implements Serializable


Serialized Fields


type
String type

 The resource type in which you want to log data events. You can specify AWS::S3::Object or
 AWS::Lambda::Function resources.
 


values
SdkInternalList<T> values

 An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.
 
 
 
 
 To log data events for all objects in all S3 buckets in your AWS account, specify the prefix as
 arn:aws:s3:::.
 
 
 
 This will also enable logging of data event activity performed by any user or role in your AWS account, even if
 that activity is performed on a bucket that belongs to another AWS account.
 
 
 
 
 To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as
 arn:aws:s3:::bucket-1/. The trail logs data events for all objects in this S3 bucket.
 
 
 
 
 To log data events for specific objects, specify the S3 bucket and object prefix such as
 arn:aws:s3:::bucket-1/example-images. The trail logs data events for objects in this S3 bucket that
 match the prefix.
 
 
 
 
 To log data events for all functions in your AWS account, specify the prefix as arn:aws:lambda.
 
 
 
 This will also enable logging of Invoke activity performed by any user or role in your AWS account,
 even if that activity is performed on a function that belongs to another AWS account.
 
 
 
 
 To log data events for a specific Lambda function, specify the function ARN.
 
 
 
 Lambda function ARNs are exact. For example, if you specify a function ARN
 arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will only be logged for
 arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be logged for
 arn:aws:lambda:us-west-2:111111111111:function:helloworld2.
 
 
 








Class com.amazonaws.services.cloudtrail.model.DeleteTrailRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Specifies the name or the CloudTrail ARN of the trail to be deleted. The format of a trail ARN is:
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 








Class com.amazonaws.services.cloudtrail.model.DeleteTrailResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudtrail.model.DescribeTrailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trailNameList
SdkInternalList<T> trailNameList

 Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 
 
 If an empty list is specified, information for the trail in the current region is returned.
 
 
 
 
 If an empty list is specified and IncludeShadowTrails is false, then information for all trails in
 the current region is returned.
 
 
 
 
 If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the
 current region and any associated shadow trails in other regions is returned.
 
 
 
 
 
 If one or more trail names are specified, information is returned only if the names match the names of trails
 belonging only to the current region. To return information about a trail in another region, you must specify its
 trail ARN.
 
 


includeShadowTrails
Boolean includeShadowTrails

 Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a
 trail that was created in a different region, or in the case of an organization trail, the replication of an
 organization trail in member accounts. If you do not include shadow trails, organization trails in a member
 account and region replication trails will not be returned. The default is true.
 








Class com.amazonaws.services.cloudtrail.model.DescribeTrailsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trailList
SdkInternalList<T> trailList

 The list of trail objects. Trail objects with string values are only returned if values for the objects exist in
 a trail's configuration. For example, SNSTopicName and SNSTopicARN are only returned in
 results if a trail is configured to send SNS notifications. Similarly, KMSKeyId only appears in
 results if a trail's log files are encrypted with AWS KMS-managed keys.
 








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


Serialized Fields


eventId
String eventId

 The CloudTrail ID of the event returned.
 


eventName
String eventName

 The name of the event returned.
 


readOnly
String readOnly

 Information about whether the event is a write event or a read event.
 


accessKeyId
String accessKeyId

 The AWS access key ID that was used to sign the request. If the request was made with temporary security
 credentials, this is the access key ID of the temporary credentials.
 


eventTime
Date eventTime

 The date and time of the event returned.
 


eventSource
String eventSource

 The AWS service that the request was made to.
 


username
String username

 A user name or role name of the requester that called the API in the event returned.
 


resources
SdkInternalList<T> resources

 A list of resources referenced by the event returned.
 


cloudTrailEvent
String cloudTrailEvent

 A JSON string that contains a representation of the event returned.
 








Class com.amazonaws.services.cloudtrail.model.EventSelector extends Object implements Serializable


Serialized Fields


readWriteType
String readWriteType

 Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2
 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API
 operation.
 
 
 By default, the value is All.
 


includeManagementEvents
Boolean includeManagementEvents

 Specify if you want your event selector to include management events for your trail.
 
 
 For more information, see Management Events in the AWS CloudTrail User Guide.
 
 
 By default, the value is true.
 


dataResources
SdkInternalList<T> dataResources

 CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify up to 250
 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all
 event selectors in a trail. This limit does not apply if you configure resource logging for all data events.
 
 
 For more information, see Data Events and Limits in AWS
 CloudTrail in the AWS CloudTrail User Guide.
 


excludeManagementEventSources
SdkInternalList<T> excludeManagementEventSources

 An optional list of service event sources from which you do not want management events to be logged on your
 trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management
 Service events by containing "kms.amazonaws.com". By default,
 ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to
 your trail.
 








Class com.amazonaws.services.cloudtrail.model.GetEventSelectorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trailName
String trailName

 Specifies the name of the trail or trail ARN. If you specify 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 not valid.
 
 
 
 
 Not be in IP address format (for example, 192.168.5.4)
 
 
 
 
 If you specify a trail ARN, it must be in the format:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 








Class com.amazonaws.services.cloudtrail.model.GetEventSelectorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trailARN
String trailARN

 The specified trail ARN that has the event selectors.
 


eventSelectors
SdkInternalList<T> eventSelectors

 The event selectors that are configured for the trail.
 








Class com.amazonaws.services.cloudtrail.model.GetInsightSelectorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trailName
String trailName

 Specifies the name of the trail or trail ARN. If you specify 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 not valid.
 
 
 
 
 Not be in IP address format (for example, 192.168.5.4)
 
 
 
 
 If you specify a trail ARN, it must be in the format:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 








Class com.amazonaws.services.cloudtrail.model.GetInsightSelectorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trailARN
String trailARN

 The Amazon Resource Name (ARN) of a trail for which you want to get Insights selectors.
 


insightSelectors
SdkInternalList<T> insightSelectors

 A JSON string that contains the insight types you want to log on a trail. In this release, only
 ApiCallRateInsight is supported as an insight type.
 








Class com.amazonaws.services.cloudtrail.model.GetTrailRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.
 








Class com.amazonaws.services.cloudtrail.model.GetTrailResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trail
Trail trail








Class com.amazonaws.services.cloudtrail.model.GetTrailStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a
 shadow trail (a replication of the trail in another region), you must specify its ARN. The format of a trail ARN
 is:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 








Class com.amazonaws.services.cloudtrail.model.GetTrailStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


isLogging
Boolean isLogging

 Whether the CloudTrail is currently logging AWS API calls.
 


latestDeliveryError
String latestDeliveryError

 Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated
 bucket. For more information see the topic Error Responses in the Amazon S3
 API Reference.
 
 
 
 This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To
 resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the
 existing objects so that CloudTrail can again write to the bucket.
 
 


latestNotificationError
String latestNotificationError

 Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more
 information about Amazon SNS errors, see the Amazon SNS Developer Guide.
 


latestDeliveryTime
Date latestDeliveryTime

 Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
 


latestNotificationTime
Date latestNotificationTime

 Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file
 to an account's Amazon S3 bucket.
 


startLoggingTime
Date startLoggingTime

 Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.
 


stopLoggingTime
Date stopLoggingTime

 Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.
 


latestCloudWatchLogsDeliveryError
String latestCloudWatchLogsDeliveryError

 Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch
 Logs.
 


latestCloudWatchLogsDeliveryTime
Date latestCloudWatchLogsDeliveryTime

 Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
 


latestDigestDeliveryTime
Date latestDigestDeliveryTime

 Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.
 


latestDigestDeliveryError
String latestDigestDeliveryError

 Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the
 designated bucket. For more information see the topic Error Responses in the Amazon S3
 API Reference.
 
 
 
 This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To
 resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the
 existing objects so that CloudTrail can again write to the bucket.
 
 


latestDeliveryAttemptTime
String latestDeliveryAttemptTime

 This field is no longer in use.
 


latestNotificationAttemptTime
String latestNotificationAttemptTime

 This field is no longer in use.
 


latestNotificationAttemptSucceeded
String latestNotificationAttemptSucceeded

 This field is no longer in use.
 


latestDeliveryAttemptSucceeded
String latestDeliveryAttemptSucceeded

 This field is no longer in use.
 


timeLoggingStarted
String timeLoggingStarted

 This field is no longer in use.
 


timeLoggingStopped
String timeLoggingStopped

 This field is no longer in use.
 








Class com.amazonaws.services.cloudtrail.model.InsightNotEnabledException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InsightSelector extends Object implements Serializable


Serialized Fields


insightType
String insightType

 The type of insights to log on a trail. In this release, only ApiCallRateInsight is supported as an
 insight type.
 








Class com.amazonaws.services.cloudtrail.model.InsufficientDependencyServiceAccessPermissionException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InsufficientEncryptionPolicyException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InsufficientS3BucketPolicyException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InsufficientSnsTopicPolicyException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidCloudWatchLogsLogGroupArnException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidCloudWatchLogsRoleArnException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidEventCategoryException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidEventSelectorsException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidHomeRegionException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidInsightSelectorsException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidKmsKeyIdException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidLookupAttributesException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidMaxResultsException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidNextTokenException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidParameterCombinationException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidS3BucketNameException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidS3PrefixException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidSnsTopicNameException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidTagParameterException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidTimeRangeException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidTokenException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.InvalidTrailNameException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.KmsException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.KmsKeyDisabledException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.KmsKeyNotFoundException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.ListPublicKeysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


startTime
Date startTime

 Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If
 not specified, the current time is used, and the current public key is returned.
 


endTime
Date endTime

 Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If
 not specified, the current time is used.
 


nextToken
String nextToken

 Reserved for future use.
 








Class com.amazonaws.services.cloudtrail.model.ListPublicKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


publicKeyList
SdkInternalList<T> publicKeyList

 Contains an array of PublicKey objects.
 
 
 
 The returned public keys may have validity time ranges that overlap.
 
 


nextToken
String nextToken

 Reserved for future use.
 








Class com.amazonaws.services.cloudtrail.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceIdList
SdkInternalList<T> resourceIdList

 Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The format of a trail
 ARN is:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 


nextToken
String nextToken

 Reserved for future use.
 








Class com.amazonaws.services.cloudtrail.model.ListTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceTagList
SdkInternalList<T> resourceTagList

 A list of resource tags.
 


nextToken
String nextToken

 Reserved for future use.
 








Class com.amazonaws.services.cloudtrail.model.ListTrailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to use to get the next page of results after a previous API call. This token must be passed in with the
 same parameters that were specified in the the original call. For example, if the original call specified an
 AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
 








Class com.amazonaws.services.cloudtrail.model.ListTrailsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trails
SdkInternalList<T> trails

 Returns the name, ARN, and home region of trails in the current account.
 


nextToken
String nextToken

 The token to use to get the next page of results after a previous API call. If the token does not appear, there
 are no more results to return. The token must be passed in with the same parameters as the previous call. For
 example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with
 NextToken should include those same parameters.
 








Class com.amazonaws.services.cloudtrail.model.LookupAttribute extends Object implements Serializable


Serialized Fields


attributeKey
String attributeKey

 Specifies an attribute on which to filter the events returned.
 


attributeValue
String attributeValue

 Specifies a value for the specified AttributeKey.
 








Class com.amazonaws.services.cloudtrail.model.LookupEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


lookupAttributes
SdkInternalList<T> lookupAttributes

 Contains a list of lookup attributes. Currently the list can contain only one item.
 


startTime
Date startTime

 Specifies that only events that occur after or at the specified time are returned. If the specified start time is
 after the specified end time, an error is returned.
 


endTime
Date endTime

 Specifies that only events that occur before or at the specified time are returned. If the specified end time is
 before the specified start time, an error is returned.
 


eventCategory
String eventCategory

 Specifies the event category. If you do not specify an event category, events of the category are not returned in
 the response. For example, if you do not specify insight as the value of EventCategory,
 no Insights events are returned.
 


maxResults
Integer maxResults

 The number of events to return. Possible values are 1 through 50. The default is 50.
 


nextToken
String nextToken

 The token to use to get the next page of results after a previous API call. This token must be passed in with the
 same parameters that were specified in the the original call. For example, if the original call specified an
 AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.
 








Class com.amazonaws.services.cloudtrail.model.LookupEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


events
SdkInternalList<T> events

 A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is
 sorted by time. The most recent event is listed first.
 


nextToken
String nextToken

 The token to use to get the next page of results after a previous API call. If the token does not appear, there
 are no more results to return. The token must be passed in with the same parameters as the previous call. For
 example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with
 NextToken should include those same parameters.
 








Class com.amazonaws.services.cloudtrail.model.MaximumNumberOfTrailsExceededException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.NotOrganizationMasterAccountException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.OperationNotPermittedException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.OrganizationNotInAllFeaturesModeException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.OrganizationsNotInUseException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.PublicKey extends Object implements Serializable


Serialized Fields


value
ByteBuffer value

 The DER encoded public key value in PKCS#1 format.
 


validityStartTime
Date validityStartTime

 The starting time of validity of the public key.
 


validityEndTime
Date validityEndTime

 The ending time of validity of the public key.
 


fingerprint
String fingerprint

 The fingerprint of the public key.
 








Class com.amazonaws.services.cloudtrail.model.PutEventSelectorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trailName
String trailName

 Specifies the name of the trail or trail ARN. If you specify 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 you specify a trail ARN, it must be in the format:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 


eventSelectors
SdkInternalList<T> eventSelectors

 Specifies the settings for your event selectors. You can configure up to five event selectors for a trail.
 








Class com.amazonaws.services.cloudtrail.model.PutEventSelectorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trailARN
String trailARN

 Specifies the ARN of the trail that was updated with event selectors. The format of a trail ARN is:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 


eventSelectors
SdkInternalList<T> eventSelectors

 Specifies the event selectors configured for your trail.
 








Class com.amazonaws.services.cloudtrail.model.PutInsightSelectorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trailName
String trailName

 The name of the CloudTrail trail for which you want to change or add Insights selectors.
 


insightSelectors
SdkInternalList<T> insightSelectors

 A JSON string that contains the insight types you want to log on a trail. In this release, only
 ApiCallRateInsight is supported as an insight type.
 








Class com.amazonaws.services.cloudtrail.model.PutInsightSelectorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trailARN
String trailARN

 The Amazon Resource Name (ARN) of a trail for which you want to change or add Insights selectors.
 


insightSelectors
SdkInternalList<T> insightSelectors

 A JSON string that contains the insight types you want to log on a trail. In this release, only
 ApiCallRateInsight is supported as an insight type.
 








Class com.amazonaws.services.cloudtrail.model.RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceId
String resourceId

 Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 


tagsList
SdkInternalList<T> tagsList

 Specifies a list of tags to be removed.
 








Class com.amazonaws.services.cloudtrail.model.RemoveTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


resourceType
String resourceType

 The type of a resource referenced by the event returned. When the resource type cannot be determined, null is
 returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail,
 DBInstance for RDS, and AccessKey for IAM. To learn more about how to look up and filter events by
 the resource types supported for a service, see Filtering CloudTrail Events.
 


resourceName
String resourceName

 The name of the resource referenced by the event returned. These are user-created names whose values will depend
 on the environment. For example, the resource name might be "auto-scaling-test-group" for an Auto Scaling Group
 or "i-1234567" for an EC2 Instance.
 








Class com.amazonaws.services.cloudtrail.model.ResourceNotFoundException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.ResourceTag extends Object implements Serializable


Serialized Fields


resourceId
String resourceId

 Specifies the ARN of the resource.
 


tagsList
SdkInternalList<T> tagsList

 A list of tags.
 








Class com.amazonaws.services.cloudtrail.model.ResourceTypeNotSupportedException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.S3BucketDoesNotExistException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.StartLoggingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS API calls. The format of a
 trail ARN is:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 








Class com.amazonaws.services.cloudtrail.model.StartLoggingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudtrail.model.StopLoggingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging AWS API calls. The
 format of a trail ARN is:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 








Class com.amazonaws.services.cloudtrail.model.StopLoggingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudtrail.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be
 unique for the resource to which it applies.
 


value
String value

 The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
 








Class com.amazonaws.services.cloudtrail.model.TagsLimitExceededException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.Trail extends Object implements Serializable


Serialized Fields


name
String name

 Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
 


s3BucketName
String s3BucketName

 Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3
 Bucket Naming Requirements.
 


s3KeyPrefix
String s3KeyPrefix

 Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file
 delivery. For more information, see Finding Your
 CloudTrail Log Files.The maximum length is 200 characters.
 


snsTopicName
String snsTopicName
Deprecated. 

 This field is no longer in use. Use SnsTopicARN.
 


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-2:123456789012:MyTopic
 


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 exists only in one region or exists in all regions.
 


homeRegion
String homeRegion

 The region in which the trail was created.
 


trailARN
String trailARN

 Specifies the ARN of the trail. The format of a trail ARN is:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 


logFileValidationEnabled
Boolean logFileValidationEnabled

 Specifies whether log file validation is enabled.
 


cloudWatchLogsLogGroupArn
String cloudWatchLogsLogGroupArn

 Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail
 logs will be delivered.
 


cloudWatchLogsRoleArn
String cloudWatchLogsRoleArn

 Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
 


kmsKeyId
String kmsKeyId

 Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a
 KMS key in the format:
 
 
 arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
 


hasCustomEventSelectors
Boolean hasCustomEventSelectors

 Specifies if the trail has custom event selectors.
 


hasInsightSelectors
Boolean hasInsightSelectors

 Specifies whether a trail has insight types specified in an InsightSelector list.
 


isOrganizationTrail
Boolean isOrganizationTrail

 Specifies whether the trail is an organization trail.
 








Class com.amazonaws.services.cloudtrail.model.TrailAlreadyExistsException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.TrailInfo extends Object implements Serializable


Serialized Fields


trailARN
String trailARN

 The ARN of a trail.
 


name
String name

 The name of a trail.
 


homeRegion
String homeRegion

 The AWS region in which a trail was created.
 








Class com.amazonaws.services.cloudtrail.model.TrailNotFoundException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.TrailNotProvidedException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.UnsupportedOperationException extends AWSCloudTrailException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudtrail.model.UpdateTrailRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Specifies the name of the trail or trail ARN. If Name is a trail name, the string must meet the
 following requirements:
 
 
 
 
 Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
 
 
 
 
 Start with a letter or number, and end with a letter or number
 
 
 
 
 Be between 3 and 128 characters
 
 
 
 
 Have no adjacent periods, underscores or dashes. Names like my-_namespace and
 my--namespace are invalid.
 
 
 
 
 Not be in IP address format (for example, 192.168.5.4)
 
 
 
 
 If Name is a trail ARN, it must be in the format:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 


s3BucketName
String s3BucketName

 Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3
 Bucket Naming Requirements.
 


s3KeyPrefix
String s3KeyPrefix

 Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file
 delivery. For more information, see Finding Your
 CloudTrail Log Files. The maximum length is 200 characters.
 


snsTopicName
String snsTopicName

 Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is
 256 characters.
 


includeGlobalServiceEvents
Boolean includeGlobalServiceEvents

 Specifies whether the trail is publishing events from global services such as IAM to the log files.
 


isMultiRegionTrail
Boolean isMultiRegionTrail

 Specifies whether the trail applies only to the current region or to all regions. The default is false. If the
 trail exists only in the current region and this value is set to true, shadow trails (replications of the trail)
 will be created in the other regions. If the trail exists in all regions and this value is set to false, the
 trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As
 a best practice, consider using trails that log events in all regions.
 


enableLogFileValidation
Boolean enableLogFileValidation

 Specifies whether log file validation is enabled. The default is false.
 
 
 
 When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail
 will not create digest files for log files that were delivered during a period in which log file integrity
 validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable
 it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log
 files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail
 logging or delete a trail.
 
 


cloudWatchLogsLogGroupArn
String cloudWatchLogsLogGroupArn

 Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group
 to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.
 


cloudWatchLogsRoleArn
String cloudWatchLogsRoleArn

 Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
 


kmsKeyId
String kmsKeyId

 Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be 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-2:123456789012:alias/MyAliasName
 
 
 
 
 arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
 
 
 
 
 12345678-1234-1234-1234-123456789012
 
 
 


isOrganizationTrail
Boolean isOrganizationTrail

 Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the
 current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account
 that is the master account for an organization in AWS Organizations. If the trail is not an organization trail
 and this is set to true, the trail will be created in all AWS accounts that belong to the organization. If the
 trail is an organization trail and this is set to false, the trail will remain in the current AWS account but be
 deleted from all member accounts in the organization.
 








Class com.amazonaws.services.cloudtrail.model.UpdateTrailResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 Specifies the name of the trail.
 


s3BucketName
String s3BucketName

 Specifies the name of the Amazon S3 bucket designated for publishing log files.
 


s3KeyPrefix
String s3KeyPrefix

 Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file
 delivery. For more information, see Finding Your
 CloudTrail Log Files.
 


snsTopicName
String snsTopicName
Deprecated. 

 This field is no longer in use. Use SnsTopicARN.
 


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-2:123456789012:MyTopic
 


includeGlobalServiceEvents
Boolean includeGlobalServiceEvents

 Specifies whether the trail is publishing events from global services such as IAM to the log files.
 


isMultiRegionTrail
Boolean isMultiRegionTrail

 Specifies whether the trail exists in one region or in all regions.
 


trailARN
String trailARN

 Specifies the ARN of the trail that was updated. The format of a trail ARN is:
 
 
 arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
 


logFileValidationEnabled
Boolean logFileValidationEnabled

 Specifies whether log file integrity validation is enabled.
 


cloudWatchLogsLogGroupArn
String cloudWatchLogsLogGroupArn

 Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
 


cloudWatchLogsRoleArn
String cloudWatchLogsRoleArn

 Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
 


kmsKeyId
String kmsKeyId

 Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a
 KMS key in the format:
 
 
 arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
 


isOrganizationTrail
Boolean isOrganizationTrail

 Specifies whether the trail is an organization trail.
 








Package com.amazonaws.services.cloudwatch.model




Class com.amazonaws.services.cloudwatch.model.AlarmHistoryItem extends Object implements Serializable


Serialized Fields


alarmName
String alarmName

 The descriptive name for the alarm.
 


timestamp
Date timestamp

 The time stamp for the alarm history item.
 


historyItemType
String historyItemType

 The type of alarm history item.
 


historySummary
String historySummary

 A summary of the alarm history, in text format.
 


historyData
String historyData

 Data about the alarm, in JSON format.
 








Class com.amazonaws.services.cloudwatch.model.AmazonCloudWatchException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatch.model.AnomalyDetector extends Object implements Serializable


Serialized Fields


namespace
String namespace

 The namespace of the metric associated with the anomaly detection model.
 


metricName
String metricName

 The name of the metric associated with the anomaly detection model.
 


dimensions
SdkInternalList<T> dimensions

 The metric dimensions associated with the anomaly detection model.
 


stat
String stat

 The statistic associated with the anomaly detection model.
 


configuration
AnomalyDetectorConfiguration configuration

 The configuration specifies details about how the anomaly detection model is to be trained, including time ranges
 to exclude from use for training the model, and the time zone to use for the metric.
 


stateValue
String stateValue

 The current status of the anomaly detector's training. The possible values are
 TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA
 








Class com.amazonaws.services.cloudwatch.model.AnomalyDetectorConfiguration extends Object implements Serializable


Serialized Fields


excludedTimeRanges
SdkInternalList<T> excludedTimeRanges

 An array of time ranges to exclude from use when the anomaly detection model is trained. Use this to make sure
 that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch
 creates the model.
 


metricTimezone
String metricTimezone

 The time zone to use for the metric. This is useful to enable the model to automatically account for daylight
 savings time changes if the metric is sensitive to such time changes.
 
 
 To specify a time zone, use the name of the time zone as specified in the standard tz database. For more
 information, see tz database.
 








Class com.amazonaws.services.cloudwatch.model.ConcurrentModificationException extends AmazonCloudWatchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatch.model.DashboardEntry extends Object implements Serializable


Serialized Fields


dashboardName
String dashboardName

 The name of the dashboard.
 


dashboardArn
String dashboardArn

 The Amazon Resource Name (ARN) of the dashboard.
 


lastModified
Date lastModified

 The time stamp of when the dashboard was last modified, either by an API call or through the console. This number
 is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
 


size
Long size

 The size of the dashboard, in bytes.
 








Class com.amazonaws.services.cloudwatch.model.DashboardInvalidInputErrorException extends AmazonCloudWatchException implements Serializable

serialVersionUID:
1L



Serialized Fields


dashboardValidationMessages
SdkInternalList<T> dashboardValidationMessages








Class com.amazonaws.services.cloudwatch.model.DashboardNotFoundErrorException extends AmazonCloudWatchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatch.model.DashboardValidationMessage extends Object implements Serializable


Serialized Fields


dataPath
String dataPath

 The data path related to the message.
 


message
String message

 A message describing the error or warning.
 








Class com.amazonaws.services.cloudwatch.model.Datapoint extends Object implements Serializable


Serialized Fields


timestamp
Date timestamp

 The time stamp used for the data point.
 


sampleCount
Double sampleCount

 The number of metric values that contributed to the aggregate value of this data point.
 


average
Double average

 The average of the metric values that correspond to the data point.
 


sum
Double sum

 The sum of the metric values for the data point.
 


minimum
Double minimum

 The minimum metric value for the data point.
 


maximum
Double maximum

 The maximum metric value for the data point.
 


unit
String unit

 The standard unit for the data point.
 


extendedStatistics
Map<K,V> extendedStatistics

 The percentile statistic for the data point.
 








Class com.amazonaws.services.cloudwatch.model.DeleteAlarmsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


alarmNames
SdkInternalList<T> alarmNames

 The alarms to be deleted.
 








Class com.amazonaws.services.cloudwatch.model.DeleteAlarmsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatch.model.DeleteAnomalyDetectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namespace
String namespace

 The namespace associated with the anomaly detection model to delete.
 


metricName
String metricName

 The metric name associated with the anomaly detection model to delete.
 


dimensions
SdkInternalList<T> dimensions

 The metric dimensions associated with the anomaly detection model to delete.
 


stat
String stat

 The statistic associated with the anomaly detection model to delete.
 








Class com.amazonaws.services.cloudwatch.model.DeleteAnomalyDetectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatch.model.DeleteDashboardsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dashboardNames
SdkInternalList<T> dashboardNames

 The dashboards to be deleted. This parameter is required.
 








Class com.amazonaws.services.cloudwatch.model.DeleteDashboardsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatch.model.DeleteInsightRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleNames
SdkInternalList<T> ruleNames

 An array of the rule names to delete. If you need to find out the names of your rules, use
 DescribeInsightRules.
 








Class com.amazonaws.services.cloudwatch.model.DeleteInsightRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failures
SdkInternalList<T> failures

 An array listing the rules that could not be deleted. You cannot delete built-in rules.
 








Class com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


alarmName
String alarmName

 The name of the alarm.
 


historyItemType
String historyItemType

 The type of alarm histories to retrieve.
 


startDate
Date startDate

 The starting date to retrieve alarm history.
 


endDate
Date endDate

 The ending date to retrieve alarm history.
 


maxRecords
Integer maxRecords

 The maximum number of alarm history records to retrieve.
 


nextToken
String nextToken

 The token returned by a previous call to indicate that there is more data available.
 








Class com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


alarmHistoryItems
SdkInternalList<T> alarmHistoryItems

 The alarm histories, in JSON format.
 


nextToken
String nextToken

 The token that marks the start of the next batch of returned results.
 








Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


metricName
String metricName

 The name of the metric.
 


namespace
String namespace

 The namespace of the metric.
 


statistic
String statistic

 The statistic for the metric, other than percentiles. For percentile statistics, use
 ExtendedStatistics.
 


extendedStatistic
String extendedStatistic

 The percentile statistic for the metric. Specify a value between p0.0 and p100.
 


dimensions
SdkInternalList<T> dimensions

 The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in
 order for the call to succeed.
 


period
Integer period

 The period, in seconds, over which the statistic is applied.
 


unit
String unit

 The unit for the metric.
 








Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


metricAlarms
SdkInternalList<T> metricAlarms

 The information for each alarm with the specified metric.
 








Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


alarmNames
SdkInternalList<T> alarmNames

 The names of the alarms.
 


alarmNamePrefix
String alarmNamePrefix

 The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames.
 


stateValue
String stateValue

 The state value to be used in matching alarms.
 


actionPrefix
String actionPrefix

 The action name prefix.
 


maxRecords
Integer maxRecords

 The maximum number of alarm descriptions to retrieve.
 


nextToken
String nextToken

 The token returned by a previous call to indicate that there is more data available.
 








Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


metricAlarms
SdkInternalList<T> metricAlarms

 The information for the specified alarms.
 


nextToken
String nextToken

 The token that marks the start of the next batch of returned results.
 








Class com.amazonaws.services.cloudwatch.model.DescribeAnomalyDetectorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 Use the token returned by the previous operation to request the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in one operation. The maximum value you can specify is 10.
 
 
 To retrieve the remaining results, make another call with the returned NextToken value.
 


namespace
String namespace

 Limits the results to only the anomaly detection models that are associated with the specified namespace.
 


metricName
String metricName

 Limits the results to only the anomaly detection models that are associated with the specified metric name. If
 there are multiple metrics with this name in different namespaces that have anomaly detection models, they're all
 returned.
 


dimensions
SdkInternalList<T> dimensions

 Limits the results to only the anomaly detection models that are associated with the specified metric dimensions.
 If there are multiple metrics that have these dimensions and have anomaly detection models associated, they're
 all returned.
 








Class com.amazonaws.services.cloudwatch.model.DescribeAnomalyDetectorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


anomalyDetectors
SdkInternalList<T> anomalyDetectors

 The list of anomaly detection models returned by the operation.
 


nextToken
String nextToken

 A token that you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.cloudwatch.model.DescribeInsightRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 Reserved for future use.
 


maxResults
Integer maxResults

 This parameter is not currently used. Reserved for future use. If it is used in the future, the maximum value may
 be different.
 








Class com.amazonaws.services.cloudwatch.model.DescribeInsightRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 Reserved for future use.
 


insightRules
SdkInternalList<T> insightRules

 The rules returned by the operation.
 








Class com.amazonaws.services.cloudwatch.model.Dimension extends Object implements Serializable


Serialized Fields


name
String name

 The name of the dimension.
 


value
String value

 The value representing the dimension measurement.
 








Class com.amazonaws.services.cloudwatch.model.DimensionFilter extends Object implements Serializable


Serialized Fields


name
String name

 The dimension name to be matched.
 


value
String value

 The value of the dimension to be matched.
 








Class com.amazonaws.services.cloudwatch.model.DisableAlarmActionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


alarmNames
SdkInternalList<T> alarmNames

 The names of the alarms.
 








Class com.amazonaws.services.cloudwatch.model.DisableAlarmActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatch.model.DisableInsightRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleNames
SdkInternalList<T> ruleNames

 An array of the rule names to disable. If you need to find out the names of your rules, use
 DescribeInsightRules.
 








Class com.amazonaws.services.cloudwatch.model.DisableInsightRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failures
SdkInternalList<T> failures

 An array listing the rules that could not be disabled. You cannot disable built-in rules.
 








Class com.amazonaws.services.cloudwatch.model.EnableAlarmActionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


alarmNames
SdkInternalList<T> alarmNames

 The names of the alarms.
 








Class com.amazonaws.services.cloudwatch.model.EnableAlarmActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatch.model.EnableInsightRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleNames
SdkInternalList<T> ruleNames

 An array of the rule names to enable. If you need to find out the names of your rules, use
 DescribeInsightRules.
 








Class com.amazonaws.services.cloudwatch.model.EnableInsightRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failures
SdkInternalList<T> failures

 An array listing the rules that could not be enabled. You cannot disable or enable built-in rules.
 








Class com.amazonaws.services.cloudwatch.model.GetDashboardRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dashboardName
String dashboardName

 The name of the dashboard to be described.
 








Class com.amazonaws.services.cloudwatch.model.GetDashboardResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dashboardArn
String dashboardArn

 The Amazon Resource Name (ARN) of the dashboard.
 


dashboardBody
String dashboardBody

 The detailed information about the dashboard, including what widgets are included and their location on the
 dashboard. For more information about the DashboardBody syntax, see
 CloudWatch-Dashboard-Body-Structure.
 


dashboardName
String dashboardName

 The name of the dashboard.
 








Class com.amazonaws.services.cloudwatch.model.GetInsightRuleReportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleName
String ruleName

 The name of the rule that you want to see data from.
 


startTime
Date startTime

 The start time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
 yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
 


endTime
Date endTime

 The end time of the data to use in the report. When used in a raw HTTP Query API, it is formatted as
 yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.
 


period
Integer period

 The period, in seconds, to use for the statistics in the InsightRuleMetricDatapoint results.
 


maxContributorCount
Integer maxContributorCount

 The maximum number of contributors to include in the report. The range is 1 to 100. If you omit this, the default
 of 10 is used.
 


metrics
SdkInternalList<T> metrics

 Specifies which metrics to use for aggregation of contributor values for the report. You can specify one or more
 of the following metrics:
 
 
 
 
 UniqueContributors -- the number of unique contributors for each data point.
 
 
 
 
 MaxContributorValue -- the value of the top contributor for each data point. The identity of the
 contributor may change for each data point in the graph.
 
 
 If this rule aggregates by COUNT, the top contributor for each data point is the contributor with the most
 occurrences in that period. If the rule aggregates by SUM, the top contributor is the contributor with the
 highest sum in the log field specified by the rule's Value, during that period.
 
 
 
 
 SampleCount -- the number of data points matched by the rule.
 
 
 
 
 Sum -- the sum of the values from all contributors during the time period represented by that data
 point.
 
 
 
 
 Minimum -- the minimum value from a single observation during the time period represented by that
 data point.
 
 
 
 
 Maximum -- the maximum value from a single observation during the time period represented by that
 data point.
 
 
 
 
 Average -- the average value from all contributors during the time period represented by that data
 point.
 
 
 


orderBy
String orderBy

 Determines what statistic to use to rank the contributors. Valid values are SUM and MAXIMUM.
 








Class com.amazonaws.services.cloudwatch.model.GetInsightRuleReportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyLabels
SdkInternalList<T> keyLabels

 An array of the strings used as the keys for this rule. The keys are the dimensions used to classify
 contributors. If the rule contains more than one key, then each unique combination of values for the keys is
 counted as a unique contributor.
 


aggregationStatistic
String aggregationStatistic

 Specifies whether this rule aggregates contributor data by COUNT or SUM.
 


aggregateValue
Double aggregateValue

 The sum of the values from all individual contributors that match the rule.
 


approximateUniqueCount
Long approximateUniqueCount

 An approximate count of the unique contributors found by this rule in this time period.
 


contributors
SdkInternalList<T> contributors

 An array of the unique contributors found by this rule in this time period. If the rule contains multiple keys,
 each combination of values for the keys counts as a unique contributor.
 


metricDatapoints
SdkInternalList<T> metricDatapoints

 A time series of metric data points that matches the time period in the rule request.
 








Class com.amazonaws.services.cloudwatch.model.GetMetricDataRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


metricDataQueries
SdkInternalList<T> metricDataQueries

 The metric queries to be returned. A single GetMetricData call can include as many as 100
 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a
 math expression to perform on retrieved data.
 


startTime
Date startTime

 The time stamp indicating the earliest data to be returned.
 
 
 The value specified is inclusive; results include data points with the specified time stamp.
 
 
 CloudWatch rounds the specified time stamp as follows:
 
 
 
 
 Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down
 to 12:32:00.
 
 
 
 
 Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34
 is rounded down to 12:30:00.
 
 
 
 
 Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is
 rounded down to 12:00:00.
 
 
 
 
 If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest
 time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at
 (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you
 receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using
 a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
 
 
 For better performance, specify StartTime and EndTime values that align with the value
 of the metric's Period and sync up with the beginning and end of an hour. For example, if the
 Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a
 faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.
 


endTime
Date endTime

 The time stamp indicating the latest data to be returned.
 
 
 The value specified is exclusive; results include data points up to the specified time stamp.
 
 
 For better performance, specify StartTime and EndTime values that align with the value
 of the metric's Period and sync up with the beginning and end of an hour. For example, if the
 Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster
 response from CloudWatch than setting 12:07 or 12:29 as the EndTime.
 


nextToken
String nextToken

 Include this value, if it was returned by the previous call, to get the next set of data points.
 


scanBy
String scanBy

 The order in which data points should be returned. TimestampDescending returns the newest data first
 and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the
 oldest data first and paginates when the MaxDatapoints limit is reached.
 


maxDatapoints
Integer maxDatapoints

 The maximum number of data points the request should return before paginating. If you omit this, the default of
 100,800 is used.
 








Class com.amazonaws.services.cloudwatch.model.GetMetricDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


metricDataResults
SdkInternalList<T> metricDataResults

 The metrics that are returned, including the metric name, namespace, and dimensions.
 


nextToken
String nextToken

 A token that marks the next batch of returned results.
 


messages
SdkInternalList<T> messages

 Contains a message about this GetMetricData operation, if the operation results in such a message.
 An example of a message that may be returned is Maximum number of allowed metrics exceeded. If there
 is a message, as much of the operation as possible is still executed.
 
 
 A message appears here only if it is related to the global GetMetricData operation. Any message
 about a specific metric returned by the operation appears in the MetricDataResult object returned
 for that metric.
 








Class com.amazonaws.services.cloudwatch.model.GetMetricStatisticsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namespace
String namespace

 The namespace of the metric, with or without spaces.
 


metricName
String metricName

 The name of the metric, with or without spaces.
 


dimensions
SdkInternalList<T> dimensions

 The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension.
 CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of
 dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that
 were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying
 dimensions, see Publishing
 Metrics in the Amazon CloudWatch User Guide.
 


startTime
Date startTime

 The time stamp that determines the first data point to return. Start times are evaluated relative to the time
 that CloudWatch receives the request.
 
 
 The value specified is inclusive; results include data points with the specified time stamp. In a raw HTTP query,
 the time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).
 
 
 CloudWatch rounds the specified time stamp as follows:
 
 
 
 
 Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down
 to 12:32:00.
 
 
 
 
 Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34
 is rounded down to 12:30:00.
 
 
 
 
 Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is
 rounded down to 12:00:00.
 
 
 
 
 If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest
 time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at
 (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you
 receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using
 a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.
 


endTime
Date endTime

 The time stamp that determines the last data point to return.
 
 
 The value specified is exclusive; results include data points up to the specified time stamp. In a raw HTTP
 query, the time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).
 


period
Integer period

 The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as
 short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at
 intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
 metrics are those metrics stored by a PutMetricData call that includes a
 StorageResolution of 1 second.
 
 
 If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify
 the period as follows or no data points in that time range is returned:
 
 
 
 
 Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
 
 
 
 
 Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
 
 
 
 
 Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
 
 
 


statistics
SdkInternalList<T> statistics

 The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics.
 When calling GetMetricStatistics, you must specify either Statistics or
 ExtendedStatistics, but not both.
 


extendedStatistics
SdkInternalList<T> extendedStatistics

 The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics,
 you must specify either Statistics or ExtendedStatistics, but not both. Percentile
 statistics are not available for metrics when any of the metric values are negative numbers.
 


unit
String unit

 The unit for a given metric. If you omit Unit, all data that was collected with any unit is
 returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you
 specify a unit, the operation returns only data data that was collected with that unit specified. If you specify
 a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform
 unit conversions.
 








Class com.amazonaws.services.cloudwatch.model.GetMetricStatisticsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


label
String label

 A label for the specified metric.
 


datapoints
SdkInternalList<T> datapoints

 The data points for the specified metric.
 








Class com.amazonaws.services.cloudwatch.model.GetMetricWidgetImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


metricWidget
String metricWidget

 A JSON string that defines the bitmap graph to be retrieved. The string includes the metrics to include in the
 graph, statistics, annotations, title, axis limits, and so on. You can include only one MetricWidget
 parameter in each GetMetricWidgetImage call.
 
 
 For more information about the syntax of MetricWidget see CloudWatch-Metric-Widget-Structure.
 
 
 If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation
 point appears next to the graph legend.
 


outputFormat
String outputFormat

 The format of the resulting image. Only PNG images are supported.
 
 
 The default is png. If you specify png, the API returns an HTTP response with the
 content-type set to text/xml. The image data is in a MetricWidgetImage field. For
 example:
 
 
  <GetMetricWidgetImageResponse xmlns=<URLstring>>
 
 
  <GetMetricWidgetImageResult>
 
 
  <MetricWidgetImage>
 
 
  iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...
 
 
  </MetricWidgetImage>
 
 
  </GetMetricWidgetImageResult>
 
 
  <ResponseMetadata>
 
 
  <RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId>
 
 
  </ResponseMetadata>
 
 
 </GetMetricWidgetImageResponse>
 
 
 The image/png setting is intended only for custom HTTP requests. For most use cases, and all actions
 using an AWS SDK, you should use png. If you specify image/png, the HTTP response has a
 content-type set to image/png, and the body of the response is a PNG image.
 








Class com.amazonaws.services.cloudwatch.model.GetMetricWidgetImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


metricWidgetImage
ByteBuffer metricWidgetImage

 The image of the graph, in the output format specified.
 








Class com.amazonaws.services.cloudwatch.model.InsightRule extends Object implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


state
String state

 Indicates whether the rule is enabled or disabled.
 


schema
String schema

 For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": 1}. For built-in
 rules, this is {"Name": "ServiceLogRule", "Version": 1}
 


definition
String definition

 The definition of the rule, as a JSON object. The definition contains the keywords used to define contributors,
 the value to aggregate on if this rule returns a sum instead of a count, and the filters. For details on the
 valid syntax, see Contributor Insights Rule Syntax.
 








Class com.amazonaws.services.cloudwatch.model.InsightRuleContributor extends Object implements Serializable


Serialized Fields


keys
SdkInternalList<T> keys

 One of the log entry field keywords that is used to define contributors for this rule.
 


approximateAggregateValue
Double approximateAggregateValue

 An approximation of the aggregate value that comes from this contributor.
 


datapoints
SdkInternalList<T> datapoints

 An array of the data points where this contributor is present. Only the data points when this contributor
 appeared are included in the array.
 








Class com.amazonaws.services.cloudwatch.model.InsightRuleContributorDatapoint extends Object implements Serializable


Serialized Fields


timestamp
Date timestamp

 The timestamp of the data point.
 


approximateValue
Double approximateValue

 The approximate value that this contributor added during this timestamp.
 








Class com.amazonaws.services.cloudwatch.model.InsightRuleMetricDatapoint extends Object implements Serializable


Serialized Fields


timestamp
Date timestamp

 The timestamp of the data point.
 


uniqueContributors
Double uniqueContributors

 The number of unique contributors who published data during this timestamp.
 
 
 This statistic is returned only if you included it in the Metrics array in your request.
 


maxContributorValue
Double maxContributorValue

 The maximum value provided by one contributor during this timestamp. Each timestamp is evaluated separately, so
 the identity of the max contributor could be different for each timestamp.
 
 
 This statistic is returned only if you included it in the Metrics array in your request.
 


sampleCount
Double sampleCount

 The number of occurrences that matched the rule during this data point.
 
 
 This statistic is returned only if you included it in the Metrics array in your request.
 


average
Double average

 The average value from all contributors during the time period represented by that data point.
 
 
 This statistic is returned only if you included it in the Metrics array in your request.
 


sum
Double sum

 The sum of the values from all contributors during the time period represented by that data point.
 
 
 This statistic is returned only if you included it in the Metrics array in your request.
 


minimum
Double minimum

 The minimum value from a single contributor during the time period represented by that data point.
 
 
 This statistic is returned only if you included it in the Metrics array in your request.
 


maximum
Double maximum

 The maximum value from a single occurence from a single contributor during the time period represented by that
 data point.
 
 
 This statistic is returned only if you included it in the Metrics array in your request.
 








Class com.amazonaws.services.cloudwatch.model.InternalServiceException extends AmazonCloudWatchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatch.model.InvalidFormatException extends AmazonCloudWatchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatch.model.InvalidNextTokenException extends AmazonCloudWatchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatch.model.InvalidParameterCombinationException extends AmazonCloudWatchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatch.model.InvalidParameterValueException extends AmazonCloudWatchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatch.model.LimitExceededException extends AmazonCloudWatchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatch.model.ListDashboardsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dashboardNamePrefix
String dashboardNamePrefix

 If you specify this parameter, only the dashboards with names starting with the specified string are listed. The
 maximum length is 255, and valid characters are A-Z, a-z, 0-9, ".", "-", and "_".
 


nextToken
String nextToken

 The token returned by a previous call to indicate that there is more data available.
 








Class com.amazonaws.services.cloudwatch.model.ListDashboardsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dashboardEntries
SdkInternalList<T> dashboardEntries

 The list of matching dashboards.
 


nextToken
String nextToken

 The token that marks the start of the next batch of returned results.
 








Class com.amazonaws.services.cloudwatch.model.ListMetricsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namespace
String namespace

 The namespace to filter against.
 


metricName
String metricName

 The name of the metric to filter against.
 


dimensions
SdkInternalList<T> dimensions

 The dimensions to filter against.
 


nextToken
String nextToken

 The token returned by a previous call to indicate that there is more data available.
 








Class com.amazonaws.services.cloudwatch.model.ListMetricsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


metrics
SdkInternalList<T> metrics

 The metrics.
 


nextToken
String nextToken

 The token that marks the start of the next batch of returned results.
 








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


Serialized Fields


resourceARN
String resourceARN

 The ARN of the CloudWatch resource that you want to view tags for. For more information on ARN format, see Example
 ARNs in the Amazon Web Services General Reference.
 








Class com.amazonaws.services.cloudwatch.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 The list of tag keys and values associated with the resource you specified.
 








Class com.amazonaws.services.cloudwatch.model.MessageData extends Object implements Serializable


Serialized Fields


code
String code

 The error code or status code associated with the message.
 


value
String value

 The message text.
 








Class com.amazonaws.services.cloudwatch.model.Metric extends Object implements Serializable


Serialized Fields


namespace
String namespace

 The namespace of the metric.
 


metricName
String metricName

 The name of the metric. This is a required field.
 


dimensions
SdkInternalList<T> dimensions

 The dimensions for the metric.
 








Class com.amazonaws.services.cloudwatch.model.MetricAlarm extends Object implements Serializable


Serialized Fields


alarmName
String alarmName

 The name of the alarm.
 


alarmArn
String alarmArn

 The Amazon Resource Name (ARN) of the alarm.
 


alarmDescription
String alarmDescription

 The description of the alarm.
 


alarmConfigurationUpdatedTimestamp
Date alarmConfigurationUpdatedTimestamp

 The time stamp of the last update to the alarm configuration.
 


actionsEnabled
Boolean actionsEnabled

 Indicates whether actions should be executed during any changes to the alarm state.
 


oKActions
SdkInternalList<T> oKActions

 The actions to execute when this alarm transitions to the OK state from any other state. Each action
 is specified as an Amazon Resource Name (ARN).
 


alarmActions
SdkInternalList<T> alarmActions

 The actions to execute when this alarm transitions to the ALARM state from any other state. Each
 action is specified as an Amazon Resource Name (ARN).
 


insufficientDataActions
SdkInternalList<T> insufficientDataActions

 The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other
 state. Each action is specified as an Amazon Resource Name (ARN).
 


stateValue
String stateValue

 The state value for the alarm.
 


stateReason
String stateReason

 An explanation for the alarm state, in text format.
 


stateReasonData
String stateReasonData

 An explanation for the alarm state, in JSON format.
 


stateUpdatedTimestamp
Date stateUpdatedTimestamp

 The time stamp of the last update to the alarm state.
 


metricName
String metricName

 The name of the metric associated with the alarm, if this is an alarm based on a single metric.
 


namespace
String namespace

 The namespace of the metric associated with the alarm.
 


statistic
String statistic

 The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
 ExtendedStatistic.
 


extendedStatistic
String extendedStatistic

 The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
 


dimensions
SdkInternalList<T> dimensions

 The dimensions for the metric associated with the alarm.
 


period
Integer period

 The period, in seconds, over which the statistic is applied.
 


unit
String unit

 The unit of the metric associated with the alarm.
 


evaluationPeriods
Integer evaluationPeriods

 The number of periods over which data is compared to the specified threshold.
 


datapointsToAlarm
Integer datapointsToAlarm

 The number of data points that must be breaching to trigger the alarm.
 


threshold
Double threshold

 The value to compare with the specified statistic.
 


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.
 


treatMissingData
String treatMissingData

 Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of
 missing is used.
 


evaluateLowSampleCountPercentile
String evaluateLowSampleCountPercentile

 Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods
 with too few data points to be statistically significant. If evaluate or this parameter is not used,
 the alarm is always evaluated and possibly changes state no matter how many data points are available.
 


metrics
SdkInternalList<T> metrics

 An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either
 retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the
 alarm watches. This expression by designated by having ReturnValue set to true.
 


thresholdMetricId
String thresholdMetricId

 In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND
 function used as the threshold for the alarm.
 








Class com.amazonaws.services.cloudwatch.model.MetricDataQuery extends Object implements Serializable


Serialized Fields


id
String id

 A short name used to tie this object to the results in the response. This name must be unique within a single
 call to GetMetricData. If you are performing math expressions on this set of data, this name
 represents that data and can serve as a variable in the mathematical expression. The valid characters are
 letters, numbers, and underscore. The first character must be a lowercase letter.
 


metricStat
MetricStat metricStat

 The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is
 retrieving a metric and not performing a math expression on returned data.
 
 
 Within one MetricDataQuery object, you must specify either Expression or MetricStat but
 not both.
 


expression
String expression

 The math expression to be performed on the returned data, if this object is performing a math expression. This
 expression can use the Id of the other metrics to refer to those metrics, and can also use the
 Id of other expressions to use the result of those expressions. For more information about metric
 math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.
 
 
 Within each MetricDataQuery object, you must specify either Expression or MetricStat
 but not both.
 


label
String label

 A human-readable label for this metric or expression. This is especially useful if this is an expression, so that
 you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the
 label is shown. If Label is omitted, CloudWatch generates a default.
 


returnData
Boolean returnData

 When used in GetMetricData, this option indicates whether to return the timestamps and raw data
 values of this metric. If you are performing this call just to do math expressions and do not also need the raw
 data returned, you can specify False. If you omit this, the default of True is used.
 
 
 When used in PutMetricAlarm, specify True for the one expression result to use as the
 alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify
 ReturnData as False.
 


period
Integer period

 The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as
 short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at
 intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
 metrics are those metrics stored by a PutMetricData operation that includes a
 StorageResolution of 1 second.
 
 
 If you are performing a GetMetricData operation, use this field only if you are specifying an
 Expression. Do not use this field when you are specifying a MetricStat in a
 GetMetricData operation.
 








Class com.amazonaws.services.cloudwatch.model.MetricDataResult extends Object implements Serializable


Serialized Fields


id
String id

 The short name you specified to represent this metric.
 


label
String label

 The human-readable label associated with the data.
 


timestamps
SdkInternalList<T> timestamps

 The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches
 the number of values and the value for Timestamps[x] is Values[x].
 


values
SdkInternalList<T> values

 The data points for the metric corresponding to Timestamps. The number of values always matches the
 number of timestamps and the timestamp for Values[x] is Timestamps[x].
 


statusCode
String statusCode

 The status of the returned data. Complete indicates that all data points in the requested time range
 were returned. PartialData means that an incomplete set of data points were returned. You can use
 the NextToken value that was returned and repeat your request to get more data points.
 NextToken is not returned if you are performing a math expression. InternalError
 indicates that an error occurred. Retry your request using NextToken, if present.
 


messages
SdkInternalList<T> messages

 A list of messages with additional information about the data returned.
 








Class com.amazonaws.services.cloudwatch.model.MetricDatum extends Object implements Serializable


Serialized Fields


metricName
String metricName

 The name of the metric.
 


dimensions
SdkInternalList<T> dimensions

 The dimensions associated with the metric.
 


timestamp
Date timestamp

 The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
 


value
Double value

 The value for the metric.
 
 
 Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too
 large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity,
 -Infinity) are not supported.
 


statisticValues
StatisticSet statisticValues

 The statistical values for the metric.
 


values
SdkInternalList<T> values

 Array of numbers representing the values for the metric during the period. Each unique value is listed just once
 in this array, and the corresponding number in the Counts array specifies the number of times that
 value occurred during the period. You can include up to 150 unique values in each PutMetricData
 action that specifies a Values array.
 
 
 Although the Values array accepts numbers of type Double, CloudWatch rejects values
 that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special
 values (for example, NaN, +Infinity, -Infinity) are not supported.
 


counts
SdkInternalList<T> counts

 Array of numbers that is used along with the Values array. Each number in the Count
 array is the number of times the corresponding value in the Values array occurred during the period.
 
 
 If you omit the Counts array, the default of 1 is used as the value for each count. If you include a
 Counts array, it must include the same amount of values as the Values array.
 


unit
String unit

 When you are using a Put operation, this defines what unit you want to use when storing the metric.
 
 
 In a Get operation, this displays the unit that is used for the metric.
 


storageResolution
Integer storageResolution

 Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that
 CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this
 metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution
 is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide.
 
 
 This field is optional, if you do not specify it the default of 60 is used.
 








Class com.amazonaws.services.cloudwatch.model.MetricStat extends Object implements Serializable


Serialized Fields


metric
Metric metric

 The metric to return, including the metric name, namespace, and dimensions.
 


period
Integer period

 The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as
 short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at
 intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution
 metrics are those metrics stored by a PutMetricData call that includes a
 StorageResolution of 1 second.
 
 
 If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify
 the period as follows or no data points in that time range is returned:
 
 
 
 
 Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
 
 
 
 
 Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
 
 
 
 
 Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
 
 
 


stat
String stat

 The statistic to return. It can include any CloudWatch statistic or extended statistic.
 


unit
String unit

 When you are using a Put operation, this defines what unit you want to use when storing the metric.
 
 
 In a Get operation, if you omit Unit then all data that was collected with any unit is
 returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you
 specify a unit, the operation returns only data data that was collected with that unit specified. If you specify
 a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform
 unit conversions.
 








Class com.amazonaws.services.cloudwatch.model.MissingRequiredParameterException extends AmazonCloudWatchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatch.model.PartialFailure extends Object implements Serializable


Serialized Fields


failureResource
String failureResource

 The specified rule that could not be deleted.
 


exceptionType
String exceptionType

 The type of error.
 


failureCode
String failureCode

 The code of the error.
 


failureDescription
String failureDescription

 A description of the error.
 








Class com.amazonaws.services.cloudwatch.model.PutAnomalyDetectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namespace
String namespace

 The namespace of the metric to create the anomaly detection model for.
 


metricName
String metricName

 The name of the metric to create the anomaly detection model for.
 


dimensions
SdkInternalList<T> dimensions

 The metric dimensions to create the anomaly detection model for.
 


stat
String stat

 The statistic to use for the metric and the anomaly detection model.
 


configuration
AnomalyDetectorConfiguration configuration

 The configuration specifies details about how the anomaly detection model is to be trained, including time ranges
 to exclude when training and updating the model. You can specify as many as 10 time ranges.
 
 
 The configuration can also include the time zone to use for the metric.
 
 
 You can in
 








Class com.amazonaws.services.cloudwatch.model.PutAnomalyDetectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatch.model.PutDashboardRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dashboardName
String dashboardName

 The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard,
 replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid
 characters are A-Z, a-z, 0-9, "-", and "_". This parameter is required.
 


dashboardBody
String dashboardBody

 The detailed information about the dashboard in JSON format, including the widgets to include and their location
 on the dashboard. This parameter is required.
 
 
 For more information about the syntax, see CloudWatch-Dashboard-Body-Structure.
 








Class com.amazonaws.services.cloudwatch.model.PutDashboardResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dashboardValidationMessages
SdkInternalList<T> dashboardValidationMessages

 If the input for PutDashboard was correct and the dashboard was successfully created or modified,
 this result is empty.
 
 
 If this result includes only warning messages, then the input was valid enough for the dashboard to be created or
 modified, but some elements of the dashboard may not render.
 
 
 If this result includes error messages, the input was not valid and the operation failed.
 








Class com.amazonaws.services.cloudwatch.model.PutInsightRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleName
String ruleName

 A unique name for the rule.
 


ruleState
String ruleState

 The state of the rule. Valid values are ENABLED and DISABLED.
 


ruleDefinition
String ruleDefinition

 The definition of the rule, as a JSON object. For details on the valid syntax, see Contributor Insights Rule Syntax.
 








Class com.amazonaws.services.cloudwatch.model.PutInsightRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatch.model.PutMetricAlarmRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


alarmName
String alarmName

 The name for the alarm. This name must be unique within your AWS account.
 


alarmDescription
String alarmDescription

 The description for the alarm.
 


actionsEnabled
Boolean actionsEnabled

 Indicates whether actions should be executed during any changes to the alarm state. The default is
 TRUE.
 


oKActions
SdkInternalList<T> oKActions

 The actions to execute when this alarm transitions to an OK state from any other state. Each action
 is specified as an Amazon Resource Name (ARN).
 
 
 Valid Values: arn:aws:automate:region:ec2:stop |
 arn:aws:automate:region:ec2:terminate |
 arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot
 | arn:aws:sns:region:account-id:sns-topic-name  |
 arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name 
 
 
 Valid Values (for use with IAM roles):
 arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |
 arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |
 arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
 


alarmActions
SdkInternalList<T> alarmActions

 The actions to execute when this alarm transitions to the ALARM state from any other state. Each
 action is specified as an Amazon Resource Name (ARN).
 
 
 Valid Values: arn:aws:automate:region:ec2:stop |
 arn:aws:automate:region:ec2:terminate |
 arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot
 | arn:aws:sns:region:account-id:sns-topic-name  |
 arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name 
 
 
 Valid Values (for use with IAM roles):
 arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |
 arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |
 arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
 


insufficientDataActions
SdkInternalList<T> insufficientDataActions

 The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other
 state. Each action is specified as an Amazon Resource Name (ARN).
 
 
 Valid Values: arn:aws:automate:region:ec2:stop |
 arn:aws:automate:region:ec2:terminate |
 arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot
 | arn:aws:sns:region:account-id:sns-topic-name  |
 arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name 
 
 
 Valid Values (for use with IAM roles):
 >arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 |
 arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 |
 arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
 


metricName
String metricName

 The name for the metric associated with the alarm. For each PutMetricAlarm operation, you must
 specify either MetricName or a Metrics array.
 
 
 If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the
 Dimensions, Period, Namespace, Statistic, or
 ExtendedStatistic parameters. Instead, you specify all this information in the Metrics
 array.
 


namespace
String namespace

 The namespace for the metric associated specified in MetricName.
 


statistic
String statistic

 The statistic for the metric specified in MetricName, other than percentile. For percentile
 statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify a
 MetricName, you must specify either Statistic or ExtendedStatistic, but
 not both.
 


extendedStatistic
String extendedStatistic

 The percentile statistic for the metric specified in MetricName. Specify a value between p0.0 and
 p100. When you call PutMetricAlarm and specify a MetricName, you must specify either
 Statistic or ExtendedStatistic, but not both.
 


dimensions
SdkInternalList<T> dimensions

 The dimensions for the metric specified in MetricName.
 


period
Integer period

 The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values
 are 10, 30, and any multiple of 60.
 
 
 Period is required for alarms based on static thresholds. If you are creating an alarm based on a
 metric math expression, you specify the period for each metric within the objects in the Metrics
 array.
 
 
 Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a
 StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have
 sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case,
 it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm
 may often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution
 alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.
 
 
 An alarm's total current evaluation period can be no longer than one day, so Period multiplied by
 EvaluationPeriods cannot be more than 86,400 seconds.
 


unit
String unit

 The unit of measure for the statistic. 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.
 
 
 If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the
 metric and attempts to evaluate the alarm. Usually metrics are published with only one unit, so the alarm will
 work as intended.
 
 
 However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's
 behavior is not defined and will behave un-predictably.
 
 
 We recommend omitting Unit so that you don't inadvertently specify an incorrect unit that is not
 published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA state.
 


evaluationPeriods
Integer evaluationPeriods

 The number of periods over which data is compared to the specified threshold. If you are setting an alarm that
 requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that
 number. If you are setting an "M out of N" alarm, this value is the N.
 
 
 An alarm's total current evaluation period can be no longer than one day, so this number multiplied by
 Period cannot be more than 86,400 seconds.
 


datapointsToAlarm
Integer datapointsToAlarm

 The number of data points that must be breaching to trigger the alarm. This is used only if you are setting an
 "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.
 


threshold
Double threshold

 The value against which the specified statistic is compared.
 
 
 This parameter is required for alarms based on static thresholds, but should not be used for alarms based on
 anomaly detection models.
 


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.
 
 
 The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and
 GreaterThanUpperThreshold are used only for alarms based on anomaly detection models.
 


treatMissingData
String treatMissingData

 Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default
 behavior of missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.
 
 
 Valid Values: breaching | notBreaching | ignore | missing
 


evaluateLowSampleCountPercentile
String evaluateLowSampleCountPercentile

 Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change
 during periods with too few data points to be statistically significant. If you specify evaluate or
 omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are
 available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.
 
 
 Valid Values: evaluate | ignore
 


metrics
SdkInternalList<T> metrics

 An array of MetricDataQuery structures that enable you to create an alarm based on the result of a
 metric math expression. For each PutMetricAlarm operation, you must specify either
 MetricName or a Metrics array.
 
 
 Each item in the Metrics array either retrieves a metric or performs a math expression.
 
 
 One item in the Metrics array is the expression that the alarm watches. You designate this
 expression by setting ReturnValue to true for this object in the array. For more information, see
 MetricDataQuery.
 
 
 If you use the Metrics parameter, you cannot include the MetricName,
 Dimensions, Period, Namespace, Statistic, or
 ExtendedStatistic parameters of PutMetricAlarm in the same operation. Instead, you
 retrieve the metrics you are using in your math expression as part of the Metrics array.
 


tags
SdkInternalList<T> tags

 A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.
 
 
 Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by
 granting a user permission to access or change only resources with certain tag values.
 


thresholdMetricId
String thresholdMetricId

 If this is an alarm based on an anomaly detection model, make this value match the ID of the
 ANOMALY_DETECTION_BAND function.
 
 
 For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page.
 
 
 If your alarm uses this parameter, it cannot have Auto Scaling actions.
 








Class com.amazonaws.services.cloudwatch.model.PutMetricAlarmResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatch.model.PutMetricDataRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namespace
String namespace

 The namespace for the metric data.
 
 
 To avoid conflicts with AWS service namespaces, you should not specify a namespace that begins with
 AWS/
 


metricData
SdkInternalList<T> metricData

 The data for the metric. The array can include no more than 20 metrics per call.
 








Class com.amazonaws.services.cloudwatch.model.PutMetricDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatch.model.Range extends Object implements Serializable


Serialized Fields


startTime
Date startTime

 The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example,
 2019-07-01T23:59:59.
 


endTime
Date endTime

 The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example,
 2019-07-01T23:59:59.
 








Class com.amazonaws.services.cloudwatch.model.ResourceNotFoundException extends AmazonCloudWatchException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceType
String resourceType


resourceId
String resourceId








Class com.amazonaws.services.cloudwatch.model.SetAlarmStateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


alarmName
String alarmName

 The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.
 


stateValue
String stateValue

 The value of the state.
 


stateReason
String stateReason

 The reason that this alarm is set to this specific state, in text format.
 


stateReasonData
String stateReasonData

 The reason that this alarm is set to this specific state, in JSON format.
 








Class com.amazonaws.services.cloudwatch.model.SetAlarmStateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatch.model.StatisticSet extends Object implements Serializable


Serialized Fields


sampleCount
Double sampleCount

 The number of samples used for the statistic set.
 


sum
Double sum

 The sum of values for the sample set.
 


minimum
Double minimum

 The minimum value of the sample set.
 


maximum
Double maximum

 The maximum value of the sample set.
 








Class com.amazonaws.services.cloudwatch.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A string that you can use to assign a value. The combination of tag keys and values can help you organize and
 categorize your resources.
 


value
String value

 The value for the specified tag key.
 








Class com.amazonaws.services.cloudwatch.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the CloudWatch alarm that you're adding tags to. The ARN format is
 arn:aws:cloudwatch:Region:account-id:alarm:alarm-name 
 


tags
SdkInternalList<T> tags

 The list of key-value pairs to associate with the alarm.
 








Class com.amazonaws.services.cloudwatch.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatch.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the CloudWatch resource that you're removing tags from. For more information on ARN format, see Example
 ARNs in the Amazon Web Services General Reference.
 


tagKeys
SdkInternalList<T> tagKeys

 The list of tag keys to remove from the resource.
 








Class com.amazonaws.services.cloudwatch.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.cloudwatchevents.model




Class com.amazonaws.services.cloudwatchevents.model.ActivateEventSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the partner event source to activate.
 








Class com.amazonaws.services.cloudwatchevents.model.ActivateEventSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatchevents.model.AmazonCloudWatchEventsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatchevents.model.AwsVpcConfiguration extends Object implements Serializable


Serialized Fields


subnets
List<E> subnets

 Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as
 many as 16 subnets.
 


securityGroups
List<E> securityGroups

 Specifies the security groups associated with the task. These security groups must all be in the same VPC. You
 can specify as many as five security groups. If you don't specify a security group, the default security group
 for the VPC is used.
 


assignPublicIp
String assignPublicIp

 Specifies whether the task's elastic network interface receives a public IP address. You can specify
 ENABLED only when LaunchType in EcsParameters is set to
 FARGATE.
 








Class com.amazonaws.services.cloudwatchevents.model.BatchArrayProperties extends Object implements Serializable


Serialized Fields


size
Integer size

 The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
 








Class com.amazonaws.services.cloudwatchevents.model.BatchParameters extends Object implements Serializable


Serialized Fields


jobDefinition
String jobDefinition

 The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must
 already exist.
 


jobName
String jobName

 The name to use for this execution of the job, if the target is an AWS Batch job.
 


arrayProperties
BatchArrayProperties arrayProperties

 The array properties for the submitted job, such as the size of the array. The array size can be between 2 and
 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the
 target is an AWS Batch job.
 


retryStrategy
BatchRetryStrategy retryStrategy

 The retry strategy to use for failed jobs if the target is an AWS Batch job. The retry strategy is the number of
 times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it
 overrides the retry strategy defined in the job definition.
 








Class com.amazonaws.services.cloudwatchevents.model.BatchRetryStrategy extends Object implements Serializable


Serialized Fields


attempts
Integer attempts

 The number of times to attempt to retry, if the job fails. Valid values are 1–10.
 








Class com.amazonaws.services.cloudwatchevents.model.ConcurrentModificationException extends AmazonCloudWatchEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatchevents.model.Condition extends Object implements Serializable


Serialized Fields


type
String type

 The type of condition. Currently, the only supported value is StringEquals.
 


key
String key

 The key for the condition. Currently, the only supported key is aws:PrincipalOrgID.
 


value
String value

 The value for the key. Currently, this must be the ID of the organization.
 








Class com.amazonaws.services.cloudwatchevents.model.CreateEventBusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the new event bus.
 
 
 The names of custom event buses can't contain the / character. You can't use the name
 default for a custom event bus because this name is already used for your account's default event
 bus.
 
 
 If this is a partner event bus, the name must exactly match the name of the partner event source that this event
 bus is matched to. This name will include the / character.
 


eventSourceName
String eventSourceName

 If you're creating a partner event bus, this specifies the partner event source that the new event bus will be
 matched with.
 








Class com.amazonaws.services.cloudwatchevents.model.CreateEventBusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventBusArn
String eventBusArn

 The ARN of the new event bus.
 








Class com.amazonaws.services.cloudwatchevents.model.CreatePartnerEventSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the partner event source. This name must be unique and must be in the format
  partner_name/event_namespace/event_name . The AWS account that wants to use
 this partner event source must create a partner event bus with a name that matches the name of the partner event
 source.
 


account
String account

 The AWS account ID of the customer who is permitted to create a matching partner event bus for this partner event
 source.
 








Class com.amazonaws.services.cloudwatchevents.model.CreatePartnerEventSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventSourceArn
String eventSourceArn

 The ARN of the partner event source.
 








Class com.amazonaws.services.cloudwatchevents.model.DeactivateEventSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the partner event source to deactivate.
 








Class com.amazonaws.services.cloudwatchevents.model.DeactivateEventSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatchevents.model.DeleteEventBusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the event bus to delete.
 








Class com.amazonaws.services.cloudwatchevents.model.DeleteEventBusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatchevents.model.DeletePartnerEventSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the event source to delete.
 


account
String account

 The AWS account ID of the AWS customer that the event source was created for.
 








Class com.amazonaws.services.cloudwatchevents.model.DeletePartnerEventSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatchevents.model.DeleteRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule. If you omit this, the default event bus is used.
 


force
Boolean force

 If this is a managed rule, created by an AWS service on your behalf, you must specify Force as
 True to delete the rule. This parameter is ignored for rules that are not managed rules. You can
 check whether a rule is a managed rule by using DescribeRule or ListRules and checking
 the ManagedBy field of the response.
 








Class com.amazonaws.services.cloudwatchevents.model.DeleteRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatchevents.model.DescribeEventBusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the event bus to show details for. If you omit this, the default event bus is displayed.
 








Class com.amazonaws.services.cloudwatchevents.model.DescribeEventBusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the event bus. Currently, this is always default.
 


arn
String arn

 The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
 


policy
String policy

 The policy that enables the external account to send events to your account.
 








Class com.amazonaws.services.cloudwatchevents.model.DescribeEventSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the partner event source to display the details of.
 








Class com.amazonaws.services.cloudwatchevents.model.DescribeEventSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN of the partner event source.
 


createdBy
String createdBy

 The name of the SaaS partner that created the event source.
 


creationTime
Date creationTime

 The date and time that the event source was created.
 


expirationTime
Date expirationTime

 The date and time that the event source will expire if you don't create a matching event bus.
 


name
String name

 The name of the partner event source.
 


state
String state

 The state of the event source. If it's ACTIVE, you have already created a matching event bus for
 this event source, and that event bus is active. If it's PENDING, either you haven't yet created a
 matching event bus, or that event bus is deactivated. If it's DELETED, you have created a matching
 event bus, but the event source has since been deleted.
 








Class com.amazonaws.services.cloudwatchevents.model.DescribePartnerEventSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the event source to display.
 








Class com.amazonaws.services.cloudwatchevents.model.DescribePartnerEventSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN of the event source.
 


name
String name

 The name of the event source.
 








Class com.amazonaws.services.cloudwatchevents.model.DescribeRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule. If you omit this, the default event bus is used.
 








Class com.amazonaws.services.cloudwatchevents.model.DescribeRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


arn
String arn

 The Amazon Resource Name (ARN) of the rule.
 


eventPattern
String eventPattern

 The event pattern. For more information, see Event
 Patterns in the Amazon EventBridge User Guide.
 


scheduleExpression
String scheduleExpression

 The scheduling expression: for example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
 


state
String state

 Specifies whether the rule is enabled or disabled.
 


description
String description

 The description of the rule.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role associated with the rule.
 


managedBy
String managedBy

 If this is a managed rule, created by an AWS service on your behalf, this field displays the principal name of
 the AWS service that created the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule.
 








Class com.amazonaws.services.cloudwatchevents.model.DisableRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule. If you omit this, the default event bus is used.
 








Class com.amazonaws.services.cloudwatchevents.model.DisableRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatchevents.model.EcsParameters extends Object implements Serializable


Serialized Fields


taskDefinitionArn
String taskDefinitionArn

 The ARN of the task definition to use if the event target is an Amazon ECS task.
 


taskCount
Integer taskCount

 The number of tasks to create based on TaskDefinition. The default is 1.
 


launchType
String launchType

 Specifies the launch type on which your task is running. The launch type that you specify here must match one of
 the launch type (compatibilities) of the target task. The FARGATE value is supported only in the
 Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS
 in the Amazon Elastic Container Service Developer Guide.
 


networkConfiguration
NetworkConfiguration networkConfiguration

 Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC
 subnets and security groups associated with the task and whether a public IP address is to be used. This
 structure is required if LaunchType is FARGATE because the awsvpc mode is
 required for Fargate tasks.
 
 
 If you specify NetworkConfiguration when the target ECS task doesn't use the awsvpc
 network mode, the task fails.
 


platformVersion
String platformVersion

 Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as
 1.1.0.
 
 
 This structure is used only if LaunchType is FARGATE. For more information about valid
 platform versions, see AWS Fargate Platform
 Versions in the Amazon Elastic Container Service Developer Guide.
 


group
String group

 Specifies an ECS task group for the task. The maximum length is 255 characters.
 








Class com.amazonaws.services.cloudwatchevents.model.EnableRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule. If you omit this, the default event bus is used.
 








Class com.amazonaws.services.cloudwatchevents.model.EnableRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatchevents.model.EventBus extends Object implements Serializable


Serialized Fields


name
String name

 The name of the event bus.
 


arn
String arn

 The ARN of the event bus.
 


policy
String policy

 The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.
 








Class com.amazonaws.services.cloudwatchevents.model.EventSource extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the event source.
 


createdBy
String createdBy

 The name of the partner that created the event source.
 


creationTime
Date creationTime

 The date and time when the event source was created.
 


expirationTime
Date expirationTime

 The date and time when the event source will expire if the AWS account doesn't create a matching event bus for
 it.
 


name
String name

 The name of the event source.
 


state
String state

 The state of the event source. If it's ACTIVE, you have already created a matching event bus for
 this event source, and that event bus is active. If it's PENDING, either you haven't yet created a
 matching event bus, or that event bus is deactivated. If it's DELETED, you have created a matching
 event bus, but the event source has since been deleted.
 








Class com.amazonaws.services.cloudwatchevents.model.InputTransformer extends Object implements Serializable


Serialized Fields


inputPathsMap
Map<K,V> inputPathsMap

 Map of JSON paths to be extracted from the event. You can then insert these in the template in
 InputTemplate to produce the output to be sent to the target.
 
 
 InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as
 many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.
 
 
 The keys can't start with "AWS".
 


inputTemplate
String inputTemplate

 Input template where you specify placeholders that will be filled with the values of the keys from
 InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps
 value in brackets: <value>. The InputTemplate must be valid JSON.
 
 
 If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:
 
 
 
 
 The placeholder can't be used as an object key
 
 
 
 
 Object values can't include quote marks
 
 
 
 
 The following example shows the syntax for using InputPathsMap and InputTemplate.
 
 
  "InputTransformer":
 
 
 {
 
 
 "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
 
 
 "InputTemplate": "<instance> is in state <status>"
 
 
 }
 
 
 To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a
 slash, as in the following example:
 
 
  "InputTransformer":
 
 
 {
 
 
 "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
 
 
 "InputTemplate": "<instance> is in state \"<status>\""
 
 
 }
 








Class com.amazonaws.services.cloudwatchevents.model.InternalException extends AmazonCloudWatchEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatchevents.model.InvalidEventPatternException extends AmazonCloudWatchEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatchevents.model.InvalidStateException extends AmazonCloudWatchEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatchevents.model.KinesisParameters extends Object implements Serializable


Serialized Fields


partitionKeyPath
String partitionKeyPath

 The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key
 Concepts in the Amazon Kinesis Streams Developer Guide.
 








Class com.amazonaws.services.cloudwatchevents.model.LimitExceededException extends AmazonCloudWatchEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatchevents.model.ListEventBusesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namePrefix
String namePrefix

 Specifying this limits the results to only those event buses with names that start with the specified prefix.
 


nextToken
String nextToken

 The token returned by a previous call to retrieve the next set of results.
 


limit
Integer limit

 Specifying this limits the number of results returned by this operation. The operation also returns a
 NextToken that you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.cloudwatchevents.model.ListEventBusesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventBuses
List<E> eventBuses

 This list of event buses.
 


nextToken
String nextToken

 A token you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.cloudwatchevents.model.ListEventSourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namePrefix
String namePrefix

 Specifying this limits the results to only those partner event sources with names that start with the specified
 prefix.
 


nextToken
String nextToken

 The token returned by a previous call to retrieve the next set of results.
 


limit
Integer limit

 Specifying this limits the number of results returned by this operation. The operation also returns a
 NextToken that you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.cloudwatchevents.model.ListEventSourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventSources
List<E> eventSources

 The list of event sources.
 


nextToken
String nextToken

 A token you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.cloudwatchevents.model.ListPartnerEventSourceAccountsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventSourceName
String eventSourceName

 The name of the partner event source to display account information about.
 


nextToken
String nextToken

 The token returned by a previous call to this operation. Specifying this retrieves the next set of results.
 


limit
Integer limit

 Specifying this limits the number of results returned by this operation. The operation also returns a
 NextToken that you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.cloudwatchevents.model.ListPartnerEventSourceAccountsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


partnerEventSourceAccounts
List<E> partnerEventSourceAccounts

 The list of partner event sources returned by the operation.
 


nextToken
String nextToken

 A token you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.cloudwatchevents.model.ListPartnerEventSourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namePrefix
String namePrefix

 If you specify this, the results are limited to only those partner event sources that start with the string you
 specify.
 


nextToken
String nextToken

 The token returned by a previous call to this operation. Specifying this retrieves the next set of results.
 


limit
Integer limit

 pecifying this limits the number of results returned by this operation. The operation also returns a
 NextToken that you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.cloudwatchevents.model.ListPartnerEventSourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


partnerEventSources
List<E> partnerEventSources

 The list of partner event sources returned by the operation.
 


nextToken
String nextToken

 A token you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.cloudwatchevents.model.ListRuleNamesByTargetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetArn
String targetArn

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


eventBusName
String eventBusName

 Limits the results to show only the rules associated with the specified event bus.
 


nextToken
String nextToken

 The token returned by a previous call to retrieve the next set of results.
 


limit
Integer limit

 The maximum number of results to return.
 








Class com.amazonaws.services.cloudwatchevents.model.ListRuleNamesByTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ruleNames
List<E> ruleNames

 The names of the rules that can invoke the given target.
 


nextToken
String nextToken

 Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
 








Class com.amazonaws.services.cloudwatchevents.model.ListRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namePrefix
String namePrefix

 The prefix matching the rule name.
 


eventBusName
String eventBusName

 Limits the results to show only the rules associated with the specified event bus.
 


nextToken
String nextToken

 The token returned by a previous call to retrieve the next set of results.
 


limit
Integer limit

 The maximum number of results to return.
 








Class com.amazonaws.services.cloudwatchevents.model.ListRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rules
List<E> rules

 The rules that match the specified criteria.
 


nextToken
String nextToken

 Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
 








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


Serialized Fields


resourceARN
String resourceARN

 The ARN of the rule for which you want to view tags.
 








Class com.amazonaws.services.cloudwatchevents.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The list of tag keys and values associated with the rule that you specified.
 








Class com.amazonaws.services.cloudwatchevents.model.ListTargetsByRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rule
String rule

 The name of the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule. If you omit this, the default event bus is used.
 


nextToken
String nextToken

 The token returned by a previous call to retrieve the next set of results.
 


limit
Integer limit

 The maximum number of results to return.
 








Class com.amazonaws.services.cloudwatchevents.model.ListTargetsByRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


targets
List<E> targets

 The targets assigned to the rule.
 


nextToken
String nextToken

 Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
 








Class com.amazonaws.services.cloudwatchevents.model.ManagedRuleException extends AmazonCloudWatchEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatchevents.model.NetworkConfiguration extends Object implements Serializable


Serialized Fields


awsvpcConfiguration
AwsVpcConfiguration awsvpcConfiguration

 Use this structure to specify the VPC subnets and security groups for the task and whether a public IP address is
 to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
 








Class com.amazonaws.services.cloudwatchevents.model.PartnerEventSource extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the partner event source.
 


name
String name

 The name of the partner event source.
 








Class com.amazonaws.services.cloudwatchevents.model.PartnerEventSourceAccount extends Object implements Serializable


Serialized Fields


account
String account

 The AWS account ID that the partner event source was offered to.
 


creationTime
Date creationTime

 The date and time when the event source was created.
 


expirationTime
Date expirationTime

 The date and time when the event source will expire if the AWS account doesn't create a matching event bus for
 it.
 


state
String state

 The state of the event source. If it's ACTIVE, you have already created a matching event bus for
 this event source, and that event bus is active. If it's PENDING, either you haven't yet created a
 matching event bus, or that event bus is deactivated. If it's DELETED, you have created a matching
 event bus, but the event source has since been deleted.
 








Class com.amazonaws.services.cloudwatchevents.model.PolicyLengthExceededException extends AmazonCloudWatchEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatchevents.model.PutEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


entries
List<E> entries

 The entry that defines an event in your system. You can specify several parameters for the entry such as the
 source and type of the event, resources associated with the event, and so on.
 








Class com.amazonaws.services.cloudwatchevents.model.PutEventsRequestEntry extends Object implements Serializable


Serialized Fields


time
Date time

 The timestamp of the event, per RFC3339. If no timestamp
 is provided, the timestamp of the PutEvents call is used.
 


source
String source

 The source of the event. This field is required.
 


resources
List<E> resources

 AWS resources, identified by Amazon Resource Name (ARN), that the event primarily concerns. Any number, including
 zero, can be present.
 


detailType
String detailType

 Free-form string used to decide which fields to expect in the event detail.
 


detail
String detail

 A valid JSON string. There is no other schema imposed. The JSON string can contain fields and nested subobjects.
 


eventBusName
String eventBusName

 The event bus that will receive the event. Only the rules that are associated with this event bus can match the
 event.
 








Class com.amazonaws.services.cloudwatchevents.model.PutEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedEntryCount
Integer failedEntryCount

 The number of failed entries.
 


entries
List<E> entries

 The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the
 event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.
 








Class com.amazonaws.services.cloudwatchevents.model.PutEventsResultEntry extends Object implements Serializable


Serialized Fields


eventId
String eventId

 The ID of the event.
 


errorCode
String errorCode

 The error code that indicates why the event submission failed.
 


errorMessage
String errorMessage

 The error message that explains why the event submission failed.
 








Class com.amazonaws.services.cloudwatchevents.model.PutPartnerEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


entries
List<E> entries

 The list of events to write to the event bus.
 








Class com.amazonaws.services.cloudwatchevents.model.PutPartnerEventsRequestEntry extends Object implements Serializable


Serialized Fields


time
Date time

 The date and time of the event.
 


source
String source

 The event source that is generating the evntry.
 


resources
List<E> resources

 AWS resources, identified by Amazon Resource Name (ARN), that the event primarily concerns. Any number, including
 zero, can be present.
 


detailType
String detailType

 A free-form string used to decide which fields to expect in the event detail.
 


detail
String detail

 A valid JSON string. There is no other schema imposed. The JSON string can contain fields and nested subobjects.
 








Class com.amazonaws.services.cloudwatchevents.model.PutPartnerEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedEntryCount
Integer failedEntryCount

 The number of events from this operation that couldn't be written to the partner event bus.
 


entries
List<E> entries

 The list of events from this operation that were successfully written to the partner event bus.
 








Class com.amazonaws.services.cloudwatchevents.model.PutPartnerEventsResultEntry extends Object implements Serializable


Serialized Fields


eventId
String eventId

 The ID of the event.
 


errorCode
String errorCode

 The error code that indicates why the event submission failed.
 


errorMessage
String errorMessage

 The error message that explains why the event submission failed.
 








Class com.amazonaws.services.cloudwatchevents.model.PutPermissionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventBusName
String eventBusName

 The event bus associated with the rule. If you omit this, the default event bus is used.
 


action
String action

 The action that you're enabling the other account to perform. Currently, this must be
 events:PutEvents.
 


principal
String principal

 The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to
 permit any account to put events to your default event bus.
 
 
 If you specify "*" without specifying Condition, avoid creating rules that might match undesirable
 events. To create more secure rules, make sure that the event pattern for each rule contains an
 account field with a specific account ID to receive events from. Rules with an account field don't
 match any events sent from other accounts.
 


statementId
String statementId

 An identifier string for the external account that you're granting permissions to. If you later want to revoke
 the permission for this external account, specify this StatementId when you run
 RemovePermission.
 


condition
Condition condition

 This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a
 member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS
 Organizations? in the AWS Organizations User Guide.
 
 
 If you specify Condition with an AWS organization ID and specify "*" as the value for
 Principal, you grant permission to all the accounts in the named organization.
 
 
 The Condition is a JSON string that must contain Type, Key, and
 Value fields.
 








Class com.amazonaws.services.cloudwatchevents.model.PutPermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatchevents.model.PutRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the rule that you're creating or updating.
 


scheduleExpression
String scheduleExpression

 The scheduling expression: for example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
 


eventPattern
String eventPattern

 The event pattern. For more information, see Event
 Patterns in the Amazon EventBridge User Guide.
 


state
String state

 Indicates whether the rule is enabled or disabled.
 


description
String description

 A description of the rule.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role associated with the rule.
 


tags
List<E> tags

 The list of key-value pairs to associate with the rule.
 


eventBusName
String eventBusName

 The event bus to associate with this rule. If you omit this, the default event bus is used.
 








Class com.amazonaws.services.cloudwatchevents.model.PutRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ruleArn
String ruleArn

 The Amazon Resource Name (ARN) of the rule.
 








Class com.amazonaws.services.cloudwatchevents.model.PutTargetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rule
String rule

 The name of the rule.
 


eventBusName
String eventBusName

 The name of the event bus associated with the rule. If you omit this, the default event bus is used.
 


targets
List<E> targets

 The targets to update or add to the rule.
 








Class com.amazonaws.services.cloudwatchevents.model.PutTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedEntryCount
Integer failedEntryCount

 The number of failed entries.
 


failedEntries
List<E> failedEntries

 The failed target entries.
 








Class com.amazonaws.services.cloudwatchevents.model.PutTargetsResultEntry extends Object implements Serializable


Serialized Fields


targetId
String targetId

 The ID of the target.
 


errorCode
String errorCode

 The error code that indicates why the target addition failed. If the value is
 ConcurrentModificationException, too many requests were made at the same time.
 


errorMessage
String errorMessage

 The error message that explains why the target addition failed.
 








Class com.amazonaws.services.cloudwatchevents.model.RemovePermissionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


statementId
String statementId

 The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.
 


eventBusName
String eventBusName

 The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.
 








Class com.amazonaws.services.cloudwatchevents.model.RemovePermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatchevents.model.RemoveTargetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rule
String rule

 The name of the rule.
 


eventBusName
String eventBusName

 The name of the event bus associated with the rule.
 


ids
List<E> ids

 The IDs of the targets to remove from the rule.
 


force
Boolean force

 If this is a managed rule created by an AWS service on your behalf, you must specify Force as
 True to remove targets. This parameter is ignored for rules that aren't managed rules. You can check
 whether a rule is a managed rule by using DescribeRule or ListRules and checking the
 ManagedBy field of the response.
 








Class com.amazonaws.services.cloudwatchevents.model.RemoveTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedEntryCount
Integer failedEntryCount

 The number of failed entries.
 


failedEntries
List<E> failedEntries

 The failed target entries.
 








Class com.amazonaws.services.cloudwatchevents.model.RemoveTargetsResultEntry extends Object implements Serializable


Serialized Fields


targetId
String targetId

 The ID of the target.
 


errorCode
String errorCode

 The error code that indicates why the target removal failed. If the value is
 ConcurrentModificationException, too many requests were made at the same time.
 


errorMessage
String errorMessage

 The error message that explains why the target removal failed.
 








Class com.amazonaws.services.cloudwatchevents.model.ResourceAlreadyExistsException extends AmazonCloudWatchEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatchevents.model.ResourceNotFoundException extends AmazonCloudWatchEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cloudwatchevents.model.Rule extends Object implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


arn
String arn

 The Amazon Resource Name (ARN) of the rule.
 


eventPattern
String eventPattern

 The event pattern of the rule. For more information, see Event
 Patterns in the Amazon EventBridge User Guide.
 


state
String state

 The state of the rule.
 


description
String description

 The description of the rule.
 


scheduleExpression
String scheduleExpression

 The scheduling expression: for example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the role that is used for target invocation.
 


managedBy
String managedBy

 If an AWS service created the rule on behalf of your account, this field displays the principal name of the
 service that created the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule.
 








Class com.amazonaws.services.cloudwatchevents.model.RunCommandParameters extends Object implements Serializable


Serialized Fields


runCommandTargets
List<E> runCommandTargets

 Currently, we support including only one RunCommandTarget block, which specifies either an array of
 InstanceIds or a tag.
 








Class com.amazonaws.services.cloudwatchevents.model.RunCommandTarget extends Object implements Serializable


Serialized Fields


key
String key

 Can be either tag: tag-key or InstanceIds.
 


values
List<E> values

 If Key is tag: tag-key, Values is a list of tag values. If
 Key is InstanceIds, Values is a list of Amazon EC2 instance IDs.
 








Class com.amazonaws.services.cloudwatchevents.model.SqsParameters extends Object implements Serializable


Serialized Fields


messageGroupId
String messageGroupId

 The FIFO message group ID to use as the target.
 








Class com.amazonaws.services.cloudwatchevents.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A string that you can use to assign a value. The combination of tag keys and values can help you organize and
 categorize your resources.
 


value
String value

 The value for the specified tag key.
 








Class com.amazonaws.services.cloudwatchevents.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the rule that you're adding tags to.
 


tags
List<E> tags

 The list of key-value pairs to associate with the rule.
 








Class com.amazonaws.services.cloudwatchevents.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cloudwatchevents.model.Target extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the target.
 


arn
String arn

 The Amazon Resource Name (ARN) of the target.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule
 triggers multiple targets, you can use a different IAM role for each target.
 


input
String input

 Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For
 more information, 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.
 You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.
 


inputTransformer
InputTransformer inputTransformer

 Settings to enable you to provide custom input to a target based on certain event data. You can extract one or
 more key-value pairs from the event and then use that data to send customized input to the target.
 


kinesisParameters
KinesisParameters kinesisParameters

 The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream.
 If you don't include this parameter, the default is to use the eventId as the partition key.
 


runCommandParameters
RunCommandParameters runCommandParameters

 Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
 


ecsParameters
EcsParameters ecsParameters

 Contains the Amazon ECS task definition and task count to be used if the event target is an Amazon ECS task. For
 more information about Amazon ECS tasks, see Task Definitions  in
 the Amazon EC2 Container Service Developer Guide.
 


batchParameters
BatchParameters batchParameters

 If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For
 more information, see Jobs in the
 AWS Batch User Guide.
 


sqsParameters
SqsParameters sqsParameters

 Contains the message group ID to use when the target is a FIFO queue.
 
 
 If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
 








Class com.amazonaws.services.cloudwatchevents.model.TestEventPatternRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventPattern
String eventPattern

 The event pattern. For more information, see Event
 Patterns in the Amazon EventBridge User Guide.
 


event
String event

 The event, in JSON format, to test against the event pattern.
 








Class com.amazonaws.services.cloudwatchevents.model.TestEventPatternResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


result
Boolean result

 Indicates whether the event matches the event pattern.
 








Class com.amazonaws.services.cloudwatchevents.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the rule that you're removing tags from.
 


tagKeys
List<E> tagKeys

 The list of tag keys to remove from the resource.
 








Class com.amazonaws.services.cloudwatchevents.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.codebuild.model




Class com.amazonaws.services.codebuild.model.AccountLimitExceededException extends AWSCodeBuildException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codebuild.model.AWSCodeBuildException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codebuild.model.BatchDeleteBuildsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ids
List<E> ids

 The IDs of the builds to delete.
 








Class com.amazonaws.services.codebuild.model.BatchDeleteBuildsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


buildsDeleted
List<E> buildsDeleted

 The IDs of the builds that were successfully deleted.
 


buildsNotDeleted
List<E> buildsNotDeleted

 Information about any builds that could not be successfully deleted.
 








Class com.amazonaws.services.codebuild.model.BatchGetBuildsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ids
List<E> ids

 The IDs of the builds.
 








Class com.amazonaws.services.codebuild.model.BatchGetBuildsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


builds
List<E> builds

 Information about the requested builds.
 


buildsNotFound
List<E> buildsNotFound

 The IDs of builds for which information could not be found.
 








Class com.amazonaws.services.codebuild.model.BatchGetProjectsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


names
List<E> names

 The names or ARNs of the build projects. To get information about a project shared with your AWS account, its ARN
 must be specified. You cannot specify a shared project using its name.
 








Class com.amazonaws.services.codebuild.model.BatchGetProjectsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


projects
List<E> projects

 Information about the requested build projects.
 


projectsNotFound
List<E> projectsNotFound

 The names of build projects for which information could not be found.
 








Class com.amazonaws.services.codebuild.model.BatchGetReportGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reportGroupArns
List<E> reportGroupArns

 An array of report group ARNs that identify the report groups to return.
 








Class com.amazonaws.services.codebuild.model.BatchGetReportGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reportGroups
List<E> reportGroups

 The array of report groups returned by BatchGetReportGroups.
 


reportGroupsNotFound
List<E> reportGroupsNotFound

 An array of ARNs passed to BatchGetReportGroups that are not associated with a
 ReportGroup.
 








Class com.amazonaws.services.codebuild.model.BatchGetReportsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reportArns
List<E> reportArns

 An array of ARNs that identify the Report objects to return.
 








Class com.amazonaws.services.codebuild.model.BatchGetReportsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reports
List<E> reports

 The array of Report objects returned by BatchGetReports.
 


reportsNotFound
List<E> reportsNotFound

 An array of ARNs passed to BatchGetReportGroups that are not associated with a Report.
 








Class com.amazonaws.services.codebuild.model.Build extends Object implements Serializable


Serialized Fields


id
String id

 The unique ID for the build.
 


arn
String arn

 The Amazon Resource Name (ARN) of the build.
 


buildNumber
Long buildNumber

 The number of the build. For each project, the buildNumber of its first build is 1. The
 buildNumber of each subsequent build is incremented by 1. If a build is deleted, the
 buildNumber of other builds does not change.
 


startTime
Date startTime

 When the build process started, expressed in Unix time format.
 


endTime
Date endTime

 When the build process ended, expressed in Unix time format.
 


currentPhase
String currentPhase

 The current build phase.
 


buildStatus
String buildStatus

 The current status of the build. Valid values include:
 
 
 
 
 FAILED: The build failed.
 
 
 
 
 FAULT: The build faulted.
 
 
 
 
 IN_PROGRESS: The build is still in progress.
 
 
 
 
 STOPPED: The build stopped.
 
 
 
 
 SUCCEEDED: The build succeeded.
 
 
 
 
 TIMED_OUT: The build timed out.
 
 
 


sourceVersion
String sourceVersion

 Any version identifier for the version of the source code to be built. If sourceVersion is specified
 at the project level, then this sourceVersion (at the build level) takes precedence.
 
 
 For more information, see Source Version Sample
 with CodeBuild in the AWS CodeBuild User Guide.
 


resolvedSourceVersion
String resolvedSourceVersion

 An identifier for the version of this build's source code.
 
 
 
 
 For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.
 
 
 
 
 For AWS CodePipeline, the source revision provided by AWS CodePipeline.
 
 
 
 
 For Amazon Simple Storage Service (Amazon S3), this does not apply.
 
 
 


projectName
String projectName

 The name of the AWS CodeBuild project.
 


phases
List<E> phases

 Information about all previous build phases that are complete and information about any current build phase that
 is not yet complete.
 


source
ProjectSource source

 Information about the source code to be built.
 


secondarySources
List<E> secondarySources

 An array of ProjectSource objects.
 


secondarySourceVersions
List<E> secondarySourceVersions

 An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:
 
 
 
 
 For AWS CodeCommit: the commit ID, branch, or Git tag to use.
 
 
 
 
 For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the
 source code you want to build. If a pull request ID is specified, it must use the format
 pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's
 HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
 
 
 
 
 For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you
 want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default
 branch's HEAD commit ID is used.
 
 
 
 
 For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP
 file to use.
 
 
 


artifacts
BuildArtifacts artifacts

 Information about the output artifacts for the build.
 


secondaryArtifacts
List<E> secondaryArtifacts

 An array of ProjectArtifacts objects.
 


cache
ProjectCache cache

 Information about the cache for the build.
 


environment
ProjectEnvironment environment

 Information about the build environment for this build.
 


serviceRole
String serviceRole

 The name of a service role used for this build.
 


logs
LogsLocation logs

 Information about the build's logs in Amazon CloudWatch Logs.
 


timeoutInMinutes
Integer timeoutInMinutes

 How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as
 completed.
 


queuedTimeoutInMinutes
Integer queuedTimeoutInMinutes

 The number of minutes a build is allowed to be queued before it times out.
 


buildComplete
Boolean buildComplete

 Whether the build is complete. True if complete; otherwise, false.
 


initiator
String initiator

 The entity that started the build. Valid values include:
 
 
 
 
 If AWS CodePipeline started the build, the pipeline's name (for example,
 codepipeline/my-demo-pipeline).
 
 
 
 
 If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example,
 MyUserName).
 
 
 
 
 If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.
 
 
 


vpcConfig
VpcConfig vpcConfig

 If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the
 VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same
 VPC. You must provide at least one security group and one subnet ID.
 


networkInterface
NetworkInterface networkInterface

 Describes a network interface.
 


encryptionKey
String encryptionKey

 The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output
 artifacts.
 
 
 
 You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to
 that key.
 
 
 
 You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the
 format alias/alias-name ).
 


exportedEnvironmentVariables
List<E> exportedEnvironmentVariables

 A list of exported environment variables for this build.
 


reportArns
List<E> reportArns

 An array of the ARNs associated with this build's reports.
 








Class com.amazonaws.services.codebuild.model.BuildArtifacts extends Object implements Serializable


Serialized Fields


location
String location

 Information about the location of the build artifacts.
 


sha256sum
String sha256sum

 The SHA-256 hash of the build artifact.
 
 
 You can use this hash along with a checksum tool to confirm file integrity and authenticity.
 
 
 
 This value is available only if the build project's packaging value is set to ZIP.
 
 


md5sum
String md5sum

 The MD5 hash of the build artifact.
 
 
 You can use this hash along with a checksum tool to confirm file integrity and authenticity.
 
 
 
 This value is available only if the build project's packaging value is set to ZIP.
 
 


overrideArtifactName
Boolean overrideArtifactName

 If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a
 build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a
 date and time to your artifact name so that it is always unique.
 


encryptionDisabled
Boolean encryptionDisabled

 Information that tells you if encryption for build artifacts is disabled.
 


artifactIdentifier
String artifactIdentifier

 An identifier for this artifact definition.
 








Class com.amazonaws.services.codebuild.model.BuildNotDeleted extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the build that could not be successfully deleted.
 


statusCode
String statusCode

 Additional information about the build that could not be successfully deleted.
 








Class com.amazonaws.services.codebuild.model.BuildPhase extends Object implements Serializable


Serialized Fields


phaseType
String phaseType

 The name of the build phase. Valid values include:
 
 
 
 
 BUILD: Core build activities typically occur in this build phase.
 
 
 
 
 COMPLETED: The build has been completed.
 
 
 
 
 DOWNLOAD_SOURCE: Source code is being downloaded in this build phase.
 
 
 
 
 FINALIZING: The build process is completing in this build phase.
 
 
 
 
 INSTALL: Installation activities typically occur in this build phase.
 
 
 
 
 POST_BUILD: Post-build activities typically occur in this build phase.
 
 
 
 
 PRE_BUILD: Pre-build activities typically occur in this build phase.
 
 
 
 
 PROVISIONING: The build environment is being set up.
 
 
 
 
 QUEUED: The build has been submitted and is queued behind other submitted builds.
 
 
 
 
 SUBMITTED: The build has been submitted.
 
 
 
 
 UPLOAD_ARTIFACTS: Build output artifacts are being uploaded to the output location.
 
 
 


phaseStatus
String phaseStatus

 The current status of the build phase. Valid values include:
 
 
 
 
 FAILED: The build phase failed.
 
 
 
 
 FAULT: The build phase faulted.
 
 
 
 
 IN_PROGRESS: The build phase is still in progress.
 
 
 
 
 QUEUED: The build has been submitted and is queued behind other submitted builds.
 
 
 
 
 STOPPED: The build phase stopped.
 
 
 
 
 SUCCEEDED: The build phase succeeded.
 
 
 
 
 TIMED_OUT: The build phase timed out.
 
 
 


startTime
Date startTime

 When the build phase started, expressed in Unix time format.
 


endTime
Date endTime

 When the build phase ended, expressed in Unix time format.
 


durationInSeconds
Long durationInSeconds

 How long, in seconds, between the starting and ending times of the build's phase.
 


contexts
List<E> contexts

 Additional information about a build phase, especially to help troubleshoot a failed build.
 








Class com.amazonaws.services.codebuild.model.CloudWatchLogsConfig extends Object implements Serializable


Serialized Fields


status
String status

 The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:
 
 
 
 
 ENABLED: Amazon CloudWatch Logs are enabled for this build project.
 
 
 
 
 DISABLED: Amazon CloudWatch Logs are not enabled for this build project.
 
 
 


groupName
String groupName

 The group name of the logs in Amazon CloudWatch Logs. For more information, see Working
 with Log Groups and Log Streams.
 


streamName
String streamName

 The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working
 with Log Groups and Log Streams.
 








Class com.amazonaws.services.codebuild.model.CreateProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the build project.
 


description
String description

 A description that makes the build project easy to identify.
 


source
ProjectSource source

 Information about the build input source code for the build project.
 


secondarySources
List<E> secondarySources

 An array of ProjectSource objects.
 


sourceVersion
String sourceVersion

 A version of the build input to be built for this project. If not specified, the latest version is used. If
 specified, it must be one of:
 
 
 
 
 For AWS CodeCommit: the commit ID, branch, or Git tag to use.
 
 
 
 
 For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the
 source code you want to build. If a pull request ID is specified, it must use the format
 pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's
 HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
 
 
 
 
 For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you
 want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default
 branch's HEAD commit ID is used.
 
 
 
 
 For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP
 file to use.
 
 
 
 
 If sourceVersion is specified at the build level, then that version takes precedence over this
 sourceVersion (at the project level).
 
 
 For more information, see Source Version Sample
 with CodeBuild in the AWS CodeBuild User Guide.
 


secondarySourceVersions
List<E> secondarySourceVersions

 An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at
 the build level, then they take precedence over these secondarySourceVersions (at the project
 level).
 


artifacts
ProjectArtifacts artifacts

 Information about the build output artifacts for the build project.
 


secondaryArtifacts
List<E> secondaryArtifacts

 An array of ProjectArtifacts objects.
 


cache
ProjectCache cache

 Stores recently used information so that it can be quickly accessed at a later time.
 


environment
ProjectEnvironment environment

 Information about the build environment for the build project.
 


serviceRole
String serviceRole

 The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with
 dependent AWS services on behalf of the AWS account.
 


timeoutInMinutes
Integer timeoutInMinutes

 How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out any build that has
 not been marked as completed. The default is 60 minutes.
 


queuedTimeoutInMinutes
Integer queuedTimeoutInMinutes

 The number of minutes a build is allowed to be queued before it times out.
 


encryptionKey
String encryptionKey

 The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output
 artifacts.
 
 
 
 You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to
 that key.
 
 
 
 You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the
 format alias/alias-name ).
 


tags
List<E> tags

 A set of tags for this build project.
 
 
 These tags are available for use by AWS services that support AWS CodeBuild build project tags.
 


vpcConfig
VpcConfig vpcConfig

 VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.
 


badgeEnabled
Boolean badgeEnabled

 Set this to true to generate a publicly accessible URL for your project's build badge.
 


logsConfig
LogsConfig logsConfig

 Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs uploaded to a
 specified S3 bucket, or both.
 








Class com.amazonaws.services.codebuild.model.CreateProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


project
Project project

 Information about the build project that was created.
 








Class com.amazonaws.services.codebuild.model.CreateReportGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the report group.
 


type
String type

 The type of report group.
 


exportConfig
ReportExportConfig exportConfig

 A ReportExportConfig object that contains information about where the report group test results are
 exported.
 








Class com.amazonaws.services.codebuild.model.CreateReportGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reportGroup
ReportGroup reportGroup

 Information about the report group that was created.
 








Class com.amazonaws.services.codebuild.model.CreateWebhookRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the AWS CodeBuild project.
 


branchFilter
String branchFilter

 A regular expression used to determine which repository branches are built when a webhook is triggered. If the
 name of a branch matches the regular expression, then it is built. If branchFilter is empty, then
 all branches are built.
 
 
 
 It is recommended that you use filterGroups instead of branchFilter.
 
 


filterGroups
List<E> filterGroups

 An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least
 one WebhookFilter in the array must specify EVENT as its type.
 
 
 For a build to be triggered, at least one filter group in the filterGroups array must pass. For a
 filter group to pass, each of its filters must pass.
 








Class com.amazonaws.services.codebuild.model.CreateWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


webhook
Webhook webhook

 Information about a webhook that connects repository events to a build project in AWS CodeBuild.
 








Class com.amazonaws.services.codebuild.model.DeleteProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the build project.
 








Class com.amazonaws.services.codebuild.model.DeleteProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codebuild.model.DeleteReportGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The ARN of the report group to delete.
 








Class com.amazonaws.services.codebuild.model.DeleteReportGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codebuild.model.DeleteReportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The ARN of the report to delete.
 








Class com.amazonaws.services.codebuild.model.DeleteReportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codebuild.model.DeleteResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource that is associated with the resource policy.
 








Class com.amazonaws.services.codebuild.model.DeleteResourcePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codebuild.model.DeleteSourceCredentialsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the token.
 








Class com.amazonaws.services.codebuild.model.DeleteSourceCredentialsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the token.
 








Class com.amazonaws.services.codebuild.model.DeleteWebhookRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the AWS CodeBuild project.
 








Class com.amazonaws.services.codebuild.model.DeleteWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codebuild.model.DescribeTestCasesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reportArn
String reportArn

 The ARN of the report for which test cases are returned.
 


nextToken
String nextToken

 During a previous call, the maximum number of items that can be returned is the value specified in
 maxResults. If there more items in the list, then a unique string called a nextToken is
 returned. To get the next batch of items in the list, call this operation again, adding the next token to the
 call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
 returned, until no more next tokens are returned.
 


maxResults
Integer maxResults

 The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in
 the list of returned TestCase objects. The default value is 100.
 


filter
TestCaseFilter filter

 A TestCaseFilter object used to filter the returned reports.
 








Class com.amazonaws.services.codebuild.model.DescribeTestCasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 During a previous call, the maximum number of items that can be returned is the value specified in
 maxResults. If there more items in the list, then a unique string called a nextToken is
 returned. To get the next batch of items in the list, call this operation again, adding the next token to the
 call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
 returned, until no more next tokens are returned.
 


testCases
List<E> testCases

 The returned list of test cases.
 








Class com.amazonaws.services.codebuild.model.EnvironmentImage extends Object implements Serializable


Serialized Fields


name
String name

 The name of the Docker image.
 


description
String description

 The description of the Docker image.
 


versions
List<E> versions

 A list of environment image versions.
 








Class com.amazonaws.services.codebuild.model.EnvironmentLanguage extends Object implements Serializable


Serialized Fields


language
String language

 The programming language for the Docker images.
 


images
List<E> images

 The list of Docker images that are related by the specified programming language.
 








Class com.amazonaws.services.codebuild.model.EnvironmentPlatform extends Object implements Serializable


Serialized Fields


platform
String platform

 The platform's name.
 


languages
List<E> languages

 The list of programming languages that are available for the specified platform.
 








Class com.amazonaws.services.codebuild.model.EnvironmentVariable extends Object implements Serializable


Serialized Fields


name
String name

 The name or key of the environment variable.
 


value
String value

 The value of the environment variable.
 
 
 
 We strongly discourage the use of environment variables to store sensitive values, especially AWS secret key IDs
 and secret access keys. Environment variables can be displayed in plain text using the AWS CodeBuild console and
 the AWS Command Line Interface (AWS CLI).
 
 


type
String type

 The type of environment variable. Valid values include:
 
 
 
 
 PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store.
 
 
 
 
 PLAINTEXT: An environment variable in plain text format. This is the default value.
 
 
 
 
 SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager.
 
 
 








Class com.amazonaws.services.codebuild.model.ExportedEnvironmentVariable extends Object implements Serializable


Serialized Fields


name
String name

 The name of this exported environment variable.
 


value
String value

 The value assigned to this exported environment variable.
 
 
 
 During a build, the value of a variable is available starting with the install phase. It can be
 updated between the start of the install phase and the end of the post_build phase.
 After the post_build phase ends, the value of exported variables cannot change.
 
 








Class com.amazonaws.services.codebuild.model.GetResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource that is associated with the resource policy.
 








Class com.amazonaws.services.codebuild.model.GetResourcePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
String policy

 The resource policy for the resource identified by the input ARN parameter.
 








Class com.amazonaws.services.codebuild.model.GitSubmodulesConfig extends Object implements Serializable


Serialized Fields


fetchSubmodules
Boolean fetchSubmodules

 Set to true to fetch Git submodules for your AWS CodeBuild build project.
 








Class com.amazonaws.services.codebuild.model.ImportSourceCredentialsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


username
String username

 The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types
 of source providers or connections.
 


token
String token

 For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.
 


serverType
String serverType

 The source provider used for this project.
 


authType
String authType

 The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH
 connection is not supported by the API and must be created using the AWS CodeBuild console.
 


shouldOverwrite
Boolean shouldOverwrite

 Set to false to prevent overwriting the repository source credentials. Set to true to
 overwrite the repository source credentials. The default value is true.
 








Class com.amazonaws.services.codebuild.model.ImportSourceCredentialsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the token.
 








Class com.amazonaws.services.codebuild.model.InvalidateProjectCacheRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the AWS CodeBuild build project that the cache is reset for.
 








Class com.amazonaws.services.codebuild.model.InvalidateProjectCacheResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codebuild.model.InvalidInputException extends AWSCodeBuildException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codebuild.model.ListBuildsForProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the AWS CodeBuild project.
 


sortOrder
String sortOrder

 The order to list build IDs. Valid values include:
 
 
 
 
 ASCENDING: List the build IDs in ascending order by build ID.
 
 
 
 
 DESCENDING: List the build IDs in descending order by build ID.
 
 
 


nextToken
String nextToken

 During a previous call, if there are more than 100 items in the list, only the first 100 items are returned,
 along with a unique string called a nextToken. To get the next batch of items in the list, call this
 operation again, adding the next token to the call. To get all of the items in the list, keep calling this
 operation with each subsequent next token that is returned, until no more next tokens are returned.
 








Class com.amazonaws.services.codebuild.model.ListBuildsForProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ids
List<E> ids

 A list of build IDs for the specified build project, with each build ID representing a single build.
 


nextToken
String nextToken

 If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string
 called a nextToken. To get the next batch of items in the list, call this operation again, adding the next
 token to the call.
 








Class com.amazonaws.services.codebuild.model.ListBuildsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sortOrder
String sortOrder

 The order to list build IDs. Valid values include:
 
 
 
 
 ASCENDING: List the build IDs in ascending order by build ID.
 
 
 
 
 DESCENDING: List the build IDs in descending order by build ID.
 
 
 


nextToken
String nextToken

 During a previous call, if there are more than 100 items in the list, only the first 100 items are returned,
 along with a unique string called a nextToken. To get the next batch of items in the list, call this
 operation again, adding the next token to the call. To get all of the items in the list, keep calling this
 operation with each subsequent next token that is returned, until no more next tokens are returned.
 








Class com.amazonaws.services.codebuild.model.ListBuildsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ids
List<E> ids

 A list of build IDs, with each build ID representing a single build.
 


nextToken
String nextToken

 If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string
 called a nextToken. To get the next batch of items in the list, call this operation again, adding the next
 token to the call.
 








Class com.amazonaws.services.codebuild.model.ListCuratedEnvironmentImagesRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.codebuild.model.ListCuratedEnvironmentImagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


platforms
List<E> platforms

 Information about supported platforms for Docker images that are managed by AWS CodeBuild.
 








Class com.amazonaws.services.codebuild.model.ListProjectsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sortBy
String sortBy

 The criterion to be used to list build project names. Valid values include:
 
 
 
 
 CREATED_TIME: List based on when each build project was created.
 
 
 
 
 LAST_MODIFIED_TIME: List based on when information about each build project was last changed.
 
 
 
 
 NAME: List based on each build project's name.
 
 
 
 
 Use sortOrder to specify in what order to list the build project names based on the preceding
 criteria.
 


sortOrder
String sortOrder

 The order in which to list build projects. Valid values include:
 
 
 
 
 ASCENDING: List in ascending order.
 
 
 
 
 DESCENDING: List in descending order.
 
 
 
 
 Use sortBy to specify the criterion to be used to list build project names.
 


nextToken
String nextToken

 During a previous call, if there are more than 100 items in the list, only the first 100 items are returned,
 along with a unique string called a nextToken. To get the next batch of items in the list, call this
 operation again, adding the next token to the call. To get all of the items in the list, keep calling this
 operation with each subsequent next token that is returned, until no more next tokens are returned.
 








Class com.amazonaws.services.codebuild.model.ListProjectsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string
 called a nextToken. To get the next batch of items in the list, call this operation again, adding the next
 token to the call.
 


projects
List<E> projects

 The list of build project names, with each build project name representing a single build project.
 








Class com.amazonaws.services.codebuild.model.ListReportGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sortOrder
String sortOrder

 Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and
 DESCENDING.
 


sortBy
String sortBy

 The criterion to be used to list build report groups. Valid values include:
 
 
 
 
 CREATED_TIME: List based on when each report group was created.
 
 
 
 
 LAST_MODIFIED_TIME: List based on when each report group was last changed.
 
 
 
 
 NAME: List based on each report group's name.
 
 
 


nextToken
String nextToken

 During a previous call, the maximum number of items that can be returned is the value specified in
 maxResults. If there more items in the list, then a unique string called a nextToken is
 returned. To get the next batch of items in the list, call this operation again, adding the next token to the
 call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
 returned, until no more next tokens are returned.
 


maxResults
Integer maxResults

 The maximum number of paginated report groups returned per response. Use nextToken to iterate pages
 in the list of returned ReportGroup objects. The default value is 100.
 








Class com.amazonaws.services.codebuild.model.ListReportGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 During a previous call, the maximum number of items that can be returned is the value specified in
 maxResults. If there more items in the list, then a unique string called a nextToken is
 returned. To get the next batch of items in the list, call this operation again, adding the next token to the
 call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
 returned, until no more next tokens are returned.
 


reportGroups
List<E> reportGroups

 The list of ARNs for the report groups in the current AWS account.
 








Class com.amazonaws.services.codebuild.model.ListReportsForReportGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reportGroupArn
String reportGroupArn

 The ARN of the report group for which you want to return report ARNs.
 


nextToken
String nextToken

 During a previous call, the maximum number of items that can be returned is the value specified in
 maxResults. If there more items in the list, then a unique string called a nextToken is
 returned. To get the next batch of items in the list, call this operation again, adding the next token to the
 call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
 returned, until no more next tokens are returned.
 


sortOrder
String sortOrder

 Use to specify whether the results are returned in ascending or descending order.
 


maxResults
Integer maxResults

 The maximum number of paginated reports in this report group returned per response. Use nextToken to
 iterate pages in the list of returned Report objects. The default value is 100.
 


filter
ReportFilter filter

 A ReportFilter object used to filter the returned reports.
 








Class com.amazonaws.services.codebuild.model.ListReportsForReportGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 During a previous call, the maximum number of items that can be returned is the value specified in
 maxResults. If there more items in the list, then a unique string called a nextToken is
 returned. To get the next batch of items in the list, call this operation again, adding the next token to the
 call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
 returned, until no more next tokens are returned.
 


reports
List<E> reports

 The list of returned report group ARNs.
 








Class com.amazonaws.services.codebuild.model.ListReportsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sortOrder
String sortOrder

 Specifies the sort order for the list of returned reports. Valid values are:
 
 
 
 
 ASCENDING: return reports in chronological order based on their creation date.
 
 
 
 
 DESCENDING: return reports in the reverse chronological order based on their creation date.
 
 
 


nextToken
String nextToken

 During a previous call, the maximum number of items that can be returned is the value specified in
 maxResults. If there more items in the list, then a unique string called a nextToken is
 returned. To get the next batch of items in the list, call this operation again, adding the next token to the
 call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
 returned, until no more next tokens are returned.
 


maxResults
Integer maxResults

 The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the
 list of returned Report objects. The default value is 100.
 


filter
ReportFilter filter

 A ReportFilter object used to filter the returned reports.
 








Class com.amazonaws.services.codebuild.model.ListReportsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 During a previous call, the maximum number of items that can be returned is the value specified in
 maxResults. If there more items in the list, then a unique string called a nextToken is
 returned. To get the next batch of items in the list, call this operation again, adding the next token to the
 call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
 returned, until no more next tokens are returned.
 


reports
List<E> reports

 The list of returned ARNs for the reports in the current AWS account.
 








Class com.amazonaws.services.codebuild.model.ListSharedProjectsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sortBy
String sortBy

 The criterion to be used to list build projects shared with the current AWS account or user. Valid values
 include:
 
 
 
 
 ARN: List based on the ARN.
 
 
 
 
 MODIFIED_TIME: List based on when information about the shared project was last changed.
 
 
 


sortOrder
String sortOrder

 The order in which to list shared build projects. Valid values include:
 
 
 
 
 ASCENDING: List in ascending order.
 
 
 
 
 DESCENDING: List in descending order.
 
 
 


maxResults
Integer maxResults

 The maximum number of paginated shared build projects returned per response. Use nextToken to
 iterate pages in the list of returned Project objects. The default value is 100.
 


nextToken
String nextToken

 During a previous call, the maximum number of items that can be returned is the value specified in
 maxResults. If there more items in the list, then a unique string called a nextToken is
 returned. To get the next batch of items in the list, call this operation again, adding the next token to the
 call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
 returned, until no more next tokens are returned.
 








Class com.amazonaws.services.codebuild.model.ListSharedProjectsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 During a previous call, the maximum number of items that can be returned is the value specified in
 maxResults. If there more items in the list, then a unique string called a nextToken is
 returned. To get the next batch of items in the list, call this operation again, adding the next token to the
 call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
 returned, until no more next tokens are returned.
 


projects
List<E> projects

 The list of ARNs for the build projects shared with the current AWS account or user.
 








Class com.amazonaws.services.codebuild.model.ListSharedReportGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sortOrder
String sortOrder

 The order in which to list shared report groups. Valid values include:
 
 
 
 
 ASCENDING: List in ascending order.
 
 
 
 
 DESCENDING: List in descending order.
 
 
 


sortBy
String sortBy

 The criterion to be used to list report groups shared with the current AWS account or user. Valid values include:
 
 
 
 
 ARN: List based on the ARN.
 
 
 
 
 MODIFIED_TIME: List based on when information about the shared report group was last changed.
 
 
 


nextToken
String nextToken

 During a previous call, the maximum number of items that can be returned is the value specified in
 maxResults. If there more items in the list, then a unique string called a nextToken is
 returned. To get the next batch of items in the list, call this operation again, adding the next token to the
 call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
 returned, until no more next tokens are returned.
 


maxResults
Integer maxResults

 The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in
 the list of returned ReportGroup objects. The default value is 100.
 








Class com.amazonaws.services.codebuild.model.ListSharedReportGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 During a previous call, the maximum number of items that can be returned is the value specified in
 maxResults. If there more items in the list, then a unique string called a nextToken is
 returned. To get the next batch of items in the list, call this operation again, adding the next token to the
 call. To get all of the items in the list, keep calling this operation with each subsequent next token that is
 returned, until no more next tokens are returned.
 


reportGroups
List<E> reportGroups

 The list of ARNs for the report groups shared with the current AWS account or user.
 








Class com.amazonaws.services.codebuild.model.ListSourceCredentialsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.codebuild.model.ListSourceCredentialsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sourceCredentialsInfos
List<E> sourceCredentialsInfos

 A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the
 authentication type, token ARN, and type of source provider for one set of credentials.
 








Class com.amazonaws.services.codebuild.model.LogsConfig extends Object implements Serializable


Serialized Fields


cloudWatchLogs
CloudWatchLogsConfig cloudWatchLogs

 Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default.
 


s3Logs
S3LogsConfig s3Logs

 Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
 








Class com.amazonaws.services.codebuild.model.LogsLocation extends Object implements Serializable


Serialized Fields


groupName
String groupName

 The name of the Amazon CloudWatch Logs group for the build logs.
 


streamName
String streamName

 The name of the Amazon CloudWatch Logs stream for the build logs.
 


deepLink
String deepLink

 The URL to an individual build log in Amazon CloudWatch Logs.
 


s3DeepLink
String s3DeepLink

 The URL to a build log in an S3 bucket.
 


cloudWatchLogsArn
String cloudWatchLogsArn

 The ARN of Amazon CloudWatch Logs for a build project. Its format is
 arn:${Partition}:logs:${Region}:${Account}:log-group:${LogGroupName}:log-stream:${LogStreamName}.
 For more information, see Resources Defined by Amazon CloudWatch Logs.
 


s3LogsArn
String s3LogsArn

 The ARN of S3 logs for a build project. Its format is
 arn:${Partition}:s3:::${BucketName}/${ObjectName}. For more information, see Resources Defined by Amazon S3.
 


cloudWatchLogs
CloudWatchLogsConfig cloudWatchLogs

 Information about Amazon CloudWatch Logs for a build project.
 


s3Logs
S3LogsConfig s3Logs

 Information about S3 logs for a build project.
 








Class com.amazonaws.services.codebuild.model.NetworkInterface extends Object implements Serializable


Serialized Fields


subnetId
String subnetId

 The ID of the subnet.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 








Class com.amazonaws.services.codebuild.model.OAuthProviderException extends AWSCodeBuildException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codebuild.model.PhaseContext extends Object implements Serializable


Serialized Fields


statusCode
String statusCode

 The status code for the context of the build phase.
 


message
String message

 An explanation of the build phase's context. This might include a command ID and an exit code.
 








Class com.amazonaws.services.codebuild.model.Project extends Object implements Serializable


Serialized Fields


name
String name

 The name of the build project.
 


arn
String arn

 The Amazon Resource Name (ARN) of the build project.
 


description
String description

 A description that makes the build project easy to identify.
 


source
ProjectSource source

 Information about the build input source code for this build project.
 


secondarySources
List<E> secondarySources

 An array of ProjectSource objects.
 


sourceVersion
String sourceVersion

 A version of the build input to be built for this project. If not specified, the latest version is used. If
 specified, it must be one of:
 
 
 
 
 For AWS CodeCommit: the commit ID, branch, or Git tag to use.
 
 
 
 
 For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the
 source code you want to build. If a pull request ID is specified, it must use the format
 pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's
 HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
 
 
 
 
 For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you
 want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default
 branch's HEAD commit ID is used.
 
 
 
 
 For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP
 file to use.
 
 
 
 
 If sourceVersion is specified at the build level, then that version takes precedence over this
 sourceVersion (at the project level).
 
 
 For more information, see Source Version Sample
 with CodeBuild in the AWS CodeBuild User Guide.
 


secondarySourceVersions
List<E> secondarySourceVersions

 An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at
 the build level, then they take over these secondarySourceVersions (at the project level).
 


artifacts
ProjectArtifacts artifacts

 Information about the build output artifacts for the build project.
 


secondaryArtifacts
List<E> secondaryArtifacts

 An array of ProjectArtifacts objects.
 


cache
ProjectCache cache

 Information about the cache for the build project.
 


environment
ProjectEnvironment environment

 Information about the build environment for this build project.
 


serviceRole
String serviceRole

 The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with
 dependent AWS services on behalf of the AWS account.
 


timeoutInMinutes
Integer timeoutInMinutes

 How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that
 did not get marked as completed. The default is 60 minutes.
 


queuedTimeoutInMinutes
Integer queuedTimeoutInMinutes

 The number of minutes a build is allowed to be queued before it times out.
 


encryptionKey
String encryptionKey

 The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output
 artifacts.
 
 
 
 You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to
 that key.
 
 
 
 You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the
 format alias/alias-name ).
 


tags
List<E> tags

 The tags for this build project.
 
 
 These tags are available for use by AWS services that support AWS CodeBuild build project tags.
 


created
Date created

 When the build project was created, expressed in Unix time format.
 


lastModified
Date lastModified

 When the build project's settings were last modified, expressed in Unix time format.
 


webhook
Webhook webhook

 Information about a webhook that connects repository events to a build project in AWS CodeBuild.
 


vpcConfig
VpcConfig vpcConfig

 Information about the VPC configuration that AWS CodeBuild accesses.
 


badge
ProjectBadge badge

 Information about the build badge for the build project.
 


logsConfig
LogsConfig logsConfig

 Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket,
 or both.
 








Class com.amazonaws.services.codebuild.model.ProjectArtifacts extends Object implements Serializable


Serialized Fields


type
String type

 The type of build output artifact. Valid values include:
 
 
 
 
 CODEPIPELINE: The build project has build output generated through AWS CodePipeline.
 
 
 
 The CODEPIPELINE type is not supported for secondaryArtifacts.
 
 
 
 
 NO_ARTIFACTS: The build project does not produce any build output.
 
 
 
 
 S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3).
 
 
 


location
String location

 Information about the build output artifact location:
 
 
 
 
 If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This
 is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.
 
 
 
 
 If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build
 output is produced.
 
 
 
 
 If type is set to S3, this is the name of the output bucket.
 
 
 


path
String path

 Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and
 store the output artifact:
 
 
 
 
 If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This
 is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
 
 
 
 
 If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build
 output is produced.
 
 
 
 
 If type is set to S3, this is the path to the output artifact. If path is
 not specified, path is not used.
 
 
 
 
 For example, if path is set to MyArtifacts, namespaceType is set to
 NONE, and name is set to MyArtifact.zip, the output artifact is stored in
 the output bucket at MyArtifacts/MyArtifact.zip.
 


namespaceType
String namespaceType

 Along with path and name, the pattern that AWS CodeBuild uses to determine the name and
 location to store the output artifact:
 
 
 
 
 If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This
 is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
 
 
 
 
 If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build
 output is produced.
 
 
 
 
 If type is set to S3, valid values include:
 
 
 
 
 BUILD_ID: Include the build ID in the location of the build output artifact.
 
 
 
 
 NONE: Do not include the build ID. This is the default if namespaceType is not
 specified.
 
 
 
 
 
 
 For example, if path is set to MyArtifacts, namespaceType is set to
 BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored
 in MyArtifacts/build-ID/MyArtifact.zip.
 


name
String name

 Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and
 store the output artifact:
 
 
 
 
 If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This
 is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.
 
 
 
 
 If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build
 output is produced.
 
 
 
 
 If type is set to S3, this is the name of the output artifact object. If you set the
 name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
 
 
 
 
 For example:
 
 
 
 
 If path is set to MyArtifacts, namespaceType is set to
 BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is
 stored in MyArtifacts/build-ID/MyArtifact.zip.
 
 
 
 
 If path is empty, namespaceType is set to NONE, and name is
 set to "/", the output artifact is stored in the root of the output bucket.
 
 
 
 
 If path is set to MyArtifacts, namespaceType is set to
 BUILD_ID, and name is set to "/", the output artifact is stored in
 MyArtifacts/build-ID .
 
 
 


packaging
String packaging

 The type of build output artifact to create:
 
 
 
 
 If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This
 is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.
 
 
 
 
 If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build
 output is produced.
 
 
 
 
 If type is set to S3, valid values include:
 
 
 
 
 NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is
 the default if packaging is not specified.
 
 
 
 
 ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
 
 
 
 
 


overrideArtifactName
Boolean overrideArtifactName

 If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a
 build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a
 date and time to your artifact name so that it is always unique.
 


encryptionDisabled
Boolean encryptionDisabled

 Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type
 is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an
 invalidInputException is thrown.
 


artifactIdentifier
String artifactIdentifier

 An identifier for this artifact definition.
 








Class com.amazonaws.services.codebuild.model.ProjectBadge extends Object implements Serializable


Serialized Fields


badgeEnabled
Boolean badgeEnabled

 Set this to true to generate a publicly accessible URL for your project's build badge.
 


badgeRequestUrl
String badgeRequestUrl

 The publicly-accessible URL through which you can access the build badge for your project.
 
 
 The publicly accessible URL through which you can access the build badge for your project.
 








Class com.amazonaws.services.codebuild.model.ProjectCache extends Object implements Serializable


Serialized Fields


type
String type

 The type of cache used by the build project. Valid values include:
 
 
 
 
 NO_CACHE: The build project does not use any cache.
 
 
 
 
 S3: The build project reads and writes from and to S3.
 
 
 
 
 LOCAL: The build project stores a cache locally on a build host that is only available to that build
 host.
 
 
 


location
String location

 Information about the cache location:
 
 
 
 
 NO_CACHE or LOCAL: This value is ignored.
 
 
 
 
 S3: This is the S3 bucket name/prefix.
 
 
 


modes
List<E> modes

 If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the
 same time.
 
 
 
 
 LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is
 created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a
 clean working directory and a source that is a large Git repository. If you choose this option and your project
 does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.
 
 
 
 
 LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects
 that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker
 images down from the network.
 
 
 
 
 
 You can use a Docker layer cache in the Linux environment only.
 
 
 
 
 The privileged flag must be set so that your project has the required Docker permissions.
 
 
 
 
 You should consider the security implications before you use a Docker layer cache.
 
 
 
 
 
 
 
 
 LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good
 choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom
 cache:
 
 
 
 
 Only directories can be specified for caching. You cannot specify individual files.
 
 
 
 
 Symlinks are used to reference cached directories.
 
 
 
 
 Cached directories are linked to your build before it downloads its project sources. Cached items are overridden
 if a source item has the same name. Directories are specified using cache paths in the buildspec file.
 
 
 
 
 








Class com.amazonaws.services.codebuild.model.ProjectEnvironment extends Object implements Serializable


Serialized Fields


type
String type

 The type of build environment to use for related builds.
 
 
 
 
 The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East
 (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and
 EU (Frankfurt).
 
 
 
 
 The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is
 available only in regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), EU
 (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore),
 Asia Pacific (Sydney), China (Beijing), and China (Ningxia).
 
 
 
 
 The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East
 (N. Virginia), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific
 (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China
 (Ningxia).
 
 
 


image
String image

 The image tag or image digest that identifies the Docker image to use for this build project. Use the following
 formats:
 
 
 
 
 For an image tag: registry/repository:tag. For example, to specify an image with the tag "latest,"
 use registry/repository:latest.
 
 
 
 
 For an image digest: registry/repository@digest. For example, to specify an image with the digest
 "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use
 registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.
 
 
 


computeType
String computeType

 Information about the compute resources the build project uses. Available values include:
 
 
 
 
 BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.
 
 
 
 
 BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.
 
 
 
 
 BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment
 type.
 
 
 
 
 BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds.
 This compute type supports Docker images up to 100 GB uncompressed.
 
 
 
 
 If you use BUILD_GENERAL1_LARGE:
 
 
 
 
 For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.
 
 
 
 
 For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA
 Tesla V100 GPUs for builds.
 
 
 
 
 For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based
 processors for builds.
 
 
 
 
 For more information, see Build Environment
 Compute Types in the AWS CodeBuild User Guide.
 


environmentVariables
List<E> environmentVariables

 A set of environment variables to make available to builds for this build project.
 


privilegedMode
Boolean privilegedMode

 Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to
 build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default
 setting is false.
 
 
 You can initialize the Docker daemon during the install phase of your build by adding one of the following sets
 of commands to the install phase of your buildspec file:
 
 
 If the operating system's base image is Ubuntu Linux:
 
 
 - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
 
 
 - timeout 15 sh -c "until docker info; do echo .; sleep 1; done"
 
 
 If the operating system's base image is Alpine Linux and the previous command does not work, add the
 -t argument to timeout:
 
 
 - nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
 
 
 - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"
 


certificate
String certificate

 The certificate to use with this build project.
 


registryCredential
RegistryCredential registryCredential

 The credentials for access to a private registry.
 


imagePullCredentialsType
String imagePullCredentialsType

 The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
 
 
 
 
 CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your
 ECR repository policy to trust AWS CodeBuild's service principal.
 
 
 
 
 SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.
 
 
 
 
 When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an
 AWS CodeBuild curated image, you must use CODEBUILD credentials.
 








Class com.amazonaws.services.codebuild.model.ProjectSource extends Object implements Serializable


Serialized Fields


type
String type

 The type of repository that contains the source code to be built. Valid values include:
 
 
 
 
 BITBUCKET: The source code is in a Bitbucket repository.
 
 
 
 
 CODECOMMIT: The source code is in an AWS CodeCommit repository.
 
 
 
 
 CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS
 CodePipeline.
 
 
 
 
 GITHUB: The source code is in a GitHub repository.
 
 
 
 
 GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise repository.
 
 
 
 
 NO_SOURCE: The project does not have input source code.
 
 
 
 
 S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
 
 
 


location
String location

 Information about the location of the source code to be built. Valid values include:
 
 
 
 
 For source code settings that are specified in the source action of a pipeline in AWS CodePipeline,
 location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because
 AWS CodePipeline uses the settings in a pipeline's source action instead of this value.
 
 
 
 
 For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source
 code and the build spec (for example,
 https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).
 
 
 
 
 For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following.
 
 
 
 
 The path to the ZIP file that contains the source code (for example,
  bucket-name/path/to/object-name.zip).
 
 
 
 
 The path to the folder that contains the source code (for example,
  bucket-name/path/to/source-code/folder/).
 
 
 
 
 
 
 For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the
 build spec. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start
 creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub
 Authorize application page, for Organization access, choose Request access next to each
 repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application.
 (After you have connected to your GitHub account, you do not need to finish creating the build project. You can
 leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source
 object, set the auth object's type value to OAUTH.
 
 
 
 
 For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the
 build spec. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start
 creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket
 Confirm access to your account page, choose Grant access. (After you have connected to your
 Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild
 console.) To instruct AWS CodeBuild to use this connection, in the source object, set the
 auth object's type value to OAUTH.
 
 
 


gitCloneDepth
Integer gitCloneDepth

 Information about the Git clone depth for the build project.
 


gitSubmodulesConfig
GitSubmodulesConfig gitSubmodulesConfig

 Information about the Git submodules configuration for the build project.
 


buildspec
String buildspec

 The build spec declaration to use for the builds in this build project.
 
 
 If this value is not specified, a build spec must be included along with the source code to be built.
 


auth
SourceAuth auth

 Information about the authorization settings for AWS CodeBuild to access the source code to be built.
 
 
 This information is for the AWS CodeBuild console's use only. Your code should not get or set this information
 directly.
 


reportBuildStatus
Boolean reportBuildStatus

 Set to true to report the status of a build's start and finish to your source provider. This option is valid only
 when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different
 source provider, an invalidInputException is thrown.
 
 
 
 The status of a build triggered by a webhook is always reported to your source provider.
 
 


insecureSsl
Boolean insecureSsl

 Enable this flag to ignore SSL warnings while connecting to the project source code.
 


sourceIdentifier
String sourceIdentifier

 An identifier for this project source.
 








Class com.amazonaws.services.codebuild.model.ProjectSourceVersion extends Object implements Serializable


Serialized Fields


sourceIdentifier
String sourceIdentifier

 An identifier for a source in the build project.
 


sourceVersion
String sourceVersion

 The source version for the corresponding source identifier. If specified, must be one of:
 
 
 
 
 For AWS CodeCommit: the commit ID, branch, or Git tag to use.
 
 
 
 
 For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the
 source code you want to build. If a pull request ID is specified, it must use the format
 pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's
 HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
 
 
 
 
 For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you
 want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default
 branch's HEAD commit ID is used.
 
 
 
 
 For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP
 file to use.
 
 
 
 
 For more information, see Source Version Sample
 with CodeBuild in the AWS CodeBuild User Guide.
 








Class com.amazonaws.services.codebuild.model.PutResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policy
String policy

 A JSON-formatted resource policy. For more information, see Sharing
 a Project and Sharing a Report Group in the AWS CodeBuild User Guide.
 


resourceArn
String resourceArn

 The ARN of the Project or ReportGroup resource you want to associate with a resource
 policy.
 








Class com.amazonaws.services.codebuild.model.PutResourcePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the Project or ReportGroup resource that is associated with a resource
 policy.
 








Class com.amazonaws.services.codebuild.model.RegistryCredential extends Object implements Serializable


Serialized Fields


credential
String credential

 The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.
 
 
 
 The credential can use the name of the credentials only if they exist in your current region.
 
 


credentialProvider
String credentialProvider

 The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER,
 is for AWS Secrets Manager.
 








Class com.amazonaws.services.codebuild.model.Report extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the report run.
 


type
String type

 The type of the report that was run.
 


name
String name

 The name of the report that was run.
 


reportGroupArn
String reportGroupArn

 The ARN of the report group associated with this report.
 


executionId
String executionId

 The ARN of the build run that generated this report.
 


status
String status

 The status of this report.
 


created
Date created

 The date and time this report run occurred.
 


expired
Date expired

 The date and time a report expires. A report expires 30 days after it is created. An expired report is not
 available to view in CodeBuild.
 


exportConfig
ReportExportConfig exportConfig

 Information about where the raw data used to generate this report was exported.
 


truncated
Boolean truncated

 A boolean that specifies if this report run is truncated. The list of test cases is truncated after the maximum
 number of test cases is reached.
 


testSummary
TestReportSummary testSummary

 A TestReportSummary object that contains information about this test report.
 








Class com.amazonaws.services.codebuild.model.ReportExportConfig extends Object implements Serializable


Serialized Fields


exportConfigType
String exportConfigType

 The export configuration type. Valid values are:
 
 
 
 
 S3: The report results are exported to an S3 bucket.
 
 
 
 
 NO_EXPORT: The report results are not exported.
 
 
 


s3Destination
S3ReportExportConfig s3Destination

 A S3ReportExportConfig object that contains information about the S3 bucket where the run of a
 report is exported.
 








Class com.amazonaws.services.codebuild.model.ReportFilter extends Object implements Serializable


Serialized Fields


status
String status

 The status used to filter reports. You can filter using one status only.
 








Class com.amazonaws.services.codebuild.model.ReportGroup extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of a ReportGroup.
 


name
String name

 The name of a ReportGroup.
 


type
String type

 The type of the ReportGroup. The one valid value is TEST.
 


exportConfig
ReportExportConfig exportConfig

 Information about the destination where the raw data of this ReportGroup is exported.
 


created
Date created

 The date and time this ReportGroup was created.
 


lastModified
Date lastModified

 The date and time this ReportGroup was last modified.
 








Class com.amazonaws.services.codebuild.model.ResourceAlreadyExistsException extends AWSCodeBuildException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codebuild.model.ResourceNotFoundException extends AWSCodeBuildException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codebuild.model.S3LogsConfig extends Object implements Serializable


Serialized Fields


status
String status

 The current status of the S3 build logs. Valid values are:
 
 
 
 
 ENABLED: S3 build logs are enabled for this build project.
 
 
 
 
 DISABLED: S3 build logs are not enabled for this build project.
 
 
 


location
String location

 The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket,
 and your path prefix is build-log, then acceptable formats are my-bucket/build-log or
 arn:aws:s3:::my-bucket/build-log.
 


encryptionDisabled
Boolean encryptionDisabled

 Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.
 








Class com.amazonaws.services.codebuild.model.S3ReportExportConfig extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The name of the S3 bucket where the raw data of a report are exported.
 


path
String path

 The path to the exported report's raw data results.
 


packaging
String packaging

 The type of build output artifact to create. Valid values include:
 
 
 
 
 NONE: AWS CodeBuild creates the raw data in the output bucket. This is the default if packaging is
 not specified.
 
 
 
 
 ZIP: AWS CodeBuild creates a ZIP file with the raw data in the output bucket.
 
 
 


encryptionKey
String encryptionKey

 The encryption key for the report's encrypted raw data.
 


encryptionDisabled
Boolean encryptionDisabled

 A boolean value that specifies if the results of a report are encrypted.
 








Class com.amazonaws.services.codebuild.model.SourceAuth extends Object implements Serializable


Serialized Fields


type
String type

 
 This data type is deprecated and is no longer accurate or used.
 
 
 
 The authorization type to use. The only valid value is OAUTH, which represents the OAuth
 authorization type.
 


resource
String resource

 The resource value that applies to the specified authorization type.
 








Class com.amazonaws.services.codebuild.model.SourceCredentialsInfo extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the token.
 


serverType
String serverType

 The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.
 


authType
String authType

 The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or
 PERSONAL_ACCESS_TOKEN.
 








Class com.amazonaws.services.codebuild.model.StartBuildRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the AWS CodeBuild build project to start running a build.
 


secondarySourcesOverride
List<E> secondarySourcesOverride

 An array of ProjectSource objects.
 


secondarySourcesVersionOverride
List<E> secondarySourcesVersionOverride

 An array of ProjectSourceVersion objects that specify one or more versions of the project's
 secondary sources to be used for this build only.
 


sourceVersion
String sourceVersion

 A version of the build input to be built, for this build only. If not specified, the latest version is used. If
 specified, must be one of:
 
 
 
 
 For AWS CodeCommit: the commit ID, branch, or Git tag to use.
 
 
 
 
 For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the
 source code you want to build. If a pull request ID is specified, it must use the format
 pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's
 HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
 
 
 
 
 For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you
 want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default
 branch's HEAD commit ID is used.
 
 
 
 
 For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP
 file to use.
 
 
 
 
 If sourceVersion is specified at the project level, then this sourceVersion (at the
 build level) takes precedence.
 
 
 For more information, see Source Version Sample
 with CodeBuild in the AWS CodeBuild User Guide.
 


artifactsOverride
ProjectArtifacts artifactsOverride

 Build output artifact settings that override, for this build only, the latest ones already defined in the build
 project.
 


secondaryArtifactsOverride
List<E> secondaryArtifactsOverride

 An array of ProjectArtifacts objects.
 


environmentVariablesOverride
List<E> environmentVariablesOverride

 A set of environment variables that overrides, for this build only, the latest ones already defined in the build
 project.
 


sourceTypeOverride
String sourceTypeOverride

 A source input type, for this build, that overrides the source input defined in the build project.
 


sourceLocationOverride
String sourceLocationOverride

 A location that overrides, for this build, the source location for the one defined in the build project.
 


sourceAuthOverride
SourceAuth sourceAuthOverride

 An authorization type for this build that overrides the one defined in the build project. This override applies
 only if the build project's source is BitBucket or GitHub.
 


gitCloneDepthOverride
Integer gitCloneDepthOverride

 The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous
 depth of history defined in the build project.
 


gitSubmodulesConfigOverride
GitSubmodulesConfig gitSubmodulesConfigOverride

 Information about the Git submodules configuration for this build of an AWS CodeBuild build project.
 


buildspecOverride
String buildspecOverride

 A build spec declaration that overrides, for this build only, the latest one already defined in the build
 project.
 


insecureSslOverride
Boolean insecureSslOverride

 Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL
 setting determines whether to ignore SSL warnings while connecting to the project source code. This override
 applies only if the build's source is GitHub Enterprise.
 


reportBuildStatusOverride
Boolean reportBuildStatusOverride

 Set to true to report to your source provider the status of a build's start and completion. If you use this
 option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is
 thrown.
 
 
 
 The status of a build triggered by a webhook is always reported to your source provider.
 
 


environmentTypeOverride
String environmentTypeOverride

 A container type for this build that overrides the one specified in the build project.
 


imageOverride
String imageOverride

 The name of an image for this build that overrides the one specified in the build project.
 


computeTypeOverride
String computeTypeOverride

 The name of a compute type for this build that overrides the one specified in the build project.
 


certificateOverride
String certificateOverride

 The name of a certificate for this build that overrides the one specified in the build project.
 


cacheOverride
ProjectCache cacheOverride

 A ProjectCache object specified for this build that overrides the one defined in the build project.
 


serviceRoleOverride
String serviceRoleOverride

 The name of a service role for this build that overrides the one specified in the build project.
 


privilegedModeOverride
Boolean privilegedModeOverride

 Enable this flag to override privileged mode in the build project.
 


timeoutInMinutesOverride
Integer timeoutInMinutesOverride

 The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest
 setting already defined in the build project.
 


queuedTimeoutInMinutesOverride
Integer queuedTimeoutInMinutesOverride

 The number of minutes a build is allowed to be queued before it times out.
 


encryptionKeyOverride
String encryptionKeyOverride

 The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build
 project. The CMK key encrypts the build output artifacts.
 
 
 
 You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to
 that key.
 
 
 
 You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the
 format alias/alias-name ).
 


idempotencyToken
String idempotencyToken

 A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is
 included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same
 token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.
 


logsConfigOverride
LogsConfig logsConfigOverride

 Log settings for this build that override the log settings defined in the build project.
 


registryCredentialOverride
RegistryCredential registryCredentialOverride

 The credentials for access to a private registry.
 


imagePullCredentialsTypeOverride
String imagePullCredentialsTypeOverride

 The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
 
 
 
 
 CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your
 ECR repository policy to trust AWS CodeBuild's service principal.
 
 
 
 
 SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.
 
 
 
 
 When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS
 CodeBuild curated image, you must use CODEBUILD credentials.
 








Class com.amazonaws.services.codebuild.model.StartBuildResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


build
Build build

 Information about the build to be run.
 








Class com.amazonaws.services.codebuild.model.StopBuildRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the build.
 








Class com.amazonaws.services.codebuild.model.StopBuildResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


build
Build build

 Information about the build.
 








Class com.amazonaws.services.codebuild.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The tag's key.
 


value
String value

 The tag's value.
 








Class com.amazonaws.services.codebuild.model.TestCase extends Object implements Serializable


Serialized Fields


reportArn
String reportArn

 The ARN of the report to which the test case belongs.
 


testRawDataPath
String testRawDataPath

 The path to the raw data file that contains the test result.
 


prefix
String prefix

 A string that is applied to a series of related test cases. CodeBuild generates the prefix. The prefix depends on
 the framework used to generate the tests.
 


name
String name

 The name of the test case.
 


status
String status

 The status returned by the test case after it was run. Valid statuses are SUCCEEDED,
 FAILED, ERROR, SKIPPED, and UNKNOWN.
 


durationInNanoSeconds
Long durationInNanoSeconds

 The number of nanoseconds it took to run this test case.
 


message
String message

 A message associated with a test case. For example, an error message or stack trace.
 


expired
Date expired

 The date and time a test case expires. A test case expires 30 days after it is created. An expired test case is
 not available to view in CodeBuild.
 








Class com.amazonaws.services.codebuild.model.TestCaseFilter extends Object implements Serializable


Serialized Fields


status
String status

 The status used to filter test cases. Valid statuses are SUCCEEDED, FAILED,
 ERROR, SKIPPED, and UNKNOWN. A TestCaseFilter can have one
 status.
 








Class com.amazonaws.services.codebuild.model.TestReportSummary extends Object implements Serializable


Serialized Fields


total
Integer total

 The number of test cases in this TestReportSummary. The total includes truncated test cases.
 


statusCounts
Map<K,V> statusCounts

 A map that contains the number of each type of status returned by the test results in this
 TestReportSummary.
 


durationInNanoSeconds
Long durationInNanoSeconds

 The number of nanoseconds it took to run all of the test cases in this report.
 








Class com.amazonaws.services.codebuild.model.UpdateProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the build project.
 
 
 
 You cannot change a build project's name.
 
 


description
String description

 A new or replacement description of the build project.
 


source
ProjectSource source

 Information to be changed about the build input source code for the build project.
 


secondarySources
List<E> secondarySources

 An array of ProjectSource objects.
 


sourceVersion
String sourceVersion

 A version of the build input to be built for this project. If not specified, the latest version is used. If
 specified, it must be one of:
 
 
 
 
 For AWS CodeCommit: the commit ID, branch, or Git tag to use.
 
 
 
 
 For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the
 source code you want to build. If a pull request ID is specified, it must use the format
 pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's
 HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
 
 
 
 
 For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you
 want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default
 branch's HEAD commit ID is used.
 
 
 
 
 For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP
 file to use.
 
 
 
 
 If sourceVersion is specified at the build level, then that version takes precedence over this
 sourceVersion (at the project level).
 
 
 For more information, see Source Version Sample
 with CodeBuild in the AWS CodeBuild User Guide.
 


secondarySourceVersions
List<E> secondarySourceVersions

 An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at
 the build level, then they take over these secondarySourceVersions (at the project level).
 


artifacts
ProjectArtifacts artifacts

 Information to be changed about the build output artifacts for the build project.
 


secondaryArtifacts
List<E> secondaryArtifacts

 An array of ProjectSource objects.
 


cache
ProjectCache cache

 Stores recently used information so that it can be quickly accessed at a later time.
 


environment
ProjectEnvironment environment

 Information to be changed about the build environment for the build project.
 


serviceRole
String serviceRole

 The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact
 with dependent AWS services on behalf of the AWS account.
 


timeoutInMinutes
Integer timeoutInMinutes

 The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any
 related build that did not get marked as completed.
 


queuedTimeoutInMinutes
Integer queuedTimeoutInMinutes

 The number of minutes a build is allowed to be queued before it times out.
 


encryptionKey
String encryptionKey

 The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output
 artifacts.
 
 
 
 You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to
 that key.
 
 
 
 You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the
 format alias/alias-name ).
 


tags
List<E> tags

 The replacement set of tags for this build project.
 
 
 These tags are available for use by AWS services that support AWS CodeBuild build project tags.
 


vpcConfig
VpcConfig vpcConfig

 VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.
 


badgeEnabled
Boolean badgeEnabled

 Set this to true to generate a publicly accessible URL for your project's build badge.
 


logsConfig
LogsConfig logsConfig

 Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, logs in an S3
 bucket, or both.
 








Class com.amazonaws.services.codebuild.model.UpdateProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


project
Project project

 Information about the build project that was changed.
 








Class com.amazonaws.services.codebuild.model.UpdateReportGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The ARN of the report group to update.
 


exportConfig
ReportExportConfig exportConfig

 Used to specify an updated export type. Valid values are:
 
 
 
 
 S3: The report results are exported to an S3 bucket.
 
 
 
 
 NO_EXPORT: The report results are not exported.
 
 
 








Class com.amazonaws.services.codebuild.model.UpdateReportGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reportGroup
ReportGroup reportGroup

 Information about the updated report group.
 








Class com.amazonaws.services.codebuild.model.UpdateWebhookRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the AWS CodeBuild project.
 


branchFilter
String branchFilter

 A regular expression used to determine which repository branches are built when a webhook is triggered. If the
 name of a branch matches the regular expression, then it is built. If branchFilter is empty, then
 all branches are built.
 
 
 
 It is recommended that you use filterGroups instead of branchFilter.
 
 


rotateSecret
Boolean rotateSecret

 A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you
 use Bitbucket for your repository, rotateSecret is ignored.
 


filterGroups
List<E> filterGroups

 An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a
 build. A filter group must contain at least one EVENT WebhookFilter.
 








Class com.amazonaws.services.codebuild.model.UpdateWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


webhook
Webhook webhook

 Information about a repository's webhook that is associated with a project in AWS CodeBuild.
 








Class com.amazonaws.services.codebuild.model.VpcConfig extends Object implements Serializable


Serialized Fields


vpcId
String vpcId

 The ID of the Amazon VPC.
 


subnets
List<E> subnets

 A list of one or more subnet IDs in your Amazon VPC.
 


securityGroupIds
List<E> securityGroupIds

 A list of one or more security groups IDs in your Amazon VPC.
 








Class com.amazonaws.services.codebuild.model.Webhook extends Object implements Serializable


Serialized Fields


url
String url

 The URL to the webhook.
 


payloadUrl
String payloadUrl

 The AWS CodeBuild endpoint where webhook events are sent.
 


secret
String secret

 The secret token of the associated repository.
 
 
 
 A Bitbucket webhook does not support secret.
 
 


branchFilter
String branchFilter

 A regular expression used to determine which repository branches are built when a webhook is triggered. If the
 name of a branch matches the regular expression, then it is built. If branchFilter is empty, then
 all branches are built.
 
 
 
 It is recommended that you use filterGroups instead of branchFilter.
 
 


filterGroups
List<E> filterGroups

 An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least
 one WebhookFilter in the array must specify EVENT as its type.
 
 
 For a build to be triggered, at least one filter group in the filterGroups array must pass. For a
 filter group to pass, each of its filters must pass.
 


lastModifiedSecret
Date lastModifiedSecret

 A timestamp that indicates the last time a repository's secret token was modified.
 








Class com.amazonaws.services.codebuild.model.WebhookFilter extends Object implements Serializable


Serialized Fields


type
String type

 The type of webhook filter. There are five webhook filter types: EVENT,
 ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, and FILE_PATH.
 
 
 EVENT
 
 
 A webhook event triggers a build when the provided pattern matches one of four event types:
 PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, and
 PULL_REQUEST_REOPENED. The EVENT patterns are specified as a comma-separated string.
 For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request
 created, and pull request updated events.
 
 
 
 The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only.
 
 
 ACTOR_ACCOUNT_ID
 
 
 A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular
 expression pattern.
 
 
 HEAD_REF
 
 
 A webhook event triggers a build when the head reference matches the regular expression pattern. For
 example, refs/heads/branch-name and refs/tags/tag-name.
 
 
 Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and
 Bitbucket pull request events.
 
 
 BASE_REF
 
 
 A webhook event triggers a build when the base reference matches the regular expression pattern. For
 example, refs/heads/branch-name.
 
 
 
 Works with pull request events only.
 
 
 FILE_PATH
 
 
 A webhook triggers a build when the path of a changed file matches the regular expression pattern.
 
 
 
 Works with GitHub and GitHub Enterprise push events only.
 
 
 


pattern
String pattern

 For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one
 or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED
 allows all push, pull request created, and pull request updated events to trigger a build.
 
 
 For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For
 example, a WebHookFilter that uses HEAD_REF for its type and the pattern
 ^refs/heads/ triggers a build when the head reference is a branch with a reference name
 refs/heads/branch-name.
 


excludeMatchedPattern
Boolean excludeMatchedPattern

 Used to indicate that the pattern determines which webhook events do not trigger a build. If true,
 then a webhook event that does not match the pattern triggers a build. If false, then a webhook
 event that matches the pattern triggers a build.
 








Package com.amazonaws.services.codecommit.model




Class com.amazonaws.services.codecommit.model.ActorDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.Approval extends Object implements Serializable


Serialized Fields


userArn
String userArn

 The Amazon Resource Name (ARN) of the user.
 


approvalState
String approvalState

 The state of the approval, APPROVE or REVOKE. REVOKE states are not stored.
 








Class com.amazonaws.services.codecommit.model.ApprovalRule extends Object implements Serializable


Serialized Fields


approvalRuleId
String approvalRuleId

 The system-generated ID of the approval rule.
 


approvalRuleName
String approvalRuleName

 The name of the approval rule.
 


approvalRuleContent
String approvalRuleContent

 The content of the approval rule.
 


ruleContentSha256
String ruleContentSha256

 The SHA-256 hash signature for the content of the approval rule.
 


lastModifiedDate
Date lastModifiedDate

 The date the approval rule was most recently changed, in timestamp format.
 


creationDate
Date creationDate

 The date the approval rule was created, in timestamp format.
 


lastModifiedUser
String lastModifiedUser

 The Amazon Resource Name (ARN) of the user who made the most recent changes to the approval rule.
 


originApprovalRuleTemplate
OriginApprovalRuleTemplate originApprovalRuleTemplate

 The approval rule template used to create the rule.
 








Class com.amazonaws.services.codecommit.model.ApprovalRuleContentRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ApprovalRuleDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ApprovalRuleEventMetadata extends Object implements Serializable


Serialized Fields


approvalRuleName
String approvalRuleName

 The name of the approval rule.
 


approvalRuleId
String approvalRuleId

 The system-generated ID of the approval rule.
 


approvalRuleContent
String approvalRuleContent

 The content of the approval rule.
 








Class com.amazonaws.services.codecommit.model.ApprovalRuleNameAlreadyExistsException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ApprovalRuleNameRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ApprovalRuleOverriddenEventMetadata extends Object implements Serializable


Serialized Fields


revisionId
String revisionId

 The revision ID of the pull request when the override event occurred.
 


overrideStatus
String overrideStatus

 The status of the override event.
 








Class com.amazonaws.services.codecommit.model.ApprovalRuleTemplate extends Object implements Serializable


Serialized Fields


approvalRuleTemplateId
String approvalRuleTemplateId

 The system-generated ID of the approval rule template.
 


approvalRuleTemplateName
String approvalRuleTemplateName

 The name of the approval rule template.
 


approvalRuleTemplateDescription
String approvalRuleTemplateDescription

 The description of the approval rule template.
 


approvalRuleTemplateContent
String approvalRuleTemplateContent

 The content of the approval rule template.
 


ruleContentSha256
String ruleContentSha256

 The SHA-256 hash signature for the content of the approval rule template.
 


lastModifiedDate
Date lastModifiedDate

 The date the approval rule template was most recently changed, in timestamp format.
 


creationDate
Date creationDate

 The date the approval rule template was created, in timestamp format.
 


lastModifiedUser
String lastModifiedUser

 The Amazon Resource Name (ARN) of the user who made the most recent changes to the approval rule template.
 








Class com.amazonaws.services.codecommit.model.ApprovalRuleTemplateContentRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ApprovalRuleTemplateDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ApprovalRuleTemplateInUseException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ApprovalRuleTemplateNameAlreadyExistsException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ApprovalRuleTemplateNameRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ApprovalStateChangedEventMetadata extends Object implements Serializable


Serialized Fields


revisionId
String revisionId

 The revision ID of the pull request when the approval state changed.
 


approvalStatus
String approvalStatus

 The approval status for the pull request.
 








Class com.amazonaws.services.codecommit.model.ApprovalStateRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.AssociateApprovalRuleTemplateWithRepositoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


approvalRuleTemplateName
String approvalRuleTemplateName

 The name for the approval rule template.
 


repositoryName
String repositoryName

 The name of the repository that you want to associate with the template.
 








Class com.amazonaws.services.codecommit.model.AssociateApprovalRuleTemplateWithRepositoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codecommit.model.AuthorDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.AWSCodeCommitException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.BatchAssociateApprovalRuleTemplateWithRepositoriesError extends Object implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where the association was not made.
 


errorCode
String errorCode

 An error code that specifies whether the repository name was not valid or not found.
 


errorMessage
String errorMessage

 An error message that provides details about why the repository name was not found or not valid.
 








Class com.amazonaws.services.codecommit.model.BatchAssociateApprovalRuleTemplateWithRepositoriesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


approvalRuleTemplateName
String approvalRuleTemplateName

 The name of the template you want to associate with one or more repositories.
 


repositoryNames
List<E> repositoryNames

 The names of the repositories you want to associate with the template.
 
 
 
 The length constraint limit is for each string in the array. The array itself can be empty.
 
 








Class com.amazonaws.services.codecommit.model.BatchAssociateApprovalRuleTemplateWithRepositoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


associatedRepositoryNames
List<E> associatedRepositoryNames

 A list of names of the repositories that have been associated with the template.
 


errors
List<E> errors

 A list of any errors that might have occurred while attempting to create the association between the template and
 the repositories.
 








Class com.amazonaws.services.codecommit.model.BatchDescribeMergeConflictsError extends Object implements Serializable


Serialized Fields


filePath
String filePath

 The path to the file.
 


exceptionName
String exceptionName

 The name of the exception.
 


message
String message

 The message provided by the exception.
 








Class com.amazonaws.services.codecommit.model.BatchDescribeMergeConflictsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository that contains the merge conflicts you want to review.
 


destinationCommitSpecifier
String destinationCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


sourceCommitSpecifier
String sourceCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


mergeOption
String mergeOption

 The merge option or strategy you want to use to merge the code.
 


maxMergeHunks
Integer maxMergeHunks

 The maximum number of merge hunks to include in the output.
 


maxConflictFiles
Integer maxConflictFiles

 The maximum number of files to include in the output.
 


filePaths
List<E> filePaths

 The path of the target files used to describe the conflicts. If not specified, the default is all conflict files.
 


conflictDetailLevel
String conflictDetailLevel

 The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a
 not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is
 considered not mergeable if the same file in both branches has differences on the same line.
 


conflictResolutionStrategy
String conflictResolutionStrategy

 Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions
 of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation
 is successful.
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 








Class com.amazonaws.services.codecommit.model.BatchDescribeMergeConflictsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


conflicts
List<E> conflicts

 A list of conflicts for each file, including the conflict metadata and the hunks of the differences between the
 files.
 


nextToken
String nextToken

 An enumeration token that can be used in a request to return the next batch of the results.
 


errors
List<E> errors

 A list of any errors returned while describing the merge conflicts for each file.
 


destinationCommitId
String destinationCommitId

 The commit ID of the destination commit specifier that was used in the merge evaluation.
 


sourceCommitId
String sourceCommitId

 The commit ID of the source commit specifier that was used in the merge evaluation.
 


baseCommitId
String baseCommitId

 The commit ID of the merge base.
 








Class com.amazonaws.services.codecommit.model.BatchDisassociateApprovalRuleTemplateFromRepositoriesError extends Object implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where the association with the template was not able to be removed.
 


errorCode
String errorCode

 An error code that specifies whether the repository name was not valid or not found.
 


errorMessage
String errorMessage

 An error message that provides details about why the repository name was either not found or not valid.
 








Class com.amazonaws.services.codecommit.model.BatchDisassociateApprovalRuleTemplateFromRepositoriesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


approvalRuleTemplateName
String approvalRuleTemplateName

 The name of the template that you want to disassociate from one or more repositories.
 


repositoryNames
List<E> repositoryNames

 The repository names that you want to disassociate from the approval rule template.
 
 
 
 The length constraint limit is for each string in the array. The array itself can be empty.
 
 








Class com.amazonaws.services.codecommit.model.BatchDisassociateApprovalRuleTemplateFromRepositoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


disassociatedRepositoryNames
List<E> disassociatedRepositoryNames

 A list of repository names that have had their association with the template removed.
 


errors
List<E> errors

 A list of any errors that might have occurred while attempting to remove the association between the template and
 the repositories.
 








Class com.amazonaws.services.codecommit.model.BatchGetCommitsError extends Object implements Serializable


Serialized Fields


commitId
String commitId

 A commit ID that either could not be found or was not in a valid format.
 


errorCode
String errorCode

 An error code that specifies whether the commit ID was not valid or not found.
 


errorMessage
String errorMessage

 An error message that provides detail about why the commit ID either was not found or was not valid.
 








Class com.amazonaws.services.codecommit.model.BatchGetCommitsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


commitIds
List<E> commitIds

 The full commit IDs of the commits to get information about.
 
 
 
 You must supply the full SHA IDs of each commit. You cannot use shortened SHA IDs.
 
 


repositoryName
String repositoryName

 The name of the repository that contains the commits.
 








Class com.amazonaws.services.codecommit.model.BatchGetCommitsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commits
List<E> commits

 An array of commit data type objects, each of which contains information about a specified commit.
 


errors
List<E> errors

 Returns any commit IDs for which information could not be found. For example, if one of the commit IDs was a
 shortened SHA ID or that commit was not found in the specified repository, the ID returns an error object with
 more information.
 








Class com.amazonaws.services.codecommit.model.BatchGetRepositoriesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryNames
List<E> repositoryNames

 The names of the repositories to get information about.
 
 
 
 The length constraint limit is for each string in the array. The array itself can be empty.
 
 








Class com.amazonaws.services.codecommit.model.BatchGetRepositoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositories
List<E> repositories

 A list of repositories returned by the batch get repositories operation.
 


repositoriesNotFound
List<E> repositoriesNotFound

 Returns a list of repository names for which information could not be found.
 








Class com.amazonaws.services.codecommit.model.BeforeCommitIdAndAfterCommitIdAreSameException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.BlobIdDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.BlobIdRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.BlobMetadata extends Object implements Serializable


Serialized Fields


blobId
String blobId

 The full ID of the blob.
 


path
String path

 The path to the blob and associated file name, if any.
 


mode
String mode

 The file mode permissions of the blob. File mode permission codes include:
 
 
 
 
 100644 indicates read/write
 
 
 
 
 100755 indicates read/write/execute
 
 
 
 
 160000 indicates a submodule
 
 
 
 
 120000 indicates a symlink
 
 
 








Class com.amazonaws.services.codecommit.model.BranchDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.BranchInfo extends Object implements Serializable


Serialized Fields


branchName
String branchName

 The name of the branch.
 


commitId
String commitId

 The ID of the last commit made to the branch.
 








Class com.amazonaws.services.codecommit.model.BranchNameExistsException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.BranchNameIsTagNameException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.BranchNameRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CannotDeleteApprovalRuleFromTemplateException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CannotModifyApprovalRuleFromTemplateException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ClientRequestTokenRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.Comment extends Object implements Serializable


Serialized Fields


commentId
String commentId

 The system-generated comment ID.
 


content
String content

 The content of the comment.
 


inReplyTo
String inReplyTo

 The ID of the comment for which this comment is a reply, if any.
 


creationDate
Date creationDate

 The date and time the comment was created, in timestamp format.
 


lastModifiedDate
Date lastModifiedDate

 The date and time the comment was most recently modified, in timestamp format.
 


authorArn
String authorArn

 The Amazon Resource Name (ARN) of the person who posted the comment.
 


deleted
Boolean deleted

 A Boolean value indicating whether the comment has been deleted.
 


clientRequestToken
String clientRequestToken

 A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be
 repeated with a changed parameter. If a request is received with the same parameters and a token is included, the
 request returns information about the initial request that used that token.
 








Class com.amazonaws.services.codecommit.model.CommentContentRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CommentContentSizeLimitExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CommentDeletedException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CommentDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CommentIdRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CommentNotCreatedByCallerException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CommentsForComparedCommit extends Object implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository that contains the compared commits.
 


beforeCommitId
String beforeCommitId

 The full commit ID of the commit used to establish the before of the comparison.
 


afterCommitId
String afterCommitId

 The full commit ID of the commit used to establish the after of the comparison.
 


beforeBlobId
String beforeBlobId

 The full blob ID of the commit used to establish the before of the comparison.
 


afterBlobId
String afterBlobId

 The full blob ID of the commit used to establish the after of the comparison.
 


location
Location location

 Location information about the comment on the comparison, including the file name, line number, and whether the
 version of the file where the comment was made is BEFORE or AFTER.
 


comments
List<E> comments

 An array of comment objects. Each comment object contains information about a comment on the comparison between
 commits.
 








Class com.amazonaws.services.codecommit.model.CommentsForPullRequest extends Object implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request.
 


repositoryName
String repositoryName

 The name of the repository that contains the pull request.
 


beforeCommitId
String beforeCommitId

 The full commit ID of the commit that was the tip of the destination branch when the pull request was created.
 This commit is superceded by the after commit in the source branch when and if you merge the source branch into
 the destination branch.
 


afterCommitId
String afterCommitId

 The full commit ID of the commit that was the tip of the source branch at the time the comment was made.
 


beforeBlobId
String beforeBlobId

 The full blob ID of the file on which you want to comment on the destination commit.
 


afterBlobId
String afterBlobId

 The full blob ID of the file on which you want to comment on the source commit.
 


location
Location location

 Location information about the comment on the pull request, including the file name, line number, and whether the
 version of the file where the comment was made is BEFORE (destination branch) or AFTER (source branch).
 


comments
List<E> comments

 An array of comment objects. Each comment object contains information about a comment on the pull request.
 








Class com.amazonaws.services.codecommit.model.Commit extends Object implements Serializable


Serialized Fields


commitId
String commitId

 The full SHA ID of the specified commit.
 


treeId
String treeId

 Tree information for the specified commit.
 


parents
List<E> parents

 A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.
 


message
String message

 The commit message associated with the specified commit.
 


author
UserInfo author

 Information about the author of the specified commit. Information includes the date in timestamp format with GMT
 offset, the name of the author, and the email address for the author, as configured in Git.
 


committer
UserInfo committer

 Information about the person who committed the specified commit, also known as the committer. Information
 includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the
 committer, as configured in Git.
 
 
 For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben
 Straub.
 


additionalData
String additionalData

 Any other data associated with the specified commit.
 








Class com.amazonaws.services.codecommit.model.CommitDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CommitIdDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CommitIdRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CommitIdsLimitExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CommitIdsListRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CommitMessageLengthExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.CommitRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ConcurrentReferenceUpdateException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.Conflict extends Object implements Serializable


Serialized Fields


conflictMetadata
ConflictMetadata conflictMetadata

 Metadata about a conflict in a merge operation.
 


mergeHunks
List<E> mergeHunks

 A list of hunks that contain the differences between files or lines causing the conflict.
 








Class com.amazonaws.services.codecommit.model.ConflictMetadata extends Object implements Serializable


Serialized Fields


filePath
String filePath

 The path of the file that contains conflicts.
 


fileSizes
FileSizes fileSizes

 The file sizes of the file in the source, destination, and base of the merge.
 


fileModes
FileModes fileModes

 The file modes of the file in the source, destination, and base of the merge.
 


objectTypes
ObjectTypes objectTypes

 Information about any object type conflicts in a merge operation.
 


numberOfConflicts
Integer numberOfConflicts

 The number of conflicts, including both hunk conflicts and metadata conflicts.
 


isBinaryFile
IsBinaryFile isBinaryFile

 A boolean value (true or false) indicating whether the file is binary or textual in the source, destination, and
 base of the merge.
 


contentConflict
Boolean contentConflict

 A boolean value indicating whether there are conflicts in the content of a file.
 


fileModeConflict
Boolean fileModeConflict

 A boolean value indicating whether there are conflicts in the file mode of a file.
 


objectTypeConflict
Boolean objectTypeConflict

 A boolean value (true or false) indicating whether there are conflicts between the branches in the object type of
 a file, folder, or submodule.
 


mergeOperations
MergeOperations mergeOperations

 Whether an add, modify, or delete operation caused the conflict between the source and destination of the merge.
 








Class com.amazonaws.services.codecommit.model.ConflictResolution extends Object implements Serializable


Serialized Fields


replaceContents
List<E> replaceContents

 Files to have content replaced as part of the merge conflict resolution.
 


deleteFiles
List<E> deleteFiles

 Files to be deleted as part of the merge conflict resolution.
 


setFileModes
List<E> setFileModes

 File modes that are set as part of the merge conflict resolution.
 








Class com.amazonaws.services.codecommit.model.CreateApprovalRuleTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


approvalRuleTemplateName
String approvalRuleTemplateName

 The name of the approval rule template. Provide descriptive names, because this name is applied to the approval
 rules created automatically in associated repositories.
 


approvalRuleTemplateContent
String approvalRuleTemplateContent

 The content of the approval rule that is created on pull requests in associated repositories. If you specify one
 or more destination references (branches), approval rules are created in an associated repository only if their
 destination references (branches) match those specified in the template.
 
 
 
 When you create the content of the approval rule template, you can specify approvers in an approval pool in one
 of two ways:
 
 
 
 
 CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM
 users and federated access users whose name matches the provided resource name. This is a very powerful option
 that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and
 Mary_Major, all of the following are counted as approvals coming from that user:
 
 
 
 
 An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)
 
 
 
 
 A federated user identified in IAM as Mary_Major
 (arn:aws:sts::123456789012:federated-user/Mary_Major)
 
 
 
 
 This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role
 session name of Mary_Major
 (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard
 (*Mary_Major).
 
 
 
 
 Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of
 the IAM user or role.
 
 
 
 
 For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the
 IAM User Guide.
 
 


approvalRuleTemplateDescription
String approvalRuleTemplateDescription

 The description of the approval rule template. Consider providing a description that explains what this template
 does and when it might be appropriate to associate it with repositories.
 








Class com.amazonaws.services.codecommit.model.CreateApprovalRuleTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvalRuleTemplate
ApprovalRuleTemplate approvalRuleTemplate

 The content and structure of the created approval rule template.
 








Class com.amazonaws.services.codecommit.model.CreateBranchRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository in which you want to create the new branch.
 


branchName
String branchName

 The name of the new branch to create.
 


commitId
String commitId

 The ID of the commit to point the new branch to.
 








Class com.amazonaws.services.codecommit.model.CreateBranchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codecommit.model.CreateCommitRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you create the commit.
 


branchName
String branchName

 The name of the branch where you create the commit.
 


parentCommitId
String parentCommitId

 The ID of the commit that is the parent of the commit you create. Not required if this is an empty repository.
 


authorName
String authorName

 The name of the author who created the commit. This information is used as both the author and committer for the
 commit.
 


email
String email

 The email address of the person who created the commit.
 


commitMessage
String commitMessage

 The commit message you want to include in the commit. Commit messages are limited to 256 KB. If no message is
 specified, a default message is used.
 


keepEmptyFolders
Boolean keepEmptyFolders

 If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders
 empty. If true, a ..gitkeep file is created for empty folders. The default is false.
 


putFiles
List<E> putFiles

 The files to add or update in this commit.
 


deleteFiles
List<E> deleteFiles

 The files to delete in this commit. These files still exist in earlier commits.
 


setFileModes
List<E> setFileModes

 The file modes to update for files in this commit.
 








Class com.amazonaws.services.codecommit.model.CreateCommitResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commitId
String commitId

 The full commit ID of the commit that contains your committed file changes.
 


treeId
String treeId

 The full SHA-1 pointer of the tree information for the commit that contains the commited file changes.
 


filesAdded
List<E> filesAdded

 The files added as part of the committed file changes.
 


filesUpdated
List<E> filesUpdated

 The files updated as part of the commited file changes.
 


filesDeleted
List<E> filesDeleted

 The files deleted as part of the committed file changes.
 








Class com.amazonaws.services.codecommit.model.CreatePullRequestApprovalRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request for which you want to create the approval rule.
 


approvalRuleName
String approvalRuleName

 The name for the approval rule.
 


approvalRuleContent
String approvalRuleContent

 The content of the approval rule, including the number of approvals needed and the structure of an approval pool
 defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.
 
 
 
 When you create the content of the approval rule, you can specify approvers in an approval pool in one of two
 ways:
 
 
 
 
 CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM
 users and federated access users whose name matches the provided resource name. This is a very powerful option
 that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and
 Mary_Major, all of the following would be counted as approvals coming from that user:
 
 
 
 
 An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)
 
 
 
 
 A federated user identified in IAM as Mary_Major
 (arn:aws:sts::123456789012:federated-user/Mary_Major)
 
 
 
 
 This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role
 session name of Mary_Major
 (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard
 (*Mary_Major).
 
 
 
 
 Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of
 the IAM user or role.
 
 
 
 
 For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the
 IAM User Guide.
 
 








Class com.amazonaws.services.codecommit.model.CreatePullRequestApprovalRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvalRule
ApprovalRule approvalRule

 Information about the created approval rule.
 








Class com.amazonaws.services.codecommit.model.CreatePullRequestRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


title
String title

 The title of the pull request. This title is used to identify the pull request to other users in the repository.
 


description
String description

 A description of the pull request.
 


targets
List<E> targets

 The targets for the pull request, including the source of the code to be reviewed (the source branch) and the
 destination where the creator of the pull request intends the code to be merged after the pull request is closed
 (the destination branch).
 


clientRequestToken
String clientRequestToken

 A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be
 repeated with a changed parameter. If a request is received with the same parameters and a token is included, the
 request returns information about the initial request that used that token.
 
 
 
 The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for
 you.
 
 








Class com.amazonaws.services.codecommit.model.CreatePullRequestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pullRequest
PullRequest pullRequest

 Information about the newly created pull request.
 








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


Serialized Fields


repositoryName
String repositoryName

 The name of the new repository to be created.
 
 
 
 The repository name must be unique across the calling AWS account. Repository names are limited to 100
 alphanumeric, dash, and underscore characters, and cannot include certain characters. For more information about
 the limits on repository names, see Limits in the AWS CodeCommit
 User Guide. The suffix .git is prohibited.
 
 


repositoryDescription
String repositoryDescription

 A comment or description about the new repository.
 
 
 
 The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications
 that do not HTML-encode the description and display it in a webpage can 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 webpage.
 
 


tags
Map<K,V> tags

 One or more tag key-value pairs to use when tagging this repository.
 








Class com.amazonaws.services.codecommit.model.CreateRepositoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositoryMetadata
RepositoryMetadata repositoryMetadata

 Information about the newly created repository.
 








Class com.amazonaws.services.codecommit.model.CreateUnreferencedMergeCommitRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you want to create the unreferenced merge commit.
 


sourceCommitSpecifier
String sourceCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


destinationCommitSpecifier
String destinationCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


mergeOption
String mergeOption

 The merge option or strategy you want to use to merge the code.
 


conflictDetailLevel
String conflictDetailLevel

 The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a
 not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is
 considered not mergeable if the same file in both branches has differences on the same line.
 


conflictResolutionStrategy
String conflictResolutionStrategy

 Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions
 of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation
 is successful.
 


authorName
String authorName

 The name of the author who created the unreferenced commit. This information is used as both the author and
 committer for the commit.
 


email
String email

 The email address for the person who created the unreferenced commit.
 


commitMessage
String commitMessage

 The commit message for the unreferenced commit.
 


keepEmptyFolders
Boolean keepEmptyFolders

 If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders
 empty. If this is specified as true, a .gitkeep file is created for empty folders. The default is false.
 


conflictResolution
ConflictResolution conflictResolution

 If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a
 merge.
 








Class com.amazonaws.services.codecommit.model.CreateUnreferencedMergeCommitResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commitId
String commitId

 The full commit ID of the commit that contains your merge results.
 


treeId
String treeId

 The full SHA-1 pointer of the tree information for the commit that contains the merge results.
 








Class com.amazonaws.services.codecommit.model.DefaultBranchCannotBeDeletedException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.DeleteApprovalRuleTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


approvalRuleTemplateName
String approvalRuleTemplateName

 The name of the approval rule template to delete.
 








Class com.amazonaws.services.codecommit.model.DeleteApprovalRuleTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvalRuleTemplateId
String approvalRuleTemplateId

 The system-generated ID of the deleted approval rule template. If the template has been previously deleted, the
 only response is a 200 OK.
 








Class com.amazonaws.services.codecommit.model.DeleteBranchRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository that contains the branch to be deleted.
 


branchName
String branchName

 The name of the branch to delete.
 








Class com.amazonaws.services.codecommit.model.DeleteBranchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deletedBranch
BranchInfo deletedBranch

 Information about the branch deleted by the operation, including the branch name and the commit ID that was the
 tip of the branch.
 








Class com.amazonaws.services.codecommit.model.DeleteCommentContentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


commentId
String commentId

 The unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or
 GetCommentsForPullRequest.
 








Class com.amazonaws.services.codecommit.model.DeleteCommentContentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


comment
Comment comment

 Information about the comment you just deleted.
 








Class com.amazonaws.services.codecommit.model.DeleteFileEntry extends Object implements Serializable


Serialized Fields


filePath
String filePath

 The full path of the file to be deleted, including the name of the file.
 








Class com.amazonaws.services.codecommit.model.DeleteFileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository that contains the file to delete.
 


branchName
String branchName

 The name of the branch where the commit that deletes the file is made.
 


filePath
String filePath

 The fully qualified path to the file that to be deleted, including the full name and extension of that file. For
 example, /examples/file.md is a fully qualified path to a file named file.md in a folder named examples.
 


parentCommitId
String parentCommitId

 The ID of the commit that is the tip of the branch where you want to create the commit that deletes the file.
 This must be the HEAD commit for the branch. The commit that deletes the file is created from this commit ID.
 


keepEmptyFolders
Boolean keepEmptyFolders

 If a file is the only object in the folder or directory, specifies whether to delete the folder or directory that
 contains the file. By default, empty folders are deleted. This includes empty folders that are part of the
 directory structure. For example, if the path to a file is dir1/dir2/dir3/dir4, and dir2 and dir3 are empty,
 deleting the last file in dir4 also deletes the empty folders dir4, dir3, and dir2.
 


commitMessage
String commitMessage

 The commit message you want to include as part of deleting the file. Commit messages are limited to 256 KB. If no
 message is specified, a default message is used.
 


name
String name

 The name of the author of the commit that deletes the file. If no name is specified, the user's ARN is used as
 the author name and committer name.
 


email
String email

 The email address for the commit that deletes the file. If no email address is specified, the email address is
 left blank.
 








Class com.amazonaws.services.codecommit.model.DeleteFileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commitId
String commitId

 The full commit ID of the commit that contains the change that deletes the file.
 


blobId
String blobId

 The blob ID removed from the tree as part of deleting the file.
 


treeId
String treeId

 The full SHA-1 pointer of the tree information for the commit that contains the delete file change.
 


filePath
String filePath

 The fully qualified path to the file to be deleted, including the full name and extension of that file.
 








Class com.amazonaws.services.codecommit.model.DeletePullRequestApprovalRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request that contains the approval rule you want to delete.
 


approvalRuleName
String approvalRuleName

 The name of the approval rule you want to delete.
 








Class com.amazonaws.services.codecommit.model.DeletePullRequestApprovalRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvalRuleId
String approvalRuleId

 The ID of the deleted approval rule.
 
 
 
 If the approval rule was deleted in an earlier API call, the response is 200 OK without content.
 
 








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


Serialized Fields


repositoryName
String repositoryName

 The name of the repository to delete.
 








Class com.amazonaws.services.codecommit.model.DeleteRepositoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositoryId
String repositoryId

 The ID of the repository that was deleted.
 








Class com.amazonaws.services.codecommit.model.DescribeMergeConflictsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you want to get information about a merge conflict.
 


destinationCommitSpecifier
String destinationCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


sourceCommitSpecifier
String sourceCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


mergeOption
String mergeOption

 The merge option or strategy you want to use to merge the code.
 


maxMergeHunks
Integer maxMergeHunks

 The maximum number of merge hunks to include in the output.
 


filePath
String filePath

 The path of the target files used to describe the conflicts.
 


conflictDetailLevel
String conflictDetailLevel

 The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a
 not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is
 considered not mergeable if the same file in both branches has differences on the same line.
 


conflictResolutionStrategy
String conflictResolutionStrategy

 Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions
 of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation
 is successful.
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 








Class com.amazonaws.services.codecommit.model.DescribeMergeConflictsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


conflictMetadata
ConflictMetadata conflictMetadata

 Contains metadata about the conflicts found in the merge.
 


mergeHunks
List<E> mergeHunks

 A list of merge hunks of the differences between the files or lines.
 


nextToken
String nextToken

 An enumeration token that can be used in a request to return the next batch of the results.
 


destinationCommitId
String destinationCommitId

 The commit ID of the destination commit specifier that was used in the merge evaluation.
 


sourceCommitId
String sourceCommitId

 The commit ID of the source commit specifier that was used in the merge evaluation.
 


baseCommitId
String baseCommitId

 The commit ID of the merge base.
 








Class com.amazonaws.services.codecommit.model.DescribePullRequestEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request. To get this ID, use ListPullRequests.
 


pullRequestEventType
String pullRequestEventType

 Optional. The pull request event type about which you want to return information.
 


actorArn
String actorArn

 The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the
 pull request with more commits or changing the status of a pull request.
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 


maxResults
Integer maxResults

 A non-zero, non-negative integer used to limit the number of returned results. The default is 100 events, which
 is also the maximum number of events that can be returned in a result.
 








Class com.amazonaws.services.codecommit.model.DescribePullRequestEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pullRequestEvents
List<E> pullRequestEvents

 Information about the pull request events.
 


nextToken
String nextToken

 An enumeration token that can be used in a request to return the next batch of the results.
 








Class com.amazonaws.services.codecommit.model.Difference extends Object implements Serializable


Serialized Fields


beforeBlob
BlobMetadata beforeBlob

 Information about a beforeBlob data type object, including the ID, the file mode permission code,
 and the path.
 


afterBlob
BlobMetadata afterBlob

 Information about an afterBlob data type object, including the ID, the file mode permission code,
 and the path.
 


changeType
String changeType

 Whether the change type of the difference is an addition (A), deletion (D), or modification (M).
 








Class com.amazonaws.services.codecommit.model.DirectoryNameConflictsWithFileNameException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.DisassociateApprovalRuleTemplateFromRepositoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


approvalRuleTemplateName
String approvalRuleTemplateName

 The name of the approval rule template to disassociate from a specified repository.
 


repositoryName
String repositoryName

 The name of the repository you want to disassociate from the template.
 








Class com.amazonaws.services.codecommit.model.DisassociateApprovalRuleTemplateFromRepositoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codecommit.model.EncryptionIntegrityChecksFailedException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.EncryptionKeyAccessDeniedException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.EncryptionKeyDisabledException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.EncryptionKeyNotFoundException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.EncryptionKeyUnavailableException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.EvaluatePullRequestApprovalRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request you want to evaluate.
 


revisionId
String revisionId

 The system-generated ID for the pull request revision. To retrieve the most recent revision ID for a pull
 request, use GetPullRequest.
 








Class com.amazonaws.services.codecommit.model.EvaluatePullRequestApprovalRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


evaluation
Evaluation evaluation

 The result of the evaluation, including the names of the rules whose conditions have been met (if any), the names
 of the rules whose conditions have not been met (if any), whether the pull request is in the approved state, and
 whether the pull request approval rule has been set aside by an override.
 








Class com.amazonaws.services.codecommit.model.Evaluation extends Object implements Serializable


Serialized Fields


approved
Boolean approved

 Whether the state of the pull request is approved.
 


overridden
Boolean overridden

 Whether the approval rule requirements for the pull request have been overridden and no longer need to be met.
 


approvalRulesSatisfied
List<E> approvalRulesSatisfied

 The names of the approval rules that have had their conditions met.
 


approvalRulesNotSatisfied
List<E> approvalRulesNotSatisfied

 The names of the approval rules that have not had their conditions met.
 








Class com.amazonaws.services.codecommit.model.File extends Object implements Serializable


Serialized Fields


blobId
String blobId

 The blob ID that contains the file information.
 


absolutePath
String absolutePath

 The fully qualified path to the file in the repository.
 


relativePath
String relativePath

 The relative path of the file from the folder where the query originated.
 


fileMode
String fileMode

 The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.
 








Class com.amazonaws.services.codecommit.model.FileContentAndSourceFileSpecifiedException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.FileContentRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.FileContentSizeLimitExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.FileDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.FileEntryRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.FileMetadata extends Object implements Serializable


Serialized Fields


absolutePath
String absolutePath

 The full path to the file to be added or updated, including the name of the file.
 


blobId
String blobId

 The blob ID that contains the file information.
 


fileMode
String fileMode

 The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.
 








Class com.amazonaws.services.codecommit.model.FileModeRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.FileModes extends Object implements Serializable


Serialized Fields


source
String source

 The file mode of a file in the source of a merge or pull request.
 


destination
String destination

 The file mode of a file in the destination of a merge or pull request.
 


base
String base

 The file mode of a file in the base of a merge or pull request.
 








Class com.amazonaws.services.codecommit.model.FileNameConflictsWithDirectoryNameException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.FilePathConflictsWithSubmodulePathException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.FileSizes extends Object implements Serializable


Serialized Fields


source
Long source

 The size of a file in the source of a merge or pull request.
 


destination
Long destination

 The size of a file in the destination of a merge or pull request.
 


base
Long base

 The size of a file in the base of a merge or pull request.
 








Class com.amazonaws.services.codecommit.model.FileTooLargeException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.Folder extends Object implements Serializable


Serialized Fields


treeId
String treeId

 The full SHA-1 pointer of the tree information for the commit that contains the folder.
 


absolutePath
String absolutePath

 The fully qualified path of the folder in the repository.
 


relativePath
String relativePath

 The relative path of the specified folder from the folder where the query originated.
 








Class com.amazonaws.services.codecommit.model.FolderContentSizeLimitExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.FolderDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.GetApprovalRuleTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


approvalRuleTemplateName
String approvalRuleTemplateName

 The name of the approval rule template for which you want to get information.
 








Class com.amazonaws.services.codecommit.model.GetApprovalRuleTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvalRuleTemplate
ApprovalRuleTemplate approvalRuleTemplate

 The content and structure of the approval rule template.
 








Class com.amazonaws.services.codecommit.model.GetBlobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository that contains the blob.
 


blobId
String blobId

 The ID of the blob, which is its SHA-1 pointer.
 








Class com.amazonaws.services.codecommit.model.GetBlobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


content
ByteBuffer content

 The content of the blob, usually a file.
 








Class com.amazonaws.services.codecommit.model.GetBranchRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository that contains the branch for which you want to retrieve information.
 


branchName
String branchName

 The name of the branch for which you want to retrieve information.
 








Class com.amazonaws.services.codecommit.model.GetBranchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


branch
BranchInfo branch

 The name of the branch.
 








Class com.amazonaws.services.codecommit.model.GetCommentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


commentId
String commentId

 The unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or
 GetCommentsForPullRequest.
 








Class com.amazonaws.services.codecommit.model.GetCommentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


comment
Comment comment

 The contents of the comment.
 








Class com.amazonaws.services.codecommit.model.GetCommentsForComparedCommitRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you want to compare commits.
 


beforeCommitId
String beforeCommitId

 To establish the directionality of the comparison, the full commit ID of the before commit.
 


afterCommitId
String afterCommitId

 To establish the directionality of the comparison, the full commit ID of the after commit.
 


nextToken
String nextToken

 An enumeration token that when provided in a request, returns the next batch of the results.
 


maxResults
Integer maxResults

 A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments, but
 you can configure up to 500.
 








Class com.amazonaws.services.codecommit.model.GetCommentsForComparedCommitResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commentsForComparedCommitData
List<E> commentsForComparedCommitData

 A list of comment objects on the compared commit.
 


nextToken
String nextToken

 An enumeration token that can be used in a request to return the next batch of the results.
 








Class com.amazonaws.services.codecommit.model.GetCommentsForPullRequestRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request. To get this ID, use ListPullRequests.
 


repositoryName
String repositoryName

 The name of the repository that contains the pull request.
 


beforeCommitId
String beforeCommitId

 The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull
 request was created.
 


afterCommitId
String afterCommitId

 The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was
 made.
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 


maxResults
Integer maxResults

 A non-zero, non-negative integer used to limit the number of returned results. The default is 100 comments. You
 can return up to 500 comments with a single request.
 








Class com.amazonaws.services.codecommit.model.GetCommentsForPullRequestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commentsForPullRequestData
List<E> commentsForPullRequestData

 An array of comment objects on the pull request.
 


nextToken
String nextToken

 An enumeration token that can be used in a request to return the next batch of the results.
 








Class com.amazonaws.services.codecommit.model.GetCommitRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository to which the commit was made.
 


commitId
String commitId

 The commit ID. Commit IDs are the full SHA ID of the commit.
 








Class com.amazonaws.services.codecommit.model.GetCommitResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commit
Commit commit

 A commit data type object that contains information about the specified commit.
 








Class com.amazonaws.services.codecommit.model.GetDifferencesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you want to get differences.
 


beforeCommitSpecifier
String beforeCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, the full commit
 ID). Optional. If not specified, all changes before the afterCommitSpecifier value are shown. If you
 do not use beforeCommitSpecifier in your request, consider limiting the results with
 maxResults.
 


afterCommitSpecifier
String afterCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit.
 


beforePath
String beforePath

 The file path in which to check for differences. Limits the results to this path. Can also be used to specify the
 previous name of a directory or folder. If beforePath and afterPath are not specified,
 differences are shown for all paths.
 


afterPath
String afterPath

 The file path in which to check differences. Limits the results to this path. Can also be used to specify the
 changed name of a directory or folder, if it has changed. If not specified, differences are shown for all paths.
 


maxResults
Integer maxResults

 A non-zero, non-negative integer used to limit the number of returned results.
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 








Class com.amazonaws.services.codecommit.model.GetDifferencesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


differences
List<E> differences

 A data type object that contains information about the differences, including whether the difference is added,
 modified, or deleted (A, D, M).
 


nextToken
String nextToken

 An enumeration token that can be used in a request to return the next batch of the results.
 








Class com.amazonaws.services.codecommit.model.GetFileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository that contains the file.
 


commitSpecifier
String commitSpecifier

 The fully quaified reference that identifies the commit that contains the file. For example, you can specify a
 full commit ID, a tag, a branch name, or a reference such as refs/heads/master. If none is provided, the head
 commit is used.
 


filePath
String filePath

 The fully qualified path to the file, including the full name and extension of the file. For example,
 /examples/file.md is the fully qualified path to a file named file.md in a folder named examples.
 








Class com.amazonaws.services.codecommit.model.GetFileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commitId
String commitId

 The full commit ID of the commit that contains the content returned by GetFile.
 


blobId
String blobId

 The blob ID of the object that represents the file content.
 


filePath
String filePath

 The fully qualified path to the specified file. Returns the name and extension of the file.
 


fileMode
String fileMode

 The extrapolated file mode permissions of the blob. Valid values include strings such as EXECUTABLE and not
 numeric values.
 
 
 
 The file mode permissions returned by this API are not the standard file mode permission values, such as 100644,
 but rather extrapolated values. See the supported return values.
 
 


fileSize
Long fileSize

 The size of the contents of the file, in bytes.
 


fileContent
ByteBuffer fileContent

 The base-64 encoded binary data object that represents the content of the file.
 








Class com.amazonaws.services.codecommit.model.GetFolderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository.
 


commitSpecifier
String commitSpecifier

 A fully qualified reference used to identify a commit that contains the version of the folder's content to
 return. A fully qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no
 specifier is provided, the folder content is returned as it exists in the HEAD commit.
 


folderPath
String folderPath

 The fully qualified path to the folder whose contents are returned, including the folder name. For example,
 /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of
 a repository.
 








Class com.amazonaws.services.codecommit.model.GetFolderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commitId
String commitId

 The full commit ID used as a reference for the returned version of the folder content.
 


folderPath
String folderPath

 The fully qualified path of the folder whose contents are returned.
 


treeId
String treeId

 The full SHA-1 pointer of the tree information for the commit that contains the folder.
 


subFolders
List<E> subFolders

 The list of folders that exist under the specified folder, if any.
 


files
List<E> files

 The list of files in the specified folder, if any.
 


symbolicLinks
List<E> symbolicLinks

 The list of symbolic links to other files and folders in the specified folder, if any.
 


subModules
List<E> subModules

 The list of submodules in the specified folder, if any.
 








Class com.amazonaws.services.codecommit.model.GetMergeCommitRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository that contains the merge commit about which you want to get information.
 


sourceCommitSpecifier
String sourceCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


destinationCommitSpecifier
String destinationCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


conflictDetailLevel
String conflictDetailLevel

 The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a
 not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is
 considered not mergeable if the same file in both branches has differences on the same line.
 


conflictResolutionStrategy
String conflictResolutionStrategy

 Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions
 of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation
 is successful.
 








Class com.amazonaws.services.codecommit.model.GetMergeCommitResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sourceCommitId
String sourceCommitId

 The commit ID of the source commit specifier that was used in the merge evaluation.
 


destinationCommitId
String destinationCommitId

 The commit ID of the destination commit specifier that was used in the merge evaluation.
 


baseCommitId
String baseCommitId

 The commit ID of the merge base.
 


mergedCommitId
String mergedCommitId

 The commit ID for the merge commit created when the source branch was merged into the destination branch. If the
 fast-forward merge strategy was used, there is no merge commit.
 








Class com.amazonaws.services.codecommit.model.GetMergeConflictsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where the pull request was created.
 


destinationCommitSpecifier
String destinationCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


sourceCommitSpecifier
String sourceCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


mergeOption
String mergeOption

 The merge option or strategy you want to use to merge the code.
 


conflictDetailLevel
String conflictDetailLevel

 The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a
 not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is
 considered not mergeable if the same file in both branches has differences on the same line.
 


maxConflictFiles
Integer maxConflictFiles

 The maximum number of files to include in the output.
 


conflictResolutionStrategy
String conflictResolutionStrategy

 Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions
 of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation
 is successful.
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 








Class com.amazonaws.services.codecommit.model.GetMergeConflictsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


mergeable
Boolean mergeable

 A Boolean value that indicates whether the code is mergeable by the specified merge option.
 


destinationCommitId
String destinationCommitId

 The commit ID of the destination commit specifier that was used in the merge evaluation.
 


sourceCommitId
String sourceCommitId

 The commit ID of the source commit specifier that was used in the merge evaluation.
 


baseCommitId
String baseCommitId

 The commit ID of the merge base.
 


conflictMetadataList
List<E> conflictMetadataList

 A list of metadata for any conflicting files. If the specified merge strategy is FAST_FORWARD_MERGE, this list is
 always empty.
 


nextToken
String nextToken

 An enumeration token that can be used in a request to return the next batch of the results.
 








Class com.amazonaws.services.codecommit.model.GetMergeOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository that contains the commits about which you want to get merge options.
 


sourceCommitSpecifier
String sourceCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


destinationCommitSpecifier
String destinationCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


conflictDetailLevel
String conflictDetailLevel

 The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a
 not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is
 considered not mergeable if the same file in both branches has differences on the same line.
 


conflictResolutionStrategy
String conflictResolutionStrategy

 Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions
 of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation
 is successful.
 








Class com.amazonaws.services.codecommit.model.GetMergeOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


mergeOptions
List<E> mergeOptions

 The merge option or strategy used to merge the code.
 


sourceCommitId
String sourceCommitId

 The commit ID of the source commit specifier that was used in the merge evaluation.
 


destinationCommitId
String destinationCommitId

 The commit ID of the destination commit specifier that was used in the merge evaluation.
 


baseCommitId
String baseCommitId

 The commit ID of the merge base.
 








Class com.amazonaws.services.codecommit.model.GetPullRequestApprovalStatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID for the pull request.
 


revisionId
String revisionId

 The system-generated ID for the pull request revision.
 








Class com.amazonaws.services.codecommit.model.GetPullRequestApprovalStatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvals
List<E> approvals

 Information about users who have approved the pull request.
 








Class com.amazonaws.services.codecommit.model.GetPullRequestOverrideStateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The ID of the pull request for which you want to get information about whether approval rules have been set aside
 (overridden).
 


revisionId
String revisionId

 The system-generated ID of the revision for the pull request. To retrieve the most recent revision ID, use
 GetPullRequest.
 








Class com.amazonaws.services.codecommit.model.GetPullRequestOverrideStateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


overridden
Boolean overridden

 A Boolean value that indicates whether a pull request has had its rules set aside (TRUE) or whether all approval
 rules still apply (FALSE).
 


overrider
String overrider

 The Amazon Resource Name (ARN) of the user or identity that overrode the rules and their requirements for the
 pull request.
 








Class com.amazonaws.services.codecommit.model.GetPullRequestRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request. To get this ID, use ListPullRequests.
 








Class com.amazonaws.services.codecommit.model.GetPullRequestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pullRequest
PullRequest pullRequest

 Information about the specified pull request.
 








Class com.amazonaws.services.codecommit.model.GetRepositoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository to get information about.
 








Class com.amazonaws.services.codecommit.model.GetRepositoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositoryMetadata
RepositoryMetadata repositoryMetadata

 Information about the repository.
 








Class com.amazonaws.services.codecommit.model.GetRepositoryTriggersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository for which the trigger is configured.
 








Class com.amazonaws.services.codecommit.model.GetRepositoryTriggersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurationId
String configurationId

 The system-generated unique ID for the trigger.
 


triggers
List<E> triggers

 The JSON block of configuration information for each trigger.
 








Class com.amazonaws.services.codecommit.model.IdempotencyParameterMismatchException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidActorArnException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidApprovalRuleContentException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidApprovalRuleNameException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidApprovalRuleTemplateContentException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidApprovalRuleTemplateDescriptionException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidApprovalRuleTemplateNameException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidApprovalStateException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidAuthorArnException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidBlobIdException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidBranchNameException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidClientRequestTokenException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidCommentIdException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidCommitException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidCommitIdException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidConflictDetailLevelException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidConflictResolutionException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidConflictResolutionStrategyException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidContinuationTokenException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidDeletionParameterException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidDescriptionException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidDestinationCommitSpecifierException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidEmailException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidFileLocationException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidFileModeException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidFilePositionException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidMaxConflictFilesException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidMaxMergeHunksException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidMaxResultsException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidMergeOptionException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidOrderException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidOverrideStatusException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidParentCommitIdException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidPathException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidPullRequestEventTypeException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidPullRequestIdException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidPullRequestStatusException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidPullRequestStatusUpdateException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidReferenceNameException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidRelativeFileVersionEnumException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidReplacementContentException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidReplacementTypeException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidRepositoryDescriptionException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidRepositoryNameException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerBranchNameException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerCustomDataException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerDestinationArnException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerEventsException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerNameException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerRegionException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidResourceArnException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidRevisionIdException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidRuleContentSha256Exception extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidSortByException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidSourceCommitSpecifierException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidSystemTagUsageException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidTagKeysListException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidTagsMapException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidTargetBranchException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidTargetException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidTargetsException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.InvalidTitleException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.IsBinaryFile extends Object implements Serializable


Serialized Fields


source
Boolean source

 The binary or non-binary status of file in the source of a merge or pull request.
 


destination
Boolean destination

 The binary or non-binary status of a file in the destination of a merge or pull request.
 


base
Boolean base

 The binary or non-binary status of a file in the base of a merge or pull request.
 








Class com.amazonaws.services.codecommit.model.ListApprovalRuleTemplatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 


maxResults
Integer maxResults

 A non-zero, non-negative integer used to limit the number of returned results.
 








Class com.amazonaws.services.codecommit.model.ListApprovalRuleTemplatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvalRuleTemplateNames
List<E> approvalRuleTemplateNames

 The names of all the approval rule templates found in the AWS Region for your AWS account.
 


nextToken
String nextToken

 An enumeration token that allows the operation to batch the next results of the operation.
 








Class com.amazonaws.services.codecommit.model.ListAssociatedApprovalRuleTemplatesForRepositoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository for which you want to list all associated approval rule templates.
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 


maxResults
Integer maxResults

 A non-zero, non-negative integer used to limit the number of returned results.
 








Class com.amazonaws.services.codecommit.model.ListAssociatedApprovalRuleTemplatesForRepositoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvalRuleTemplateNames
List<E> approvalRuleTemplateNames

 The names of all approval rule templates associated with the repository.
 


nextToken
String nextToken

 An enumeration token that allows the operation to batch the next results of the operation.
 








Class com.amazonaws.services.codecommit.model.ListBranchesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository that contains the branches.
 


nextToken
String nextToken

 An enumeration token that allows the operation to batch the results.
 








Class com.amazonaws.services.codecommit.model.ListBranchesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


branches
List<E> branches

 The list of branch names.
 


nextToken
String nextToken

 An enumeration token that returns the batch of the results.
 








Class com.amazonaws.services.codecommit.model.ListPullRequestsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository for which you want to list pull requests.
 


authorArn
String authorArn

 Optional. The Amazon Resource Name (ARN) of the user who created the pull request. If used, this filters the
 results to pull requests created by that user.
 


pullRequestStatus
String pullRequestStatus

 Optional. The status of the pull request. If used, this refines the results to the pull requests that match the
 specified status.
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 


maxResults
Integer maxResults

 A non-zero, non-negative integer used to limit the number of returned results.
 








Class com.amazonaws.services.codecommit.model.ListPullRequestsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pullRequestIds
List<E> pullRequestIds

 The system-generated IDs of the pull requests.
 


nextToken
String nextToken

 An enumeration token that allows the operation to batch the next results of the operation.
 








Class com.amazonaws.services.codecommit.model.ListRepositoriesForApprovalRuleTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


approvalRuleTemplateName
String approvalRuleTemplateName

 The name of the approval rule template for which you want to list repositories that are associated with that
 template.
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 


maxResults
Integer maxResults

 A non-zero, non-negative integer used to limit the number of returned results.
 








Class com.amazonaws.services.codecommit.model.ListRepositoriesForApprovalRuleTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositoryNames
List<E> repositoryNames

 A list of repository names that are associated with the specified approval rule template.
 


nextToken
String nextToken

 An enumeration token that allows the operation to batch the next results of the operation.
 








Class com.amazonaws.services.codecommit.model.ListRepositoriesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for
 list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records
 is retrieved.
 


sortBy
String sortBy

 The criteria used to sort the results of a list repositories operation.
 


order
String order

 The order in which to sort the results of a list repositories operation.
 








Class com.amazonaws.services.codecommit.model.ListRepositoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositories
List<E> repositories

 Lists the repositories called by the list repositories operation.
 


nextToken
String nextToken

 An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for
 list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records
 is retrieved.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 








Class com.amazonaws.services.codecommit.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 A list of tag key and value pairs associated with the specified resource.
 


nextToken
String nextToken

 An enumeration token that allows the operation to batch the next results of the operation.
 








Class com.amazonaws.services.codecommit.model.Location extends Object implements Serializable


Serialized Fields


filePath
String filePath

 The name of the file being compared, including its extension and subdirectory, if any.
 


filePosition
Long filePosition

 The position of a change in a compared file, in line number format.
 


relativeFileVersion
String relativeFileVersion

 In a comparison of commits or a pull request, whether the change is in the before or after of that comparison.
 








Class com.amazonaws.services.codecommit.model.ManualMergeRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MaximumBranchesExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MaximumConflictResolutionEntriesExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MaximumFileContentToLoadExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MaximumFileEntriesExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MaximumItemsToCompareExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MaximumNumberOfApprovalsExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MaximumOpenPullRequestsExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MaximumRepositoryNamesExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MaximumRepositoryTriggersExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MaximumRuleTemplatesAssociatedWithRepositoryException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MergeBranchesByFastForwardRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you want to merge two branches.
 


sourceCommitSpecifier
String sourceCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


destinationCommitSpecifier
String destinationCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


targetBranch
String targetBranch

 The branch where the merge is applied.
 








Class com.amazonaws.services.codecommit.model.MergeBranchesByFastForwardResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commitId
String commitId

 The commit ID of the merge in the destination or target branch.
 


treeId
String treeId

 The tree ID of the merge in the destination or target branch.
 








Class com.amazonaws.services.codecommit.model.MergeBranchesBySquashRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you want to merge two branches.
 


sourceCommitSpecifier
String sourceCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


destinationCommitSpecifier
String destinationCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


targetBranch
String targetBranch

 The branch where the merge is applied.
 


conflictDetailLevel
String conflictDetailLevel

 The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a
 not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is
 considered not mergeable if the same file in both branches has differences on the same line.
 


conflictResolutionStrategy
String conflictResolutionStrategy

 Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions
 of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation
 is successful.
 


authorName
String authorName

 The name of the author who created the commit. This information is used as both the author and committer for the
 commit.
 


email
String email

 The email address of the person merging the branches. This information is used in the commit information for the
 merge.
 


commitMessage
String commitMessage

 The commit message for the merge.
 


keepEmptyFolders
Boolean keepEmptyFolders

 If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders
 empty. If this is specified as true, a .gitkeep file is created for empty folders. The default is false.
 


conflictResolution
ConflictResolution conflictResolution

 If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a
 merge.
 








Class com.amazonaws.services.codecommit.model.MergeBranchesBySquashResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commitId
String commitId

 The commit ID of the merge in the destination or target branch.
 


treeId
String treeId

 The tree ID of the merge in the destination or target branch.
 








Class com.amazonaws.services.codecommit.model.MergeBranchesByThreeWayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you want to merge two branches.
 


sourceCommitSpecifier
String sourceCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


destinationCommitSpecifier
String destinationCommitSpecifier

 The branch, tag, HEAD, or other fully qualified reference used to identify a commit (for example, a branch name
 or a full commit ID).
 


targetBranch
String targetBranch

 The branch where the merge is applied.
 


conflictDetailLevel
String conflictDetailLevel

 The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a
 not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is
 considered not mergeable if the same file in both branches has differences on the same line.
 


conflictResolutionStrategy
String conflictResolutionStrategy

 Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions
 of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation
 is successful.
 


authorName
String authorName

 The name of the author who created the commit. This information is used as both the author and committer for the
 commit.
 


email
String email

 The email address of the person merging the branches. This information is used in the commit information for the
 merge.
 


commitMessage
String commitMessage

 The commit message to include in the commit information for the merge.
 


keepEmptyFolders
Boolean keepEmptyFolders

 If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders
 empty. If true, a .gitkeep file is created for empty folders. The default is false.
 


conflictResolution
ConflictResolution conflictResolution

 If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a
 merge.
 








Class com.amazonaws.services.codecommit.model.MergeBranchesByThreeWayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commitId
String commitId

 The commit ID of the merge in the destination or target branch.
 


treeId
String treeId

 The tree ID of the merge in the destination or target branch.
 








Class com.amazonaws.services.codecommit.model.MergeHunk extends Object implements Serializable


Serialized Fields


isConflict
Boolean isConflict

 A Boolean value indicating whether a combination of hunks contains a conflict. Conflicts occur when the same file
 or the same lines in a file were modified in both the source and destination of a merge or pull request. Valid
 values include true, false, and null. True when the hunk represents a conflict and one or more files contains a
 line conflict. File mode conflicts in a merge do not set this to true.
 


source
MergeHunkDetail source

 Information about the merge hunk in the source of a merge or pull request.
 


destination
MergeHunkDetail destination

 Information about the merge hunk in the destination of a merge or pull request.
 


base
MergeHunkDetail base

 Information about the merge hunk in the base of a merge or pull request.
 








Class com.amazonaws.services.codecommit.model.MergeHunkDetail extends Object implements Serializable


Serialized Fields


startLine
Integer startLine

 The start position of the hunk in the merge result.
 


endLine
Integer endLine

 The end position of the hunk in the merge result.
 


hunkContent
String hunkContent

 The base-64 encoded content of the hunk merged region that might contain a conflict.
 








Class com.amazonaws.services.codecommit.model.MergeMetadata extends Object implements Serializable


Serialized Fields


isMerged
Boolean isMerged

 A Boolean value indicating whether the merge has been made.
 


mergedBy
String mergedBy

 The Amazon Resource Name (ARN) of the user who merged the branches.
 


mergeCommitId
String mergeCommitId

 The commit ID for the merge commit, if any.
 


mergeOption
String mergeOption

 The merge strategy used in the merge.
 








Class com.amazonaws.services.codecommit.model.MergeOperations extends Object implements Serializable


Serialized Fields


source
String source

 The operation (add, modify, or delete) on a file in the source of a merge or pull request.
 


destination
String destination

 The operation on a file in the destination of a merge or pull request.
 








Class com.amazonaws.services.codecommit.model.MergeOptionRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MergePullRequestByFastForwardRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request. To get this ID, use ListPullRequests.
 


repositoryName
String repositoryName

 The name of the repository where the pull request was created.
 


sourceCommitId
String sourceCommitId

 The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you
 want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.
 








Class com.amazonaws.services.codecommit.model.MergePullRequestByFastForwardResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pullRequest
PullRequest pullRequest

 Information about the specified pull request, including the merge.
 








Class com.amazonaws.services.codecommit.model.MergePullRequestBySquashRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request. To get this ID, use ListPullRequests.
 


repositoryName
String repositoryName

 The name of the repository where the pull request was created.
 


sourceCommitId
String sourceCommitId

 The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you
 want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.
 


conflictDetailLevel
String conflictDetailLevel

 The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a
 not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is
 considered not mergeable if the same file in both branches has differences on the same line.
 


conflictResolutionStrategy
String conflictResolutionStrategy

 Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions
 of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation
 is successful.
 


commitMessage
String commitMessage

 The commit message to include in the commit information for the merge.
 


authorName
String authorName

 The name of the author who created the commit. This information is used as both the author and committer for the
 commit.
 


email
String email

 The email address of the person merging the branches. This information is used in the commit information for the
 merge.
 


keepEmptyFolders
Boolean keepEmptyFolders

 If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders
 empty. If true, a .gitkeep file is created for empty folders. The default is false.
 


conflictResolution
ConflictResolution conflictResolution

 If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a
 merge.
 








Class com.amazonaws.services.codecommit.model.MergePullRequestBySquashResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pullRequest
PullRequest pullRequest








Class com.amazonaws.services.codecommit.model.MergePullRequestByThreeWayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request. To get this ID, use ListPullRequests.
 


repositoryName
String repositoryName

 The name of the repository where the pull request was created.
 


sourceCommitId
String sourceCommitId

 The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you
 want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.
 


conflictDetailLevel
String conflictDetailLevel

 The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which returns a
 not-mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict is
 considered not mergeable if the same file in both branches has differences on the same line.
 


conflictResolutionStrategy
String conflictResolutionStrategy

 Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions
 of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation
 is successful.
 


commitMessage
String commitMessage

 The commit message to include in the commit information for the merge.
 


authorName
String authorName

 The name of the author who created the commit. This information is used as both the author and committer for the
 commit.
 


email
String email

 The email address of the person merging the branches. This information is used in the commit information for the
 merge.
 


keepEmptyFolders
Boolean keepEmptyFolders

 If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders
 empty. If true, a .gitkeep file is created for empty folders. The default is false.
 


conflictResolution
ConflictResolution conflictResolution

 If AUTOMERGE is the conflict resolution strategy, a list of inputs to use when resolving conflicts during a
 merge.
 








Class com.amazonaws.services.codecommit.model.MergePullRequestByThreeWayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pullRequest
PullRequest pullRequest








Class com.amazonaws.services.codecommit.model.MultipleConflictResolutionEntriesException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.MultipleRepositoriesInPullRequestException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.NameLengthExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.NoChangeException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.NumberOfRulesExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.NumberOfRuleTemplatesExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ObjectTypes extends Object implements Serializable


Serialized Fields


source
String source

 The type of the object in the source branch.
 


destination
String destination

 The type of the object in the destination branch.
 


base
String base

 The type of the object in the base commit of the merge.
 








Class com.amazonaws.services.codecommit.model.OriginApprovalRuleTemplate extends Object implements Serializable


Serialized Fields


approvalRuleTemplateId
String approvalRuleTemplateId

 The ID of the template that created the approval rule.
 


approvalRuleTemplateName
String approvalRuleTemplateName

 The name of the template that created the approval rule.
 








Class com.amazonaws.services.codecommit.model.OverrideAlreadySetException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.OverridePullRequestApprovalRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request for which you want to override all approval rule requirements. To get
 this information, use GetPullRequest.
 


revisionId
String revisionId

 The system-generated ID of the most recent revision of the pull request. You cannot override approval rules for
 anything but the most recent revision of a pull request. To get the revision ID, use GetPullRequest.
 


overrideStatus
String overrideStatus

 Whether you want to set aside approval rule requirements for the pull request (OVERRIDE) or revoke a previous
 override and apply approval rule requirements (REVOKE). REVOKE status is not stored.
 








Class com.amazonaws.services.codecommit.model.OverridePullRequestApprovalRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codecommit.model.OverrideStatusRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ParentCommitDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ParentCommitIdOutdatedException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ParentCommitIdRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.PathDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.PathRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.PostCommentForComparedCommitRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you want to post a comment on the comparison between commits.
 


beforeCommitId
String beforeCommitId

 To establish the directionality of the comparison, the full commit ID of the before commit. Required for
 commenting on any commit unless that commit is the initial commit.
 


afterCommitId
String afterCommitId

 To establish the directionality of the comparison, the full commit ID of the after commit.
 


location
Location location

 The location of the comparison where you want to comment.
 


content
String content

 The content of the comment you want to make.
 


clientRequestToken
String clientRequestToken

 A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be
 repeated with a changed parameter. If a request is received with the same parameters and a token is included, the
 request returns information about the initial request that used that token.
 








Class com.amazonaws.services.codecommit.model.PostCommentForComparedCommitResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you posted a comment on the comparison between commits.
 


beforeCommitId
String beforeCommitId

 In the directionality you established, the full commit ID of the before commit.
 


afterCommitId
String afterCommitId

 In the directionality you established, the full commit ID of the after commit.
 


beforeBlobId
String beforeBlobId

 In the directionality you established, the blob ID of the before blob.
 


afterBlobId
String afterBlobId

 In the directionality you established, the blob ID of the after blob.
 


location
Location location

 The location of the comment in the comparison between the two commits.
 


comment
Comment comment

 The content of the comment you posted.
 








Class com.amazonaws.services.codecommit.model.PostCommentForPullRequestRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request. To get this ID, use ListPullRequests.
 


repositoryName
String repositoryName

 The name of the repository where you want to post a comment on a pull request.
 


beforeCommitId
String beforeCommitId

 The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull
 request was created.
 


afterCommitId
String afterCommitId

 The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request
 when you post the comment.
 


location
Location location

 The location of the change where you want to post your comment. If no location is provided, the comment is posted
 as a general comment on the pull request difference between the before commit ID and the after commit ID.
 


content
String content

 The content of your comment on the change.
 


clientRequestToken
String clientRequestToken

 A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be
 repeated with a changed parameter. If a request is received with the same parameters and a token is included, the
 request returns information about the initial request that used that token.
 








Class com.amazonaws.services.codecommit.model.PostCommentForPullRequestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you posted a comment on a pull request.
 


pullRequestId
String pullRequestId

 The system-generated ID of the pull request.
 


beforeCommitId
String beforeCommitId

 The full commit ID of the commit in the source branch used to create the pull request, or in the case of an
 updated pull request, the full commit ID of the commit used to update the pull request.
 


afterCommitId
String afterCommitId

 The full commit ID of the commit in the destination branch where the pull request is merged.
 


beforeBlobId
String beforeBlobId

 In the directionality of the pull request, the blob ID of the before blob.
 


afterBlobId
String afterBlobId

 In the directionality of the pull request, the blob ID of the after blob.
 


location
Location location

 The location of the change where you posted your comment.
 


comment
Comment comment

 The content of the comment you posted.
 








Class com.amazonaws.services.codecommit.model.PostCommentReplyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inReplyTo
String inReplyTo

 The system-generated ID of the comment to which you want to reply. To get this ID, use
 GetCommentsForComparedCommit or GetCommentsForPullRequest.
 


clientRequestToken
String clientRequestToken

 A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be
 repeated with a changed parameter. If a request is received with the same parameters and a token is included, the
 request returns information about the initial request that used that token.
 


content
String content

 The contents of your reply to a comment.
 








Class com.amazonaws.services.codecommit.model.PostCommentReplyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


comment
Comment comment

 Information about the reply to a comment.
 








Class com.amazonaws.services.codecommit.model.PullRequest extends Object implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request.
 


title
String title

 The user-defined title of the pull request. This title is displayed in the list of pull requests to other
 repository users.
 


description
String description

 The user-defined description of the pull request. This description can be used to clarify what should be reviewed
 and other details of the request.
 


lastActivityDate
Date lastActivityDate

 The day and time of the last user or system activity on the pull request, in timestamp format.
 


creationDate
Date creationDate

 The date and time the pull request was originally created, in timestamp format.
 


pullRequestStatus
String pullRequestStatus

 The status of the pull request. Pull request status can only change from OPEN to CLOSED
 .
 


authorArn
String authorArn

 The Amazon Resource Name (ARN) of the user who created the pull request.
 


pullRequestTargets
List<E> pullRequestTargets

 The targets of the pull request, including the source branch and destination branch for the pull request.
 


clientRequestToken
String clientRequestToken

 A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be
 repeated with a changed parameter. If a request is received with the same parameters and a token is included, the
 request returns information about the initial request that used that token.
 


revisionId
String revisionId

 The system-generated revision ID for the pull request.
 


approvalRules
List<E> approvalRules

 The approval rules applied to the pull request.
 








Class com.amazonaws.services.codecommit.model.PullRequestAlreadyClosedException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.PullRequestApprovalRulesNotSatisfiedException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.PullRequestCannotBeApprovedByAuthorException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.PullRequestCreatedEventMetadata extends Object implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where the pull request was created.
 


sourceCommitId
String sourceCommitId

 The commit ID on the source branch used when the pull request was created.
 


destinationCommitId
String destinationCommitId

 The commit ID of the tip of the branch specified as the destination branch when the pull request was created.
 


mergeBase
String mergeBase

 The commit ID of the most recent commit that the source branch and the destination branch have in common.
 








Class com.amazonaws.services.codecommit.model.PullRequestDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.PullRequestEvent extends Object implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request.
 


eventDate
Date eventDate

 The day and time of the pull request event, in timestamp format.
 


pullRequestEventType
String pullRequestEventType

 The type of the pull request event (for example, a status change event (PULL_REQUEST_STATUS_CHANGED) or update
 event (PULL_REQUEST_SOURCE_REFERENCE_UPDATED)).
 


actorArn
String actorArn

 The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the
 pull request with more commits or changing the status of a pull request.
 


pullRequestCreatedEventMetadata
PullRequestCreatedEventMetadata pullRequestCreatedEventMetadata

 Information about the source and destination branches for the pull request.
 


pullRequestStatusChangedEventMetadata
PullRequestStatusChangedEventMetadata pullRequestStatusChangedEventMetadata

 Information about the change in status for the pull request event.
 


pullRequestSourceReferenceUpdatedEventMetadata
PullRequestSourceReferenceUpdatedEventMetadata pullRequestSourceReferenceUpdatedEventMetadata

 Information about the updated source branch for the pull request event.
 


pullRequestMergedStateChangedEventMetadata
PullRequestMergedStateChangedEventMetadata pullRequestMergedStateChangedEventMetadata

 Information about the change in mergability state for the pull request event.
 


approvalRuleEventMetadata
ApprovalRuleEventMetadata approvalRuleEventMetadata

 Information about a pull request event.
 


approvalStateChangedEventMetadata
ApprovalStateChangedEventMetadata approvalStateChangedEventMetadata

 Information about an approval state change for a pull request.
 


approvalRuleOverriddenEventMetadata
ApprovalRuleOverriddenEventMetadata approvalRuleOverriddenEventMetadata

 Information about an approval rule override event for a pull request.
 








Class com.amazonaws.services.codecommit.model.PullRequestIdRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.PullRequestMergedStateChangedEventMetadata extends Object implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where the pull request was created.
 


destinationReference
String destinationReference

 The name of the branch that the pull request is merged into.
 


mergeMetadata
MergeMetadata mergeMetadata

 Information about the merge state change event.
 








Class com.amazonaws.services.codecommit.model.PullRequestSourceReferenceUpdatedEventMetadata extends Object implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where the pull request was updated.
 


beforeCommitId
String beforeCommitId

 The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull
 request was updated.
 


afterCommitId
String afterCommitId

 The full commit ID of the commit in the source branch that was the tip of the branch at the time the pull request
 was updated.
 


mergeBase
String mergeBase

 The commit ID of the most recent commit that the source branch and the destination branch have in common.
 








Class com.amazonaws.services.codecommit.model.PullRequestStatusChangedEventMetadata extends Object implements Serializable


Serialized Fields


pullRequestStatus
String pullRequestStatus

 The changed status of the pull request.
 








Class com.amazonaws.services.codecommit.model.PullRequestStatusRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.PullRequestTarget extends Object implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository that contains the pull request source and destination branches.
 


sourceReference
String sourceReference

 The branch of the repository that contains the changes for the pull request. Also known as the source branch.
 


destinationReference
String destinationReference

 The branch of the repository where the pull request changes are merged. Also known as the destination branch.
 


destinationCommit
String destinationCommit

 The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or
 will be merged.
 


sourceCommit
String sourceCommit

 The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is
 updated by a push while the pull request is open, the commit ID changes to reflect the new tip of the branch.
 


mergeBase
String mergeBase

 The commit ID of the most recent commit that the source branch and the destination branch have in common.
 


mergeMetadata
MergeMetadata mergeMetadata

 Returns metadata about the state of the merge, including whether the merge has been made.
 








Class com.amazonaws.services.codecommit.model.PutFileEntry extends Object implements Serializable


Serialized Fields


filePath
String filePath

 The full path to the file in the repository, including the name of the file.
 


fileMode
String fileMode

 The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.
 


fileContent
ByteBuffer fileContent

 The content of the file, if a source file is not specified.
 


sourceFile
SourceFileSpecifier sourceFile

 The name and full path of the file that contains the changes you want to make as part of the commit, if you are
 not providing the file content directly.
 








Class com.amazonaws.services.codecommit.model.PutFileEntryConflictException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.PutFileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you want to add or update the file.
 


branchName
String branchName

 The name of the branch where you want to add or update the file. If this is an empty repository, this branch is
 created.
 


fileContent
ByteBuffer fileContent

 The content of the file, in binary object format.
 


filePath
String filePath

 The name of the file you want to add or update, including the relative path to the file in the repository.
 
 
 
 If the path does not currently exist in the repository, the path is created as part of adding the file.
 
 


fileMode
String fileMode

 The file mode permissions of the blob. Valid file mode permissions are listed here.
 


parentCommitId
String parentCommitId

 The full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty
 repository, no commit ID is required. If this is not an empty repository, a commit ID is required.
 
 
 The commit ID must match the ID of the head commit at the time of the operation. Otherwise, an error occurs, and
 the file is not added or updated.
 


commitMessage
String commitMessage

 A message about why this file was added or updated. Although it is optional, a message makes the commit history
 for your repository more useful.
 


name
String name

 The name of the person adding or updating the file. Although it is optional, a name makes the commit history for
 your repository more useful.
 


email
String email

 An email address for the person adding or updating the file.
 








Class com.amazonaws.services.codecommit.model.PutFileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commitId
String commitId

 The full SHA ID of the commit that contains this file change.
 


blobId
String blobId

 The ID of the blob, which is its SHA-1 pointer.
 


treeId
String treeId

 The full SHA-1 pointer of the tree information for the commit that contains this file change.
 








Class com.amazonaws.services.codecommit.model.PutRepositoryTriggersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository where you want to create or update the trigger.
 


triggers
List<E> triggers

 The JSON block of configuration information for each trigger.
 








Class com.amazonaws.services.codecommit.model.PutRepositoryTriggersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurationId
String configurationId

 The system-generated unique ID for the create or update operation.
 








Class com.amazonaws.services.codecommit.model.ReferenceDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ReferenceNameRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ReferenceTypeNotSupportedException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ReplaceContentEntry extends Object implements Serializable


Serialized Fields


filePath
String filePath

 The path of the conflicting file.
 


replacementType
String replacementType

 The replacement type to use when determining how to resolve the conflict.
 


content
ByteBuffer content

 The base-64 encoded content to use when the replacement type is USE_NEW_CONTENT.
 


fileMode
String fileMode

 The file mode to apply during conflict resoltion.
 








Class com.amazonaws.services.codecommit.model.ReplacementContentRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ReplacementTypeRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RepositoryDoesNotExistException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RepositoryLimitExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RepositoryMetadata extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The ID of the AWS account associated with the repository.
 


repositoryId
String repositoryId

 The ID of the repository.
 


repositoryName
String repositoryName

 The repository's name.
 


repositoryDescription
String repositoryDescription

 A comment or description about the repository.
 


defaultBranch
String defaultBranch

 The repository's default branch name.
 


lastModifiedDate
Date lastModifiedDate

 The date and time the repository was last modified, in timestamp format.
 


creationDate
Date creationDate

 The date and time the repository was created, in timestamp format.
 


cloneUrlHttp
String cloneUrlHttp

 The URL to use for cloning the repository over HTTPS.
 


cloneUrlSsh
String cloneUrlSsh

 The URL to use for cloning the repository over SSH.
 


arn
String arn

 The Amazon Resource Name (ARN) of the repository.
 








Class com.amazonaws.services.codecommit.model.RepositoryNameExistsException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RepositoryNameIdPair extends Object implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name associated with the repository.
 


repositoryId
String repositoryId

 The ID associated with the repository.
 








Class com.amazonaws.services.codecommit.model.RepositoryNameRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RepositoryNamesRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RepositoryNotAssociatedWithPullRequestException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RepositoryTrigger extends Object implements Serializable


Serialized Fields


name
String name

 The name of the trigger.
 


destinationArn
String destinationArn

 The ARN of the resource that is the target for a trigger (for example, the ARN of a topic in Amazon SNS).
 


customData
String customData

 Any custom data associated with the trigger to be included in the information sent to the target of the trigger.
 


branches
List<E> branches

 The branches to be included in the trigger configuration. If you specify an empty array, the trigger applies to
 all branches.
 
 
 
 Although no content is required in the array, you must include the array itself.
 
 


events
List<E> events

 The repository events that cause the trigger to run actions in another service, such as sending a notification
 through Amazon SNS.
 
 
 
 The valid value "all" cannot be used with any other values.
 
 








Class com.amazonaws.services.codecommit.model.RepositoryTriggerBranchNameListRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RepositoryTriggerDestinationArnRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RepositoryTriggerEventsListRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RepositoryTriggerExecutionFailure extends Object implements Serializable


Serialized Fields


trigger
String trigger

 The name of the trigger that did not run.
 


failureMessage
String failureMessage

 Message information about the trigger that did not run.
 








Class com.amazonaws.services.codecommit.model.RepositoryTriggerNameRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RepositoryTriggersListRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.ResourceArnRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RestrictedSourceFileException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RevisionIdRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.RevisionNotCurrentException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.SameFileContentException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.SamePathRequestException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.SetFileModeEntry extends Object implements Serializable


Serialized Fields


filePath
String filePath

 The full path to the file, including the name of the file.
 


fileMode
String fileMode

 The file mode for the file.
 








Class com.amazonaws.services.codecommit.model.SourceAndDestinationAreSameException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.SourceFileOrContentRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.SourceFileSpecifier extends Object implements Serializable


Serialized Fields


filePath
String filePath

 The full path to the file, including the name of the file.
 


isMove
Boolean isMove

 Whether to remove the source file from the parent commit.
 








Class com.amazonaws.services.codecommit.model.SubModule extends Object implements Serializable


Serialized Fields


commitId
String commitId

 The commit ID that contains the reference to the submodule.
 


absolutePath
String absolutePath

 The fully qualified path to the folder that contains the reference to the submodule.
 


relativePath
String relativePath

 The relative path of the submodule from the folder where the query originated.
 








Class com.amazonaws.services.codecommit.model.SymbolicLink extends Object implements Serializable


Serialized Fields


blobId
String blobId

 The blob ID that contains the information about the symbolic link.
 


absolutePath
String absolutePath

 The fully qualified path to the folder that contains the symbolic link.
 


relativePath
String relativePath

 The relative path of the symbolic link from the folder where the query originated.
 


fileMode
String fileMode

 The file mode permissions of the blob that cotains information about the symbolic link.
 








Class com.amazonaws.services.codecommit.model.TagKeysListRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.TagPolicyException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.
 


tags
Map<K,V> tags

 The key-value pair to use when tagging this repository.
 








Class com.amazonaws.services.codecommit.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codecommit.model.TagsMapRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.Target extends Object implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository that contains the pull request.
 


sourceReference
String sourceReference

 The branch of the repository that contains the changes for the pull request. Also known as the source branch.
 


destinationReference
String destinationReference

 The branch of the repository where the pull request changes are merged. Also known as the destination branch.
 








Class com.amazonaws.services.codecommit.model.TargetRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.TargetsRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.TestRepositoryTriggersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository in which to test the triggers.
 


triggers
List<E> triggers

 The list of triggers to test.
 








Class com.amazonaws.services.codecommit.model.TestRepositoryTriggersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successfulExecutions
List<E> successfulExecutions

 The list of triggers that were successfully tested. This list provides the names of the triggers that were
 successfully tested, separated by commas.
 


failedExecutions
List<E> failedExecutions

 The list of triggers that were not tested. This list provides the names of the triggers that could not be tested,
 separated by commas.
 








Class com.amazonaws.services.codecommit.model.TipOfSourceReferenceIsDifferentException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.TipsDivergenceExceededException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.TitleRequiredException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.TooManyTagsException extends AWSCodeCommitException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codecommit.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource to which you want to remove tags.
 


tagKeys
List<E> tagKeys

 The tag key for each tag that you want to remove from the resource.
 








Class com.amazonaws.services.codecommit.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codecommit.model.UpdateApprovalRuleTemplateContentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


approvalRuleTemplateName
String approvalRuleTemplateName

 The name of the approval rule template where you want to update the content of the rule.
 


newRuleContent
String newRuleContent

 The content that replaces the existing content of the rule. Content statements must be complete. You cannot
 provide only the changes.
 


existingRuleContentSha256
String existingRuleContentSha256

 The SHA-256 hash signature for the content of the approval rule. You can retrieve this information by using
 GetPullRequest.
 








Class com.amazonaws.services.codecommit.model.UpdateApprovalRuleTemplateContentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvalRuleTemplate
ApprovalRuleTemplate approvalRuleTemplate








Class com.amazonaws.services.codecommit.model.UpdateApprovalRuleTemplateDescriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


approvalRuleTemplateName
String approvalRuleTemplateName

 The name of the template for which you want to update the description.
 


approvalRuleTemplateDescription
String approvalRuleTemplateDescription

 The updated description of the approval rule template.
 








Class com.amazonaws.services.codecommit.model.UpdateApprovalRuleTemplateDescriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvalRuleTemplate
ApprovalRuleTemplate approvalRuleTemplate

 The structure and content of the updated approval rule template.
 








Class com.amazonaws.services.codecommit.model.UpdateApprovalRuleTemplateNameRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


oldApprovalRuleTemplateName
String oldApprovalRuleTemplateName

 The current name of the approval rule template.
 


newApprovalRuleTemplateName
String newApprovalRuleTemplateName

 The new name you want to apply to the approval rule template.
 








Class com.amazonaws.services.codecommit.model.UpdateApprovalRuleTemplateNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvalRuleTemplate
ApprovalRuleTemplate approvalRuleTemplate

 The structure and content of the updated approval rule template.
 








Class com.amazonaws.services.codecommit.model.UpdateCommentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


commentId
String commentId

 The system-generated ID of the comment you want to update. To get this ID, use
 GetCommentsForComparedCommit or GetCommentsForPullRequest.
 


content
String content

 The updated content to replace the existing content of the comment.
 








Class com.amazonaws.services.codecommit.model.UpdateCommentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


comment
Comment comment

 Information about the updated comment.
 








Class com.amazonaws.services.codecommit.model.UpdateDefaultBranchRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository to set or change the default branch for.
 


defaultBranchName
String defaultBranchName

 The name of the branch to set as the default.
 








Class com.amazonaws.services.codecommit.model.UpdateDefaultBranchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codecommit.model.UpdatePullRequestApprovalRuleContentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request.
 


approvalRuleName
String approvalRuleName

 The name of the approval rule you want to update.
 


existingRuleContentSha256
String existingRuleContentSha256

 The SHA-256 hash signature for the content of the approval rule. You can retrieve this information by using
 GetPullRequest.
 


newRuleContent
String newRuleContent

 The updated content for the approval rule.
 
 
 
 When you update the content of the approval rule, you can specify approvers in an approval pool in one of two
 ways:
 
 
 
 
 CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM
 users and federated access users whose name matches the provided resource name. This is a very powerful option
 that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and
 Mary_Major, all of the following are counted as approvals coming from that user:
 
 
 
 
 An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)
 
 
 
 
 A federated user identified in IAM as Mary_Major
 (arn:aws:sts::123456789012:federated-user/Mary_Major)
 
 
 
 
 This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role
 session name of Mary_Major
 (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard
 (*Mary_Major).
 
 
 
 
 Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of
 the IAM user or role.
 
 
 
 
 For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the
 IAM User Guide.
 
 








Class com.amazonaws.services.codecommit.model.UpdatePullRequestApprovalRuleContentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvalRule
ApprovalRule approvalRule

 Information about the updated approval rule.
 








Class com.amazonaws.services.codecommit.model.UpdatePullRequestApprovalStateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request.
 


revisionId
String revisionId

 The system-generated ID of the revision.
 


approvalState
String approvalState

 The approval state to associate with the user on the pull request.
 








Class com.amazonaws.services.codecommit.model.UpdatePullRequestApprovalStateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codecommit.model.UpdatePullRequestDescriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request. To get this ID, use ListPullRequests.
 


description
String description

 The updated content of the description for the pull request. This content replaces the existing description.
 








Class com.amazonaws.services.codecommit.model.UpdatePullRequestDescriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pullRequest
PullRequest pullRequest

 Information about the updated pull request.
 








Class com.amazonaws.services.codecommit.model.UpdatePullRequestStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request. To get this ID, use ListPullRequests.
 


pullRequestStatus
String pullRequestStatus

 The status of the pull request. The only valid operations are to update the status from OPEN to
 OPEN, OPEN to CLOSED or from CLOSED to CLOSED.
 








Class com.amazonaws.services.codecommit.model.UpdatePullRequestStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pullRequest
PullRequest pullRequest

 Information about the pull request.
 








Class com.amazonaws.services.codecommit.model.UpdatePullRequestTitleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pullRequestId
String pullRequestId

 The system-generated ID of the pull request. To get this ID, use ListPullRequests.
 


title
String title

 The updated title of the pull request. This replaces the existing title.
 








Class com.amazonaws.services.codecommit.model.UpdatePullRequestTitleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pullRequest
PullRequest pullRequest

 Information about the updated pull request.
 








Class com.amazonaws.services.codecommit.model.UpdateRepositoryDescriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repositoryName
String repositoryName

 The name of the repository to set or change the comment or description for.
 


repositoryDescription
String repositoryDescription

 The new comment or description for the specified repository. Repository descriptions are limited to 1,000
 characters.
 








Class com.amazonaws.services.codecommit.model.UpdateRepositoryDescriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codecommit.model.UpdateRepositoryNameRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


oldName
String oldName

 The current name of the repository.
 


newName
String newName

 The new name for the repository.
 








Class com.amazonaws.services.codecommit.model.UpdateRepositoryNameResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codecommit.model.UserInfo extends Object implements Serializable


Serialized Fields


name
String name

 The name of the user who made the specified commit.
 


email
String email

 The email address associated with the user who made the commit, if any.
 


date
String date

 The date when the specified commit was commited, in timestamp format with GMT offset.
 








Package com.amazonaws.services.codedeploy.model




Class com.amazonaws.services.codedeploy.model.AddTagsToOnPremisesInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 The tag key-value pairs to add to the on-premises instances.
 
 
 Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed.
 


instanceNames
SdkInternalList<T> instanceNames

 The names of the on-premises instances to which to add tags.
 








Class com.amazonaws.services.codedeploy.model.AddTagsToOnPremisesInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codedeploy.model.Alarm extends Object implements Serializable


Serialized Fields


name
String name

 The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of
 alarms.
 








Class com.amazonaws.services.codedeploy.model.AlarmConfiguration extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Indicates whether the alarm configuration is enabled.
 


ignorePollAlarmFailure
Boolean ignorePollAlarmFailure

 Indicates whether a deployment should continue if information about the current state of alarms cannot be
 retrieved from Amazon CloudWatch. The default value is false.
 
 
 
 
 true: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.
 
 
 
 
 false: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.
 
 
 


alarms
SdkInternalList<T> alarms

 A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group.
 








Class com.amazonaws.services.codedeploy.model.AlarmsLimitExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.AmazonCodeDeployException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.ApplicationAlreadyExistsException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.ApplicationInfo extends Object implements Serializable


Serialized Fields


applicationId
String applicationId

 The application ID.
 


applicationName
String applicationName

 The application name.
 


createTime
Date createTime

 The time at which the application was created.
 


linkedToGitHub
Boolean linkedToGitHub

 True if the user has authenticated with GitHub for the specified application. Otherwise, false.
 


gitHubAccountName
String gitHubAccountName

 The name for a connection to a GitHub account.
 


computePlatform
String computePlatform

 The destination platform type for deployment of the application (Lambda or Server).
 








Class com.amazonaws.services.codedeploy.model.ApplicationLimitExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.AppSpecContent extends Object implements Serializable


Serialized Fields


content
String content

 The YAML-formatted or JSON-formatted revision string.
 
 
 For an AWS Lambda deployment, the content includes a Lambda function name, the alias for its original version,
 and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda
 function to the replacement version.
 
 
 For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves
 traffic to the container, and more.
 
 
 For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as
 BeforeInstall, during a deployment.
 


sha256
String sha256

 The SHA256 hash value of the revision content.
 








Class com.amazonaws.services.codedeploy.model.ArnNotSupportedException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.AutoRollbackConfiguration extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Indicates whether a defined automatic rollback configuration is currently enabled.
 


events
SdkInternalList<T> events

 The event type or types that trigger a rollback.
 








Class com.amazonaws.services.codedeploy.model.AutoScalingGroup extends Object implements Serializable


Serialized Fields


name
String name

 The Auto Scaling group name.
 


hook
String hook

 An Auto Scaling lifecycle event hook name.
 








Class com.amazonaws.services.codedeploy.model.BatchGetApplicationRevisionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an AWS CodeDeploy application about which to get revision information.
 


revisions
SdkInternalList<T> revisions

 An array of RevisionLocation objects that specify information to get about the application
 revisions, including type and location. The maximum number of RevisionLocation objects you can
 specify is 25.
 








Class com.amazonaws.services.codedeploy.model.BatchGetApplicationRevisionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application that corresponds to the revisions.
 


errorMessage
String errorMessage

 Information about errors that might have occurred during the API call.
 


revisions
SdkInternalList<T> revisions

 Additional information about the revisions, including the type and location.
 








Class com.amazonaws.services.codedeploy.model.BatchGetApplicationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationNames
SdkInternalList<T> applicationNames

 A list of application names separated by spaces. The maximum number of application names you can specify is 25.
 








Class com.amazonaws.services.codedeploy.model.BatchGetApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationsInfo
SdkInternalList<T> applicationsInfo

 Information about the applications.
 








Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
 


deploymentGroupNames
SdkInternalList<T> deploymentGroupNames

 The names of the deployment groups.
 








Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentGroupsInfo
SdkInternalList<T> deploymentGroupsInfo

 Information about the deployment groups.
 


errorMessage
String errorMessage

 Information about errors that might have occurred during the API call.
 








Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment.
 


instanceIds
SdkInternalList<T> instanceIds

 The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.
 








Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instancesSummary
SdkInternalList<T> instancesSummary

 Information about the instance.
 


errorMessage
String errorMessage

 Information about errors that might have occurred during the API call.
 








Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentIds
SdkInternalList<T> deploymentIds

 A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.
 








Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentsInfo
SdkInternalList<T> deploymentsInfo

 Information about the deployments.
 








Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentTargetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment.
 


targetIds
SdkInternalList<T> targetIds

 The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the
 targets and their formats. The maximum number of deployment target IDs you can specify is 25.
 
 
 
 
 For deployments that use the EC2/On-premises compute platform, the target IDs are EC2 or on-premises instances
 IDs, and their target type is instanceTarget.
 
 
 
 
 For deployments that use the AWS Lambda compute platform, the target IDs are the names of Lambda functions, and
 their target type is instanceTarget.
 
 
 
 
 For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and
 services specified using the format <clustername>:<servicename>. Their target type is
 ecsTarget.
 
 
 








Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentTargets
SdkInternalList<T> deploymentTargets

 A list of target objects for a deployment. Each target object contains details about the target, such as its
 status and lifecycle events. The type of the target objects depends on the deployment' compute platform.
 
 
 
 
 EC2/On-premises: Each target object is an EC2 or on-premises instance.
 
 
 
 
 AWS Lambda: The target object is a specific version of an AWS Lambda function.
 
 
 
 
 Amazon ECS: The target object is an Amazon ECS service.
 
 
 








Class com.amazonaws.services.codedeploy.model.BatchGetOnPremisesInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceNames
SdkInternalList<T> instanceNames

 The names of the on-premises instances about which to get information. The maximum number of instance names you
 can specify is 25.
 








Class com.amazonaws.services.codedeploy.model.BatchGetOnPremisesInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceInfos
SdkInternalList<T> instanceInfos

 Information about the on-premises instances.
 








Class com.amazonaws.services.codedeploy.model.BatchLimitExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.BlueGreenDeploymentConfiguration extends Object implements Serializable


Serialized Fields


terminateBlueInstancesOnDeploymentSuccess
BlueInstanceTerminationOption terminateBlueInstancesOnDeploymentSuccess

 Information about whether to terminate instances in the original fleet during a blue/green deployment.
 


deploymentReadyOption
DeploymentReadyOption deploymentReadyOption

 Information about the action to take when newly provisioned instances are ready to receive traffic in a
 blue/green deployment.
 


greenFleetProvisioningOption
GreenFleetProvisioningOption greenFleetProvisioningOption

 Information about how instances are provisioned for a replacement environment in a blue/green deployment.
 








Class com.amazonaws.services.codedeploy.model.BlueInstanceTerminationOption extends Object implements Serializable


Serialized Fields


action
String action

 The action to take on instances in the original environment after a successful blue/green deployment.
 
 
 
 
 TERMINATE: Instances are terminated after a specified wait time.
 
 
 
 
 KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the
 deployment group.
 
 
 


terminationWaitTimeInMinutes
Integer terminationWaitTimeInMinutes

 For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before
 terminating instances from the original environment.
 
 
 For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an
 Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task
 set.
 
 
 The maximum setting is 2880 minutes (2 days).
 








Class com.amazonaws.services.codedeploy.model.BucketNameFilterRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.ContinueDeploymentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement
 environment.
 


deploymentWaitType
String deploymentWaitType

 The status of the deployment's waiting period. READY_WAIT indicates the deployment is ready to start shifting
 traffic. TERMINATION_WAIT indicates the traffic is shifted, but the original target is not terminated.
 








Class com.amazonaws.services.codedeploy.model.ContinueDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codedeploy.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application. This name must be unique with the applicable IAM user or AWS account.
 


computePlatform
String computePlatform

 The destination platform type for the deployment (Lambda, Server, or ECS).
 


tags
SdkInternalList<T> tags

 The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag
 consists of a key and an optional value, both of which you define.
 








Class com.amazonaws.services.codedeploy.model.CreateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationId
String applicationId

 A unique application ID.
 








Class com.amazonaws.services.codedeploy.model.CreateDeploymentConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentConfigName
String deploymentConfigName

 The name of the deployment configuration to create.
 


minimumHealthyHosts
MinimumHealthyHosts minimumHealthyHosts

 The minimum number of healthy instances that should be available at any time during the deployment. There are two
 parameters expected in the input: type and value.
 
 
 The type parameter takes either of the following values:
 
 
 
 
 HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.
 
 
 
 
 FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the
 total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS
 CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances.
 
 
 
 
 The value parameter takes an integer.
 
 
 For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.
 


trafficRoutingConfig
TrafficRoutingConfig trafficRoutingConfig

 The configuration that specifies how the deployment traffic is routed.
 


computePlatform
String computePlatform

 The destination platform type for the deployment (Lambda, Server, or ECS).
 








Class com.amazonaws.services.codedeploy.model.CreateDeploymentConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentConfigId
String deploymentConfigId

 A unique deployment configuration ID.
 








Class com.amazonaws.services.codedeploy.model.CreateDeploymentGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
 


deploymentGroupName
String deploymentGroupName

 The name of a new deployment group for the specified application.
 


deploymentConfigName
String deploymentConfigName

 If specified, the deployment configuration name can be either one of the predefined configurations provided with
 AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment
 configuration operation.
 
 
 CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't
 specified for the deployment or deployment group.
 
 
 For more information about the predefined deployment configurations in AWS CodeDeploy, see Working with
 Deployment Groups in AWS CodeDeploy in the AWS CodeDeploy User Guide.
 


ec2TagFilters
SdkInternalList<T> ec2TagFilters

 The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified
 tags. Cannot be used in the same call as ec2TagSet.
 


onPremisesInstanceTagFilters
SdkInternalList<T> onPremisesInstanceTagFilters

 The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of
 the specified tags. Cannot be used in the same call as OnPremisesTagSet.
 


autoScalingGroups
SdkInternalList<T> autoScalingGroups

 A list of associated Amazon EC2 Auto Scaling groups.
 


serviceRoleArn
String serviceRoleArn

 A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
 


triggerConfigurations
SdkInternalList<T> triggerConfigurations

 Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an AWS
 CodeDeploy Event in the AWS CodeDeploy User Guide.
 


alarmConfiguration
AlarmConfiguration alarmConfiguration

 Information to add about Amazon CloudWatch alarms when the deployment group is created.
 


autoRollbackConfiguration
AutoRollbackConfiguration autoRollbackConfiguration

 Configuration information for an automatic rollback that is added when a deployment group is created.
 


deploymentStyle
DeploymentStyle deploymentStyle

 Information about the type of deployment, in-place or blue/green, that you want to run and whether to route
 deployment traffic behind a load balancer.
 


blueGreenDeploymentConfiguration
BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration

 Information about blue/green deployment options for a deployment group.
 


loadBalancerInfo
LoadBalancerInfo loadBalancerInfo

 Information about the load balancer used in a deployment.
 


ec2TagSet
EC2TagSet ec2TagSet

 Information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances
 identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.
 


ecsServices
SdkInternalList<T> ecsServices

 The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the
 Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name
 pair using the format <clustername>:<servicename>.
 


onPremisesTagSet
OnPremisesTagSet onPremisesTagSet

 Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises
 instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.
 


tags
SdkInternalList<T> tags

 The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag
 consists of a key and an optional value, both of which you define.
 








Class com.amazonaws.services.codedeploy.model.CreateDeploymentGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentGroupId
String deploymentGroupId

 A unique deployment group ID.
 








Class com.amazonaws.services.codedeploy.model.CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
 


deploymentGroupName
String deploymentGroupName

 The name of the deployment group.
 


revision
RevisionLocation revision

 The type and location of the revision to deploy.
 


deploymentConfigName
String deploymentConfigName

 The name of a deployment configuration associated with the IAM user or AWS account.
 
 
 If not specified, the value configured in the deployment group is used as the default. If the deployment group
 does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is used by default.
 


description
String description

 A comment about the deployment.
 


ignoreApplicationStopFailures
Boolean ignoreApplicationStopFailures

 If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an
 instance fails, then the deployment continues to the next deployment lifecycle event. For example, if
 ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment
 continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.
 
 
 If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment
 fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not
 less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.
 
 
 During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic,
 and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run
 from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run
 successfully, the deployment can fail.
 
 
 If the cause of the failure is a script from the last successful deployment that will never run successfully,
 create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop,
 BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.
 


targetInstances
TargetInstances targetInstances

 Information about the instances that belong to the replacement environment in a blue/green deployment.
 


autoRollbackConfiguration
AutoRollbackConfiguration autoRollbackConfiguration

 Configuration information for an automatic rollback that is added when a deployment is created.
 


updateOutdatedInstancesOnly
Boolean updateOutdatedInstancesOnly

 Indicates whether to deploy to all instances or only to instances that are not running the latest application
 revision.
 


fileExistsBehavior
String fileExistsBehavior

 Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't
 part of the previous successful deployment.
 
 
 The fileExistsBehavior parameter takes any of the following values:
 
 
 
 
 DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
 
 
 
 
 OVERWRITE: The version of the file from the application revision currently being deployed replaces the version
 already on the instance.
 
 
 
 
 RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
 
 
 








Class com.amazonaws.services.codedeploy.model.CreateDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment.
 








Class com.amazonaws.services.codedeploy.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
 








Class com.amazonaws.services.codedeploy.model.DeleteApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codedeploy.model.DeleteDeploymentConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentConfigName
String deploymentConfigName

 The name of a deployment configuration associated with the IAM user or AWS account.
 








Class com.amazonaws.services.codedeploy.model.DeleteDeploymentConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codedeploy.model.DeleteDeploymentGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
 


deploymentGroupName
String deploymentGroupName

 The name of a deployment group for the specified application.
 








Class com.amazonaws.services.codedeploy.model.DeleteDeploymentGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hooksNotCleanedUp
SdkInternalList<T> hooksNotCleanedUp

 If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group,
 AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2
 instances in the Auto Scaling group. If the output contains data, AWS CodeDeploy could not remove some Auto
 Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.
 








Class com.amazonaws.services.codedeploy.model.DeleteGitHubAccountTokenRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tokenName
String tokenName

 The name of the GitHub account connection to delete.
 








Class com.amazonaws.services.codedeploy.model.DeleteGitHubAccountTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tokenName
String tokenName

 The name of the GitHub account connection that was deleted.
 








Class com.amazonaws.services.codedeploy.model.DeploymentAlreadyCompletedException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentConfigAlreadyExistsException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentConfigDoesNotExistException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentConfigInfo extends Object implements Serializable


Serialized Fields


deploymentConfigId
String deploymentConfigId

 The deployment configuration ID.
 


deploymentConfigName
String deploymentConfigName

 The deployment configuration name.
 


minimumHealthyHosts
MinimumHealthyHosts minimumHealthyHosts

 Information about the number or percentage of minimum healthy instance.
 


createTime
Date createTime

 The time at which the deployment configuration was created.
 


computePlatform
String computePlatform

 The destination platform type for the deployment (Lambda, Server, or ECS).
 


trafficRoutingConfig
TrafficRoutingConfig trafficRoutingConfig

 The configuration that specifies how the deployment traffic is routed. Only deployments with a Lambda compute
 platform can specify this.
 








Class com.amazonaws.services.codedeploy.model.DeploymentConfigInUseException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentConfigLimitExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentConfigNameRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentDoesNotExistException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentGroupAlreadyExistsException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentGroupDoesNotExistException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentGroupInfo extends Object implements Serializable


Serialized Fields


applicationName
String applicationName

 The application name.
 


deploymentGroupId
String deploymentGroupId

 The deployment group ID.
 


deploymentGroupName
String deploymentGroupName

 The deployment group name.
 


deploymentConfigName
String deploymentConfigName

 The deployment configuration name.
 


ec2TagFilters
SdkInternalList<T> ec2TagFilters

 The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified
 tags.
 


onPremisesInstanceTagFilters
SdkInternalList<T> onPremisesInstanceTagFilters

 The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of
 the specified tags.
 


autoScalingGroups
SdkInternalList<T> autoScalingGroups

 A list of associated Auto Scaling groups.
 


serviceRoleArn
String serviceRoleArn

 A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your
 behalf. For more information, see Create a
 Service Role for AWS CodeDeploy in the AWS CodeDeploy User Guide.
 


targetRevision
RevisionLocation targetRevision

 Information about the deployment group's target revision, including type and location.
 


triggerConfigurations
SdkInternalList<T> triggerConfigurations

 Information about triggers associated with the deployment group.
 


alarmConfiguration
AlarmConfiguration alarmConfiguration

 A list of alarms associated with the deployment group.
 


autoRollbackConfiguration
AutoRollbackConfiguration autoRollbackConfiguration

 Information about the automatic rollback configuration associated with the deployment group.
 


deploymentStyle
DeploymentStyle deploymentStyle

 Information about the type of deployment, either in-place or blue/green, you want to run and whether to route
 deployment traffic behind a load balancer.
 


blueGreenDeploymentConfiguration
BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration

 Information about blue/green deployment options for a deployment group.
 


loadBalancerInfo
LoadBalancerInfo loadBalancerInfo

 Information about the load balancer to use in a deployment.
 


lastSuccessfulDeployment
LastDeploymentInfo lastSuccessfulDeployment

 Information about the most recent successful deployment to the deployment group.
 


lastAttemptedDeployment
LastDeploymentInfo lastAttemptedDeployment

 Information about the most recent attempted deployment to the deployment group.
 


ec2TagSet
EC2TagSet ec2TagSet

 Information about groups of tags applied to an EC2 instance. The deployment group includes only EC2 instances
 identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.
 


onPremisesTagSet
OnPremisesTagSet onPremisesTagSet

 Information about groups of tags applied to an on-premises instance. The deployment group includes only
 on-premises instances identified by all the tag groups. Cannot be used in the same call as
 onPremisesInstanceTagFilters.
 


computePlatform
String computePlatform

 The destination platform type for the deployment (Lambda, Server, or ECS).
 


ecsServices
SdkInternalList<T> ecsServices

 The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the
 Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name
 pair using the format <clustername>:<servicename>.
 








Class com.amazonaws.services.codedeploy.model.DeploymentGroupLimitExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentGroupNameRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentIdRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentInfo extends Object implements Serializable


Serialized Fields


applicationName
String applicationName

 The application name.
 


deploymentGroupName
String deploymentGroupName

 The deployment group name.
 


deploymentConfigName
String deploymentConfigName

 The deployment configuration name.
 


deploymentId
String deploymentId

 The unique ID of a deployment.
 


previousRevision
RevisionLocation previousRevision

 Information about the application revision that was deployed to the deployment group before the most recent
 successful deployment.
 


revision
RevisionLocation revision

 Information about the location of stored application artifacts and the service from which to retrieve them.
 


status
String status

 The current state of the deployment as a whole.
 


errorInformation
ErrorInformation errorInformation

 Information about any error associated with this deployment.
 


createTime
Date createTime

 A timestamp that indicates when the deployment was created.
 


startTime
Date startTime

 A timestamp that indicates when the deployment was deployed to the deployment group.
 
 
 In some cases, the reported value of the start time might be later than the complete time. This is due to
 differences in the clock settings of backend servers that participate in the deployment process.
 


completeTime
Date completeTime

 A timestamp that indicates when the deployment was complete.
 


deploymentOverview
DeploymentOverview deploymentOverview

 A summary of the deployment status of the instances in the deployment.
 


description
String description

 A comment about the deployment.
 


creator
String creator

 The means by which the deployment was created:
 
 
 
 
 user: A user created the deployment.
 
 
 
 
 autoscaling: Amazon EC2 Auto Scaling created the deployment.
 
 
 
 
 codeDeployRollback: A rollback process created the deployment.
 
 
 


ignoreApplicationStopFailures
Boolean ignoreApplicationStopFailures

 If true, then if an ApplicationStop, BeforeBlockTraffic, or
 AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to
 the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues
 with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with
 BlockTraffic. If AfterBlockTraffic fails, the deployment continues with
 ApplicationStop.
 
 
 If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment
 fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not
 less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.
 
 
 During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop,
 BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous
 successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of
 these scripts contains an error and does not run successfully, the deployment can fail.
 
 
 If the cause of the failure is a script from the last successful deployment that will never run successfully,
 create a new deployment and use ignoreApplicationStopFailures to specify that the
 ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should
 be ignored.
 


autoRollbackConfiguration
AutoRollbackConfiguration autoRollbackConfiguration

 Information about the automatic rollback configuration associated with the deployment.
 


updateOutdatedInstancesOnly
Boolean updateOutdatedInstancesOnly

 Indicates whether only instances that are not running the latest application revision are to be deployed to.
 


rollbackInfo
RollbackInfo rollbackInfo

 Information about a deployment rollback.
 


deploymentStyle
DeploymentStyle deploymentStyle

 Information about the type of deployment, either in-place or blue/green, you want to run and whether to route
 deployment traffic behind a load balancer.
 


targetInstances
TargetInstances targetInstances

 Information about the instances that belong to the replacement environment in a blue/green deployment.
 


instanceTerminationWaitTimeStarted
Boolean instanceTerminationWaitTimeStarted

 Indicates whether the wait period set for the termination of instances in the original environment has started.
 Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period
 starts.
 


blueGreenDeploymentConfiguration
BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration

 Information about blue/green deployment options for this deployment.
 


loadBalancerInfo
LoadBalancerInfo loadBalancerInfo

 Information about the load balancer used in the deployment.
 


additionalDeploymentStatusInfo
String additionalDeploymentStatusInfo

 Provides information about the results of a deployment, such as whether instances in the original environment in
 a blue/green deployment were not terminated.
 


fileExistsBehavior
String fileExistsBehavior

 Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't
 part of the previous successful deployment.
 
 
 
 
 DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
 
 
 
 
 OVERWRITE: The version of the file from the application revision currently being deployed replaces the version
 already on the instance.
 
 
 
 
 RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.
 
 
 


deploymentStatusMessages
SdkInternalList<T> deploymentStatusMessages

 Messages that contain information about the status of a deployment.
 


computePlatform
String computePlatform

 The destination platform type for the deployment (Lambda, Server, or ECS).
 








Class com.amazonaws.services.codedeploy.model.DeploymentIsNotInReadyStateException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentLimitExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentNotStartedException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentOverview extends Object implements Serializable


Serialized Fields


pending
Long pending

 The number of instances in the deployment in a pending state.
 


inProgress
Long inProgress

 The number of instances in which the deployment is in progress.
 


succeeded
Long succeeded

 The number of instances in the deployment to which revisions have been successfully deployed.
 


failed
Long failed

 The number of instances in the deployment in a failed state.
 


skipped
Long skipped

 The number of instances in the deployment in a skipped state.
 


ready
Long ready

 The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.
 








Class com.amazonaws.services.codedeploy.model.DeploymentReadyOption extends Object implements Serializable


Serialized Fields


actionOnTimeout
String actionOnTimeout

 Information about when to reroute traffic from an original environment to a replacement environment in a
 blue/green deployment.
 
 
 
 
 CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision
 is installed on the instances in the replacement environment.
 
 
 
 
 STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using
 ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the
 deployment status is changed to Stopped.
 
 
 


waitTimeInMinutes
Integer waitTimeInMinutes

 The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is
 not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout
 








Class com.amazonaws.services.codedeploy.model.DeploymentStyle extends Object implements Serializable


Serialized Fields


deploymentType
String deploymentType

 Indicates whether to run an in-place deployment or a blue/green deployment.
 


deploymentOption
String deploymentOption

 Indicates whether to route deployment traffic behind a load balancer.
 








Class com.amazonaws.services.codedeploy.model.DeploymentTarget extends Object implements Serializable


Serialized Fields


deploymentTargetType
String deploymentTargetType

 The deployment type that is specific to the deployment's compute platform.
 


instanceTarget
InstanceTarget instanceTarget

 Information about the target for a deployment that uses the EC2/On-premises compute platform.
 


lambdaTarget
LambdaTarget lambdaTarget

 Information about the target for a deployment that uses the AWS Lambda compute platform.
 


ecsTarget
ECSTarget ecsTarget

 Information about the target for a deployment that uses the Amazon ECS compute platform.
 








Class com.amazonaws.services.codedeploy.model.DeploymentTargetDoesNotExistException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentTargetIdRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeploymentTargetListSizeExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.DeregisterOnPremisesInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the on-premises instance to deregister.
 








Class com.amazonaws.services.codedeploy.model.DeregisterOnPremisesInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codedeploy.model.DescriptionTooLongException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.Diagnostics extends Object implements Serializable


Serialized Fields


errorCode
String errorCode

 The associated error code:
 
 
 
 
 Success: The specified script ran.
 
 
 
 
 ScriptMissing: The specified script was not found in the specified location.
 
 
 
 
 ScriptNotExecutable: The specified script is not a recognized executable file type.
 
 
 
 
 ScriptTimedOut: The specified script did not finish running in the specified time period.
 
 
 
 
 ScriptFailed: The specified script failed to run as expected.
 
 
 
 
 UnknownError: The specified script did not run for an unknown reason.
 
 
 


scriptName
String scriptName

 The name of the script.
 


message
String message

 The message associated with the error.
 


logTail
String logTail

 The last portion of the diagnostic log.
 
 
 If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.
 








Class com.amazonaws.services.codedeploy.model.EC2TagFilter extends Object implements Serializable


Serialized Fields


key
String key

 The tag filter key.
 


value
String value

 The tag filter value.
 


type
String type

 The tag filter type:
 
 
 
 
 KEY_ONLY: Key only.
 
 
 
 
 VALUE_ONLY: Value only.
 
 
 
 
 KEY_AND_VALUE: Key and value.
 
 
 








Class com.amazonaws.services.codedeploy.model.EC2TagSet extends Object implements Serializable


Serialized Fields


ec2TagSetList
SdkInternalList<T> ec2TagSetList

 A list that contains other lists of EC2 instance tag groups. For an instance to be included in the deployment
 group, it must be identified by all of the tag groups in the list.
 








Class com.amazonaws.services.codedeploy.model.ECSService extends Object implements Serializable


Serialized Fields


serviceName
String serviceName

 The name of the target Amazon ECS service.
 


clusterName
String clusterName

 The name of the cluster that the Amazon ECS service is associated with.
 








Class com.amazonaws.services.codedeploy.model.ECSServiceMappingLimitExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.ECSTarget extends Object implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment.
 


targetId
String targetId

 The unique ID of a deployment target that has a type of ecsTarget.
 


targetArn
String targetArn

 The ARN of the target.
 


lastUpdatedAt
Date lastUpdatedAt

 The date and time when the target Amazon ECS application was updated by a deployment.
 


lifecycleEvents
SdkInternalList<T> lifecycleEvents

 The lifecycle events of the deployment to this target Amazon ECS application.
 


status
String status

 The status an Amazon ECS deployment's target ECS application.
 


taskSetsInfo
SdkInternalList<T> taskSetsInfo

 The ECSTaskSet objects associated with the ECS target.
 








Class com.amazonaws.services.codedeploy.model.ECSTaskSet extends Object implements Serializable


Serialized Fields


identifer
String identifer

 A unique ID of an ECSTaskSet.
 


desiredCount
Long desiredCount

 The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy
 instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After
 the updated task set is created, CodeDeploy shifts traffic to the new task set.
 


pendingCount
Long pendingCount

 The number of tasks in the task set that are in the PENDING status during an Amazon ECS deployment.
 A task in the PENDING state is preparing to enter the RUNNING state. A task set enters
 the PENDING status when it launches for the first time, or when it is restarted after being in the
 STOPPED state.
 


runningCount
Long runningCount

 The number of tasks in the task set that are in the RUNNING status during an Amazon ECS deployment.
 A task in the RUNNING state is running and ready for use.
 


status
String status

 The status of the task set. There are three valid task set statuses:
 
 
 
 
 PRIMARY: Indicates the task set is serving production traffic.
 
 
 
 
 ACTIVE: Indicates the task set is not serving production traffic.
 
 
 
 
 DRAINING: Indicates the tasks in the task set are being stopped and their corresponding targets are
 being deregistered from their target group.
 
 
 


trafficWeight
Double trafficWeight

 The percentage of traffic served by this task set.
 


targetGroup
TargetGroupInfo targetGroup

 The target group associated with the task set. The target group is used by AWS CodeDeploy to manage traffic to a
 task set.
 


taskSetLabel
String taskSetLabel

 A label that identifies whether the ECS task set is an original target (BLUE) or a replacement
 target (GREEN).
 








Class com.amazonaws.services.codedeploy.model.ELBInfo extends Object implements Serializable


Serialized Fields


name
String name

 For blue/green deployments, the name of the load balancer that is used to route traffic from original instances
 to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that
 instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with
 after the deployment is complete.
 








Class com.amazonaws.services.codedeploy.model.ErrorInformation extends Object implements Serializable


Serialized Fields


code
String code

 For more information, see Error Codes for AWS
 CodeDeploy in the AWS CodeDeploy User
 Guide.
 
 
 The error code:
 
 
 
 
 APPLICATION_MISSING: The application was missing. This error code is most likely 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 is most likely 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 Amazon EC2.
 
 
 
 
 NO_INSTANCES: No instances were specified, or no instances can be found.
 
 
 
 
 OVER_MAX_INSTANCES: The maximum number of instances 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 is most likely raised if the revision is deleted
 after the deployment is created, but before it is started.
 
 
 


message
String message

 An accompanying error message.
 








Class com.amazonaws.services.codedeploy.model.GenericRevisionInfo extends Object implements Serializable


Serialized Fields


description
String description

 A comment about the revision.
 


deploymentGroups
SdkInternalList<T> deploymentGroups

 The deployment groups for which this is the current target revision.
 


firstUsedTime
Date firstUsedTime

 When the revision was first used by AWS CodeDeploy.
 


lastUsedTime
Date lastUsedTime

 When the revision was last used by AWS CodeDeploy.
 


registerTime
Date registerTime

 When the revision was registered with AWS CodeDeploy.
 








Class com.amazonaws.services.codedeploy.model.GetApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
 








Class com.amazonaws.services.codedeploy.model.GetApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


application
ApplicationInfo application

 Information about the application.
 








Class com.amazonaws.services.codedeploy.model.GetApplicationRevisionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application that corresponds to the revision.
 


revision
RevisionLocation revision

 Information about the application revision to get, including type and location.
 








Class com.amazonaws.services.codedeploy.model.GetApplicationRevisionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application that corresponds to the revision.
 


revision
RevisionLocation revision

 Additional information about the revision, including type and location.
 


revisionInfo
GenericRevisionInfo revisionInfo

 General information about the revision.
 








Class com.amazonaws.services.codedeploy.model.GetDeploymentConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentConfigName
String deploymentConfigName

 The name of a deployment configuration associated with the IAM user or AWS account.
 








Class com.amazonaws.services.codedeploy.model.GetDeploymentConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentConfigInfo
DeploymentConfigInfo deploymentConfigInfo

 Information about the deployment configuration.
 








Class com.amazonaws.services.codedeploy.model.GetDeploymentGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
 


deploymentGroupName
String deploymentGroupName

 The name of a deployment group for the specified application.
 








Class com.amazonaws.services.codedeploy.model.GetDeploymentGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentGroupInfo
DeploymentGroupInfo deploymentGroupInfo

 Information about the deployment group.
 








Class com.amazonaws.services.codedeploy.model.GetDeploymentInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment.
 


instanceId
String instanceId

 The unique ID of an instance in the deployment group.
 








Class com.amazonaws.services.codedeploy.model.GetDeploymentInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceSummary
InstanceSummary instanceSummary

 Information about the instance.
 








Class com.amazonaws.services.codedeploy.model.GetDeploymentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment associated with the IAM user or AWS account.
 








Class com.amazonaws.services.codedeploy.model.GetDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentInfo
DeploymentInfo deploymentInfo

 Information about the deployment.
 








Class com.amazonaws.services.codedeploy.model.GetDeploymentTargetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment.
 


targetId
String targetId

 The unique ID of a deployment target.
 








Class com.amazonaws.services.codedeploy.model.GetDeploymentTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentTarget
DeploymentTarget deploymentTarget

 A deployment target that contains information about a deployment such as its status, lifecyle events, and when it
 was last updated. It also contains metadata about the deployment target. The deployment target metadata depends
 on the deployment target's type (instanceTarget, lambdaTarget, or
 ecsTarget).
 








Class com.amazonaws.services.codedeploy.model.GetOnPremisesInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the on-premises instance about which to get information.
 








Class com.amazonaws.services.codedeploy.model.GetOnPremisesInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceInfo
InstanceInfo instanceInfo

 Information about the on-premises instance.
 








Class com.amazonaws.services.codedeploy.model.GitHubAccountTokenDoesNotExistException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.GitHubAccountTokenNameRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.GitHubLocation extends Object implements Serializable


Serialized Fields


repository
String repository

 The GitHub account and repository pair that stores a reference to the commit that represents the bundled
 artifacts for the application revision.
 
 
 Specified as account/repository.
 


commitId
String commitId

 The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
 








Class com.amazonaws.services.codedeploy.model.GreenFleetProvisioningOption extends Object implements Serializable


Serialized Fields


action
String action

 The method used to add instances to a replacement environment.
 
 
 
 
 DISCOVER_EXISTING: Use instances that already exist or will be created manually.
 
 
 
 
 COPY_AUTO_SCALING_GROUP: Use settings from a specified Auto Scaling group to define and create instances in a new
 Auto Scaling group.
 
 
 








Class com.amazonaws.services.codedeploy.model.IamArnRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.IamSessionArnAlreadyRegisteredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.IamUserArnAlreadyRegisteredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.IamUserArnRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InstanceDoesNotExistException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InstanceIdRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InstanceInfo extends Object implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the on-premises instance.
 


iamSessionArn
String iamSessionArn

 The ARN of the IAM session associated with the on-premises instance.
 


iamUserArn
String iamUserArn

 The IAM user ARN associated with the on-premises instance.
 


instanceArn
String instanceArn

 The ARN of the on-premises instance.
 


registerTime
Date registerTime

 The time at which the on-premises instance was registered.
 


deregisterTime
Date deregisterTime

 If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.
 


tags
SdkInternalList<T> tags

 The tags currently associated with the on-premises instance.
 








Class com.amazonaws.services.codedeploy.model.InstanceLimitExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InstanceNameAlreadyRegisteredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InstanceNameRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InstanceNotRegisteredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InstanceSummary extends Object implements Serializable


Serialized Fields


deploymentId
String deploymentId
Deprecated. 

 The unique ID of a deployment.
 


instanceId
String instanceId
Deprecated. 

 The instance ID.
 


status
String status
Deprecated. 

 The deployment status for this instance:
 
 
 
 
 Pending: The deployment is pending for this instance.
 
 
 
 
 In Progress: The deployment is in progress for this instance.
 
 
 
 
 Succeeded: The deployment has succeeded for this instance.
 
 
 
 
 Failed: The deployment has failed for this instance.
 
 
 
 
 Skipped: The deployment has been skipped for this instance.
 
 
 
 
 Unknown: The deployment status is unknown for this instance.
 
 
 


lastUpdatedAt
Date lastUpdatedAt
Deprecated. 

 A timestamp that indicaties when the instance information was last updated.
 


lifecycleEvents
SdkInternalList<T> lifecycleEvents
Deprecated. 

 A list of lifecycle events for this instance.
 


instanceType
String instanceType
Deprecated. 

 Information about which environment an instance belongs to in a blue/green deployment.
 
 
 
 
 BLUE: The instance is part of the original environment.
 
 
 
 
 GREEN: The instance is part of the replacement environment.
 
 
 








Class com.amazonaws.services.codedeploy.model.InstanceTarget extends Object implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment.
 


targetId
String targetId

 The unique ID of a deployment target that has a type of instanceTarget.
 


targetArn
String targetArn

 The ARN of the target.
 


status
String status

 The status an EC2/On-premises deployment's target instance.
 


lastUpdatedAt
Date lastUpdatedAt

 The date and time when the target instance was updated by a deployment.
 


lifecycleEvents
SdkInternalList<T> lifecycleEvents

 The lifecycle events of the deployment to this target instance.
 


instanceLabel
String instanceLabel

 A label that identifies whether the instance is an original target (BLUE) or a replacement target (
 GREEN).
 








Class com.amazonaws.services.codedeploy.model.InvalidAlarmConfigException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidApplicationNameException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidArnException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidAutoRollbackConfigException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidAutoScalingGroupException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidBlueGreenDeploymentConfigurationException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidBucketNameFilterException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidComputePlatformException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidDeployedStateFilterException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidDeploymentConfigNameException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidDeploymentGroupNameException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidDeploymentIdException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidDeploymentInstanceTypeException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidDeploymentStatusException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidDeploymentStyleException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidDeploymentTargetIdException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidDeploymentWaitTypeException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidEC2TagCombinationException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidEC2TagException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidECSServiceException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidFileExistsBehaviorException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidGitHubAccountTokenException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidGitHubAccountTokenNameException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidIamSessionArnException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidIamUserArnException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidIgnoreApplicationStopFailuresValueException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidInputException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidInstanceNameException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidInstanceStatusException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidInstanceTypeException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidKeyPrefixFilterException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidLifecycleEventHookExecutionIdException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidLifecycleEventHookExecutionStatusException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidLoadBalancerInfoException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidMinimumHealthyHostValueException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidNextTokenException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidOnPremisesTagCombinationException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidOperationException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidRegistrationStatusException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidRevisionException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidRoleException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidSortByException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidSortOrderException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidTagException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidTagFilterException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidTagsToAddException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidTargetFilterNameException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidTargetGroupPairException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidTargetInstancesException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidTimeRangeException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidTrafficRoutingConfigurationException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidTriggerConfigException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.InvalidUpdateOutdatedInstancesOnlyValueException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.LambdaFunctionInfo extends Object implements Serializable


Serialized Fields


functionName
String functionName

 The name of a Lambda function.
 


functionAlias
String functionAlias

 The alias of a Lambda function. For more information, see Introduction to AWS Lambda Aliases.
 


currentVersion
String currentVersion

 The version of a Lambda function that production traffic points to.
 


targetVersion
String targetVersion

 The version of a Lambda function that production traffic points to after the Lambda function is deployed.
 


targetVersionWeight
Double targetVersionWeight

 The percentage of production traffic that the target version of a Lambda function receives.
 








Class com.amazonaws.services.codedeploy.model.LambdaTarget extends Object implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment.
 


targetId
String targetId

 The unique ID of a deployment target that has a type of lambdaTarget.
 


targetArn
String targetArn

 The ARN of the target.
 


status
String status

 The status an AWS Lambda deployment's target Lambda function.
 


lastUpdatedAt
Date lastUpdatedAt

 The date and time when the target Lambda function was updated by a deployment.
 


lifecycleEvents
SdkInternalList<T> lifecycleEvents

 The lifecycle events of the deployment to this target Lambda function.
 


lambdaFunctionInfo
LambdaFunctionInfo lambdaFunctionInfo

 A LambdaFunctionInfo object that describes a target Lambda function.
 








Class com.amazonaws.services.codedeploy.model.LastDeploymentInfo extends Object implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment.
 


status
String status

 The status of the most recent deployment.
 


endTime
Date endTime

 A timestamp that indicates when the most recent deployment to the deployment group was complete.
 


createTime
Date createTime

 A timestamp that indicates when the most recent deployment to the deployment group started.
 








Class com.amazonaws.services.codedeploy.model.LifecycleEvent extends Object implements Serializable


Serialized Fields


lifecycleEventName
String lifecycleEventName

 The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or
 ValidateService.
 


diagnostics
Diagnostics diagnostics

 Diagnostic information about the deployment lifecycle event.
 


startTime
Date startTime

 A timestamp that indicates when the deployment lifecycle event started.
 


endTime
Date endTime

 A timestamp that indicates when the deployment lifecycle event ended.
 


status
String status

 The deployment lifecycle event status:
 
 
 
 
 Pending: The deployment lifecycle event is pending.
 
 
 
 
 InProgress: The deployment lifecycle event is in progress.
 
 
 
 
 Succeeded: The deployment lifecycle event ran successfully.
 
 
 
 
 Failed: The deployment lifecycle event has failed.
 
 
 
 
 Skipped: The deployment lifecycle event has been skipped.
 
 
 
 
 Unknown: The deployment lifecycle event is unknown.
 
 
 








Class com.amazonaws.services.codedeploy.model.LifecycleEventAlreadyCompletedException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.LifecycleHookLimitExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.ListApplicationRevisionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
 


sortBy
String sortBy

 The column name to use to sort the list results:
 
 
 
 
 registerTime: Sort by the time the revisions were registered with AWS CodeDeploy.
 
 
 
 
 firstUsedTime: Sort by the time the revisions were first used in a deployment.
 
 
 
 
 lastUsedTime: Sort by the time the revisions were last used in a deployment.
 
 
 
 
 If not specified or set to null, the results are 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 are sorted in ascending order.
 
 
 If set to null, the results are sorted in an arbitrary order.
 


s3Bucket
String s3Bucket

 An Amazon S3 bucket name to limit the search for revisions.
 
 
 If set to null, all of the user's buckets are searched.
 


s3KeyPrefix
String s3KeyPrefix

 A key prefix for the set of Amazon S3 objects to limit the search for revisions.
 


deployed
String deployed

 Whether to list revisions based on whether the revision is the target revision of an deployment group:
 
 
 
 
 include: List revisions that are target revisions of a deployment group.
 
 
 
 
 exclude: Do not list revisions that are target revisions of a deployment group.
 
 
 
 
 ignore: List all revisions.
 
 
 


nextToken
String nextToken

 An identifier returned from the previous ListApplicationRevisions call. It can be used to return the
 next set of applications in the list.
 








Class com.amazonaws.services.codedeploy.model.ListApplicationRevisionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


revisions
SdkInternalList<T> revisions

 A list of locations that contain the matching revisions.
 


nextToken
String nextToken

 If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list
 application revisions call to return the next set of application revisions in the list.
 








Class com.amazonaws.services.codedeploy.model.ListApplicationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 An identifier returned from the previous list applications call. It can be used to return the next set of
 applications in the list.
 








Class com.amazonaws.services.codedeploy.model.ListApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applications
SdkInternalList<T> applications

 A list of application names.
 


nextToken
String nextToken

 If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list
 applications call to return the next set of applications in the list.
 








Class com.amazonaws.services.codedeploy.model.ListDeploymentConfigsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 An identifier returned from the previous ListDeploymentConfigs call. It can be used to return the
 next set of deployment configurations in the list.
 








Class com.amazonaws.services.codedeploy.model.ListDeploymentConfigsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentConfigsList
SdkInternalList<T> deploymentConfigsList

 A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime.
 


nextToken
String nextToken

 If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list
 deployment configurations call to return the next set of deployment configurations in the list.
 








Class com.amazonaws.services.codedeploy.model.ListDeploymentGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
 


nextToken
String nextToken

 An identifier returned from the previous list deployment groups call. It can be used to return the next set of
 deployment groups in the list.
 








Class com.amazonaws.services.codedeploy.model.ListDeploymentGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationName
String applicationName

 The application name.
 


deploymentGroups
SdkInternalList<T> deploymentGroups

 A list of deployment group names.
 


nextToken
String nextToken

 If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list
 deployment groups call to return the next set of deployment groups in the list.
 








Class com.amazonaws.services.codedeploy.model.ListDeploymentInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment.
 


nextToken
String nextToken

 An identifier returned from the previous list deployment instances call. It can be used to return the next set of
 deployment instances in the list.
 


instanceStatusFilter
SdkInternalList<T> instanceStatusFilter

 A subset of instances to list by status:
 
 
 
 
 Pending: Include those instances with pending deployments.
 
 
 
 
 InProgress: Include those instances where deployments are still in progress.
 
 
 
 
 Succeeded: Include those instances with successful deployments.
 
 
 
 
 Failed: Include those instances with failed deployments.
 
 
 
 
 Skipped: Include those instances with skipped deployments.
 
 
 
 
 Unknown: Include those instances with deployments in an unknown state.
 
 
 


instanceTypeFilter
SdkInternalList<T> instanceTypeFilter

 The set of instances in a blue/green deployment, either those in the original environment ("BLUE") or those in
 the replacement environment ("GREEN"), for which you want to view instance information.
 








Class com.amazonaws.services.codedeploy.model.ListDeploymentInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instancesList
SdkInternalList<T> instancesList

 A list of instance IDs.
 


nextToken
String nextToken

 If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list
 deployment instances call to return the next set of deployment instances in the list.
 








Class com.amazonaws.services.codedeploy.model.ListDeploymentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an AWS CodeDeploy application associated with the IAM user or AWS account.
 
 
 
 If applicationName is specified, then deploymentGroupName must be specified. If it is
 not specified, then deploymentGroupName must not be specified.
 
 


deploymentGroupName
String deploymentGroupName

 The name of a deployment group for the specified application.
 
 
 
 If deploymentGroupName is specified, then applicationName must be specified. If it is
 not specified, then applicationName must not be specified.
 
 


includeOnlyStatuses
SdkInternalList<T> includeOnlyStatuses

 A subset of deployments to list by status:
 
 
 
 
 Created: Include created deployments in the resulting list.
 
 
 
 
 Queued: Include queued deployments in the resulting list.
 
 
 
 
 In Progress: Include in-progress deployments in the resulting list.
 
 
 
 
 Succeeded: Include successful deployments in the resulting list.
 
 
 
 
 Failed: Include failed deployments in the resulting list.
 
 
 
 
 Stopped: Include stopped deployments in the resulting list.
 
 
 


createTimeRange
TimeRange createTimeRange

 A time range (start and end) for returning a subset of the list of deployments.
 


nextToken
String nextToken

 An identifier returned from the previous list deployments call. It can be used to return the next set of
 deployments in the list.
 








Class com.amazonaws.services.codedeploy.model.ListDeploymentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deployments
SdkInternalList<T> deployments

 A list of deployment IDs.
 


nextToken
String nextToken

 If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list
 deployments call to return the next set of deployments in the list.
 








Class com.amazonaws.services.codedeploy.model.ListDeploymentTargetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment.
 


nextToken
String nextToken

 A token identifier returned from the previous ListDeploymentTargets call. It can be used to return
 the next set of deployment targets in the list.
 


targetFilters
Map<K,V> targetFilters

 A key used to filter the returned targets. The two valid values are:
 
 
 
 
 TargetStatus - A TargetStatus filter string can be Failed,
 InProgress, Pending, Ready, Skipped, Succeeded,
 or Unknown.
 
 
 
 
 ServerInstanceLabel - A ServerInstanceLabel filter string can be Blue or
 Green.
 
 
 








Class com.amazonaws.services.codedeploy.model.ListDeploymentTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


targetIds
SdkInternalList<T> targetIds

 The unique IDs of deployment targets.
 


nextToken
String nextToken

 If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent
 ListDeploymentTargets call to return the next set of deployment targets in the list.
 








Class com.amazonaws.services.codedeploy.model.ListGitHubAccountTokenNamesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set
 of names in the list.
 








Class com.amazonaws.services.codedeploy.model.ListGitHubAccountTokenNamesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tokenNameList
SdkInternalList<T> tokenNameList

 A list of names of connections to GitHub accounts.
 


nextToken
String nextToken

 If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent
 ListGitHubAccountTokenNames call to return the next set of names in the list.
 








Class com.amazonaws.services.codedeploy.model.ListOnPremisesInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


registrationStatus
String registrationStatus

 The registration status of the on-premises instances:
 
 
 
 
 Deregistered: Include deregistered on-premises instances in the resulting list.
 
 
 
 
 Registered: Include registered on-premises instances in the resulting list.
 
 
 


tagFilters
SdkInternalList<T> tagFilters

 The on-premises instance tags that are used to restrict the on-premises instance names returned.
 


nextToken
String nextToken

 An identifier returned from the previous list on-premises instances call. It can be used to return the next set
 of on-premises instances in the list.
 








Class com.amazonaws.services.codedeploy.model.ListOnPremisesInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceNames
SdkInternalList<T> instanceNames

 The list of matching on-premises instance names.
 


nextToken
String nextToken

 If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list
 on-premises instances call to return the next set of on-premises instances in the list.
 








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


Serialized Fields


resourceArn
String resourceArn

 The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags associated with the
 resource that is identified by the ResourceArn.
 


nextToken
String nextToken

 An identifier returned from the previous ListTagsForResource call. It can be used to return the next
 set of applications in the list.
 








Class com.amazonaws.services.codedeploy.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 A list of tags returned by ListTagsForResource. The tags are associated with the resource identified
 by the input ResourceArn parameter.
 


nextToken
String nextToken

 If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list
 application revisions call to return the next set of application revisions in the list.
 








Class com.amazonaws.services.codedeploy.model.LoadBalancerInfo extends Object implements Serializable


Serialized Fields


elbInfoList
SdkInternalList<T> elbInfoList

 An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic
 Load Balancing, load balancers are used with Classic Load Balancers.
 
 
 
 Adding more than one load balancer to the array is not supported.
 
 


targetGroupInfoList
SdkInternalList<T> targetGroupInfoList

 An array that contains information about the target group to use for load balancing in a deployment. In Elastic
 Load Balancing, target groups are used with Application Load Balancers.
 
 
 
 Adding more than one target group to the array is not supported.
 
 


targetGroupPairInfoList
SdkInternalList<T> targetGroupPairInfoList

 The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum
 size of one.
 








Class com.amazonaws.services.codedeploy.model.MinimumHealthyHosts extends Object implements Serializable


Serialized Fields


value
Integer value

 The minimum healthy instance value.
 


type
String type

 The minimum healthy instance type:
 
 
 
 
 HOST_COUNT: The minimum number of healthy instance as an absolute value.
 
 
 
 
 FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the
 deployment.
 
 
 
 
 In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time.
 The deployment is 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 is
 successful if four or more instance are deployed to successfully. Otherwise, the deployment fails.
 
 
 
 In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns 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 attempts 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 is still
 successful.
 
 
 
 For more information, see AWS CodeDeploy Instance
 Health in the AWS CodeDeploy User Guide.
 








Class com.amazonaws.services.codedeploy.model.MultipleIamArnsProvidedException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.OnPremisesTagSet extends Object implements Serializable


Serialized Fields


onPremisesTagSetList
SdkInternalList<T> onPremisesTagSetList

 A list that contains other lists of on-premises instance tag groups. For an instance to be included in the
 deployment group, it must be identified by all of the tag groups in the list.
 








Class com.amazonaws.services.codedeploy.model.OperationNotSupportedException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.PutLifecycleEventHookExecutionStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.
 


lifecycleEventHookExecutionId
String lifecycleEventHookExecutionId

 The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the
 hooks section of the AppSpec file.
 


status
String status

 The result of a Lambda function that validates a deployment lifecycle event (Succeeded or
 Failed).
 








Class com.amazonaws.services.codedeploy.model.PutLifecycleEventHookExecutionStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


lifecycleEventHookExecutionId
String lifecycleEventHookExecutionId

 The execution ID of the lifecycle event hook. A hook is specified in the hooks section of the
 deployment's AppSpec file.
 








Class com.amazonaws.services.codedeploy.model.RawString extends Object implements Serializable


Serialized Fields


content
String content
Deprecated. 

 The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to
 update and optional Lambda functions that validate deployment lifecycle events.
 


sha256
String sha256
Deprecated. 

 The SHA256 hash value of the revision content.
 








Class com.amazonaws.services.codedeploy.model.RegisterApplicationRevisionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an AWS CodeDeploy application associated with the 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codedeploy.model.RegisterOnPremisesInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the on-premises instance to register.
 


iamSessionArn
String iamSessionArn

 The ARN of the IAM session to associate with the on-premises instance.
 


iamUserArn
String iamUserArn

 The ARN of the IAM user to associate with the on-premises instance.
 








Class com.amazonaws.services.codedeploy.model.RegisterOnPremisesInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codedeploy.model.RemoveTagsFromOnPremisesInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 The tag key-value pairs to remove from the on-premises instances.
 


instanceNames
SdkInternalList<T> instanceNames

 The names of the on-premises instances from which to remove tags.
 








Class com.amazonaws.services.codedeploy.model.RemoveTagsFromOnPremisesInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codedeploy.model.ResourceArnRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.ResourceValidationException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.RevisionDoesNotExistException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.RevisionInfo extends Object implements Serializable


Serialized Fields


revisionLocation
RevisionLocation revisionLocation

 Information about the location and type of an application revision.
 


genericRevisionInfo
GenericRevisionInfo genericRevisionInfo

 Information about an application revision, including usage details and associated deployment groups.
 








Class com.amazonaws.services.codedeploy.model.RevisionLocation extends Object implements Serializable


Serialized Fields


revisionType
String revisionType

 The type of application revision:
 
 
 
 
 S3: An application revision stored in Amazon S3.
 
 
 
 
 GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).
 
 
 
 
 String: A YAML-formatted or JSON-formatted string (AWS Lambda deployments only).
 
 
 


s3Location
S3Location s3Location

 Information about the location of a revision stored in Amazon S3.
 


gitHubLocation
GitHubLocation gitHubLocation

 Information about the location of application artifacts stored in GitHub.
 


string
RawString string

 Information about the location of an AWS Lambda deployment revision stored as a RawString.
 


appSpecContent
AppSpecContent appSpecContent

 The content of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The content is formatted as JSON or
 YAML and stored as a RawString.
 








Class com.amazonaws.services.codedeploy.model.RevisionRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.RoleRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.RollbackInfo extends Object implements Serializable


Serialized Fields


rollbackDeploymentId
String rollbackDeploymentId

 The ID of the deployment rollback.
 


rollbackTriggeringDeploymentId
String rollbackTriggeringDeploymentId

 The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or
 was stopped.
 


rollbackMessage
String rollbackMessage

 Information that describes the status of a deployment rollback (for example, whether the deployment can't be
 rolled back, is in progress, failed, or succeeded).
 








Class com.amazonaws.services.codedeploy.model.S3Location extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The name of the Amazon S3 bucket where the application revision is stored.
 


key
String key

 The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
 


bundleType
String bundleType

 The file type of the application revision. Must be one of the following:
 
 
 
 
 tar: A tar archive file.
 
 
 
 
 tgz: A compressed tar archive file.
 
 
 
 
 zip: A zip archive file.
 
 
 


version
String version

 A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.
 
 
 If the version is not specified, the system uses the most recent version by default.
 


eTag
String eTag

 The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.
 
 
 If the ETag is not specified as an input parameter, ETag validation of the object is skipped.
 








Class com.amazonaws.services.codedeploy.model.SkipWaitTimeForInstanceTerminationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a blue/green deployment for which you want to skip the instance termination wait time.
 








Class com.amazonaws.services.codedeploy.model.SkipWaitTimeForInstanceTerminationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codedeploy.model.StopDeploymentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The unique ID of a deployment.
 


autoRollbackEnabled
Boolean autoRollbackEnabled

 Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the
 previous version of the application revision.
 








Class com.amazonaws.services.codedeploy.model.StopDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The status of the stop deployment operation:
 
 
 
 
 Pending: The stop operation is pending.
 
 
 
 
 Succeeded: The stop operation was successful.
 
 
 


statusMessage
String statusMessage

 An accompanying status message.
 








Class com.amazonaws.services.codedeploy.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The tag's key.
 


value
String value

 The tag's value.
 








Class com.amazonaws.services.codedeploy.model.TagFilter extends Object implements Serializable


Serialized Fields


key
String key

 The on-premises instance tag filter key.
 


value
String value

 The on-premises instance tag filter value.
 


type
String type

 The on-premises instance tag filter type:
 
 
 
 
 KEY_ONLY: Key only.
 
 
 
 
 VALUE_ONLY: Value only.
 
 
 
 
 KEY_AND_VALUE: Key and value.
 
 
 








Class com.amazonaws.services.codedeploy.model.TagLimitExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.TagRequiredException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of a resource, such as a CodeDeploy application or deployment group.
 


tags
SdkInternalList<T> tags

 A list of tags that TagResource associates with a resource. The resource is identified by the
 ResourceArn input parameter.
 








Class com.amazonaws.services.codedeploy.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codedeploy.model.TagSetListLimitExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.TargetGroupInfo extends Object implements Serializable


Serialized Fields


name
String name

 For blue/green deployments, the name of the target group that instances in the original environment are
 deregistered from, and instances in the replacement environment are registered with. For in-place deployments,
 the name of the target group that instances are deregistered from, so they are not serving traffic during a
 deployment, and then re-registered with after the deployment is complete.
 








Class com.amazonaws.services.codedeploy.model.TargetGroupPairInfo extends Object implements Serializable


Serialized Fields


targetGroups
SdkInternalList<T> targetGroups

 One pair of target groups. One is associated with the original task set. The second is associated with the task
 set that serves traffic after the deployment is complete.
 


prodTrafficRoute
TrafficRoute prodTrafficRoute

 The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.
 


testTrafficRoute
TrafficRoute testTrafficRoute

 An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can
 occur while test traffic is served during a deployment.
 








Class com.amazonaws.services.codedeploy.model.TargetInstances extends Object implements Serializable


Serialized Fields


tagFilters
SdkInternalList<T> tagFilters

 The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a
 blue/green deployment. Cannot be used in the same call as ec2TagSet.
 


autoScalingGroups
SdkInternalList<T> autoScalingGroups

 The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.
 


ec2TagSet
EC2TagSet ec2TagSet

 Information about the groups of EC2 instance tags that an instance must be identified by in order for it to be
 included in the replacement environment for a blue/green deployment. Cannot be used in the same call as
 tagFilters.
 








Class com.amazonaws.services.codedeploy.model.ThrottlingException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.TimeBasedCanary extends Object implements Serializable


Serialized Fields


canaryPercentage
Integer canaryPercentage

 The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.
 


canaryInterval
Integer canaryInterval

 The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.
 








Class com.amazonaws.services.codedeploy.model.TimeBasedLinear extends Object implements Serializable


Serialized Fields


linearPercentage
Integer linearPercentage

 The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear
 deployment.
 


linearInterval
Integer linearInterval

 The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.
 








Class com.amazonaws.services.codedeploy.model.TimeRange extends Object implements Serializable


Serialized Fields


start
Date start

 The start time of the time range.
 
 
 
 Specify null to leave the start time open-ended.
 
 


end
Date end

 The end time of the time range.
 
 
 
 Specify null to leave the end time open-ended.
 
 








Class com.amazonaws.services.codedeploy.model.TrafficRoute extends Object implements Serializable


Serialized Fields


listenerArns
SdkInternalList<T> listenerArns

 The ARN of one listener. The listener identifies the route between a target group and a load balancer. This is an
 array of strings with a maximum size of one.
 








Class com.amazonaws.services.codedeploy.model.TrafficRoutingConfig extends Object implements Serializable


Serialized Fields


type
String type

 The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment
 configuration .
 


timeBasedCanary
TimeBasedCanary timeBasedCanary

 A configuration that shifts traffic from one version of a Lambda function to another in two increments. The
 original and target Lambda function versions are specified in the deployment's AppSpec file.
 


timeBasedLinear
TimeBasedLinear timeBasedLinear

 A configuration that shifts traffic from one version of a Lambda function to another in equal increments, with an
 equal number of minutes between each increment. The original and target Lambda function versions are specified in
 the deployment's AppSpec file.
 








Class com.amazonaws.services.codedeploy.model.TriggerConfig extends Object implements Serializable


Serialized Fields


triggerName
String triggerName

 The name of the notification trigger.
 


triggerTargetArn
String triggerTargetArn

 The ARN of the Amazon Simple Notification Service topic through which notifications about deployment or instance
 events are sent.
 


triggerEvents
SdkInternalList<T> triggerEvents

 The event type or types for which notifications are triggered.
 








Class com.amazonaws.services.codedeploy.model.TriggerTargetsLimitExceededException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.UnsupportedActionForDeploymentTypeException extends AmazonCodeDeployException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codedeploy.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN that specifies from which resource to disassociate the tags with the keys in the TagKeys
 input paramter.
 


tagKeys
SdkInternalList<T> tagKeys

 A list of keys of Tag objects. The Tag objects identified by the keys are disassociated
 from the resource specified by the ResourceArn input parameter.
 








Class com.amazonaws.services.codedeploy.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codedeploy.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The current name of the application you want to change.
 


newApplicationName
String newApplicationName

 The new name to give the application.
 








Class com.amazonaws.services.codedeploy.model.UpdateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codedeploy.model.UpdateDeploymentGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The application name that corresponds to the deployment group to update.
 


currentDeploymentGroupName
String currentDeploymentGroupName

 The current name of the deployment group.
 


newDeploymentGroupName
String newDeploymentGroupName

 The new name of the deployment group, if you want to change it.
 


deploymentConfigName
String deploymentConfigName

 The replacement deployment configuration name to use, if you want to change it.
 


ec2TagFilters
SdkInternalList<T> ec2TagFilters

 The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags,
 enter their names. To remove tags, do not enter any tag names.
 


onPremisesInstanceTagFilters
SdkInternalList<T> onPremisesInstanceTagFilters

 The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the
 existing tags, enter their names. To remove tags, do not enter any tag names.
 


autoScalingGroups
SdkInternalList<T> autoScalingGroups

 The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them.
 To keep the Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling
 group names.
 


serviceRoleArn
String serviceRoleArn

 A replacement ARN for the service role, if you want to change it.
 


triggerConfigurations
SdkInternalList<T> triggerConfigurations

 Information about triggers to change when the deployment group is updated. For examples, see Modify Triggers in an AWS
 CodeDeploy Deployment Group in the AWS CodeDeploy User Guide.
 


alarmConfiguration
AlarmConfiguration alarmConfiguration

 Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.
 


autoRollbackConfiguration
AutoRollbackConfiguration autoRollbackConfiguration

 Information for an automatic rollback configuration that is added or changed when a deployment group is updated.
 


deploymentStyle
DeploymentStyle deploymentStyle

 Information about the type of deployment, either in-place or blue/green, you want to run and whether to route
 deployment traffic behind a load balancer.
 


blueGreenDeploymentConfiguration
BlueGreenDeploymentConfiguration blueGreenDeploymentConfiguration

 Information about blue/green deployment options for a deployment group.
 


loadBalancerInfo
LoadBalancerInfo loadBalancerInfo

 Information about the load balancer used in a deployment.
 


ec2TagSet
EC2TagSet ec2TagSet

 Information about groups of tags applied to on-premises instances. The deployment group includes only EC2
 instances identified by all the tag groups.
 


ecsServices
SdkInternalList<T> ecsServices

 The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the
 Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name
 pair using the format <clustername>:<servicename>.
 


onPremisesTagSet
OnPremisesTagSet onPremisesTagSet

 Information about an on-premises instance tag set. The deployment group includes only on-premises instances
 identified by all the tag groups.
 








Class com.amazonaws.services.codedeploy.model.UpdateDeploymentGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hooksNotCleanedUp
SdkInternalList<T> hooksNotCleanedUp

 If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group,
 AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If
 the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS
 account.
 








Package com.amazonaws.services.codeguruprofiler.model




Class com.amazonaws.services.codeguruprofiler.model.AgentConfiguration extends Object implements Serializable


Serialized Fields


periodInSeconds
Integer periodInSeconds

 Specifies the period to follow the configuration (to profile or not) and call back to get a new configuration.
 


shouldProfile
Boolean shouldProfile

 Specifies if the profiling should be enabled by the agent.
 








Class com.amazonaws.services.codeguruprofiler.model.AgentOrchestrationConfig extends Object implements Serializable


Serialized Fields


profilingEnabled
Boolean profilingEnabled

 If the agents should be enabled to create and report profiles.
 








Class com.amazonaws.services.codeguruprofiler.model.AggregatedProfileTime extends Object implements Serializable


Serialized Fields


period
String period

 The aggregation period of the aggregated profile.
 


start
Date start

 The start time of the aggregated profile.
 








Class com.amazonaws.services.codeguruprofiler.model.AmazonCodeGuruProfilerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codeguruprofiler.model.ConfigureAgentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetInstanceId
String fleetInstanceId


profilingGroupName
String profilingGroupName








Class com.amazonaws.services.codeguruprofiler.model.ConfigureAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configuration
AgentConfiguration configuration

 The configuration for the agent to use.
 








Class com.amazonaws.services.codeguruprofiler.model.ConflictException extends AmazonCodeGuruProfilerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codeguruprofiler.model.CreateProfilingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


agentOrchestrationConfig
AgentOrchestrationConfig agentOrchestrationConfig


clientToken
String clientToken


profilingGroupName
String profilingGroupName








Class com.amazonaws.services.codeguruprofiler.model.CreateProfilingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


profilingGroup
ProfilingGroupDescription profilingGroup








Class com.amazonaws.services.codeguruprofiler.model.DeleteProfilingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


profilingGroupName
String profilingGroupName








Class com.amazonaws.services.codeguruprofiler.model.DeleteProfilingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codeguruprofiler.model.DescribeProfilingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


profilingGroupName
String profilingGroupName








Class com.amazonaws.services.codeguruprofiler.model.DescribeProfilingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


profilingGroup
ProfilingGroupDescription profilingGroup








Class com.amazonaws.services.codeguruprofiler.model.GetProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accept
String accept

 The format of the profile to return. Supports application/json or application/x-amzn-ion. Defaults to
 application/x-amzn-ion.
 


endTime
Date endTime

 The end time of the profile to get. Either period or endTime must be specified. Must be greater than start and
 the overall time range to be in the past and not larger than a week.
 


maxDepth
Integer maxDepth


period
String period

 The period of the profile to get. Exactly two of startTime, period and
 endTime must be specified. Must be positive and the overall time range to be in the past and not
 larger than a week.
 


profilingGroupName
String profilingGroupName


startTime
Date startTime

 The start time of the profile to get.
 








Class com.amazonaws.services.codeguruprofiler.model.GetProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contentEncoding
String contentEncoding

 The content encoding of the profile in the payload.
 


contentType
String contentType

 The content type of the profile in the payload. Will be application/json or application/x-amzn-ion based on
 Accept header in the request.
 


profile
ByteBuffer profile








Class com.amazonaws.services.codeguruprofiler.model.InternalServerException extends AmazonCodeGuruProfilerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codeguruprofiler.model.ListProfileTimesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endTime
Date endTime

 The end time of the time range to list profiles until.
 


maxResults
Integer maxResults


nextToken
String nextToken


orderBy
String orderBy

 The order (ascending or descending by start time of the profile) to list the profiles by. Defaults to
 TIMESTAMP_DESCENDING.
 


period
String period

 The aggregation period to list the profiles for.
 


profilingGroupName
String profilingGroupName


startTime
Date startTime

 The start time of the time range to list the profiles from.
 








Class com.amazonaws.services.codeguruprofiler.model.ListProfileTimesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken


profileTimes
List<E> profileTimes

 List of start times of the available profiles for the aggregation period in the specified time range.
 








Class com.amazonaws.services.codeguruprofiler.model.ListProfilingGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


includeDescription
Boolean includeDescription

 If set to true, returns the full description of the profiling groups instead of the names. Defaults to false.
 


maxResults
Integer maxResults


nextToken
String nextToken








Class com.amazonaws.services.codeguruprofiler.model.ListProfilingGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken


profilingGroupNames
List<E> profilingGroupNames


profilingGroups
List<E> profilingGroups








Class com.amazonaws.services.codeguruprofiler.model.PostAgentProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


agentProfile
ByteBuffer agentProfile


contentType
String contentType

 The content type of the agent profile in the payload. Recommended to send the profile gzipped with content-type
 application/octet-stream. Other accepted values are application/x-amzn-ion and application/json for unzipped Ion
 and JSON respectively.
 


profileToken
String profileToken

 Client generated token to deduplicate the agent profile during aggregation.
 


profilingGroupName
String profilingGroupName








Class com.amazonaws.services.codeguruprofiler.model.PostAgentProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codeguruprofiler.model.ProfileTime extends Object implements Serializable


Serialized Fields


start
Date start

 The start time of the profile.
 








Class com.amazonaws.services.codeguruprofiler.model.ProfilingGroupDescription extends Object implements Serializable


Serialized Fields


agentOrchestrationConfig
AgentOrchestrationConfig agentOrchestrationConfig


arn
String arn


createdAt
Date createdAt

 The timestamp of when the profiling group was created.
 


name
String name


profilingStatus
ProfilingStatus profilingStatus


updatedAt
Date updatedAt

 The timestamp of when the profiling group was last updated.
 








Class com.amazonaws.services.codeguruprofiler.model.ProfilingStatus extends Object implements Serializable


Serialized Fields


latestAgentOrchestratedAt
Date latestAgentOrchestratedAt

 Timestamp of when the last interaction of the agent with configureAgent API for orchestration.
 


latestAgentProfileReportedAt
Date latestAgentProfileReportedAt

 Timestamp of when the latest agent profile was successfully reported.
 


latestAggregatedProfile
AggregatedProfileTime latestAggregatedProfile

 The time range of latest aggregated profile available.
 








Class com.amazonaws.services.codeguruprofiler.model.ResourceNotFoundException extends AmazonCodeGuruProfilerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codeguruprofiler.model.ServiceQuotaExceededException extends AmazonCodeGuruProfilerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codeguruprofiler.model.ThrottlingException extends AmazonCodeGuruProfilerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codeguruprofiler.model.UpdateProfilingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


agentOrchestrationConfig
AgentOrchestrationConfig agentOrchestrationConfig

 Remote configuration to configure the agents of the profiling group.
 


profilingGroupName
String profilingGroupName








Class com.amazonaws.services.codeguruprofiler.model.UpdateProfilingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


profilingGroup
ProfilingGroupDescription profilingGroup








Class com.amazonaws.services.codeguruprofiler.model.ValidationException extends AmazonCodeGuruProfilerException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.codegurureviewer.model




Class com.amazonaws.services.codegurureviewer.model.AccessDeniedException extends AmazonCodeGuruReviewerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codegurureviewer.model.AmazonCodeGuruReviewerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codegurureviewer.model.AssociateRepositoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


repository
Repository repository

 The repository to associate.
 


clientRequestToken
String clientRequestToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 
 
 If you want to add a new repository association, this parameter specifies a unique identifier for the new
 repository association that helps ensure idempotency.
 
 
 If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The
 CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead
 generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken
 yourself for new versions and include that value in the request.
 
 
 You typically only need to interact with this value if you implement your own retry logic and want to ensure that
 a given repository association is not created twice. We recommend that you generate a UUID-type value to ensure
 uniqueness within the specified repository association.
 
 
 Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations
 if there are failures and retries.
 








Class com.amazonaws.services.codegurureviewer.model.AssociateRepositoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositoryAssociation
RepositoryAssociation repositoryAssociation

 Information about the repository association.
 








Class com.amazonaws.services.codegurureviewer.model.CodeCommitRepository extends Object implements Serializable


Serialized Fields


name
String name

 The name of the AWS CodeCommit repository.
 








Class com.amazonaws.services.codegurureviewer.model.ConflictException extends AmazonCodeGuruReviewerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codegurureviewer.model.DescribeRepositoryAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationArn
String associationArn

 The Amazon Resource Name (ARN) identifying the association.
 








Class com.amazonaws.services.codegurureviewer.model.DescribeRepositoryAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositoryAssociation
RepositoryAssociation repositoryAssociation

 Information about the repository association.
 








Class com.amazonaws.services.codegurureviewer.model.DisassociateRepositoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationArn
String associationArn

 The Amazon Resource Name (ARN) identifying the association.
 








Class com.amazonaws.services.codegurureviewer.model.DisassociateRepositoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositoryAssociation
RepositoryAssociation repositoryAssociation

 Information about the disassociated repository.
 








Class com.amazonaws.services.codegurureviewer.model.InternalServerException extends AmazonCodeGuruReviewerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codegurureviewer.model.ListRepositoryAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


providerTypes
List<E> providerTypes

 List of provider types to use as a filter.
 


states
List<E> states

 List of states to use as a filter.
 


names
List<E> names

 List of names to use as a filter.
 


owners
List<E> owners

 List of owners to use as a filter. For AWS CodeCommit, the owner is the AWS account id. For GitHub, it is the
 GitHub account name.
 


maxResults
Integer maxResults

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


nextToken
String nextToken

 The nextToken value returned from a previous paginated ListRepositoryAssociations
 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 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.codegurureviewer.model.ListRepositoryAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositoryAssociationSummaries
List<E> repositoryAssociationSummaries

 A list of repository associations that meet the criteria of the request.
 


nextToken
String nextToken

 The nextToken value to include in a future ListRecommendations request. When the
 results of a ListRecommendations 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.codegurureviewer.model.NotFoundException extends AmazonCodeGuruReviewerException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


codeCommit
CodeCommitRepository codeCommit

 Information about an AWS CodeCommit repository.
 








Class com.amazonaws.services.codegurureviewer.model.RepositoryAssociation extends Object implements Serializable


Serialized Fields


associationId
String associationId

 The id of the repository association.
 


associationArn
String associationArn

 The Amazon Resource Name (ARN) identifying the repository association.
 


name
String name

 The name of the repository.
 


owner
String owner

 The owner of the repository.
 


providerType
String providerType

 The provider type of the repository association.
 


state
String state

 The state of the repository association.
 


stateReason
String stateReason

 A description of why the repository association is in the current state.
 


lastUpdatedTimeStamp
Date lastUpdatedTimeStamp

 The time, in milliseconds since the epoch, when the repository association was last updated.
 


createdTimeStamp
Date createdTimeStamp

 The time, in milliseconds since the epoch, when the repository association was created.
 








Class com.amazonaws.services.codegurureviewer.model.RepositoryAssociationSummary extends Object implements Serializable


Serialized Fields


associationArn
String associationArn

 The Amazon Resource Name (ARN) identifying the repository association.
 


lastUpdatedTimeStamp
Date lastUpdatedTimeStamp

 The time, in milliseconds since the epoch, since the repository association was last updated.
 


associationId
String associationId

 The repository association ID.
 


name
String name

 The name of the repository association.
 


owner
String owner

 The owner of the repository association.
 


providerType
String providerType

 The provider type of the repository association.
 


state
String state

 The state of the repository association.
 
 
 Associated
 
 
 Amazon CodeGuru Reviewer is associated with the repository.
 
 
 Associating
 
 
 The association is in progress.
 
 
 Failed
 
 
 The association failed. For more information about troubleshooting (or why it failed), see [troubleshooting
 topic].
 
 
 Disassociating
 
 
 Amazon CodeGuru Reviewer is in the process of disassociating with the repository.
 
 
 








Class com.amazonaws.services.codegurureviewer.model.ThrottlingException extends AmazonCodeGuruReviewerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codegurureviewer.model.ValidationException extends AmazonCodeGuruReviewerException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.codepipeline.model




Class com.amazonaws.services.codepipeline.model.AcknowledgeJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique system-generated ID of the job for which you want to confirm receipt.
 


nonce
String nonce

 A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one
 job worker. Get this number from the response of the PollForJobs request that returned this job.
 








Class com.amazonaws.services.codepipeline.model.AcknowledgeJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 Whether the job worker has received the specified job.
 








Class com.amazonaws.services.codepipeline.model.AcknowledgeThirdPartyJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique system-generated ID of the job.
 


nonce
String nonce

 A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one
 job worker. Get this number from the response to a GetThirdPartyJobDetails request.
 


clientToken
String clientToken

 The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed
 access to the job and its details.
 








Class com.amazonaws.services.codepipeline.model.AcknowledgeThirdPartyJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The status information for the third party job, if any.
 








Class com.amazonaws.services.codepipeline.model.ActionConfiguration extends Object implements Serializable


Serialized Fields


configuration
Map<K,V> configuration

 The configuration data for the action.
 








Class com.amazonaws.services.codepipeline.model.ActionConfigurationProperty extends Object implements Serializable


Serialized Fields


name
String name

 The name of the action configuration property.
 


required
Boolean required

 Whether the configuration property is a required value.
 


key
Boolean key

 Whether the configuration property is a key.
 


secret
Boolean secret

 Whether the configuration property is secret. Secrets are hidden from all calls except for
 GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and
 PollForThirdPartyJobs.
 
 
 When updating a pipeline, passing * * * * * without changing any other values of the action preserves the
 previous value of the secret.
 


queryable
Boolean queryable

 Indicates that the property is used 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 other restrictions. The value must be less than or equal to
 twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
 


description
String description

 The description of the action configuration property that is displayed to users.
 


type
String type

 The type of the configuration property.
 








Class com.amazonaws.services.codepipeline.model.ActionContext extends Object implements Serializable


Serialized Fields


name
String name

 The name of the action in the context of a job.
 


actionExecutionId
String actionExecutionId

 The system-generated unique ID that corresponds to an action's execution.
 








Class com.amazonaws.services.codepipeline.model.ActionDeclaration extends Object implements Serializable


Serialized Fields


name
String name

 The action declaration's name.
 


actionTypeId
ActionTypeId actionTypeId

 Specifies the action type and the provider of the action.
 


runOrder
Integer runOrder

 The order in which actions are run.
 


configuration
Map<K,V> configuration

 The action's configuration. These are key-value pairs that specify input values for an action. For more
 information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS
 CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with
 examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide.
 
 
 The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is
 as follows:
 
 
 JSON:
 
 
 "Configuration" : { Key : Value },
 


outputArtifacts
List<E> outputArtifacts

 The name or ID of the result of the action declaration, such as a test or build artifact.
 


inputArtifacts
List<E> inputArtifacts

 The name or ID of the artifact consumed by the action, such as a test or build artifact.
 


roleArn
String roleArn

 The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the
 pipeline.
 


region
String region

 The action declaration's AWS Region, such as us-east-1.
 


namespace
String namespace

 The variable namespace associated with the action. All variables produced as output by this action fall under
 this namespace.
 








Class com.amazonaws.services.codepipeline.model.ActionExecution extends Object implements Serializable


Serialized Fields


status
String status

 The status of the action, or for a completed action, the last status of the action.
 


summary
String summary

 A summary of the run of the action.
 


lastStatusChange
Date lastStatusChange

 The last status change of the action.
 


token
String token

 The system-generated token used to identify a unique approval request. The token for each open approval request
 can be obtained using the GetPipelineState command. It is used to validate that the approval request
 corresponding to this token is still valid.
 


lastUpdatedBy
String lastUpdatedBy

 The ARN of the user who last changed the pipeline.
 


externalExecutionId
String externalExecutionId

 The external ID of the run of the action.
 


externalExecutionUrl
String externalExecutionUrl

 The URL of a resource external to AWS that is used when running the action (for example, an external repository
 URL).
 


percentComplete
Integer percentComplete

 A percentage of completeness of the action as it runs.
 


errorDetails
ErrorDetails errorDetails

 The details of an error returned by a URL external to AWS.
 








Class com.amazonaws.services.codepipeline.model.ActionExecutionDetail extends Object implements Serializable


Serialized Fields


pipelineExecutionId
String pipelineExecutionId

 The pipeline execution ID for the action execution.
 


actionExecutionId
String actionExecutionId

 The action execution ID.
 


pipelineVersion
Integer pipelineVersion

 The version of the pipeline where the action was run.
 


stageName
String stageName

 The name of the stage that contains the action.
 


actionName
String actionName

 The name of the action.
 


startTime
Date startTime

 The start time of the action execution.
 


lastUpdateTime
Date lastUpdateTime

 The last update time of the action execution.
 


status
String status

 The status of the action execution. Status categories are InProgress, Succeeded, and
 Failed.
 


input
ActionExecutionInput input

 Input details for the action execution, such as role ARN, Region, and input artifacts.
 


output
ActionExecutionOutput output

 Output details for the action execution, such as the action execution result.
 








Class com.amazonaws.services.codepipeline.model.ActionExecutionFilter extends Object implements Serializable


Serialized Fields


pipelineExecutionId
String pipelineExecutionId

 The pipeline execution ID used to filter action execution history.
 








Class com.amazonaws.services.codepipeline.model.ActionExecutionInput extends Object implements Serializable


Serialized Fields


actionTypeId
ActionTypeId actionTypeId


configuration
Map<K,V> configuration

 Configuration data for an action execution.
 


resolvedConfiguration
Map<K,V> resolvedConfiguration

 Configuration data for an action execution with all variable references replaced with their real values for the
 execution.
 


roleArn
String roleArn

 The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the
 pipeline.
 


region
String region

 The AWS Region for the action, such as us-east-1.
 


inputArtifacts
List<E> inputArtifacts

 Details of input artifacts of the action that correspond to the action execution.
 


namespace
String namespace

 The variable namespace associated with the action. All variables produced as output by this action fall under
 this namespace.
 








Class com.amazonaws.services.codepipeline.model.ActionExecutionOutput extends Object implements Serializable


Serialized Fields


outputArtifacts
List<E> outputArtifacts

 Details of output artifacts of the action that correspond to the action execution.
 


executionResult
ActionExecutionResult executionResult

 Execution result information listed in the output details for an action execution.
 


outputVariables
Map<K,V> outputVariables

 The outputVariables field shows the key-value pairs that were output as part of that execution.
 








Class com.amazonaws.services.codepipeline.model.ActionExecutionResult extends Object implements Serializable


Serialized Fields


externalExecutionId
String externalExecutionId

 The action provider's external ID for the action execution.
 


externalExecutionSummary
String externalExecutionSummary

 The action provider's summary for the action execution.
 


externalExecutionUrl
String externalExecutionUrl

 The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is
 used when running the action.
 








Class com.amazonaws.services.codepipeline.model.ActionNotFoundException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.ActionRevision extends Object implements Serializable


Serialized Fields


revisionId
String revisionId

 The system-generated unique ID that identifies the revision number of the action.
 


revisionChangeId
String revisionChangeId

 The unique identifier of the change that set the state to this revision (for example, a deployment ID or
 timestamp).
 


created
Date created

 The date and time when the most recent version of the action was created, in timestamp format.
 








Class com.amazonaws.services.codepipeline.model.ActionState extends Object implements Serializable


Serialized Fields


actionName
String actionName

 The name of the action.
 


currentRevision
ActionRevision currentRevision

 Represents information about the version (or revision) of an action.
 


latestExecution
ActionExecution latestExecution

 Represents information about the run of an action.
 


entityUrl
String entityUrl

 A URL link for more information about the state of the action, such as a deployment group details page.
 


revisionUrl
String revisionUrl

 A URL link for more information about the revision, such as a commit details page.
 








Class com.amazonaws.services.codepipeline.model.ActionType extends Object implements Serializable


Serialized Fields


id
ActionTypeId id

 Represents information about an action type.
 


settings
ActionTypeSettings settings

 The settings for the action type.
 


actionConfigurationProperties
List<E> actionConfigurationProperties

 The configuration properties for the action type.
 


inputArtifactDetails
ArtifactDetails inputArtifactDetails

 The details of the input artifact for the action, such as its commit ID.
 


outputArtifactDetails
ArtifactDetails outputArtifactDetails

 The details of the output artifact of the action, such as its commit ID.
 








Class com.amazonaws.services.codepipeline.model.ActionTypeId extends Object implements Serializable


Serialized Fields


category
String category

 A category defines what kind of action can be taken in the stage, and constrains the provider type for the
 action. Valid categories are limited to one of the following values.
 


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. For more information, see Valid Action Types and Providers in CodePipeline.
 


version
String version

 A string that describes the action version.
 








Class com.amazonaws.services.codepipeline.model.ActionTypeNotFoundException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.ActionTypeSettings extends Object implements Serializable


Serialized Fields


thirdPartyConfigurationUrl
String thirdPartyConfigurationUrl

 The URL of a sign-up page where users can sign up for an external service and perform initial configuration of
 the action provided by that service.
 


entityUrlTemplate
String entityUrlTemplate

 The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external
 system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of
 the action display in 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 the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the
 AWS CodePipeline console and provides a link to the execution entity of the external action.
 


revisionUrlTemplate
String revisionUrlTemplate

 The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or
 change the configuration of the external action.
 








Class com.amazonaws.services.codepipeline.model.ApprovalAlreadyCompletedException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.ApprovalResult extends Object implements Serializable


Serialized Fields


summary
String summary

 The summary of the current status of the approval request.
 


status
String status

 The response submitted by a reviewer assigned to an approval action request.
 








Class com.amazonaws.services.codepipeline.model.Artifact extends Object implements Serializable


Serialized Fields


name
String name

 The artifact's name.
 


revision
String revision

 The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID
 (Amazon S3).
 


location
ArtifactLocation location

 The location of an artifact.
 








Class com.amazonaws.services.codepipeline.model.ArtifactDetail extends Object implements Serializable


Serialized Fields


name
String name

 The artifact object name for the action execution.
 


s3location
S3Location s3location

 The Amazon S3 artifact location for the action execution.
 








Class com.amazonaws.services.codepipeline.model.ArtifactDetails extends Object implements Serializable


Serialized Fields


minimumCount
Integer minimumCount

 The minimum number of artifacts allowed for the action type.
 


maximumCount
Integer maximumCount

 The maximum number of artifacts allowed for the action type.
 








Class com.amazonaws.services.codepipeline.model.ArtifactLocation extends Object implements Serializable


Serialized Fields


type
String type

 The type of artifact in the location.
 


s3Location
S3ArtifactLocation s3Location

 The S3 bucket that contains the artifact.
 








Class com.amazonaws.services.codepipeline.model.ArtifactRevision extends Object implements Serializable


Serialized Fields


name
String name

 The name of an artifact. This name might be system-generated, such as "MyApp", or defined by the user when an
 action is created.
 


revisionId
String revisionId

 The revision ID of the artifact.
 


revisionChangeIdentifier
String revisionChangeIdentifier

 An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the
 ETag value.
 


revisionSummary
String revisionSummary

 Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories,
 the commit message. For Amazon S3 buckets or actions, the user-provided content of a
 codepipeline-artifact-revision-summary key specified in the object metadata.
 


created
Date created

 The date and time when the most recent revision of the artifact was created, in timestamp format.
 


revisionUrl
String revisionUrl

 The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the
 commit ID is linked to a commit details page.
 








Class com.amazonaws.services.codepipeline.model.ArtifactStore extends Object implements Serializable


Serialized Fields


type
String type

 The type of the artifact store, such as S3.
 


location
String location

 The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a
 folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the
 pipeline. You can use any S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.
 


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.
 








Class com.amazonaws.services.codepipeline.model.AWSCodePipelineException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.AWSSessionCredentials extends Object implements Serializable


Serialized Fields


accessKeyId
String accessKeyId

 The access key for the session.
 


secretAccessKey
String secretAccessKey

 The secret access key for the session.
 


sessionToken
String sessionToken

 The token for the session.
 








Class com.amazonaws.services.codepipeline.model.BlockerDeclaration extends Object implements Serializable


Serialized Fields


name
String name

 Reserved for future use.
 


type
String type

 Reserved for future use.
 








Class com.amazonaws.services.codepipeline.model.ConcurrentModificationException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.CreateCustomActionTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


category
String category

 The category of the custom action, such as a build action or a test action.
 
 
 
 Although Source and Approval are listed as valid values, they are not currently
 functional. These values are reserved for future use.
 
 


provider
String provider

 The provider of the service used in the custom action, such as AWS CodeDeploy.
 


version
String version

 The version identifier of the custom action.
 


settings
ActionTypeSettings settings

 URLs that provide users information about this custom action.
 


configurationProperties
List<E> 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

 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.
 


tags
List<E> tags

 The tags for the custom action.
 








Class com.amazonaws.services.codepipeline.model.CreateCustomActionTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


actionType
ActionType actionType

 Returns information about the details of an action type.
 


tags
List<E> tags

 Specifies the tags applied to the custom action.
 








Class com.amazonaws.services.codepipeline.model.CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipeline
PipelineDeclaration pipeline

 Represents the structure of actions and stages to be performed in the pipeline.
 


tags
List<E> tags

 The tags for the pipeline.
 








Class com.amazonaws.services.codepipeline.model.CreatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipeline
PipelineDeclaration pipeline

 Represents the structure of actions and stages to be performed in the pipeline.
 


tags
List<E> tags

 Specifies the tags applied to the pipeline.
 








Class com.amazonaws.services.codepipeline.model.CurrentRevision extends Object implements Serializable


Serialized Fields


revision
String revision

 The revision ID of the current version of an artifact.
 


changeIdentifier
String changeIdentifier

 The change identifier for the current revision.
 


created
Date created

 The date and time when the most recent revision of the artifact was created, in timestamp format.
 


revisionSummary
String revisionSummary

 The summary of the most recent revision of the artifact.
 








Class com.amazonaws.services.codepipeline.model.DeleteCustomActionTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


category
String category

 The category of the custom action that you want to delete, such as source or deploy.
 


provider
String provider

 The provider of the service used in the custom action, such as AWS CodeDeploy.
 


version
String version

 The version of the custom action to delete.
 








Class com.amazonaws.services.codepipeline.model.DeleteCustomActionTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the pipeline to be deleted.
 








Class com.amazonaws.services.codepipeline.model.DeletePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.DeleteWebhookRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the webhook you want to delete.
 








Class com.amazonaws.services.codepipeline.model.DeleteWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.DeregisterWebhookWithThirdPartyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


webhookName
String webhookName

 The name of the webhook you want to deregister.
 








Class com.amazonaws.services.codepipeline.model.DeregisterWebhookWithThirdPartyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.DisableStageTransitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
 


stageName
String stageName

 The name of the stage where you want to disable the inbound or outbound transition of artifacts.
 


transitionType
String transitionType

 Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in
 that stage (inbound), or prevented from transitioning from the stage after they have been processed by the
 actions in that stage (outbound).
 


reason
String reason

 The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This
 message is displayed in the pipeline console UI.
 








Class com.amazonaws.services.codepipeline.model.DisableStageTransitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.DuplicatedStopRequestException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.EnableStageTransitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
 


stageName
String stageName

 The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or
 from that stage to the next stage (outbound).
 


transitionType
String transitionType

 Specifies whether artifacts are allowed to enter the stage and be processed by the actions in that stage
 (inbound) or whether already processed artifacts are allowed to transition to the next stage (outbound).
 








Class com.amazonaws.services.codepipeline.model.EnableStageTransitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.EncryptionKey extends Object implements Serializable


Serialized Fields


id
String id

 The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.
 
 
 
 Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions,
 you can only use the key ID or key ARN to identify the key.
 
 


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 extends Object implements Serializable


Serialized Fields


code
String code

 The system ID or number code of the error.
 


message
String message

 The text of the error message.
 








Class com.amazonaws.services.codepipeline.model.ExecutionDetails extends Object implements Serializable


Serialized Fields


summary
String summary

 The summary of the current status of the actions.
 


externalExecutionId
String externalExecutionId

 The system-generated unique ID of this action used to identify this job worker in any external systems, such as
 AWS CodeDeploy.
 


percentComplete
Integer percentComplete

 The percentage of work completed on the action, represented on a scale of 0 to 100 percent.
 








Class com.amazonaws.services.codepipeline.model.ExecutionTrigger extends Object implements Serializable


Serialized Fields


triggerType
String triggerType

 The type of change-detection method, command, or user interaction that started a pipeline execution.
 


triggerDetail
String triggerDetail

 Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook that
 triggered the pipeline execution or the user ARN for a user-initiated start-pipeline-execution CLI
 command.
 








Class com.amazonaws.services.codepipeline.model.FailureDetails extends Object implements Serializable


Serialized Fields


type
String type

 The type of the failure.
 


message
String message

 The message about the failure.
 


externalExecutionId
String externalExecutionId

 The external ID of the run of the action that failed.
 








Class com.amazonaws.services.codepipeline.model.GetJobDetailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique system-generated ID for the job.
 








Class com.amazonaws.services.codepipeline.model.GetJobDetailsResult extends AmazonWebServiceResult<ResponseMetadata> 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.GetPipelineExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline about which you want to get execution details.
 


pipelineExecutionId
String pipelineExecutionId

 The ID of the pipeline execution about which you want to get execution details.
 








Class com.amazonaws.services.codepipeline.model.GetPipelineExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelineExecution
PipelineExecution pipelineExecution

 Represents information about the execution of a pipeline.
 








Class com.amazonaws.services.codepipeline.model.GetPipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the pipeline for which you want to get information. Pipeline names must be unique under an AWS user
 account.
 


version
Integer version

 The version number of the pipeline. If you do not specify a version, defaults to the current version.
 








Class com.amazonaws.services.codepipeline.model.GetPipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipeline
PipelineDeclaration pipeline

 Represents the structure of actions and stages to be performed in the pipeline.
 


metadata
PipelineMetadata metadata

 Represents the pipeline metadata information returned as part of the output of a GetPipeline action.
 








Class com.amazonaws.services.codepipeline.model.GetPipelineStateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the pipeline about which you want to get information.
 








Class com.amazonaws.services.codepipeline.model.GetPipelineStateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline for which you want to get the state.
 


pipelineVersion
Integer pipelineVersion

 The version number of the pipeline.
 
 
 
 A newly created pipeline is always assigned a version number of 1.
 
 


stageStates
List<E> stageStates

 A list of the pipeline stage output information, including stage name, state, most recent run details, whether
 the stage is disabled, and other data.
 


created
Date created

 The date and time the pipeline was created, in timestamp format.
 


updated
Date updated

 The date and time the pipeline was last updated, in timestamp format.
 








Class com.amazonaws.services.codepipeline.model.GetThirdPartyJobDetailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique system-generated ID used for identifying the job.
 


clientToken
String clientToken

 The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed
 access to the job and its details.
 








Class com.amazonaws.services.codepipeline.model.GetThirdPartyJobDetailsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobDetails
ThirdPartyJobDetails jobDetails

 The details of the job, including any protected values defined for the job.
 








Class com.amazonaws.services.codepipeline.model.InputArtifact extends Object implements Serializable


Serialized Fields


name
String name

 The name of the artifact to be worked on (for example, "My App").
 
 
 The input artifact of an action must exactly match the output artifact declared in a preceding action, but the
 input artifact does not have to be the next action in strict sequence from the action that provided the output
 artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different
 following actions.
 








Class com.amazonaws.services.codepipeline.model.InvalidActionDeclarationException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidApprovalTokenException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidArnException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidBlockerDeclarationException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidClientTokenException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidJobException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidJobStateException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidNextTokenException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidNonceException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidStageDeclarationException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidStructureException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidTagsException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidWebhookAuthenticationParametersException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.InvalidWebhookFilterPatternException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.Job extends Object implements Serializable


Serialized Fields


id
String id

 The unique system-generated ID of the job.
 


data
JobData data

 Other data about a job.
 


nonce
String nonce

 A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one
 job worker. Use this number in an AcknowledgeJob request.
 


accountId
String accountId

 The ID of the AWS account to use when performing the job.
 








Class com.amazonaws.services.codepipeline.model.JobData extends Object implements Serializable


Serialized Fields


actionTypeId
ActionTypeId actionTypeId

 Represents information about an action type.
 


actionConfiguration
ActionConfiguration actionConfiguration

 Represents information about an action configuration.
 


pipelineContext
PipelineContext pipelineContext

 Represents information about a pipeline to a job worker.
 
 
 
 Includes pipelineArn and pipelineExecutionId for custom jobs.
 
 


inputArtifacts
List<E> inputArtifacts

 The artifact supplied to the job.
 


outputArtifacts
List<E> outputArtifacts

 The output of the job.
 


artifactCredentials
AWSSessionCredentials artifactCredentials

 Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS
 Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store
 artifacts for the pipeline in AWS CodePipeline.
 


continuationToken
String continuationToken

 A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job
 asynchronously.
 


encryptionKey
EncryptionKey encryptionKey

 Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management
 Service (AWS KMS) key.
 








Class com.amazonaws.services.codepipeline.model.JobDetails extends Object implements Serializable


Serialized Fields


id
String id

 The unique system-generated ID of the job.
 


data
JobData data

 Represents other information about a job required for a job worker to complete the job.
 


accountId
String accountId

 The AWS account ID associated with the job.
 








Class com.amazonaws.services.codepipeline.model.JobNotFoundException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.LimitExceededException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.ListActionExecutionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline for which you want to list action execution history.
 


filter
ActionExecutionFilter filter

 Input information used to filter action execution history.
 


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. Action execution history is retained for up to 12 months, based on action
 execution start times. Default value is 100.
 
 
 
 Detailed execution history is available for executions run on or after February 21, 2019.
 
 


nextToken
String nextToken

 The token that was returned from the previous ListActionExecutions call, which can be used to return
 the next set of action executions in the list.
 








Class com.amazonaws.services.codepipeline.model.ListActionExecutionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


actionExecutionDetails
List<E> actionExecutionDetails

 The details for a list of recent executions, such as action execution ID.
 


nextToken
String nextToken

 If the amount of returned information is significantly large, an identifier is also returned and can be used in a
 subsequent ListActionExecutions call to return the next set of action executions in the list.
 








Class com.amazonaws.services.codepipeline.model.ListActionTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


actionOwnerFilter
String actionOwnerFilter

 Filters the list of action types to those created by a specified entity.
 


nextToken
String nextToken

 An identifier that was returned from the previous list action types call, which can be used to return the next
 set of action types in the list.
 








Class com.amazonaws.services.codepipeline.model.ListActionTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


actionTypes
List<E> actionTypes

 Provides details of the action types.
 


nextToken
String nextToken

 If the amount of returned information is significantly large, an identifier is also returned. It 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.ListPipelineExecutionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline for which you want to get execution summary information.
 


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. Pipeline history is limited to the most recent 12 months, based on pipeline
 execution start times. Default value is 100.
 


nextToken
String nextToken

 The token that was returned from the previous ListPipelineExecutions call, which can be used to
 return the next set of pipeline executions in the list.
 








Class com.amazonaws.services.codepipeline.model.ListPipelineExecutionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelineExecutionSummaries
List<E> pipelineExecutionSummaries

 A list of executions in the history of a pipeline.
 


nextToken
String nextToken

 A token that can be used in the next ListPipelineExecutions call. To view all items in the list,
 continue to call this operation with each subsequent token until no more nextToken values are returned.
 








Class com.amazonaws.services.codepipeline.model.ListPipelinesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 An identifier that was returned from the previous list pipelines call. It can be used to return the next set of
 pipelines in the list.
 








Class com.amazonaws.services.codepipeline.model.ListPipelinesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelines
List<E> pipelines

 The list of pipelines.
 


nextToken
String nextToken

 If the amount of returned information is significantly large, an identifier is also returned. It can be used in a
 subsequent list pipelines call to return the next set of pipelines in the list.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource to get tags for.
 


nextToken
String nextToken

 The token that was returned from the previous API call, which would be used to return the next page of the list.
 The ListTagsforResource call lists all available tags in one call and does not use pagination.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 








Class com.amazonaws.services.codepipeline.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The tags for the resource.
 


nextToken
String nextToken

 If the amount of returned information is significantly large, an identifier is also returned and can be used in a
 subsequent API call to return the next page of the list. The ListTagsforResource call lists all available tags in
 one call and does not use pagination.
 








Class com.amazonaws.services.codepipeline.model.ListWebhookItem extends Object implements Serializable


Serialized Fields


definition
WebhookDefinition definition

 The detail returned for each webhook, such as the webhook authentication type and filter rules.
 


url
String url

 A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started
 as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting
 and re-creating a webhook makes the old URL invalid and generates a new one.
 


errorMessage
String errorMessage

 The text of the error message about the webhook.
 


errorCode
String errorCode

 The number code of the error.
 


lastTriggered
Date lastTriggered

 The date and time a webhook was last successfully triggered, in timestamp format.
 


arn
String arn

 The Amazon Resource Name (ARN) of the webhook.
 


tags
List<E> tags

 Specifies the tags applied to the webhook.
 








Class com.amazonaws.services.codepipeline.model.ListWebhooksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token that was returned from the previous ListWebhooks call, which can be used to return the next set of
 webhooks in the list.
 


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.
 








Class com.amazonaws.services.codepipeline.model.ListWebhooksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


webhooks
List<E> webhooks

 The JSON detail returned for each webhook in the list output for the ListWebhooks call.
 


nextToken
String nextToken

 If the amount of returned information is significantly large, an identifier is also returned and can be used in a
 subsequent ListWebhooks call to return the next set of webhooks in the list.
 








Class com.amazonaws.services.codepipeline.model.NotLatestPipelineExecutionException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.OutputArtifact extends Object implements Serializable


Serialized Fields


name
String name

 The name of the output of an artifact, such as "My App".
 
 
 The input artifact of an action must exactly match the output artifact declared in a preceding action, but the
 input artifact does not have to be the next action in strict sequence from the action that provided the output
 artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different
 following actions.
 
 
 Output artifact names must be unique within a pipeline.
 








Class com.amazonaws.services.codepipeline.model.OutputVariablesSizeExceededException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.PipelineContext extends Object implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names
 under an Amazon Web Services account.
 


stage
StageContext stage

 The stage of the pipeline.
 


action
ActionContext action

 The context of an action to a job worker in the stage of a pipeline.
 


pipelineArn
String pipelineArn

 The Amazon Resource Name (ARN) of the pipeline.
 


pipelineExecutionId
String pipelineExecutionId

 The execution ID of the pipeline.
 








Class com.amazonaws.services.codepipeline.model.PipelineDeclaration extends Object implements Serializable


Serialized Fields


name
String name

 The name of the action to be performed.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no
 actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
 


artifactStore
ArtifactStore artifactStore

 Represents information about the S3 bucket where artifacts are stored for the pipeline.
 
 
 
 You must include either artifactStore or artifactStores in your pipeline, but you
 cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
 
 


artifactStores
Map<K,V> artifactStores

 A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact
 store for the pipeline Region and for each cross-region action in the pipeline.
 
 
 
 You must include either artifactStore or artifactStores in your pipeline, but you
 cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
 
 


stages
List<E> stages

 The stage in which to perform the action.
 


version
Integer version

 The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented
 when a pipeline is updated.
 








Class com.amazonaws.services.codepipeline.model.PipelineExecution extends Object implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline with the specified pipeline execution.
 


pipelineVersion
Integer pipelineVersion

 The version number of the pipeline with the specified pipeline execution.
 


pipelineExecutionId
String pipelineExecutionId

 The ID of the pipeline execution.
 


status
String status

 The status of the pipeline execution.
 
 
 
 
 InProgress: The pipeline execution is currently running.
 
 
 
 
 Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
 
 
 
 
 Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode,
 the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
 
 
 
 
 Succeeded: The pipeline execution was completed successfully.
 
 
 
 
 Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline
 execution advanced and continued through the pipeline instead. For more information, see Superseded
 Executions.
 
 
 
 
 Failed: The pipeline execution was not completed successfully.
 
 
 


artifactRevisions
List<E> artifactRevisions

 A list of ArtifactRevision objects included in a pipeline execution.
 








Class com.amazonaws.services.codepipeline.model.PipelineExecutionNotFoundException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.PipelineExecutionNotStoppableException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.PipelineExecutionSummary extends Object implements Serializable


Serialized Fields


pipelineExecutionId
String pipelineExecutionId

 The ID of the pipeline execution.
 


status
String status

 The status of the pipeline execution.
 
 
 
 
 InProgress: The pipeline execution is currently running.
 
 
 
 
 Stopped: The pipeline execution was manually stopped. For more information, see Stopped Executions.
 
 
 
 
 Stopping: The pipeline execution received a request to be manually stopped. Depending on the selected stop mode,
 the execution is either completing or abandoning in-progress actions. For more information, see Stopped Executions.
 
 
 
 
 Succeeded: The pipeline execution was completed successfully.
 
 
 
 
 Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline
 execution advanced and continued through the pipeline instead. For more information, see Superseded
 Executions.
 
 
 
 
 Failed: The pipeline execution was not completed successfully.
 
 
 


startTime
Date startTime

 The date and time when the pipeline execution began, in timestamp format.
 


lastUpdateTime
Date lastUpdateTime

 The date and time of the last change to the pipeline execution, in timestamp format.
 


sourceRevisions
List<E> sourceRevisions

 A list of the source artifact revisions that initiated a pipeline execution.
 


trigger
ExecutionTrigger trigger

 The interaction or event that started a pipeline execution, such as automated change detection or a
 StartPipelineExecution API call.
 


stopTrigger
StopExecutionTrigger stopTrigger

 The interaction that stopped a pipeline execution.
 








Class com.amazonaws.services.codepipeline.model.PipelineMetadata extends Object implements Serializable


Serialized Fields


pipelineArn
String pipelineArn

 The Amazon Resource Name (ARN) of the pipeline.
 


created
Date created

 The date and time the pipeline was created, in timestamp format.
 


updated
Date updated

 The date and time the pipeline was last updated, in timestamp format.
 








Class com.amazonaws.services.codepipeline.model.PipelineNameInUseException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.PipelineNotFoundException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.PipelineSummary extends Object implements Serializable


Serialized Fields


name
String name

 The name of the pipeline.
 


version
Integer version

 The version number of the pipeline.
 


created
Date created

 The date and time the pipeline was created, in timestamp format.
 


updated
Date updated

 The date and time of the last update to the pipeline, in timestamp format.
 








Class com.amazonaws.services.codepipeline.model.PipelineVersionNotFoundException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.PollForJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


actionTypeId
ActionTypeId actionTypeId

 Represents information about an action type.
 


maxBatchSize
Integer maxBatchSize

 The maximum number of jobs to return in a poll for jobs call.
 


queryParam
Map<K,V> queryParam

 A map of property names and values. For an action type with no queryable properties, this value must be null or
 an empty map. For an action type with a queryable property, you must supply that property as a key in the map.
 Only jobs whose action configuration matches the mapped value are returned.
 








Class com.amazonaws.services.codepipeline.model.PollForJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobs
List<E> jobs

 Information about the jobs to take action on.
 








Class com.amazonaws.services.codepipeline.model.PollForThirdPartyJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


actionTypeId
ActionTypeId actionTypeId

 Represents information about an action type.
 


maxBatchSize
Integer maxBatchSize

 The maximum number of jobs to return in a poll for jobs call.
 








Class com.amazonaws.services.codepipeline.model.PollForThirdPartyJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobs
List<E> jobs

 Information about the jobs to take action on.
 








Class com.amazonaws.services.codepipeline.model.PutActionRevisionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline that starts processing the revision to the source.
 


stageName
String stageName

 The name of the stage that contains the action that acts on the revision.
 


actionName
String actionName

 The name of the action that processes the revision.
 


actionRevision
ActionRevision actionRevision

 Represents information about the version (or revision) of an action.
 








Class com.amazonaws.services.codepipeline.model.PutActionRevisionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


newRevision
Boolean newRevision

 Indicates whether the artifact revision was previously used in an execution of the specified pipeline.
 


pipelineExecutionId
String pipelineExecutionId

 The ID of the current workflow state of the pipeline.
 








Class com.amazonaws.services.codepipeline.model.PutApprovalResultRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline that contains the action.
 


stageName
String stageName

 The name of the stage that contains the action.
 


actionName
String actionName

 The name of the action for which approval is requested.
 


result
ApprovalResult result

 Represents information about the result of the approval request.
 


token
String token

 The system-generated token used to identify a unique approval request. The token for each open approval request
 can be obtained using the GetPipelineState action. It is used to validate that the approval request
 corresponding to this token is still valid.
 








Class com.amazonaws.services.codepipeline.model.PutApprovalResultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


approvedAt
Date approvedAt

 The timestamp showing when the approval or rejection was submitted.
 








Class com.amazonaws.services.codepipeline.model.PutJobFailureResultRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs
 .
 


failureDetails
FailureDetails failureDetails

 The details about the failure of a job.
 








Class com.amazonaws.services.codepipeline.model.PutJobFailureResultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.PutJobSuccessResultRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique system-generated ID of the job that succeeded. This is the same ID returned from
 PollForJobs.
 


currentRevision
CurrentRevision currentRevision

 The ID of the current revision of the artifact successfully worked on by the job.
 


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 use this token to identify the running instance of the action.
 It can be reused to return more information about the progress of the custom action. When the action is complete,
 no continuation token should be supplied.
 


executionDetails
ExecutionDetails executionDetails

 The execution details of the successful job, such as the actions taken by the job worker.
 


outputVariables
Map<K,V> outputVariables

 Key-value pairs produced as output by a job worker that can be made available to a downstream action
 configuration. outputVariables can be included only when there is no continuation token on the
 request.
 








Class com.amazonaws.services.codepipeline.model.PutJobSuccessResultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.PutThirdPartyJobFailureResultRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
 


clientToken
String clientToken

 The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed
 access to the job and its details.
 


failureDetails
FailureDetails failureDetails

 Represents information about failure details.
 








Class com.amazonaws.services.codepipeline.model.PutThirdPartyJobFailureResultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.PutThirdPartyJobSuccessResultRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The ID of the job that successfully completed. This is the same ID returned from
 PollForThirdPartyJobs.
 


clientToken
String clientToken

 The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed
 access to the job and its details.
 


currentRevision
CurrentRevision currentRevision

 Represents information about a current revision.
 


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 use this token to identify the running instance of the action.
 It can be reused to return more information about the progress of the partner action. When the action is
 complete, no continuation token should be supplied.
 


executionDetails
ExecutionDetails executionDetails

 The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
 








Class com.amazonaws.services.codepipeline.model.PutThirdPartyJobSuccessResultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.PutWebhookRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


webhook
WebhookDefinition webhook

 The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the
 action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the
 pipeline and action it targets so that you can easily recognize what it's used for later.
 


tags
List<E> tags

 The tags for the webhook.
 








Class com.amazonaws.services.codepipeline.model.PutWebhookResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


webhook
ListWebhookItem webhook

 The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.
 








Class com.amazonaws.services.codepipeline.model.RegisterWebhookWithThirdPartyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


webhookName
String webhookName

 The name of an existing webhook created with PutWebhook to register with a supported third party.
 








Class com.amazonaws.services.codepipeline.model.RegisterWebhookWithThirdPartyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.ResourceNotFoundException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.RetryStageExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline that contains the failed stage.
 


stageName
String stageName

 The name of the failed stage to be retried.
 


pipelineExecutionId
String pipelineExecutionId

 The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to
 retrieve the current pipelineExecutionId of the failed stage
 


retryMode
String retryMode

 The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.
 








Class com.amazonaws.services.codepipeline.model.RetryStageExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelineExecutionId
String pipelineExecutionId

 The ID of the current workflow execution in the failed stage.
 








Class com.amazonaws.services.codepipeline.model.S3ArtifactLocation extends Object implements Serializable


Serialized Fields


bucketName
String bucketName

 The name of the S3 bucket.
 


objectKey
String objectKey

 The key of the object in the S3 bucket, which uniquely identifies the object in the bucket.
 








Class com.amazonaws.services.codepipeline.model.S3Location extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The Amazon S3 artifact bucket for an action's artifacts.
 


key
String key

 The artifact name.
 








Class com.amazonaws.services.codepipeline.model.SourceRevision extends Object implements Serializable


Serialized Fields


actionName
String actionName

 The name of the action that processed the revision to the source artifact.
 


revisionId
String revisionId

 The system-generated unique ID that identifies the revision number of the artifact.
 


revisionSummary
String revisionSummary

 Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories,
 the commit message. For Amazon S3 buckets or actions, the user-provided content of a
 codepipeline-artifact-revision-summary key specified in the object metadata.
 


revisionUrl
String revisionUrl

 The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the
 commit ID is linked to a commit details page.
 








Class com.amazonaws.services.codepipeline.model.StageContext extends Object implements Serializable


Serialized Fields


name
String name

 The name of the stage.
 








Class com.amazonaws.services.codepipeline.model.StageDeclaration extends Object implements Serializable


Serialized Fields


name
String name

 The name of the stage.
 


blockers
List<E> blockers

 Reserved for future use.
 


actions
List<E> actions

 The actions included in a stage.
 








Class com.amazonaws.services.codepipeline.model.StageExecution extends Object implements Serializable


Serialized Fields


pipelineExecutionId
String pipelineExecutionId

 The ID of the pipeline execution associated with the stage.
 


status
String status

 The status of the stage, or for a completed stage, the last status of the stage.
 








Class com.amazonaws.services.codepipeline.model.StageNotFoundException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.StageNotRetryableException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.StageState extends Object implements Serializable


Serialized Fields


stageName
String stageName

 The name of the stage.
 


inboundTransitionState
TransitionState inboundTransitionState

 The state of the inbound transition, which is either enabled or disabled.
 


actionStates
List<E> actionStates

 The state of the stage.
 


latestExecution
StageExecution latestExecution

 Information about the latest execution in the stage, including its ID and status.
 








Class com.amazonaws.services.codepipeline.model.StartPipelineExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the pipeline to start.
 


clientRequestToken
String clientRequestToken

 The system-generated unique ID used to identify a unique execution request.
 








Class com.amazonaws.services.codepipeline.model.StartPipelineExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelineExecutionId
String pipelineExecutionId

 The unique system-generated ID of the pipeline execution that was started.
 








Class com.amazonaws.services.codepipeline.model.StopExecutionTrigger extends Object implements Serializable


Serialized Fields


reason
String reason

 The user-specified reason the pipeline was stopped.
 








Class com.amazonaws.services.codepipeline.model.StopPipelineExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline to stop.
 


pipelineExecutionId
String pipelineExecutionId

 The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action
 to retrieve the current pipelineExecutionId.
 


abandon
Boolean abandon

 Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
 
 
 
 This option can lead to failed or out-of-sequence tasks.
 
 


reason
String reason

 Use this option to enter comments, such as the reason the pipeline was stopped.
 








Class com.amazonaws.services.codepipeline.model.StopPipelineExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelineExecutionId
String pipelineExecutionId

 The unique system-generated ID of the pipeline execution that was stopped.
 








Class com.amazonaws.services.codepipeline.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The tag's key.
 


value
String value

 The tag's value.
 








Class com.amazonaws.services.codepipeline.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource you want to add tags to.
 


tags
List<E> tags

 The tags you want to modify or add to the resource.
 








Class com.amazonaws.services.codepipeline.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.ThirdPartyJob extends Object implements Serializable


Serialized Fields


clientId
String clientId

 The clientToken portion of the clientId and clientToken pair used to
 verify that the calling entity is allowed access to the job and its details.
 


jobId
String jobId

 The identifier used to identify the job in AWS CodePipeline.
 








Class com.amazonaws.services.codepipeline.model.ThirdPartyJobData extends Object implements Serializable


Serialized Fields


actionTypeId
ActionTypeId actionTypeId

 Represents information about an action type.
 


actionConfiguration
ActionConfiguration actionConfiguration

 Represents information about an action configuration.
 


pipelineContext
PipelineContext pipelineContext

 Represents information about a pipeline to a job worker.
 
 
 
 Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.
 
 


inputArtifacts
List<E> inputArtifacts

 The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as
 "MyApp", or it might be defined by the user when the action is created. The input artifact name must match the
 name of an output artifact generated by an action in an earlier action or stage of the pipeline.
 


outputArtifacts
List<E> outputArtifacts

 The name of the artifact that is the result of the action, if any. This name might be system-generated, such as
 "MyBuiltApp", or it might be defined by the user when the action is created.
 


artifactCredentials
AWSSessionCredentials artifactCredentials

 Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS
 Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store
 artifact for the pipeline in AWS CodePipeline.
 


continuationToken
String continuationToken

 A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires 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.
 








Class com.amazonaws.services.codepipeline.model.ThirdPartyJobDetails extends Object implements Serializable


Serialized Fields


id
String id

 The identifier used to identify the job details in AWS CodePipeline.
 


data
ThirdPartyJobData data

 The data to be returned by the third party job worker.
 


nonce
String nonce

 A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one
 job worker. Use this number in an AcknowledgeThirdPartyJob request.
 








Class com.amazonaws.services.codepipeline.model.TooManyTagsException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.TransitionState extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Whether the transition between stages is enabled (true) or disabled (false).
 


lastChangedBy
String lastChangedBy

 The ID of the user who last changed the transition state.
 


lastChangedAt
Date lastChangedAt

 The timestamp when the transition state was last changed.
 


disabledReason
String disabledReason

 The user-specified reason why the transition between two stages of a pipeline was disabled.
 








Class com.amazonaws.services.codepipeline.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource to remove tags from.
 


tagKeys
List<E> tagKeys

 The list of keys for the tags to be removed from the resource.
 








Class com.amazonaws.services.codepipeline.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codepipeline.model.UpdatePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipeline
PipelineDeclaration pipeline

 The name of the pipeline to be updated.
 








Class com.amazonaws.services.codepipeline.model.UpdatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipeline
PipelineDeclaration pipeline

 The structure of the updated pipeline.
 








Class com.amazonaws.services.codepipeline.model.ValidationException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codepipeline.model.WebhookAuthConfiguration extends Object implements Serializable


Serialized Fields


allowedIPRange
String allowedIPRange

 The property used to configure acceptance of webhooks in an IP address range. For IP, only the
 AllowedIPRange property must be set. This property must be set to a valid CIDR range.
 


secretToken
String secretToken

 The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property
 must be set.
 








Class com.amazonaws.services.codepipeline.model.WebhookDefinition extends Object implements Serializable


Serialized Fields


name
String name

 The name of the webhook.
 


targetPipeline
String targetPipeline

 The name of the pipeline you want to connect to the webhook.
 


targetAction
String targetAction

 The name of the action in a pipeline you want to connect to the webhook. The action must be from the source
 (first) stage of the pipeline.
 


filters
List<E> filters

 A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must
 pass for the request to be accepted and the pipeline started.
 


authentication
String authentication

 Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
 
 
 
 
 For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer
 website.
 
 
 
 
 IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the
 authentication configuration.
 
 
 
 
 UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.
 
 
 


authenticationConfiguration
WebhookAuthConfiguration authenticationConfiguration

 Properties that configure the authentication applied to incoming webhook trigger requests. The required
 properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be
 set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For
 UNAUTHENTICATED, no properties can be set.
 








Class com.amazonaws.services.codepipeline.model.WebhookFilterRule extends Object implements Serializable


Serialized Fields


jsonPath
String jsonPath

 A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath
 expression must match the value specified in the MatchEquals field. Otherwise, the request is
 ignored. For more information, see Java JsonPath
 implementation in GitHub.
 


matchEquals
String matchEquals

 The value selected by the JsonPath expression must match what is supplied in the
 MatchEquals field. Otherwise, the request is ignored. Properties from the target action
 configuration can be included as placeholders in this value by surrounding the action configuration key with
 curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an
 action configuration property called "Branch" with a value of "master", the MatchEquals value is
 evaluated as "refs/heads/master". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.
 








Class com.amazonaws.services.codepipeline.model.WebhookNotFoundException extends AWSCodePipelineException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.codestar.model




Class com.amazonaws.services.codestar.model.AssociateTeamMemberRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectId
String projectId

 The ID of the project to which you will add the IAM user.
 


clientRequestToken
String clientRequestToken

 A user- or system-generated token that identifies the entity that requested the team member association to the
 project. This token can be used to repeat the request.
 


userArn
String userArn

 The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.
 


projectRole
String projectRole

 The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in
 an AWS CodeStar project.
 


remoteAccessAllowed
Boolean remoteAccessAllowed

 Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources,
 for example Amazon EC2 instances.
 








Class com.amazonaws.services.codestar.model.AssociateTeamMemberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientRequestToken
String clientRequestToken

 The user- or system-generated token from the initial request that can be used to repeat the request.
 








Class com.amazonaws.services.codestar.model.AWSCodeStarException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.Code extends Object implements Serializable


Serialized Fields


source
CodeSource source

 The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the
 files during project creation.
 


destination
CodeDestination destination

 The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar
 provisions the new repository, the source code files provided with the project request are placed in the
 repository.
 








Class com.amazonaws.services.codestar.model.CodeCommitCodeDestination extends Object implements Serializable


Serialized Fields


name
String name

 The name of the AWS CodeCommit repository to be created in AWS CodeStar.
 








Class com.amazonaws.services.codestar.model.CodeDestination extends Object implements Serializable


Serialized Fields


codeCommit
CodeCommitCodeDestination codeCommit

 Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code
 files provided with the project request will be uploaded after project creation.
 


gitHub
GitHubCodeDestination gitHub

 Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files
 provided with the project request will be uploaded after project creation.
 








Class com.amazonaws.services.codestar.model.CodeSource extends Object implements Serializable


Serialized Fields


s3
S3Location s3

 Information about the Amazon S3 location where the source code files provided with the project request are
 stored.
 








Class com.amazonaws.services.codestar.model.ConcurrentModificationException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.CreateProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The display name for the project to be created in AWS CodeStar.
 


id
String id

 The ID of the project to be created in AWS CodeStar.
 


description
String description

 The description of the project, if any.
 


clientRequestToken
String clientRequestToken

 A user- or system-generated token that identifies the entity that requested project creation. This token can be
 used to repeat the request.
 


sourceCode
List<E> sourceCode

 A list of the Code objects submitted with the project request. If this parameter is specified, the request must
 also include the toolchain parameter.
 


toolchain
Toolchain toolchain

 The name of the toolchain template file submitted with the project request. If this parameter is specified, the
 request must also include the sourceCode parameter.
 


tags
Map<K,V> tags

 The tags created for the project.
 








Class com.amazonaws.services.codestar.model.CreateProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The ID of the project.
 


arn
String arn

 The Amazon Resource Name (ARN) of the created project.
 


clientRequestToken
String clientRequestToken

 A user- or system-generated token that identifies the entity that requested project creation.
 


projectTemplateId
String projectTemplateId

 Reserved for future use.
 








Class com.amazonaws.services.codestar.model.CreateUserProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userArn
String userArn

 The Amazon Resource Name (ARN) of the user in IAM.
 


displayName
String displayName

 The name that will be displayed as the friendly name for the user in AWS CodeStar.
 


emailAddress
String emailAddress

 The email address that will be displayed as part of the user's profile in AWS CodeStar.
 


sshPublicKey
String sshPublicKey

 The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to
 project resources, this public key will be used along with the user's private key for SSH access.
 








Class com.amazonaws.services.codestar.model.CreateUserProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userArn
String userArn

 The Amazon Resource Name (ARN) of the user in IAM.
 


displayName
String displayName

 The name that is displayed as the friendly name for the user in AWS CodeStar.
 


emailAddress
String emailAddress

 The email address that is displayed as part of the user's profile in AWS CodeStar.
 


sshPublicKey
String sshPublicKey

 The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private
 keypair the user can use to access project resources if a project owner allows the user remote access to those
 resources.
 


createdTimestamp
Date createdTimestamp

 The date the user profile was created, in timestamp format.
 


lastModifiedTimestamp
Date lastModifiedTimestamp

 The date the user profile was last modified, in timestamp format.
 








Class com.amazonaws.services.codestar.model.DeleteProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the project to be deleted in AWS CodeStar.
 


clientRequestToken
String clientRequestToken

 A user- or system-generated token that identifies the entity that requested project deletion. This token can be
 used to repeat the request.
 


deleteStack
Boolean deleteStack

 Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the
 project and its resources. This option will delete all AWS resources for the project (except for any buckets in
 Amazon S3) as well as deleting the project itself. Recommended for most use cases.
 








Class com.amazonaws.services.codestar.model.DeleteProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackId
String stackId

 The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its
 resources.
 


projectArn
String projectArn

 The Amazon Resource Name (ARN) of the deleted project.
 








Class com.amazonaws.services.codestar.model.DeleteUserProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userArn
String userArn

 The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.
 








Class com.amazonaws.services.codestar.model.DeleteUserProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userArn
String userArn

 The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.
 








Class com.amazonaws.services.codestar.model.DescribeProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the project.
 








Class com.amazonaws.services.codestar.model.DescribeProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The display name for the project.
 


id
String id

 The ID of the project.
 


arn
String arn

 The Amazon Resource Name (ARN) for the project.
 


description
String description

 The description of the project, if any.
 


clientRequestToken
String clientRequestToken

 A user- or system-generated token that identifies the entity that requested project creation.
 


createdTimeStamp
Date createdTimeStamp

 The date and time the project was created, in timestamp format.
 


stackId
String stackId

 The ID of the primary stack in AWS CloudFormation used to generate resources for the project.
 


projectTemplateId
String projectTemplateId

 The ID for the AWS CodeStar project template used to create the project.
 


status
ProjectStatus status

 The project creation or deletion status.
 








Class com.amazonaws.services.codestar.model.DescribeUserProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userArn
String userArn

 The Amazon Resource Name (ARN) of the user.
 








Class com.amazonaws.services.codestar.model.DescribeUserProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userArn
String userArn

 The Amazon Resource Name (ARN) of the user.
 


displayName
String displayName

 The display name shown for the user in AWS CodeStar projects. For example, this could be set to both first and
 last name ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon
 associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first
 character that appears after the space will be used as the second character in the user initial icon. The initial
 icon displays a maximum of two characters, so a display name with more than one space (for example
 "Mary Jane Major") would generate an initial icon using the first character and the first character after the
 space ("MJ", not "MM").
 


emailAddress
String emailAddress

 The email address for the user. Optional.
 


sshPublicKey
String sshPublicKey

 The SSH public key associated with the user. This SSH public key is associated with the user profile, and can be
 used in conjunction with the associated private key for access to project resources, such as Amazon EC2
 instances, if a project owner grants remote access to those resources.
 


createdTimestamp
Date createdTimestamp

 The date and time when the user profile was created in AWS CodeStar, in timestamp format.
 


lastModifiedTimestamp
Date lastModifiedTimestamp

 The date and time when the user profile was last modified, in timestamp format.
 








Class com.amazonaws.services.codestar.model.DisassociateTeamMemberRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectId
String projectId

 The ID of the AWS CodeStar project from which you want to remove a team member.
 


userArn
String userArn

 The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from the project.
 








Class com.amazonaws.services.codestar.model.DisassociateTeamMemberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codestar.model.GitHubCodeDestination extends Object implements Serializable


Serialized Fields


name
String name

 Name of the GitHub repository to be created in AWS CodeStar.
 


description
String description

 Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after
 the repository is created.
 


type
String type

 The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.
 


owner
String owner

 The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository
 should be owned by a GitHub organization, provide its name.
 


privateRepository
Boolean privateRepository

 Whether the GitHub repository is to be a private repository.
 


issuesEnabled
Boolean issuesEnabled

 Whether to enable issues for the GitHub repository.
 


token
String token

 The GitHub user's personal access token for the GitHub repository.
 








Class com.amazonaws.services.codestar.model.InvalidNextTokenException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.InvalidServiceRoleException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.LimitExceededException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.ListProjectsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The continuation token to be used to return the next set of results, if the results cannot be returned in one
 response.
 


maxResults
Integer maxResults

 The maximum amount of data that can be contained in a single set of results.
 








Class com.amazonaws.services.codestar.model.ListProjectsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


projects
List<E> projects

 A list of projects.
 


nextToken
String nextToken

 The continuation token to use when requesting the next set of results, if there are more results to be returned.
 








Class com.amazonaws.services.codestar.model.ListResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectId
String projectId

 The ID of the project.
 


nextToken
String nextToken

 The continuation token for the next set of results, if the results cannot be returned in one response.
 


maxResults
Integer maxResults

 The maximum amount of data that can be contained in a single set of results.
 








Class com.amazonaws.services.codestar.model.ListResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resources
List<E> resources

 An array of resources associated with the project.
 


nextToken
String nextToken

 The continuation token to use when requesting the next set of results, if there are more results to be returned.
 








Class com.amazonaws.services.codestar.model.ListTagsForProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the project to get tags for.
 


nextToken
String nextToken

 Reserved for future use.
 


maxResults
Integer maxResults

 Reserved for future use.
 








Class com.amazonaws.services.codestar.model.ListTagsForProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The tags for the project.
 


nextToken
String nextToken

 Reserved for future use.
 








Class com.amazonaws.services.codestar.model.ListTeamMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectId
String projectId

 The ID of the project for which you want to list team members.
 


nextToken
String nextToken

 The continuation token for the next set of results, if the results cannot be returned in one response.
 


maxResults
Integer maxResults

 The maximum number of team members you want returned in a response.
 








Class com.amazonaws.services.codestar.model.ListTeamMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


teamMembers
List<E> teamMembers

 A list of team member objects for the project.
 


nextToken
String nextToken

 The continuation token to use when requesting the next set of results, if there are more results to be returned.
 








Class com.amazonaws.services.codestar.model.ListUserProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The continuation token for the next set of results, if the results cannot be returned in one response.
 


maxResults
Integer maxResults

 The maximum number of results to return in a response.
 








Class com.amazonaws.services.codestar.model.ListUserProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userProfiles
List<E> userProfiles

 All the user profiles configured in AWS CodeStar for an AWS account.
 


nextToken
String nextToken

 The continuation token to use when requesting the next set of results, if there are more results to be returned.
 








Class com.amazonaws.services.codestar.model.ProjectAlreadyExistsException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.ProjectConfigurationException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.ProjectCreationFailedException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.ProjectNotFoundException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.ProjectStatus extends Object implements Serializable


Serialized Fields


state
String state

 The phase of completion for a project creation or deletion.
 


reason
String reason

 In the case of a project creation or deletion failure, a reason for the failure.
 








Class com.amazonaws.services.codestar.model.ProjectSummary extends Object implements Serializable


Serialized Fields


projectId
String projectId

 The ID of the project.
 


projectArn
String projectArn

 The Amazon Resource Name (ARN) of the project.
 








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


Serialized Fields


id
String id

 The Amazon Resource Name (ARN) of the resource.
 








Class com.amazonaws.services.codestar.model.S3Location extends Object implements Serializable


Serialized Fields


bucketName
String bucketName

 The Amazon S3 bucket name where the source code files provided with the project request are stored.
 


bucketKey
String bucketKey

 The Amazon S3 object key where the source code files provided with the project request are stored.
 








Class com.amazonaws.services.codestar.model.TagProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the project you want to add a tag to.
 


tags
Map<K,V> tags

 The tags you want to add to the project.
 








Class com.amazonaws.services.codestar.model.TagProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The tags for the project.
 








Class com.amazonaws.services.codestar.model.TeamMember extends Object implements Serializable


Serialized Fields


userArn
String userArn

 The Amazon Resource Name (ARN) of the user in IAM.
 


projectRole
String projectRole

 The role assigned to the user in the project. Project roles have different levels of access. For more
 information, see Working
 with Teams in the AWS CodeStar User Guide.
 


remoteAccessAllowed
Boolean remoteAccessAllowed

 Whether the user is allowed to remotely access project resources using an SSH public/private key pair.
 








Class com.amazonaws.services.codestar.model.TeamMemberAlreadyAssociatedException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.TeamMemberNotFoundException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.Toolchain extends Object implements Serializable


Serialized Fields


source
ToolchainSource source

 The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS
 CodeStar retrieves the file during project creation.
 


roleArn
String roleArn

 The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning.
 


stackParameters
Map<K,V> stackParameters

 The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any.
 








Class com.amazonaws.services.codestar.model.ToolchainSource extends Object implements Serializable


Serialized Fields


s3
S3Location s3

 The Amazon S3 bucket where the toolchain template file provided with the project request is stored.
 








Class com.amazonaws.services.codestar.model.UntagProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the project to remove tags from.
 


tags
List<E> tags

 The tags to remove from the project.
 








Class com.amazonaws.services.codestar.model.UntagProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codestar.model.UpdateProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the project you want to update.
 


name
String name

 The name of the project you want to update.
 


description
String description

 The description of the project, if any.
 








Class com.amazonaws.services.codestar.model.UpdateProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codestar.model.UpdateTeamMemberRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectId
String projectId

 The ID of the project.
 


userArn
String userArn

 The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.
 


projectRole
String projectRole

 The role assigned to the user in the project. Project roles have different levels of access. For more
 information, see Working
 with Teams in the AWS CodeStar User Guide.
 


remoteAccessAllowed
Boolean remoteAccessAllowed

 Whether a team member is allowed to remotely access project resources using the SSH public key associated with
 the user's profile. Even if this is set to True, the user must associate a public key with their profile before
 the user can access resources.
 








Class com.amazonaws.services.codestar.model.UpdateTeamMemberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userArn
String userArn

 The Amazon Resource Name (ARN) of the user whose team membership attributes were updated.
 


projectRole
String projectRole

 The project role granted to the user.
 


remoteAccessAllowed
Boolean remoteAccessAllowed

 Whether a team member is allowed to remotely access project resources using the SSH public key associated with
 the user's profile.
 








Class com.amazonaws.services.codestar.model.UpdateUserProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userArn
String userArn

 The name that will be displayed as the friendly name for the user in AWS CodeStar.
 


displayName
String displayName

 The name that is displayed as the friendly name for the user in AWS CodeStar.
 


emailAddress
String emailAddress

 The email address that is displayed as part of the user's profile in AWS CodeStar.
 


sshPublicKey
String sshPublicKey

 The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to
 project resources, this public key will be used along with the user's private key for SSH access.
 








Class com.amazonaws.services.codestar.model.UpdateUserProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userArn
String userArn

 The Amazon Resource Name (ARN) of the user in IAM.
 


displayName
String displayName

 The name that is displayed as the friendly name for the user in AWS CodeStar.
 


emailAddress
String emailAddress

 The email address that is displayed as part of the user's profile in AWS CodeStar.
 


sshPublicKey
String sshPublicKey

 The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private
 keypair the user can use to access project resources if a project owner allows the user remote access to those
 resources.
 


createdTimestamp
Date createdTimestamp

 The date the user profile was created, in timestamp format.
 


lastModifiedTimestamp
Date lastModifiedTimestamp

 The date the user profile was last modified, in timestamp format.
 








Class com.amazonaws.services.codestar.model.UserProfileAlreadyExistsException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.UserProfileNotFoundException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestar.model.UserProfileSummary extends Object implements Serializable


Serialized Fields


userArn
String userArn

 The Amazon Resource Name (ARN) of the user in IAM.
 


displayName
String displayName

 The display name of a user in AWS CodeStar. For example, this could be set to both first and last name
 ("Mary Major") or a single name ("Mary"). The display name is also used to generate the initial icon associated
 with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that
 appears after the space will be used as the second character in the user initial icon. The initial icon displays
 a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would
 generate an initial icon using the first character and the first character after the space ("MJ", not "MM").
 


emailAddress
String emailAddress

 The email address associated with the user.
 


sshPublicKey
String sshPublicKey

 The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to
 project resources, this public key will be used along with the user's private key for SSH access.
 








Class com.amazonaws.services.codestar.model.ValidationException extends AWSCodeStarException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.codestarconnections.model




Class com.amazonaws.services.codestarconnections.model.AWSCodeStarconnectionsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestarconnections.model.Connection extends Object implements Serializable


Serialized Fields


connectionName
String connectionName

 The name of the connection. Connection names must be unique in an AWS user account.
 


connectionArn
String connectionArn

 The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection
 is shared between AWS services.
 
 
 
 The ARN is never reused if the connection is deleted.
 
 


providerType
String providerType

 The name of the external provider where your third-party code repository is configured. Currently, the valid
 provider type is Bitbucket.
 


ownerAccountId
String ownerAccountId

 The name of the external provider where your third-party code repository is configured. For Bitbucket, this is
 the account ID of the owner of the Bitbucket repository.
 


connectionStatus
String connectionStatus

 The current status of the connection.
 








Class com.amazonaws.services.codestarconnections.model.CreateConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


providerType
String providerType

 The name of the external provider where your third-party code repository is configured. Currently, the valid
 provider type is Bitbucket.
 


connectionName
String connectionName

 The name of the connection to be created. The name must be unique in the calling AWS account.
 








Class com.amazonaws.services.codestarconnections.model.CreateConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectionArn
String connectionArn

 The Amazon Resource Name (ARN) of the connection to be created. The ARN is used as the connection reference when
 the connection is shared between AWS services.
 
 
 
 The ARN is never reused if the connection is deleted.
 
 








Class com.amazonaws.services.codestarconnections.model.DeleteConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionArn
String connectionArn

 The Amazon Resource Name (ARN) of the connection to be deleted.
 
 
 
 The ARN is never reused if the connection is deleted.
 
 








Class com.amazonaws.services.codestarconnections.model.DeleteConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codestarconnections.model.GetConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionArn
String connectionArn

 The Amazon Resource Name (ARN) of a connection.
 








Class com.amazonaws.services.codestarconnections.model.GetConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connection
Connection connection

 The connection details, such as status, owner, and provider type.
 








Class com.amazonaws.services.codestarconnections.model.LimitExceededException extends AWSCodeStarconnectionsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestarconnections.model.ListConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


providerTypeFilter
String providerTypeFilter

 Filters the list of connections to those associated with a specified provider, such as Bitbucket.
 


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

 The token that was returned from the previous ListConnections call, which can be used to return the
 next set of connections in the list.
 








Class com.amazonaws.services.codestarconnections.model.ListConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connections
List<E> connections

 A list of connections and the details for each connection, such as status, owner, and provider type.
 


nextToken
String nextToken

 A token that can be used in the next ListConnections call. To view all items in the list, continue
 to call this operation with each subsequent token until no more nextToken values are returned.
 








Class com.amazonaws.services.codestarconnections.model.ResourceNotFoundException extends AWSCodeStarconnectionsException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.codestarnotifications.model




Class com.amazonaws.services.codestarnotifications.model.AccessDeniedException extends AWSCodeStarNotificationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestarnotifications.model.AWSCodeStarNotificationsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestarnotifications.model.ConcurrentModificationException extends AWSCodeStarNotificationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestarnotifications.model.ConfigurationException extends AWSCodeStarNotificationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestarnotifications.model.CreateNotificationRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name for the notification rule. Notifictaion rule names must be unique in your AWS account.
 


eventTypeIds
List<E> eventTypeIds

 A list of event types associated with this notification rule. For a list of allowed events, see
 EventTypeSummary.
 


resource
String resource

 The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources
 include pipelines in AWS CodePipeline, repositories in AWS CodeCommit, and build projects in AWS CodeBuild.
 


targets
List<E> targets

 A list of Amazon Resource Names (ARNs) of SNS topics to associate with the notification rule.
 


detailType
String detailType

 The level of detail to include in the notifications for this resource. BASIC will include only the contents of
 the event as it would appear in AWS CloudWatch. FULL will include any supplemental information provided by AWS
 CodeStar Notifications and/or the service for the resource for which the notification is created.
 


clientRequestToken
String clientRequestToken

 A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be
 repeated with a changed parameter. If a request with the same parameters is received and a token is included, the
 request returns information about the initial request that used that token.
 
 
 
 The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for
 you.
 
 


tags
Map<K,V> tags

 A list of tags to apply to this notification rule. Key names cannot start with "aws".
 


status
String status

 The status of the notification rule. The default value is ENABLED. If the status is set to DISABLED,
 notifications aren't sent for the notification rule.
 








Class com.amazonaws.services.codestarnotifications.model.CreateNotificationRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the notification rule.
 








Class com.amazonaws.services.codestarnotifications.model.DeleteNotificationRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the notification rule you want to delete.
 








Class com.amazonaws.services.codestarnotifications.model.DeleteNotificationRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the deleted notification rule.
 








Class com.amazonaws.services.codestarnotifications.model.DeleteTargetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetAddress
String targetAddress

 The Amazon Resource Name (ARN) of the SNS topic to delete.
 


forceUnsubscribeAll
Boolean forceUnsubscribeAll

 A Boolean value that can be used to delete all associations with this SNS topic. The default value is FALSE. If
 set to TRUE, all associations between that target and every notification rule in your AWS account are deleted.
 








Class com.amazonaws.services.codestarnotifications.model.DeleteTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codestarnotifications.model.DescribeNotificationRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the notification rule.
 








Class com.amazonaws.services.codestarnotifications.model.DescribeNotificationRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the notification rule.
 


name
String name

 The name of the notification rule.
 


eventTypes
List<E> eventTypes

 A list of the event types associated with the notification rule.
 


resource
String resource

 The Amazon Resource Name (ARN) of the resource associated with the notification rule.
 


targets
List<E> targets

 A list of the SNS topics associated with the notification rule.
 


detailType
String detailType

 The level of detail included in the notifications for this resource. BASIC will include only the contents of the
 event as it would appear in AWS CloudWatch. FULL will include any supplemental information provided by AWS
 CodeStar Notifications and/or the service for the resource for which the notification is created.
 


createdBy
String createdBy

 The name or email alias of the person who created the notification rule.
 


status
String status

 The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending
 notifications).
 


createdTimestamp
Date createdTimestamp

 The date and time the notification rule was created, in timestamp format.
 


lastModifiedTimestamp
Date lastModifiedTimestamp

 The date and time the notification rule was most recently updated, in timestamp format.
 


tags
Map<K,V> tags

 The tags associated with the notification rule.
 








Class com.amazonaws.services.codestarnotifications.model.EventTypeSummary extends Object implements Serializable


Serialized Fields


eventTypeId
String eventTypeId

 The system-generated ID of the event.
 


serviceName
String serviceName

 The name of the service for which the event applies.
 


eventTypeName
String eventTypeName

 The name of the event.
 


resourceType
String resourceType

 The resource type of the event.
 








Class com.amazonaws.services.codestarnotifications.model.InvalidNextTokenException extends AWSCodeStarNotificationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestarnotifications.model.LimitExceededException extends AWSCodeStarNotificationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestarnotifications.model.ListEventTypesFilter extends Object implements Serializable


Serialized Fields


name
String name

 The system-generated name of the filter type you want to filter by.
 


value
String value

 The name of the resource type (for example, pipeline) or service name (for example, CodePipeline) that you want
 to filter by.
 








Class com.amazonaws.services.codestarnotifications.model.ListEventTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 The filters to use to return information by service or resource type.
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 


maxResults
Integer maxResults

 A non-negative integer used to limit the number of returned results. The default number is 50. The maximum number
 of results that can be returned is 100.
 








Class com.amazonaws.services.codestarnotifications.model.ListEventTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventTypes
List<E> eventTypes

 Information about each event, including service name, resource type, event ID, and event name.
 


nextToken
String nextToken

 An enumeration token that can be used in a request to return the next batch of the results.
 








Class com.amazonaws.services.codestarnotifications.model.ListNotificationRulesFilter extends Object implements Serializable


Serialized Fields


name
String name

 The name of the attribute you want to use to filter the returned notification rules.
 


value
String value

 The value of the attribute you want to use to filter the returned notification rules. For example, if you specify
 filtering by RESOURCE in Name, you might specify the ARN of a pipeline in AWS CodePipeline for the value.
 








Class com.amazonaws.services.codestarnotifications.model.ListNotificationRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 The filters to use to return information by service or resource type. For valid values, see
 ListNotificationRulesFilter.
 
 
 
 A filter with the same name can appear more than once when used with OR statements. Filters with different names
 should be applied with AND statements.
 
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 


maxResults
Integer maxResults

 A non-negative integer used to limit the number of returned results. The maximum number of results that can be
 returned is 100.
 








Class com.amazonaws.services.codestarnotifications.model.ListNotificationRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 An enumeration token that can be used in a request to return the next batch of the results.
 


notificationRules
List<E> notificationRules

 The list of notification rules for the AWS account, by Amazon Resource Name (ARN) and ID.
 








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


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) for the notification rule.
 








Class com.amazonaws.services.codestarnotifications.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The tags associated with the notification rule.
 








Class com.amazonaws.services.codestarnotifications.model.ListTargetsFilter extends Object implements Serializable


Serialized Fields


name
String name

 The name of the attribute you want to use to filter the returned targets.
 


value
String value

 The value of the attribute you want to use to filter the returned targets. For example, if you specify SNS
 for the Target type, you could specify an Amazon Resource Name (ARN) for a topic as the value.
 








Class com.amazonaws.services.codestarnotifications.model.ListTargetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 The filters to use to return information by service or resource type. Valid filters include target type, target
 address, and target status.
 
 
 
 A filter with the same name can appear more than once when used with OR statements. Filters with different names
 should be applied with AND statements.
 
 


nextToken
String nextToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 


maxResults
Integer maxResults

 A non-negative integer used to limit the number of returned results. The maximum number of results that can be
 returned is 100.
 








Class com.amazonaws.services.codestarnotifications.model.ListTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


targets
List<E> targets

 The list of notification rule targets.
 


nextToken
String nextToken

 An enumeration token that can be used in a request to return the next batch of results.
 








Class com.amazonaws.services.codestarnotifications.model.NotificationRuleSummary extends Object implements Serializable


Serialized Fields


id
String id

 The unique ID of the notification rule.
 


arn
String arn

 The Amazon Resource Name (ARN) of the notification rule.
 








Class com.amazonaws.services.codestarnotifications.model.ResourceAlreadyExistsException extends AWSCodeStarNotificationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestarnotifications.model.ResourceNotFoundException extends AWSCodeStarNotificationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.codestarnotifications.model.SubscribeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.
 


target
Target target


clientRequestToken
String clientRequestToken

 An enumeration token that, when provided in a request, returns the next batch of the results.
 








Class com.amazonaws.services.codestarnotifications.model.SubscribeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.
 








Class com.amazonaws.services.codestarnotifications.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the notification rule to tag.
 


tags
Map<K,V> tags

 The list of tags to associate with the resource. Tag key names cannot start with "aws".
 








Class com.amazonaws.services.codestarnotifications.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The list of tags associated with the resource.
 








Class com.amazonaws.services.codestarnotifications.model.Target extends Object implements Serializable


Serialized Fields


targetType
String targetType

 The target type. Can be an Amazon SNS topic.
 


targetAddress
String targetAddress

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








Class com.amazonaws.services.codestarnotifications.model.TargetSummary extends Object implements Serializable


Serialized Fields


targetAddress
String targetAddress

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


targetType
String targetType

 The type of the target (for example, SNS).
 


targetStatus
String targetStatus

 The status of the target.
 








Class com.amazonaws.services.codestarnotifications.model.UnsubscribeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the notification rule.
 


targetAddress
String targetAddress

 The ARN of the SNS topic to unsubscribe from the notification rule.
 








Class com.amazonaws.services.codestarnotifications.model.UnsubscribeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the the notification rule from which you have removed a subscription.
 








Class com.amazonaws.services.codestarnotifications.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the notification rule from which to remove the tags.
 


tagKeys
List<E> tagKeys

 The key names of the tags to remove.
 








Class com.amazonaws.services.codestarnotifications.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codestarnotifications.model.UpdateNotificationRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the notification rule.
 


name
String name

 The name of the notification rule.
 


status
String status

 The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not
 sending notifications).
 


eventTypeIds
List<E> eventTypeIds

 A list of event types associated with this notification rule.
 


targets
List<E> targets

 The address and type of the targets to receive notifications from this notification rule.
 


detailType
String detailType

 The level of detail to include in the notifications for this resource. BASIC will include only the contents of
 the event as it would appear in AWS CloudWatch. FULL will include any supplemental information provided by AWS
 CodeStar Notifications and/or the service for the resource for which the notification is created.
 








Class com.amazonaws.services.codestarnotifications.model.UpdateNotificationRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.codestarnotifications.model.ValidationException extends AWSCodeStarNotificationsException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.cognitoidentity.model




Class com.amazonaws.services.cognitoidentity.model.AmazonCognitoIdentityException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidentity.model.CognitoIdentityProvider extends Object implements Serializable


Serialized Fields


providerName
String providerName

 The provider name for an Amazon Cognito user pool. For example,
 cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
 


clientId
String clientId

 The client ID for the Amazon Cognito user pool.
 


serverSideTokenCheck
Boolean serverSideTokenCheck

 TRUE if server-side token validation is enabled for the identity provider’s token.
 
 
 Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with
 the integrated user pools to make sure that the user has not been globally signed out or deleted before the
 identity pool provides an OIDC token or AWS credentials for the user.
 
 
 If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.
 








Class com.amazonaws.services.cognitoidentity.model.ConcurrentModificationException extends AmazonCognitoIdentityException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolName
String identityPoolName

 A string that you provide.
 


allowUnauthenticatedIdentities
Boolean allowUnauthenticatedIdentities

 TRUE if the identity pool supports unauthenticated logins.
 


allowClassicFlow
Boolean allowClassicFlow

 Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools
 (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
 


supportedLoginProviders
Map<K,V> supportedLoginProviders

 Optional key:value pairs mapping provider names to provider app IDs.
 


developerProviderName
String developerProviderName

 The "domain" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend
 and the Cognito service to communicate about the developer provider. For the DeveloperProviderName,
 you can use letters as well as period (.), underscore (_), and dash (-).
 
 
 Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.
 


openIdConnectProviderARNs
List<E> openIdConnectProviderARNs

 A list of OpendID Connect provider ARNs.
 


cognitoIdentityProviders
List<E> cognitoIdentityProviders

 An array of Amazon Cognito user pools and their client IDs.
 


samlProviderARNs
List<E> samlProviderARNs

 An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
 


identityPoolTags
Map<K,V> identityPoolTags

 Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and
 manage them in different ways, such as by purpose, owner, environment, or other criteria.
 








Class com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


identityPoolName
String identityPoolName

 A string that you provide.
 


allowUnauthenticatedIdentities
Boolean allowUnauthenticatedIdentities

 TRUE if the identity pool supports unauthenticated logins.
 


allowClassicFlow
Boolean allowClassicFlow

 Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools
 (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
 


supportedLoginProviders
Map<K,V> supportedLoginProviders

 Optional key:value pairs mapping provider names to provider app IDs.
 


developerProviderName
String developerProviderName

 The "domain" by which Cognito will refer to your users.
 


openIdConnectProviderARNs
List<E> openIdConnectProviderARNs

 A list of OpendID Connect provider ARNs.
 


cognitoIdentityProviders
List<E> cognitoIdentityProviders

 A list representing an Amazon Cognito user pool and its client ID.
 


samlProviderARNs
List<E> samlProviderARNs

 An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
 


identityPoolTags
Map<K,V> identityPoolTags

 The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to
 categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
 








Class com.amazonaws.services.cognitoidentity.model.Credentials extends Object implements Serializable


Serialized Fields


accessKeyId
String accessKeyId

 The Access Key portion of the credentials.
 


secretKey
String secretKey

 The Secret Access Key portion of the credentials
 


sessionToken
String sessionToken

 The Session Token portion of the credentials
 


expiration
Date expiration

 The date at which these credentials will expire.
 








Class com.amazonaws.services.cognitoidentity.model.DeleteIdentitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityIdsToDelete
List<E> identityIdsToDelete

 A list of 1-60 identities that you want to delete.
 








Class com.amazonaws.services.cognitoidentity.model.DeleteIdentitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unprocessedIdentityIds
List<E> unprocessedIdentityIds

 An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
 








Class com.amazonaws.services.cognitoidentity.model.DeleteIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 








Class com.amazonaws.services.cognitoidentity.model.DeleteIdentityPoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 








Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityPoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


identityPoolName
String identityPoolName

 A string that you provide.
 


allowUnauthenticatedIdentities
Boolean allowUnauthenticatedIdentities

 TRUE if the identity pool supports unauthenticated logins.
 


allowClassicFlow
Boolean allowClassicFlow

 Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools
 (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
 


supportedLoginProviders
Map<K,V> supportedLoginProviders

 Optional key:value pairs mapping provider names to provider app IDs.
 


developerProviderName
String developerProviderName

 The "domain" by which Cognito will refer to your users.
 


openIdConnectProviderARNs
List<E> openIdConnectProviderARNs

 A list of OpendID Connect provider ARNs.
 


cognitoIdentityProviders
List<E> cognitoIdentityProviders

 A list representing an Amazon Cognito user pool and its client ID.
 


samlProviderARNs
List<E> samlProviderARNs

 An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
 


identityPoolTags
Map<K,V> identityPoolTags

 The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to
 categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
 








Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 








Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 


logins
List<E> logins

 The provider names.
 


creationDate
Date creationDate

 Date on which the identity was created.
 


lastModifiedDate
Date lastModifiedDate

 Date on which the identity was last modified.
 








Class com.amazonaws.services.cognitoidentity.model.DeveloperUserAlreadyRegisteredException extends AmazonCognitoIdentityException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidentity.model.ExternalServiceException extends AmazonCognitoIdentityException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidentity.model.GetCredentialsForIdentityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 


logins
Map<K,V> logins

 A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow
 the syntax "provider_name": "provider_user_identifier".
 
 
 Logins should not be specified when trying to get credentials for an unauthenticated identity.
 
 
 The Logins parameter is required when using identities associated with external identity providers such as
 FaceBook. For examples of Logins maps, see the code examples in the External
 Identity Providers section of the Amazon Cognito Developer Guide.
 


customRoleArn
String customRoleArn

 The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the
 identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers
 that do not support role customization.
 








Class com.amazonaws.services.cognitoidentity.model.GetCredentialsForIdentityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 


credentials
Credentials credentials

 Credentials for the provided identity ID.
 








Class com.amazonaws.services.cognitoidentity.model.GetIdentityPoolRolesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 








Class com.amazonaws.services.cognitoidentity.model.GetIdentityPoolRolesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


roles
Map<K,V> roles

 The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
 


roleMappings
Map<K,V> roleMappings

 How users for a specific identity provider are to mapped to roles. This is a String-to-RoleMapping object
 map. The string identifies the identity provider, for example, "graph.facebook.com" or
 "cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".
 








Class com.amazonaws.services.cognitoidentity.model.GetIdRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 A standard AWS account ID (9+ digits).
 


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


logins
Map<K,V> logins

 A set of optional name-value pairs that map provider names to provider tokens. The available provider names for
 Logins are as follows:
 
 
 
 
 Facebook: graph.facebook.com
 
 
 
 
 Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID>, for
 example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
 
 
 
 
 Google: accounts.google.com
 
 
 
 
 Amazon: www.amazon.com
 
 
 
 
 Twitter: api.twitter.com
 
 
 
 
 Digits: www.digits.com
 
 
 








Class com.amazonaws.services.cognitoidentity.model.GetIdResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 








Class com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 


logins
Map<K,V> logins

 A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a
 user from a public provider or developer provider. If the user is from a developer provider, the name-value pair
 will follow the syntax "developer_provider_name": "developer_user_identifier". The developer
 provider is the "domain" by which Cognito will refer to your users; you provided this domain while
 creating/updating the identity pool. The developer user identifier is an identifier from your backend that
 uniquely identifies a user. When you create an identity pool, you can specify the supported logins.
 


tokenDuration
Long tokenDuration

 The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you
 can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the
 token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token
 duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are
 significant security implications: an attacker could use a leaked token to access your AWS resources for the
 token's duration.
 
 
 
 Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.
 
 








Class com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 


token
String token

 An OpenID token.
 








Class com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 


logins
Map<K,V> logins

 A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and
 www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon
 Cognito user pool provider, or any other OpenId Connect provider, always include the id_token.
 








Class com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenResult extends AmazonWebServiceResult<ResponseMetadata> 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 10 minutes.
 








Class com.amazonaws.services.cognitoidentity.model.IdentityDescription extends Object implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 


logins
List<E> logins

 The provider names.
 


creationDate
Date creationDate

 Date on which the identity was created.
 


lastModifiedDate
Date lastModifiedDate

 Date on which the identity was last modified.
 








Class com.amazonaws.services.cognitoidentity.model.IdentityPoolShortDescription extends Object implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


identityPoolName
String identityPoolName

 A string that you provide.
 








Class com.amazonaws.services.cognitoidentity.model.InternalErrorException extends AmazonCognitoIdentityException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidentity.model.InvalidIdentityPoolConfigurationException extends AmazonCognitoIdentityException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidentity.model.InvalidParameterException extends AmazonCognitoIdentityException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidentity.model.LimitExceededException extends AmazonCognitoIdentityException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidentity.model.ListIdentitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


maxResults
Integer maxResults

 The maximum number of identities to return.
 


nextToken
String nextToken

 A pagination token.
 


hideDisabled
Boolean hideDisabled

 An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API
 will include disabled identities in the response.
 








Class com.amazonaws.services.cognitoidentity.model.ListIdentitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


identities
List<E> identities

 An object containing a set of identities and associated mappings.
 


nextToken
String nextToken

 A pagination token.
 








Class com.amazonaws.services.cognitoidentity.model.ListIdentityPoolsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of identities to return.
 


nextToken
String nextToken

 A pagination token.
 








Class com.amazonaws.services.cognitoidentity.model.ListIdentityPoolsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityPools
List<E> identityPools

 The identity pools returned by the ListIdentityPools action.
 


nextToken
String nextToken

 A pagination token.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.
 








Class com.amazonaws.services.cognitoidentity.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The tags that are assigned to the identity pool.
 








Class com.amazonaws.services.cognitoidentity.model.LookupDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 


developerUserIdentifier
String developerUserIdentifier

 A unique ID used by your backend authentication process to identify a user. Typically, a developer identity
 provider would issue many developer user identifiers, in keeping with the number of users.
 


maxResults
Integer maxResults

 The maximum number of identities to return.
 


nextToken
String nextToken

 A pagination token. The first call you make will have NextToken set to null. After that the service
 will return NextToken values as needed. For example, let's say you make a request with
 MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination
 token as a part of the response. This token can be used to call the API again and get results starting from the
 11th match.
 








Class com.amazonaws.services.cognitoidentity.model.LookupDeveloperIdentityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 


developerUserIdentifierList
List<E> developerUserIdentifierList

 This is the list of developer user identifiers associated with an identity ID. Cognito supports the association
 of multiple developer user identifiers with an identity ID.
 


nextToken
String nextToken

 A pagination token. The first call you make will have NextToken set to null. After that the service
 will return NextToken values as needed. For example, let's say you make a request with
 MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination
 token as a part of the response. This token can be used to call the API again and get results starting from the
 11th match.
 








Class com.amazonaws.services.cognitoidentity.model.MappingRule extends Object implements Serializable


Serialized Fields


claim
String claim

 The claim name that must be present in the token, for example, "isAdmin" or "paid".
 


matchType
String matchType

 The match condition that specifies how closely the claim value in the IdP token must match Value.
 


value
String value

 A brief string that the claim must match, for example, "paid" or "yes".
 


roleARN
String roleARN

 The role ARN.
 








Class com.amazonaws.services.cognitoidentity.model.MergeDeveloperIdentitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceUserIdentifier
String sourceUserIdentifier

 User identifier for the source user. The value should be a DeveloperUserIdentifier.
 


destinationUserIdentifier
String destinationUserIdentifier

 User identifier for the destination user. The value should be a DeveloperUserIdentifier.
 


developerProviderName
String developerProviderName

 The "domain" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while
 creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to
 communicate about the developer provider. For the DeveloperProviderName, you can use letters as well
 as period (.), underscore (_), and dash (-).
 


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 








Class com.amazonaws.services.cognitoidentity.model.MergeDeveloperIdentitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 








Class com.amazonaws.services.cognitoidentity.model.NotAuthorizedException extends AmazonCognitoIdentityException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidentity.model.ResourceConflictException extends AmazonCognitoIdentityException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidentity.model.ResourceNotFoundException extends AmazonCognitoIdentityException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidentity.model.RoleMapping extends Object implements Serializable


Serialized Fields


type
String type

 The role mapping type. Token will use cognito:roles and cognito:preferred_role claims
 from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the
 token to map to a role.
 


ambiguousRoleResolution
String ambiguousRoleResolution

 If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.
 
 
 Specifies the action to be taken if either no rules match the claim value for the Rules type, or
 there is no cognito:preferred_role claim and there are multiple cognito:roles matches
 for the Token type.
 


rulesConfiguration
RulesConfigurationType rulesConfiguration

 The rules to be used for mapping users to roles.
 
 
 If you specify Rules as the role mapping type, RulesConfiguration is required.
 








Class com.amazonaws.services.cognitoidentity.model.RulesConfigurationType extends Object implements Serializable


Serialized Fields


rules
List<E> rules

 An array of rules. You can specify up to 25 rules per identity provider.
 
 
 Rules are evaluated in order. The first one to match specifies the role.
 








Class com.amazonaws.services.cognitoidentity.model.SetIdentityPoolRolesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


roles
Map<K,V> roles

 The map of roles associated with this pool. For a given role, the key will be either "authenticated" or
 "unauthenticated" and the value will be the Role ARN.
 


roleMappings
Map<K,V> roleMappings

 How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object
 map. The string identifies the identity provider, for example, "graph.facebook.com" or
 "cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".
 
 
 Up to 25 rules can be specified per identity provider.
 








Class com.amazonaws.services.cognitoidentity.model.SetIdentityPoolRolesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidentity.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the identity pool to assign the tags to.
 


tags
Map<K,V> tags

 The tags to assign to the identity pool.
 








Class com.amazonaws.services.cognitoidentity.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidentity.model.TooManyRequestsException extends AmazonCognitoIdentityException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidentity.model.UnlinkDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


developerProviderName
String developerProviderName

 The "domain" by which Cognito will refer to your users.
 


developerUserIdentifier
String developerUserIdentifier

 A unique ID used by your backend authentication process to identify a user.
 








Class com.amazonaws.services.cognitoidentity.model.UnlinkDeveloperIdentityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidentity.model.UnlinkIdentityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 


logins
Map<K,V> logins

 A set of optional name-value pairs that map provider names to provider tokens.
 


loginsToRemove
List<E> loginsToRemove

 Provider names to unlink from this identity.
 








Class com.amazonaws.services.cognitoidentity.model.UnlinkIdentityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidentity.model.UnprocessedIdentityId extends Object implements Serializable


Serialized Fields


identityId
String identityId

 A unique identifier in the format REGION:GUID.
 


errorCode
String errorCode

 The error code indicating the type of error that occurred.
 








Class com.amazonaws.services.cognitoidentity.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.
 


tagKeys
List<E> tagKeys

 The keys of the tags to remove from the user pool.
 








Class com.amazonaws.services.cognitoidentity.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidentity.model.UpdateIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


identityPoolName
String identityPoolName

 A string that you provide.
 


allowUnauthenticatedIdentities
Boolean allowUnauthenticatedIdentities

 TRUE if the identity pool supports unauthenticated logins.
 


allowClassicFlow
Boolean allowClassicFlow

 Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools
 (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
 


supportedLoginProviders
Map<K,V> supportedLoginProviders

 Optional key:value pairs mapping provider names to provider app IDs.
 


developerProviderName
String developerProviderName

 The "domain" by which Cognito will refer to your users.
 


openIdConnectProviderARNs
List<E> openIdConnectProviderARNs

 A list of OpendID Connect provider ARNs.
 


cognitoIdentityProviders
List<E> cognitoIdentityProviders

 A list representing an Amazon Cognito user pool and its client ID.
 


samlProviderARNs
List<E> samlProviderARNs

 An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
 


identityPoolTags
Map<K,V> identityPoolTags

 The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to
 categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
 








Class com.amazonaws.services.cognitoidentity.model.UpdateIdentityPoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 An identity pool ID in the format REGION:GUID.
 


identityPoolName
String identityPoolName

 A string that you provide.
 


allowUnauthenticatedIdentities
Boolean allowUnauthenticatedIdentities

 TRUE if the identity pool supports unauthenticated logins.
 


allowClassicFlow
Boolean allowClassicFlow

 Enables or disables the Basic (Classic) authentication flow. For more information, see Identity Pools
 (Federated Identities) Authentication Flow in the Amazon Cognito Developer Guide.
 


supportedLoginProviders
Map<K,V> supportedLoginProviders

 Optional key:value pairs mapping provider names to provider app IDs.
 


developerProviderName
String developerProviderName

 The "domain" by which Cognito will refer to your users.
 


openIdConnectProviderARNs
List<E> openIdConnectProviderARNs

 A list of OpendID Connect provider ARNs.
 


cognitoIdentityProviders
List<E> cognitoIdentityProviders

 A list representing an Amazon Cognito user pool and its client ID.
 


samlProviderARNs
List<E> samlProviderARNs

 An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.
 


identityPoolTags
Map<K,V> identityPoolTags

 The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to
 categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.
 








Package com.amazonaws.services.cognitoidp.model




Class com.amazonaws.services.cognitoidp.model.AccountRecoverySettingType extends Object implements Serializable


Serialized Fields


recoveryMechanisms
List<E> recoveryMechanisms

 The list of RecoveryOptionTypes.
 








Class com.amazonaws.services.cognitoidp.model.AccountTakeoverActionsType extends Object implements Serializable


Serialized Fields


lowAction
AccountTakeoverActionType lowAction

 Action to take for a low risk.
 


mediumAction
AccountTakeoverActionType mediumAction

 Action to take for a medium risk.
 


highAction
AccountTakeoverActionType highAction

 Action to take for a high risk.
 








Class com.amazonaws.services.cognitoidp.model.AccountTakeoverActionType extends Object implements Serializable


Serialized Fields


notify
Boolean notify

 Flag specifying whether to send a notification.
 


eventAction
String eventAction

 The event action.
 
 
 
 
 BLOCK Choosing this action will block the request.
 
 
 
 
 MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request.
 
 
 
 
 MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request.
 
 
 
 
 NO_ACTION Allow the user sign-in.
 
 
 








Class com.amazonaws.services.cognitoidp.model.AccountTakeoverRiskConfigurationType extends Object implements Serializable


Serialized Fields


notifyConfiguration
NotifyConfigurationType notifyConfiguration

 The notify configuration used to construct email notifications.
 


actions
AccountTakeoverActionsType actions

 Account takeover risk configuration actions
 








Class com.amazonaws.services.cognitoidp.model.AddCustomAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to add custom attributes.
 


customAttributes
List<E> customAttributes

 An array of custom attributes, such as Mutable and Name.
 








Class com.amazonaws.services.cognitoidp.model.AddCustomAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminAddUserToGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


username
String username

 The username for the user.
 


groupName
String groupName

 The group name.
 








Class com.amazonaws.services.cognitoidp.model.AdminAddUserToGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminConfirmSignUpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for which you want to confirm user registration.
 


username
String username

 The user name for which you want to confirm user registration.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda
 function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function,
 it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata
 attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request.
 In your function code in AWS Lambda, you can process the ClientMetadata value to enhance your workflow for your
 specific needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.AdminConfirmSignUpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminCreateUserConfigType extends Object implements Serializable


Serialized Fields


allowAdminCreateUserOnly
Boolean allowAdminCreateUserOnly

 Set to True if only the administrator is allowed to create user profiles. Set to False
 if users can sign themselves up via an app.
 


unusedAccountValidityDays
Integer unusedAccountValidityDays

 The user account expiration limit, in days, after which the account is no longer usable. To reset the account
 after that time limit, you must call AdminCreateUser again, specifying "RESEND" for the
 MessageAction parameter. The default value for this parameter is 7.
 
 
 
 If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will
 be used and UnusedAccountValidityDays will be deprecated for that user pool.
 
 


inviteMessageTemplate
MessageTemplateType inviteMessageTemplate

 The message template to be used for the welcome message to new users.
 
 
 See also Customizing User Invitation Messages.
 








Class com.amazonaws.services.cognitoidp.model.AdminCreateUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where the user will be created.
 


username
String username

 The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128
 characters. After the user is created, the username cannot be changed.
 


userAttributes
List<E> userAttributes

 An array of name-value pairs that contain user attributes and attribute values to be set for the user to be
 created. You can create a user without specifying any attributes other than Username. However, any
 attributes that you specify as required (in or in the Attributes tab of the console) must be supplied
 either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response
 to your welcome message).
 
 
 For custom attributes, you must prepend the custom: prefix to the attribute name.
 
 
 To send a message inviting the user to sign up, you must specify the user's email address or phone number. This
 can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing
 your user pools.
 
 
 In your call to AdminCreateUser, you can set the email_verified attribute to
 True, and you can set the phone_number_verified attribute to True. (You
 can also do this by calling .)
 
 
 
 
 email: The email address of the user to whom the message that contains the code and username will be sent.
 Required if the email_verified attribute is set to True, or if "EMAIL" is
 specified in the DesiredDeliveryMediums parameter.
 
 
 
 
 phone_number: The phone number of the user to whom the message that contains the code and username will be
 sent. Required if the phone_number_verified attribute is set to True, or if
 "SMS" is specified in the DesiredDeliveryMediums parameter.
 
 
 


validationData
List<E> validationData

 The user's validation data. This is an array of name-value pairs that contain user attributes and attribute
 values that you can use for custom validation, such as restricting the types of user accounts that can be
 registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.
 
 
 To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in
 the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation
 process.
 
 
 The user's validation data is not persisted.
 


temporaryPassword
String temporaryPassword

 The user's temporary password. This password must conform to the password policy that you specified when you
 created the user pool.
 
 
 The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the
 temporary password in the sign-in page along with a new password to be used in all future sign-ins.
 
 
 This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.
 
 
 The temporary password can only be used until the user account expiration limit that you specified when you
 created the user pool. To reset the account after that time limit, you must call AdminCreateUser
 again, specifying "RESEND" for the MessageAction parameter.
 


forceAliasCreation
Boolean forceAliasCreation

 This parameter is only used if the phone_number_verified or email_verified attribute is
 set to True. Otherwise, it is ignored.
 
 
 If this parameter is set to True and the phone number or email address specified in the
 UserAttributes parameter 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. The previous user will no longer be able to log in using that
 alias.
 
 
 If this parameter is set to False, the API throws an AliasExistsException error if the
 alias already exists. The default value is False.
 


messageAction
String messageAction

 Set to "RESEND" to resend the invitation message to a user that already exists and reset the
 expiration limit on the user's account. Set to "SUPPRESS" to suppress sending the message. Only one
 value can be specified.
 


desiredDeliveryMediums
List<E> desiredDeliveryMediums

 Specify "EMAIL" if email will be used to send the welcome message. Specify "SMS" if the
 phone number will be used. The default value is "SMS". More than one value can be specified.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up
 trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as
 input. This payload contains a clientMetadata attribute, which provides the data that you assigned
 to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda, you can
 process the clientMetadata value to enhance your workflow for your specific needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.AdminCreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


user
UserType user

 The newly created user.
 








Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to delete user attributes.
 


username
String username

 The user name of the user from which you would like to delete attributes.
 


userAttributeNames
List<E> userAttributeNames

 An array of strings representing the user attribute names you wish to delete.
 
 
 For custom attributes, you must prepend the custom: prefix to the attribute name.
 








Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to delete the user.
 


username
String username

 The user name of the user you wish to delete.
 








Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminDisableProviderForUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


user
ProviderUserIdentifierType user

 The user to be disabled.
 








Class com.amazonaws.services.cognitoidp.model.AdminDisableProviderForUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminDisableUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to disable the user.
 


username
String username

 The user name of the user you wish to disable.
 








Class com.amazonaws.services.cognitoidp.model.AdminDisableUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminEnableUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to enable the user.
 


username
String username

 The user name of the user you wish to enable.
 








Class com.amazonaws.services.cognitoidp.model.AdminEnableUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminForgetDeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


username
String username

 The user name.
 


deviceKey
String deviceKey

 The device key.
 








Class com.amazonaws.services.cognitoidp.model.AdminForgetDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminGetDeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceKey
String deviceKey

 The device key.
 


userPoolId
String userPoolId

 The user pool ID.
 


username
String username

 The user name.
 








Class com.amazonaws.services.cognitoidp.model.AdminGetDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


device
DeviceType device

 The device.
 








Class com.amazonaws.services.cognitoidp.model.AdminGetUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to get information about the user.
 


username
String username

 The user name of the user you wish to retrieve.
 








Class com.amazonaws.services.cognitoidp.model.AdminGetUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


username
String username

 The user name of the user about whom you are receiving information.
 


userAttributes
List<E> userAttributes

 An array of name-value pairs representing user attributes.
 


userCreateDate
Date userCreateDate

 The date the user was created.
 


userLastModifiedDate
Date userLastModifiedDate

 The date the user was last modified.
 


enabled
Boolean enabled

 Indicates that the status is enabled.
 


userStatus
String userStatus

 The user status. Can be one of the following:
 
 
 
 
 UNCONFIRMED - User has been created but not confirmed.
 
 
 
 
 CONFIRMED - User has been confirmed.
 
 
 
 
 ARCHIVED - User is no longer active.
 
 
 
 
 COMPROMISED - User is disabled due to a potential security threat.
 
 
 
 
 UNKNOWN - User status is not known.
 
 
 
 
 RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or
 she can sign in.
 
 
 
 
 FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first
 sign-in, the user must change his or her password to a new value before doing anything else.
 
 
 


mFAOptions
List<E> mFAOptions

 This response parameter is no longer supported. It provides information only about SMS MFA configurations.
 It doesn't provide information about TOTP software token MFA configurations. To look up information about either
 type of MFA configuration, use the AdminGetUserResponse$UserMFASettingList response instead.
 


preferredMfaSetting
String preferredMfaSetting

 The user's preferred MFA setting.
 


userMFASettingList
List<E> userMFASettingList

 The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and
 SOFTWARE_TOKEN_MFA.
 








Class com.amazonaws.services.cognitoidp.model.AdminInitiateAuthRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The ID of the Amazon Cognito user pool.
 


clientId
String clientId

 The app client ID.
 


authFlow
String authFlow

 The authentication flow for this call to execute. The API action will depend on this value. For example:
 
 
 
 
 REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
 
 
 
 
 USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables
 to be used for next challenge execution.
 
 
 
 
 USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next
 challenge or tokens.
 
 
 
 
 Valid values include:
 
 
 
 
 USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
 
 
 
 
 REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token
 and ID token by supplying a valid refresh token.
 
 
 
 
 CUSTOM_AUTH: Custom authentication flow.
 
 
 
 
 ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly
 if the flow is enabled for calling the app client.
 
 
 
 
 USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a
 user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not
 found in the user pool.
 
 
 
 
 ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the
 ADMIN_NO_SRP_AUTH authentication flow. In this flow, Cognito receives the password in the request
 instead of using the SRP process to verify passwords.
 
 
 


authParameters
Map<K,V> authParameters

 The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking.
 The required values depend on the value of AuthFlow:
 
 
 
 
 For USER_SRP_AUTH: USERNAME (required), SRP_A (required),
 SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
 
 
 
 
 For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required),
 SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
 
 
 
 
 For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is
 configured with client secret), PASSWORD (required), DEVICE_KEY
 
 
 
 
 For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is
 configured with client secret), DEVICE_KEY
 
 
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for certain custom workflows that this action
 triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 AdminInitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that are specified for various
 triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:
 
 
 
 
 Pre signup
 
 
 
 
 Pre authentication
 
 
 
 
 User migration
 
 
 
 
 When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function
 receives as input. This payload contains a validationData attribute, which provides the data that
 you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in AWS
 Lambda, you can process the validationData value to enhance your workflow for your specific needs.
 
 
 When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following
 triggers, but it does not provide the ClientMetadata value as input:
 
 
 
 
 Post authentication
 
 
 
 
 Custom message
 
 
 
 
 Pre token generation
 
 
 
 
 Create auth challenge
 
 
 
 
 Define auth challenge
 
 
 
 
 Verify auth challenge
 
 
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 


analyticsMetadata
AnalyticsMetadataType analyticsMetadata

 The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.
 


contextData
ContextDataType contextData

 Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an
 unexpected event by Amazon Cognito advanced security.
 








Class com.amazonaws.services.cognitoidp.model.AdminInitiateAuthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


challengeName
String challengeName

 The name of the challenge which you are responding to with this call. This is returned to you in the
 AdminInitiateAuth response if you need to pass another challenge.
 
 
 
 
 MFA_SETUP: If MFA is required, users who do not have at least one of the MFA methods set up are
 presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to
 authenticate.
 
 
 
 
 SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA,
 and SOFTWARE_TOKEN_MFA for TOTP software token MFA.
 
 
 
 
 SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
 
 
 
 
 PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE,
 PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
 
 
 
 
 CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user
 should pass another challenge before tokens are issued.
 
 
 
 
 DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were
 passed, this challenge is returned so that Amazon Cognito can start tracking this device.
 
 
 
 
 DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
 
 
 
 
 ADMIN_NO_SRP_AUTH: This is returned if you need to authenticate with USERNAME and
 PASSWORD directly. An app client must be enabled to use this flow.
 
 
 
 
 NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first
 login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
 
 
 


session
String session

 The session which should be passed both ways in challenge-response calls to the service. If
 AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller
 needs to go through another challenge, they return a session with other challenge parameters. This session should
 be passed as it is to the next AdminRespondToAuthChallenge API call.
 


challengeParameters
Map<K,V> challengeParameters

 The challenge parameters. These are returned to you in the AdminInitiateAuth response if you need to
 pass another challenge. The responses in this parameter should be used to compute inputs to the next call (
 AdminRespondToAuthChallenge).
 
 
 All challenges require USERNAME and SECRET_HASH (if applicable).
 
 
 The value of the USER_ID_FOR_SRP attribute will be the user's actual username, not an alias (such as
 email address or phone number), even if you specified an alias in your call to AdminInitiateAuth.
 This is because, in the AdminRespondToAuthChallenge API ChallengeResponses, the
 USERNAME attribute cannot be an alias.
 


authenticationResult
AuthenticationResultType authenticationResult

 The result of the authentication response. This is only returned if the caller does not need to pass another
 challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName,
 ChallengeParameters, and Session are returned.
 








Class com.amazonaws.services.cognitoidp.model.AdminLinkProviderForUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


destinationUser
ProviderUserIdentifierType destinationUser

 The existing user in the user pool to be linked to the external identity provider user account. Can be a native
 (Username + Password) Cognito User Pools user or a federated user (for example, a SAML or Facebook user). If the
 user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked
 identity provider attribute) signs in.
 
 
 For a native username + password user, the ProviderAttributeValue for the
 DestinationUser should be the username in the user pool. For a federated user, it should be the
 provider-specific user_id.
 
 
 The ProviderAttributeName of the DestinationUser is ignored.
 
 
 The ProviderName should be set to Cognito for users in Cognito user pools.
 


sourceUser
ProviderUserIdentifierType sourceUser

 An external identity provider account for a user who does not currently exist yet in the user pool. This user
 must be a federated user (for example, a SAML or Facebook user), not another native user.
 
 
 If the SourceUser is a federated social identity provider user (Facebook, Google, or Login with
 Amazon), you must set the ProviderAttributeName to Cognito_Subject. For social identity
 providers, the ProviderName will be Facebook, Google, or
 LoginWithAmazon, and Cognito will automatically parse the Facebook, Google, and Login with Amazon
 tokens for id, sub, and user_id, respectively. The
 ProviderAttributeValue for the user must be the same value as the id, sub,
 or user_id value found in the social identity provider token.
 
 
 

 For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If
 you wish to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim
 through the SAML identity provider and submit that claim name as the ProviderAttributeName. If you
 set ProviderAttributeName to Cognito_Subject, Cognito will automatically parse the
 default unique identifier found in the subject from the SAML token.
 








Class com.amazonaws.services.cognitoidp.model.AdminLinkProviderForUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminListDevicesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


username
String username

 The user name.
 


limit
Integer limit

 The limit of the devices request.
 


paginationToken
String paginationToken

 The pagination token.
 








Class com.amazonaws.services.cognitoidp.model.AdminListDevicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devices
List<E> devices

 The devices in the list of devices response.
 


paginationToken
String paginationToken

 The pagination token.
 








Class com.amazonaws.services.cognitoidp.model.AdminListGroupsForUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


username
String username

 The username for the user.
 


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


limit
Integer limit

 The limit of the request to list groups.
 


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.AdminListGroupsForUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


groups
List<E> groups

 The groups that the user belongs to.
 


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.AdminListUserAuthEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


username
String username

 The user pool username or an alias.
 


maxResults
Integer maxResults

 The maximum number of authentication events to return.
 


nextToken
String nextToken

 A pagination token.
 








Class com.amazonaws.services.cognitoidp.model.AdminListUserAuthEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


authEvents
List<E> authEvents

 The response object. It includes the EventID, EventType, CreationDate,
 EventRisk, and EventResponse.
 


nextToken
String nextToken

 A pagination token.
 








Class com.amazonaws.services.cognitoidp.model.AdminRemoveUserFromGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


username
String username

 The username for the user.
 


groupName
String groupName

 The group name.
 








Class com.amazonaws.services.cognitoidp.model.AdminRemoveUserFromGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminResetUserPasswordRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to reset the user's password.
 


username
String username

 The user name of the user whose password you wish to reset.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom
 message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function
 receives as input. This payload contains a clientMetadata attribute, which provides the data that
 you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in AWS
 Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.AdminResetUserPasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminRespondToAuthChallengeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The ID of the Amazon Cognito user pool.
 


clientId
String clientId

 The app client ID.
 


challengeName
String challengeName

 The challenge name. For more information, see .
 


challengeResponses
Map<K,V> challengeResponses

 The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
 
 
 
 
 SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client
 is configured with client secret).
 
 
 
 
 PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK,
 TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client
 secret).
 
 
 
 
 ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app
 client is configured with client secret).
 
 
 
 
 NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes,
 USERNAME, SECRET_HASH (if app client is configured with client secret).
 
 
 
 
 The value of the USERNAME attribute must be the user's actual username, not an alias (such as email
 address or phone number). To make this easier, the AdminInitiateAuth response includes the actual
 username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call
 to AdminInitiateAuth.
 


session
String session

 The session which should be passed both ways in challenge-response calls to the service. If
 InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go
 through another challenge, they return a session with other challenge parameters. This session should be passed
 as it is to the next RespondToAuthChallenge API call.
 


analyticsMetadata
AnalyticsMetadataType analyticsMetadata

 The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.
 


contextData
ContextDataType contextData

 Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an
 unexpected event by Amazon Cognito advanced security.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following
 triggers: pre sign-up, custom message, post authentication, user migration, pre
 token generation, define auth challenge, create auth challenge, and verify auth challenge
 response. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function
 receives as input. This payload contains a clientMetadata attribute, which provides the data that
 you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code
 in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific
 needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.AdminRespondToAuthChallengeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


challengeName
String challengeName

 The name of the challenge. For more information, see .
 


session
String session

 The session which should be passed both ways in challenge-response calls to the service. If the or API call
 determines that the caller needs to go through another challenge, they return a session with other challenge
 parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
 


challengeParameters
Map<K,V> challengeParameters

 The challenge parameters. For more information, see .
 


authenticationResult
AuthenticationResultType authenticationResult

 The result returned by the server in response to the authentication request.
 








Class com.amazonaws.services.cognitoidp.model.AdminSetUserMFAPreferenceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sMSMfaSettings
SMSMfaSettingsType sMSMfaSettings

 The SMS text message MFA settings.
 


softwareTokenMfaSettings
SoftwareTokenMfaSettingsType softwareTokenMfaSettings

 The time-based one-time password software token MFA settings.
 


username
String username

 The user pool username or alias.
 


userPoolId
String userPoolId

 The user pool ID.
 








Class com.amazonaws.services.cognitoidp.model.AdminSetUserMFAPreferenceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminSetUserPasswordRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to set the user's password.
 


username
String username

 The user name of the user whose password you wish to set.
 


password
String password

 The password for the user.
 


permanent
Boolean permanent

 True if the password is permanent, False if it is temporary.
 








Class com.amazonaws.services.cognitoidp.model.AdminSetUserPasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminSetUserSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The ID of the user pool that contains the user that you are setting options for.
 


username
String username

 The user name of the user that you are setting options for.
 


mFAOptions
List<E> mFAOptions

 You can use this parameter only to set an SMS configuration that uses SMS for delivery.
 








Class com.amazonaws.services.cognitoidp.model.AdminSetUserSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminUpdateAuthEventFeedbackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


username
String username

 The user pool username.
 


eventId
String eventId

 The authentication event ID.
 


feedbackValue
String feedbackValue

 The authentication event feedback value.
 








Class com.amazonaws.services.cognitoidp.model.AdminUpdateAuthEventFeedbackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminUpdateDeviceStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


username
String username

 The user name.
 


deviceKey
String deviceKey

 The device key.
 


deviceRememberedStatus
String deviceRememberedStatus

 The status indicating whether a device has been remembered or not.
 








Class com.amazonaws.services.cognitoidp.model.AdminUpdateDeviceStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminUpdateUserAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to update user attributes.
 


username
String username

 The user name of the user for whom you want to update user attributes.
 


userAttributes
List<E> userAttributes

 An array of name-value pairs representing user attributes.
 
 
 For custom attributes, you must prepend the custom: prefix to the attribute name.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom
 message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function
 receives as input. This payload contains a clientMetadata attribute, which provides the data that
 you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in
 AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific
 needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.AdminUpdateUserAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AdminUserGlobalSignOutRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


username
String username

 The user name.
 








Class com.amazonaws.services.cognitoidp.model.AdminUserGlobalSignOutResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.AliasExistsException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.AnalyticsConfigurationType extends Object implements Serializable


Serialized Fields


applicationId
String applicationId

 The application ID for an Amazon Pinpoint application.
 


roleArn
String roleArn

 The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.
 


externalId
String externalId

 The external ID.
 


userDataShared
Boolean userDataShared

 If UserDataShared is true, Amazon Cognito will include user data in the events it
 publishes to Amazon Pinpoint analytics.
 








Class com.amazonaws.services.cognitoidp.model.AnalyticsMetadataType extends Object implements Serializable


Serialized Fields


analyticsEndpointId
String analyticsEndpointId

 The endpoint ID.
 








Class com.amazonaws.services.cognitoidp.model.AssociateSoftwareTokenRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessToken
String accessToken

 The access token.
 


session
String session

 The session which should be passed both ways in challenge-response calls to the service. This allows
 authentication of the user as part of the MFA setup process.
 








Class com.amazonaws.services.cognitoidp.model.AssociateSoftwareTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


secretCode
String secretCode

 A unique generated shared secret code that is used in the TOTP algorithm to generate a one time code.
 


session
String session

 The session which should be passed both ways in challenge-response calls to the service. This allows
 authentication of the user as part of the MFA setup process.
 








Class com.amazonaws.services.cognitoidp.model.AttributeType extends Object implements Serializable


Serialized Fields


name
String name

 The name of the attribute.
 


value
String value

 The value of the attribute.
 








Class com.amazonaws.services.cognitoidp.model.AuthenticationResultType extends Object implements Serializable


Serialized Fields


accessToken
String accessToken

 The access token.
 


expiresIn
Integer expiresIn

 The expiration period of the authentication result in seconds.
 


tokenType
String tokenType

 The token type.
 


refreshToken
String refreshToken

 The refresh token.
 


idToken
String idToken

 The ID token.
 


newDeviceMetadata
NewDeviceMetadataType newDeviceMetadata

 The new device metadata from an authentication result.
 








Class com.amazonaws.services.cognitoidp.model.AuthEventType extends Object implements Serializable


Serialized Fields


eventId
String eventId

 The event ID.
 


eventType
String eventType

 The event type.
 


creationDate
Date creationDate

 The creation date
 


eventResponse
String eventResponse

 The event response.
 


eventRisk
EventRiskType eventRisk

 The event risk.
 


challengeResponses
List<E> challengeResponses

 The challenge responses.
 


eventContextData
EventContextDataType eventContextData

 The user context data captured at the time of an event request. It provides additional information about the
 client from which event the request is received.
 


eventFeedback
EventFeedbackType eventFeedback

 A flag specifying the user feedback captured at the time of an event request is good or bad.
 








Class com.amazonaws.services.cognitoidp.model.AWSCognitoIdentityProviderException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.ChallengeResponseType extends Object implements Serializable


Serialized Fields


challengeName
String challengeName

 The challenge name
 


challengeResponse
String challengeResponse

 The challenge response.
 








Class com.amazonaws.services.cognitoidp.model.ChangePasswordRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


previousPassword
String previousPassword

 The old password.
 


proposedPassword
String proposedPassword

 The new password.
 


accessToken
String accessToken

 The access token.
 








Class com.amazonaws.services.cognitoidp.model.ChangePasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.CodeDeliveryDetailsType extends Object implements Serializable


Serialized Fields


destination
String destination

 The destination for the code delivery details.
 


deliveryMedium
String deliveryMedium

 The delivery medium (email message or phone number).
 


attributeName
String attributeName

 The attribute name.
 








Class com.amazonaws.services.cognitoidp.model.CodeDeliveryFailureException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.CodeMismatchException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.CompromisedCredentialsActionsType extends Object implements Serializable


Serialized Fields


eventAction
String eventAction

 The event action.
 








Class com.amazonaws.services.cognitoidp.model.CompromisedCredentialsRiskConfigurationType extends Object implements Serializable


Serialized Fields


eventFilter
List<E> eventFilter

 Perform the action for these events. The default is to perform all events if no event filter is specified.
 


actions
CompromisedCredentialsActionsType actions

 The compromised credentials risk configuration actions.
 








Class com.amazonaws.services.cognitoidp.model.ConcurrentModificationException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.ConfirmDeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessToken
String accessToken

 The access token.
 


deviceKey
String deviceKey

 The device key.
 


deviceSecretVerifierConfig
DeviceSecretVerifierConfigType deviceSecretVerifierConfig

 The configuration of the device secret verifier.
 


deviceName
String deviceName

 The device name.
 








Class com.amazonaws.services.cognitoidp.model.ConfirmDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userConfirmationNecessary
Boolean userConfirmationNecessary

 Indicates whether the user confirmation is necessary to confirm the device response.
 








Class com.amazonaws.services.cognitoidp.model.ConfirmForgotPasswordRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientId
String clientId

 The app client ID of the app associated with the user pool.
 


secretHash
String secretHash

 A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and
 username plus the client ID in the message.
 


username
String username

 The user name of the user for whom you want to enter a code to retrieve a forgotten password.
 


confirmationCode
String confirmationCode

 The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see
 


password
String password

 The password sent by a user's request to retrieve a forgotten password.
 


analyticsMetadata
AnalyticsMetadataType analyticsMetadata

 The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.
 


userContextData
UserContextDataType userContextData

 Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an
 unexpected event by Amazon Cognito advanced security.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post
 confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function
 receives as input. This payload contains a clientMetadata attribute, which provides the data that
 you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in AWS
 Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.ConfirmForgotPasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.ConfirmSignUpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientId
String clientId

 The ID of the app client associated with the user pool.
 


secretHash
String secretHash

 A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and
 username plus the client ID in the message.
 


username
String username

 The user name of the user whose registration you wish to confirm.
 


confirmationCode
String confirmationCode

 The confirmation code sent by a user's request to confirm registration.
 


forceAliasCreation
Boolean forceAliasCreation

 Boolean to be specified to force user confirmation irrespective of existing alias. By default set to
 False. If this parameter is set to True and the phone number/email used for sign up
 confirmation already exists as an alias with a different user, the API call will migrate the alias from the
 previous user to the newly created user being confirmed. If set to False, the API will throw an
 AliasExistsException error.
 


analyticsMetadata
AnalyticsMetadataType analyticsMetadata

 The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
 


userContextData
UserContextDataType userContextData

 Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an
 unexpected event by Amazon Cognito advanced security.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation
 trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as
 input. This payload contains a clientMetadata attribute, which provides the data that you assigned
 to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in AWS Lambda, you can
 process the clientMetadata value to enhance your workflow for your specific needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.ConfirmSignUpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.ContextDataType extends Object implements Serializable


Serialized Fields


ipAddress
String ipAddress

 Source IP address of your user.
 


serverName
String serverName

 Your server endpoint where this API is invoked.
 


serverPath
String serverPath

 Your server path where this API is invoked.
 


httpHeaders
List<E> httpHeaders

 HttpHeaders received on your server in same order.
 


encodedData
String encodedData

 Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection
 library.
 








Class com.amazonaws.services.cognitoidp.model.CreateGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name of the group. Must be unique.
 


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


description
String description

 A string containing the description of the group.
 


roleArn
String roleArn

 The role ARN for the group.
 


precedence
Integer precedence

 A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user
 can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence
 values take precedence over groups with higher or null Precedence values. If a user belongs to two
 or more groups, it is the group with the lowest precedence value whose role ARN will be used in the
 cognito:roles and cognito:preferred_role claims in the user's tokens.
 
 
 Two groups can have the same Precedence value. If this happens, neither group takes precedence over
 the other. If two groups with the same Precedence have the same role ARN, that role is used in the
 cognito:preferred_role claim in tokens for users in each group. If the two groups have different
 role ARNs, the cognito:preferred_role claim is not set in users' tokens.
 
 
 The default Precedence value is null.
 








Class com.amazonaws.services.cognitoidp.model.CreateGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


group
GroupType group

 The group object for the group.
 








Class com.amazonaws.services.cognitoidp.model.CreateIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


providerName
String providerName

 The identity provider name.
 


providerType
String providerType

 The identity provider type.
 


providerDetails
Map<K,V> providerDetails

 The identity provider details, such as MetadataURL and MetadataFile.
 


attributeMapping
Map<K,V> attributeMapping

 A mapping of identity provider attributes to standard and custom user pool attributes.
 


idpIdentifiers
List<E> idpIdentifiers

 A list of identity provider identifiers.
 








Class com.amazonaws.services.cognitoidp.model.CreateIdentityProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityProvider
IdentityProviderType identityProvider

 The newly created identity provider object.
 








Class com.amazonaws.services.cognitoidp.model.CreateResourceServerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


identifier
String identifier

 A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource
 server is located. For example, https://my-weather-api.example.com.
 


name
String name

 A friendly name for the resource server.
 


scopes
List<E> scopes

 A list of scopes. Each scope is map, where the keys are name and description.
 








Class com.amazonaws.services.cognitoidp.model.CreateResourceServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceServer
ResourceServerType resourceServer

 The newly created resource server.
 








Class com.amazonaws.services.cognitoidp.model.CreateUserImportJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 The job name for the user import job.
 


userPoolId
String userPoolId

 The user pool ID for the user pool that the users are being imported into.
 


cloudWatchLogsRoleArn
String cloudWatchLogsRoleArn

 The role ARN for the Amazon CloudWatch Logging role for the user import job.
 








Class com.amazonaws.services.cognitoidp.model.CreateUserImportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userImportJob
UserImportJobType userImportJob

 The job object that represents the user import job.
 








Class com.amazonaws.services.cognitoidp.model.CreateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to create a user pool client.
 


clientName
String clientName

 The client name for the user pool client you would like to create.
 


generateSecret
Boolean generateSecret

 Boolean to specify whether you want to generate a secret for the user pool client being created.
 


refreshTokenValidity
Integer refreshTokenValidity

 The time limit, in days, after which the refresh token is no longer valid and cannot be used.
 


readAttributes
List<E> readAttributes

 The read attributes.
 


writeAttributes
List<E> writeAttributes

 The user pool attributes that the app client can write to.
 
 
 If your app client allows users to sign in through an identity provider, this array must include all attributes
 that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to
 your application through an identity provider. If your app client lacks write access to a mapped attribute,
 Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
 


explicitAuthFlows
List<E> explicitAuthFlows

 The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
 prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with
 ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
 
 
 Valid values include:
 
 
 
 
 ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow
 ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With
 this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote
 Password protocol) protocol to verify passwords.
 
 
 
 
 ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
 
 
 
 
 ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives
 the password in the request instead of using the SRP protocol to verify passwords.
 
 
 
 
 ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
 
 
 
 
 ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
 
 
 


supportedIdentityProviders
List<E> supportedIdentityProviders

 A list of provider names for the identity providers that are supported on this client. The following are
 supported: COGNITO, Facebook, Google and LoginWithAmazon.
 


callbackURLs
List<E> callbackURLs

 A list of allowed redirect (callback) URLs for the identity providers.
 
 
 A redirect URI must:
 
 
 
 
 Be an absolute URI.
 
 
 
 
 Be registered with the authorization server.
 
 
 
 
 Not include a fragment component.
 
 
 
 
 See OAuth 2.0 - Redirection Endpoint.
 
 
 Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
 
 
 App callback URLs such as myapp://example are also supported.
 


logoutURLs
List<E> logoutURLs

 A list of allowed logout URLs for the identity providers.
 


defaultRedirectURI
String defaultRedirectURI

 The default redirect URI. Must be in the CallbackURLs list.
 
 
 A redirect URI must:
 
 
 
 
 Be an absolute URI.
 
 
 
 
 Be registered with the authorization server.
 
 
 
 
 Not include a fragment component.
 
 
 
 
 See OAuth 2.0 - Redirection Endpoint.
 
 
 Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
 
 
 App callback URLs such as myapp://example are also supported.
 


allowedOAuthFlows
List<E> allowedOAuthFlows

 Set to code to initiate a code grant flow, which provides an authorization code as the response.
 This code can be exchanged for access tokens with the token endpoint.
 
 
 Set to token to specify that the client should get the access token (and, optionally, ID token,
 based on scopes) directly.
 


allowedOAuthScopes
List<E> allowedOAuthScopes

 A list of allowed OAuth scopes. Currently supported values are "phone",
 "email", "openid", and "Cognito". In addition to these values, custom
 scopes created in Resource Servers are also supported.
 


allowedOAuthFlowsUserPoolClient
Boolean allowedOAuthFlowsUserPoolClient

 Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user
 pools.
 


analyticsConfiguration
AnalyticsConfigurationType analyticsConfiguration

 The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
 


preventUserExistenceErrors
String preventUserExistenceErrors

 Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account
 confirmation, and password recovery when the user does not exist in the user pool. When set to
 ENABLED and the user does not exist, authentication returns an error indicating either the username
 or password was incorrect, and account confirmation and password recovery return a response indicating a code was
 sent to a simulated destination. When set to LEGACY, those APIs will return a
 UserNotFoundException exception if the user does not exist in the user pool.
 
 
 Valid values include:
 
 
 
 
 ENABLED - This prevents user existence-related errors.
 
 
 
 
 LEGACY - This represents the old behavior of Cognito where user existence related errors are not
 prevented.
 
 
 
 
 This setting affects the behavior of following APIs:
 
 
 
 
 AdminInitiateAuth
 
 
 
 
 AdminRespondToAuthChallenge
 
 
 
 
 InitiateAuth
 
 
 
 
 RespondToAuthChallenge
 
 
 
 
 ForgotPassword
 
 
 
 
 ConfirmForgotPassword
 
 
 
 
 ConfirmSignUp
 
 
 
 
 ResendConfirmationCode
 
 
 
 
 
 After January 1st 2020, the value of PreventUserExistenceErrors will default to ENABLED
 for newly created user pool clients if no value is provided.
 
 








Class com.amazonaws.services.cognitoidp.model.CreateUserPoolClientResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userPoolClient
UserPoolClientType userPoolClient

 The user pool client that was just created.
 








Class com.amazonaws.services.cognitoidp.model.CreateUserPoolDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domain
String domain

 The domain string.
 


userPoolId
String userPoolId

 The user pool ID.
 


customDomainConfig
CustomDomainConfigType customDomainConfig

 The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
 
 
 Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude
 this parameter and use the Amazon Cognito hosted domain instead.
 
 
 For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
 








Class com.amazonaws.services.cognitoidp.model.CreateUserPoolDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cloudFrontDomain
String cloudFrontDomain

 The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name
 Service (DNS) provider.
 








Class com.amazonaws.services.cognitoidp.model.CreateUserPoolRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


poolName
String poolName

 A string used to name the user pool.
 


policies
UserPoolPolicyType policies

 The policies associated with the new user pool.
 


lambdaConfig
LambdaConfigType lambdaConfig

 The Lambda trigger configuration information for the new user pool.
 
 
 
 In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function.
 So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.
 
 
 

 For more information on using the Lambda API to add permission, see  AddPermission .
 
 
 For adding permission using the AWS CLI, see  add-permission .
 
 


autoVerifiedAttributes
List<E> autoVerifiedAttributes

 The attributes to be auto-verified. Possible values: email, phone_number.
 


aliasAttributes
List<E> aliasAttributes

 Attributes supported as an alias for this user pool. Possible values: phone_number, email, or
 preferred_username.
 


usernameAttributes
List<E> usernameAttributes

 Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
 


smsVerificationMessage
String smsVerificationMessage

 A string representing the SMS verification message.
 


emailVerificationMessage
String emailVerificationMessage

 A string representing the email verification message.
 


emailVerificationSubject
String emailVerificationSubject

 A string representing the email verification subject.
 


verificationMessageTemplate
VerificationMessageTemplateType verificationMessageTemplate

 The template for the verification message that the user sees when the app requests permission to access the
 user's information.
 


smsAuthenticationMessage
String smsAuthenticationMessage

 A string representing the SMS authentication message.
 


mfaConfiguration
String mfaConfiguration

 Specifies MFA configuration details.
 


deviceConfiguration
DeviceConfigurationType deviceConfiguration

 The device configuration.
 


emailConfiguration
EmailConfigurationType emailConfiguration

 The email configuration.
 


smsConfiguration
SmsConfigurationType smsConfiguration

 The SMS configuration.
 


userPoolTags
Map<K,V> userPoolTags

 The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage
 user pools in different ways, such as by purpose, owner, environment, or other criteria.
 


adminCreateUserConfig
AdminCreateUserConfigType adminCreateUserConfig

 The configuration for AdminCreateUser requests.
 


schema
List<E> schema

 An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.
 


userPoolAddOns
UserPoolAddOnsType userPoolAddOns

 Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value
 "AUDIT".
 


accountRecoverySetting
AccountRecoverySettingType accountRecoverySetting

 Use this setting to define which verified available method a user can use to recover their password when they
 call ForgotPassword. It allows you to define a preferred method when a user has more than one method
 available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has
 SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery
 method where SMS is preferred over email.
 
 
 
 Starting February 1, 2020, the value of AccountRecoverySetting will default to
 verified_email first and verified_phone_number as the second option for newly created
 user pools if no value is provided.
 
 








Class com.amazonaws.services.cognitoidp.model.CreateUserPoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userPool
UserPoolType userPool

 A container for the user pool details.
 








Class com.amazonaws.services.cognitoidp.model.CustomDomainConfigType extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the
 subdomain of your custom domain.
 








Class com.amazonaws.services.cognitoidp.model.DeleteGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name of the group.
 


userPoolId
String userPoolId

 The user pool ID for the user pool.
 








Class com.amazonaws.services.cognitoidp.model.DeleteGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.DeleteIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


providerName
String providerName

 The identity provider name.
 








Class com.amazonaws.services.cognitoidp.model.DeleteIdentityProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.DeleteResourceServerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool that hosts the resource server.
 


identifier
String identifier

 The identifier for the resource server.
 








Class com.amazonaws.services.cognitoidp.model.DeleteResourceServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.DeleteUserAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userAttributeNames
List<E> userAttributeNames

 An array of strings representing the user attribute names you wish to delete.
 
 
 For custom attributes, you must prepend the custom: prefix to the attribute name.
 


accessToken
String accessToken

 The access token used in the request to delete user attributes.
 








Class com.amazonaws.services.cognitoidp.model.DeleteUserAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to delete the client.
 


clientId
String clientId

 The app client ID of the app associated with the user pool.
 








Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolClientResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domain
String domain

 The domain string.
 


userPoolId
String userPoolId

 The user pool ID.
 








Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool you want to delete.
 








Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessToken
String accessToken

 The access token from a request to delete a user.
 








Class com.amazonaws.services.cognitoidp.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.DescribeIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


providerName
String providerName

 The identity provider name.
 








Class com.amazonaws.services.cognitoidp.model.DescribeIdentityProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityProvider
IdentityProviderType identityProvider

 The identity provider that was deleted.
 








Class com.amazonaws.services.cognitoidp.model.DescribeResourceServerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool that hosts the resource server.
 


identifier
String identifier

 The identifier for the resource server
 








Class com.amazonaws.services.cognitoidp.model.DescribeResourceServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceServer
ResourceServerType resourceServer

 The resource server.
 








Class com.amazonaws.services.cognitoidp.model.DescribeRiskConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


clientId
String clientId

 The app client ID.
 








Class com.amazonaws.services.cognitoidp.model.DescribeRiskConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


riskConfiguration
RiskConfigurationType riskConfiguration

 The risk configuration.
 








Class com.amazonaws.services.cognitoidp.model.DescribeUserImportJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool that the users are being imported into.
 


jobId
String jobId

 The job ID for the user import job.
 








Class com.amazonaws.services.cognitoidp.model.DescribeUserImportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userImportJob
UserImportJobType userImportJob

 The job object that represents the user import job.
 








Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool you want to describe.
 


clientId
String clientId

 The app client ID of the app associated with the user pool.
 








Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolClientResult extends AmazonWebServiceResult<ResponseMetadata> 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.DescribeUserPoolDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domain
String domain

 The domain string.
 








Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainDescription
DomainDescriptionType domainDescription

 A domain description object containing information about the domain.
 








Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool you want to describe.
 








Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userPool
UserPoolType userPool

 The container of metadata returned by the server to describe the pool.
 








Class com.amazonaws.services.cognitoidp.model.DeviceConfigurationType extends Object implements Serializable


Serialized Fields


challengeRequiredOnNewDevice
Boolean challengeRequiredOnNewDevice

 Indicates whether a challenge is required on a new device. Only applicable to a new device.
 


deviceOnlyRememberedOnUserPrompt
Boolean deviceOnlyRememberedOnUserPrompt

 If true, a device is only remembered on user prompt.
 








Class com.amazonaws.services.cognitoidp.model.DeviceSecretVerifierConfigType extends Object implements Serializable


Serialized Fields


passwordVerifier
String passwordVerifier

 The password verifier.
 


salt
String salt

 The salt.
 








Class com.amazonaws.services.cognitoidp.model.DeviceType extends Object implements Serializable


Serialized Fields


deviceKey
String deviceKey

 The device key.
 


deviceAttributes
List<E> deviceAttributes

 The device attributes.
 


deviceCreateDate
Date deviceCreateDate

 The creation date of the device.
 


deviceLastModifiedDate
Date deviceLastModifiedDate

 The last modified date of the device.
 


deviceLastAuthenticatedDate
Date deviceLastAuthenticatedDate

 The date in which the device was last authenticated.
 








Class com.amazonaws.services.cognitoidp.model.DomainDescriptionType extends Object implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


aWSAccountId
String aWSAccountId

 The AWS account ID for the user pool owner.
 


domain
String domain

 The domain string.
 


s3Bucket
String s3Bucket

 The S3 bucket where the static files for this domain are stored.
 


cloudFrontDistribution
String cloudFrontDistribution

 The ARN of the CloudFront distribution.
 


version
String version

 The app version.
 


status
String status

 The domain status.
 


customDomainConfig
CustomDomainConfigType customDomainConfig

 The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
 








Class com.amazonaws.services.cognitoidp.model.DuplicateProviderException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.EmailConfigurationType extends Object implements Serializable


Serialized Fields


sourceArn
String sourceArn

 The Amazon Resource Name (ARN) of a verified email address in Amazon SES. This email address is used in one of
 the following ways, depending on the value that you specify for the EmailSendingAccount parameter:
 
 
 
 
 If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it
 emails your users by using its built-in email account.
 
 
 
 
 If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES
 on your behalf.
 
 
 


replyToEmailAddress
String replyToEmailAddress

 The destination to which the receiver of the email should reply to.
 


emailSendingAccount
String emailSendingAccount

 Specifies whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon SES
 email configuration. Specify one of the following values:
 
 
 COGNITO_DEFAULT
 
 
 When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option,
 Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production
 environments, the default email limit is below the required delivery volume. To achieve a higher delivery volume,
 specify DEVELOPER to use your Amazon SES email configuration.
 
 
 To look up the email delivery limit for the default option, see Limits in Amazon Cognito in the
 Amazon Cognito Developer Guide.
 
 
 The default FROM address is [email protected]. To customize the FROM address, provide the ARN of an
 Amazon SES verified email address for the SourceArn parameter.
 
 
 DEVELOPER
 
 
 When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on
 your behalf to send email from your verified email address. When you use this option, the email delivery limits
 are the same limits that apply to your Amazon SES verified email address in your AWS account.
 
 
 If you use this option, you must provide the ARN of an Amazon SES verified email address for the
 SourceArn parameter.
 
 
 Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf.
 When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a
 type of IAM role, in your AWS account. This role contains the permissions that allow Amazon Cognito to access
 Amazon SES and send email messages with your address. For more information about the service-linked role that
 Amazon Cognito creates, see Using
 Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.
 
 
 


from
String from

 Identifies either the sender’s email address or the sender’s name with their email address. For example,
 [email protected] or Test User <[email protected]>. This address will
 appear before the body of the email.
 


configurationSet
String configurationSet

 The set of configuration rules that can be applied to emails sent using Amazon SES. A configuration set is
 applied to an email by including a reference to the configuration set in the headers of the email. Once applied,
 all of the rules in that configuration set are applied to the email. Configuration sets can be used to apply the
 following types of rules to emails:
 
 
 
 
 Event publishing – Amazon SES can track the number of send, delivery, open, click, bounce, and complaint events
 for each email sent. Use event publishing to send information about these events to other AWS services such as
 SNS and CloudWatch.
 
 
 
 
 IP pool management – When leasing dedicated IP addresses with Amazon SES, you can create groups of IP addresses,
 called dedicated IP pools. You can then associate the dedicated IP pools with configuration sets.
 
 
 








Class com.amazonaws.services.cognitoidp.model.EnableSoftwareTokenMFAException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.EventContextDataType extends Object implements Serializable


Serialized Fields


ipAddress
String ipAddress

 The user's IP address.
 


deviceName
String deviceName

 The user's device name.
 


timezone
String timezone

 The user's time zone.
 


city
String city

 The user's city.
 


country
String country

 The user's country.
 








Class com.amazonaws.services.cognitoidp.model.EventFeedbackType extends Object implements Serializable


Serialized Fields


feedbackValue
String feedbackValue

 The event feedback value.
 


provider
String provider

 The provider.
 


feedbackDate
Date feedbackDate

 The event feedback date.
 








Class com.amazonaws.services.cognitoidp.model.EventRiskType extends Object implements Serializable


Serialized Fields


riskDecision
String riskDecision

 The risk decision.
 


riskLevel
String riskLevel

 The risk level.
 








Class com.amazonaws.services.cognitoidp.model.ExpiredCodeException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.ForgetDeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessToken
String accessToken

 The access token for the forgotten device request.
 


deviceKey
String deviceKey

 The device key.
 








Class com.amazonaws.services.cognitoidp.model.ForgetDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.ForgotPasswordRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientId
String clientId

 The ID of the client associated with the user pool.
 


secretHash
String secretHash

 A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and
 username plus the client ID in the message.
 


userContextData
UserContextDataType userContextData

 Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an
 unexpected event by Amazon Cognito advanced security.
 


username
String username

 The user name of the user for whom you want to enter a code to reset a forgotten password.
 


analyticsMetadata
AnalyticsMetadataType analyticsMetadata

 The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers:
 pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these
 functions, it passes a JSON payload, which the function receives as input. This payload contains a
 clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter
 in your ForgotPassword request. In your function code in AWS Lambda, you can process the
 clientMetadata value to enhance your workflow for your specific needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.ForgotPasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


codeDeliveryDetails
CodeDeliveryDetailsType codeDeliveryDetails

 The code delivery details returned by the server in response to the request to reset a password.
 








Class com.amazonaws.services.cognitoidp.model.GetCSVHeaderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool that the users are to be imported into.
 








Class com.amazonaws.services.cognitoidp.model.GetCSVHeaderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool that the users are to be imported into.
 


cSVHeader
List<E> cSVHeader

 The header information for the .csv file for the user import job.
 








Class com.amazonaws.services.cognitoidp.model.GetDeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceKey
String deviceKey

 The device key.
 


accessToken
String accessToken

 The access token.
 








Class com.amazonaws.services.cognitoidp.model.GetDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


device
DeviceType device

 The device.
 








Class com.amazonaws.services.cognitoidp.model.GetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name of the group.
 


userPoolId
String userPoolId

 The user pool ID for the user pool.
 








Class com.amazonaws.services.cognitoidp.model.GetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


group
GroupType group

 The group object for the group.
 








Class com.amazonaws.services.cognitoidp.model.GetIdentityProviderByIdentifierRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


idpIdentifier
String idpIdentifier

 The identity provider ID.
 








Class com.amazonaws.services.cognitoidp.model.GetIdentityProviderByIdentifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityProvider
IdentityProviderType identityProvider

 The identity provider object.
 








Class com.amazonaws.services.cognitoidp.model.GetSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 








Class com.amazonaws.services.cognitoidp.model.GetSigningCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificate
String certificate

 The signing certificate.
 








Class com.amazonaws.services.cognitoidp.model.GetUICustomizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


clientId
String clientId

 The client ID for the client app.
 








Class com.amazonaws.services.cognitoidp.model.GetUICustomizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uICustomization
UICustomizationType uICustomization

 The UI customization information.
 








Class com.amazonaws.services.cognitoidp.model.GetUserAttributeVerificationCodeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessToken
String accessToken

 The access token returned by the server response to get the user attribute verification code.
 


attributeName
String attributeName

 The attribute name returned by the server response to get the user attribute verification code.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the
 custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the
 function receives as input. This payload contains a clientMetadata attribute, which provides the
 data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your
 function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for
 your specific needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.GetUserAttributeVerificationCodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


codeDeliveryDetails
CodeDeliveryDetailsType codeDeliveryDetails

 The code delivery details returned by the server in response to the request to get the user attribute
 verification code.
 








Class com.amazonaws.services.cognitoidp.model.GetUserPoolMfaConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 








Class com.amazonaws.services.cognitoidp.model.GetUserPoolMfaConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


smsMfaConfiguration
SmsMfaConfigType smsMfaConfiguration

 The SMS text message multi-factor (MFA) configuration.
 


softwareTokenMfaConfiguration
SoftwareTokenMfaConfigType softwareTokenMfaConfiguration

 The software token multi-factor (MFA) configuration.
 


mfaConfiguration
String mfaConfiguration

 The multi-factor (MFA) configuration. Valid values include:
 
 
 
 
 OFF MFA will not be used for any users.
 
 
 
 
 ON MFA is required for all users to sign in.
 
 
 
 
 OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
 
 
 








Class com.amazonaws.services.cognitoidp.model.GetUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessToken
String accessToken

 The access token returned by the server response to get information about the user.
 








Class com.amazonaws.services.cognitoidp.model.GetUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


username
String username

 The user name of the user you wish to retrieve from the get user request.
 


userAttributes
List<E> userAttributes

 An array of name-value pairs representing user attributes.
 
 
 For custom attributes, you must prepend the custom: prefix to the attribute name.
 


mFAOptions
List<E> mFAOptions

 This response parameter is no longer supported. It provides information only about SMS MFA configurations.
 It doesn't provide information about TOTP software token MFA configurations. To look up information about either
 type of MFA configuration, use the use the GetUserResponse$UserMFASettingList response instead.
 


preferredMfaSetting
String preferredMfaSetting

 The user's preferred MFA setting.
 


userMFASettingList
List<E> userMFASettingList

 The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and
 SOFTWARE_TOKEN_MFA.
 








Class com.amazonaws.services.cognitoidp.model.GlobalSignOutRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessToken
String accessToken

 The access token.
 








Class com.amazonaws.services.cognitoidp.model.GlobalSignOutResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.GroupExistsException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.GroupType extends Object implements Serializable


Serialized Fields


groupName
String groupName

 The name of the group.
 


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


description
String description

 A string containing the description of the group.
 


roleArn
String roleArn

 The role ARN for the group.
 


precedence
Integer precedence

 A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user
 can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest
 precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role
 claims in the user's tokens. Groups with higher Precedence values take precedence over groups with
 lower Precedence values or with null Precedence values.
 
 
 Two groups can have the same Precedence value. If this happens, neither group takes precedence over
 the other. If two groups with the same Precedence have the same role ARN, that role is used in the
 cognito:preferred_role claim in tokens for users in each group. If the two groups have different
 role ARNs, the cognito:preferred_role claim is not set in users' tokens.
 
 
 The default Precedence value is null.
 


lastModifiedDate
Date lastModifiedDate

 The date the group was last modified.
 


creationDate
Date creationDate

 The date the group was created.
 








Class com.amazonaws.services.cognitoidp.model.HttpHeader extends Object implements Serializable


Serialized Fields


headerName
String headerName

 The header name
 


headerValue
String headerValue

 The header value.
 








Class com.amazonaws.services.cognitoidp.model.IdentityProviderType extends Object implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


providerName
String providerName

 The identity provider name.
 


providerType
String providerType

 The identity provider type.
 


providerDetails
Map<K,V> providerDetails

 The identity provider details, such as MetadataURL and MetadataFile.
 


attributeMapping
Map<K,V> attributeMapping

 A mapping of identity provider attributes to standard and custom user pool attributes.
 


idpIdentifiers
List<E> idpIdentifiers

 A list of identity provider identifiers.
 


lastModifiedDate
Date lastModifiedDate

 The date the identity provider was last modified.
 


creationDate
Date creationDate

 The date the identity provider was created.
 








Class com.amazonaws.services.cognitoidp.model.InitiateAuthRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


authFlow
String authFlow

 The authentication flow for this call to execute. The API action will depend on this value. For example:
 
 
 
 
 REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.
 
 
 
 
 USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables
 to be used for next challenge execution.
 
 
 
 
 USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next
 challenge or tokens.
 
 
 
 
 Valid values include:
 
 
 
 
 USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.
 
 
 
 
 REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token
 and ID token by supplying a valid refresh token.
 
 
 
 
 CUSTOM_AUTH: Custom authentication flow.
 
 
 
 
 USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a
 user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not
 found in the user pool.
 
 
 
 
 ADMIN_USER_PASSWORD_AUTH: Admin-based user password authentication. This replaces the
 ADMIN_NO_SRP_AUTH authentication flow. In this flow, Cognito receives the password in the request
 instead of using the SRP process to verify passwords.
 
 
 
 
 ADMIN_NO_SRP_AUTH is not a valid value.
 


authParameters
Map<K,V> authParameters

 The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking.
 The required values depend on the value of AuthFlow:
 
 
 
 
 For USER_SRP_AUTH: USERNAME (required), SRP_A (required),
 SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
 
 
 
 
 For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required),
 SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY
 
 
 
 
 For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is
 configured with client secret), DEVICE_KEY
 
 
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for certain custom workflows that this action
 triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that are specified for various triggers.
 The ClientMetadata value is passed as input to the functions for only the following triggers:
 
 
 
 
 Pre signup
 
 
 
 
 Pre authentication
 
 
 
 
 User migration
 
 
 
 
 When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function
 receives as input. This payload contains a validationData attribute, which provides the data that
 you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in AWS Lambda,
 you can process the validationData value to enhance your workflow for your specific needs.
 
 
 When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers,
 but it does not provide the ClientMetadata value as input:
 
 
 
 
 Post authentication
 
 
 
 
 Custom message
 
 
 
 
 Pre token generation
 
 
 
 
 Create auth challenge
 
 
 
 
 Define auth challenge
 
 
 
 
 Verify auth challenge
 
 
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 


clientId
String clientId

 The app client ID.
 


analyticsMetadata
AnalyticsMetadataType analyticsMetadata

 The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth calls.
 


userContextData
UserContextDataType userContextData

 Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an
 unexpected event by Amazon Cognito advanced security.
 








Class com.amazonaws.services.cognitoidp.model.InitiateAuthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


challengeName
String challengeName

 The name of the challenge which you are responding to with this call. This is returned to you in the
 AdminInitiateAuth response if you need to pass another challenge.
 
 
 Valid values include the following. Note that all of these challenges require USERNAME and
 SECRET_HASH (if applicable) in the parameters.
 
 
 
 
 SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.
 
 
 
 
 PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE,
 PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.
 
 
 
 
 CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user
 should pass another challenge before tokens are issued.
 
 
 
 
 DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were
 passed, this challenge is returned so that Amazon Cognito can start tracking this device.
 
 
 
 
 DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.
 
 
 
 
 NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first
 login. This challenge should be passed with NEW_PASSWORD and any other required attributes.
 
 
 


session
String session

 The session which should be passed both ways in challenge-response calls to the service. If the or API call
 determines that the caller needs to go through another challenge, they return a session with other challenge
 parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
 


challengeParameters
Map<K,V> challengeParameters

 The challenge parameters. These are returned to you in the InitiateAuth response if you need to pass
 another challenge. The responses in this parameter should be used to compute inputs to the next call (
 RespondToAuthChallenge).
 
 
 All challenges require USERNAME and SECRET_HASH (if applicable).
 


authenticationResult
AuthenticationResultType authenticationResult

 The result of the authentication response. This is only returned if the caller does not need to pass another
 challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName,
 ChallengeParameters, and Session are returned.
 








Class com.amazonaws.services.cognitoidp.model.InternalErrorException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.InvalidEmailRoleAccessPolicyException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.InvalidLambdaResponseException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.InvalidOAuthFlowException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.InvalidParameterException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.InvalidPasswordException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.InvalidSmsRoleAccessPolicyException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.InvalidSmsRoleTrustRelationshipException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.InvalidUserPoolConfigurationException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.LambdaConfigType extends Object implements Serializable


Serialized Fields


preSignUp
String preSignUp

 A pre-registration AWS Lambda trigger.
 


customMessage
String customMessage

 A custom Message AWS Lambda trigger.
 


postConfirmation
String postConfirmation

 A post-confirmation AWS Lambda trigger.
 


preAuthentication
String preAuthentication

 A pre-authentication AWS Lambda trigger.
 


postAuthentication
String postAuthentication

 A post-authentication AWS Lambda trigger.
 


defineAuthChallenge
String defineAuthChallenge

 Defines the authentication challenge.
 


createAuthChallenge
String createAuthChallenge

 Creates an authentication challenge.
 


verifyAuthChallengeResponse
String verifyAuthChallengeResponse

 Verifies the authentication challenge response.
 


preTokenGeneration
String preTokenGeneration

 A Lambda trigger that is invoked before token generation.
 


userMigration
String userMigration

 The user migration Lambda config type.
 








Class com.amazonaws.services.cognitoidp.model.LimitExceededException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.ListDevicesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessToken
String accessToken

 The access tokens for the request to list devices.
 


limit
Integer limit

 The limit of the device request.
 


paginationToken
String paginationToken

 The pagination token for the list request.
 








Class com.amazonaws.services.cognitoidp.model.ListDevicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devices
List<E> devices

 The devices returned in the list devices response.
 


paginationToken
String paginationToken

 The pagination token for the list device response.
 








Class com.amazonaws.services.cognitoidp.model.ListGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


limit
Integer limit

 The limit of the request to list groups.
 


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.ListGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


groups
List<E> groups

 The group objects for the groups.
 


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.ListIdentityProvidersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


maxResults
Integer maxResults

 The maximum number of identity providers to return.
 


nextToken
String nextToken

 A pagination token.
 








Class com.amazonaws.services.cognitoidp.model.ListIdentityProvidersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


providers
List<E> providers

 A list of identity provider objects.
 


nextToken
String nextToken

 A pagination token.
 








Class com.amazonaws.services.cognitoidp.model.ListResourceServersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


maxResults
Integer maxResults

 The maximum number of resource servers to return.
 


nextToken
String nextToken

 A pagination token.
 








Class com.amazonaws.services.cognitoidp.model.ListResourceServersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceServers
List<E> resourceServers

 The resource servers.
 


nextToken
String nextToken

 A pagination token.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
 








Class com.amazonaws.services.cognitoidp.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The tags that are assigned to the user pool.
 








Class com.amazonaws.services.cognitoidp.model.ListUserImportJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool that the users are being imported into.
 


maxResults
Integer maxResults

 The maximum number of import jobs you want the request to return.
 


paginationToken
String paginationToken

 An identifier that was returned from the previous call to ListUserImportJobs, which can be used to
 return the next set of import jobs in the list.
 








Class com.amazonaws.services.cognitoidp.model.ListUserImportJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userImportJobs
List<E> userImportJobs

 The user import jobs.
 


paginationToken
String paginationToken

 An identifier that can be used to return the next set of user import jobs in the list.
 








Class com.amazonaws.services.cognitoidp.model.ListUserPoolClientsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to list user pool clients.
 


maxResults
Integer maxResults

 The maximum number of results you want the request to return when listing the user pool clients.
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.cognitoidp.model.ListUserPoolClientsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userPoolClients
List<E> userPoolClients

 The user pool clients in the response that lists user pool clients.
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.cognitoidp.model.ListUserPoolsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 


maxResults
Integer maxResults

 The maximum number of results you want the request to return when listing the user pools.
 








Class com.amazonaws.services.cognitoidp.model.ListUserPoolsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userPools
List<E> userPools

 The user pools from the response to list users.
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.cognitoidp.model.ListUsersInGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


groupName
String groupName

 The name of the group.
 


limit
Integer limit

 The limit of the request to list users.
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.cognitoidp.model.ListUsersInGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


users
List<E> users

 The users returned in the request to list users.
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.cognitoidp.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool on which the search should be performed.
 


attributesToGet
List<E> attributesToGet

 An array of strings, where each string is the name of a user attribute to be returned for each user in the search
 results. If the array is null, all attributes are returned.
 


limit
Integer limit

 Maximum number of users to be returned.
 


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.
 


filter
String filter

 A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks
 within the filter string must be escaped using the backslash (\) character. For example, "
 family_name = \"Reddy\"".
 
 
 
 
 AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
 
 
 
 
 Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix
 ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".
 
 
 
 
 AttributeValue: The attribute value that must be matched for each user.
 
 
 
 
 If the filter string is empty, ListUsers returns all users in the user pool.
 
 
 You can only search for the following standard attributes:
 
 
 
 
 username (case-sensitive)
 
 
 
 
 email
 
 
 
 
 phone_number
 
 
 
 
 name
 
 
 
 
 given_name
 
 
 
 
 family_name
 
 
 
 
 preferred_username
 
 
 
 
 cognito:user_status (called Status in the Console) (case-insensitive)
 
 
 
 
 status (called Enabled in the Console) (case-sensitive)
 
 
 
 
 sub
 
 
 
 
 Custom attributes are not searchable.
 
 
 For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
 








Class com.amazonaws.services.cognitoidp.model.ListUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


users
List<E> users

 The users returned in the request to list users.
 


paginationToken
String paginationToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.cognitoidp.model.MessageTemplateType extends Object implements Serializable


Serialized Fields


sMSMessage
String sMSMessage

 The message template for SMS messages.
 


emailMessage
String emailMessage

 The message template for email messages.
 


emailSubject
String emailSubject

 The subject line for email messages.
 








Class com.amazonaws.services.cognitoidp.model.MFAMethodNotFoundException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.MFAOptionType extends Object implements Serializable


Serialized Fields


deliveryMedium
String deliveryMedium

 The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery
 medium value.
 


attributeName
String attributeName

 The attribute name of the MFA option type. The only valid value is phone_number.
 








Class com.amazonaws.services.cognitoidp.model.NewDeviceMetadataType extends Object implements Serializable


Serialized Fields


deviceKey
String deviceKey

 The device key.
 


deviceGroupKey
String deviceGroupKey

 The device group key.
 








Class com.amazonaws.services.cognitoidp.model.NotAuthorizedException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.NotifyConfigurationType extends Object implements Serializable


Serialized Fields


from
String from

 The email address that is sending the email. It must be either individually verified with Amazon SES, or from a
 domain that has been verified with Amazon SES.
 


replyTo
String replyTo

 The destination to which the receiver of an email should reply to.
 


sourceArn
String sourceArn

 The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. It
 permits Amazon Cognito to send for the email address specified in the From parameter.
 


blockEmail
NotifyEmailType blockEmail

 Email template used when a detected risk event is blocked.
 


noActionEmail
NotifyEmailType noActionEmail

 The email template used when a detected risk event is allowed.
 


mfaEmail
NotifyEmailType mfaEmail

 The MFA email template used when MFA is challenged as part of a detected risk.
 








Class com.amazonaws.services.cognitoidp.model.NotifyEmailType extends Object implements Serializable


Serialized Fields


subject
String subject

 The subject.
 


htmlBody
String htmlBody

 The HTML body.
 


textBody
String textBody

 The text body.
 








Class com.amazonaws.services.cognitoidp.model.NumberAttributeConstraintsType extends Object implements Serializable


Serialized Fields


minValue
String minValue

 The minimum value of an attribute that is of the number data type.
 


maxValue
String maxValue

 The maximum value of an attribute that is of the number data type.
 








Class com.amazonaws.services.cognitoidp.model.PasswordPolicyType extends Object implements Serializable


Serialized Fields


minimumLength
Integer minimumLength

 The minimum length of the password policy that you have set. Cannot be less than 6.
 


requireUppercase
Boolean requireUppercase

 In the password policy that you have set, refers to whether you have required users to use at least one uppercase
 letter in their password.
 


requireLowercase
Boolean requireLowercase

 In the password policy that you have set, refers to whether you have required users to use at least one lowercase
 letter in their password.
 


requireNumbers
Boolean requireNumbers

 In the password policy that you have set, refers to whether you have required users to use at least one number in
 their password.
 


requireSymbols
Boolean requireSymbols

 In the password policy that you have set, refers to whether you have required users to use at least one symbol in
 their password.
 


temporaryPasswordValidityDays
Integer temporaryPasswordValidityDays

 In the password policy you have set, refers to the number of days a temporary password is valid. If the user does
 not sign-in during this time, their password will need to be reset by an administrator.
 
 
 
 When you set TemporaryPasswordValidityDays for a user pool, you will no longer be able to set the
 deprecated UnusedAccountValidityDays value for that user pool.
 
 








Class com.amazonaws.services.cognitoidp.model.PasswordResetRequiredException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.PreconditionNotMetException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.ProviderDescription extends Object implements Serializable


Serialized Fields


providerName
String providerName

 The identity provider name.
 


providerType
String providerType

 The identity provider type.
 


lastModifiedDate
Date lastModifiedDate

 The date the provider was last modified.
 


creationDate
Date creationDate

 The date the provider was added to the user pool.
 








Class com.amazonaws.services.cognitoidp.model.ProviderUserIdentifierType extends Object implements Serializable


Serialized Fields


providerName
String providerName

 The name of the provider, for example, Facebook, Google, or Login with Amazon.
 


providerAttributeName
String providerAttributeName

 The name of the provider attribute to link to, for example, NameID.
 


providerAttributeValue
String providerAttributeValue

 The value of the provider attribute to link to, for example, xxxxx_account.
 








Class com.amazonaws.services.cognitoidp.model.RecoveryOptionType extends Object implements Serializable


Serialized Fields


priority
Integer priority

 A positive integer specifying priority of a method with 1 being the highest priority.
 


name
String name

 Specifies the recovery method for a user.
 








Class com.amazonaws.services.cognitoidp.model.ResendConfirmationCodeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientId
String clientId

 The ID of the client associated with the user pool.
 


secretHash
String secretHash

 A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and
 username plus the client ID in the message.
 


userContextData
UserContextDataType userContextData

 Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an
 unexpected event by Amazon Cognito advanced security.
 


username
String username

 The user name of the user to whom you wish to resend a confirmation code.
 


analyticsMetadata
AnalyticsMetadataType analyticsMetadata

 The Amazon Pinpoint analytics metadata for collecting metrics for ResendConfirmationCode calls.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom
 message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function
 receives as input. This payload contains a clientMetadata attribute, which provides the data that
 you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in AWS
 Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.ResendConfirmationCodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


codeDeliveryDetails
CodeDeliveryDetailsType codeDeliveryDetails

 The code delivery details returned by the server in response to the request to resend the confirmation code.
 








Class com.amazonaws.services.cognitoidp.model.ResourceNotFoundException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.ResourceServerScopeType extends Object implements Serializable


Serialized Fields


scopeName
String scopeName

 The name of the scope.
 


scopeDescription
String scopeDescription

 A description of the scope.
 








Class com.amazonaws.services.cognitoidp.model.ResourceServerType extends Object implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool that hosts the resource server.
 


identifier
String identifier

 The identifier for the resource server.
 


name
String name

 The name of the resource server.
 


scopes
List<E> scopes

 A list of scopes that are defined for the resource server.
 








Class com.amazonaws.services.cognitoidp.model.RespondToAuthChallengeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientId
String clientId

 The app client ID.
 


challengeName
String challengeName

 The challenge name. For more information, see .
 
 
 ADMIN_NO_SRP_AUTH is not a valid value.
 


session
String session

 The session which should be passed both ways in challenge-response calls to the service. If
 InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go
 through another challenge, they return a session with other challenge parameters. This session should be passed
 as it is to the next RespondToAuthChallenge API call.
 


challengeResponses
Map<K,V> challengeResponses

 The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:
 
 
 
 SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including
 SOFTWARE_TOKEN_MFA).
 
 
 
 
 
 SMS_MFA: SMS_MFA_CODE, USERNAME.
 
 
 
 
 PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK,
 TIMESTAMP, USERNAME.
 
 
 
 
 NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes,
 USERNAME.
 
 
 
 
 SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required
 attributes.
 
 
 
 
 DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and
 SECRET_HASH).
 
 
 
 
 DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus
 DEVICE_KEY.
 
 
 


analyticsMetadata
AnalyticsMetadataType analyticsMetadata

 The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.
 


userContextData
UserContextDataType userContextData

 Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an
 unexpected event by Amazon Cognito advanced security.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following
 triggers: post authentication, pre token generation, define auth challenge, create auth
 challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a
 JSON payload, which the function receives as input. This payload contains a clientMetadata
 attribute, which provides the data that you assigned to the ClientMetadata parameter in your
 RespondToAuthChallenge request. In your function code in AWS Lambda, you can process the
 clientMetadata value to enhance your workflow for your specific needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.RespondToAuthChallengeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


challengeName
String challengeName

 The challenge name. For more information, see .
 


session
String session

 The session which should be passed both ways in challenge-response calls to the service. If the or API call
 determines that the caller needs to go through another challenge, they return a session with other challenge
 parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.
 


challengeParameters
Map<K,V> challengeParameters

 The challenge parameters. For more information, see .
 


authenticationResult
AuthenticationResultType authenticationResult

 The result returned by the server in response to the request to respond to the authentication challenge.
 








Class com.amazonaws.services.cognitoidp.model.RiskConfigurationType extends Object implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


clientId
String clientId

 The app client ID.
 


compromisedCredentialsRiskConfiguration
CompromisedCredentialsRiskConfigurationType compromisedCredentialsRiskConfiguration

 The compromised credentials risk configuration object including the EventFilter and the
 EventAction
 


accountTakeoverRiskConfiguration
AccountTakeoverRiskConfigurationType accountTakeoverRiskConfiguration

 The account takeover risk configuration object including the NotifyConfiguration object and
 Actions to take in the case of an account takeover.
 


riskExceptionConfiguration
RiskExceptionConfigurationType riskExceptionConfiguration

 The configuration to override the risk decision.
 


lastModifiedDate
Date lastModifiedDate

 The last modified date.
 








Class com.amazonaws.services.cognitoidp.model.RiskExceptionConfigurationType extends Object implements Serializable


Serialized Fields


blockedIPRangeList
List<E> blockedIPRangeList

 Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation: a
 compact representation of an IP address and its associated routing prefix.
 


skippedIPRangeList
List<E> skippedIPRangeList

 Risk detection is not performed on the IP addresses in the range list. The IP range is in CIDR notation.
 








Class com.amazonaws.services.cognitoidp.model.SchemaAttributeType extends Object implements Serializable


Serialized Fields


name
String name

 A schema attribute of the name type.
 


attributeDataType
String attributeDataType

 The attribute data type.
 


developerOnlyAttribute
Boolean developerOnlyAttribute

 Specifies whether the attribute type is developer only.
 


mutable
Boolean mutable

 Specifies whether the value of the attribute can be changed.
 
 
 For any user pool attribute that's mapped to an identity provider attribute, you must set this parameter to
 true. Amazon Cognito updates mapped attributes when users sign in to your application through an
 identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the
 attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.
 


required
Boolean required

 Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a
 value, registration or sign-in will fail.
 


numberAttributeConstraints
NumberAttributeConstraintsType numberAttributeConstraints

 Specifies the constraints for an attribute of the number type.
 


stringAttributeConstraints
StringAttributeConstraintsType stringAttributeConstraints

 Specifies the constraints for an attribute of the string type.
 








Class com.amazonaws.services.cognitoidp.model.ScopeDoesNotExistException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.SetRiskConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


clientId
String clientId

 The app client ID. If ClientId is null, then the risk configuration is mapped to
 userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in
 the userPool.
 
 
 Otherwise, ClientId is mapped to the client. When the client ID is not null, the user pool
 configuration is overridden and the risk configuration for the client is used instead.
 


compromisedCredentialsRiskConfiguration
CompromisedCredentialsRiskConfigurationType compromisedCredentialsRiskConfiguration

 The compromised credentials risk configuration.
 


accountTakeoverRiskConfiguration
AccountTakeoverRiskConfigurationType accountTakeoverRiskConfiguration

 The account takeover risk configuration.
 


riskExceptionConfiguration
RiskExceptionConfigurationType riskExceptionConfiguration

 The configuration to override the risk decision.
 








Class com.amazonaws.services.cognitoidp.model.SetRiskConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


riskConfiguration
RiskConfigurationType riskConfiguration

 The risk configuration.
 








Class com.amazonaws.services.cognitoidp.model.SetUICustomizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


clientId
String clientId

 The client ID for the client app.
 


cSS
String cSS

 The CSS values in the UI customization.
 


imageFile
ByteBuffer imageFile

 The uploaded logo image for the UI customization.
 








Class com.amazonaws.services.cognitoidp.model.SetUICustomizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uICustomization
UICustomizationType uICustomization

 The UI customization information.
 








Class com.amazonaws.services.cognitoidp.model.SetUserMFAPreferenceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sMSMfaSettings
SMSMfaSettingsType sMSMfaSettings

 The SMS text message multi-factor authentication (MFA) settings.
 


softwareTokenMfaSettings
SoftwareTokenMfaSettingsType softwareTokenMfaSettings

 The time-based one-time password software token MFA settings.
 


accessToken
String accessToken

 The access token for the user.
 








Class com.amazonaws.services.cognitoidp.model.SetUserMFAPreferenceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.SetUserPoolMfaConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


smsMfaConfiguration
SmsMfaConfigType smsMfaConfiguration

 The SMS text message MFA configuration.
 


softwareTokenMfaConfiguration
SoftwareTokenMfaConfigType softwareTokenMfaConfiguration

 The software token MFA configuration.
 


mfaConfiguration
String mfaConfiguration

 The MFA configuration. Valid values include:
 
 
 
 
 OFF MFA will not be used for any users.
 
 
 
 
 ON MFA is required for all users to sign in.
 
 
 
 
 OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
 
 
 








Class com.amazonaws.services.cognitoidp.model.SetUserPoolMfaConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


smsMfaConfiguration
SmsMfaConfigType smsMfaConfiguration

 The SMS text message MFA configuration.
 


softwareTokenMfaConfiguration
SoftwareTokenMfaConfigType softwareTokenMfaConfiguration

 The software token MFA configuration.
 


mfaConfiguration
String mfaConfiguration

 The MFA configuration. Valid values include:
 
 
 
 
 OFF MFA will not be used for any users.
 
 
 
 
 ON MFA is required for all users to sign in.
 
 
 
 
 OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.
 
 
 








Class com.amazonaws.services.cognitoidp.model.SetUserSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessToken
String accessToken

 The access token for the set user settings request.
 


mFAOptions
List<E> mFAOptions

 You can use this parameter only to set an SMS configuration that uses SMS for delivery.
 








Class com.amazonaws.services.cognitoidp.model.SetUserSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.SignUpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientId
String clientId

 The ID of the client associated with the user pool.
 


secretHash
String secretHash

 A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and
 username plus the client ID in the message.
 


username
String username

 The user name of the user you wish to register.
 


password
String password

 The password of the user you wish to register.
 


userAttributes
List<E> userAttributes

 An array of name-value pairs representing user attributes.
 
 
 For custom attributes, you must prepend the custom: prefix to the attribute name.
 


validationData
List<E> validationData

 The validation data in the request to register a user.
 


analyticsMetadata
AnalyticsMetadataType analyticsMetadata

 The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.
 


userContextData
UserContextDataType userContextData

 Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an
 unexpected event by Amazon Cognito advanced security.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the SignUp API
 action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up,
 custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it
 passes a JSON payload, which the function receives as input. This payload contains a clientMetadata
 attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In
 your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow
 for your specific needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.SignUpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userConfirmed
Boolean userConfirmed

 A response from the server indicating that a user registration has been confirmed.
 


codeDeliveryDetails
CodeDeliveryDetailsType codeDeliveryDetails

 The code delivery details returned by the server response to the user registration request.
 


userSub
String userSub

 The UUID of the authenticated user. This is not the same as username.
 








Class com.amazonaws.services.cognitoidp.model.SmsConfigurationType extends Object implements Serializable


Serialized Fields


snsCallerArn
String snsCallerArn

 The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM
 role in your AWS account which Cognito will use to send SMS messages.
 


externalId
String externalId

 The external ID is a value that we recommend you use to add security to your IAM role which is used to call
 Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, the Cognito User
 Pool will include it when attempting to assume your IAM role, so that you can set your roles trust policy to
 require the ExternalID. If you use the Cognito Management Console to create a role for SMS MFA,
 Cognito will create a role with the required permissions and a trust policy that demonstrates use of the
 ExternalId.
 








Class com.amazonaws.services.cognitoidp.model.SmsMfaConfigType extends Object implements Serializable


Serialized Fields


smsAuthenticationMessage
String smsAuthenticationMessage

 The SMS authentication message that will be sent to users with the code they need to sign in. The message must
 contain the ‘{####}’ placeholder, which will be replaced with the code. If the message is not included, and
 default message will be used.
 


smsConfiguration
SmsConfigurationType smsConfiguration

 The SMS configuration.
 








Class com.amazonaws.services.cognitoidp.model.SMSMfaSettingsType extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specifies whether SMS text message MFA is enabled.
 


preferredMfa
Boolean preferredMfa

 Specifies whether SMS is the preferred MFA method.
 








Class com.amazonaws.services.cognitoidp.model.SoftwareTokenMfaConfigType extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specifies whether software token MFA is enabled.
 








Class com.amazonaws.services.cognitoidp.model.SoftwareTokenMFANotFoundException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.SoftwareTokenMfaSettingsType extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specifies whether software token MFA is enabled.
 


preferredMfa
Boolean preferredMfa

 Specifies whether software token MFA is the preferred MFA method.
 








Class com.amazonaws.services.cognitoidp.model.StartUserImportJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool that the users are being imported into.
 


jobId
String jobId

 The job ID for the user import job.
 








Class com.amazonaws.services.cognitoidp.model.StartUserImportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userImportJob
UserImportJobType userImportJob

 The job object that represents the user import job.
 








Class com.amazonaws.services.cognitoidp.model.StopUserImportJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool that the users are being imported into.
 


jobId
String jobId

 The job ID for the user import job.
 








Class com.amazonaws.services.cognitoidp.model.StopUserImportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userImportJob
UserImportJobType userImportJob

 The job object that represents the user import job.
 








Class com.amazonaws.services.cognitoidp.model.StringAttributeConstraintsType extends Object implements Serializable


Serialized Fields


minLength
String minLength

 The minimum length.
 


maxLength
String maxLength

 The maximum length.
 








Class com.amazonaws.services.cognitoidp.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the user pool to assign the tags to.
 


tags
Map<K,V> tags

 The tags to assign to the user pool.
 








Class com.amazonaws.services.cognitoidp.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.TooManyFailedAttemptsException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.TooManyRequestsException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.UICustomizationType extends Object implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


clientId
String clientId

 The client ID for the client app.
 


imageUrl
String imageUrl

 The logo image for the UI customization.
 


cSS
String cSS

 The CSS values in the UI customization.
 


cSSVersion
String cSSVersion

 The CSS version number.
 


lastModifiedDate
Date lastModifiedDate

 The last-modified date for the UI customization.
 


creationDate
Date creationDate

 The creation date for the UI customization.
 








Class com.amazonaws.services.cognitoidp.model.UnexpectedLambdaException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.UnsupportedIdentityProviderException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.UnsupportedUserStateException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.
 


tagKeys
List<E> tagKeys

 The keys of the tags to remove from the user pool.
 








Class com.amazonaws.services.cognitoidp.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.UpdateAuthEventFeedbackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


username
String username

 The user pool username.
 


eventId
String eventId

 The event ID.
 


feedbackToken
String feedbackToken

 The feedback token.
 


feedbackValue
String feedbackValue

 The authentication event feedback value.
 








Class com.amazonaws.services.cognitoidp.model.UpdateAuthEventFeedbackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.UpdateDeviceStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessToken
String accessToken

 The access token.
 


deviceKey
String deviceKey

 The device key.
 


deviceRememberedStatus
String deviceRememberedStatus

 The status of whether a device is remembered.
 








Class com.amazonaws.services.cognitoidp.model.UpdateDeviceStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.UpdateGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name of the group.
 


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


description
String description

 A string containing the new description of the group.
 


roleArn
String roleArn

 The new role ARN for the group. This is used for setting the cognito:roles and
 cognito:preferred_role claims in the token.
 


precedence
Integer precedence

 The new precedence value for the group. For more information about this parameter, see .
 








Class com.amazonaws.services.cognitoidp.model.UpdateGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


group
GroupType group

 The group object for the group.
 








Class com.amazonaws.services.cognitoidp.model.UpdateIdentityProviderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID.
 


providerName
String providerName

 The identity provider name.
 


providerDetails
Map<K,V> providerDetails

 The identity provider details to be updated, such as MetadataURL and MetadataFile.
 


attributeMapping
Map<K,V> attributeMapping

 The identity provider attribute mapping to be changed.
 


idpIdentifiers
List<E> idpIdentifiers

 A list of identity provider identifiers.
 








Class com.amazonaws.services.cognitoidp.model.UpdateIdentityProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityProvider
IdentityProviderType identityProvider

 The identity provider object.
 








Class com.amazonaws.services.cognitoidp.model.UpdateResourceServerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool.
 


identifier
String identifier

 The identifier for the resource server.
 


name
String name

 The name of the resource server.
 


scopes
List<E> scopes

 The scope values to be set for the resource server.
 








Class com.amazonaws.services.cognitoidp.model.UpdateResourceServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceServer
ResourceServerType resourceServer

 The resource server.
 








Class com.amazonaws.services.cognitoidp.model.UpdateUserAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userAttributes
List<E> userAttributes

 An array of name-value pairs representing user attributes.
 
 
 For custom attributes, you must prepend the custom: prefix to the attribute name.
 


accessToken
String accessToken

 The access token for the request to update user attributes.
 


clientMetadata
Map<K,V> clientMetadata

 A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
 
 
 You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the
 UpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom
 message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function
 receives as input. This payload contains a clientMetadata attribute, which provides the data that
 you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in AWS
 Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.
 
 
 For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
 
 
 
 Take the following limitations into consideration when you use the ClientMetadata parameter:
 
 
 
 
 Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that
 are assigned to a user pool to support custom workflows. If your user pool configuration does not include
 triggers, the ClientMetadata parameter serves no purpose.
 
 
 
 
 Amazon Cognito does not validate the ClientMetadata value.
 
 
 
 
 Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.
 
 
 
 








Class com.amazonaws.services.cognitoidp.model.UpdateUserAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


codeDeliveryDetailsList
List<E> codeDeliveryDetailsList

 The code delivery details list from the server for the request to update user attributes.
 








Class com.amazonaws.services.cognitoidp.model.UpdateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to update the user pool client.
 


clientId
String clientId

 The ID of the client associated with the user pool.
 


clientName
String clientName

 The client name from the update user pool client request.
 


refreshTokenValidity
Integer refreshTokenValidity

 The time limit, in days, after which the refresh token is no longer valid and cannot be used.
 


readAttributes
List<E> readAttributes

 The read-only attributes of the user pool.
 


writeAttributes
List<E> writeAttributes

 The writeable attributes of the user pool.
 


explicitAuthFlows
List<E> explicitAuthFlows

 The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
 prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with
 ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
 
 
 Valid values include:
 
 
 
 
 ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow
 ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With
 this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote
 Password protocol) protocol to verify passwords.
 
 
 
 
 ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
 
 
 
 
 ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives
 the password in the request instead of using the SRP protocol to verify passwords.
 
 
 
 
 ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
 
 
 
 
 ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
 
 
 


supportedIdentityProviders
List<E> supportedIdentityProviders

 A list of provider names for the identity providers that are supported on this client.
 


callbackURLs
List<E> callbackURLs

 A list of allowed redirect (callback) URLs for the identity providers.
 
 
 A redirect URI must:
 
 
 
 
 Be an absolute URI.
 
 
 
 
 Be registered with the authorization server.
 
 
 
 
 Not include a fragment component.
 
 
 
 
 See OAuth 2.0 - Redirection Endpoint.
 
 
 Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
 
 
 App callback URLs such as myapp://example are also supported.
 


logoutURLs
List<E> logoutURLs

 A list of allowed logout URLs for the identity providers.
 


defaultRedirectURI
String defaultRedirectURI

 The default redirect URI. Must be in the CallbackURLs list.
 
 
 A redirect URI must:
 
 
 
 
 Be an absolute URI.
 
 
 
 
 Be registered with the authorization server.
 
 
 
 
 Not include a fragment component.
 
 
 
 
 See OAuth 2.0 - Redirection Endpoint.
 
 
 Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
 
 
 App callback URLs such as myapp://example are also supported.
 


allowedOAuthFlows
List<E> allowedOAuthFlows

 Set to code to initiate a code grant flow, which provides an authorization code as the response.
 This code can be exchanged for access tokens with the token endpoint.
 


allowedOAuthScopes
List<E> allowedOAuthScopes

 A list of allowed OAuth scopes. Currently supported values are "phone",
 "email", "openid", and "Cognito". In addition to these values, custom
 scopes created in Resource Servers are also supported.
 


allowedOAuthFlowsUserPoolClient
Boolean allowedOAuthFlowsUserPoolClient

 Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
 


analyticsConfiguration
AnalyticsConfigurationType analyticsConfiguration

 The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.
 


preventUserExistenceErrors
String preventUserExistenceErrors

 Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account
 confirmation, and password recovery when the user does not exist in the user pool. When set to
 ENABLED and the user does not exist, authentication returns an error indicating either the username
 or password was incorrect, and account confirmation and password recovery return a response indicating a code was
 sent to a simulated destination. When set to LEGACY, those APIs will return a
 UserNotFoundException exception if the user does not exist in the user pool.
 
 
 Valid values include:
 
 
 
 
 ENABLED - This prevents user existence-related errors.
 
 
 
 
 LEGACY - This represents the old behavior of Cognito where user existence related errors are not
 prevented.
 
 
 
 
 This setting affects the behavior of following APIs:
 
 
 
 
 AdminInitiateAuth
 
 
 
 
 AdminRespondToAuthChallenge
 
 
 
 
 InitiateAuth
 
 
 
 
 RespondToAuthChallenge
 
 
 
 
 ForgotPassword
 
 
 
 
 ConfirmForgotPassword
 
 
 
 
 ConfirmSignUp
 
 
 
 
 ResendConfirmationCode
 
 
 
 
 
 After January 1st 2020, the value of PreventUserExistenceErrors will default to ENABLED
 for newly created user pool clients if no value is provided.
 
 








Class com.amazonaws.services.cognitoidp.model.UpdateUserPoolClientResult extends AmazonWebServiceResult<ResponseMetadata> 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.UpdateUserPoolDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domain
String domain

 The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. For example:
 auth.example.com.
 
 
 This string can include only lowercase letters, numbers, and hyphens. Do not use a hyphen for the first or last
 character. Use periods to separate subdomain names.
 


userPoolId
String userPoolId

 The ID of the user pool that is associated with the custom domain that you are updating the certificate for.
 


customDomainConfig
CustomDomainConfigType customDomainConfig

 The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this
 object to specify an SSL certificate that is managed by ACM.
 








Class com.amazonaws.services.cognitoidp.model.UpdateUserPoolDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cloudFrontDomain
String cloudFrontDomain

 The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.
 








Class com.amazonaws.services.cognitoidp.model.UpdateUserPoolRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool you want to update.
 


policies
UserPoolPolicyType policies

 A container with the policies you wish to update in a user pool.
 


lambdaConfig
LambdaConfigType lambdaConfig

 The AWS Lambda configuration information from the request to update the user pool.
 


autoVerifiedAttributes
List<E> autoVerifiedAttributes

 The attributes that are automatically verified when the Amazon Cognito service makes a request to update user
 pools.
 


smsVerificationMessage
String smsVerificationMessage

 A container with information about the SMS verification message.
 


emailVerificationMessage
String emailVerificationMessage

 The contents of the email verification message.
 


emailVerificationSubject
String emailVerificationSubject

 The subject of the email verification message.
 


verificationMessageTemplate
VerificationMessageTemplateType verificationMessageTemplate

 The template for verification messages.
 


smsAuthenticationMessage
String smsAuthenticationMessage

 The contents of the SMS authentication message.
 


mfaConfiguration
String mfaConfiguration

 Can be one of the following values:
 
 
 
 
 OFF - MFA tokens are not required and cannot be specified during user registration.
 
 
 
 
 ON - MFA tokens are required for all user registrations. You can only specify required when you are
 initially creating a user pool.
 
 
 
 
 OPTIONAL - Users have the option when registering to create an MFA token.
 
 
 


deviceConfiguration
DeviceConfigurationType deviceConfiguration

 Device configuration.
 


emailConfiguration
EmailConfigurationType emailConfiguration

 Email configuration.
 


smsConfiguration
SmsConfigurationType smsConfiguration

 SMS configuration.
 


userPoolTags
Map<K,V> userPoolTags

 The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage
 user pools in different ways, such as by purpose, owner, environment, or other criteria.
 


adminCreateUserConfig
AdminCreateUserConfigType adminCreateUserConfig

 The configuration for AdminCreateUser requests.
 


userPoolAddOns
UserPoolAddOnsType userPoolAddOns

 Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value
 "AUDIT".
 


accountRecoverySetting
AccountRecoverySettingType accountRecoverySetting

 Use this setting to define which verified available method a user can use to recover their password when they
 call ForgotPassword. It allows you to define a preferred method when a user has more than one method
 available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has
 SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery
 method where SMS is preferred over email.
 








Class com.amazonaws.services.cognitoidp.model.UpdateUserPoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitoidp.model.UserContextDataType extends Object implements Serializable


Serialized Fields


encodedData
String encodedData

 Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an
 unexpected event by Amazon Cognito advanced security.
 








Class com.amazonaws.services.cognitoidp.model.UserImportInProgressException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.UserImportJobType extends Object implements Serializable


Serialized Fields


jobName
String jobName

 The job name for the user import job.
 


jobId
String jobId

 The job ID for the user import job.
 


userPoolId
String userPoolId

 The user pool ID for the user pool that the users are being imported into.
 


preSignedUrl
String preSignedUrl

 The pre-signed URL to be used to upload the .csv file.
 


creationDate
Date creationDate

 The date the user import job was created.
 


startDate
Date startDate

 The date when the user import job was started.
 


completionDate
Date completionDate

 The date when the user import job was completed.
 


status
String status

 The status of the user import job. One of the following:
 
 
 
 
 Created - The job was created but not started.
 
 
 
 
 Pending - A transition state. You have started the job, but it has not begun importing users yet.
 
 
 
 
 InProgress - The job has started, and users are being imported.
 
 
 
 
 Stopping - You have stopped the job, but the job has not stopped importing users yet.
 
 
 
 
 Stopped - You have stopped the job, and the job has stopped importing users.
 
 
 
 
 Succeeded - The job has completed successfully.
 
 
 
 
 Failed - The job has stopped due to an error.
 
 
 
 
 Expired - You created a job, but did not start the job within 24-48 hours. All data associated with
 the job was deleted, and the job cannot be started.
 
 
 


cloudWatchLogsRoleArn
String cloudWatchLogsRoleArn

 The role ARN for the Amazon CloudWatch Logging role for the user import job. For more information, see
 "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.
 


importedUsers
Long importedUsers

 The number of users that were successfully imported.
 


skippedUsers
Long skippedUsers

 The number of users that were skipped.
 


failedUsers
Long failedUsers

 The number of users that could not be imported.
 


completionMessage
String completionMessage

 The message returned when the user import job is completed.
 








Class com.amazonaws.services.cognitoidp.model.UserLambdaValidationException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.UsernameExistsException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.UserNotConfirmedException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.UserNotFoundException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.UserPoolAddOnNotEnabledException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.UserPoolAddOnsType extends Object implements Serializable


Serialized Fields


advancedSecurityMode
String advancedSecurityMode

 The advanced security mode.
 








Class com.amazonaws.services.cognitoidp.model.UserPoolClientDescription extends Object implements Serializable


Serialized Fields


clientId
String clientId

 The ID of the client associated with the user pool.
 


userPoolId
String userPoolId

 The user pool ID for the user pool where you want to describe the user pool client.
 


clientName
String clientName

 The client name from the user pool client description.
 








Class com.amazonaws.services.cognitoidp.model.UserPoolClientType extends Object implements Serializable


Serialized Fields


userPoolId
String userPoolId

 The user pool ID for the user pool client.
 


clientName
String clientName

 The client name from the user pool request of the client type.
 


clientId
String clientId

 The ID of the client associated with the user pool.
 


clientSecret
String clientSecret

 The client secret from the user pool request of the client type.
 


lastModifiedDate
Date lastModifiedDate

 The date the user pool client was last modified.
 


creationDate
Date creationDate

 The date the user pool client was created.
 


refreshTokenValidity
Integer refreshTokenValidity

 The time limit, in days, after which the refresh token is no longer valid and cannot be used.
 


readAttributes
List<E> readAttributes

 The Read-only attributes.
 


writeAttributes
List<E> writeAttributes

 The writeable attributes.
 


explicitAuthFlows
List<E> explicitAuthFlows

 The authentication flows that are supported by the user pool clients. Flow names without the ALLOW_
 prefix are deprecated in favor of new names with the ALLOW_ prefix. Note that values with
 ALLOW_ prefix cannot be used along with values without ALLOW_ prefix.
 
 
 Valid values include:
 
 
 
 
 ALLOW_ADMIN_USER_PASSWORD_AUTH: Enable admin based user password authentication flow
 ADMIN_USER_PASSWORD_AUTH. This setting replaces the ADMIN_NO_SRP_AUTH setting. With
 this authentication flow, Cognito receives the password in the request instead of using the SRP (Secure Remote
 Password protocol) protocol to verify passwords.
 
 
 
 
 ALLOW_CUSTOM_AUTH: Enable Lambda trigger based authentication.
 
 
 
 
 ALLOW_USER_PASSWORD_AUTH: Enable user password-based authentication. In this flow, Cognito receives
 the password in the request instead of using the SRP protocol to verify passwords.
 
 
 
 
 ALLOW_USER_SRP_AUTH: Enable SRP based authentication.
 
 
 
 
 ALLOW_REFRESH_TOKEN_AUTH: Enable authflow to refresh tokens.
 
 
 


supportedIdentityProviders
List<E> supportedIdentityProviders

 A list of provider names for the identity providers that are supported on this client.
 


callbackURLs
List<E> callbackURLs

 A list of allowed redirect (callback) URLs for the identity providers.
 
 
 A redirect URI must:
 
 
 
 
 Be an absolute URI.
 
 
 
 
 Be registered with the authorization server.
 
 
 
 
 Not include a fragment component.
 
 
 
 
 See OAuth 2.0 - Redirection Endpoint.
 
 
 Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
 
 
 App callback URLs such as myapp://example are also supported.
 


logoutURLs
List<E> logoutURLs

 A list of allowed logout URLs for the identity providers.
 


defaultRedirectURI
String defaultRedirectURI

 The default redirect URI. Must be in the CallbackURLs list.
 
 
 A redirect URI must:
 
 
 
 
 Be an absolute URI.
 
 
 
 
 Be registered with the authorization server.
 
 
 
 
 Not include a fragment component.
 
 
 
 
 See OAuth 2.0 - Redirection Endpoint.
 
 
 Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.
 
 
 App callback URLs such as myapp://example are also supported.
 


allowedOAuthFlows
List<E> allowedOAuthFlows

 Set to code to initiate a code grant flow, which provides an authorization code as the response.
 This code can be exchanged for access tokens with the token endpoint.
 
 
 Set to token to specify that the client should get the access token (and, optionally, ID token,
 based on scopes) directly.
 


allowedOAuthScopes
List<E> allowedOAuthScopes

 A list of allowed OAuth scopes. Currently supported values are "phone",
 "email", "openid", and "Cognito". In addition to these values, custom
 scopes created in Resource Servers are also supported.
 


allowedOAuthFlowsUserPoolClient
Boolean allowedOAuthFlowsUserPoolClient

 Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.
 


analyticsConfiguration
AnalyticsConfigurationType analyticsConfiguration

 The Amazon Pinpoint analytics configuration for the user pool client.
 


preventUserExistenceErrors
String preventUserExistenceErrors

 Use this setting to choose which errors and responses are returned by Cognito APIs during authentication, account
 confirmation, and password recovery when the user does not exist in the user pool. When set to
 ENABLED and the user does not exist, authentication returns an error indicating either the username
 or password was incorrect, and account confirmation and password recovery return a response indicating a code was
 sent to a simulated destination. When set to LEGACY, those APIs will return a
 UserNotFoundException exception if the user does not exist in the user pool.
 
 
 Valid values include:
 
 
 
 
 ENABLED - This prevents user existence-related errors.
 
 
 
 
 LEGACY - This represents the old behavior of Cognito where user existence related errors are not
 prevented.
 
 
 
 
 This setting affects the behavior of following APIs:
 
 
 
 
 AdminInitiateAuth
 
 
 
 
 AdminRespondToAuthChallenge
 
 
 
 
 InitiateAuth
 
 
 
 
 RespondToAuthChallenge
 
 
 
 
 ForgotPassword
 
 
 
 
 ConfirmForgotPassword
 
 
 
 
 ConfirmSignUp
 
 
 
 
 ResendConfirmationCode
 
 
 
 
 
 After January 1st 2020, the value of PreventUserExistenceErrors will default to ENABLED
 for newly created user pool clients if no value is provided.
 
 








Class com.amazonaws.services.cognitoidp.model.UserPoolDescriptionType extends Object implements Serializable


Serialized Fields


id
String id

 The ID in a user pool description.
 


name
String name

 The name in a user pool description.
 


lambdaConfig
LambdaConfigType lambdaConfig

 The AWS Lambda configuration information in a user pool description.
 


status
String status

 The user pool status in a user pool description.
 


lastModifiedDate
Date lastModifiedDate

 The date the user pool description was last modified.
 


creationDate
Date creationDate

 The date the user pool description was created.
 








Class com.amazonaws.services.cognitoidp.model.UserPoolPolicyType extends Object implements Serializable


Serialized Fields


passwordPolicy
PasswordPolicyType passwordPolicy

 The password policy.
 








Class com.amazonaws.services.cognitoidp.model.UserPoolTaggingException extends AWSCognitoIdentityProviderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitoidp.model.UserPoolType extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the user pool.
 


name
String name

 The name of the user pool.
 


policies
UserPoolPolicyType policies

 The policies associated with the user pool.
 


lambdaConfig
LambdaConfigType lambdaConfig

 The AWS Lambda triggers associated with the user pool.
 


status
String status

 The status of a user pool.
 


lastModifiedDate
Date lastModifiedDate

 The date the user pool was last modified.
 


creationDate
Date creationDate

 The date the user pool was created.
 


schemaAttributes
List<E> schemaAttributes

 A container with the schema attributes of a user pool.
 


autoVerifiedAttributes
List<E> autoVerifiedAttributes

 Specifies the attributes that are auto-verified in a user pool.
 


aliasAttributes
List<E> aliasAttributes

 Specifies the attributes that are aliased in a user pool.
 


usernameAttributes
List<E> usernameAttributes

 Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.
 


smsVerificationMessage
String smsVerificationMessage

 The contents of the SMS verification message.
 


emailVerificationMessage
String emailVerificationMessage

 The contents of the email verification message.
 


emailVerificationSubject
String emailVerificationSubject

 The subject of the email verification message.
 


verificationMessageTemplate
VerificationMessageTemplateType verificationMessageTemplate

 The template for verification messages.
 


smsAuthenticationMessage
String smsAuthenticationMessage

 The contents of the SMS authentication message.
 


mfaConfiguration
String mfaConfiguration

 Can be one of the following values:
 
 
 
 
 OFF - MFA tokens are not required and cannot be specified during user registration.
 
 
 
 
 ON - MFA tokens are required for all user registrations. You can only specify required when you are
 initially creating a user pool.
 
 
 
 
 OPTIONAL - Users have the option when registering to create an MFA token.
 
 
 


deviceConfiguration
DeviceConfigurationType deviceConfiguration

 The device configuration.
 


estimatedNumberOfUsers
Integer estimatedNumberOfUsers

 A number estimating the size of the user pool.
 


emailConfiguration
EmailConfigurationType emailConfiguration

 The email configuration.
 


smsConfiguration
SmsConfigurationType smsConfiguration

 The SMS configuration.
 


userPoolTags
Map<K,V> userPoolTags

 The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and
 manage them in different ways, such as by purpose, owner, environment, or other criteria.
 


smsConfigurationFailure
String smsConfigurationFailure

 The reason why the SMS configuration cannot send the messages to your users.
 


emailConfigurationFailure
String emailConfigurationFailure

 The reason why the email configuration cannot send the messages to your users.
 


domain
String domain

 Holds the domain prefix if the user pool has a domain associated with it.
 


customDomain
String customDomain

 A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain
 to host the sign-up and sign-in pages for your application. For example: auth.example.com.
 
 
 For more information about adding a custom domain to your user pool, see Using
 Your Own Domain for the Hosted UI.
 


adminCreateUserConfig
AdminCreateUserConfigType adminCreateUserConfig

 The configuration for AdminCreateUser requests.
 


userPoolAddOns
UserPoolAddOnsType userPoolAddOns

 The user pool add-ons.
 


arn
String arn

 The Amazon Resource Name (ARN) for the user pool.
 


accountRecoverySetting
AccountRecoverySettingType accountRecoverySetting

 Use this setting to define which verified available method a user can use to recover their password when they
 call ForgotPassword. It allows you to define a preferred method when a user has more than one method
 available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has
 SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery
 method where SMS is preferred over email.
 








Class com.amazonaws.services.cognitoidp.model.UserType extends Object implements Serializable


Serialized Fields


username
String username

 The user name of the user you wish to describe.
 


attributes
List<E> attributes

 A container with information about the user type attributes.
 


userCreateDate
Date userCreateDate

 The creation date of the user.
 


userLastModifiedDate
Date userLastModifiedDate

 The last modified date of the user.
 


enabled
Boolean enabled

 Specifies whether the user is enabled.
 


userStatus
String userStatus

 The user status. Can be one of the following:
 
 
 
 
 UNCONFIRMED - User has been created but not confirmed.
 
 
 
 
 CONFIRMED - User has been confirmed.
 
 
 
 
 ARCHIVED - User is no longer active.
 
 
 
 
 COMPROMISED - User is disabled due to a potential security threat.
 
 
 
 
 UNKNOWN - User status is not known.
 
 
 
 
 RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or
 she can sign in.
 
 
 
 
 FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first
 sign-in, the user must change his or her password to a new value before doing anything else.
 
 
 


mFAOptions
List<E> mFAOptions

 The MFA options for the user.
 








Class com.amazonaws.services.cognitoidp.model.VerificationMessageTemplateType extends Object implements Serializable


Serialized Fields


smsMessage
String smsMessage

 The SMS message template.
 


emailMessage
String emailMessage

 The email message template.
 


emailSubject
String emailSubject

 The subject line for the email message template.
 


emailMessageByLink
String emailMessageByLink

 The email message template for sending a confirmation link to the user.
 


emailSubjectByLink
String emailSubjectByLink

 The subject line for the email message template for sending a confirmation link to the user.
 


defaultEmailOption
String defaultEmailOption

 The default email option.
 








Class com.amazonaws.services.cognitoidp.model.VerifySoftwareTokenRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessToken
String accessToken

 The access token.
 


session
String session

 The session which should be passed both ways in challenge-response calls to the service.
 


userCode
String userCode

 The one time password computed using the secret code returned by
 


friendlyDeviceName
String friendlyDeviceName

 The friendly device name.
 








Class com.amazonaws.services.cognitoidp.model.VerifySoftwareTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The status of the verify software token.
 


session
String session

 The session which should be passed both ways in challenge-response calls to the service.
 








Class com.amazonaws.services.cognitoidp.model.VerifyUserAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessToken
String accessToken

 Represents the access token of the request to verify user attributes.
 


attributeName
String attributeName

 The attribute name in the request to verify user attributes.
 


code
String code

 The verification code in the request to verify user attributes.
 








Class com.amazonaws.services.cognitoidp.model.VerifyUserAttributeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.cognitosync.model




Class com.amazonaws.services.cognitosync.model.AlreadyStreamedException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.AmazonCognitoSyncException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.BulkPublishRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.








Class com.amazonaws.services.cognitosync.model.BulkPublishResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.








Class com.amazonaws.services.cognitosync.model.CognitoStreams extends Object implements Serializable


Serialized Fields


streamName
String streamName
The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same
 region as the identity pool.


roleArn
String roleArn
The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to
 Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.


streamingStatus
String streamingStatus
Status of the Cognito streams. Valid values are:
 
 ENABLED - Streaming of updates to identity pool is enabled.
 
 
 DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is
 DISABLED.
 








Class com.amazonaws.services.cognitosync.model.ConcurrentModificationException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.Dataset extends Object implements Serializable


Serialized Fields


identityId
String identityId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


datasetName
String datasetName
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'
 (dot).


creationDate
Date creationDate
Date on which the dataset was created.


lastModifiedDate
Date lastModifiedDate
Date when the dataset was last modified.


lastModifiedBy
String lastModifiedBy
The device that made the last change to this dataset.


dataStorage
Long dataStorage
Total size in bytes of the records in this dataset.


numRecords
Long numRecords
Number of records in this dataset.








Class com.amazonaws.services.cognitosync.model.DeleteDatasetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


identityId
String identityId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


datasetName
String datasetName
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'
 (dot).








Class com.amazonaws.services.cognitosync.model.DeleteDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataset
Dataset dataset
A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity
 and can be general or associated with a particular entity in an application (like a saved game). Datasets are
 automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of
 key-value pairs.








Class com.amazonaws.services.cognitosync.model.DescribeDatasetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


identityId
String identityId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


datasetName
String datasetName
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'
 (dot).








Class com.amazonaws.services.cognitosync.model.DescribeDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataset
Dataset dataset
Meta data for a collection of data for an identity. An identity can have multiple datasets. A dataset can be
 general or associated with a particular entity in an application (like a saved game). Datasets are automatically
 created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs.








Class com.amazonaws.services.cognitosync.model.DescribeIdentityPoolUsageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.








Class com.amazonaws.services.cognitosync.model.DescribeIdentityPoolUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityPoolUsage
IdentityPoolUsage identityPoolUsage
Information about the usage of the identity pool.








Class com.amazonaws.services.cognitosync.model.DescribeIdentityUsageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


identityId
String identityId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.








Class com.amazonaws.services.cognitosync.model.DescribeIdentityUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityUsage
IdentityUsage identityUsage
Usage information for the identity.








Class com.amazonaws.services.cognitosync.model.DuplicateRequestException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.GetBulkPublishDetailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.








Class com.amazonaws.services.cognitosync.model.GetBulkPublishDetailsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


bulkPublishStartTime
Date bulkPublishStartTime
The date/time at which the last bulk publish was initiated.


bulkPublishCompleteTime
Date bulkPublishCompleteTime
If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.


bulkPublishStatus
String bulkPublishStatus
Status of the last bulk publish operation, valid values are:
 
 NOT_STARTED - No bulk publish has been requested for this identity pool
 
 
 IN_PROGRESS - Data is being published to the configured stream
 
 
 SUCCEEDED - All data for the identity pool has been published to the configured stream
 
 
 FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.
 


failureMessage
String failureMessage
If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.








Class com.amazonaws.services.cognitosync.model.GetCognitoEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 The Cognito Identity Pool ID for the request
 








Class com.amazonaws.services.cognitosync.model.GetCognitoEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


events
SdkInternalMap<K,V> events

 The Cognito Events returned from the GetCognitoEvents request
 








Class com.amazonaws.services.cognitosync.model.GetIdentityPoolConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This
 is the ID of the pool for which to return a configuration.
 








Class com.amazonaws.services.cognitosync.model.GetIdentityPoolConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
 


pushSync
PushSync pushSync

 Options to apply to this identity pool for push synchronization.
 


cognitoStreams
CognitoStreams cognitoStreams
Options to apply to this identity pool for Amazon Cognito streams.








Class com.amazonaws.services.cognitosync.model.IdentityPoolUsage extends Object implements Serializable


Serialized Fields


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


syncSessionsCount
Long syncSessionsCount
Number of sync sessions for the identity pool.


dataStorage
Long dataStorage
Data storage information for the identity pool.


lastModifiedDate
Date lastModifiedDate
Date on which the identity pool was last modified.








Class com.amazonaws.services.cognitosync.model.IdentityUsage extends Object implements Serializable


Serialized Fields


identityId
String identityId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


lastModifiedDate
Date lastModifiedDate
Date on which the identity was last modified.


datasetCount
Integer datasetCount
Number of datasets for the identity.


dataStorage
Long dataStorage
Total data storage for this identity.








Class com.amazonaws.services.cognitosync.model.InternalErrorException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.InvalidConfigurationException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.InvalidLambdaFunctionOutputException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.InvalidParameterException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.LambdaThrottledException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.LimitExceededException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.ListDatasetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


identityId
String identityId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


nextToken
String nextToken
A pagination token for obtaining the next page of results.


maxResults
Integer maxResults
The maximum number of results to be returned.








Class com.amazonaws.services.cognitosync.model.ListDatasetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasets
SdkInternalList<T> datasets
A set of datasets.


count
Integer count
Number of datasets returned.


nextToken
String nextToken
A pagination token for obtaining the next page of results.








Class com.amazonaws.services.cognitosync.model.ListIdentityPoolUsageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken
A pagination token for obtaining the next page of results.


maxResults
Integer maxResults
The maximum number of results to be returned.








Class com.amazonaws.services.cognitosync.model.ListIdentityPoolUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityPoolUsages
SdkInternalList<T> identityPoolUsages
Usage information for the identity pools.


maxResults
Integer maxResults
The maximum number of results to be returned.


count
Integer count
Total number of identities for the identity pool.


nextToken
String nextToken
A pagination token for obtaining the next page of results.








Class com.amazonaws.services.cognitosync.model.ListRecordsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


identityId
String identityId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


datasetName
String datasetName
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'
 (dot).


lastSyncCount
Long lastSyncCount
The last server sync count for this record.


nextToken
String nextToken
A pagination token for obtaining the next page of results.


maxResults
Integer maxResults
The maximum number of results to be returned.


syncSessionToken
String syncSessionToken
A token containing a session ID, identity ID, and expiration.








Class com.amazonaws.services.cognitosync.model.ListRecordsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


records
SdkInternalList<T> records
A list of all records.


nextToken
String nextToken
A pagination token for obtaining the next page of results.


count
Integer count
Total number of records.


datasetSyncCount
Long datasetSyncCount
Server sync count for this dataset.


lastModifiedBy
String lastModifiedBy
The user/device that made the last change to this record.


mergedDatasetNames
SdkInternalList<T> mergedDatasetNames
Names of merged datasets.


datasetExists
Boolean datasetExists
Indicates whether the dataset exists.


datasetDeletedAfterRequestedSyncCount
Boolean datasetDeletedAfterRequestedSyncCount
A boolean value specifying whether to delete the dataset locally.


syncSessionToken
String syncSessionToken
A token containing a session ID, identity ID, and expiration.








Class com.amazonaws.services.cognitosync.model.NotAuthorizedException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.PushSync extends Object implements Serializable


Serialized Fields


applicationArns
SdkInternalList<T> applicationArns

 List of SNS platform application ARNs that could be used by clients.
 


roleArn
String roleArn

 A role configured to allow Cognito to call SNS on behalf of the developer.
 








Class com.amazonaws.services.cognitosync.model.Record extends Object implements Serializable


Serialized Fields


key
String key
The key for the record.


value
String value
The value for the record.


syncCount
Long syncCount
The server sync count for this record.


lastModifiedDate
Date lastModifiedDate
The date on which the record was last modified.


lastModifiedBy
String lastModifiedBy
The user/device that made the last change to this record.


deviceLastModifiedDate
Date deviceLastModifiedDate
The last modified date of the client device.








Class com.amazonaws.services.cognitosync.model.RecordPatch extends Object implements Serializable


Serialized Fields


op
String op
An operation, either replace or remove.


key
String key
The key associated with the record patch.


value
String value
The value associated with the record patch.


syncCount
Long syncCount
Last known server sync count for this record. Set to 0 if unknown.


deviceLastModifiedDate
Date deviceLastModifiedDate
The last modified date of the client device.








Class com.amazonaws.services.cognitosync.model.RegisterDeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here,
 the ID of the pool that the identity belongs to.
 


identityId
String identityId

 The unique ID for this identity.
 


platform
String platform

 The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
 


token
String token

 The push token.
 








Class com.amazonaws.services.cognitosync.model.RegisterDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deviceId
String deviceId

 The unique ID generated for this device by Cognito.
 








Class com.amazonaws.services.cognitosync.model.ResourceConflictException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.ResourceNotFoundException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.SetCognitoEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 The Cognito Identity Pool to use when configuring Cognito Events
 


events
SdkInternalMap<K,V> events

 The events to configure
 








Class com.amazonaws.services.cognitosync.model.SetCognitoEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitosync.model.SetIdentityPoolConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This
 is the ID of the pool to modify.
 


pushSync
PushSync pushSync

 Options to apply to this identity pool for push synchronization.
 


cognitoStreams
CognitoStreams cognitoStreams
Options to apply to this identity pool for Amazon Cognito streams.








Class com.amazonaws.services.cognitosync.model.SetIdentityPoolConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
 


pushSync
PushSync pushSync

 Options to apply to this identity pool for push synchronization.
 


cognitoStreams
CognitoStreams cognitoStreams
Options to apply to this identity pool for Amazon Cognito streams.








Class com.amazonaws.services.cognitosync.model.SubscribeToDatasetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The
 ID of the pool to which the identity belongs.
 


identityId
String identityId

 Unique ID for this identity.
 


datasetName
String datasetName

 The name of the dataset to subcribe to.
 


deviceId
String deviceId

 The unique ID generated for this device by Cognito.
 








Class com.amazonaws.services.cognitosync.model.SubscribeToDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitosync.model.TooManyRequestsException extends AmazonCognitoSyncException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.cognitosync.model.UnsubscribeFromDatasetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId

 A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The
 ID of the pool to which this identity belongs.
 


identityId
String identityId

 Unique ID for this identity.
 


datasetName
String datasetName

 The name of the dataset from which to unsubcribe.
 


deviceId
String deviceId

 The unique ID generated for this device by Cognito.
 








Class com.amazonaws.services.cognitosync.model.UnsubscribeFromDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.cognitosync.model.UpdateRecordsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityPoolId
String identityPoolId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


identityId
String identityId
A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID
 generation is unique within a region.


datasetName
String datasetName
A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'
 (dot).


deviceId
String deviceId

 The unique ID generated for this device by Cognito.
 


recordPatches
SdkInternalList<T> recordPatches
A list of patch operations.


syncSessionToken
String syncSessionToken
The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.


clientContext
String clientContext
Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The
 ClientContext field is not yet implemented.








Class com.amazonaws.services.cognitosync.model.UpdateRecordsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


records
SdkInternalList<T> records
A list of records that have been updated.








Package com.amazonaws.services.comprehend.model




Class com.amazonaws.services.comprehend.model.AmazonComprehendException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageItemResult extends Object implements Serializable


Serialized Fields


index
Integer index

 The zero-based index of the document in the input list.
 


languages
List<E> languages

 One or more DominantLanguage objects describing the dominant languages in the document.
 








Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


textList
List<E> textList

 A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document
 should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.
 








Class com.amazonaws.services.comprehend.model.BatchDetectDominantLanguageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resultList
List<E> resultList

 A list of objects containing the results of the operation. The results are sorted in ascending order by the
 Index field and match the order of the documents in the input list. If all of the documents contain
 an error, the ResultList is empty.
 


errorList
List<E> errorList

 A list containing one object for each document that contained an error. The results are sorted in ascending order
 by the Index field and match the order of the documents in the input list. If there are no errors in
 the batch, the ErrorList is empty.
 








Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesItemResult extends Object implements Serializable


Serialized Fields


index
Integer index

 The zero-based index of the document in the input list.
 


entities
List<E> entities

 One or more Entity objects, one for each entity detected in the document.
 








Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


textList
List<E> textList

 A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document
 must contain fewer than 5,000 bytes of UTF-8 encoded characters.
 


languageCode
String languageCode

 The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend.
 All documents must be in the same language.
 








Class com.amazonaws.services.comprehend.model.BatchDetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resultList
List<E> resultList

 A list of objects containing the results of the operation. The results are sorted in ascending order by the
 Index field and match the order of the documents in the input list. If all of the documents contain
 an error, the ResultList is empty.
 


errorList
List<E> errorList

 A list containing one object for each document that contained an error. The results are sorted in ascending order
 by the Index field and match the order of the documents in the input list. If there are no errors in
 the batch, the ErrorList is empty.
 








Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesItemResult extends Object implements Serializable


Serialized Fields


index
Integer index

 The zero-based index of the document in the input list.
 


keyPhrases
List<E> keyPhrases

 One or more KeyPhrase objects, one for each key phrase detected in the document.
 








Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


textList
List<E> textList

 A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document
 must contain fewer that 5,000 bytes of UTF-8 encoded characters.
 


languageCode
String languageCode

 The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend.
 All documents must be in the same language.
 








Class com.amazonaws.services.comprehend.model.BatchDetectKeyPhrasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resultList
List<E> resultList

 A list of objects containing the results of the operation. The results are sorted in ascending order by the
 Index field and match the order of the documents in the input list. If all of the documents contain
 an error, the ResultList is empty.
 


errorList
List<E> errorList

 A list containing one object for each document that contained an error. The results are sorted in ascending order
 by the Index field and match the order of the documents in the input list. If there are no errors in
 the batch, the ErrorList is empty.
 








Class com.amazonaws.services.comprehend.model.BatchDetectSentimentItemResult extends Object implements Serializable


Serialized Fields


index
Integer index

 The zero-based index of the document in the input list.
 


sentiment
String sentiment

 The sentiment detected in the document.
 


sentimentScore
SentimentScore sentimentScore

 The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.
 








Class com.amazonaws.services.comprehend.model.BatchDetectSentimentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


textList
List<E> textList

 A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document
 must contain fewer that 5,000 bytes of UTF-8 encoded characters.
 


languageCode
String languageCode

 The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend.
 All documents must be in the same language.
 








Class com.amazonaws.services.comprehend.model.BatchDetectSentimentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resultList
List<E> resultList

 A list of objects containing the results of the operation. The results are sorted in ascending order by the
 Index field and match the order of the documents in the input list. If all of the documents contain
 an error, the ResultList is empty.
 


errorList
List<E> errorList

 A list containing one object for each document that contained an error. The results are sorted in ascending order
 by the Index field and match the order of the documents in the input list. If there are no errors in
 the batch, the ErrorList is empty.
 








Class com.amazonaws.services.comprehend.model.BatchDetectSyntaxItemResult extends Object implements Serializable


Serialized Fields


index
Integer index

 The zero-based index of the document in the input list.
 


syntaxTokens
List<E> syntaxTokens

 The syntax tokens for the words in the document, one token for each word.
 








Class com.amazonaws.services.comprehend.model.BatchDetectSyntaxRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


textList
List<E> textList

 A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document
 must contain fewer that 5,000 bytes of UTF-8 encoded characters.
 


languageCode
String languageCode

 The language of the input documents. You can specify any of the following languages supported by Amazon
 Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").
 All documents must be in the same language.
 








Class com.amazonaws.services.comprehend.model.BatchDetectSyntaxResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resultList
List<E> resultList

 A list of objects containing the results of the operation. The results are sorted in ascending order by the
 Index field and match the order of the documents in the input list. If all of the documents contain
 an error, the ResultList is empty.
 


errorList
List<E> errorList

 A list containing one object for each document that contained an error. The results are sorted in ascending order
 by the Index field and match the order of the documents in the input list. If there are no errors in
 the batch, the ErrorList is empty.
 








Class com.amazonaws.services.comprehend.model.BatchItemError extends Object implements Serializable


Serialized Fields


index
Integer index

 The zero-based index of the document in the input list.
 


errorCode
String errorCode

 The numeric error code of the error.
 


errorMessage
String errorMessage

 A text description of the error.
 








Class com.amazonaws.services.comprehend.model.BatchSizeLimitExceededException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.ClassifierEvaluationMetrics extends Object implements Serializable


Serialized Fields


accuracy
Double accuracy

 The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the
 test documents that were correctly recognized by the total number of labels in the test documents.
 


precision
Double precision

 A measure of the usefulness of the classifier results in the test data. High precision means that the classifier
 returned substantially more relevant results than irrelevant ones.
 


recall
Double recall

 A measure of how complete the classifier results are for the test data. High recall means that the classifier
 returned most of the relevant results.
 


f1Score
Double f1Score

 A measure of how accurate the classifier results are for the test data. It is derived from the
 Precision and Recall values. The F1Score is the harmonic average of the
 two scores. The highest score is 1, and the worst score is 0.
 


microPrecision
Double microPrecision

 A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer
 returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from
 averaging the precision of all available labels, this is based on the overall score of all precision scores added
 together.
 


microRecall
Double microRecall

 A measure of how complete the classifier results are for the test data. High recall means that the classifier
 returned most of the relevant results. Specifically, this indicates how many of the correct categories in the
 text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of
 averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all
 recall scores added together.
 


microF1Score
Double microF1Score

 A measure of how accurate the classifier results are for the test data. It is a combination of the
 Micro Precision and Micro Recall values. The Micro F1Score is the harmonic
 mean of the two scores. The highest score is 1, and the worst score is 0.
 


hammingLoss
Double hammingLoss

 Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels
 compared to the total number of labels. Scores closer to zero are better.
 








Class com.amazonaws.services.comprehend.model.ClassifierMetadata extends Object implements Serializable


Serialized Fields


numberOfLabels
Integer numberOfLabels

 The number of labels in the input data.
 


numberOfTrainedDocuments
Integer numberOfTrainedDocuments

 The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90
 percent of the input documents.
 


numberOfTestDocuments
Integer numberOfTestDocuments

 The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20
 percent of the input documents.
 


evaluationMetrics
ClassifierEvaluationMetrics evaluationMetrics

 Describes the result metrics for the test data associated with an documentation classifier.
 








Class com.amazonaws.services.comprehend.model.ClassifyDocumentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


text
String text

 The document text to be analyzed.
 


endpointArn
String endpointArn

 The Amazon Resource Number (ARN) of the endpoint.
 








Class com.amazonaws.services.comprehend.model.ClassifyDocumentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


classes
List<E> classes

 The classes used by the document being analyzed. These are used for multi-class trained models. Individual
 classes are mutually exclusive and each document is expected to have only a single class assigned to it. For
 example, an animal can be a dog or a cat, but not both at the same time.
 


labels
List<E> labels

 The labels used the document being analyzed. These are used for multi-label trained models. Individual labels
 represent different categories that are related in some manner and are not multually exclusive. For example, a
 movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at
 the same time.
 








Class com.amazonaws.services.comprehend.model.ConcurrentModificationException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.CreateDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


documentClassifierName
String documentClassifierName

 The name of the document classifier.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read
 access to your input data.
 


tags
List<E> tags

 Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a
 metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a
 resource to indicate its use by the sales department.
 


inputDataConfig
DocumentClassifierInputDataConfig inputDataConfig

 Specifies the format and location of the input data for the job.
 


outputDataConfig
DocumentClassifierOutputDataConfig outputDataConfig

 Enables the addition of output results configuration parameters for custom classifier jobs.
 


clientRequestToken
String clientRequestToken

 A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
 


languageCode
String languageCode

 The language of the input documents. You can specify any of the following languages supported by Amazon
 Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").
 All documents must be in the same language.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are
 using for your custom classifier. For more information, see Amazon VPC.
 


mode
String mode

 Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class mode,
 which identifies one and only one class for each document, or multi-label mode, which identifies one or more
 labels for each document. In multi-label mode, multiple labels for an individual document are separated by a
 delimiter. The default delimiter between labels is a pipe (|).
 








Class com.amazonaws.services.comprehend.model.CreateDocumentClassifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


documentClassifierArn
String documentClassifierArn

 The Amazon Resource Name (ARN) that identifies the document classifier.
 








Class com.amazonaws.services.comprehend.model.CreateEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointName
String endpointName

 This is the descriptive suffix that becomes part of the EndpointArn used for all subsequent requests
 to this resource.
 


modelArn
String modelArn

 The Amazon Resource Number (ARN) of the model to which the endpoint will be attached.
 


desiredInferenceUnits
Integer desiredInferenceUnits

 The desired number of inference units to be used by the model using this endpoint. Each inference unit represents
 of a throughput of 100 characters per second.
 


clientRequestToken
String clientRequestToken

 An idempotency token provided by the customer. If this token matches a previous endpoint creation request, Amazon
 Comprehend will not return a ResourceInUseException.
 


tags
List<E> tags

 Tags associated with the endpoint being created. A tag is a key-value pair that adds metadata to the endpoint.
 For example, a tag with "Sales" as the key might be added to an endpoint to indicate its use by the sales
 department.
 








Class com.amazonaws.services.comprehend.model.CreateEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpointArn
String endpointArn

 The Amazon Resource Number (ARN) of the endpoint being created.
 








Class com.amazonaws.services.comprehend.model.CreateEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


recognizerName
String recognizerName

 The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric
 characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read
 access to your input data.
 


tags
List<E> tags

 Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata
 to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource
 to indicate its use by the sales department.
 


inputDataConfig
EntityRecognizerInputDataConfig inputDataConfig

 Specifies the format and location of the input data. The S3 bucket containing the input data must be located in
 the same region as the entity recognizer being created.
 


clientRequestToken
String clientRequestToken

 A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
 


languageCode
String languageCode

 The language of the input documents. All documents must be in the same language. Only English ("en") is currently
 supported.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are
 using for your custom entity recognizer. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.CreateEntityRecognizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entityRecognizerArn
String entityRecognizerArn

 The Amazon Resource Name (ARN) that identifies the entity recognizer.
 








Class com.amazonaws.services.comprehend.model.DeleteDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


documentClassifierArn
String documentClassifierArn

 The Amazon Resource Name (ARN) that identifies the document classifier.
 








Class com.amazonaws.services.comprehend.model.DeleteDocumentClassifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.comprehend.model.DeleteEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointArn
String endpointArn

 The Amazon Resource Number (ARN) of the endpoint being deleted.
 








Class com.amazonaws.services.comprehend.model.DeleteEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.comprehend.model.DeleteEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


entityRecognizerArn
String entityRecognizerArn

 The Amazon Resource Name (ARN) that identifies the entity recognizer.
 








Class com.amazonaws.services.comprehend.model.DeleteEntityRecognizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.comprehend.model.DescribeDocumentClassificationJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its
 response.
 








Class com.amazonaws.services.comprehend.model.DescribeDocumentClassificationJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


documentClassificationJobProperties
DocumentClassificationJobProperties documentClassificationJobProperties

 An object that describes the properties associated with the document classification job.
 








Class com.amazonaws.services.comprehend.model.DescribeDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


documentClassifierArn
String documentClassifierArn

 The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in
 its response.
 








Class com.amazonaws.services.comprehend.model.DescribeDocumentClassifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


documentClassifierProperties
DocumentClassifierProperties documentClassifierProperties

 An object that contains the properties associated with a document classifier.
 








Class com.amazonaws.services.comprehend.model.DescribeDominantLanguageDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its
 response.
 








Class com.amazonaws.services.comprehend.model.DescribeDominantLanguageDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dominantLanguageDetectionJobProperties
DominantLanguageDetectionJobProperties dominantLanguageDetectionJobProperties

 An object that contains the properties associated with a dominant language detection job.
 








Class com.amazonaws.services.comprehend.model.DescribeEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointArn
String endpointArn

 The Amazon Resource Number (ARN) of the endpoint being described.
 








Class com.amazonaws.services.comprehend.model.DescribeEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpointProperties
EndpointProperties endpointProperties

 Describes information associated with the specific endpoint.
 








Class com.amazonaws.services.comprehend.model.DescribeEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its
 response.
 








Class com.amazonaws.services.comprehend.model.DescribeEntitiesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entitiesDetectionJobProperties
EntitiesDetectionJobProperties entitiesDetectionJobProperties

 An object that contains the properties associated with an entities detection job.
 








Class com.amazonaws.services.comprehend.model.DescribeEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


entityRecognizerArn
String entityRecognizerArn

 The Amazon Resource Name (ARN) that identifies the entity recognizer.
 








Class com.amazonaws.services.comprehend.model.DescribeEntityRecognizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entityRecognizerProperties
EntityRecognizerProperties entityRecognizerProperties

 Describes information associated with an entity recognizer.
 








Class com.amazonaws.services.comprehend.model.DescribeKeyPhrasesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its
 response.
 








Class com.amazonaws.services.comprehend.model.DescribeKeyPhrasesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyPhrasesDetectionJobProperties
KeyPhrasesDetectionJobProperties keyPhrasesDetectionJobProperties

 An object that contains the properties associated with a key phrases detection job.
 








Class com.amazonaws.services.comprehend.model.DescribeSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its
 response.
 








Class com.amazonaws.services.comprehend.model.DescribeSentimentDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sentimentDetectionJobProperties
SentimentDetectionJobProperties sentimentDetectionJobProperties

 An object that contains the properties associated with a sentiment detection job.
 








Class com.amazonaws.services.comprehend.model.DescribeTopicsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier assigned by the user to the detection job.
 








Class com.amazonaws.services.comprehend.model.DescribeTopicsDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


topicsDetectionJobProperties
TopicsDetectionJobProperties topicsDetectionJobProperties

 The list of properties for the requested job.
 








Class com.amazonaws.services.comprehend.model.DetectDominantLanguageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


text
String text

 A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of
 UTF-8 encoded characters.
 








Class com.amazonaws.services.comprehend.model.DetectDominantLanguageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


languages
List<E> languages

 The languages that Amazon Comprehend detected in the input text. For each language, the response returns the RFC
 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For
 more information about RFC 5646, see Tags for Identifying
 Languages on the IETF Tools web site.
 








Class com.amazonaws.services.comprehend.model.DetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


text
String text

 A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
 


languageCode
String languageCode

 The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend.
 All documents must be in the same language.
 








Class com.amazonaws.services.comprehend.model.DetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entities
List<E> entities

 A collection of entities identified in the input text. For each entity, the response provides the entity text,
 entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the
 detection. For a list of entity types, see how-entities.
 








Class com.amazonaws.services.comprehend.model.DetectKeyPhrasesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


text
String text

 A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
 


languageCode
String languageCode

 The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend.
 All documents must be in the same language.
 








Class com.amazonaws.services.comprehend.model.DetectKeyPhrasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyPhrases
List<E> keyPhrases

 A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the
 response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence
 that Amazon Comprehend has in the accuracy of the detection.
 








Class com.amazonaws.services.comprehend.model.DetectSentimentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


text
String text

 A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.
 


languageCode
String languageCode

 The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend.
 All documents must be in the same language.
 








Class com.amazonaws.services.comprehend.model.DetectSentimentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sentiment
String sentiment

 The inferred sentiment that Amazon Comprehend has the highest level of confidence in.
 


sentimentScore
SentimentScore sentimentScore

 An object that lists the sentiments, and their corresponding confidence levels.
 








Class com.amazonaws.services.comprehend.model.DetectSyntaxRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


text
String text

 A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.
 


languageCode
String languageCode

 The language code of the input documents. You can specify any of the following languages supported by Amazon
 Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt").
 








Class com.amazonaws.services.comprehend.model.DetectSyntaxResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


syntaxTokens
List<E> syntaxTokens

 A collection of syntax tokens describing the text. For each token, the response provides the text, the token
 type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is
 correct. For a list of token types, see how-syntax.
 








Class com.amazonaws.services.comprehend.model.DocumentClass extends Object implements Serializable


Serialized Fields


name
String name

 The name of the class.
 


score
Float score

 The confidence score that Amazon Comprehend has this class correctly attributed.
 








Class com.amazonaws.services.comprehend.model.DocumentClassificationJobFilter extends Object implements Serializable


Serialized Fields


jobName
String jobName

 Filters on the name of the job.
 


jobStatus
String jobStatus

 Filters the list based on job status. Returns only jobs with the specified status.
 


submitTimeBefore
Date submitTimeBefore

 Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted
 after the specified time. Jobs are returned in ascending order, oldest to newest.
 


submitTimeAfter
Date submitTimeAfter

 Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted
 before the specified time. Jobs are returned in descending order, newest to oldest.
 








Class com.amazonaws.services.comprehend.model.DocumentClassificationJobProperties extends Object implements Serializable


Serialized Fields


jobId
String jobId

 The identifier assigned to the document classification job.
 


jobName
String jobName

 The name that you assigned to the document classification job.
 


jobStatus
String jobStatus

 The current status of the document classification job. If the status is FAILED, the
 Message field shows the reason for the failure.
 


message
String message

 A description of the status of the job.
 


submitTime
Date submitTime

 The time that the document classification job was submitted for processing.
 


endTime
Date endTime

 The time that the document classification job completed.
 


documentClassifierArn
String documentClassifierArn

 The Amazon Resource Name (ARN) that identifies the document classifier.
 


inputDataConfig
InputDataConfig inputDataConfig

 The input data configuration that you supplied when you created the document classification job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 The output data configuration that you supplied when you created the document classification job.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend
 read access to your input data.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for
 your document classification job. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.DocumentClassifierFilter extends Object implements Serializable


Serialized Fields


status
String status

 Filters the list of classifiers based on status.
 


submitTimeBefore
Date submitTimeBefore

 Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only
 classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.
 


submitTimeAfter
Date submitTimeAfter

 Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only
 classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.
 








Class com.amazonaws.services.comprehend.model.DocumentClassifierInputDataConfig extends Object implements Serializable


Serialized Fields


s3Uri
String s3Uri

 The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are
 calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.
 
 
 For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon
 Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of
 them as input.
 


labelDelimiter
String labelDelimiter

 Indicates the delimiter used to separate each label for training a multi-label classifier. The default delimiter
 between labels is a pipe (|). You can use a different character as a delimiter (if it's an allowed character) by
 specifying it under Delimiter for labels. If the training documents use a delimiter other than the default or the
 delimiter you specify, the labels on that line will be combined to make a single unique label, such as
 LABELLABELLABEL.
 








Class com.amazonaws.services.comprehend.model.DocumentClassifierOutputDataConfig extends Object implements Serializable


Serialized Fields


s3Uri
String s3Uri

 When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon
 S3 location where you want to write the confusion matrix. The URI must be in the same region as the API endpoint
 that you are calling. The location is used as the prefix for the actual location of this output file.
 
 
 When the custom classifier job is finished, the service creates the output file in a directory specific to the
 job. The S3Uri field contains the location of the output file, called output.tar.gz. It
 is a compressed archive that contains the confusion matrix.
 


kmsKeyId
String kmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an
 analysis job. The KmsKeyId can be one of the following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 KMS Key Alias: "alias/ExampleAlias"
 
 
 
 
 ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
 
 
 








Class com.amazonaws.services.comprehend.model.DocumentClassifierProperties extends Object implements Serializable


Serialized Fields


documentClassifierArn
String documentClassifierArn

 The Amazon Resource Name (ARN) that identifies the document classifier.
 


languageCode
String languageCode

 The language code for the language of the documents that the classifier was trained on.
 


status
String status

 The status of the document classifier. If the status is TRAINED the classifier is ready to use. If
 the status is FAILED you can see additional information about why the classifier wasn't trained in
 the Message field.
 


message
String message

 Additional information about the status of the classifier.
 


submitTime
Date submitTime

 The time that the document classifier was submitted for training.
 


endTime
Date endTime

 The time that training the document classifier completed.
 


trainingStartTime
Date trainingStartTime

 Indicates the time when the training starts on documentation classifiers. You are billed for the time interval
 between this time and the value of TrainingEndTime.
 


trainingEndTime
Date trainingEndTime

 The time that training of the document classifier was completed. Indicates the time when the training completes
 on documentation classifiers. You are billed for the time interval between this time and the value of
 TrainingStartTime.
 


inputDataConfig
DocumentClassifierInputDataConfig inputDataConfig

 The input data configuration that you supplied when you created the document classifier for training.
 


outputDataConfig
DocumentClassifierOutputDataConfig outputDataConfig

 Provides output results configuration parameters for custom classifier jobs.
 


classifierMetadata
ClassifierMetadata classifierMetadata

 Information about the document classifier, including the number of documents used for training the classifier,
 the number of documents used for test the classifier, and an accuracy rating.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read
 access to your input data.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for
 your custom classifier. For more information, see Amazon VPC.
 


mode
String mode

 Indicates the mode in which the specific classifier was trained. This also indicates the format of input
 documents and the format of the confusion matrix. Each classifier can only be trained in one mode and this cannot
 be changed once the classifier is trained.
 








Class com.amazonaws.services.comprehend.model.DocumentLabel extends Object implements Serializable


Serialized Fields


name
String name

 The name of the label.
 


score
Float score

 The confidence score that Amazon Comprehend has this label correctly attributed.
 








Class com.amazonaws.services.comprehend.model.DominantLanguage extends Object implements Serializable


Serialized Fields


languageCode
String languageCode

 The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.
 


score
Float score

 The level of confidence that Amazon Comprehend has in the accuracy of the detection.
 








Class com.amazonaws.services.comprehend.model.DominantLanguageDetectionJobFilter extends Object implements Serializable


Serialized Fields


jobName
String jobName

 Filters on the name of the job.
 


jobStatus
String jobStatus

 Filters the list of jobs based on job status. Returns only jobs with the specified status.
 


submitTimeBefore
Date submitTimeBefore

 Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted
 before the specified time. Jobs are returned in ascending order, oldest to newest.
 


submitTimeAfter
Date submitTimeAfter

 Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted
 after the specified time. Jobs are returned in descending order, newest to oldest.
 








Class com.amazonaws.services.comprehend.model.DominantLanguageDetectionJobProperties extends Object implements Serializable


Serialized Fields


jobId
String jobId

 The identifier assigned to the dominant language detection job.
 


jobName
String jobName

 The name that you assigned to the dominant language detection job.
 


jobStatus
String jobStatus

 The current status of the dominant language detection job. If the status is FAILED, the
 Message field shows the reason for the failure.
 


message
String message

 A description for the status of a job.
 


submitTime
Date submitTime

 The time that the dominant language detection job was submitted for processing.
 


endTime
Date endTime

 The time that the dominant language detection job completed.
 


inputDataConfig
InputDataConfig inputDataConfig

 The input data configuration that you supplied when you created the dominant language detection job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 The output data configuration that you supplied when you created the dominant language detection job.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for
 your dominant language detection job. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.EndpointFilter extends Object implements Serializable


Serialized Fields


modelArn
String modelArn

 The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
 


status
String status

 Specifies the status of the endpoint being returned. Possible values are: Creating, Ready, Updating, Deleting,
 Failed.
 


creationTimeBefore
Date creationTimeBefore

 Specifies a date before which the returned endpoint or endpoints were created.
 


creationTimeAfter
Date creationTimeAfter

 Specifies a date after which the returned endpoint or endpoints were created.
 








Class com.amazonaws.services.comprehend.model.EndpointProperties extends Object implements Serializable


Serialized Fields


endpointArn
String endpointArn

 The Amazon Resource Number (ARN) of the endpoint.
 


status
String status

 Specifies the status of the endpoint. Because the endpoint updates and creation are asynchronous, so customers
 will need to wait for the endpoint to be Ready status before making inference requests.
 


message
String message

 Specifies a reason for failure in cases of Failed status.
 


modelArn
String modelArn

 The Amazon Resource Number (ARN) of the model to which the endpoint is attached.
 


desiredInferenceUnits
Integer desiredInferenceUnits

 The desired number of inference units to be used by the model using this endpoint. Each inference unit represents
 of a throughput of 100 characters per second.
 


currentInferenceUnits
Integer currentInferenceUnits

 The number of inference units currently used by the model using this endpoint.
 


creationTime
Date creationTime

 The creation date and time of the endpoint.
 


lastModifiedTime
Date lastModifiedTime

 The date and time that the endpoint was last modified.
 








Class com.amazonaws.services.comprehend.model.EntitiesDetectionJobFilter extends Object implements Serializable


Serialized Fields


jobName
String jobName

 Filters on the name of the job.
 


jobStatus
String jobStatus

 Filters the list of jobs based on job status. Returns only jobs with the specified status.
 


submitTimeBefore
Date submitTimeBefore

 Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted
 before the specified time. Jobs are returned in ascending order, oldest to newest.
 


submitTimeAfter
Date submitTimeAfter

 Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted
 after the specified time. Jobs are returned in descending order, newest to oldest.
 








Class com.amazonaws.services.comprehend.model.EntitiesDetectionJobProperties extends Object implements Serializable


Serialized Fields


jobId
String jobId

 The identifier assigned to the entities detection job.
 


jobName
String jobName

 The name that you assigned the entities detection job.
 


jobStatus
String jobStatus

 The current status of the entities detection job. If the status is FAILED, the Message
 field shows the reason for the failure.
 


message
String message

 A description of the status of a job.
 


submitTime
Date submitTime

 The time that the entities detection job was submitted for processing.
 


endTime
Date endTime

 The time that the entities detection job completed
 


entityRecognizerArn
String entityRecognizerArn

 The Amazon Resource Name (ARN) that identifies the entity recognizer.
 


inputDataConfig
InputDataConfig inputDataConfig

 The input data configuration that you supplied when you created the entities detection job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 The output data configuration that you supplied when you created the entities detection job.
 


languageCode
String languageCode

 The language code of the input documents.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for
 your entity detection job. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.Entity extends Object implements Serializable


Serialized Fields


score
Float score

 The level of confidence that Amazon Comprehend has in the accuracy of the detection.
 


type
String type

 The entity's type.
 


text
String text

 The text of the entity.
 


beginOffset
Integer beginOffset

 A character offset in the input text that shows where the entity begins (the first character is at position 0).
 The offset returns the position of each UTF-8 code point in the string. A code point is the abstract
 character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single
 code point.
 


endOffset
Integer endOffset

 A character offset in the input text that shows where the entity ends. The offset returns the position of each
 UTF-8 code point in the string. A code point is the abstract character from a particular graphical
 representation. For example, a multi-byte UTF-8 character maps to a single code point.
 








Class com.amazonaws.services.comprehend.model.EntityRecognizerAnnotations extends Object implements Serializable


Serialized Fields


s3Uri
String s3Uri

 Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in
 the same region as the API endpoint that you are calling.
 








Class com.amazonaws.services.comprehend.model.EntityRecognizerDocuments extends Object implements Serializable


Serialized Fields


s3Uri
String s3Uri

 Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must
 be in the same region as the API endpoint that you are calling.
 








Class com.amazonaws.services.comprehend.model.EntityRecognizerEntityList extends Object implements Serializable


Serialized Fields


s3Uri
String s3Uri

 Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API
 endpoint that you are calling.
 








Class com.amazonaws.services.comprehend.model.EntityRecognizerEvaluationMetrics extends Object implements Serializable


Serialized Fields


precision
Double precision

 A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer
 returned substantially more relevant results than irrelevant ones.
 


recall
Double recall

 A measure of how complete the recognizer results are for the test data. High recall means that the recognizer
 returned most of the relevant results.
 


f1Score
Double f1Score

 A measure of how accurate the recognizer results are for the test data. It is derived from the
 Precision and Recall values. The F1Score is the harmonic average of the
 two scores. The highest score is 1, and the worst score is 0.
 








Class com.amazonaws.services.comprehend.model.EntityRecognizerFilter extends Object implements Serializable


Serialized Fields


status
String status

 The status of an entity recognizer.
 


submitTimeBefore
Date submitTimeBefore

 Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs
 submitted before the specified time. Jobs are returned in descending order, newest to oldest.
 


submitTimeAfter
Date submitTimeAfter

 Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs
 submitted after the specified time. Jobs are returned in ascending order, oldest to newest.
 








Class com.amazonaws.services.comprehend.model.EntityRecognizerInputDataConfig extends Object implements Serializable


Serialized Fields


entityTypes
List<E> entityTypes

 The entity types in the input data for an entity recognizer. A maximum of 12 entity types can be used at one time
 to train an entity recognizer.
 


documents
EntityRecognizerDocuments documents

 S3 location of the documents folder for an entity recognizer
 


annotations
EntityRecognizerAnnotations annotations

 S3 location of the annotations file for an entity recognizer.
 


entityList
EntityRecognizerEntityList entityList

 S3 location of the entity list for an entity recognizer.
 








Class com.amazonaws.services.comprehend.model.EntityRecognizerMetadata extends Object implements Serializable


Serialized Fields


numberOfTrainedDocuments
Integer numberOfTrainedDocuments

 The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to
 90 percent of the input documents.
 


numberOfTestDocuments
Integer numberOfTestDocuments

 The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to
 20 percent of the input documents.
 


evaluationMetrics
EntityRecognizerEvaluationMetrics evaluationMetrics

 Detailed information about the accuracy of an entity recognizer.
 


entityTypes
List<E> entityTypes

 Entity types from the metadata of an entity recognizer.
 








Class com.amazonaws.services.comprehend.model.EntityRecognizerMetadataEntityTypesListItem extends Object implements Serializable


Serialized Fields


type
String type

 Type of entity from the list of entity types in the metadata of an entity recognizer.
 


evaluationMetrics
EntityTypesEvaluationMetrics evaluationMetrics

 Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.
 


numberOfTrainMentions
Integer numberOfTrainMentions

 Indicates the number of times the given entity type was seen in the training data.
 








Class com.amazonaws.services.comprehend.model.EntityRecognizerProperties extends Object implements Serializable


Serialized Fields


entityRecognizerArn
String entityRecognizerArn

 The Amazon Resource Name (ARN) that identifies the entity recognizer.
 


languageCode
String languageCode

 The language of the input documents. All documents must be in the same language. Only English ("en") is currently
 supported.
 


status
String status

 Provides the status of the entity recognizer.
 


message
String message

 A description of the status of the recognizer.
 


submitTime
Date submitTime

 The time that the recognizer was submitted for processing.
 


endTime
Date endTime

 The time that the recognizer creation completed.
 


trainingStartTime
Date trainingStartTime

 The time that training of the entity recognizer started.
 


trainingEndTime
Date trainingEndTime

 The time that training of the entity recognizer was completed.
 


inputDataConfig
EntityRecognizerInputDataConfig inputDataConfig

 The input data properties of an entity recognizer.
 


recognizerMetadata
EntityRecognizerMetadata recognizerMetadata

 Provides information about an entity recognizer.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read
 access to your input data.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for
 your custom entity recognizer. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.EntityTypesEvaluationMetrics extends Object implements Serializable


Serialized Fields


precision
Double precision

 A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision
 means that the recognizer returned substantially more relevant results than irrelevant ones.
 


recall
Double recall

 A measure of how complete the recognizer results are for a specific entity type in the test data. High recall
 means that the recognizer returned most of the relevant results.
 


f1Score
Double f1Score

 A measure of how accurate the recognizer results are for for a specific entity type in the test data. It is
 derived from the Precision and Recall values. The F1Score is the harmonic
 average of the two scores. The highest score is 1, and the worst score is 0.
 








Class com.amazonaws.services.comprehend.model.EntityTypesListItem extends Object implements Serializable


Serialized Fields


type
String type

 Entity type of an item on an entity type list.
 








Class com.amazonaws.services.comprehend.model.InputDataConfig extends Object implements Serializable


Serialized Fields


s3Uri
String s3Uri

 The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling.
 The URI can point to a single input file or it can provide the prefix for a collection of data files.
 
 
 For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon
 Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of
 them as input.
 


inputFormat
String inputFormat

 Specifies how the text in an input file should be processed:
 
 
 
 
 ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are
 processing large documents, such as newspaper articles or scientific papers.
 
 
 
 
 ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you
 are processing many short documents, such as text messages.
 
 
 








Class com.amazonaws.services.comprehend.model.InternalServerException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.InvalidFilterException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.InvalidRequestException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.JobNotFoundException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.KeyPhrase extends Object implements Serializable


Serialized Fields


score
Float score

 The level of confidence that Amazon Comprehend has in the accuracy of the detection.
 


text
String text

 The text of a key noun phrase.
 


beginOffset
Integer beginOffset

 A character offset in the input text that shows where the key phrase begins (the first character is at position
 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract
 character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single
 code point.
 


endOffset
Integer endOffset

 A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8
 code point in the string. A code point is the abstract character from a particular graphical
 representation. For example, a multi-byte UTF-8 character maps to a single code point.
 








Class com.amazonaws.services.comprehend.model.KeyPhrasesDetectionJobFilter extends Object implements Serializable


Serialized Fields


jobName
String jobName

 Filters on the name of the job.
 


jobStatus
String jobStatus

 Filters the list of jobs based on job status. Returns only jobs with the specified status.
 


submitTimeBefore
Date submitTimeBefore

 Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted
 before the specified time. Jobs are returned in ascending order, oldest to newest.
 


submitTimeAfter
Date submitTimeAfter

 Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted
 after the specified time. Jobs are returned in descending order, newest to oldest.
 








Class com.amazonaws.services.comprehend.model.KeyPhrasesDetectionJobProperties extends Object implements Serializable


Serialized Fields


jobId
String jobId

 The identifier assigned to the key phrases detection job.
 


jobName
String jobName

 The name that you assigned the key phrases detection job.
 


jobStatus
String jobStatus

 The current status of the key phrases detection job. If the status is FAILED, the
 Message field shows the reason for the failure.
 


message
String message

 A description of the status of a job.
 


submitTime
Date submitTime

 The time that the key phrases detection job was submitted for processing.
 


endTime
Date endTime

 The time that the key phrases detection job completed.
 


inputDataConfig
InputDataConfig inputDataConfig

 The input data configuration that you supplied when you created the key phrases detection job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 The output data configuration that you supplied when you created the key phrases detection job.
 


languageCode
String languageCode

 The language code of the input documents.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for
 your key phrases detection job. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.KmsKeyValidationException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.ListDocumentClassificationJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
DocumentClassificationJobFilter filter

 Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they
 were submitted. You can only set one filter at a time.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 


maxResults
Integer maxResults

 The maximum number of results to return in each page. The default is 100.
 








Class com.amazonaws.services.comprehend.model.ListDocumentClassificationJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


documentClassificationJobPropertiesList
List<E> documentClassificationJobPropertiesList

 A list containing the properties of each job returned.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 








Class com.amazonaws.services.comprehend.model.ListDocumentClassifiersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
DocumentClassifierFilter filter

 Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they
 were submitted. You can only set one filter at a time.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 


maxResults
Integer maxResults

 The maximum number of results to return in each page. The default is 100.
 








Class com.amazonaws.services.comprehend.model.ListDocumentClassifiersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


documentClassifierPropertiesList
List<E> documentClassifierPropertiesList

 A list containing the properties of each job returned.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 








Class com.amazonaws.services.comprehend.model.ListDominantLanguageDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
DominantLanguageDetectionJobFilter filter

 Filters that jobs that are returned. You can filter jobs on their name, status, or the date and time that they
 were submitted. You can only set one filter at a time.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 


maxResults
Integer maxResults

 The maximum number of results to return in each page. The default is 100.
 








Class com.amazonaws.services.comprehend.model.ListDominantLanguageDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dominantLanguageDetectionJobPropertiesList
List<E> dominantLanguageDetectionJobPropertiesList

 A list containing the properties of each job that is returned.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 








Class com.amazonaws.services.comprehend.model.ListEndpointsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
EndpointFilter filter

 Filters the endpoints that are returned. You can filter endpoints on their name, model, status, or the date and
 time that they were created. You can only set one filter at a time.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 


maxResults
Integer maxResults

 The maximum number of results to return in each page. The default is 100.
 








Class com.amazonaws.services.comprehend.model.ListEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpointPropertiesList
List<E> endpointPropertiesList

 Displays a list of endpoint properties being retrieved by the service in response to the request.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 








Class com.amazonaws.services.comprehend.model.ListEntitiesDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
EntitiesDetectionJobFilter filter

 Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they
 were submitted. You can only set one filter at a time.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 


maxResults
Integer maxResults

 The maximum number of results to return in each page. The default is 100.
 








Class com.amazonaws.services.comprehend.model.ListEntitiesDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entitiesDetectionJobPropertiesList
List<E> entitiesDetectionJobPropertiesList

 A list containing the properties of each job that is returned.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 








Class com.amazonaws.services.comprehend.model.ListEntityRecognizersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
EntityRecognizerFilter filter

 Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or
 SubmitTimeAfter. You can only set one filter at a time.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 


maxResults
Integer maxResults

 The maximum number of results to return on each page. The default is 100.
 








Class com.amazonaws.services.comprehend.model.ListEntityRecognizersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entityRecognizerPropertiesList
List<E> entityRecognizerPropertiesList

 The list of properties of an entity recognizer.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 








Class com.amazonaws.services.comprehend.model.ListKeyPhrasesDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
KeyPhrasesDetectionJobFilter filter

 Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they
 were submitted. You can only set one filter at a time.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 


maxResults
Integer maxResults

 The maximum number of results to return in each page. The default is 100.
 








Class com.amazonaws.services.comprehend.model.ListKeyPhrasesDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyPhrasesDetectionJobPropertiesList
List<E> keyPhrasesDetectionJobPropertiesList

 A list containing the properties of each job that is returned.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 








Class com.amazonaws.services.comprehend.model.ListSentimentDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
SentimentDetectionJobFilter filter

 Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they
 were submitted. You can only set one filter at a time.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 


maxResults
Integer maxResults

 The maximum number of results to return in each page. The default is 100.
 








Class com.amazonaws.services.comprehend.model.ListSentimentDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sentimentDetectionJobPropertiesList
List<E> sentimentDetectionJobPropertiesList

 A list containing the properties of each job that is returned.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.
 








Class com.amazonaws.services.comprehend.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.
 


tags
List<E> tags

 Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value pair that adds as a
 metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a
 resource to indicate its use by the sales department.
 








Class com.amazonaws.services.comprehend.model.ListTopicsDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
TopicsDetectionJobFilter filter

 Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they
 were submitted. You can set only one filter at a time.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 


maxResults
Integer maxResults

 The maximum number of results to return in each page. The default is 100.
 








Class com.amazonaws.services.comprehend.model.ListTopicsDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


topicsDetectionJobPropertiesList
List<E> topicsDetectionJobPropertiesList

 A list containing the properties of each job that is returned.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 








Class com.amazonaws.services.comprehend.model.OutputDataConfig extends Object implements Serializable


Serialized Fields


s3Uri
String s3Uri

 When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3
 location where you want to write the output data. The URI must be in the same region as the API endpoint that you
 are calling. The location is used as the prefix for the actual location of the output file.
 
 
 When the topic detection job is finished, the service creates an output file in a directory specific to the job.
 The S3Uri field contains the location of the output file, called output.tar.gz. It is a
 compressed archive that contains the ouput of the operation.
 


kmsKeyId
String kmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an
 analysis job. The KmsKeyId can be one of the following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 KMS Key Alias: "alias/ExampleAlias"
 
 
 
 
 ARN of a KMS Key Alias: "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"
 
 
 








Class com.amazonaws.services.comprehend.model.PartOfSpeechTag extends Object implements Serializable


Serialized Fields


tag
String tag

 Identifies the part of speech that the token represents.
 


score
Float score

 The confidence that Amazon Comprehend has that the part of speech was correctly identified.
 








Class com.amazonaws.services.comprehend.model.ResourceInUseException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.ResourceLimitExceededException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.ResourceNotFoundException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.ResourceUnavailableException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.SentimentDetectionJobFilter extends Object implements Serializable


Serialized Fields


jobName
String jobName

 Filters on the name of the job.
 


jobStatus
String jobStatus

 Filters the list of jobs based on job status. Returns only jobs with the specified status.
 


submitTimeBefore
Date submitTimeBefore

 Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted
 before the specified time. Jobs are returned in ascending order, oldest to newest.
 


submitTimeAfter
Date submitTimeAfter

 Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted
 after the specified time. Jobs are returned in descending order, newest to oldest.
 








Class com.amazonaws.services.comprehend.model.SentimentDetectionJobProperties extends Object implements Serializable


Serialized Fields


jobId
String jobId

 The identifier assigned to the sentiment detection job.
 


jobName
String jobName

 The name that you assigned to the sentiment detection job
 


jobStatus
String jobStatus

 The current status of the sentiment detection job. If the status is FAILED, the
 Messages field shows the reason for the failure.
 


message
String message

 A description of the status of a job.
 


submitTime
Date submitTime

 The time that the sentiment detection job was submitted for processing.
 


endTime
Date endTime

 The time that the sentiment detection job ended.
 


inputDataConfig
InputDataConfig inputDataConfig

 The input data configuration that you supplied when you created the sentiment detection job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 The output data configuration that you supplied when you created the sentiment detection job.
 


languageCode
String languageCode

 The language code of the input documents.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for
 your sentiment detection job. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.SentimentScore extends Object implements Serializable


Serialized Fields


positive
Float positive

 The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE
 sentiment.
 


negative
Float negative

 The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE
 sentiment.
 


neutral
Float neutral

 The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL
 sentiment.
 


mixed
Float mixed

 The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED
 sentiment.
 








Class com.amazonaws.services.comprehend.model.StartDocumentClassificationJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 The identifier of the job.
 


documentClassifierArn
String documentClassifierArn

 The Amazon Resource Name (ARN) of the document classifier to use to process the job.
 


inputDataConfig
InputDataConfig inputDataConfig

 Specifies the format and location of the input data for the job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 Specifies where to send the output files.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend
 read access to your input data.
 


clientRequestToken
String clientRequestToken

 A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are
 using for your document classification job. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.StartDocumentClassificationJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier generated for the job. To get the status of the job, use this identifier with the operation.
 


jobStatus
String jobStatus

 The status of the job:
 
 
 
 
 SUBMITTED - The job has been received and queued for processing.
 
 
 
 
 IN_PROGRESS - Amazon Comprehend is processing the job.
 
 
 
 
 COMPLETED - The job was successfully completed and the output is available.
 
 
 
 
 FAILED - The job did not complete. For details, use the operation.
 
 
 
 
 STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
 
 
 
 
 STOPPED - The job was successfully stopped without completing.
 
 
 








Class com.amazonaws.services.comprehend.model.StartDominantLanguageDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputDataConfig
InputDataConfig inputDataConfig

 Specifies the format and location of the input data for the job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 Specifies where to send the output files.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend
 read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions<
 /a>.
 



jobName
String jobName

 An identifier for the job.
 


clientRequestToken
String clientRequestToken

 A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are
 using for your dominant language detection job. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.StartDominantLanguageDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier generated for the job. To get the status of a job, use this identifier with the operation.
 


jobStatus
String jobStatus

 The status of the job.
 
 
 
 
 SUBMITTED - The job has been received and is queued for processing.
 
 
 
 
 IN_PROGRESS - Amazon Comprehend is processing the job.
 
 
 
 
 COMPLETED - The job was successfully completed and the output is available.
 
 
 
 
 FAILED - The job did not complete. To get details, use the operation.
 
 
 








Class com.amazonaws.services.comprehend.model.StartEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputDataConfig
InputDataConfig inputDataConfig

 Specifies the format and location of the input data for the job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 Specifies where to send the output files.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend
 read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions<
 /a>.
 



jobName
String jobName

 The identifier of the job.
 


entityRecognizerArn
String entityRecognizerArn

 The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the
 StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition
 job.
 


languageCode
String languageCode

 The language of the input documents. All documents must be in the same language. You can specify any of the
 languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and
 the language used for training the model is used instead.
 


clientRequestToken
String clientRequestToken

 A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are
 using for your entity detection job. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.StartEntitiesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier generated for the job. To get the status of job, use this identifier with the operation.
 


jobStatus
String jobStatus

 The status of the job.
 
 
 
 
 SUBMITTED - The job has been received and is queued for processing.
 
 
 
 
 IN_PROGRESS - Amazon Comprehend is processing the job.
 
 
 
 
 COMPLETED - The job was successfully completed and the output is available.
 
 
 
 
 FAILED - The job did not complete. To get details, use the operation.
 
 
 
 
 STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.
 
 
 
 
 STOPPED - The job was successfully stopped without completing.
 
 
 








Class com.amazonaws.services.comprehend.model.StartKeyPhrasesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputDataConfig
InputDataConfig inputDataConfig

 Specifies the format and location of the input data for the job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 Specifies where to send the output files.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend
 read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions<
 /a>.
 



jobName
String jobName

 The identifier of the job.
 


languageCode
String languageCode

 The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend.
 All documents must be in the same language.
 


clientRequestToken
String clientRequestToken

 A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are
 using for your key phrases detection job. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.StartKeyPhrasesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier generated for the job. To get the status of a job, use this identifier with the operation.
 


jobStatus
String jobStatus

 The status of the job.
 
 
 
 
 SUBMITTED - The job has been received and is queued for processing.
 
 
 
 
 IN_PROGRESS - Amazon Comprehend is processing the job.
 
 
 
 
 COMPLETED - The job was successfully completed and the output is available.
 
 
 
 
 FAILED - The job did not complete. To get details, use the operation.
 
 
 








Class com.amazonaws.services.comprehend.model.StartSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputDataConfig
InputDataConfig inputDataConfig

 Specifies the format and location of the input data for the job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 Specifies where to send the output files.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend
 read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions<
 /a>.
 



jobName
String jobName

 The identifier of the job.
 


languageCode
String languageCode

 The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend.
 All documents must be in the same language.
 


clientRequestToken
String clientRequestToken

 A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are
 using for your sentiment detection job. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.StartSentimentDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier generated for the job. To get the status of a job, use this identifier with the operation.
 


jobStatus
String jobStatus

 The status of the job.
 
 
 
 
 SUBMITTED - The job has been received and is queued for processing.
 
 
 
 
 IN_PROGRESS - Amazon Comprehend is processing the job.
 
 
 
 
 COMPLETED - The job was successfully completed and the output is available.
 
 
 
 
 FAILED - The job did not complete. To get details, use the operation.
 
 
 








Class com.amazonaws.services.comprehend.model.StartTopicsDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputDataConfig
InputDataConfig inputDataConfig

 Specifies the format and location of the input data for the job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 Specifies where to send the output files. The output is a compressed archive with two files,
 topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv
 that lists the documents associated with each topic
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend
 read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions<
 /a>.
 



jobName
String jobName

 The identifier of the job.
 


numberOfTopics
Integer numberOfTopics

 The number of topics to detect.
 


clientRequestToken
String clientRequestToken

 A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are
 using for your topic detection job. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.StartTopicsDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier generated for the job. To get the status of the job, use this identifier with the
 DescribeTopicDetectionJob operation.
 


jobStatus
String jobStatus

 The status of the job:
 
 
 
 
 SUBMITTED - The job has been received and is queued for processing.
 
 
 
 
 IN_PROGRESS - Amazon Comprehend is processing the job.
 
 
 
 
 COMPLETED - The job was successfully completed and the output is available.
 
 
 
 
 FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.
 
 
 








Class com.amazonaws.services.comprehend.model.StopDominantLanguageDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the dominant language detection job to stop.
 








Class com.amazonaws.services.comprehend.model.StopDominantLanguageDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the dominant language detection job to stop.
 


jobStatus
String jobStatus

 Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was
 previously stopped with the StopDominantLanguageDetectionJob operation.
 








Class com.amazonaws.services.comprehend.model.StopEntitiesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the entities detection job to stop.
 








Class com.amazonaws.services.comprehend.model.StopEntitiesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the entities detection job to stop.
 


jobStatus
String jobStatus

 Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was
 previously stopped with the StopEntitiesDetectionJob operation.
 








Class com.amazonaws.services.comprehend.model.StopKeyPhrasesDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the key phrases detection job to stop.
 








Class com.amazonaws.services.comprehend.model.StopKeyPhrasesDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the key phrases detection job to stop.
 


jobStatus
String jobStatus

 Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was
 previously stopped with the StopKeyPhrasesDetectionJob operation.
 








Class com.amazonaws.services.comprehend.model.StopSentimentDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the sentiment detection job to stop.
 








Class com.amazonaws.services.comprehend.model.StopSentimentDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the sentiment detection job to stop.
 


jobStatus
String jobStatus

 Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was
 previously stopped with the StopSentimentDetectionJob operation.
 








Class com.amazonaws.services.comprehend.model.StopTrainingDocumentClassifierRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


documentClassifierArn
String documentClassifierArn

 The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.
 








Class com.amazonaws.services.comprehend.model.StopTrainingDocumentClassifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.comprehend.model.StopTrainingEntityRecognizerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


entityRecognizerArn
String entityRecognizerArn

 The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.
 








Class com.amazonaws.services.comprehend.model.StopTrainingEntityRecognizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.comprehend.model.SyntaxToken extends Object implements Serializable


Serialized Fields


tokenId
Integer tokenId

 A unique identifier for a token.
 


text
String text

 The word that was recognized in the source text.
 


beginOffset
Integer beginOffset

 The zero-based offset from the beginning of the source text to the first character in the word.
 


endOffset
Integer endOffset

 The zero-based offset from the beginning of the source text to the last character in the word.
 


partOfSpeech
PartOfSpeechTag partOfSpeech

 Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was
 correctly identified. For more information, see how-syntax.
 








Class com.amazonaws.services.comprehend.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want
 to show which resources are used by which departments, you might use “Department” as the key portion of the pair,
 with multiple possible values such as “sales,” “legal,” and “administration.”
 


value
String value

 The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want
 to show which resources are used by which departments, you might use “Department” as the initial (key) portion of
 the pair, with a value of “sales” to indicate the sales department.
 








Class com.amazonaws.services.comprehend.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.
 


tags
List<E> tags

 Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both
 existing and pending) associated with a specific resource.
 








Class com.amazonaws.services.comprehend.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.comprehend.model.TextSizeLimitExceededException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.TooManyRequestsException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.TooManyTagKeysException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.TooManyTagsException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.TopicsDetectionJobFilter extends Object implements Serializable


Serialized Fields


jobName
String jobName



jobStatus
String jobStatus

 Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.
 


submitTimeBefore
Date submitTimeBefore

 Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted
 before the specified time. Jobs are returned in descending order, newest to oldest.
 


submitTimeAfter
Date submitTimeAfter

 Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted
 after the specified time. Jobs are returned in ascending order, oldest to newest.
 








Class com.amazonaws.services.comprehend.model.TopicsDetectionJobProperties extends Object implements Serializable


Serialized Fields


jobId
String jobId

 The identifier assigned to the topic detection job.
 


jobName
String jobName

 The name of the topic detection job.
 


jobStatus
String jobStatus

 The current status of the topic detection job. If the status is Failed, the reason for the failure
 is shown in the Message field.
 


message
String message

 A description for the status of a job.
 


submitTime
Date submitTime

 The time that the topic detection job was submitted for processing.
 


endTime
Date endTime

 The time that the topic detection job was completed.
 


inputDataConfig
InputDataConfig inputDataConfig

 The input data configuration supplied when you created the topic detection job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 The output data configuration supplied when you created the topic detection job.
 


numberOfTopics
Integer numberOfTopics

 The number of topics to detect supplied when you created the topic detection job. The default is 10.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read
 access to your job data.
 


volumeKmsKeyId
String volumeKmsKeyId

 ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume
 attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the
 following formats:
 
 
 
 
 KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 
 
 Amazon Resource Name (ARN) of a KMS Key:
 "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
 
 
 


vpcConfig
VpcConfig vpcConfig

 Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for
 your topic detection job. For more information, see Amazon VPC.
 








Class com.amazonaws.services.comprehend.model.UnsupportedLanguageException extends AmazonComprehendException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehend.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.
 


tagKeys
List<E> tagKeys

 The initial part of a key-value pair that forms a tag being removed from a given resource. For example, a tag
 with "Sales" as the key might be added to a resource to indicate its use by the sales department. Keys must be
 unique and cannot be duplicated for a particular resource.
 








Class com.amazonaws.services.comprehend.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.comprehend.model.UpdateEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointArn
String endpointArn

 The Amazon Resource Number (ARN) of the endpoint being updated.
 


desiredInferenceUnits
Integer desiredInferenceUnits

 The desired number of inference units to be used by the model using this endpoint. Each inference unit represents
 of a throughput of 100 characters per second.
 








Class com.amazonaws.services.comprehend.model.UpdateEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.comprehend.model.VpcConfig extends Object implements Serializable


Serialized Fields


securityGroupIds
List<E> securityGroupIds

 The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve
 as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll
 be accessing on the VPC. This ID number is preceded by "sg-", for instance: "sg-03b388029b0a285ea". For more
 information, see Security
 Groups for your VPC.
 


subnets
List<E> subnets

 The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses
 used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by
 "subnet-", for instance: "subnet-04ccf456919e69055". For more information, see VPCs and Subnets.
 








Package com.amazonaws.services.comprehendmedical.model




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


Serialized Fields


type
String type

 The type of attribute.
 


score
Float score

 The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an
 attribute.
 


relationshipScore
Float relationshipScore

 The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this
 entity.
 


id
Integer id

 The numeric identifier for this attribute. This is a monotonically increasing id unique within this response
 rather than a global unique identifier.
 


beginOffset
Integer beginOffset

 The 0-based character offset in the input text that shows where the attribute begins. The offset returns the
 UTF-8 code point in the string.
 


endOffset
Integer endOffset

 The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8
 code point in the string.
 


text
String text

 The segment of input text extracted as this attribute.
 


traits
List<E> traits

 Contextual information for this attribute.
 








Class com.amazonaws.services.comprehendmedical.model.AWSComprehendMedicalException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehendmedical.model.ComprehendMedicalAsyncJobFilter extends Object implements Serializable


Serialized Fields


jobName
String jobName

 Filters on the name of the job.
 


jobStatus
String jobStatus

 Filters the list of jobs based on job status. Returns only jobs with the specified status.
 


submitTimeBefore
Date submitTimeBefore

 Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted
 before the specified time. Jobs are returned in ascending order, oldest to newest.
 


submitTimeAfter
Date submitTimeAfter

 Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted
 after the specified time. Jobs are returned in descending order, newest to oldest.
 








Class com.amazonaws.services.comprehendmedical.model.ComprehendMedicalAsyncJobProperties extends Object implements Serializable


Serialized Fields


jobId
String jobId

 The identifier assigned to the detection job.
 


jobName
String jobName

 The name that you assigned to the detection job.
 


jobStatus
String jobStatus

 The current status of the detection job. If the status is FAILED, the Message field
 shows the reason for the failure.
 


message
String message

 A description of the status of a job.
 


submitTime
Date submitTime

 The time that the detection job was submitted for processing.
 


endTime
Date endTime

 The time that the detection job completed.
 


expirationTime
Date expirationTime

 The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be
 deleted. After the metadata is deleted, the job will no longer appear in the results of the
 ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.
 


inputDataConfig
InputDataConfig inputDataConfig

 The input data configuration that you supplied when you created the detection job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 The output data configuration that you supplied when you created the detection job.
 


languageCode
String languageCode

 The language code of the input documents.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.
 


manifestFilePath
String manifestFilePath

 The path to the file that describes the results of a batch job.
 


kMSKey
String kMSKey

 The AWS Key Management Service key, if any, used to encrypt the output files.
 


modelVersion
String modelVersion

 The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this
 information to track the model used for a particular batch of documents.
 








Class com.amazonaws.services.comprehendmedical.model.DescribeEntitiesDetectionV2JobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier that Amazon Comprehend Medical generated for the job. The StartEntitiesDetectionV2Job
 operation returns this identifier in its response.
 








Class com.amazonaws.services.comprehendmedical.model.DescribeEntitiesDetectionV2JobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


comprehendMedicalAsyncJobProperties
ComprehendMedicalAsyncJobProperties comprehendMedicalAsyncJobProperties

 An object that contains the properties associated with a detection job.
 








Class com.amazonaws.services.comprehendmedical.model.DescribePHIDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier that Amazon Comprehend Medical generated for the job. The StartPHIDetectionJob
 operation returns this identifier in its response.
 








Class com.amazonaws.services.comprehendmedical.model.DescribePHIDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


comprehendMedicalAsyncJobProperties
ComprehendMedicalAsyncJobProperties comprehendMedicalAsyncJobProperties

 An object that contains the properties associated with a detection job.
 








Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


text
String text

 A UTF-8 text string containing the clinical content being examined for entities. Each string must contain fewer
 than 20,000 bytes of characters.
 








Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entities
List<E> entities

 The collection of medical entities extracted from the input text and their associated information. For each
 entity, the response provides the entity text, the entity category, where the entity text begins and ends, and
 the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits
 of the entity are also returned.
 


unmappedAttributes
List<E> unmappedAttributes

 Attributes extracted from the input text that we were unable to relate to an entity.
 


paginationToken
String paginationToken

 If the result of the previous request to DetectEntities was truncated, include the
 PaginationToken to fetch the next page of entities.
 


modelVersion
String modelVersion

 The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this
 information to track the model used for a particular batch of documents.
 








Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesV2Request extends AmazonWebServiceRequest implements Serializable


Serialized Fields


text
String text

 A UTF-8 string containing the clinical content being examined for entities. Each string must contain fewer than
 20,000 bytes of characters.
 








Class com.amazonaws.services.comprehendmedical.model.DetectEntitiesV2Result extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entities
List<E> entities

 The collection of medical entities extracted from the input text and their associated information. For each
 entity, the response provides the entity text, the entity category, where the entity text begins and ends, and
 the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.
 


unmappedAttributes
List<E> unmappedAttributes

 Attributes extracted from the input text that couldn't be related to an entity.
 


paginationToken
String paginationToken

 If the result to the DetectEntitiesV2 operation was truncated, include the
 PaginationToken to fetch the next page of entities.
 


modelVersion
String modelVersion

 The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this
 information to track the model used for a particular batch of documents.
 








Class com.amazonaws.services.comprehendmedical.model.DetectPHIRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


text
String text

 A UTF-8 text string containing the clinical content being examined for PHI entities. Each string must contain
 fewer than 20,000 bytes of characters.
 








Class com.amazonaws.services.comprehendmedical.model.DetectPHIResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entities
List<E> entities

 The collection of PHI entities extracted from the input text and their associated information. For each entity,
 the response provides the entity text, the entity category, where the entity text begins and ends, and the level
 of confidence that Amazon Comprehend Medical has in its detection.
 


paginationToken
String paginationToken

 If the result of the previous request to DetectPHI was truncated, include the
 PaginationToken to fetch the next page of PHI entities.
 


modelVersion
String modelVersion

 The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this
 information to track the model used for a particular batch of documents.
 








Class com.amazonaws.services.comprehendmedical.model.Entity extends Object implements Serializable


Serialized Fields


id
Integer id

 The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather
 than a global unique identifier.
 


beginOffset
Integer beginOffset

 The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8
 code point in the string.
 


endOffset
Integer endOffset

 The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8
 code point in the string.
 


score
Float score

 The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
 


text
String text

 The segment of input text extracted as this entity.
 


category
String category

 The category of the entity.
 


type
String type

 Describes the specific type of entity with category of entities.
 


traits
List<E> traits

 Contextual information for the entity.
 


attributes
List<E> attributes

 The extracted attributes that relate to this entity.
 








Class com.amazonaws.services.comprehendmedical.model.ICD10CMAttribute extends Object implements Serializable


Serialized Fields


type
String type

 The type of attribute. InferICD10CM detects entities of the type DX_NAME.
 


score
Float score

 The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an
 attribute.
 


relationshipScore
Float relationshipScore

 The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this
 entity.
 


id
Integer id

 The numeric identifier for this attribute. This is a monotonically increasing id unique within this response
 rather than a global unique identifier.
 


beginOffset
Integer beginOffset

 The 0-based character offset in the input text that shows where the attribute begins. The offset returns the
 UTF-8 code point in the string.
 


endOffset
Integer endOffset

 The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8
 code point in the string.
 


text
String text

 The segment of input text which contains the detected attribute.
 


traits
List<E> traits

 The contextual information for the attribute. The traits recognized by InferICD10CM are DIAGNOSIS,
 SIGN, SYMPTOM, and NEGATION.
 








Class com.amazonaws.services.comprehendmedical.model.ICD10CMConcept extends Object implements Serializable


Serialized Fields


description
String description

 The long description of the ICD-10-CM code in the ontology.
 


code
String code

 The ICD-10-CM code that identifies the concept found in the knowledge base from the Centers for Disease Control.
 


score
Float score

 The level of confidence that Amazon Comprehend Medical has that the entity is accurately linked to an ICD-10-CM
 concept.
 








Class com.amazonaws.services.comprehendmedical.model.ICD10CMEntity extends Object implements Serializable


Serialized Fields


id
Integer id

 The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather
 than a global unique identifier.
 


text
String text

 The segment of input text that is matched to the detected entity.
 


category
String category

 The category of the entity. InferICD10CM detects entities in the MEDICAL_CONDITION category.
 


type
String type

 Describes the specific type of entity with category of entities. InferICD10CM detects entities of the type
 DX_NAME.
 


score
Float score

 The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.
 


beginOffset
Integer beginOffset

 The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8
 code point in the string.
 


endOffset
Integer endOffset

 The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8
 code point in the string.
 


attributes
List<E> attributes

 The detected attributes that relate to the entity. An extracted segment of the text that is an attribute of an
 entity, or otherwise related to an entity, such as the nature of a medical condition.
 


traits
List<E> traits

 Provides Contextual information for the entity. The traits recognized by InferICD10CM are DIAGNOSIS,
 SIGN, SYMPTOM, and NEGATION.
 


iCD10CMConcepts
List<E> iCD10CMConcepts

 The ICD-10-CM concepts that the entity could refer to, along with a score indicating the likelihood of the match.
 








Class com.amazonaws.services.comprehendmedical.model.ICD10CMTrait extends Object implements Serializable


Serialized Fields


name
String name

 Provides a name or contextual description about the trait.
 


score
Float score

 The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as a
 trait.
 








Class com.amazonaws.services.comprehendmedical.model.InferICD10CMRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


text
String text

 The input text used for analysis. The input for InferICD10CM is a string from 1 to 10000 characters.
 








Class com.amazonaws.services.comprehendmedical.model.InferICD10CMResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entities
List<E> entities

 The medical conditions detected in the text linked to ICD-10-CM concepts. If the action is successful, the
 service sends back an HTTP 200 response, as well as the entities detected.
 


paginationToken
String paginationToken

 If the result of the previous request to InferICD10CM was truncated, include the
 PaginationToken to fetch the next page of medical condition entities.
 


modelVersion
String modelVersion

 The version of the model used to analyze the documents, in the format n.n.n You can use this
 information to track the model used for a particular batch of documents.
 








Class com.amazonaws.services.comprehendmedical.model.InferRxNormRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


text
String text

 The input text used for analysis. The input for InferRxNorm is a string from 1 to 10000 characters.
 








Class com.amazonaws.services.comprehendmedical.model.InferRxNormResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entities
List<E> entities

 The medication entities detected in the text linked to RxNorm concepts. If the action is successful, the service
 sends back an HTTP 200 response, as well as the entities detected.
 


paginationToken
String paginationToken

 If the result of the previous request to InferRxNorm was truncated, include the
 PaginationToken to fetch the next page of medication entities.
 


modelVersion
String modelVersion

 The version of the model used to analyze the documents, in the format n.n.n You can use this
 information to track the model used for a particular batch of documents.
 








Class com.amazonaws.services.comprehendmedical.model.InputDataConfig extends Object implements Serializable


Serialized Fields


s3Bucket
String s3Bucket

 The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint
 that you are calling.
 
 
 Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.
 


s3Key
String s3Key

 The path to the input data files in the S3 bucket.
 








Class com.amazonaws.services.comprehendmedical.model.InternalServerException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehendmedical.model.InvalidEncodingException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehendmedical.model.InvalidRequestException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehendmedical.model.ListEntitiesDetectionV2JobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
ComprehendMedicalAsyncJobFilter filter

 Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that
 they were submitted. You can only set one filter at a time.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 


maxResults
Integer maxResults

 The maximum number of results to return in each page. The default is 100.
 








Class com.amazonaws.services.comprehendmedical.model.ListEntitiesDetectionV2JobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


comprehendMedicalAsyncJobPropertiesList
List<E> comprehendMedicalAsyncJobPropertiesList

 A list containing the properties of each job returned.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 








Class com.amazonaws.services.comprehendmedical.model.ListPHIDetectionJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
ComprehendMedicalAsyncJobFilter filter

 Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that
 they were submitted. You can only set one filter at a time.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 


maxResults
Integer maxResults

 The maximum number of results to return in each page. The default is 100.
 








Class com.amazonaws.services.comprehendmedical.model.ListPHIDetectionJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


comprehendMedicalAsyncJobPropertiesList
List<E> comprehendMedicalAsyncJobPropertiesList

 A list containing the properties of each job returned.
 


nextToken
String nextToken

 Identifies the next page of results to return.
 








Class com.amazonaws.services.comprehendmedical.model.OutputDataConfig extends Object implements Serializable


Serialized Fields


s3Bucket
String s3Bucket

 When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3
 location where you want to write the output data. The URI must be in the same region as the API endpoint that you
 are calling. The location is used as the prefix for the actual location of the output.
 


s3Key
String s3Key

 The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory using
 the job ID so that the output from one job does not overwrite the output of another.
 








Class com.amazonaws.services.comprehendmedical.model.ResourceNotFoundException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehendmedical.model.RxNormAttribute extends Object implements Serializable


Serialized Fields


type
String type

 The type of attribute. The types of attributes recognized by InferRxNorm are BRAND_NAME and
 GENERIC_NAME.
 


score
Float score

 The level of confidence that Comprehend Medical has that the segment of text is correctly recognized as an
 attribute.
 


relationshipScore
Float relationshipScore

 The level of confidence that Amazon Comprehend Medical has that the attribute is accurately linked to an entity.
 


id
Integer id

 The numeric identifier for this attribute. This is a monotonically increasing id unique within this response
 rather than a global unique identifier.
 


beginOffset
Integer beginOffset

 The 0-based character offset in the input text that shows where the attribute begins. The offset returns the
 UTF-8 code point in the string.
 


endOffset
Integer endOffset

 The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8
 code point in the string.
 


text
String text

 The segment of input text which corresponds to the detected attribute.
 


traits
List<E> traits

 Contextual information for the attribute. InferRxNorm recognizes the trait NEGATION for attributes,
 i.e. that the patient is not taking a specific dose or form of a medication.
 








Class com.amazonaws.services.comprehendmedical.model.RxNormConcept extends Object implements Serializable


Serialized Fields


description
String description

 The description of the RxNorm concept.
 


code
String code

 RxNorm concept ID, also known as the RxCUI.
 


score
Float score

 The level of confidence that Amazon Comprehend Medical has that the entity is accurately linked to the reported
 RxNorm concept.
 








Class com.amazonaws.services.comprehendmedical.model.RxNormEntity extends Object implements Serializable


Serialized Fields


id
Integer id

 The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather
 than a global unique identifier.
 


text
String text

 The segment of input text extracted from which the entity was detected.
 


category
String category

 The category of the entity. The recognized categories are GENERIC or BRAND_NAME.
 


type
String type

 Describes the specific type of entity. For InferRxNorm, the recognized entity type is MEDICATION.
 


score
Float score

 The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected entity.
 


beginOffset
Integer beginOffset

 The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8
 code point in the string.
 


endOffset
Integer endOffset

 The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8
 code point in the string.
 


attributes
List<E> attributes

 The extracted attributes that relate to the entity. The attributes recognized by InferRxNorm are
 DOSAGE, DURATION, FORM, FREQUENCY, RATE,
 ROUTE_OR_MODE, and STRENGTH.
 


traits
List<E> traits

 Contextual information for the entity.
 


rxNormConcepts
List<E> rxNormConcepts

 The RxNorm concepts that the entity could refer to, along with a score indicating the likelihood of the match.
 








Class com.amazonaws.services.comprehendmedical.model.RxNormTrait extends Object implements Serializable


Serialized Fields


name
String name

 Provides a name or contextual description about the trait.
 


score
Float score

 The level of confidence that Amazon Comprehend Medical has in the accuracy of the detected trait.
 








Class com.amazonaws.services.comprehendmedical.model.ServiceUnavailableException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehendmedical.model.StartEntitiesDetectionV2JobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputDataConfig
InputDataConfig inputDataConfig

 Specifies the format and location of the input data for the job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 Specifies where to send the output files.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend
 Medical read access to your input data. For more information, see  Role-Based Permissions Required for Asynchronous Operations.
 


jobName
String jobName

 The identifier of the job.
 


clientRequestToken
String clientRequestToken

 A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical
 generates one.
 


kMSKey
String kMSKey

 An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are
 written in plain text.
 


languageCode
String languageCode

 The language of the input documents. All documents must be in the same language.
 








Class com.amazonaws.services.comprehendmedical.model.StartEntitiesDetectionV2JobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier generated for the job. To get the status of a job, use this identifier with the
 DescribeEntitiesDetectionV2Job operation.
 








Class com.amazonaws.services.comprehendmedical.model.StartPHIDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputDataConfig
InputDataConfig inputDataConfig

 Specifies the format and location of the input data for the job.
 


outputDataConfig
OutputDataConfig outputDataConfig

 Specifies where to send the output files.
 


dataAccessRoleArn
String dataAccessRoleArn

 The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend
 Medical read access to your input data. For more information, see  Role-Based Permissions Required for Asynchronous Operations.
 


jobName
String jobName

 The identifier of the job.
 


clientRequestToken
String clientRequestToken

 A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical
 generates one.
 


kMSKey
String kMSKey

 An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are
 written in plain text.
 


languageCode
String languageCode

 The language of the input documents. All documents must be in the same language.
 








Class com.amazonaws.services.comprehendmedical.model.StartPHIDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier generated for the job. To get the status of a job, use this identifier with the
 DescribePHIDetectionJob operation.
 








Class com.amazonaws.services.comprehendmedical.model.StopEntitiesDetectionV2JobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the medical entities job to stop.
 








Class com.amazonaws.services.comprehendmedical.model.StopEntitiesDetectionV2JobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the medical entities detection job that was stopped.
 








Class com.amazonaws.services.comprehendmedical.model.StopPHIDetectionJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the PHI detection job to stop.
 








Class com.amazonaws.services.comprehendmedical.model.StopPHIDetectionJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the PHI detection job that was stopped.
 








Class com.amazonaws.services.comprehendmedical.model.TextSizeLimitExceededException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehendmedical.model.TooManyRequestsException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.comprehendmedical.model.Trait extends Object implements Serializable


Serialized Fields


name
String name

 Provides a name or contextual description about the trait.
 


score
Float score

 The level of confidence that Amazon Comprehend Medical has in the accuracy of this trait.
 








Class com.amazonaws.services.comprehendmedical.model.UnmappedAttribute extends Object implements Serializable


Serialized Fields


type
String type

 The type of the attribute, could be one of the following values: "MEDICATION", "MEDICAL_CONDITION", "ANATOMY",
 "TEST_AND_TREATMENT_PROCEDURE" or "PROTECTED_HEALTH_INFORMATION".
 


attribute
Attribute attribute

 The specific attribute that has been extracted but not mapped to an entity.
 








Class com.amazonaws.services.comprehendmedical.model.ValidationException extends AWSComprehendMedicalException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.computeoptimizer.model




Class com.amazonaws.services.computeoptimizer.model.AccessDeniedException extends AWSComputeOptimizerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.computeoptimizer.model.AutoScalingGroupConfiguration extends Object implements Serializable


Serialized Fields


desiredCapacity
Integer desiredCapacity

 The desired capacity, or number of instances, for the Auto Scaling group.
 


minSize
Integer minSize

 The minimum size, or minimum number of instances, for the Auto Scaling group.
 


maxSize
Integer maxSize

 The maximum size, or maximum number of instances, for the Auto Scaling group.
 


instanceType
String instanceType

 The instance type for the Auto Scaling group.
 








Class com.amazonaws.services.computeoptimizer.model.AutoScalingGroupRecommendation extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The AWS account ID of the Auto Scaling group.
 


autoScalingGroupArn
String autoScalingGroupArn

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


autoScalingGroupName
String autoScalingGroupName

 The name of the Auto Scaling group.
 


finding
String finding

 The finding classification for the Auto Scaling group.
 
 
 Findings for Auto Scaling groups include:
 
 
 
 
  NotOptimized —An Auto Scaling group is considered not optimized when AWS Compute Optimizer
 identifies a recommendation that can provide better performance for your workload.
 
 
 
 
  Optimized —An Auto Scaling group is considered optimized when Compute Optimizer determines
 that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized
 resources, Compute Optimizer might recommend a new generation instance type.
 
 
 
 
 
 The values that are returned might be NOT_OPTIMIZED or OPTIMIZED.
 
 


utilizationMetrics
List<E> utilizationMetrics

 An array of objects that describe the utilization metrics of the Auto Scaling group.
 


lookBackPeriodInDays
Double lookBackPeriodInDays

 The number of days for which utilization metrics were analyzed for the Auto Scaling group.
 


currentConfiguration
AutoScalingGroupConfiguration currentConfiguration

 An array of objects that describe the current configuration of the Auto Scaling group.
 


recommendationOptions
List<E> recommendationOptions

 An array of objects that describe the recommendation options for the Auto Scaling group.
 


lastRefreshTimestamp
Date lastRefreshTimestamp

 The time stamp of when the Auto Scaling group recommendation was last refreshed.
 








Class com.amazonaws.services.computeoptimizer.model.AutoScalingGroupRecommendationOption extends Object implements Serializable


Serialized Fields


configuration
AutoScalingGroupConfiguration configuration

 An array of objects that describe an Auto Scaling group configuration.
 


projectedUtilizationMetrics
List<E> projectedUtilizationMetrics

 An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation
 option.
 


performanceRisk
Double performanceRisk

 The performance risk of the Auto Scaling group configuration recommendation.
 
 
 Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of
 your workload.
 
 
 The lowest performance risk is categorized as 0, and the highest as 5.
 


rank
Integer rank

 The rank of the Auto Scaling group recommendation option.
 
 
 The top recommendation option is ranked as 1.
 








Class com.amazonaws.services.computeoptimizer.model.AWSComputeOptimizerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.computeoptimizer.model.Filter extends Object implements Serializable


Serialized Fields


name
String name

 The name of the filter.
 
 
 Specify Finding to filter the results to a specific findings classification.
 
 
 Specify RecommendationSourceType to filter the results to a specific resource type.
 


values
List<E> values

 The value of the filter.
 
 
 If you specify the name parameter as Finding, and you're recommendations for an
 instance, then the valid values are Underprovisioned, Overprovisioned,
 NotOptimized, or Optimized.
 
 
 If you specify the name parameter as Finding, and you're recommendations for an Auto
 Scaling group, then the valid values are Optimized, or NotOptimized.
 
 
 If you specify the name parameter as RecommendationSourceType, then the valid values
 are EC2Instance, or AutoScalingGroup.
 








Class com.amazonaws.services.computeoptimizer.model.GetAutoScalingGroupRecommendationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountIds
List<E> accountIds

 The AWS account IDs for which to return Auto Scaling group recommendations.
 
 
 Only one account ID can be specified per request.
 


autoScalingGroupArns
List<E> autoScalingGroupArns

 The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.
 


nextToken
String nextToken

 The token to advance to the next page of Auto Scaling group recommendations.
 


maxResults
Integer maxResults

 The maximum number of Auto Scaling group recommendations to return with a single call.
 
 
 To retrieve the remaining results, make another call with the returned NextToken value.
 


filters
List<E> filters

 An array of objects that describe a filter that returns a more specific list of Auto Scaling group
 recommendations.
 








Class com.amazonaws.services.computeoptimizer.model.GetAutoScalingGroupRecommendationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to use to advance to the next page of Auto Scaling group recommendations.
 
 
 This value is null when there are no more pages of Auto Scaling group recommendations to return.
 


autoScalingGroupRecommendations
List<E> autoScalingGroupRecommendations

 An array of objects that describe Auto Scaling group recommendations.
 


errors
List<E> errors

 An array of objects that describe errors of the request.
 
 
 For example, an error is returned if you request recommendations for an unsupported Auto Scaling group.
 








Class com.amazonaws.services.computeoptimizer.model.GetEC2InstanceRecommendationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceArns
List<E> instanceArns

 The Amazon Resource Name (ARN) of the instances for which to return recommendations.
 


nextToken
String nextToken

 The token to advance to the next page of instance recommendations.
 


maxResults
Integer maxResults

 The maximum number of instance recommendations to return with a single call.
 
 
 To retrieve the remaining results, make another call with the returned NextToken value.
 


filters
List<E> filters

 An array of objects that describe a filter that returns a more specific list of instance recommendations.
 


accountIds
List<E> accountIds

 The AWS account IDs for which to return instance recommendations.
 
 
 Only one account ID can be specified per request.
 








Class com.amazonaws.services.computeoptimizer.model.GetEC2InstanceRecommendationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to use to advance to the next page of instance recommendations.
 
 
 This value is null when there are no more pages of instance recommendations to return.
 


instanceRecommendations
List<E> instanceRecommendations

 An array of objects that describe instance recommendations.
 


errors
List<E> errors

 An array of objects that describe errors of the request.
 
 
 For example, an error is returned if you request recommendations for an instance of an unsupported instance
 family.
 








Class com.amazonaws.services.computeoptimizer.model.GetEC2RecommendationProjectedMetricsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceArn
String instanceArn

 The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.
 


stat
String stat

 The statistic of the projected metrics.
 


period
Integer period

 The granularity, in seconds, of the projected metrics data points.
 


startTime
Date startTime

 The time stamp of the first projected metrics data point to return.
 


endTime
Date endTime

 The time stamp of the last projected metrics data point to return.
 








Class com.amazonaws.services.computeoptimizer.model.GetEC2RecommendationProjectedMetricsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


recommendedOptionProjectedMetrics
List<E> recommendedOptionProjectedMetrics

 An array of objects that describe a projected metrics.
 








Class com.amazonaws.services.computeoptimizer.model.GetEnrollmentStatusRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.computeoptimizer.model.GetEnrollmentStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The enrollment status of the account.
 


statusReason
String statusReason

 The reason for the enrollment status of the account.
 
 
 For example, an account might show a status of Pending because member accounts of an organization
 require more time to be enrolled in the service.
 


memberAccountsEnrolled
Boolean memberAccountsEnrolled

 Confirms the enrollment status of member accounts within the organization, if the account is a master account of
 an organization.
 








Class com.amazonaws.services.computeoptimizer.model.GetRecommendationError extends Object implements Serializable


Serialized Fields


identifier
String identifier

 The ID of the error.
 


code
String code

 The error code.
 


message
String message

 The message, or reason, for the error.
 








Class com.amazonaws.services.computeoptimizer.model.GetRecommendationSummariesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountIds
List<E> accountIds

 The AWS account IDs for which to return recommendation summaries.
 
 
 Only one account ID can be specified per request.
 


nextToken
String nextToken

 The token to advance to the next page of recommendation summaries.
 


maxResults
Integer maxResults

 The maximum number of recommendation summaries to return with a single call.
 
 
 To retrieve the remaining results, make another call with the returned NextToken value.
 








Class com.amazonaws.services.computeoptimizer.model.GetRecommendationSummariesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to use to advance to the next page of recommendation summaries.
 
 
 This value is null when there are no more pages of recommendation summaries to return.
 


recommendationSummaries
List<E> recommendationSummaries

 An array of objects that summarize a recommendation.
 








Class com.amazonaws.services.computeoptimizer.model.InstanceRecommendation extends Object implements Serializable


Serialized Fields


instanceArn
String instanceArn

 The Amazon Resource Name (ARN) of the current instance.
 


accountId
String accountId

 The AWS account ID of the instance recommendation.
 


instanceName
String instanceName

 The name of the current instance.
 


currentInstanceType
String currentInstanceType

 The instance type of the current instance.
 


finding
String finding

 The finding classification for the instance.
 
 
 Findings for instances include:
 
 
 
 
  Underprovisioned —An instance is considered under-provisioned when at least one
 specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of
 your workload. Under-provisioned instances may lead to poor application performance.
 
 
 
 
  Overprovisioned —An instance is considered over-provisioned when at least one specification
 of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance
 requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to
 unnecessary infrastructure cost.
 
 
 
 
  Optimized —An instance is considered optimized when all specifications of your instance,
 such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned.
 An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized
 resources, AWS Compute Optimizer might recommend a new generation instance type.
 
 
 
 
 
 The values that are returned might be UNDER_PROVISIONED, OVER_PROVISIONED, or
 OPTIMIZED.
 
 


utilizationMetrics
List<E> utilizationMetrics

 An array of objects that describe the utilization metrics of the instance.
 


lookBackPeriodInDays
Double lookBackPeriodInDays

 The number of days for which utilization metrics were analyzed for the instance.
 


recommendationOptions
List<E> recommendationOptions

 An array of objects that describe the recommendation options for the instance.
 


recommendationSources
List<E> recommendationSources

 An array of objects that describe the source resource of the recommendation.
 


lastRefreshTimestamp
Date lastRefreshTimestamp

 The time stamp of when the instance recommendation was last refreshed.
 








Class com.amazonaws.services.computeoptimizer.model.InstanceRecommendationOption extends Object implements Serializable


Serialized Fields


instanceType
String instanceType

 The instance type of the instance recommendation.
 


projectedUtilizationMetrics
List<E> projectedUtilizationMetrics

 An array of objects that describe the projected utilization metrics of the instance recommendation option.
 


performanceRisk
Double performanceRisk

 The performance risk of the instance recommendation option.
 
 
 Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of
 your workload.
 
 
 The lowest performance risk is categorized as 0, and the highest as 5.
 


rank
Integer rank

 The rank of the instance recommendation option.
 
 
 The top recommendation option is ranked as 1.
 








Class com.amazonaws.services.computeoptimizer.model.InternalServerException extends AWSComputeOptimizerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.computeoptimizer.model.InvalidParameterValueException extends AWSComputeOptimizerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.computeoptimizer.model.MissingAuthenticationTokenException extends AWSComputeOptimizerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.computeoptimizer.model.OptInRequiredException extends AWSComputeOptimizerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.computeoptimizer.model.ProjectedMetric extends Object implements Serializable


Serialized Fields


name
String name

 The name of the projected utilization metric.
 
 
 
 Memory metrics are only returned for resources that have the unified CloudWatch agent installed on them. For more
 information, see Enabling
 Memory Utilization with the CloudWatch Agent.
 
 


timestamps
List<E> timestamps

 The time stamps of the projected utilization metric.
 


values
List<E> values

 The values of the projected utilization metrics.
 








Class com.amazonaws.services.computeoptimizer.model.RecommendationSource extends Object implements Serializable


Serialized Fields


recommendationSourceArn
String recommendationSourceArn

 The Amazon Resource Name (ARN) of the recommendation source.
 


recommendationSourceType
String recommendationSourceType

 The resource type of the recommendation source.
 








Class com.amazonaws.services.computeoptimizer.model.RecommendationSummary extends Object implements Serializable


Serialized Fields


summaries
List<E> summaries

 An array of objects that describe a recommendation summary.
 


recommendationResourceType
String recommendationResourceType

 The resource type of the recommendation.
 


accountId
String accountId

 The AWS account ID of the recommendation summary.
 








Class com.amazonaws.services.computeoptimizer.model.RecommendedOptionProjectedMetric extends Object implements Serializable


Serialized Fields


recommendedInstanceType
String recommendedInstanceType

 The recommended instance type.
 


rank
Integer rank

 The rank of the recommendation option projected metric.
 
 
 The top recommendation option is ranked as 1.
 
 
 The projected metric rank correlates to the recommendation option rank. For example, the projected metric ranked
 as 1 is related to the recommendation option that is also ranked as 1 in the same
 response.
 


projectedMetrics
List<E> projectedMetrics

 An array of objects that describe a projected utilization metric.
 








Class com.amazonaws.services.computeoptimizer.model.ResourceNotFoundException extends AWSComputeOptimizerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.computeoptimizer.model.ServiceUnavailableException extends AWSComputeOptimizerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.computeoptimizer.model.Summary extends Object implements Serializable


Serialized Fields


name
String name

 The finding classification of the recommendation.
 


value
Double value

 The value of the recommendation summary.
 








Class com.amazonaws.services.computeoptimizer.model.ThrottlingException extends AWSComputeOptimizerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.computeoptimizer.model.UpdateEnrollmentStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


status
String status

 The new enrollment status of the account.
 
 
 Accepted options are Active or Inactive. You will get an error if Pending
 or Failed are specified.
 


includeMemberAccounts
Boolean includeMemberAccounts

 Indicates whether to enroll member accounts within the organization, if the account is a master account of an
 organization.
 








Class com.amazonaws.services.computeoptimizer.model.UpdateEnrollmentStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The enrollment status of the account.
 


statusReason
String statusReason

 The reason for the enrollment status of the account. For example, an account might show a status of
 Pending because member accounts of an organization require more time to be enrolled in the service.
 








Class com.amazonaws.services.computeoptimizer.model.UtilizationMetric extends Object implements Serializable


Serialized Fields


name
String name

 The name of the utilization metric.
 
 
 
 Memory metrics are only returned for resources that have the unified CloudWatch agent installed on them. For more
 information, see Enabling
 Memory Utilization with the CloudWatch Agent.
 
 


statistic
String statistic

 The statistic of the utilization metric.
 


value
Double value

 The value of the utilization metric.
 








Package com.amazonaws.services.config.model




Class com.amazonaws.services.config.model.AccountAggregationSource extends Object implements Serializable


Serialized Fields


accountIds
SdkInternalList<T> accountIds

 The 12-digit account ID of the account being aggregated.
 


allAwsRegions
Boolean allAwsRegions

 If true, aggregate existing AWS Config regions and future regions.
 


awsRegions
SdkInternalList<T> awsRegions

 The source regions being aggregated.
 








Class com.amazonaws.services.config.model.AggregateComplianceByConfigRule extends Object implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule.
 


compliance
Compliance compliance

 Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that
 affect the compliance.
 


accountId
String accountId

 The 12-digit account ID of the source account.
 


awsRegion
String awsRegion

 The source region from where the data is aggregated.
 








Class com.amazonaws.services.config.model.AggregateComplianceCount extends Object implements Serializable


Serialized Fields


groupName
String groupName

 The 12-digit account ID or region based on the GroupByKey value.
 


complianceSummary
ComplianceSummary complianceSummary

 The number of compliant and noncompliant AWS Config rules.
 








Class com.amazonaws.services.config.model.AggregatedSourceStatus extends Object implements Serializable


Serialized Fields


sourceId
String sourceId

 The source account ID or an organization.
 


sourceType
String sourceType

 The source account or an organization.
 


awsRegion
String awsRegion

 The region authorized to collect aggregated data.
 


lastUpdateStatus
String lastUpdateStatus

 Filters the last updated status type.
 
 
 
 
 Valid value FAILED indicates errors while moving data.
 
 
 
 
 Valid value SUCCEEDED indicates the data was successfully moved.
 
 
 
 
 Valid value OUTDATED indicates the data is not the most recent.
 
 
 


lastUpdateTime
Date lastUpdateTime

 The time of the last update.
 


lastErrorCode
String lastErrorCode

 The error code that AWS Config returned when the source account aggregation last failed.
 


lastErrorMessage
String lastErrorMessage

 The message indicating that the source account aggregation failed due to an error.
 








Class com.amazonaws.services.config.model.AggregateEvaluationResult extends Object implements Serializable


Serialized Fields


evaluationResultIdentifier
EvaluationResultIdentifier evaluationResultIdentifier

 Uniquely identifies the evaluation result.
 


complianceType
String complianceType

 The resource compliance status.
 
 
 For the AggregationEvaluationResult data type, AWS Config supports only the COMPLIANT
 and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and
 INSUFFICIENT_DATA value.
 


resultRecordedTime
Date resultRecordedTime

 The time when AWS Config recorded the aggregate evaluation result.
 


configRuleInvokedTime
Date configRuleInvokedTime

 The time when the AWS Config rule evaluated the AWS resource.
 


annotation
String annotation

 Supplementary information about how the agrregate evaluation determined the compliance.
 


accountId
String accountId

 The 12-digit account ID of the source account.
 


awsRegion
String awsRegion

 The source region from where the data is aggregated.
 








Class com.amazonaws.services.config.model.AggregateResourceIdentifier extends Object implements Serializable


Serialized Fields


sourceAccountId
String sourceAccountId

 The 12-digit account ID of the source account.
 


sourceRegion
String sourceRegion

 The source region where data is aggregated.
 


resourceId
String resourceId

 The ID of the AWS resource.
 


resourceType
String resourceType

 The type of the AWS resource.
 


resourceName
String resourceName

 The name of the AWS resource.
 








Class com.amazonaws.services.config.model.AggregationAuthorization extends Object implements Serializable


Serialized Fields


aggregationAuthorizationArn
String aggregationAuthorizationArn

 The Amazon Resource Name (ARN) of the aggregation object.
 


authorizedAccountId
String authorizedAccountId

 The 12-digit account ID of the account authorized to aggregate data.
 


authorizedAwsRegion
String authorizedAwsRegion

 The region authorized to collect aggregated data.
 


creationTime
Date creationTime

 The time stamp when the aggregation authorization was created.
 








Class com.amazonaws.services.config.model.AmazonConfigException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.BaseConfigurationItem extends Object implements Serializable


Serialized Fields


version
String version

 The version number of the resource configuration.
 


accountId
String accountId

 The 12-digit AWS account ID associated with the resource.
 


configurationItemCaptureTime
Date configurationItemCaptureTime

 The time when the configuration recording was initiated.
 


configurationItemStatus
String configurationItemStatus

 The configuration item status.
 


configurationStateId
String configurationStateId

 An identifier that indicates the ordering of the configuration items of a resource.
 


arn
String arn

 The Amazon Resource Name (ARN) of the resource.
 


resourceType
String resourceType

 The type of AWS resource.
 


resourceId
String resourceId

 The ID of the resource (for example., sg-xxxxxx).
 


resourceName
String resourceName

 The custom name of the resource, if available.
 


awsRegion
String awsRegion

 The region where the resource resides.
 


availabilityZone
String availabilityZone

 The Availability Zone associated with the resource.
 


resourceCreationTime
Date resourceCreationTime

 The time stamp when the resource was created.
 


configuration
String configuration

 The description of the resource configuration.
 


supplementaryConfiguration
Map<K,V> supplementaryConfiguration

 Configuration attributes that AWS Config returns for certain resource types to supplement the information
 returned for the configuration parameter.
 








Class com.amazonaws.services.config.model.BatchGetAggregateResourceConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationAggregatorName
String configurationAggregatorName

 The name of the configuration aggregator.
 


resourceIdentifiers
SdkInternalList<T> resourceIdentifiers

 A list of aggregate ResourceIdentifiers objects.
 








Class com.amazonaws.services.config.model.BatchGetAggregateResourceConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


baseConfigurationItems
SdkInternalList<T> baseConfigurationItems

 A list that contains the current configuration of one or more resources.
 


unprocessedResourceIdentifiers
SdkInternalList<T> unprocessedResourceIdentifiers

 A list of resource identifiers that were not processed with current scope. The list is empty if all the resources
 are processed.
 








Class com.amazonaws.services.config.model.BatchGetResourceConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceKeys
SdkInternalList<T> resourceKeys

 A list of resource keys to be processed with the current request. Each element in the list consists of the
 resource type and resource ID.
 








Class com.amazonaws.services.config.model.BatchGetResourceConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


baseConfigurationItems
SdkInternalList<T> baseConfigurationItems

 A list that contains the current configuration of one or more resources.
 


unprocessedResourceKeys
SdkInternalList<T> unprocessedResourceKeys

 A list of resource keys that were not processed with the current response. The unprocessesResourceKeys value is
 in the same form as ResourceKeys, so the value can be directly provided to a subsequent BatchGetResourceConfig
 operation. If there are no unprocessed resource keys, the response contains an empty unprocessedResourceKeys
 list.
 








Class com.amazonaws.services.config.model.Compliance extends Object implements Serializable


Serialized Fields


complianceType
String complianceType

 Indicates whether an AWS resource or AWS Config rule is compliant.
 
 
 A resource is compliant if it complies with all of the AWS Config rules that evaluate it. A resource 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. A rule 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 AWS Config rule.
 
 
 For the Compliance data type, AWS Config supports only COMPLIANT,
 NON_COMPLIANT, and INSUFFICIENT_DATA values. AWS Config does not support the
 NOT_APPLICABLE value for the Compliance data type.
 


complianceContributorCount
ComplianceContributorCount complianceContributorCount

 The number of AWS resources or AWS Config rules that cause a result of NON_COMPLIANT, up to a
 maximum number.
 








Class com.amazonaws.services.config.model.ComplianceByConfigRule extends Object implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule.
 


compliance
Compliance compliance

 Indicates whether the AWS Config rule is compliant.
 








Class com.amazonaws.services.config.model.ComplianceByResource extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of the AWS resource that was evaluated.
 


resourceId
String resourceId

 The ID of the AWS resource that was evaluated.
 


compliance
Compliance compliance

 Indicates whether the AWS resource complies with all of the AWS Config rules that evaluated it.
 








Class com.amazonaws.services.config.model.ComplianceContributorCount extends Object implements Serializable


Serialized Fields


cappedCount
Integer cappedCount

 The number of AWS resources or AWS Config rules responsible for the current compliance of the item.
 


capExceeded
Boolean capExceeded

 Indicates whether the maximum count is reached.
 








Class com.amazonaws.services.config.model.ComplianceSummary extends Object implements Serializable


Serialized Fields


compliantResourceCount
ComplianceContributorCount compliantResourceCount

 The number of AWS Config rules or AWS resources that are compliant, up to a maximum of 25 for rules and 100 for
 resources.
 


nonCompliantResourceCount
ComplianceContributorCount nonCompliantResourceCount

 The number of AWS Config rules or AWS resources that are noncompliant, up to a maximum of 25 for rules and 100
 for resources.
 


complianceSummaryTimestamp
Date complianceSummaryTimestamp

 The time that AWS Config created the compliance summary.
 








Class com.amazonaws.services.config.model.ComplianceSummaryByResourceType extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of AWS resource.
 


complianceSummary
ComplianceSummary complianceSummary

 The number of AWS resources that are compliant or noncompliant, up to a maximum of 100 for each.
 








Class com.amazonaws.services.config.model.ConfigExportDeliveryInfo extends Object implements Serializable


Serialized Fields


lastStatus
String lastStatus

 Status of the last attempted delivery.
 


lastErrorCode
String lastErrorCode

 The error code from the last attempted delivery.
 


lastErrorMessage
String lastErrorMessage

 The error message from the last attempted delivery.
 


lastAttemptTime
Date lastAttemptTime

 The time of the last attempted delivery.
 


lastSuccessfulTime
Date lastSuccessfulTime

 The time of the last successful delivery.
 


nextDeliveryTime
Date nextDeliveryTime

 The time that the next delivery occurs.
 








Class com.amazonaws.services.config.model.ConfigRule extends Object implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.
 


configRuleArn
String configRuleArn

 The Amazon Resource Name (ARN) of the AWS Config rule.
 


configRuleId
String configRuleId

 The ID of the AWS Config rule.
 


description
String description

 The description that you provide for the AWS Config rule.
 


scope
Scope scope

 Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types,
 a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope
 to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope,
 evaluations are triggered when any resource in the recording group changes.
 


source
Source source

 Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to
 evaluate your AWS resources.
 


inputParameters
String inputParameters

 A string, in JSON format, that is passed to the AWS Config rule Lambda function.
 


maximumExecutionFrequency
String maximumExecutionFrequency

 The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for
 MaximumExecutionFrequency when:
 
 
 
 
 You are using an AWS managed rule that is triggered at a periodic frequency.
 
 
 
 
 Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see
 ConfigSnapshotDeliveryProperties.
 
 
 
 
 
 By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
 value for the MaximumExecutionFrequency parameter.
 
 


configRuleState
String configRuleState

 Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate
 the evaluation status for the AWS Config rule.
 
 
 AWS Config sets the state of the rule to EVALUATING temporarily after you use the
 StartConfigRulesEvaluation request to evaluate your resources against the AWS Config rule.
 
 
 AWS Config sets the state of the rule to DELETING_RESULTS temporarily after you use the
 DeleteEvaluationResults request to delete the current evaluation results for the AWS Config rule.
 
 
 AWS Config temporarily sets the state of a rule to DELETING after you use the
 DeleteConfigRule request to delete the rule. After AWS Config deletes the rule, the rule and all of
 its evaluations are erased and are no longer available.
 


createdBy
String createdBy

 Service principal name of the service that created the rule.
 
 
 
 The field is populated only if the service linked rule is created by a service. The field is empty if you create
 your own rule.
 
 








Class com.amazonaws.services.config.model.ConfigRuleComplianceFilters extends Object implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule.
 


complianceType
String complianceType

 The rule compliance status.
 
 
 For the ConfigRuleComplianceFilters data type, AWS Config supports only COMPLIANT and
 NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and the
 INSUFFICIENT_DATA values.
 


accountId
String accountId

 The 12-digit account ID of the source account.
 


awsRegion
String awsRegion

 The source region where the data is aggregated.
 








Class com.amazonaws.services.config.model.ConfigRuleComplianceSummaryFilters extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The 12-digit account ID of the source account.
 


awsRegion
String awsRegion

 The source region where the data is aggregated.
 








Class com.amazonaws.services.config.model.ConfigRuleEvaluationStatus extends Object implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule.
 


configRuleArn
String configRuleArn

 The Amazon Resource Name (ARN) of the AWS Config rule.
 


configRuleId
String configRuleId

 The ID of the AWS Config rule.
 


lastSuccessfulInvocationTime
Date lastSuccessfulInvocationTime

 The time that AWS Config last successfully invoked the AWS Config rule to evaluate your AWS resources.
 


lastFailedInvocationTime
Date lastFailedInvocationTime

 The time that AWS Config last failed to invoke the AWS Config rule to evaluate your AWS resources.
 


lastSuccessfulEvaluationTime
Date lastSuccessfulEvaluationTime

 The time that AWS Config last successfully evaluated your AWS resources against the rule.
 


lastFailedEvaluationTime
Date lastFailedEvaluationTime

 The time that AWS Config last failed to evaluate your AWS resources against the rule.
 


firstActivatedTime
Date firstActivatedTime

 The time that you first activated the AWS Config rule.
 


lastErrorCode
String lastErrorCode

 The error code that AWS Config returned when the rule last failed.
 


lastErrorMessage
String lastErrorMessage

 The error message that AWS Config returned when the rule last failed.
 


firstEvaluationStarted
Boolean firstEvaluationStarted

 Indicates whether AWS Config has evaluated your resources against the rule at least once.
 
 
 
 
 true - AWS Config has evaluated your AWS resources against the rule at least once.
 
 
 
 
 false - AWS Config has not once finished evaluating your AWS resources against the rule.
 
 
 








Class com.amazonaws.services.config.model.ConfigSnapshotDeliveryProperties extends Object implements Serializable


Serialized Fields


deliveryFrequency
String deliveryFrequency

 The frequency with which AWS Config delivers configuration snapshots.
 








Class com.amazonaws.services.config.model.ConfigStreamDeliveryInfo extends Object implements Serializable


Serialized Fields


lastStatus
String lastStatus

 Status of the last attempted delivery.
 
 
 Note Providing an SNS topic on a DeliveryChannel for
 AWS Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable.
 


lastErrorCode
String lastErrorCode

 The error code from the last attempted delivery.
 


lastErrorMessage
String lastErrorMessage

 The error message from the last attempted delivery.
 


lastStatusChangeTime
Date lastStatusChangeTime

 The time from the last status change.
 








Class com.amazonaws.services.config.model.ConfigurationAggregator extends Object implements Serializable


Serialized Fields


configurationAggregatorName
String configurationAggregatorName

 The name of the aggregator.
 


configurationAggregatorArn
String configurationAggregatorArn

 The Amazon Resource Name (ARN) of the aggregator.
 


accountAggregationSources
SdkInternalList<T> accountAggregationSources

 Provides a list of source accounts and regions to be aggregated.
 


organizationAggregationSource
OrganizationAggregationSource organizationAggregationSource

 Provides an organization and list of regions to be aggregated.
 


creationTime
Date creationTime

 The time stamp when the configuration aggregator was created.
 


lastUpdatedTime
Date lastUpdatedTime

 The time of the last update.
 








Class com.amazonaws.services.config.model.ConfigurationItem extends Object implements Serializable


Serialized Fields


version
String version

 The version number of the resource configuration.
 


accountId
String accountId

 The 12-digit AWS account ID associated with the resource.
 


configurationItemCaptureTime
Date configurationItemCaptureTime

 The time when the configuration recording was initiated.
 


configurationItemStatus
String configurationItemStatus

 The configuration item status.
 


configurationStateId
String configurationStateId

 An identifier that indicates the ordering of the configuration items of a resource.
 


configurationItemMD5Hash
String configurationItemMD5Hash

 Unique MD5 hash that represents the configuration item's state.
 
 
 You can use MD5 hash to compare the states of two or more configuration items that are associated with the same
 resource.
 


arn
String arn

 accoun
 


resourceType
String resourceType

 The type of AWS resource.
 


resourceId
String resourceId

 The ID of the resource (for example, sg-xxxxxx).
 


resourceName
String resourceName

 The custom name of the resource, if available.
 


awsRegion
String awsRegion

 The region where the resource resides.
 


availabilityZone
String availabilityZone

 The Availability Zone associated with the resource.
 


resourceCreationTime
Date resourceCreationTime

 The time stamp when the resource was created.
 


tags
Map<K,V> tags

 A mapping of key value tags associated with the resource.
 


relatedEvents
SdkInternalList<T> relatedEvents

 A list of CloudTrail event IDs.
 
 
 A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail
 log. For more information about CloudTrail, see What Is AWS
 CloudTrail.
 
 
 An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the
 relatedEvents field is empty. You can access the LookupEvents API
 in the AWS CloudTrail API Reference to retrieve the events for the resource.
 


relationships
SdkInternalList<T> relationships

 A list of related AWS resources.
 


configuration
String configuration

 The description of the resource configuration.
 


supplementaryConfiguration
Map<K,V> supplementaryConfiguration

 Configuration attributes that AWS Config returns for certain resource types to supplement the information
 returned for the configuration parameter.
 








Class com.amazonaws.services.config.model.ConfigurationRecorder extends Object implements Serializable


Serialized Fields


name
String name

 The name of the recorder. By default, AWS Config automatically assigns the name "default" when creating the
 configuration recorder. You cannot change the assigned name.
 


roleARN
String roleARN

 Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.
 


recordingGroup
RecordingGroup recordingGroup

 Specifies the types of AWS resources for which AWS Config records configuration changes.
 








Class com.amazonaws.services.config.model.ConfigurationRecorderStatus extends Object implements Serializable


Serialized Fields


name
String name

 The name of the configuration recorder.
 


lastStartTime
Date lastStartTime

 The time the recorder was last started.
 


lastStopTime
Date lastStopTime

 The time the recorder was last stopped.
 


recording
Boolean recording

 Specifies whether or not the recorder is currently recording.
 


lastStatus
String lastStatus

 The last (previous) status of the recorder.
 


lastErrorCode
String lastErrorCode

 The error code indicating that the recording failed.
 


lastErrorMessage
String lastErrorMessage

 The message indicating that the recording failed due to an error.
 


lastStatusChangeTime
Date lastStatusChangeTime

 The time when the status was last changed.
 








Class com.amazonaws.services.config.model.ConformancePackComplianceFilters extends Object implements Serializable


Serialized Fields


configRuleNames
SdkInternalList<T> configRuleNames

 Filters the results by AWS Config rule names.
 


complianceType
String complianceType

 Filters the results by compliance.
 
 
 The allowed values are COMPLIANT and NON_COMPLIANT.
 








Class com.amazonaws.services.config.model.ConformancePackComplianceSummary extends Object implements Serializable


Serialized Fields


conformancePackName
String conformancePackName

 The name of the conformance pack name.
 


conformancePackComplianceStatus
String conformancePackComplianceStatus

 The status of the conformance pack. The allowed values are COMPLIANT and NON_COMPLIANT.
 








Class com.amazonaws.services.config.model.ConformancePackDetail extends Object implements Serializable


Serialized Fields


conformancePackName
String conformancePackName

 Name of the conformance pack.
 


conformancePackArn
String conformancePackArn

 Amazon Resource Name (ARN) of the conformance pack.
 


conformancePackId
String conformancePackId

 ID of the conformance pack.
 


deliveryS3Bucket
String deliveryS3Bucket

 Conformance pack template that is used to create a pack. The delivery bucket name should start with
 awsconfigconforms. For example: "Resource": "arn:aws:s3:::your_bucket_name/*".
 


deliveryS3KeyPrefix
String deliveryS3KeyPrefix

 The prefix for the Amazon S3 bucket.
 


conformancePackInputParameters
SdkInternalList<T> conformancePackInputParameters

 A list of ConformancePackInputParameter objects.
 


lastUpdateRequestedTime
Date lastUpdateRequestedTime

 Last time when conformation pack update was requested.
 


createdBy
String createdBy

 AWS service that created the conformance pack.
 








Class com.amazonaws.services.config.model.ConformancePackEvaluationFilters extends Object implements Serializable


Serialized Fields


configRuleNames
SdkInternalList<T> configRuleNames

 Filters the results by AWS Config rule names.
 


complianceType
String complianceType

 Filters the results by compliance.
 
 
 The allowed values are COMPLIANT and NON_COMPLIANT.
 


resourceType
String resourceType

 Filters the results by the resource type (for example, "AWS::EC2::Instance").
 


resourceIds
SdkInternalList<T> resourceIds

 Filters the results by resource IDs.
 
 
 
 This is valid only when you provide resource type. If there is no resource type, you will see an error.
 
 








Class com.amazonaws.services.config.model.ConformancePackEvaluationResult extends Object implements Serializable


Serialized Fields


complianceType
String complianceType

 The compliance type. The allowed values are COMPLIANT and NON_COMPLIANT.
 


evaluationResultIdentifier
EvaluationResultIdentifier evaluationResultIdentifier


configRuleInvokedTime
Date configRuleInvokedTime

 The time when AWS Config rule evaluated AWS resource.
 


resultRecordedTime
Date resultRecordedTime

 The time when AWS Config recorded the evaluation result.
 


annotation
String annotation

 Supplementary information about how the evaluation determined the compliance.
 








Class com.amazonaws.services.config.model.ConformancePackInputParameter extends Object implements Serializable


Serialized Fields


parameterName
String parameterName

 One part of a key-value pair.
 


parameterValue
String parameterValue

 Another part of the key-value pair.
 








Class com.amazonaws.services.config.model.ConformancePackRuleCompliance extends Object implements Serializable


Serialized Fields


configRuleName
String configRuleName

 Name of the config rule.
 


complianceType
String complianceType

 Compliance of the AWS Config rule
 
 
 The allowed values are COMPLIANT and NON_COMPLIANT.
 








Class com.amazonaws.services.config.model.ConformancePackStatusDetail extends Object implements Serializable


Serialized Fields


conformancePackName
String conformancePackName

 Name of the conformance pack.
 


conformancePackId
String conformancePackId

 ID of the conformance pack.
 


conformancePackArn
String conformancePackArn

 Amazon Resource Name (ARN) of comformance pack.
 


conformancePackState
String conformancePackState

 Indicates deployment status of conformance pack.
 
 
 AWS Config sets the state of the conformance pack to:
 
 
 
 
 CREATE_IN_PROGRESS when a conformance pack creation is in progress for an account.
 
 
 
 
 CREATE_COMPLETE when a conformance pack has been successfully created in your account.
 
 
 
 
 CREATE_FAILED when a conformance pack creation failed in your account.
 
 
 
 
 DELETE_IN_PROGRESS when a conformance pack deletion is in progress.
 
 
 
 
 DELETE_FAILED when a conformance pack deletion failed in your account.
 
 
 


stackArn
String stackArn

 Amazon Resource Name (ARN) of AWS CloudFormation stack.
 


conformancePackStatusReason
String conformancePackStatusReason

 The reason of conformance pack creation failure.
 


lastUpdateRequestedTime
Date lastUpdateRequestedTime

 Last time when conformation pack creation and update was requested.
 


lastUpdateCompletedTime
Date lastUpdateCompletedTime

 Last time when conformation pack creation and update was successful.
 








Class com.amazonaws.services.config.model.ConformancePackTemplateValidationException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.DeleteAggregationAuthorizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


authorizedAccountId
String authorizedAccountId

 The 12-digit account ID of the account authorized to aggregate data.
 


authorizedAwsRegion
String authorizedAwsRegion

 The region authorized to collect aggregated data.
 








Class com.amazonaws.services.config.model.DeleteAggregationAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeleteConfigRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule that you want to delete.
 








Class com.amazonaws.services.config.model.DeleteConfigRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeleteConfigurationAggregatorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationAggregatorName
String configurationAggregatorName

 The name of the configuration aggregator.
 








Class com.amazonaws.services.config.model.DeleteConfigurationAggregatorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeleteConfigurationRecorderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationRecorderName
String configurationRecorderName

 The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by
 using the DescribeConfigurationRecorders action.
 








Class com.amazonaws.services.config.model.DeleteConfigurationRecorderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeleteConformancePackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


conformancePackName
String conformancePackName

 Name of the conformance pack you want to delete.
 








Class com.amazonaws.services.config.model.DeleteConformancePackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeleteDeliveryChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryChannelName
String deliveryChannelName

 The name of the delivery channel to delete.
 








Class com.amazonaws.services.config.model.DeleteDeliveryChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeleteEvaluationResultsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule for which you want to delete the evaluation results.
 








Class com.amazonaws.services.config.model.DeleteEvaluationResultsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeleteOrganizationConfigRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationConfigRuleName
String organizationConfigRuleName

 The name of organization config rule that you want to delete.
 








Class com.amazonaws.services.config.model.DeleteOrganizationConfigRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeleteOrganizationConformancePackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationConformancePackName
String organizationConformancePackName

 The name of organization conformance pack that you want to delete.
 








Class com.amazonaws.services.config.model.DeleteOrganizationConformancePackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeletePendingAggregationRequestRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


requesterAccountId
String requesterAccountId

 The 12-digit account ID of the account requesting to aggregate data.
 


requesterAwsRegion
String requesterAwsRegion

 The region requesting to aggregate data.
 








Class com.amazonaws.services.config.model.DeletePendingAggregationRequestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeleteRemediationConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule for which you want to delete remediation configuration.
 


resourceType
String resourceType

 The type of a resource.
 








Class com.amazonaws.services.config.model.DeleteRemediationConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeleteRemediationExceptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule for which you want to delete remediation exception configuration.
 


resourceKeys
SdkInternalList<T> resourceKeys

 An exception list of resource exception keys to be processed with the current request. AWS Config adds exception
 for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.
 








Class com.amazonaws.services.config.model.DeleteRemediationExceptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedBatches
SdkInternalList<T> failedBatches

 Returns a list of failed delete remediation exceptions batch objects. Each object in the batch consists of a list
 of failed items and failure messages.
 








Class com.amazonaws.services.config.model.DeleteResourceConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of the resource.
 


resourceId
String resourceId

 Unique identifier of the resource.
 








Class com.amazonaws.services.config.model.DeleteResourceConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeleteRetentionConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


retentionConfigurationName
String retentionConfigurationName

 The name of the retention configuration to delete.
 








Class com.amazonaws.services.config.model.DeleteRetentionConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.DeliverConfigSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryChannelName
String deliveryChannelName

 The name of the delivery channel through which the snapshot is delivered.
 








Class com.amazonaws.services.config.model.DeliverConfigSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configSnapshotId
String configSnapshotId

 The ID of the snapshot that is being created.
 








Class com.amazonaws.services.config.model.DeliveryChannel extends Object implements Serializable


Serialized Fields


name
String name

 The name of the delivery channel. By default, AWS Config assigns the name "default" when creating the delivery
 channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your
 current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that
 has the desired name.
 


s3BucketName
String s3BucketName

 The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history
 files.
 
 
 If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access
 permissions to AWS Config. For more information, see Permissions for the Amazon
 S3 Bucket in the AWS Config Developer Guide.
 


s3KeyPrefix
String s3KeyPrefix

 The prefix for the specified Amazon S3 bucket.
 


snsTopicARN
String snsTopicARN

 The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about
 configuration changes.
 
 
 If you choose a topic from another account, the topic must have policies that grant access permissions to AWS
 Config. For more information, see Permissions for the Amazon
 SNS Topic in the AWS Config Developer Guide.
 


configSnapshotDeliveryProperties
ConfigSnapshotDeliveryProperties configSnapshotDeliveryProperties

 The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket.
 








Class com.amazonaws.services.config.model.DeliveryChannelStatus extends Object implements Serializable


Serialized Fields


name
String name

 The name of the delivery channel.
 


configSnapshotDeliveryInfo
ConfigExportDeliveryInfo configSnapshotDeliveryInfo

 A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.
 


configHistoryDeliveryInfo
ConfigExportDeliveryInfo configHistoryDeliveryInfo

 A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.
 


configStreamDeliveryInfo
ConfigStreamDeliveryInfo configStreamDeliveryInfo

 A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS
 topic.
 








Class com.amazonaws.services.config.model.DescribeAggregateComplianceByConfigRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationAggregatorName
String configurationAggregatorName

 The name of the configuration aggregator.
 


filters
ConfigRuleComplianceFilters filters

 Filters the results by ConfigRuleComplianceFilters object.
 


limit
Integer limit

 The maximum number of evaluation results returned on each page. The default is maximum. 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.DescribeAggregateComplianceByConfigRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


aggregateComplianceByConfigRules
SdkInternalList<T> aggregateComplianceByConfigRules

 Returns a list of AggregateComplianceByConfigRule object.
 


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.DescribeAggregationAuthorizationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


limit
Integer limit

 The maximum number of AggregationAuthorizations returned on each page. The default is maximum. 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.DescribeAggregationAuthorizationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


aggregationAuthorizations
SdkInternalList<T> aggregationAuthorizations

 Returns a list of authorizations granted to various aggregator accounts and regions.
 


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.DescribeComplianceByConfigRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleNames
SdkInternalList<T> configRuleNames

 Specify one or more AWS Config rule names to filter the results by rule.
 


complianceTypes
SdkInternalList<T> complianceTypes

 Filters the results by compliance.
 
 
 The allowed values are COMPLIANT and NON_COMPLIANT.
 


nextToken
String nextToken

 The nextToken string returned on a previous page that you use to get the next page of results in a
 paginated response.
 








Class com.amazonaws.services.config.model.DescribeComplianceByConfigRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


complianceByConfigRules
SdkInternalList<T> complianceByConfigRules

 Indicates whether each of the specified AWS Config rules is compliant.
 


nextToken
String nextToken

 The string that you use in a subsequent request to get the next page of results in a paginated response.
 








Class com.amazonaws.services.config.model.DescribeComplianceByResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceType
String resourceType

 The types of AWS resources for which you want compliance information (for example,
 AWS::EC2::Instance). For this action, you can specify that the resource type is an AWS account by
 specifying AWS::::Account.
 


resourceId
String resourceId

 The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If
 you specify a resource ID, you must also specify a type for ResourceType.
 


complianceTypes
SdkInternalList<T> complianceTypes

 Filters the results by compliance.
 
 
 The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.
 


limit
Integer limit

 The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number
 greater than 100. If you specify 0, AWS Config uses the default.
 


nextToken
String nextToken

 The nextToken string returned on a previous page that you use to get the next page of results in a
 paginated response.
 








Class com.amazonaws.services.config.model.DescribeComplianceByResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


complianceByResources
SdkInternalList<T> complianceByResources

 Indicates whether the specified AWS resource complies with all of the AWS Config rules that evaluate it.
 


nextToken
String nextToken

 The string that you use in a subsequent request to get the next page of results in a paginated response.
 








Class com.amazonaws.services.config.model.DescribeConfigRuleEvaluationStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleNames
SdkInternalList<T> configRuleNames

 The name of the AWS managed Config rules for which you want status information. If you do not specify any names,
 AWS Config returns status information for all AWS managed Config rules that you use.
 


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.
 


limit
Integer limit

 The number of rule evaluation results that you want returned.
 
 
 This parameter is required if the rule limit for your account is more than the default of 150 rules.
 
 
 For information about requesting a rule limit increase, see AWS Config Limits
 in the AWS General Reference Guide.
 








Class com.amazonaws.services.config.model.DescribeConfigRuleEvaluationStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configRulesEvaluationStatus
SdkInternalList<T> configRulesEvaluationStatus

 Status information about your AWS managed 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.DescribeConfigRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleNames
SdkInternalList<T> configRuleNames

 The names of the AWS Config rules for which you want details. If you do not specify any names, AWS Config returns
 details for all your rules.
 


nextToken
String nextToken

 The nextToken string returned on a previous page that you use to get the next page of results in a
 paginated response.
 








Class com.amazonaws.services.config.model.DescribeConfigRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configRules
SdkInternalList<T> configRules

 The details about your AWS Config rules.
 


nextToken
String nextToken

 The string that you use in a subsequent request to get the next page of results in a paginated response.
 








Class com.amazonaws.services.config.model.DescribeConfigurationAggregatorSourcesStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationAggregatorName
String configurationAggregatorName

 The name of the configuration aggregator.
 


updateStatus
SdkInternalList<T> updateStatus

 Filters the status type.
 
 
 
 
 Valid value FAILED indicates errors while moving data.
 
 
 
 
 Valid value SUCCEEDED indicates the data was successfully moved.
 
 
 
 
 Valid value OUTDATED indicates the data is not the most recent.
 
 
 


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.
 


limit
Integer limit

 The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, AWS
 Config uses the default.
 








Class com.amazonaws.services.config.model.DescribeConfigurationAggregatorSourcesStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


aggregatedSourceStatusList
SdkInternalList<T> aggregatedSourceStatusList

 Returns an AggregatedSourceStatus object.
 


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.DescribeConfigurationAggregatorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationAggregatorNames
SdkInternalList<T> configurationAggregatorNames

 The name of the configuration aggregators.
 


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.
 


limit
Integer limit

 The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0,
 AWS Config uses the default.
 








Class com.amazonaws.services.config.model.DescribeConfigurationAggregatorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurationAggregators
SdkInternalList<T> configurationAggregators

 Returns a ConfigurationAggregators object.
 


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.DescribeConfigurationRecordersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationRecorderNames
SdkInternalList<T> configurationRecorderNames

 A list of configuration recorder names.
 








Class com.amazonaws.services.config.model.DescribeConfigurationRecordersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurationRecorders
SdkInternalList<T> configurationRecorders

 A list that contains the descriptions of the specified configuration recorders.
 








Class com.amazonaws.services.config.model.DescribeConfigurationRecorderStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationRecorderNames
SdkInternalList<T> configurationRecorderNames

 The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of
 all the configuration recorders associated with the account.
 








Class com.amazonaws.services.config.model.DescribeConfigurationRecorderStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurationRecordersStatus
SdkInternalList<T> configurationRecordersStatus

 A list that contains status of the specified recorders.
 








Class com.amazonaws.services.config.model.DescribeConformancePackComplianceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


conformancePackName
String conformancePackName

 Name of the conformance pack.
 


filters
ConformancePackComplianceFilters filters

 A ConformancePackComplianceFilters object.
 


limit
Integer limit

 The maximum number of AWS Config rules within a conformance pack are returned on each page.
 


nextToken
String nextToken

 The nextToken string returned in a previous request that you use to request the next page of results
 in a paginated response.
 








Class com.amazonaws.services.config.model.DescribeConformancePackComplianceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


conformancePackName
String conformancePackName

 Name of the conformance pack.
 


conformancePackRuleComplianceList
SdkInternalList<T> conformancePackRuleComplianceList

 Returns a list of ConformancePackRuleCompliance objects.
 


nextToken
String nextToken

 The nextToken string returned in a previous request that you use to request the next page of results
 in a paginated response.
 








Class com.amazonaws.services.config.model.DescribeConformancePacksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


conformancePackNames
SdkInternalList<T> conformancePackNames

 Comma-separated list of conformance pack names for which you want details. If you do not specify any names, AWS
 Config returns details for all your conformance packs.
 


limit
Integer limit

 The maximum number of conformance packs returned on each page.
 


nextToken
String nextToken

 The nextToken string returned in a previous request that you use to request the next page of results
 in a paginated response.
 








Class com.amazonaws.services.config.model.DescribeConformancePacksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


conformancePackDetails
SdkInternalList<T> conformancePackDetails

 Returns a list of ConformancePackDetail objects.
 


nextToken
String nextToken

 The nextToken string returned in a previous request that you use to request the next page of results
 in a paginated response.
 








Class com.amazonaws.services.config.model.DescribeConformancePackStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


conformancePackNames
SdkInternalList<T> conformancePackNames

 Comma-separated list of conformance pack names.
 


limit
Integer limit

 The maximum number of conformance packs status returned on each page.
 


nextToken
String nextToken

 The nextToken string returned in a previous request that you use to request the next page of results
 in a paginated response.
 








Class com.amazonaws.services.config.model.DescribeConformancePackStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


conformancePackStatusDetails
SdkInternalList<T> conformancePackStatusDetails

 A list of ConformancePackStatusDetail objects.
 


nextToken
String nextToken

 The nextToken string returned in a previous request that you use to request the next page of results
 in a paginated response.
 








Class com.amazonaws.services.config.model.DescribeDeliveryChannelsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryChannelNames
SdkInternalList<T> deliveryChannelNames

 A list of delivery channel names.
 








Class com.amazonaws.services.config.model.DescribeDeliveryChannelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deliveryChannels
SdkInternalList<T> deliveryChannels

 A list that contains the descriptions of the specified delivery channel.
 








Class com.amazonaws.services.config.model.DescribeDeliveryChannelStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryChannelNames
SdkInternalList<T> deliveryChannelNames

 A list of delivery channel names.
 








Class com.amazonaws.services.config.model.DescribeDeliveryChannelStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deliveryChannelsStatus
SdkInternalList<T> deliveryChannelsStatus

 A list that contains the status of a specified delivery channel.
 








Class com.amazonaws.services.config.model.DescribeOrganizationConfigRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationConfigRuleNames
SdkInternalList<T> organizationConfigRuleNames

 The names of organization config rules for which you want details. If you do not specify any names, AWS Config
 returns details for all your organization config rules.
 


limit
Integer limit

 The maximum number of organization config rules returned on each page. If you do no specify a number, AWS Config
 uses the default. The default is 100.
 


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.DescribeOrganizationConfigRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organizationConfigRules
SdkInternalList<T> organizationConfigRules

 Returns a list of OrganizationConfigRule objects.
 


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.DescribeOrganizationConfigRuleStatusesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationConfigRuleNames
SdkInternalList<T> organizationConfigRuleNames

 The names of organization config rules for which you want status details. If you do not specify any names, AWS
 Config returns details for all your organization AWS Confg rules.
 


limit
Integer limit

 The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no specify a
 number, AWS Config uses the default. The default is 100.
 


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.DescribeOrganizationConfigRuleStatusesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organizationConfigRuleStatuses
SdkInternalList<T> organizationConfigRuleStatuses

 A list of OrganizationConfigRuleStatus objects.
 


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.DescribeOrganizationConformancePacksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationConformancePackNames
SdkInternalList<T> organizationConformancePackNames

 The name that you assign to an organization conformance pack.
 


limit
Integer limit

 The maximum number of organization config packs returned on each page. If you do no specify a number, AWS Config
 uses the default. The default is 100.
 


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.DescribeOrganizationConformancePacksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organizationConformancePacks
SdkInternalList<T> organizationConformancePacks

 Returns a list of OrganizationConformancePacks objects.
 


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.DescribeOrganizationConformancePackStatusesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationConformancePackNames
SdkInternalList<T> organizationConformancePackNames

 The names of organization conformance packs for which you want status details. If you do not specify any names,
 AWS Config returns details for all your organization conformance packs.
 


limit
Integer limit

 The maximum number of OrganizationConformancePackStatuses returned on each page. If you do no specify a number,
 AWS Config uses the default. The default is 100.
 


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.DescribeOrganizationConformancePackStatusesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organizationConformancePackStatuses
SdkInternalList<T> organizationConformancePackStatuses

 A list of OrganizationConformancePackStatus objects.
 


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.DescribePendingAggregationRequestsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


limit
Integer limit

 The maximum number of evaluation results returned on each page. The default is maximum. 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.DescribePendingAggregationRequestsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pendingAggregationRequests
SdkInternalList<T> pendingAggregationRequests

 Returns a PendingAggregationRequests object.
 


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.DescribeRemediationConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleNames
SdkInternalList<T> configRuleNames

 A list of AWS Config rule names of remediation configurations for which you want details.
 








Class com.amazonaws.services.config.model.DescribeRemediationConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


remediationConfigurations
SdkInternalList<T> remediationConfigurations

 Returns a remediation configuration object.
 








Class com.amazonaws.services.config.model.DescribeRemediationExceptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule.
 


resourceKeys
SdkInternalList<T> resourceKeys

 An exception list of resource exception keys to be processed with the current request. AWS Config adds exception
 for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.
 


limit
Integer limit

 The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0,
 AWS Config uses the default.
 


nextToken
String nextToken

 The nextToken string returned in a previous request that you use to request the next page of results
 in a paginated response.
 








Class com.amazonaws.services.config.model.DescribeRemediationExceptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


remediationExceptions
SdkInternalList<T> remediationExceptions

 Returns a list of remediation exception objects.
 


nextToken
String nextToken

 The nextToken string returned in a previous request that you use to request the next page of results
 in a paginated response.
 








Class com.amazonaws.services.config.model.DescribeRemediationExecutionStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleName
String configRuleName

 A list of AWS Config rule names.
 


resourceKeys
SdkInternalList<T> resourceKeys

 A list of resource keys to be processed with the current request. Each element in the list consists of the
 resource type and resource ID.
 


limit
Integer limit

 The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. 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.DescribeRemediationExecutionStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


remediationExecutionStatuses
SdkInternalList<T> remediationExecutionStatuses

 Returns a list of remediation execution statuses objects.
 


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.DescribeRetentionConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


retentionConfigurationNames
SdkInternalList<T> retentionConfigurationNames

 A list of names of retention configurations for which you want details. If you do not specify a name, AWS Config
 returns details for all the retention configurations for that account.
 
 
 
 Currently, AWS Config supports only one retention configuration per region in your account.
 
 


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.DescribeRetentionConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


retentionConfigurations
SdkInternalList<T> retentionConfigurations

 Returns a retention configuration object.
 


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.Evaluation extends Object implements Serializable


Serialized Fields


complianceResourceType
String complianceResourceType

 The type of AWS resource that was evaluated.
 


complianceResourceId
String complianceResourceId

 The ID of the AWS resource that was evaluated.
 


complianceType
String complianceType

 Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.
 
 
 For the Evaluation data type, AWS Config supports only the COMPLIANT,
 NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the
 INSUFFICIENT_DATA value for this data type.
 
 
 Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType
 from a PutEvaluations request. For example, an AWS Lambda function for a custom AWS Config rule
 cannot pass an INSUFFICIENT_DATA value to AWS Config.
 


annotation
String annotation

 Supplementary information about how the evaluation determined the compliance.
 


orderingTimestamp
Date orderingTimestamp

 The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time
 indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations,
 the time indicates when AWS Config triggered the evaluation at the frequency that you specified (for example,
 every 24 hours).
 








Class com.amazonaws.services.config.model.EvaluationResult extends Object implements Serializable


Serialized Fields


evaluationResultIdentifier
EvaluationResultIdentifier evaluationResultIdentifier

 Uniquely identifies the evaluation result.
 


complianceType
String complianceType

 Indicates whether the AWS resource complies with the AWS Config rule that evaluated it.
 
 
 For the EvaluationResult data type, AWS Config supports only the COMPLIANT,
 NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the
 INSUFFICIENT_DATA value for the EvaluationResult data type.
 


resultRecordedTime
Date resultRecordedTime

 The time when AWS Config recorded the evaluation result.
 


configRuleInvokedTime
Date configRuleInvokedTime

 The time when the AWS Config rule evaluated the AWS resource.
 


annotation
String annotation

 Supplementary information about how the evaluation determined the compliance.
 


resultToken
String resultToken

 An encrypted token that associates an evaluation with an AWS Config rule. The token identifies the rule, the AWS
 resource being evaluated, and the event that triggered the evaluation.
 








Class com.amazonaws.services.config.model.EvaluationResultIdentifier extends Object implements Serializable


Serialized Fields


evaluationResultQualifier
EvaluationResultQualifier evaluationResultQualifier

 Identifies an AWS Config rule used to evaluate an AWS resource, and provides the type and ID of the evaluated
 resource.
 


orderingTimestamp
Date orderingTimestamp

 The time of the event that triggered the evaluation of your AWS resources. The time can indicate when AWS Config
 delivered a configuration item change notification, or it can indicate when AWS Config delivered the
 configuration snapshot, depending on which event triggered the evaluation.
 








Class com.amazonaws.services.config.model.EvaluationResultQualifier extends Object implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule that was used in the evaluation.
 


resourceType
String resourceType

 The type of AWS resource that was evaluated.
 


resourceId
String resourceId

 The ID of the evaluated AWS resource.
 








Class com.amazonaws.services.config.model.ExecutionControls extends Object implements Serializable


Serialized Fields


ssmControls
SsmControls ssmControls

 A SsmControls object.
 








Class com.amazonaws.services.config.model.FailedDeleteRemediationExceptionsBatch extends Object implements Serializable


Serialized Fields


failureMessage
String failureMessage

 Returns a failure message for delete remediation exception. For example, AWS Config creates an exception due to
 an internal error.
 


failedItems
SdkInternalList<T> failedItems

 Returns remediation exception resource key object of the failed items.
 








Class com.amazonaws.services.config.model.FailedRemediationBatch extends Object implements Serializable


Serialized Fields


failureMessage
String failureMessage

 Returns a failure message. For example, the resource is already compliant.
 


failedItems
SdkInternalList<T> failedItems

 Returns remediation configurations of the failed items.
 








Class com.amazonaws.services.config.model.FailedRemediationExceptionBatch extends Object implements Serializable


Serialized Fields


failureMessage
String failureMessage

 Returns a failure message. For example, the auto-remediation has failed.
 


failedItems
SdkInternalList<T> failedItems

 Returns remediation exception resource key object of the failed items.
 








Class com.amazonaws.services.config.model.FieldInfo extends Object implements Serializable


Serialized Fields


name
String name

 Name of the field.
 








Class com.amazonaws.services.config.model.GetAggregateComplianceDetailsByConfigRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationAggregatorName
String configurationAggregatorName

 The name of the configuration aggregator.
 


configRuleName
String configRuleName

 The name of the AWS Config rule for which you want compliance information.
 


accountId
String accountId

 The 12-digit account ID of the source account.
 


awsRegion
String awsRegion

 The source region from where the data is aggregated.
 


complianceType
String complianceType

 The resource compliance status.
 
 
 
 For the GetAggregateComplianceDetailsByConfigRuleRequest data type, AWS Config supports only the
 COMPLIANT and NON_COMPLIANT. AWS Config does not support the
 NOT_APPLICABLE and INSUFFICIENT_DATA values.
 
 


limit
Integer limit

 The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number
 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.GetAggregateComplianceDetailsByConfigRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


aggregateEvaluationResults
SdkInternalList<T> aggregateEvaluationResults

 Returns an AggregateEvaluationResults object.
 


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.GetAggregateConfigRuleComplianceSummaryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationAggregatorName
String configurationAggregatorName

 The name of the configuration aggregator.
 


filters
ConfigRuleComplianceSummaryFilters filters

 Filters the results based on the ConfigRuleComplianceSummaryFilters object.
 


groupByKey
String groupByKey

 Groups the result based on ACCOUNT_ID or AWS_REGION.
 


limit
Integer limit

 The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number
 greater than 1000. 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.GetAggregateConfigRuleComplianceSummaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


groupByKey
String groupByKey

 Groups the result based on ACCOUNT_ID or AWS_REGION.
 


aggregateComplianceCounts
SdkInternalList<T> aggregateComplianceCounts

 Returns a list of AggregateComplianceCounts object.
 


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.GetAggregateDiscoveredResourceCountsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationAggregatorName
String configurationAggregatorName

 The name of the configuration aggregator.
 


filters
ResourceCountFilters filters

 Filters the results based on the ResourceCountFilters object.
 


groupByKey
String groupByKey

 The key to group the resource counts.
 


limit
Integer limit

 The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You cannot
 specify a number greater than 1000. 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.GetAggregateDiscoveredResourceCountsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


totalDiscoveredResources
Long totalDiscoveredResources

 The total number of resources that are present in an aggregator with the filters that you provide.
 


groupByKey
String groupByKey

 The key passed into the request object. If GroupByKey is not provided, the result will be empty.
 


groupedResourceCounts
SdkInternalList<T> groupedResourceCounts

 Returns a list of GroupedResourceCount objects.
 


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.GetAggregateResourceConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationAggregatorName
String configurationAggregatorName

 The name of the configuration aggregator.
 


resourceIdentifier
AggregateResourceIdentifier resourceIdentifier

 An object that identifies aggregate resource.
 








Class com.amazonaws.services.config.model.GetAggregateResourceConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurationItem
ConfigurationItem configurationItem

 Returns a ConfigurationItem object.
 








Class com.amazonaws.services.config.model.GetComplianceDetailsByConfigRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule for which you want compliance information.
 


complianceTypes
SdkInternalList<T> complianceTypes

 Filters the results by compliance.
 
 
 The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.
 


limit
Integer limit

 The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number
 greater than 100. If you specify 0, AWS Config uses the default.
 


nextToken
String nextToken

 The nextToken string returned on a previous page that you use to get the next page of results in a
 paginated response.
 








Class com.amazonaws.services.config.model.GetComplianceDetailsByConfigRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


evaluationResults
SdkInternalList<T> evaluationResults

 Indicates whether the AWS resource complies with the specified AWS Config rule.
 


nextToken
String nextToken

 The string that you use in a subsequent request to get the next page of results in a paginated response.
 








Class com.amazonaws.services.config.model.GetComplianceDetailsByResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of the AWS resource for which you want compliance information.
 


resourceId
String resourceId

 The ID of the AWS resource for which you want compliance information.
 


complianceTypes
SdkInternalList<T> complianceTypes

 Filters the results by compliance.
 
 
 The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.
 


nextToken
String nextToken

 The nextToken string returned on a previous page that you use to get the next page of results in a
 paginated response.
 








Class com.amazonaws.services.config.model.GetComplianceDetailsByResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


evaluationResults
SdkInternalList<T> evaluationResults

 Indicates whether the specified AWS resource complies each AWS Config rule.
 


nextToken
String nextToken

 The string that you use in a subsequent request to get the next page of results in a paginated response.
 








Class com.amazonaws.services.config.model.GetComplianceSummaryByConfigRuleRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.config.model.GetComplianceSummaryByConfigRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


complianceSummary
ComplianceSummary complianceSummary

 The number of AWS Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for
 each.
 








Class com.amazonaws.services.config.model.GetComplianceSummaryByResourceTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceTypes
SdkInternalList<T> resourceTypes

 Specify one or more resource types to get the number of resources that are compliant and the number that are
 noncompliant for each resource type.
 
 
 For this request, you can specify an AWS resource type such as AWS::EC2::Instance. You can specify
 that the resource type is an AWS account by specifying AWS::::Account.
 








Class com.amazonaws.services.config.model.GetComplianceSummaryByResourceTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


complianceSummariesByResourceType
SdkInternalList<T> complianceSummariesByResourceType

 The number of resources that are compliant and the number that are noncompliant. If one or more resource types
 were provided with the request, the numbers are returned for each resource type. The maximum number returned is
 100.
 








Class com.amazonaws.services.config.model.GetConformancePackComplianceDetailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


conformancePackName
String conformancePackName

 Name of the conformance pack.
 


filters
ConformancePackEvaluationFilters filters

 A ConformancePackEvaluationFilters object.
 


limit
Integer limit

 The maximum number of evaluation results returned on each page. If you do no specify a number, AWS Config uses
 the default. The default is 100.
 


nextToken
String nextToken

 The nextToken string returned in a previous request that you use to request the next page of results
 in a paginated response.
 








Class com.amazonaws.services.config.model.GetConformancePackComplianceDetailsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


conformancePackName
String conformancePackName

 Name of the conformance pack.
 


conformancePackRuleEvaluationResults
SdkInternalList<T> conformancePackRuleEvaluationResults

 Returns a list of ConformancePackEvaluationResult objects.
 


nextToken
String nextToken

 The nextToken string returned in a previous request that you use to request the next page of results
 in a paginated response.
 








Class com.amazonaws.services.config.model.GetConformancePackComplianceSummaryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


conformancePackNames
SdkInternalList<T> conformancePackNames

 Names of conformance packs.
 


limit
Integer limit

 The maximum number of conformance packs returned on each page.
 


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.GetConformancePackComplianceSummaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


conformancePackComplianceSummaryList
SdkInternalList<T> conformancePackComplianceSummaryList

 A list of ConformancePackComplianceSummary objects.
 


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.GetDiscoveredResourceCountsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceTypes
SdkInternalList<T> resourceTypes

 The comma-separated list that specifies the resource types that you want AWS Config to return (for example,
 "AWS::EC2::Instance", "AWS::IAM::User").
 
 
 If a value for resourceTypes is not specified, AWS Config returns all resource types that AWS Config
 is recording in the region for your account.
 
 
 
 If the configuration recorder is turned off, AWS Config returns an empty list of ResourceCount objects. If
 the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource
 type is not returned in the list of ResourceCount objects.
 
 


limit
Integer limit

 The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify
 a number 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.GetDiscoveredResourceCountsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


totalDiscoveredResources
Long totalDiscoveredResources

 The total number of resources that AWS Config is recording in the region for your account. If you specify
 resource types in the request, AWS Config returns only the total number of resources for those resource types.
 
 
 Example
 
 
 
 
 AWS Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20
 IAM users, and 15 S3 buckets, for a total of 60 resources.
 
 
 
 
 You make a call to the GetDiscoveredResourceCounts action and specify the resource type,
 "AWS::EC2::Instances", in the request.
 
 
 
 
 AWS Config returns 25 for totalDiscoveredResources.
 
 
 


resourceCounts
SdkInternalList<T> resourceCounts

 The list of ResourceCount objects. Each object is listed in descending order by the number of
 resources.
 


nextToken
String nextToken

 The string that you use in a subsequent request to get the next page of results in a paginated response.
 








Class com.amazonaws.services.config.model.GetOrganizationConfigRuleDetailedStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationConfigRuleName
String organizationConfigRuleName

 The name of organization config rule for which you want status details for member accounts.
 


filters
StatusDetailFilters filters

 A StatusDetailFilters object.
 


limit
Integer limit

 The maximum number of OrganizationConfigRuleDetailedStatus returned on each page. If you do not
 specify a number, AWS Config uses the default. The default is 100.
 


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.GetOrganizationConfigRuleDetailedStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organizationConfigRuleDetailedStatus
SdkInternalList<T> organizationConfigRuleDetailedStatus

 A list of MemberAccountStatus objects.
 


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.GetOrganizationConformancePackDetailedStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationConformancePackName
String organizationConformancePackName

 The name of organization conformance pack for which you want status details for member accounts.
 


filters
OrganizationResourceDetailedStatusFilters filters

 An OrganizationResourceDetailedStatusFilters object.
 


limit
Integer limit

 The maximum number of OrganizationConformancePackDetailedStatuses returned on each page. If you do
 not specify a number, AWS Config uses the default. The default is 100.
 


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.GetOrganizationConformancePackDetailedStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organizationConformancePackDetailedStatuses
SdkInternalList<T> organizationConformancePackDetailedStatuses

 A list of OrganizationConformancePackDetailedStatus objects.
 


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.GetResourceConfigHistoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceType
String resourceType

 The resource type.
 


resourceId
String resourceId

 The ID of the resource (for example., sg-xxxxxx).
 


laterTime
Date laterTime

 The time stamp that indicates a later time. If not specified, current time is taken.
 


earlierTime
Date earlierTime

 The time stamp that indicates an earlier time. If not specified, the action returns paginated results that
 contain configuration items that start when the first configuration item was recorded.
 


chronologicalOrder
String chronologicalOrder

 The chronological order for configuration items listed. By default, the results are listed in reverse
 chronological order.
 


limit
Integer limit

 The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number
 greater than 100. If you specify 0, AWS Config uses the default.
 


nextToken
String nextToken

 The nextToken string returned on a previous page that you use to get the next page of results in a
 paginated response.
 








Class com.amazonaws.services.config.model.GetResourceConfigHistoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurationItems
SdkInternalList<T> configurationItems

 A list that contains the configuration history of one or more resources.
 


nextToken
String nextToken

 The string that you use in a subsequent request to get the next page of results in a paginated response.
 








Class com.amazonaws.services.config.model.GroupedResourceCount extends Object implements Serializable


Serialized Fields


groupName
String groupName

 The name of the group that can be region, account ID, or resource type. For example, region1, region2 if the
 region was chosen as GroupByKey.
 


resourceCount
Long resourceCount

 The number of resources in the group.
 








Class com.amazonaws.services.config.model.InsufficientDeliveryPolicyException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InsufficientPermissionsException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InvalidConfigurationRecorderNameException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InvalidDeliveryChannelNameException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InvalidExpressionException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InvalidLimitException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InvalidNextTokenException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InvalidParameterValueException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InvalidRecordingGroupException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InvalidResultTokenException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InvalidRoleException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InvalidS3KeyPrefixException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InvalidSNSTopicARNException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.InvalidTimeRangeException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.LastDeliveryChannelDeleteFailedException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.LimitExceededException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.ListAggregateDiscoveredResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationAggregatorName
String configurationAggregatorName

 The name of the configuration aggregator.
 


resourceType
String resourceType

 The type of resources that you want AWS Config to list in the response.
 


filters
ResourceFilters filters

 Filters the results based on the ResourceFilters object.
 


limit
Integer limit

 The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number
 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.ListAggregateDiscoveredResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceIdentifiers
SdkInternalList<T> resourceIdentifiers

 Returns a list of ResourceIdentifiers objects.
 


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.ListDiscoveredResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of resources that you want AWS Config to list in the response.
 


resourceIds
SdkInternalList<T> resourceIds

 The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this
 parameter, AWS Config lists all resources of the specified type that it has discovered.
 


resourceName
String resourceName

 The custom name of only those resources that you want AWS Config to list in the response. If you do not specify
 this parameter, AWS Config lists all resources of the specified type that it has discovered.
 


limit
Integer limit

 The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number
 greater than 100. If you specify 0, AWS Config uses the default.
 


includeDeletedResources
Boolean includeDeletedResources

 Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not
 included.
 


nextToken
String nextToken

 The nextToken string returned on a previous page that you use to get the next page of results in a
 paginated response.
 








Class com.amazonaws.services.config.model.ListDiscoveredResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceIdentifiers
SdkInternalList<T> resourceIdentifiers

 The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if
 available) the custom resource name.
 


nextToken
String nextToken

 The string that you use in a subsequent request to get the next page of results in a paginated response.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported
 resources are ConfigRule, ConfigurationAggregator and
 AggregatorAuthorization.
 


limit
Integer limit

 The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater
 than 50. 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.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 The tags for the resource.
 


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.MaxActiveResourcesExceededException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.MaxNumberOfConfigRulesExceededException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.MaxNumberOfConfigurationRecordersExceededException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.MaxNumberOfConformancePacksExceededException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.MaxNumberOfDeliveryChannelsExceededException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.MaxNumberOfOrganizationConfigRulesExceededException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.MaxNumberOfOrganizationConformancePacksExceededException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.MaxNumberOfRetentionConfigurationsExceededException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.MemberAccountStatus extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The 12-digit account ID of a member account.
 


configRuleName
String configRuleName

 The name of config rule deployed in the member account.
 


memberAccountRuleStatus
String memberAccountRuleStatus

 Indicates deployment status for config rule in the member account. When master account calls
 PutOrganizationConfigRule action for the first time, config rule status is created in the member
 account. When master account calls PutOrganizationConfigRule action for the second time, config rule
 status is updated in the member account. Config rule status is deleted when the master account deletes
 OrganizationConfigRule and disables service access for
 config-multiaccountsetup.amazonaws.com.
 
 
 AWS Config sets the state of the rule to:
 
 
 
 
 CREATE_SUCCESSFUL when config rule has been created in the member account.
 
 
 
 
 CREATE_IN_PROGRESS when config rule is being created in the member account.
 
 
 
 
 CREATE_FAILED when config rule creation has failed in the member account.
 
 
 
 
 DELETE_FAILED when config rule deletion has failed in the member account.
 
 
 
 
 DELETE_IN_PROGRESS when config rule is being deleted in the member account.
 
 
 
 
 DELETE_SUCCESSFUL when config rule has been deleted in the member account.
 
 
 
 
 UPDATE_SUCCESSFUL when config rule has been updated in the member account.
 
 
 
 
 UPDATE_IN_PROGRESS when config rule is being updated in the member account.
 
 
 
 
 UPDATE_FAILED when config rule deletion has failed in the member account.
 
 
 


errorCode
String errorCode

 An error code that is returned when config rule creation or deletion failed in the member account.
 


errorMessage
String errorMessage

 An error message indicating that config rule account creation or deletion has failed due to an error in the
 member account.
 


lastUpdateTime
Date lastUpdateTime

 The timestamp of the last status update.
 








Class com.amazonaws.services.config.model.NoAvailableConfigurationRecorderException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoAvailableDeliveryChannelException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoAvailableOrganizationException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoRunningConfigurationRecorderException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoSuchBucketException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoSuchConfigRuleException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoSuchConfigRuleInConformancePackException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoSuchConfigurationAggregatorException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoSuchConfigurationRecorderException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoSuchConformancePackException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoSuchDeliveryChannelException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoSuchOrganizationConfigRuleException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoSuchOrganizationConformancePackException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoSuchRemediationConfigurationException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoSuchRemediationExceptionException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.NoSuchRetentionConfigurationException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.OrganizationAccessDeniedException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.OrganizationAggregationSource extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 ARN of the IAM role used to retrieve AWS Organization details associated with the aggregator account.
 


awsRegions
SdkInternalList<T> awsRegions

 The source regions being aggregated.
 


allAwsRegions
Boolean allAwsRegions

 If true, aggregate existing AWS Config regions and future regions.
 








Class com.amazonaws.services.config.model.OrganizationAllFeaturesNotEnabledException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.OrganizationConfigRule extends Object implements Serializable


Serialized Fields


organizationConfigRuleName
String organizationConfigRuleName

 The name that you assign to organization config rule.
 


organizationConfigRuleArn
String organizationConfigRuleArn

 Amazon Resource Name (ARN) of organization config rule.
 


organizationManagedRuleMetadata
OrganizationManagedRuleMetadata organizationManagedRuleMetadata

 An OrganizationManagedRuleMetadata object.
 


organizationCustomRuleMetadata
OrganizationCustomRuleMetadata organizationCustomRuleMetadata

 An OrganizationCustomRuleMetadata object.
 


excludedAccounts
SdkInternalList<T> excludedAccounts

 A comma-separated list of accounts excluded from organization config rule.
 


lastUpdateTime
Date lastUpdateTime

 The timestamp of the last update.
 








Class com.amazonaws.services.config.model.OrganizationConfigRuleStatus extends Object implements Serializable


Serialized Fields


organizationConfigRuleName
String organizationConfigRuleName

 The name that you assign to organization config rule.
 


organizationRuleStatus
String organizationRuleStatus

 Indicates deployment status of an organization config rule. When master account calls PutOrganizationConfigRule
 action for the first time, config rule status is created in all the member accounts. When master account calls
 PutOrganizationConfigRule action for the second time, config rule status is updated in all the member accounts.
 Additionally, config rule status is updated when one or more member accounts join or leave an organization.
 Config rule status is deleted when the master account deletes OrganizationConfigRule in all the member accounts
 and disables service access for config-multiaccountsetup.amazonaws.com.
 
 
 AWS Config sets the state of the rule to:
 
 
 
 
 CREATE_SUCCESSFUL when an organization config rule has been successfully created in all the member
 accounts.
 
 
 
 
 CREATE_IN_PROGRESS when an organization config rule creation is in progress.
 
 
 
 
 CREATE_FAILED when an organization config rule creation failed in one or more member accounts within
 that organization.
 
 
 
 
 DELETE_FAILED when an organization config rule deletion failed in one or more member accounts within
 that organization.
 
 
 
 
 DELETE_IN_PROGRESS when an organization config rule deletion is in progress.
 
 
 
 
 DELETE_SUCCESSFUL when an organization config rule has been successfully deleted from all the member
 accounts.
 
 
 
 
 UPDATE_SUCCESSFUL when an organization config rule has been successfully updated in all the member
 accounts.
 
 
 
 
 UPDATE_IN_PROGRESS when an organization config rule update is in progress.
 
 
 
 
 UPDATE_FAILED when an organization config rule update failed in one or more member accounts within
 that organization.
 
 
 


errorCode
String errorCode

 An error code that is returned when organization config rule creation or deletion has failed.
 


errorMessage
String errorMessage

 An error message indicating that organization config rule creation or deletion failed due to an error.
 


lastUpdateTime
Date lastUpdateTime

 The timestamp of the last update.
 








Class com.amazonaws.services.config.model.OrganizationConformancePack extends Object implements Serializable


Serialized Fields


organizationConformancePackName
String organizationConformancePackName

 The name you assign to an organization conformance pack.
 


organizationConformancePackArn
String organizationConformancePackArn

 Amazon Resource Name (ARN) of organization conformance pack.
 


deliveryS3Bucket
String deliveryS3Bucket

 Location of an Amazon S3 bucket where AWS Config can deliver evaluation results and conformance pack template
 that is used to create a pack.
 


deliveryS3KeyPrefix
String deliveryS3KeyPrefix

 Any folder structure you want to add to an Amazon S3 bucket.
 


conformancePackInputParameters
SdkInternalList<T> conformancePackInputParameters

 A list of ConformancePackInputParameter objects.
 


excludedAccounts
SdkInternalList<T> excludedAccounts

 A comma-separated list of accounts excluded from organization conformance pack.
 


lastUpdateTime
Date lastUpdateTime

 Last time when organization conformation pack was updated.
 








Class com.amazonaws.services.config.model.OrganizationConformancePackDetailedStatus extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The 12-digit account ID of a member account.
 


conformancePackName
String conformancePackName

 The name of conformance pack deployed in the member account.
 


status
String status

 Indicates deployment status for conformance pack in a member account. When master account calls
 PutOrganizationConformancePack action for the first time, conformance pack status is created in the
 member account. When master account calls PutOrganizationConformancePack action for the second time,
 conformance pack status is updated in the member account. Conformance pack status is deleted when the master
 account deletes OrganizationConformancePack and disables service access for
 config-multiaccountsetup.amazonaws.com.
 
 
 AWS Config sets the state of the conformance pack to:
 
 
 
 
 CREATE_SUCCESSFUL when conformance pack has been created in the member account.
 
 
 
 
 CREATE_IN_PROGRESS when conformance pack is being created in the member account.
 
 
 
 
 CREATE_FAILED when conformance pack creation has failed in the member account.
 
 
 
 
 DELETE_FAILED when conformance pack deletion has failed in the member account.
 
 
 
 
 DELETE_IN_PROGRESS when conformance pack is being deleted in the member account.
 
 
 
 
 DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.
 
 
 
 
 UPDATE_SUCCESSFUL when conformance pack has been updated in the member account.
 
 
 
 
 UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.
 
 
 
 
 UPDATE_FAILED when conformance pack deletion has failed in the member account.
 
 
 


errorCode
String errorCode

 An error code that is returned when conformance pack creation or deletion failed in the member account.
 


errorMessage
String errorMessage

 An error message indicating that conformance pack account creation or deletion has failed due to an error in the
 member account.
 


lastUpdateTime
Date lastUpdateTime

 The timestamp of the last status update.
 








Class com.amazonaws.services.config.model.OrganizationConformancePackStatus extends Object implements Serializable


Serialized Fields


organizationConformancePackName
String organizationConformancePackName

 The name that you assign to organization conformance pack.
 


status
String status

 Indicates deployment status of an organization conformance pack. When master account calls
 PutOrganizationConformancePack for the first time, conformance pack status is created in all the member accounts.
 When master account calls PutOrganizationConformancePack for the second time, conformance pack status is updated
 in all the member accounts. Additionally, conformance pack status is updated when one or more member accounts
 join or leave an organization. Conformance pack status is deleted when the master account deletes
 OrganizationConformancePack in all the member accounts and disables service access for
 config-multiaccountsetup.amazonaws.com.
 
 
 AWS Config sets the state of the conformance pack to:
 
 
 
 
 CREATE_SUCCESSFUL when an organization conformance pack has been successfully created in all the
 member accounts.
 
 
 
 
 CREATE_IN_PROGRESS when an organization conformance pack creation is in progress.
 
 
 
 
 CREATE_FAILED when an organization conformance pack creation failed in one or more member accounts
 within that organization.
 
 
 
 
 DELETE_FAILED when an organization conformance pack deletion failed in one or more member accounts
 within that organization.
 
 
 
 
 DELETE_IN_PROGRESS when an organization conformance pack deletion is in progress.
 
 
 
 
 DELETE_SUCCESSFUL when an organization conformance pack has been successfully deleted from all the
 member accounts.
 
 
 
 
 UPDATE_SUCCESSFUL when an organization conformance pack has been successfully updated in all the
 member accounts.
 
 
 
 
 UPDATE_IN_PROGRESS when an organization conformance pack update is in progress.
 
 
 
 
 UPDATE_FAILED when an organization conformance pack update failed in one or more member accounts
 within that organization.
 
 
 


errorCode
String errorCode

 An error code that is returned when organization conformance pack creation or deletion has failed in a member
 account.
 


errorMessage
String errorMessage

 An error message indicating that organization conformance pack creation or deletion failed due to an error.
 


lastUpdateTime
Date lastUpdateTime

 The timestamp of the last update.
 








Class com.amazonaws.services.config.model.OrganizationConformancePackTemplateValidationException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.OrganizationCustomRuleMetadata extends Object implements Serializable


Serialized Fields


description
String description

 The description that you provide for organization config rule.
 


lambdaFunctionArn
String lambdaFunctionArn

 The lambda function ARN.
 


organizationConfigRuleTriggerTypes
SdkInternalList<T> organizationConfigRuleTriggerTypes

 The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following
 notification types:
 
 
 
 
 ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a
 configuration item as a result of a resource change.
 
 
 
 
 OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an
 oversized configuration item. AWS Config may generate this notification type when a resource changes and the
 notification exceeds the maximum size allowed by Amazon SNS.
 
 
 
 
 ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
 MaximumExecutionFrequency.
 
 
 


inputParameters
String inputParameters

 A string, in JSON format, that is passed to organization config rule Lambda function.
 


maximumExecutionFrequency
String maximumExecutionFrequency

 The maximum frequency with which AWS Config runs evaluations for a rule. Your custom rule is triggered when AWS
 Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
 
 
 
 By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
 value for the MaximumExecutionFrequency parameter.
 
 


resourceTypesScope
SdkInternalList<T> resourceTypesScope

 The type of the AWS resource that was evaluated.
 


resourceIdScope
String resourceIdScope

 The ID of the AWS resource that was evaluated.
 


tagKeyScope
String tagKeyScope

 One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more
 specific tag values.
 


tagValueScope
String tagValueScope

 The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category
 (key).
 








Class com.amazonaws.services.config.model.OrganizationManagedRuleMetadata extends Object implements Serializable


Serialized Fields


description
String description

 The description that you provide for organization config rule.
 


ruleIdentifier
String ruleIdentifier

 For organization config managed rules, a predefined identifier from a list. For example,
 IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using AWS
 Managed Config Rules.
 


inputParameters
String inputParameters

 A string, in JSON format, that is passed to organization config rule Lambda function.
 


maximumExecutionFrequency
String maximumExecutionFrequency

 The maximum frequency with which AWS Config runs evaluations for a rule. You are using an AWS managed rule that
 is triggered at a periodic frequency.
 
 
 
 By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
 value for the MaximumExecutionFrequency parameter.
 
 


resourceTypesScope
SdkInternalList<T> resourceTypesScope

 The type of the AWS resource that was evaluated.
 


resourceIdScope
String resourceIdScope

 The ID of the AWS resource that was evaluated.
 


tagKeyScope
String tagKeyScope

 One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more
 specific tag values.
 


tagValueScope
String tagValueScope

 The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category
 (key).
 








Class com.amazonaws.services.config.model.OrganizationResourceDetailedStatusFilters extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The 12-digit account ID of the member account within an organization.
 


status
String status

 Indicates deployment status for conformance pack in a member account. When master account calls
 PutOrganizationConformancePack action for the first time, conformance pack status is created in the
 member account. When master account calls PutOrganizationConformancePack action for the second time,
 conformance pack status is updated in the member account. Conformance pack status is deleted when the master
 account deletes OrganizationConformancePack and disables service access for
 config-multiaccountsetup.amazonaws.com.
 
 
 AWS Config sets the state of the conformance pack to:
 
 
 
 
 CREATE_SUCCESSFUL when conformance pack has been created in the member account.
 
 
 
 
 CREATE_IN_PROGRESS when conformance pack is being created in the member account.
 
 
 
 
 CREATE_FAILED when conformance pack creation has failed in the member account.
 
 
 
 
 DELETE_FAILED when conformance pack deletion has failed in the member account.
 
 
 
 
 DELETE_IN_PROGRESS when conformance pack is being deleted in the member account.
 
 
 
 
 DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.
 
 
 
 
 UPDATE_SUCCESSFUL when conformance pack has been updated in the member account.
 
 
 
 
 UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.
 
 
 
 
 UPDATE_FAILED when conformance pack deletion has failed in the member account.
 
 
 








Class com.amazonaws.services.config.model.OversizedConfigurationItemException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.PendingAggregationRequest extends Object implements Serializable


Serialized Fields


requesterAccountId
String requesterAccountId

 The 12-digit account ID of the account requesting to aggregate data.
 


requesterAwsRegion
String requesterAwsRegion

 The region requesting to aggregate data.
 








Class com.amazonaws.services.config.model.PutAggregationAuthorizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


authorizedAccountId
String authorizedAccountId

 The 12-digit account ID of the account authorized to aggregate data.
 


authorizedAwsRegion
String authorizedAwsRegion

 The region authorized to collect aggregated data.
 


tags
SdkInternalList<T> tags

 An array of tag object.
 








Class com.amazonaws.services.config.model.PutAggregationAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


aggregationAuthorization
AggregationAuthorization aggregationAuthorization

 Returns an AggregationAuthorization object.
 








Class com.amazonaws.services.config.model.PutConfigRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRule
ConfigRule configRule

 The rule that you want to add to your account.
 


tags
SdkInternalList<T> tags

 An array of tag object.
 








Class com.amazonaws.services.config.model.PutConfigRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.PutConfigurationAggregatorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationAggregatorName
String configurationAggregatorName

 The name of the configuration aggregator.
 


accountAggregationSources
SdkInternalList<T> accountAggregationSources

 A list of AccountAggregationSource object.
 


organizationAggregationSource
OrganizationAggregationSource organizationAggregationSource

 An OrganizationAggregationSource object.
 


tags
SdkInternalList<T> tags

 An array of tag object.
 








Class com.amazonaws.services.config.model.PutConfigurationAggregatorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurationAggregator
ConfigurationAggregator configurationAggregator

 Returns a ConfigurationAggregator object.
 








Class com.amazonaws.services.config.model.PutConfigurationRecorderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationRecorder
ConfigurationRecorder configurationRecorder

 The configuration recorder object that records each configuration change made to the resources.
 








Class com.amazonaws.services.config.model.PutConfigurationRecorderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.PutConformancePackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


conformancePackName
String conformancePackName

 Name of the conformance pack you want to create.
 


templateS3Uri
String templateS3Uri

 Location of file containing the template body (s3://bucketname/prefix). The uri must point to the
 conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same region as the
 conformance pack.
 
 
 
 You must have access to read Amazon S3 bucket.
 
 


templateBody
String templateBody

 A string containing full conformance pack template body. Structure containing the template body with a minimum
 length of 1 byte and a maximum length of 51,200 bytes.
 
 
 
 You can only use a YAML template with one resource type, that is, config rule and a remediation action.
 
 


deliveryS3Bucket
String deliveryS3Bucket

 AWS Config stores intermediate files while processing conformance pack template.
 


deliveryS3KeyPrefix
String deliveryS3KeyPrefix

 The prefix for the Amazon S3 bucket.
 


conformancePackInputParameters
SdkInternalList<T> conformancePackInputParameters

 A list of ConformancePackInputParameter objects.
 








Class com.amazonaws.services.config.model.PutConformancePackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


conformancePackArn
String conformancePackArn

 ARN of the conformance pack.
 








Class com.amazonaws.services.config.model.PutDeliveryChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryChannel
DeliveryChannel deliveryChannel

 The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and
 to an Amazon SNS topic.
 








Class com.amazonaws.services.config.model.PutDeliveryChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.PutEvaluationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


evaluations
SdkInternalList<T> evaluations

 The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates
 whether it complies with the AWS Config rule that invokes the AWS Lambda function.
 


resultToken
String resultToken

 An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that
 triggered the evaluation.
 


testMode
Boolean testMode

 Use this parameter to specify a test run for PutEvaluations. You can verify whether your AWS Lambda
 function will deliver evaluation results to AWS Config. No updates occur to your existing evaluations, and
 evaluation results are not sent to AWS Config.
 
 
 
 When TestMode is true, PutEvaluations doesn't require a valid value for
 the ResultToken parameter, but the value cannot be null.
 
 








Class com.amazonaws.services.config.model.PutEvaluationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedEvaluations
SdkInternalList<T> failedEvaluations

 Requests that failed because of a client or server error.
 








Class com.amazonaws.services.config.model.PutOrganizationConfigRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationConfigRuleName
String organizationConfigRuleName

 The name that you assign to an organization config rule.
 


organizationManagedRuleMetadata
OrganizationManagedRuleMetadata organizationManagedRuleMetadata

 An OrganizationManagedRuleMetadata object.
 


organizationCustomRuleMetadata
OrganizationCustomRuleMetadata organizationCustomRuleMetadata

 An OrganizationCustomRuleMetadata object.
 


excludedAccounts
SdkInternalList<T> excludedAccounts

 A comma-separated list of accounts that you want to exclude from an organization config rule.
 








Class com.amazonaws.services.config.model.PutOrganizationConfigRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organizationConfigRuleArn
String organizationConfigRuleArn

 The Amazon Resource Name (ARN) of an organization config rule.
 








Class com.amazonaws.services.config.model.PutOrganizationConformancePackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationConformancePackName
String organizationConformancePackName

 Name of the organization conformance pack you want to create.
 


templateS3Uri
String templateS3Uri

 Location of file containing the template body. The uri must point to the conformance pack template (max size: 300
 KB).
 
 
 
 You must have access to read Amazon S3 bucket.
 
 


templateBody
String templateBody

 A string containing full conformance pack template body. Structure containing the template body with a minimum
 length of 1 byte and a maximum length of 51,200 bytes.
 


deliveryS3Bucket
String deliveryS3Bucket

 Location of an Amazon S3 bucket where AWS Config can deliver evaluation results. AWS Config stores intermediate
 files while processing conformance pack template.
 
 
 The delivery bucket name should start with awsconfigconforms. For example: "Resource":
 "arn:aws:s3:::your_bucket_name/*". For more information, see Permissions for cross account bucket access.
 


deliveryS3KeyPrefix
String deliveryS3KeyPrefix

 The prefix for the Amazon S3 bucket.
 


conformancePackInputParameters
SdkInternalList<T> conformancePackInputParameters

 A list of ConformancePackInputParameter objects.
 


excludedAccounts
SdkInternalList<T> excludedAccounts

 A list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack.
 








Class com.amazonaws.services.config.model.PutOrganizationConformancePackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organizationConformancePackArn
String organizationConformancePackArn

 ARN of the organization conformance pack.
 








Class com.amazonaws.services.config.model.PutRemediationConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


remediationConfigurations
SdkInternalList<T> remediationConfigurations

 A list of remediation configuration objects.
 








Class com.amazonaws.services.config.model.PutRemediationConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedBatches
SdkInternalList<T> failedBatches

 Returns a list of failed remediation batch objects.
 








Class com.amazonaws.services.config.model.PutRemediationExceptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule for which you want to create remediation exception.
 


resourceKeys
SdkInternalList<T> resourceKeys

 An exception list of resource exception keys to be processed with the current request. AWS Config adds exception
 for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.
 


message
String message

 The message contains an explanation of the exception.
 


expirationTime
Date expirationTime

 The exception is automatically deleted after the expiration date.
 








Class com.amazonaws.services.config.model.PutRemediationExceptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedBatches
SdkInternalList<T> failedBatches

 Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of
 failed items and failure messages.
 








Class com.amazonaws.services.config.model.PutResourceConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of the resource. The custom resource type must be registered with AWS CloudFormation.
 
 
 
 You cannot use the organization names “aws”, “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It
 is the first part of the ResourceType up to the first ::.
 
 


schemaVersionId
String schemaVersionId

 Version of the schema registered for the ResourceType in AWS CloudFormation.
 


resourceId
String resourceId

 Unique identifier of the resource.
 


resourceName
String resourceName

 Name of the resource.
 


configuration
String configuration

 The configuration object of the resource in valid JSON format. It must match the schema registered with AWS
 CloudFormation.
 
 
 
 The configuration JSON must not exceed 64 KB.
 
 


tags
Map<K,V> tags

 Tags associated with the resource.
 








Class com.amazonaws.services.config.model.PutResourceConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.PutRetentionConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


retentionPeriodInDays
Integer retentionPeriodInDays

 Number of days AWS Config stores your historical information.
 
 
 
 Currently, only applicable to the configuration item history.
 
 








Class com.amazonaws.services.config.model.PutRetentionConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


retentionConfiguration
RetentionConfiguration retentionConfiguration

 Returns a retention configuration object.
 








Class com.amazonaws.services.config.model.QueryInfo extends Object implements Serializable


Serialized Fields


selectFields
SdkInternalList<T> selectFields

 Returns a FieldInfo object.
 








Class com.amazonaws.services.config.model.RecordingGroup extends Object implements Serializable


Serialized Fields


allSupported
Boolean allSupported

 Specifies whether AWS Config records configuration changes for every supported type of regional resource.
 
 
 If you set this option to true, when AWS Config adds support for a new type of regional resource, it
 starts recording resources of that type automatically.
 
 
 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
 starts recording resources of that type automatically.
 
 
 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
SdkInternalList<T> resourceTypes

 A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration
 changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).
 
 
 Before you can set this option to true, you must set the allSupported option to
 false.
 
 
 If you set this option to true, when AWS Config adds support for a new type of resource, it will not
 record resources of that type unless you manually add that type to your recording group.
 
 
 For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.
 








Class com.amazonaws.services.config.model.Relationship extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The resource type of the related resource.
 


resourceId
String resourceId

 The ID of the related resource (for example, sg-xxxxxx).
 


resourceName
String resourceName

 The custom name of the related resource, if available.
 


relationshipName
String relationshipName

 The type of relationship with the related resource.
 








Class com.amazonaws.services.config.model.RemediationConfiguration extends Object implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule.
 


targetType
String targetType

 The type of the target. Target executes remediation. For example, SSM document.
 


targetId
String targetId

 Target ID is the name of the public document.
 


targetVersion
String targetVersion

 Version of the target. For example, version of the SSM document.
 


parameters
Map<K,V> parameters

 An object of the RemediationParameterValue.
 


resourceType
String resourceType

 The type of a resource.
 


automatic
Boolean automatic

 The remediation is triggered automatically.
 


executionControls
ExecutionControls executionControls

 An ExecutionControls object.
 


maximumAutomaticAttempts
Integer maximumAutomaticAttempts

 The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
 
 
 For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptsSeconds as 50 seconds, AWS Config
 throws an exception after the 5th failed attempt within 50 seconds.
 


retryAttemptSeconds
Long retryAttemptSeconds

 Maximum time in seconds that AWS Config runs auto-remediation. If you do not select a number, the default is 60
 seconds.
 
 
 For example, if you specify RetryAttemptsSeconds as 50 seconds and MaximumAutomaticAttempts as 5, AWS Config will
 run auto-remediations 5 times within 50 seconds before throwing an exception.
 


arn
String arn

 Amazon Resource Name (ARN) of remediation configuration.
 


createdByService
String createdByService

 Name of the service that owns the service linked rule, if applicable.
 








Class com.amazonaws.services.config.model.RemediationException extends Object implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The name of the AWS Config rule.
 


resourceType
String resourceType

 The type of a resource.
 


resourceId
String resourceId

 The ID of the resource (for example., sg-xxxxxx).
 


message
String message

 An explanation of an remediation exception.
 


expirationTime
Date expirationTime

 The time when the remediation exception will be deleted.
 








Class com.amazonaws.services.config.model.RemediationExceptionResourceKey extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of a resource.
 


resourceId
String resourceId

 The ID of the resource (for example., sg-xxxxxx).
 








Class com.amazonaws.services.config.model.RemediationExecutionStatus extends Object implements Serializable


Serialized Fields


resourceKey
ResourceKey resourceKey


state
String state

 ENUM of the values.
 


stepDetails
SdkInternalList<T> stepDetails

 Details of every step.
 


invocationTime
Date invocationTime

 Start time when the remediation was executed.
 


lastUpdatedTime
Date lastUpdatedTime

 The time when the remediation execution was last updated.
 








Class com.amazonaws.services.config.model.RemediationExecutionStep extends Object implements Serializable


Serialized Fields


name
String name

 The details of the step.
 


state
String state

 The valid status of the step.
 


errorMessage
String errorMessage

 An error message if the step was interrupted during execution.
 


startTime
Date startTime

 The time when the step started.
 


stopTime
Date stopTime

 The time when the step stopped.
 








Class com.amazonaws.services.config.model.RemediationInProgressException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.RemediationParameterValue extends Object implements Serializable


Serialized Fields


resourceValue
ResourceValue resourceValue

 The value is dynamic and changes at run-time.
 


staticValue
StaticValue staticValue

 The value is static and does not change at run-time.
 








Class com.amazonaws.services.config.model.ResourceCount extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The resource type (for example, "AWS::EC2::Instance").
 


count
Long count

 The number of resources.
 








Class com.amazonaws.services.config.model.ResourceCountFilters extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of the AWS resource.
 


accountId
String accountId

 The 12-digit ID of the account.
 


region
String region

 The region where the account is located.
 








Class com.amazonaws.services.config.model.ResourceFilters extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The 12-digit source account ID.
 


resourceId
String resourceId

 The ID of the resource.
 


resourceName
String resourceName

 The name of the resource.
 


region
String region

 The source region.
 








Class com.amazonaws.services.config.model.ResourceIdentifier extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of resource.
 


resourceId
String resourceId

 The ID of the resource (for example, sg-xxxxxx).
 


resourceName
String resourceName

 The custom name of the resource (if available).
 


resourceDeletionTime
Date resourceDeletionTime

 The time that the resource was deleted.
 








Class com.amazonaws.services.config.model.ResourceInUseException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.ResourceKey extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The resource type.
 


resourceId
String resourceId

 The ID of the resource (for example., sg-xxxxxx).
 








Class com.amazonaws.services.config.model.ResourceNotDiscoveredException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.ResourceNotFoundException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.ResourceValue extends Object implements Serializable


Serialized Fields


value
String value

 The value is a resource ID.
 








Class com.amazonaws.services.config.model.RetentionConfiguration extends Object implements Serializable


Serialized Fields


name
String name

 The name of the retention configuration object.
 


retentionPeriodInDays
Integer retentionPeriodInDays

 Number of days AWS Config stores your historical information.
 
 
 
 Currently, only applicable to the configuration item history.
 
 








Class com.amazonaws.services.config.model.Scope extends Object implements Serializable


Serialized Fields


complianceResourceTypes
SdkInternalList<T> complianceResourceTypes

 The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only
 specify one type if you also specify a resource ID for ComplianceResourceId.
 


tagKey
String tagKey

 The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.
 


tagValue
String tagValue

 The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you
 specify a value for TagValue, you must also specify a value for TagKey.
 


complianceResourceId
String complianceResourceId

 The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource
 ID, you must specify one resource type for ComplianceResourceTypes.
 








Class com.amazonaws.services.config.model.SelectResourceConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


expression
String expression

 The SQL query SELECT command.
 


limit
Integer limit

 The maximum number of query results returned on each page.
 


nextToken
String nextToken

 The nextToken string returned in a previous request that you use to request the next page of results
 in a paginated response.
 








Class com.amazonaws.services.config.model.SelectResourceConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


results
SdkInternalList<T> results

 Returns the results for the SQL query.
 


queryInfo
QueryInfo queryInfo

 Returns the QueryInfo object.
 


nextToken
String nextToken

 The nextToken string returned in a previous request that you use to request the next page of results
 in a paginated response.
 








Class com.amazonaws.services.config.model.Source extends Object implements Serializable


Serialized Fields


owner
String owner

 Indicates whether AWS or the customer owns and manages the AWS Config rule.
 


sourceIdentifier
String sourceIdentifier

 For AWS Config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY
 is a managed rule. To reference a managed rule, see Using AWS
 Managed Config Rules.
 
 
 For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function, such as
 arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name.
 


sourceDetails
SdkInternalList<T> sourceDetails

 Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.
 








Class com.amazonaws.services.config.model.SourceDetail extends Object implements Serializable


Serialized Fields


eventSource
String eventSource

 The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.
 


messageType
String messageType

 The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following
 notification types:
 
 
 
 
 ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a
 configuration item as a result of a resource change.
 
 
 
 
 OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an
 oversized configuration item. AWS Config may generate this notification type when a resource changes and the
 notification exceeds the maximum size allowed by Amazon SNS.
 
 
 
 
 ScheduledNotification - Triggers a periodic evaluation at the frequency specified for
 MaximumExecutionFrequency.
 
 
 
 
 ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when AWS Config delivers a
 configuration snapshot.
 
 
 
 
 If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for
 ConfigurationItemChangeNotification and one for
 OversizedConfigurationItemChangeNotification.
 


maximumExecutionFrequency
String maximumExecutionFrequency

 The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger. If you
 specify a value for MaximumExecutionFrequency, then MessageType must use the
 ScheduledNotification value.
 
 
 
 By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid
 value for the MaximumExecutionFrequency parameter.
 
 
 Based on the valid value you choose, AWS Config runs evaluations once for each valid value. For example, if you
 choose Three_Hours, AWS Config runs evaluations once every three hours. In this case,
 Three_Hours is the frequency of this rule.
 
 








Class com.amazonaws.services.config.model.SsmControls extends Object implements Serializable


Serialized Fields


concurrentExecutionRatePercentage
Integer concurrentExecutionRatePercentage

 The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that
 specific rule. You can specify a percentage, such as 10%. The default value is 10.
 


errorPercentage
Integer errorPercentage

 The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for
 that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage,
 the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM
 stops running the automations when the fifth error is received.
 








Class com.amazonaws.services.config.model.StartConfigRulesEvaluationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleNames
SdkInternalList<T> configRuleNames

 The list of names of AWS Config rules that you want to run evaluations for.
 








Class com.amazonaws.services.config.model.StartConfigRulesEvaluationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.StartConfigurationRecorderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationRecorderName
String configurationRecorderName

 The name of the recorder object that records each configuration change made to the resources.
 








Class com.amazonaws.services.config.model.StartConfigurationRecorderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.StartRemediationExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configRuleName
String configRuleName

 The list of names of AWS Config rules that you want to run remediation execution for.
 


resourceKeys
SdkInternalList<T> resourceKeys

 A list of resource keys to be processed with the current request. Each element in the list consists of the
 resource type and resource ID.
 








Class com.amazonaws.services.config.model.StartRemediationExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failureMessage
String failureMessage

 Returns a failure message. For example, the resource is already compliant.
 


failedItems
SdkInternalList<T> failedItems

 For resources that have failed to start execution, the API returns a resource key object.
 








Class com.amazonaws.services.config.model.StaticValue extends Object implements Serializable


Serialized Fields


values
SdkInternalList<T> values

 A list of values. For example, the ARN of the assumed role.
 








Class com.amazonaws.services.config.model.StatusDetailFilters extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The 12-digit account ID of the member account within an organization.
 


memberAccountRuleStatus
String memberAccountRuleStatus

 Indicates deployment status for config rule in the member account. When master account calls
 PutOrganizationConfigRule action for the first time, config rule status is created in the member
 account. When master account calls PutOrganizationConfigRule action for the second time, config rule
 status is updated in the member account. Config rule status is deleted when the master account deletes
 OrganizationConfigRule and disables service access for
 config-multiaccountsetup.amazonaws.com.
 
 
 AWS Config sets the state of the rule to:
 
 
 
 
 CREATE_SUCCESSFUL when config rule has been created in the member account.
 
 
 
 
 CREATE_IN_PROGRESS when config rule is being created in the member account.
 
 
 
 
 CREATE_FAILED when config rule creation has failed in the member account.
 
 
 
 
 DELETE_FAILED when config rule deletion has failed in the member account.
 
 
 
 
 DELETE_IN_PROGRESS when config rule is being deleted in the member account.
 
 
 
 
 DELETE_SUCCESSFUL when config rule has been deleted in the member account.
 
 
 
 
 UPDATE_SUCCESSFUL when config rule has been updated in the member account.
 
 
 
 
 UPDATE_IN_PROGRESS when config rule is being updated in the member account.
 
 
 
 
 UPDATE_FAILED when config rule deletion has failed in the member account.
 
 
 








Class com.amazonaws.services.config.model.StopConfigurationRecorderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationRecorderName
String configurationRecorderName

 The name of the recorder object that records each configuration change made to the resources.
 








Class com.amazonaws.services.config.model.StopConfigurationRecorderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more
 specific tag values.
 


value
String value

 The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category
 (key).
 








Class com.amazonaws.services.config.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported
 resources are ConfigRule, ConfigurationAggregator and
 AggregatorAuthorization.
 


tags
SdkInternalList<T> tags

 An array of tag object.
 








Class com.amazonaws.services.config.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.TooManyTagsException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.config.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported
 resources are ConfigRule, ConfigurationAggregator and
 AggregatorAuthorization.
 


tagKeys
SdkInternalList<T> tagKeys

 The keys of the tags to be removed.
 








Class com.amazonaws.services.config.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.config.model.ValidationException extends AmazonConfigException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.connect.model




Class com.amazonaws.services.connect.model.AmazonConnectException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connect.model.ChatMessage extends Object implements Serializable


Serialized Fields


contentType
String contentType

 The type of the content. Supported types are text/plain.
 


content
String content

 The content of the chat message.
 








Class com.amazonaws.services.connect.model.ContactFlowSummary extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the contact flow.
 


arn
String arn

 The Amazon Resource Name (ARN) of the contact flow.
 


name
String name

 The name of the contact flow.
 


contactFlowType
String contactFlowType

 The type of contact flow.
 








Class com.amazonaws.services.connect.model.ContactNotFoundException extends AmazonConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connect.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


username
String username

 The user name for the account. For instances not using SAML for identity management, the user name can include up
 to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters
 from [a-zA-Z0-9_-.\@]+.
 


password
String password

 The password for the user account. A password is required if you are using Amazon Connect for identity
 management. Otherwise, it is an error to include a password.
 


identityInfo
UserIdentityInfo identityInfo

 The information about the identity of the user.
 


phoneConfig
UserPhoneConfig phoneConfig

 The phone settings for the user.
 


directoryUserId
String directoryUserId

 The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access
 the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume
 that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate
 users from your directory.
 
 
 This parameter is required if you are using an existing directory for identity management in Amazon Connect when
 Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management
 and include this parameter, an error is returned.
 


securityProfileIds
List<E> securityProfileIds

 The identifier of the security profile for the user.
 


routingProfileId
String routingProfileId

 The identifier of the routing profile for the user.
 


hierarchyGroupId
String hierarchyGroupId

 The identifier of the hierarchy group for the user.
 


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


tags
Map<K,V> tags

 One or more tags.
 








Class com.amazonaws.services.connect.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userId
String userId

 The identifier of the user account.
 


userArn
String userArn

 The Amazon Resource Name (ARN) of the user account.
 








Class com.amazonaws.services.connect.model.Credentials extends Object implements Serializable


Serialized Fields


accessToken
String accessToken

 An access token generated for a federated user to access Amazon Connect.
 


accessTokenExpiration
Date accessTokenExpiration

 A token generated with an expiration time for the session a user is logged in to Amazon Connect.
 


refreshToken
String refreshToken

 Renews a token generated for a user to access the Amazon Connect instance.
 


refreshTokenExpiration
Date refreshTokenExpiration

 Renews the expiration timer for a generated token.
 








Class com.amazonaws.services.connect.model.CurrentMetric extends Object implements Serializable


Serialized Fields


name
String name

 The name of the metric.
 


unit
String unit

 The unit for the metric.
 








Class com.amazonaws.services.connect.model.CurrentMetricData extends Object implements Serializable


Serialized Fields


metric
CurrentMetric metric

 Information about the metric.
 


value
Double value

 The value of the metric.
 








Class com.amazonaws.services.connect.model.CurrentMetricResult extends Object implements Serializable


Serialized Fields


dimensions
Dimensions dimensions

 The dimensions for the metrics.
 


collections
List<E> collections

 The set of metrics.
 








Class com.amazonaws.services.connect.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


userId
String userId

 The identifier of the user.
 








Class com.amazonaws.services.connect.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.connect.model.DescribeUserHierarchyGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hierarchyGroupId
String hierarchyGroupId

 The identifier of the hierarchy group.
 


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 








Class com.amazonaws.services.connect.model.DescribeUserHierarchyGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hierarchyGroup
HierarchyGroup hierarchyGroup

 Information about the hierarchy group.
 








Class com.amazonaws.services.connect.model.DescribeUserHierarchyStructureRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 








Class com.amazonaws.services.connect.model.DescribeUserHierarchyStructureResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hierarchyStructure
HierarchyStructure hierarchyStructure

 Information about the hierarchy structure.
 








Class com.amazonaws.services.connect.model.DescribeUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userId
String userId

 The identifier of the user account.
 


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 








Class com.amazonaws.services.connect.model.DescribeUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


user
User user

 Information about the user account and configuration settings.
 








Class com.amazonaws.services.connect.model.DestinationNotAllowedException extends AmazonConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connect.model.Dimensions extends Object implements Serializable


Serialized Fields


queue
QueueReference queue

 Information about the queue for which metrics are returned.
 


channel
String channel

 The channel used for grouping and filters.
 








Class com.amazonaws.services.connect.model.DuplicateResourceException extends AmazonConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connect.model.Filters extends Object implements Serializable


Serialized Fields


queues
List<E> queues

 The queues to use to filter the metrics. You can specify up to 100 queues per request.
 


channels
List<E> channels

 The channel to use to filter the metrics.
 








Class com.amazonaws.services.connect.model.GetContactAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


initialContactId
String initialContactId

 The identifier of the initial contact.
 








Class com.amazonaws.services.connect.model.GetContactAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
Map<K,V> attributes

 Information about the attributes.
 








Class com.amazonaws.services.connect.model.GetCurrentMetricDataRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


filters
Filters filters

 The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the
 resources associated with the queues or channels included in the filter. You can include both queue IDs and queue
 ARNs in the same request. The only supported channel is VOICE.
 


groupings
List<E> groupings

 The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics
 returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you
 should include a Channels filter. The only supported channel is VOICE.
 
 
 If no Grouping is included in the request, a summary of metrics is returned.
 


currentMetrics
List<E> currentMetrics

 The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available:
 
 
 AGENTS_AFTER_CONTACT_WORK
 
 
 Unit: COUNT
 
 
 AGENTS_AVAILABLE
 
 
 Unit: COUNT
 
 
 AGENTS_ERROR
 
 
 Unit: COUNT
 
 
 AGENTS_NON_PRODUCTIVE
 
 
 Unit: COUNT
 
 
 AGENTS_ON_CALL
 
 
 Unit: COUNT
 
 
 AGENTS_ON_CONTACT
 
 
 Unit: COUNT
 
 
 AGENTS_ONLINE
 
 
 Unit: COUNT
 
 
 AGENTS_STAFFED
 
 
 Unit: COUNT
 
 
 CONTACTS_IN_QUEUE
 
 
 Unit: COUNT
 
 
 CONTACTS_SCHEDULED
 
 
 Unit: COUNT
 
 
 OLDEST_CONTACT_AGE
 
 
 Unit: SECONDS
 
 
 SLOTS_ACTIVE
 
 
 Unit: COUNT
 
 
 SLOTS_AVAILABLE
 
 
 Unit: COUNT
 
 
 


nextToken
String nextToken

 The token for the next set of results. Use the value returned in the previous response in the next request to
 retrieve the next set of results.
 
 
 The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use
 the same request parameters as the request that generated the token.
 


maxResults
Integer maxResults

 The maximimum number of results to return per page.
 








Class com.amazonaws.services.connect.model.GetCurrentMetricDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 
 
 The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use
 the same request parameters as the request that generated the token.
 


metricResults
List<E> metricResults

 Information about the real-time metrics.
 


dataSnapshotTime
Date dataSnapshotTime

 The time at which the metrics were retrieved and cached for pagination.
 








Class com.amazonaws.services.connect.model.GetFederationTokenRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 








Class com.amazonaws.services.connect.model.GetFederationTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


credentials
Credentials credentials

 The credentials to use for federation.
 








Class com.amazonaws.services.connect.model.GetMetricDataRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


startTime
Date startTime

 The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of
 historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
 
 
 The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available
 only for 24 hours.
 


endTime
Date endTime

 The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical
 metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be
 later than the start time timestamp.
 
 
 The time range between the start and end time must be less than 24 hours.
 


filters
Filters filters

 The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the
 resources associated with the queues or channels included in the filter. You can include both queue IDs and queue
 ARNs in the same request. The only supported channel is VOICE.
 


groupings
List<E> groupings

 The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics
 returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for
 all queues.
 
 
 The only supported grouping is QUEUE.
 
 
 If no grouping is specified, a summary of metrics for all queues is returned.
 


historicalMetrics
List<E> historicalMetrics

 The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics
 are available:
 
 
 ABANDON_TIME
 
 
 Unit: SECONDS
 
 
 Statistic: AVG
 
 
 AFTER_CONTACT_WORK_TIME
 
 
 Unit: SECONDS
 
 
 Statistic: AVG
 
 
 API_CONTACTS_HANDLED
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CALLBACK_CONTACTS_HANDLED
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_ABANDONED
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_AGENT_HUNG_UP_FIRST
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_CONSULTED
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_HANDLED
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_HANDLED_INCOMING
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_HANDLED_OUTBOUND
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_HOLD_ABANDONS
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_MISSED
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_QUEUED
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_TRANSFERRED_IN
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_TRANSFERRED_IN_FROM_QUEUE
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_TRANSFERRED_OUT
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
 
 
 Unit: COUNT
 
 
 Statistic: SUM
 
 
 HANDLE_TIME
 
 
 Unit: SECONDS
 
 
 Statistic: AVG
 
 
 HOLD_TIME
 
 
 Unit: SECONDS
 
 
 Statistic: AVG
 
 
 INTERACTION_AND_HOLD_TIME
 
 
 Unit: SECONDS
 
 
 Statistic: AVG
 
 
 INTERACTION_TIME
 
 
 Unit: SECONDS
 
 
 Statistic: AVG
 
 
 OCCUPANCY
 
 
 Unit: PERCENT
 
 
 Statistic: AVG
 
 
 QUEUE_ANSWER_TIME
 
 
 Unit: SECONDS
 
 
 Statistic: AVG
 
 
 QUEUED_TIME
 
 
 Unit: SECONDS
 
 
 Statistic: MAX
 
 
 SERVICE_LEVEL
 
 
 Unit: PERCENT
 
 
 Statistic: AVG
 
 
 Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25,
 30, 45, 60, 90, 120, 180, 240, 300, 600
 
 
 


nextToken
String nextToken

 The token for the next set of results. Use the value returned in the previous response in the next request to
 retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximimum number of results to return per page.
 








Class com.amazonaws.services.connect.model.GetMetricDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 
 
 The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use
 the same request parameters as the request that generated the token.
 


metricResults
List<E> metricResults

 Information about the historical metrics.
 
 
 If no grouping is specified, a summary of metric data is returned.
 








Class com.amazonaws.services.connect.model.HierarchyGroup extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the hierarchy group.
 


arn
String arn

 The Amazon Resource Name (ARN) of the hierarchy group.
 


name
String name

 The name of the hierarchy group.
 


levelId
String levelId

 The identifier of the level in the hierarchy group.
 


hierarchyPath
HierarchyPath hierarchyPath

 Information about the levels in the hierarchy group.
 








Class com.amazonaws.services.connect.model.HierarchyGroupSummary extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the hierarchy group.
 


arn
String arn

 The Amazon Resource Name (ARN) of the hierarchy group.
 


name
String name

 The name of the hierarchy group.
 








Class com.amazonaws.services.connect.model.HierarchyLevel extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the hierarchy level.
 


arn
String arn

 The Amazon Resource Name (ARN) of the hierarchy level.
 


name
String name

 The name of the hierarchy level.
 








Class com.amazonaws.services.connect.model.HierarchyPath extends Object implements Serializable


Serialized Fields


levelOne
HierarchyGroupSummary levelOne

 Information about level one.
 


levelTwo
HierarchyGroupSummary levelTwo

 Information about level two.
 


levelThree
HierarchyGroupSummary levelThree

 Information about level three.
 


levelFour
HierarchyGroupSummary levelFour

 Information about level four.
 


levelFive
HierarchyGroupSummary levelFive

 Information about level five.
 








Class com.amazonaws.services.connect.model.HierarchyStructure extends Object implements Serializable


Serialized Fields


levelOne
HierarchyLevel levelOne

 Information about level one.
 


levelTwo
HierarchyLevel levelTwo

 Information about level two.
 


levelThree
HierarchyLevel levelThree

 Information about level three.
 


levelFour
HierarchyLevel levelFour

 Information about level four.
 


levelFive
HierarchyLevel levelFive

 Information about level five.
 








Class com.amazonaws.services.connect.model.HistoricalMetric extends Object implements Serializable


Serialized Fields


name
String name

 The name of the metric.
 


threshold
Threshold threshold

 The threshold for the metric, used with service level metrics.
 


statistic
String statistic

 The statistic for the metric.
 


unit
String unit

 The unit for the metric.
 








Class com.amazonaws.services.connect.model.HistoricalMetricData extends Object implements Serializable


Serialized Fields


metric
HistoricalMetric metric

 Information about the metric.
 


value
Double value

 The value of the metric.
 








Class com.amazonaws.services.connect.model.HistoricalMetricResult extends Object implements Serializable


Serialized Fields


dimensions
Dimensions dimensions

 The dimension for the metrics.
 


collections
List<E> collections

 The set of metrics.
 








Class com.amazonaws.services.connect.model.HoursOfOperationSummary extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the hours of operation.
 


arn
String arn

 The Amazon Resource Name (ARN) of the hours of operation.
 


name
String name

 The name of the hours of operation.
 








Class com.amazonaws.services.connect.model.InternalServiceException extends AmazonConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connect.model.InvalidParameterException extends AmazonConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connect.model.InvalidRequestException extends AmazonConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connect.model.LimitExceededException extends AmazonConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connect.model.ListContactFlowsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


contactFlowTypes
List<E> contactFlowTypes

 The type of contact flow.
 


nextToken
String nextToken

 The token for the next set of results. Use the value returned in the previous response in the next request to
 retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximimum number of results to return per page.
 








Class com.amazonaws.services.connect.model.ListContactFlowsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contactFlowSummaryList
List<E> contactFlowSummaryList

 Information about the contact flows.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








Class com.amazonaws.services.connect.model.ListHoursOfOperationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


nextToken
String nextToken

 The token for the next set of results. Use the value returned in the previous response in the next request to
 retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximimum number of results to return per page.
 








Class com.amazonaws.services.connect.model.ListHoursOfOperationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hoursOfOperationSummaryList
List<E> hoursOfOperationSummaryList

 Information about the hours of operation.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








Class com.amazonaws.services.connect.model.ListPhoneNumbersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


phoneNumberTypes
List<E> phoneNumberTypes

 The type of phone number.
 


phoneNumberCountryCodes
List<E> phoneNumberCountryCodes

 The ISO country code.
 


nextToken
String nextToken

 The token for the next set of results. Use the value returned in the previous response in the next request to
 retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximimum number of results to return per page.
 








Class com.amazonaws.services.connect.model.ListPhoneNumbersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


phoneNumberSummaryList
List<E> phoneNumberSummaryList

 Information about the phone numbers.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








Class com.amazonaws.services.connect.model.ListQueuesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


queueTypes
List<E> queueTypes

 The type of queue.
 


nextToken
String nextToken

 The token for the next set of results. Use the value returned in the previous response in the next request to
 retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximimum number of results to return per page.
 








Class com.amazonaws.services.connect.model.ListQueuesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


queueSummaryList
List<E> queueSummaryList

 Information about the queues.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








Class com.amazonaws.services.connect.model.ListRoutingProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


nextToken
String nextToken

 The token for the next set of results. Use the value returned in the previous response in the next request to
 retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximimum number of results to return per page.
 








Class com.amazonaws.services.connect.model.ListRoutingProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


routingProfileSummaryList
List<E> routingProfileSummaryList

 Information about the routing profiles.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








Class com.amazonaws.services.connect.model.ListSecurityProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


nextToken
String nextToken

 The token for the next set of results. Use the value returned in the previous response in the next request to
 retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximimum number of results to return per page.
 








Class com.amazonaws.services.connect.model.ListSecurityProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityProfileSummaryList
List<E> securityProfileSummaryList

 Information about the security profiles.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 








Class com.amazonaws.services.connect.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 Information about the tags.
 








Class com.amazonaws.services.connect.model.ListUserHierarchyGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


nextToken
String nextToken

 The token for the next set of results. Use the value returned in the previous response in the next request to
 retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximimum number of results to return per page.
 








Class com.amazonaws.services.connect.model.ListUserHierarchyGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userHierarchyGroupSummaryList
List<E> userHierarchyGroupSummaryList

 Information about the hierarchy groups.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








Class com.amazonaws.services.connect.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


nextToken
String nextToken

 The token for the next set of results. Use the value returned in the previous response in the next request to
 retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximimum number of results to return per page.
 








Class com.amazonaws.services.connect.model.ListUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userSummaryList
List<E> userSummaryList

 Information about the users.
 


nextToken
String nextToken

 If there are additional results, this is the token for the next set of results.
 








Class com.amazonaws.services.connect.model.OutboundContactNotPermittedException extends AmazonConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connect.model.ParticipantDetails extends Object implements Serializable


Serialized Fields


displayName
String displayName

 Display name of the participant.
 








Class com.amazonaws.services.connect.model.PhoneNumberSummary extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the phone number.
 


arn
String arn

 The Amazon Resource Name (ARN) of the phone number.
 


phoneNumber
String phoneNumber

 The phone number.
 


phoneNumberType
String phoneNumberType

 The type of phone number.
 


phoneNumberCountryCode
String phoneNumberCountryCode

 The ISO country code.
 








Class com.amazonaws.services.connect.model.QueueReference extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the queue.
 


arn
String arn

 The Amazon Resource Name (ARN) of the queue.
 








Class com.amazonaws.services.connect.model.QueueSummary extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the queue.
 


arn
String arn

 The Amazon Resource Name (ARN) of the queue.
 


name
String name

 The name of the queue.
 


queueType
String queueType

 The type of queue.
 








Class com.amazonaws.services.connect.model.ResourceNotFoundException extends AmazonConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connect.model.RoutingProfileSummary extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the routing profile.
 


arn
String arn

 The Amazon Resource Name (ARN) of the routing profile.
 


name
String name

 The name of the routing profile.
 








Class com.amazonaws.services.connect.model.SecurityProfileSummary extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the security profile.
 


arn
String arn

 The Amazon Resource Name (ARN) of the security profile.
 


name
String name

 The name of the security profile.
 








Class com.amazonaws.services.connect.model.StartChatContactRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


contactFlowId
String contactFlowId

 The identifier of the contact flow for the chat.
 


attributes
Map<K,V> attributes

 A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be
 accessed in contact flows just like any other contact attributes.
 
 
 There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
 alphanumeric, dash, and underscore characters.
 


participantDetails
ParticipantDetails participantDetails

 Information identifying the participant.
 


initialMessage
ChatMessage initialMessage

 The initial message to be sent to the newly created chat.
 


clientToken
String clientToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 








Class com.amazonaws.services.connect.model.StartChatContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contactId
String contactId

 The identifier of this contact within the Amazon Connect instance.
 


participantId
String participantId

 The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat
 lifecycle.
 


participantToken
String participantToken

 The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.
 








Class com.amazonaws.services.connect.model.StartOutboundVoiceContactRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationPhoneNumber
String destinationPhoneNumber

 The phone number of the customer, in E.164 format.
 


contactFlowId
String contactFlowId

 The identifier of the contact flow for the outbound call.
 


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


clientToken
String clientToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid
 for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is
 disconnected, a new contact is started.
 


sourcePhoneNumber
String sourcePhoneNumber

 The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source
 phone number, you must specify a queue.
 


queueId
String queueId

 The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified
 in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify
 a queue, you must specify a source phone number.
 


attributes
Map<K,V> attributes

 A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be
 accessed in contact flows just like any other contact attributes.
 
 
 There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only
 alphanumeric, dash, and underscore characters.
 








Class com.amazonaws.services.connect.model.StartOutboundVoiceContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contactId
String contactId

 The identifier of this contact within the Amazon Connect instance.
 








Class com.amazonaws.services.connect.model.StopContactRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


contactId
String contactId

 The ID of the contact.
 


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 








Class com.amazonaws.services.connect.model.StopContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.connect.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 


tags
Map<K,V> tags

 One or more tags. For example, { "tags": {"key1":"value1", "key2":"value2"} }.
 








Class com.amazonaws.services.connect.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.connect.model.Threshold extends Object implements Serializable


Serialized Fields


comparison
String comparison

 The type of comparison. Only "less than" (LT) comparisons are supported.
 


thresholdValue
Double thresholdValue

 The threshold value to compare.
 








Class com.amazonaws.services.connect.model.ThrottlingException extends AmazonConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connect.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 


tagKeys
List<E> tagKeys

 The tag keys.
 








Class com.amazonaws.services.connect.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.connect.model.UpdateContactAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


initialContactId
String initialContactId

 The identifier of the contact. This is the identifier of the contact associated with the first interaction with
 the contact center.
 


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 


attributes
Map<K,V> attributes

 The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact
 attributes.
 
 
 You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only
 alphanumeric, dash, and underscore characters.
 








Class com.amazonaws.services.connect.model.UpdateContactAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.connect.model.UpdateUserHierarchyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hierarchyGroupId
String hierarchyGroupId

 The identifier of the hierarchy group.
 


userId
String userId

 The identifier of the user account.
 


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 








Class com.amazonaws.services.connect.model.UpdateUserHierarchyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.connect.model.UpdateUserIdentityInfoRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


identityInfo
UserIdentityInfo identityInfo

 The identity information for the user.
 


userId
String userId

 The identifier of the user account.
 


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 








Class com.amazonaws.services.connect.model.UpdateUserIdentityInfoResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.connect.model.UpdateUserPhoneConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


phoneConfig
UserPhoneConfig phoneConfig

 Information about phone configuration settings for the user.
 


userId
String userId

 The identifier of the user account.
 


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 








Class com.amazonaws.services.connect.model.UpdateUserPhoneConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.connect.model.UpdateUserRoutingProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


routingProfileId
String routingProfileId

 The identifier of the routing profile for the user.
 


userId
String userId

 The identifier of the user account.
 


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 








Class com.amazonaws.services.connect.model.UpdateUserRoutingProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.connect.model.UpdateUserSecurityProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


securityProfileIds
List<E> securityProfileIds

 The identifiers of the security profiles for the user.
 


userId
String userId

 The identifier of the user account.
 


instanceId
String instanceId

 The identifier of the Amazon Connect instance.
 








Class com.amazonaws.services.connect.model.UpdateUserSecurityProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.connect.model.User extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the user account.
 


arn
String arn

 The Amazon Resource Name (ARN) of the user account.
 


username
String username

 The user name assigned to the user account.
 


identityInfo
UserIdentityInfo identityInfo

 Information about the user identity.
 


phoneConfig
UserPhoneConfig phoneConfig

 Information about the phone configuration for the user.
 


directoryUserId
String directoryUserId

 The identifier of the user account in the directory used for identity management.
 


securityProfileIds
List<E> securityProfileIds

 The identifiers of the security profiles for the user.
 


routingProfileId
String routingProfileId

 The identifier of the routing profile for the user.
 


hierarchyGroupId
String hierarchyGroupId

 The identifier of the hierarchy group for the user.
 


tags
Map<K,V> tags

 The tags.
 








Class com.amazonaws.services.connect.model.UserIdentityInfo extends Object implements Serializable


Serialized Fields


firstName
String firstName

 The first name. This is required if you are using Amazon Connect or SAML for identity management.
 


lastName
String lastName

 The last name. This is required if you are using Amazon Connect or SAML for identity management.
 


email
String email

 The email address. If you are using SAML for identity management and include this parameter, an error is
 returned.
 








Class com.amazonaws.services.connect.model.UserNotFoundException extends AmazonConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connect.model.UserPhoneConfig extends Object implements Serializable


Serialized Fields


phoneType
String phoneType

 The phone type.
 


autoAccept
Boolean autoAccept

 The Auto accept setting.
 


afterContactWorkTimeLimit
Integer afterContactWorkTimeLimit

 The After Call Work (ACW) timeout setting, in seconds.
 


deskPhoneNumber
String deskPhoneNumber

 The phone number for the user's desk phone.
 








Class com.amazonaws.services.connect.model.UserSummary extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the user account.
 


arn
String arn

 The Amazon Resource Name (ARN) of the user account.
 


username
String username

 The Amazon Connect user name of the user account.
 








Package com.amazonaws.services.connectparticipant.model




Class com.amazonaws.services.connectparticipant.model.AccessDeniedException extends AmazonConnectParticipantException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connectparticipant.model.AmazonConnectParticipantException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connectparticipant.model.ConnectionCredentials extends Object implements Serializable


Serialized Fields


connectionToken
String connectionToken

 The connection token.
 


expiry
String expiry

 The expiration of the token.
 
 
 It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
 








Class com.amazonaws.services.connectparticipant.model.CreateParticipantConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


type
List<E> type

 Type of connection information required.
 


participantToken
String participantToken

 Participant Token as obtained from StartChatContact API response.
 








Class com.amazonaws.services.connectparticipant.model.CreateParticipantConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


websocket
Websocket websocket

 Creates the participant's websocket connection.
 


connectionCredentials
ConnectionCredentials connectionCredentials

 Creates the participant's connection credentials. The authentication token associated with the participant's
 connection.
 








Class com.amazonaws.services.connectparticipant.model.DisconnectParticipantRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientToken
String clientToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 


connectionToken
String connectionToken

 The authentication token associated with the participant's connection.
 








Class com.amazonaws.services.connectparticipant.model.DisconnectParticipantResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.connectparticipant.model.GetTranscriptRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


contactId
String contactId

 The contactId from the current contact chain for which transcript is needed.
 


maxResults
Integer maxResults

 The maximum number of results to return in the page. Default: 10.
 


nextToken
String nextToken

 The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set
 of results.
 


scanDirection
String scanDirection

 The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is
 provided, FORWARD with StartPosition.
 


sortOrder
String sortOrder

 The sort order for the records. Default: DESCENDING.
 


startPosition
StartPosition startPosition

 A filtering option for where to start.
 


connectionToken
String connectionToken

 The authentication token associated with the participant's connection.
 








Class com.amazonaws.services.connectparticipant.model.GetTranscriptResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


initialContactId
String initialContactId

 The initial contact ID for the contact.
 


transcript
List<E> transcript

 The list of messages in the session.
 


nextToken
String nextToken

 The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set
 of results.
 








Class com.amazonaws.services.connectparticipant.model.InternalServerException extends AmazonConnectParticipantException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connectparticipant.model.Item extends Object implements Serializable


Serialized Fields


absoluteTime
String absoluteTime

 The time when the message or event was sent.
 
 
 It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
 


content
String content

 The content of the message or event.
 


contentType
String contentType

 The type of content of the item.
 


id
String id

 The ID of the item.
 


type
String type

 Type of the item: message or event.
 


participantId
String participantId

 The ID of the sender in the session.
 


displayName
String displayName

 The chat display name of the sender.
 


participantRole
String participantRole

 The role of the sender. For example, is it a customer, agent, or system.
 








Class com.amazonaws.services.connectparticipant.model.SendEventRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


contentType
String contentType

 The content type of the request. Supported types are:
 
 
 
 
 application/vnd.amazonaws.connect.event.typing
 
 
 
 
 application/vnd.amazonaws.connect.event.connection.acknowledged
 
 
 


content
String content

 The content of the event to be sent (for example, message text). This is not yet supported.
 


clientToken
String clientToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 


connectionToken
String connectionToken

 The authentication token associated with the participant's connection.
 








Class com.amazonaws.services.connectparticipant.model.SendEventResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The ID of the response.
 


absoluteTime
String absoluteTime

 The time when the event was sent.
 
 
 It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
 








Class com.amazonaws.services.connectparticipant.model.SendMessageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


contentType
String contentType

 The type of the content. Supported types are text/plain.
 


content
String content

 The content of the message.
 


clientToken
String clientToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 


connectionToken
String connectionToken

 The authentication token associated with the connection.
 








Class com.amazonaws.services.connectparticipant.model.SendMessageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The ID of the message.
 


absoluteTime
String absoluteTime

 The time when the message was sent.
 
 
 It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
 








Class com.amazonaws.services.connectparticipant.model.StartPosition extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the message or event where to start.
 


absoluteTime
String absoluteTime

 The time in ISO format where to start.
 
 
 It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
 


mostRecent
Integer mostRecent

 The start position of the most recent message where you want to start.
 








Class com.amazonaws.services.connectparticipant.model.ThrottlingException extends AmazonConnectParticipantException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connectparticipant.model.ValidationException extends AmazonConnectParticipantException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.connectparticipant.model.Websocket extends Object implements Serializable


Serialized Fields


url
String url

 The URL of the websocket.
 


connectionExpiry
String connectionExpiry

 The URL expiration timestamp in ISO date format.
 
 
 It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
 








Package com.amazonaws.services.costandusagereport.model




Class com.amazonaws.services.costandusagereport.model.AWSCostAndUsageReportException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costandusagereport.model.DeleteReportDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reportName
String reportName








Class com.amazonaws.services.costandusagereport.model.DeleteReportDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


responseMessage
String responseMessage








Class com.amazonaws.services.costandusagereport.model.DescribeReportDefinitionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults


nextToken
String nextToken








Class com.amazonaws.services.costandusagereport.model.DescribeReportDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reportDefinitions
List<E> reportDefinitions

 A list of AWS Cost and Usage reports owned by the account.
 


nextToken
String nextToken








Class com.amazonaws.services.costandusagereport.model.DuplicateReportNameException extends AWSCostAndUsageReportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costandusagereport.model.InternalErrorException extends AWSCostAndUsageReportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costandusagereport.model.ModifyReportDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reportName
String reportName


reportDefinition
ReportDefinition reportDefinition








Class com.amazonaws.services.costandusagereport.model.ModifyReportDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.costandusagereport.model.PutReportDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reportDefinition
ReportDefinition reportDefinition

 Represents the output of the PutReportDefinition operation. The content consists of the detailed metadata and
 data file information.
 








Class com.amazonaws.services.costandusagereport.model.PutReportDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.costandusagereport.model.ReportDefinition extends Object implements Serializable


Serialized Fields


reportName
String reportName


timeUnit
String timeUnit


format
String format


compression
String compression


additionalSchemaElements
List<E> additionalSchemaElements

 A list of strings that indicate additional content that Amazon Web Services includes in the report, such as
 individual resource IDs.
 


s3Bucket
String s3Bucket


s3Prefix
String s3Prefix


s3Region
String s3Region


additionalArtifacts
List<E> additionalArtifacts

 A list of manifests that you want Amazon Web Services to create for this report.
 


refreshClosedReports
Boolean refreshClosedReports

 Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services
 detects charges related to previous months. These charges can include refunds, credits, or support fees.
 


reportVersioning
String reportVersioning

 Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in
 addition to the previous versions.
 








Class com.amazonaws.services.costandusagereport.model.ReportLimitReachedException extends AWSCostAndUsageReportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costandusagereport.model.ValidationException extends AWSCostAndUsageReportException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.costexplorer.model




Class com.amazonaws.services.costexplorer.model.AWSCostExplorerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costexplorer.model.BillExpirationException extends AWSCostExplorerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costexplorer.model.CostCategory extends Object implements Serializable


Serialized Fields


costCategoryArn
String costCategoryArn

 The unique identifier for your Cost Category.
 


effectiveStart
String effectiveStart

 The Cost Category's effective start date.
 


effectiveEnd
String effectiveEnd

 The Cost Category's effective end date.
 


name
String name


ruleVersion
String ruleVersion


rules
List<E> rules

 Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match
 is used to determine that Cost Category value.
 








Class com.amazonaws.services.costexplorer.model.CostCategoryReference extends Object implements Serializable


Serialized Fields


costCategoryArn
String costCategoryArn

 The unique identifier for your Cost Category Reference.
 


name
String name


effectiveStart
String effectiveStart

 The Cost Category's effective start date.
 


effectiveEnd
String effectiveEnd

 The Cost Category's effective end date.
 








Class com.amazonaws.services.costexplorer.model.CostCategoryRule extends Object implements Serializable


Serialized Fields


value
String value


rule
Expression rule

 An Expression
 object used to categorize costs. This supports dimensions, Tags, and nested expressions. Currently the only
 dimensions supported is LINKED_ACCOUNT.
 
 
 Root level OR is not supported. We recommend you create a separate rule instead.
 








Class com.amazonaws.services.costexplorer.model.CostCategoryValues extends Object implements Serializable


Serialized Fields


key
String key


values
List<E> values

 The specific value of the Cost Category.
 








Class com.amazonaws.services.costexplorer.model.Coverage extends Object implements Serializable


Serialized Fields


coverageHours
CoverageHours coverageHours

 The amount of instance usage that the reservation covered, in hours.
 


coverageNormalizedUnits
CoverageNormalizedUnits coverageNormalizedUnits

 The amount of instance usage that the reservation covered, in normalized units.
 


coverageCost
CoverageCost coverageCost

 The amount of cost that the reservation covered.
 








Class com.amazonaws.services.costexplorer.model.CoverageByTime extends Object implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 The period that this coverage was used over.
 


groups
List<E> groups

 The groups of instances that the reservation covered.
 


total
Coverage total

 The total reservation coverage, in hours.
 








Class com.amazonaws.services.costexplorer.model.CoverageCost extends Object implements Serializable


Serialized Fields


onDemandCost
String onDemandCost

 How much an On-Demand instance cost.
 








Class com.amazonaws.services.costexplorer.model.CoverageHours extends Object implements Serializable


Serialized Fields


onDemandHours
String onDemandHours

 The number of instance running hours that On-Demand Instances covered.
 


reservedHours
String reservedHours

 The number of instance running hours that reservations covered.
 


totalRunningHours
String totalRunningHours

 The total instance usage, in hours.
 


coverageHoursPercentage
String coverageHoursPercentage

 The percentage of instance hours that a reservation covered.
 








Class com.amazonaws.services.costexplorer.model.CoverageNormalizedUnits extends Object implements Serializable


Serialized Fields


onDemandNormalizedUnits
String onDemandNormalizedUnits

 The number of normalized units that are covered by On-Demand Instances instead of a reservation.
 


reservedNormalizedUnits
String reservedNormalizedUnits

 The number of normalized units that a reservation covers.
 


totalRunningNormalizedUnits
String totalRunningNormalizedUnits

 The total number of normalized units that you used.
 


coverageNormalizedUnitsPercentage
String coverageNormalizedUnitsPercentage

 The percentage of your used instance normalized units that a reservation covers.
 








Class com.amazonaws.services.costexplorer.model.CreateCostCategoryDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name


ruleVersion
String ruleVersion


rules
List<E> rules

 CreateCostCategoryDefinition supports dimensions, Tags, and nested expressions. Currently the only
 dimensions supported is LINKED_ACCOUNT.
 
 
 Root level OR is not supported. We recommend you create a separate rule instead.
 
 
 Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match
 is used to determine that Cost Category value.
 








Class com.amazonaws.services.costexplorer.model.CreateCostCategoryDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


costCategoryArn
String costCategoryArn

 The unique identifier for your newly created Cost Category.
 


effectiveStart
String effectiveStart

 The Cost Category's effective start date.
 








Class com.amazonaws.services.costexplorer.model.CurrentInstance extends Object implements Serializable


Serialized Fields


resourceId
String resourceId

 Resource ID of the current instance.
 


tags
List<E> tags

 Cost allocation resource tags applied to the instance.
 


resourceDetails
ResourceDetails resourceDetails

 Details about the resource and utilization.
 


resourceUtilization
ResourceUtilization resourceUtilization

 Utilization information of the current instance during the lookback period.
 


reservationCoveredHoursInLookbackPeriod
String reservationCoveredHoursInLookbackPeriod

 Number of hours during the lookback period covered by reservations.
 


savingsPlansCoveredHoursInLookbackPeriod
String savingsPlansCoveredHoursInLookbackPeriod

 Number of hours during the lookback period covered by Savings Plans.
 


onDemandHoursInLookbackPeriod
String onDemandHoursInLookbackPeriod

 Number of hours during the lookback period billed at On Demand rates.
 


totalRunningHoursInLookbackPeriod
String totalRunningHoursInLookbackPeriod

 The total number of hours the instance ran during the lookback period.
 


monthlyCost
String monthlyCost

 Current On Demand cost of operating this instance on a monthly basis.
 


currencyCode
String currencyCode

 The currency code that Amazon Web Services used to calculate the costs for this instance.
 








Class com.amazonaws.services.costexplorer.model.DataUnavailableException extends AWSCostExplorerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costexplorer.model.DateInterval extends Object implements Serializable


Serialized Fields


start
String start

 The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example,
 if start is 2017-01-01, AWS retrieves cost and usage data starting at
 2017-01-01 up to the end date.
 


end
String end

 The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if
 end is 2017-05-01, AWS retrieves cost and usage data from the start date up to, but not
 including, 2017-05-01.
 








Class com.amazonaws.services.costexplorer.model.DeleteCostCategoryDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


costCategoryArn
String costCategoryArn

 The unique identifier for your Cost Category.
 








Class com.amazonaws.services.costexplorer.model.DeleteCostCategoryDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


costCategoryArn
String costCategoryArn

 The unique identifier for your Cost Category.
 


effectiveEnd
String effectiveEnd

 The effective end date of the Cost Category as a result of deleting it. No costs after this date will be
 categorized by the deleted Cost Category.
 








Class com.amazonaws.services.costexplorer.model.DescribeCostCategoryDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


costCategoryArn
String costCategoryArn

 The unique identifier for your Cost Category.
 


effectiveOn
String effectiveOn

 The date when the Cost Category was effective.
 








Class com.amazonaws.services.costexplorer.model.DescribeCostCategoryDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


costCategory
CostCategory costCategory








Class com.amazonaws.services.costexplorer.model.DimensionValues extends Object implements Serializable


Serialized Fields


key
String key

 The names of the metadata types that you can use to filter and group your results. For example, AZ
 returns a list of Availability Zones.
 


values
List<E> values

 The metadata values that you can use to filter and group your results. You can use
 GetDimensionValues to find specific values.
 
 
 Valid values for the SERVICE dimension are Amazon Elastic Compute Cloud - Compute,
 Amazon Elasticsearch Service, Amazon ElastiCache, Amazon Redshift, and
 Amazon Relational Database Service.
 








Class com.amazonaws.services.costexplorer.model.DimensionValuesWithAttributes extends Object implements Serializable


Serialized Fields


value
String value

 The value of a dimension with a specific attribute.
 


attributes
Map<K,V> attributes

 The attribute that applies to a specific Dimension.
 








Class com.amazonaws.services.costexplorer.model.EC2InstanceDetails extends Object implements Serializable


Serialized Fields


family
String family

 The instance family of the recommended reservation.
 


instanceType
String instanceType

 The type of instance that AWS recommends.
 


region
String region

 The AWS Region of the recommended reservation.
 


availabilityZone
String availabilityZone

 The Availability Zone of the recommended reservation.
 


platform
String platform

 The platform of the recommended reservation. The platform is the specific combination of operating system,
 license model, and software on an instance.
 


tenancy
String tenancy

 Whether the recommended reservation is dedicated or shared.
 


currentGeneration
Boolean currentGeneration

 Whether the recommendation is for a current-generation instance.
 


sizeFlexEligible
Boolean sizeFlexEligible

 Whether the recommended reservation is size flexible.
 








Class com.amazonaws.services.costexplorer.model.EC2ResourceDetails extends Object implements Serializable


Serialized Fields


hourlyOnDemandRate
String hourlyOnDemandRate

 Hourly public On Demand rate for the instance type.
 


instanceType
String instanceType

 The type of Amazon Web Services instance.
 


platform
String platform

 The platform of the Amazon Web Services instance. The platform is the specific combination of operating system,
 license model, and software on an instance.
 


region
String region

 The Amazon Web Services Region of the instance.
 


sku
String sku

 The SKU of the product.
 


memory
String memory

 Memory capacity of Amazon Web Services instance.
 


networkPerformance
String networkPerformance

 Network performance capacity of the Amazon Web Services instance.
 


storage
String storage

 The disk storage of the Amazon Web Services instance (Not EBS storage).
 


vcpu
String vcpu

 Number of VCPU cores in the Amazon Web Services instance type.
 








Class com.amazonaws.services.costexplorer.model.EC2ResourceUtilization extends Object implements Serializable


Serialized Fields


maxCpuUtilizationPercentage
String maxCpuUtilizationPercentage

 Maximum observed or expected CPU utilization of the instance.
 


maxMemoryUtilizationPercentage
String maxMemoryUtilizationPercentage

 Maximum observed or expected memory utilization of the instance.
 


maxStorageUtilizationPercentage
String maxStorageUtilizationPercentage

 Maximum observed or expected storage utilization of the instance (does not measure EBS storage).
 








Class com.amazonaws.services.costexplorer.model.EC2Specification extends Object implements Serializable


Serialized Fields


offeringClass
String offeringClass

 Whether you want a recommendation for standard or convertible reservations.
 








Class com.amazonaws.services.costexplorer.model.ElastiCacheInstanceDetails extends Object implements Serializable


Serialized Fields


family
String family

 The instance family of the recommended reservation.
 


nodeType
String nodeType

 The type of node that AWS recommends.
 


region
String region

 The AWS Region of the recommended reservation.
 


productDescription
String productDescription

 The description of the recommended reservation.
 


currentGeneration
Boolean currentGeneration

 Whether the recommendation is for a current generation instance.
 


sizeFlexEligible
Boolean sizeFlexEligible

 Whether the recommended reservation is size flexible.
 








Class com.amazonaws.services.costexplorer.model.ESInstanceDetails extends Object implements Serializable


Serialized Fields


instanceClass
String instanceClass

 The class of instance that AWS recommends.
 


instanceSize
String instanceSize

 The size of instance that AWS recommends.
 


region
String region

 The AWS Region of the recommended reservation.
 


currentGeneration
Boolean currentGeneration

 Whether the recommendation is for a current-generation instance.
 


sizeFlexEligible
Boolean sizeFlexEligible

 Whether the recommended reservation is size flexible.
 








Class com.amazonaws.services.costexplorer.model.Expression extends Object implements Serializable


Serialized Fields


or
List<E> or

 Return results that match either Dimension object.
 


and
List<E> and

 Return results that match both Dimension objects.
 


not
Expression not

 Return results that don't match a Dimension object.
 


dimensions
DimensionValues dimensions

 The specific Dimension to use for Expression.
 


tags
TagValues tags

 The specific Tag to use for Expression.
 


costCategories
CostCategoryValues costCategories

  Cost Category is in public beta for AWS Billing and Cost Management and is subject to change. Your use of
 Cost Categories is subject to the Beta Service Participation terms of the AWS Service Terms (Section 1.10). 
 
 
 The specific CostCategory used for Expression.
 








Class com.amazonaws.services.costexplorer.model.ForecastResult extends Object implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 The period of time that the forecast covers.
 


meanValue
String meanValue

 The mean value of the forecast.
 


predictionIntervalLowerBound
String predictionIntervalLowerBound

 The lower limit for the prediction interval.
 


predictionIntervalUpperBound
String predictionIntervalUpperBound

 The upper limit for the prediction interval.
 








Class com.amazonaws.services.costexplorer.model.GetCostAndUsageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is
 exclusive. For example, if start is 2017-01-01 and end is
 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and
 including 2017-04-30 but not including 2017-05-01.
 


granularity
String granularity

 Sets the AWS cost granularity to MONTHLY or DAILY, or HOURLY. If
 Granularity isn't set, the response object doesn't include the Granularity, either
 MONTHLY or DAILY, or HOURLY.
 


filter
Expression filter

 Filters AWS costs by different dimensions. For example, you can specify SERVICE and
 LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You
 can nest Expression objects to define any combination of dimension filters. For more information,
 see Expression.
 


metrics
List<E> metrics

 Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended"
 annotation appear on some line items in my bill?.
 
 
 Valid values are AmortizedCost, BlendedCost, NetAmortizedCost,
 NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and
 UsageQuantity.
 
 
 
 If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into
 account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results
 aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for
 example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by
 UsageType or UsageTypeGroups.
 
 
 
 Metrics is required for GetCostAndUsage requests.
 


groupBy
List<E> groupBy

 You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.
 
 
 When you group by tag key, you get all tag values, including empty strings.
 
 
 Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME,
 LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE,
 SERVICE, TAGS, TENANCY, RECORD_TYPE, and
 USAGE_TYPE.
 


nextPageToken
String nextPageToken

 The token to retrieve the next set of results. AWS provides the token when the response from a previous call has
 more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.GetCostAndUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextPageToken
String nextPageToken

 The token for the next set of retrievable results. AWS provides the token when the response from a previous call
 has more results than the maximum page size.
 


groupDefinitions
List<E> groupDefinitions

 The groups that are specified by the Filter or GroupBy parameters in the request.
 


resultsByTime
List<E> resultsByTime

 The time period that is covered by the results in the response.
 








Class com.amazonaws.services.costexplorer.model.GetCostAndUsageWithResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 Sets the start and end dates for retrieving Amazon Web Services costs. The range must be within the last 14 days
 (the start date cannot be earlier than 14 days ago). The start date is inclusive, but the end date is exclusive.
 For example, if start is 2017-01-01 and end is 2017-05-01,
 then the cost and usage data is retrieved from 2017-01-01 up to and including
 2017-04-30 but not including 2017-05-01.
 


granularity
String granularity

 Sets the AWS cost granularity to MONTHLY, DAILY, or HOURLY. If
 Granularity isn't set, the response object doesn't include the Granularity,
 MONTHLY, DAILY, or HOURLY.
 


filter
Expression filter

 Filters Amazon Web Services costs by different dimensions. For example, you can specify SERVICE and
 LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You
 can nest Expression objects to define any combination of dimension filters. For more information,
 see Expression.
 
 
 The GetCostAndUsageWithResources operation requires that you either group by or filter by a
 ResourceId.
 


metrics
List<E> metrics

 Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the "blended"
 annotation appear on some line items in my bill?.
 
 
 Valid values are AmortizedCost, BlendedCost, NetAmortizedCost,
 NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and
 UsageQuantity.
 
 
 
 If you return the UsageQuantity metric, the service aggregates all usage numbers without taking the
 units into account. For example, if you aggregate usageQuantity across all of Amazon EC2, the
 results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for
 example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by
 UsageType or UsageTypeGroups.
 
 
 
 Metrics is required for GetCostAndUsageWithResources requests.
 


groupBy
List<E> groupBy

 You can group Amazon Web Services costs using up to two different groups: either dimensions, tag keys, or both.
 


nextPageToken
String nextPageToken

 The token to retrieve the next set of results. AWS provides the token when the response from a previous call has
 more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.GetCostAndUsageWithResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextPageToken
String nextPageToken

 The token for the next set of retrievable results. AWS provides the token when the response from a previous call
 has more results than the maximum page size.
 


groupDefinitions
List<E> groupDefinitions

 The groups that are specified by the Filter or GroupBy parameters in the request.
 


resultsByTime
List<E> resultsByTime

 The time period that is covered by the results in the response.
 








Class com.amazonaws.services.costexplorer.model.GetCostForecastRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 The period of time that you want the forecast to cover.
 


metric
String metric

 Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates,
 see Why does the "blended"
 annotation appear on some line items in my bill?.
 
 
 Valid values for a GetCostForecast call are the following:
 
 
 
 
 AMORTIZED_COST
 
 
 
 
 BLENDED_COST
 
 
 
 
 NET_AMORTIZED_COST
 
 
 
 
 NET_UNBLENDED_COST
 
 
 
 
 UNBLENDED_COST
 
 
 


granularity
String granularity

 How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of
 MONTHLY forecasts.
 
 
 The GetCostForecast operation supports only DAILY and MONTHLY
 granularities.
 


filter
Expression filter

 The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer
 filters.
 


predictionIntervalLevel
Integer predictionIntervalLevel

 Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around
 the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is
 about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction
 intervals.
 








Class com.amazonaws.services.costexplorer.model.GetCostForecastResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


total
MetricValue total

 How much you are forecasted to spend over the forecast period, in USD.
 


forecastResultsByTime
List<E> forecastResultsByTime

 The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For
 MONTHLY forecasts, this is a list of months.
 








Class com.amazonaws.services.costexplorer.model.GetDimensionValuesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


searchString
String searchString

 The value that you want to search the filter values for.
 


timePeriod
DateInterval timePeriod

 The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is
 exclusive. For example, if start is 2017-01-01 and end is
 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and
 including 2017-04-30 but not including 2017-05-01.
 


dimension
String dimension

 The name of the dimension. Each Dimension is available for a different Context. For
 more information, see Context.
 


context
String context

 The context for the call to GetDimensionValues. This can be RESERVATIONS or
 COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to
 RESERVATIONS, the resulting dimension values can be used in the
 GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the
 resulting dimension values can be used in the GetCostAndUsage operation.
 
 
 If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
 
 
 
 
 AZ - The Availability Zone. An example is us-east-1a.
 
 
 
 
 DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
 
 
 
 
 INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
 
 
 
 
 LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
 
 
 
 
 LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
 value field contains the AWS ID of the member account.
 
 
 
 
 OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
 
 
 
 
 OPERATION - The action performed. Examples include RunInstance and CreateBucket.
 
 
 
 
 PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
 
 
 
 
 PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand
 Instances and Standard Reserved Instances.
 
 
 
 
 SERVICE - The AWS service such as Amazon DynamoDB.
 
 
 
 
 USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
 GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
 
 
 
 
 USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The
 response for this operation includes a unit attribute.
 
 
 
 
 RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
 
 
 
 
 RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14
 days for EC2-Compute Service.
 
 
 
 
 If you set the context to RESERVATIONS, you can use the following dimensions for searching:
 
 
 
 
 AZ - The Availability Zone. An example is us-east-1a.
 
 
 
 
 CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
 
 
 
 
 DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
 SingleAZ and MultiAZ.
 
 
 
 
 INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
 
 
 
 
 LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
 value field contains the AWS ID of the member account.
 
 
 
 
 PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
 
 
 
 
 REGION - The AWS Region.
 
 
 
 
 SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability
 Zone.
 
 
 
 
 TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
 
 
 
 
 TENANCY - The tenancy of a resource. Examples are shared or dedicated.
 
 
 
 
 If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
 
 
 
 
 SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
 
 
 
 
 PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
 
 
 
 
 REGION - The AWS Region.
 
 
 
 
 INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
 
 
 
 
 LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
 value field contains the AWS ID of the member account.
 
 
 
 
 SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
 
 
 


nextPageToken
String nextPageToken

 The token to retrieve the next set of results. AWS provides the token when the response from a previous call has
 more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.GetDimensionValuesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dimensionValues
List<E> dimensionValues

 The filters that you used to filter your request. Some dimensions are available only for a specific context.
 
 
 If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:
 
 
 
 
 AZ - The Availability Zone. An example is us-east-1a.
 
 
 
 
 DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.
 
 
 
 
 INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
 
 
 
 
 LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.
 
 
 
 
 LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
 value field contains the AWS ID of the member account.
 
 
 
 
 OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
 
 
 
 
 OPERATION - The action performed. Examples include RunInstance and CreateBucket.
 
 
 
 
 PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
 
 
 
 
 PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand
 Instances and Standard Reserved Instances.
 
 
 
 
 SERVICE - The AWS service such as Amazon DynamoDB.
 
 
 
 
 USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the
 GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.
 
 
 
 
 USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The
 response for this operation includes a unit attribute.
 
 
 
 
 RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.
 
 
 
 
 RESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in feature only available for last 14
 days for EC2-Compute Service.
 
 
 
 
 If you set the context to RESERVATIONS, you can use the following dimensions for searching:
 
 
 
 
 AZ - The Availability Zone. An example is us-east-1a.
 
 
 
 
 CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.
 
 
 
 
 DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are
 SingleAZ and MultiAZ.
 
 
 
 
 INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.
 
 
 
 
 LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
 value field contains the AWS ID of the member account.
 
 
 
 
 PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.
 
 
 
 
 REGION - The AWS Region.
 
 
 
 
 SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability
 Zone.
 
 
 
 
 TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).
 
 
 
 
 TENANCY - The tenancy of a resource. Examples are shared or dedicated.
 
 
 
 
 If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:
 
 
 
 
 SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
 
 
 
 
 PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)
 
 
 
 
 REGION - The AWS Region.
 
 
 
 
 INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)
 
 
 
 
 LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The
 value field contains the AWS ID of the member account.
 
 
 
 
 SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan
 
 
 


returnSize
Integer returnSize

 The number of results that AWS returned at one time.
 


totalSize
Integer totalSize

 The total number of search results.
 


nextPageToken
String nextPageToken

 The token for the next set of retrievable results. AWS provides the token when the response from a previous call
 has more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.GetReservationCoverageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 The start and end dates of the period that you want to retrieve data about reservation coverage for. You can
 retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive,
 but the end date is exclusive. For example, if start is 2017-01-01 and end
 is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and
 including 2017-04-30 but not including 2017-05-01.
 


groupBy
List<E> groupBy

 You can group the data by the following attributes:
 
 
 
 
 AZ
 
 
 
 
 CACHE_ENGINE
 
 
 
 
 DATABASE_ENGINE
 
 
 
 
 DEPLOYMENT_OPTION
 
 
 
 
 INSTANCE_TYPE
 
 
 
 
 LINKED_ACCOUNT
 
 
 
 
 OPERATING_SYSTEM
 
 
 
 
 PLATFORM
 
 
 
 
 REGION
 
 
 
 
 TENANCY
 
 
 


granularity
String granularity

 The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and
 DAILY.
 
 
 If GroupBy is set, Granularity can't be set. If Granularity isn't set, the
 response object doesn't include Granularity, either MONTHLY or DAILY.
 
 
 The GetReservationCoverage operation supports only DAILY and MONTHLY
 granularities.
 


filter
Expression filter

 Filters utilization data by dimensions. You can filter by the following dimensions:
 
 
 
 
 AZ
 
 
 
 
 CACHE_ENGINE
 
 
 
 
 DATABASE_ENGINE
 
 
 
 
 DEPLOYMENT_OPTION
 
 
 
 
 INSTANCE_TYPE
 
 
 
 
 LINKED_ACCOUNT
 
 
 
 
 OPERATING_SYSTEM
 
 
 
 
 PLATFORM
 
 
 
 
 REGION
 
 
 
 
 SERVICE
 
 
 
 
 TAG
 
 
 
 
 TENANCY
 
 
 
 
 GetReservationCoverage uses the same Expression
 object as the other operations, but only AND is supported among each dimension. You can nest only
 one level deep. If there are multiple values for a dimension, they are OR'd together.
 
 
 If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.
 


metrics
List<E> metrics

 The measurement that you want your reservation coverage reported in.
 
 
 Valid values are Hour, Unit, and Cost. You can use multiple values in a
 request.
 


nextPageToken
String nextPageToken

 The token to retrieve the next set of results. AWS provides the token when the response from a previous call has
 more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.GetReservationCoverageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


coveragesByTime
List<E> coveragesByTime

 The amount of time that your reservations covered.
 


total
Coverage total

 The total amount of instance usage that a reservation covered.
 


nextPageToken
String nextPageToken

 The token for the next set of retrievable results. AWS provides the token when the response from a previous call
 has more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.GetReservationPurchaseRecommendationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The account ID that is associated with the recommendation.
 


service
String service

 The specific service that you want recommendations for.
 


accountScope
String accountScope

 The account scope that you want recommendations for. PAYER means that AWS includes the master
 account and any member accounts when it calculates its recommendations. LINKED means that AWS
 includes only member accounts when it calculates its recommendations.
 
 
 Valid values are PAYER and LINKED.
 


lookbackPeriodInDays
String lookbackPeriodInDays

 The number of previous days that you want AWS to consider when it calculates your recommendations.
 


termInYears
String termInYears

 The reservation term that you want recommendations for.
 


paymentOption
String paymentOption

 The reservation purchase option that you want recommendations for.
 


serviceSpecification
ServiceSpecification serviceSpecification

 The hardware specifications for the service instances that you want recommendations for, such as standard or
 convertible Amazon EC2 instances.
 


pageSize
Integer pageSize

 The number of recommendations that you want returned in a single response object.
 


nextPageToken
String nextPageToken

 The pagination token that indicates the next set of results that you want to retrieve.
 








Class com.amazonaws.services.costexplorer.model.GetReservationPurchaseRecommendationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


metadata
ReservationPurchaseRecommendationMetadata metadata

 Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this
 recommendation.
 


recommendations
List<E> recommendations

 Recommendations for reservations to purchase.
 


nextPageToken
String nextPageToken

 The pagination token for the next set of retrievable results.
 








Class com.amazonaws.services.costexplorer.model.GetReservationUtilizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 Sets the start and end dates for retrieving RI utilization. The start date is inclusive, but the end date is
 exclusive. For example, if start is 2017-01-01 and end is
 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and
 including 2017-04-30 but not including 2017-05-01.
 


groupBy
List<E> groupBy

 Groups only by SUBSCRIPTION_ID. Metadata is included.
 


granularity
String granularity

 If GroupBy is set, Granularity can't be set. If Granularity isn't set, the
 response object doesn't include Granularity, either MONTHLY or DAILY. If
 both GroupBy and Granularity aren't set, GetReservationUtilization
 defaults to DAILY.
 
 
 The GetReservationUtilization operation supports only DAILY and MONTHLY
 granularities.
 


filter
Expression filter

 Filters utilization data by dimensions. You can filter by the following dimensions:
 
 
 
 
 AZ
 
 
 
 
 CACHE_ENGINE
 
 
 
 
 DEPLOYMENT_OPTION
 
 
 
 
 INSTANCE_TYPE
 
 
 
 
 LINKED_ACCOUNT
 
 
 
 
 OPERATING_SYSTEM
 
 
 
 
 PLATFORM
 
 
 
 
 REGION
 
 
 
 
 SERVICE
 
 
 
 
 SCOPE
 
 
 
 
 TENANCY
 
 
 
 
 GetReservationUtilization uses the same Expression
 object as the other operations, but only AND is supported among each dimension, and nesting is
 supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.
 


nextPageToken
String nextPageToken

 The token to retrieve the next set of results. AWS provides the token when the response from a previous call has
 more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.GetReservationUtilizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


utilizationsByTime
List<E> utilizationsByTime

 The amount of time that you used your RIs.
 


total
ReservationAggregates total

 The total amount of time that you used your RIs.
 


nextPageToken
String nextPageToken

 The token for the next set of retrievable results. AWS provides the token when the response from a previous call
 has more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.GetRightsizingRecommendationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
Expression filter


service
String service

 The specific service that you want recommendations for. The only valid value for
 GetRightsizingRecommendation is "AmazonEC2".
 


pageSize
Integer pageSize

 The number of recommendations that you want returned in a single response object.
 


nextPageToken
String nextPageToken

 The pagination token that indicates the next set of results that you want to retrieve.
 








Class com.amazonaws.services.costexplorer.model.GetRightsizingRecommendationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


metadata
RightsizingRecommendationMetadata metadata

 Information regarding this specific recommendation set.
 


summary
RightsizingRecommendationSummary summary

 Summary of this recommendation set.
 


rightsizingRecommendations
List<E> rightsizingRecommendations

 Recommendations to rightsize resources.
 


nextPageToken
String nextPageToken

 The token to retrieve the next set of results.
 








Class com.amazonaws.services.costexplorer.model.GetSavingsPlansCoverageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 The time period that you want the usage and costs for. The Start date must be within 13 months. The
 End date must be after the Start date, and before the current date. Future dates can't
 be used as an End date.
 


groupBy
List<E> groupBy

 You can group the data using the attributes INSTANCE_FAMILY, REGION, or
 SERVICE.
 


granularity
String granularity

 The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be
 set if GroupBy is set.
 
 
 The GetSavingsPlansCoverage operation supports only DAILY and MONTHLY
 granularities.
 


filter
Expression filter

 Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following
 dimensions:
 
 
 
 
 LINKED_ACCOUNT
 
 
 
 
 REGION
 
 
 
 
 SERVICE
 
 
 
 
 INSTANCE_FAMILY
 
 
 
 
 GetSavingsPlansCoverage uses the same Expression
 object as the other operations, but only AND is supported among each dimension. If there are
 multiple values for a dimension, they are OR'd together.
 


metrics
List<E> metrics

 The measurement that you want your Savings Plans coverage reported in. The only valid value is
 SpendCoveredBySavingsPlans.
 


nextToken
String nextToken

 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a
 previous call has more results than the maximum page size.
 


maxResults
Integer maxResults

 The number of items to be returned in a response. The default is 20, with a minimum value of
 1.
 








Class com.amazonaws.services.costexplorer.model.GetSavingsPlansCoverageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


savingsPlansCoverages
List<E> savingsPlansCoverages

 The amount of spend that your Savings Plans covered.
 


nextToken
String nextToken

 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a
 previous call has more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.GetSavingsPlansPurchaseRecommendationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


savingsPlansType
String savingsPlansType

 The Savings Plans recommendation type requested.
 


termInYears
String termInYears

 The savings plan recommendation term used to generated these recommendations.
 


paymentOption
String paymentOption

 The payment option used to generate these recommendations.
 


nextPageToken
String nextPageToken

 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a
 previous call has more results than the maximum page size.
 


pageSize
Integer pageSize

 The number of recommendations that you want returned in a single response object.
 


lookbackPeriodInDays
String lookbackPeriodInDays

 The lookback period used to generate the recommendation.
 








Class com.amazonaws.services.costexplorer.model.GetSavingsPlansPurchaseRecommendationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


metadata
SavingsPlansPurchaseRecommendationMetadata metadata

 Information regarding this specific recommendation set.
 


savingsPlansPurchaseRecommendation
SavingsPlansPurchaseRecommendation savingsPlansPurchaseRecommendation

 Contains your request parameters, Savings Plan Recommendations Summary, and Details.
 


nextPageToken
String nextPageToken

 The token for the next set of retrievable results. AWS provides the token when the response from a previous call
 has more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.GetSavingsPlansUtilizationDetailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 The time period that you want the usage and costs for. The Start date must be within 13 months. The
 End date must be after the Start date, and before the current date. Future dates can't
 be used as an End date.
 


filter
Expression filter

 Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the
 following dimensions:
 
 
 
 
 LINKED_ACCOUNT
 
 
 
 
 SAVINGS_PLAN_ARN
 
 
 
 
 REGION
 
 
 
 
 PAYMENT_OPTION
 
 
 
 
 INSTANCE_TYPE_FAMILY
 
 
 
 
 GetSavingsPlansUtilizationDetails uses the same Expression
 object as the other operations, but only AND is supported among each dimension.
 


nextToken
String nextToken

 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a
 previous call has more results than the maximum page size.
 


maxResults
Integer maxResults

 The number of items to be returned in a response. The default is 20, with a minimum value of
 1.
 








Class com.amazonaws.services.costexplorer.model.GetSavingsPlansUtilizationDetailsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


savingsPlansUtilizationDetails
List<E> savingsPlansUtilizationDetails

 Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.
 


total
SavingsPlansUtilizationAggregates total

 The total Savings Plans utilization, regardless of time period.
 


timePeriod
DateInterval timePeriod


nextToken
String nextToken

 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a
 previous call has more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.GetSavingsPlansUtilizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 The time period that you want the usage and costs for. The Start date must be within 13 months. The
 End date must be after the Start date, and before the current date. Future dates can't
 be used as an End date.
 


granularity
String granularity

 The granularity of the Amazon Web Services utillization data for your Savings Plans.
 
 
 The GetSavingsPlansUtilization operation supports only DAILY and MONTHLY
 granularities.
 


filter
Expression filter

 Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the
 following dimensions:
 
 
 
 
 LINKED_ACCOUNT
 
 
 
 
 SAVINGS_PLAN_ARN
 
 
 
 
 SAVINGS_PLANS_TYPE
 
 
 
 
 REGION
 
 
 
 
 PAYMENT_OPTION
 
 
 
 
 INSTANCE_TYPE_FAMILY
 
 
 
 
 GetSavingsPlansUtilization uses the same Expression
 object as the other operations, but only AND is supported among each dimension.
 








Class com.amazonaws.services.costexplorer.model.GetSavingsPlansUtilizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


savingsPlansUtilizationsByTime
List<E> savingsPlansUtilizationsByTime

 The amount of cost/commitment you used your Savings Plans. This allows you to specify date ranges.
 


total
SavingsPlansUtilizationAggregates total

 The total amount of cost/commitment that you used your Savings Plans, regardless of date ranges.
 








Class com.amazonaws.services.costexplorer.model.GetTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


searchString
String searchString

 The value that you want to search for.
 


timePeriod
DateInterval timePeriod

 The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is
 exclusive. For example, if start is 2017-01-01 and end is
 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and
 including 2017-04-30 but not including 2017-05-01.
 


tagKey
String tagKey

 The key of the tag that you want to return values for.
 


nextPageToken
String nextPageToken

 The token to retrieve the next set of results. AWS provides the token when the response from a previous call has
 more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.GetTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextPageToken
String nextPageToken

 The token for the next set of retrievable results. AWS provides the token when the response from a previous call
 has more results than the maximum page size.
 


tags
List<E> tags

 The tags that match your request.
 


returnSize
Integer returnSize

 The number of query results that AWS returns at a time.
 


totalSize
Integer totalSize

 The total number of query results.
 








Class com.amazonaws.services.costexplorer.model.GetUsageForecastRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive,
 but the end date is exclusive. For example, if start is 2017-01-01 and end
 is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and
 including 2017-04-30 but not including 2017-05-01.
 


metric
String metric

 Which metric Cost Explorer uses to create your forecast.
 
 
 Valid values for a GetUsageForecast call are the following:
 
 
 
 
 USAGE_QUANTITY
 
 
 
 
 NORMALIZED_USAGE_AMOUNT
 
 
 


granularity
String granularity

 How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of
 MONTHLY forecasts.
 
 
 The GetUsageForecast operation supports only DAILY and MONTHLY
 granularities.
 


filter
Expression filter

 The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer
 filters.
 


predictionIntervalLevel
Integer predictionIntervalLevel

 Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around
 the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is
 about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction
 intervals.
 








Class com.amazonaws.services.costexplorer.model.GetUsageForecastResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


total
MetricValue total

 How much you're forecasted to use over the forecast period.
 


forecastResultsByTime
List<E> forecastResultsByTime

 The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For
 MONTHLY forecasts, this is a list of months.
 








Class com.amazonaws.services.costexplorer.model.Group extends Object implements Serializable


Serialized Fields


keys
List<E> keys

 The keys that are included in this group.
 


metrics
Map<K,V> metrics

 The metrics that are included in this group.
 








Class com.amazonaws.services.costexplorer.model.GroupDefinition extends Object implements Serializable


Serialized Fields


type
String type

 The string that represents the type of group.
 


key
String key

 The string that represents a key for a specified group.
 








Class com.amazonaws.services.costexplorer.model.InstanceDetails extends Object implements Serializable


Serialized Fields


eC2InstanceDetails
EC2InstanceDetails eC2InstanceDetails

 The Amazon EC2 instances that AWS recommends that you purchase.
 


rDSInstanceDetails
RDSInstanceDetails rDSInstanceDetails

 The Amazon RDS instances that AWS recommends that you purchase.
 


redshiftInstanceDetails
RedshiftInstanceDetails redshiftInstanceDetails

 The Amazon Redshift instances that AWS recommends that you purchase.
 


elastiCacheInstanceDetails
ElastiCacheInstanceDetails elastiCacheInstanceDetails

 The ElastiCache instances that AWS recommends that you purchase.
 


eSInstanceDetails
ESInstanceDetails eSInstanceDetails

 The Amazon ES instances that AWS recommends that you purchase.
 








Class com.amazonaws.services.costexplorer.model.InvalidNextTokenException extends AWSCostExplorerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costexplorer.model.LimitExceededException extends AWSCostExplorerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costexplorer.model.ListCostCategoryDefinitionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


effectiveOn
String effectiveOn

 The date when the Cost Category was effective.
 


nextToken
String nextToken

 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a
 previous call has more results than the maximum page size.
 
 
 You can use this information to retrieve the full Cost Category information using
 DescribeCostCategory.
 








Class com.amazonaws.services.costexplorer.model.ListCostCategoryDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


costCategoryReferences
List<E> costCategoryReferences

 A reference to a Cost Category containing enough information to identify the Cost Category.
 


nextToken
String nextToken

 The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a
 previous call has more results than the maximum page size.
 








Class com.amazonaws.services.costexplorer.model.MetricValue extends Object implements Serializable


Serialized Fields


amount
String amount

 The actual number that represents the metric.
 


unit
String unit

 The unit that the metric is given in.
 








Class com.amazonaws.services.costexplorer.model.ModifyRecommendationDetail extends Object implements Serializable


Serialized Fields


targetInstances
List<E> targetInstances

 Identifies whether this instance type is the Amazon Web Services default recommendation.
 








Class com.amazonaws.services.costexplorer.model.RDSInstanceDetails extends Object implements Serializable


Serialized Fields


family
String family

 The instance family of the recommended reservation.
 


instanceType
String instanceType

 The type of instance that AWS recommends.
 


region
String region

 The AWS Region of the recommended reservation.
 


databaseEngine
String databaseEngine

 The database engine that the recommended reservation supports.
 


databaseEdition
String databaseEdition

 The database edition that the recommended reservation supports.
 


deploymentOption
String deploymentOption

 Whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a
 second Availability Zone.
 


licenseModel
String licenseModel

 The license model that the recommended reservation supports.
 


currentGeneration
Boolean currentGeneration

 Whether the recommendation is for a current-generation instance.
 


sizeFlexEligible
Boolean sizeFlexEligible

 Whether the recommended reservation is size flexible.
 








Class com.amazonaws.services.costexplorer.model.RedshiftInstanceDetails extends Object implements Serializable


Serialized Fields


family
String family

 The instance family of the recommended reservation.
 


nodeType
String nodeType

 The type of node that AWS recommends.
 


region
String region

 The AWS Region of the recommended reservation.
 


currentGeneration
Boolean currentGeneration

 Whether the recommendation is for a current-generation instance.
 


sizeFlexEligible
Boolean sizeFlexEligible

 Whether the recommended reservation is size flexible.
 








Class com.amazonaws.services.costexplorer.model.RequestChangedException extends AWSCostExplorerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costexplorer.model.ReservationAggregates extends Object implements Serializable


Serialized Fields


utilizationPercentage
String utilizationPercentage

 The percentage of reservation time that you used.
 


utilizationPercentageInUnits
String utilizationPercentageInUnits

 The percentage of Amazon EC2 reservation time that you used, converted to normalized units. Normalized units are
 available only for Amazon EC2 usage after November 11, 2017.
 


purchasedHours
String purchasedHours

 How many reservation hours that you purchased.
 


purchasedUnits
String purchasedUnits

 How many Amazon EC2 reservation hours that you purchased, converted to normalized units. Normalized units are
 available only for Amazon EC2 usage after November 11, 2017.
 


totalActualHours
String totalActualHours

 The total number of reservation hours that you used.
 


totalActualUnits
String totalActualUnits

 The total number of Amazon EC2 reservation hours that you used, converted to normalized units. Normalized units
 are available only for Amazon EC2 usage after November 11, 2017.
 


unusedHours
String unusedHours

 The number of reservation hours that you didn't use.
 


unusedUnits
String unusedUnits

 The number of Amazon EC2 reservation hours that you didn't use, converted to normalized units. Normalized units
 are available only for Amazon EC2 usage after November 11, 2017.
 


onDemandCostOfRIHoursUsed
String onDemandCostOfRIHoursUsed

 How much your reservation would cost if charged On-Demand rates.
 


netRISavings
String netRISavings

 How much you saved due to purchasing and utilizing reservation. AWS calculates this by subtracting
 TotalAmortizedFee from OnDemandCostOfRIHoursUsed.
 


totalPotentialRISavings
String totalPotentialRISavings

 How much you could save if you use your entire reservation.
 


amortizedUpfrontFee
String amortizedUpfrontFee

 The upfront cost of your reservation, amortized over the reservation period.
 


amortizedRecurringFee
String amortizedRecurringFee

 The monthly cost of your reservation, amortized over the reservation period.
 


totalAmortizedFee
String totalAmortizedFee

 The total cost of your reservation, amortized over the reservation period.
 








Class com.amazonaws.services.costexplorer.model.ReservationCoverageGroup extends Object implements Serializable


Serialized Fields


attributes
Map<K,V> attributes

 The attributes for this group of reservations.
 


coverage
Coverage coverage

 How much instance usage this group of reservations covered.
 








Class com.amazonaws.services.costexplorer.model.ReservationPurchaseRecommendation extends Object implements Serializable


Serialized Fields


accountScope
String accountScope

 The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this
 reservation for an entire organization in AWS Organizations.
 


lookbackPeriodInDays
String lookbackPeriodInDays

 How many days of previous usage that AWS considers when making this recommendation.
 


termInYears
String termInYears

 The term of the reservation that you want recommendations for, in years.
 


paymentOption
String paymentOption

 The payment option for the reservation. For example, AllUpfront or NoUpfront.
 


serviceSpecification
ServiceSpecification serviceSpecification

 Hardware specifications for the service that you want recommendations for.
 


recommendationDetails
List<E> recommendationDetails

 Details about the recommended purchases.
 


recommendationSummary
ReservationPurchaseRecommendationSummary recommendationSummary

 A summary about the recommended purchase.
 








Class com.amazonaws.services.costexplorer.model.ReservationPurchaseRecommendationDetail extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The account that this RI recommendation is for.
 


instanceDetails
InstanceDetails instanceDetails

 Details about the instances that AWS recommends that you purchase.
 


recommendedNumberOfInstancesToPurchase
String recommendedNumberOfInstancesToPurchase

 The number of instances that AWS recommends that you purchase.
 


recommendedNormalizedUnitsToPurchase
String recommendedNormalizedUnitsToPurchase

 The number of normalized units that AWS recommends that you purchase.
 


minimumNumberOfInstancesUsedPerHour
String minimumNumberOfInstancesUsedPerHour

 The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate
 your recommended reservation purchases.
 


minimumNormalizedUnitsUsedPerHour
String minimumNormalizedUnitsUsedPerHour

 The minimum number of normalized units that you used in an hour during the historical period. AWS uses this to
 calculate your recommended reservation purchases.
 


maximumNumberOfInstancesUsedPerHour
String maximumNumberOfInstancesUsedPerHour

 The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate
 your recommended reservation purchases.
 


maximumNormalizedUnitsUsedPerHour
String maximumNormalizedUnitsUsedPerHour

 The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to
 calculate your recommended reservation purchases.
 


averageNumberOfInstancesUsedPerHour
String averageNumberOfInstancesUsedPerHour

 The average number of instances that you used in an hour during the historical period. AWS uses this to calculate
 your recommended reservation purchases.
 


averageNormalizedUnitsUsedPerHour
String averageNormalizedUnitsUsedPerHour

 The average number of normalized units that you used in an hour during the historical period. AWS uses this to
 calculate your recommended reservation purchases.
 


averageUtilization
String averageUtilization

 The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.
 


estimatedBreakEvenInMonths
String estimatedBreakEvenInMonths

 How long AWS estimates that it takes for this instance to start saving you money, in months.
 


currencyCode
String currencyCode

 The currency code that AWS used to calculate the costs for this instance.
 


estimatedMonthlySavingsAmount
String estimatedMonthlySavingsAmount

 How much AWS estimates that this specific recommendation could save you in a month.
 


estimatedMonthlySavingsPercentage
String estimatedMonthlySavingsPercentage

 How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your
 overall costs.
 


estimatedMonthlyOnDemandCost
String estimatedMonthlyOnDemandCost

 How much AWS estimates that you spend on On-Demand Instances in a month.
 


estimatedReservationCostForLookbackPeriod
String estimatedReservationCostForLookbackPeriod

 How much AWS estimates that you would have spent for all usage during the specified historical period if you had
 a reservation.
 


upfrontCost
String upfrontCost

 How much purchasing this instance costs you upfront.
 


recurringStandardMonthlyCost
String recurringStandardMonthlyCost

 How much purchasing this instance costs you on a monthly basis.
 








Class com.amazonaws.services.costexplorer.model.ReservationPurchaseRecommendationMetadata extends Object implements Serializable


Serialized Fields


recommendationId
String recommendationId

 The ID for this specific recommendation.
 


generationTimestamp
String generationTimestamp

 The time stamp for when AWS made this recommendation.
 








Class com.amazonaws.services.costexplorer.model.ReservationPurchaseRecommendationSummary extends Object implements Serializable


Serialized Fields


totalEstimatedMonthlySavingsAmount
String totalEstimatedMonthlySavingsAmount

 The total amount that AWS estimates that this recommendation could save you in a month.
 


totalEstimatedMonthlySavingsPercentage
String totalEstimatedMonthlySavingsPercentage

 The total amount that AWS estimates that this recommendation could save you in a month, as a percentage of your
 costs.
 


currencyCode
String currencyCode

 The currency code used for this recommendation.
 








Class com.amazonaws.services.costexplorer.model.ReservationUtilizationGroup extends Object implements Serializable


Serialized Fields


key
String key

 The key for a specific reservation attribute.
 


value
String value

 The value of a specific reservation attribute.
 


attributes
Map<K,V> attributes

 The attributes for this group of reservations.
 


utilization
ReservationAggregates utilization

 How much you used this group of reservations.
 








Class com.amazonaws.services.costexplorer.model.ResourceDetails extends Object implements Serializable


Serialized Fields


eC2ResourceDetails
EC2ResourceDetails eC2ResourceDetails

 Details on the Amazon EC2 resource.
 








Class com.amazonaws.services.costexplorer.model.ResourceNotFoundException extends AWSCostExplorerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costexplorer.model.ResourceUtilization extends Object implements Serializable


Serialized Fields


eC2ResourceUtilization
EC2ResourceUtilization eC2ResourceUtilization

 Utilization of current Amazon EC2 Instance
 








Class com.amazonaws.services.costexplorer.model.ResultByTime extends Object implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 The time period that the result covers.
 


total
Map<K,V> total

 The total amount of cost or usage accrued during the time period.
 


groups
List<E> groups

 The groups that this time period includes.
 


estimated
Boolean estimated

 Whether the result is estimated.
 








Class com.amazonaws.services.costexplorer.model.RightsizingRecommendation extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The account that this recommendation is for.
 


currentInstance
CurrentInstance currentInstance

 Context regarding the current instance.
 


rightsizingType
String rightsizingType

 Recommendation to either terminate or modify the resource.
 


modifyRecommendationDetail
ModifyRecommendationDetail modifyRecommendationDetail

 Details for modification recommendations.
 


terminateRecommendationDetail
TerminateRecommendationDetail terminateRecommendationDetail

 Details for termination recommendations.
 








Class com.amazonaws.services.costexplorer.model.RightsizingRecommendationMetadata extends Object implements Serializable


Serialized Fields


recommendationId
String recommendationId

 The ID for this specific recommendation.
 


generationTimestamp
String generationTimestamp

 The time stamp for when Amazon Web Services made this recommendation.
 


lookbackPeriodInDays
String lookbackPeriodInDays

 How many days of previous usage that Amazon Web Services considers when making this recommendation.
 








Class com.amazonaws.services.costexplorer.model.RightsizingRecommendationSummary extends Object implements Serializable


Serialized Fields


totalRecommendationCount
String totalRecommendationCount

 Total number of instance recommendations.
 


estimatedTotalMonthlySavingsAmount
String estimatedTotalMonthlySavingsAmount

 Estimated total savings resulting from modifications, on a monthly basis.
 


savingsCurrencyCode
String savingsCurrencyCode

 The currency code that Amazon Web Services used to calculate the savings.
 


savingsPercentage
String savingsPercentage

 Savings percentage based on the recommended modifications, relative to the total On Demand costs associated with
 these instances.
 








Class com.amazonaws.services.costexplorer.model.SavingsPlansAmortizedCommitment extends Object implements Serializable


Serialized Fields


amortizedRecurringCommitment
String amortizedRecurringCommitment

 The amortized amount of your Savings Plans commitment that was purchased with either a Partial or a
 NoUpfront.
 


amortizedUpfrontCommitment
String amortizedUpfrontCommitment

 The amortized amount of your Savings Plans commitment that was purchased with an Upfront or
 PartialUpfront Savings Plans.
 


totalAmortizedCommitment
String totalAmortizedCommitment

 The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.
 








Class com.amazonaws.services.costexplorer.model.SavingsPlansCoverage extends Object implements Serializable


Serialized Fields


attributes
Map<K,V> attributes

 The attribute that applies to a specific Dimension.
 


coverage
SavingsPlansCoverageData coverage

 The amount of Savings Plans eligible usage that the Savings Plans covered.
 


timePeriod
DateInterval timePeriod








Class com.amazonaws.services.costexplorer.model.SavingsPlansCoverageData extends Object implements Serializable


Serialized Fields


spendCoveredBySavingsPlans
String spendCoveredBySavingsPlans

 The amount of your Amazon Web Services usage that is covered by a Savings Plans.
 


onDemandCost
String onDemandCost

 The cost of your Amazon Web Services usage at the public On-Demand rate.
 


totalCost
String totalCost

 The total cost of your Amazon Web Services usage, regardless of your purchase option.
 


coveragePercentage
String coveragePercentage

 The percentage of your existing Savings Planscovered usage, divided by all of your eligible Savings Plans usage
 in an account(or set of accounts).
 








Class com.amazonaws.services.costexplorer.model.SavingsPlansDetails extends Object implements Serializable


Serialized Fields


region
String region

 A collection of AWS resources in a geographic area. Each AWS Region is isolated and independent of the other
 Regions.
 


instanceFamily
String instanceFamily

 A group of instance types that Savings Plans applies to.
 


offeringId
String offeringId

 The unique ID used to distinguish Savings Plans from one another.
 








Class com.amazonaws.services.costexplorer.model.SavingsPlansPurchaseRecommendation extends Object implements Serializable


Serialized Fields


savingsPlansType
String savingsPlansType

 The requested Savings Plans recommendation type.
 


termInYears
String termInYears

 The Savings Plans recommendation term in years, used to generate the recommendation.
 


paymentOption
String paymentOption

 The payment option used to generate the recommendation.
 


lookbackPeriodInDays
String lookbackPeriodInDays

 The lookback period in days, used to generate the recommendation.
 


savingsPlansPurchaseRecommendationDetails
List<E> savingsPlansPurchaseRecommendationDetails

 Details for the Savings Plans we recommend you to purchase to cover existing, Savings Plans eligible workloads.
 


savingsPlansPurchaseRecommendationSummary
SavingsPlansPurchaseRecommendationSummary savingsPlansPurchaseRecommendationSummary

 Summary metrics for your Savings Plans Recommendations.
 








Class com.amazonaws.services.costexplorer.model.SavingsPlansPurchaseRecommendationDetail extends Object implements Serializable


Serialized Fields


savingsPlansDetails
SavingsPlansDetails savingsPlansDetails

 Details for your recommended Savings Plans.
 


accountId
String accountId

 The AccountID the recommendation is generated for.
 


upfrontCost
String upfrontCost

 The upfront cost of the recommended Savings Plans, based on the selected payment option.
 


estimatedROI
String estimatedROI

 The estimated return on investment based on the recommended Savings Plans purchased. This is calculated as
 estimatedSavingsAmount/ estimatedSPCost*100.
 


currencyCode
String currencyCode

 The currency code Amazon Web Services used to generate the recommendations and present potential savings.
 


estimatedSPCost
String estimatedSPCost

 The cost of the recommended Savings Plans over the length of the lookback period.
 


estimatedOnDemandCost
String estimatedOnDemandCost

 The remaining On-Demand cost estimated to not be covered by the recommended Savings Plans, over the length of the
 lookback period.
 


estimatedOnDemandCostWithCurrentCommitment
String estimatedOnDemandCostWithCurrentCommitment

 The estimated On-Demand costs you would expect with no additional commitment, based on your usage of the selected
 time period and the Savings Plans you own.
 


estimatedSavingsAmount
String estimatedSavingsAmount

 The estimated savings amount based on the recommended Savings Plans over the length of the lookback period.
 


estimatedSavingsPercentage
String estimatedSavingsPercentage

 The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback
 period.
 


hourlyCommitmentToPurchase
String hourlyCommitmentToPurchase

 The recommended hourly commitment level for the Savings Plans type, and configuration based on the usage during
 the lookback period.
 


estimatedAverageUtilization
String estimatedAverageUtilization

 The estimated utilization of the recommended Savings Plans.
 


estimatedMonthlySavingsAmount
String estimatedMonthlySavingsAmount

 The estimated monthly savings amount, based on the recommended Savings Plans.
 


currentMinimumHourlyOnDemandSpend
String currentMinimumHourlyOnDemandSpend

 The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.
 


currentMaximumHourlyOnDemandSpend
String currentMaximumHourlyOnDemandSpend

 The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.
 


currentAverageHourlyOnDemandSpend
String currentAverageHourlyOnDemandSpend

 The average value of hourly On-Demand spend over the lookback period of the applicable usage type.
 








Class com.amazonaws.services.costexplorer.model.SavingsPlansPurchaseRecommendationMetadata extends Object implements Serializable


Serialized Fields


recommendationId
String recommendationId

 The unique identifier for the recommendation set.
 


generationTimestamp
String generationTimestamp

 The timestamp showing when the recommendations were generated.
 








Class com.amazonaws.services.costexplorer.model.SavingsPlansPurchaseRecommendationSummary extends Object implements Serializable


Serialized Fields


estimatedROI
String estimatedROI

 The estimated return on investment based on the recommended Savings Plans and estimated savings.
 


currencyCode
String currencyCode

 The currency code Amazon Web Services used to generate the recommendations and present potential savings.
 


estimatedTotalCost
String estimatedTotalCost

 The estimated total cost of the usage after purchasing the recommended Savings Plans. This is a sum of the cost
 of Savings Plans during this term, and the remaining On-Demand usage.
 


currentOnDemandSpend
String currentOnDemandSpend

 The current total on demand spend of the applicable usage types over the lookback period.
 


estimatedSavingsAmount
String estimatedSavingsAmount

 The estimated total savings over the lookback period, based on the purchase of the recommended Savings Plans.
 


totalRecommendationCount
String totalRecommendationCount

 The aggregate number of Savings Plans recommendations that exist for your account.
 


dailyCommitmentToPurchase
String dailyCommitmentToPurchase

 The recommended Savings Plans cost on a daily (24 hourly) basis.
 


hourlyCommitmentToPurchase
String hourlyCommitmentToPurchase

 The recommended hourly commitment based on the recommendation parameters.
 


estimatedSavingsPercentage
String estimatedSavingsPercentage

 The estimated savings relative to the total cost of On-Demand usage, over the lookback period. This is calculated
 as estimatedSavingsAmount/ CurrentOnDemandSpend*100.
 


estimatedMonthlySavingsAmount
String estimatedMonthlySavingsAmount

 The estimated monthly savings amount, based on the recommended Savings Plans purchase.
 


estimatedOnDemandCostWithCurrentCommitment
String estimatedOnDemandCostWithCurrentCommitment

 The estimated On-Demand costs you would expect with no additional commitment, based on your usage of the selected
 time period and the Savings Plans you own.
 








Class com.amazonaws.services.costexplorer.model.SavingsPlansSavings extends Object implements Serializable


Serialized Fields


netSavings
String netSavings

 The savings amount that you are accumulating for the usage that is covered by a Savings Plans, when compared to
 the On-Demand equivalent of the same usage.
 


onDemandCostEquivalent
String onDemandCostEquivalent

 How much the amount that the usage would have cost if it was accrued at the On-Demand rate.
 








Class com.amazonaws.services.costexplorer.model.SavingsPlansUtilization extends Object implements Serializable


Serialized Fields


totalCommitment
String totalCommitment

 The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).
 


usedCommitment
String usedCommitment

 The amount of your Savings Plans commitment that was consumed from Savings Plans eligible usage in a specific
 period.
 


unusedCommitment
String unusedCommitment

 The amount of your Savings Plans commitment that was not consumed from Savings Plans eligible usage in a specific
 period.
 


utilizationPercentage
String utilizationPercentage

 The amount of UsedCommitment divided by the TotalCommitment for your Savings Plans.
 








Class com.amazonaws.services.costexplorer.model.SavingsPlansUtilizationAggregates extends Object implements Serializable


Serialized Fields


utilization
SavingsPlansUtilization utilization

 A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans
 eligible.
 


savings
SavingsPlansSavings savings

 The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans, as well as
 the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
 


amortizedCommitment
SavingsPlansAmortizedCommitment amortizedCommitment

 The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings
 Plans fees.
 








Class com.amazonaws.services.costexplorer.model.SavingsPlansUtilizationByTime extends Object implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod


utilization
SavingsPlansUtilization utilization

 A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans
 eligible.
 


savings
SavingsPlansSavings savings

 The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans as well as
 the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
 


amortizedCommitment
SavingsPlansAmortizedCommitment amortizedCommitment

 The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings
 Plans fees.
 








Class com.amazonaws.services.costexplorer.model.SavingsPlansUtilizationDetail extends Object implements Serializable


Serialized Fields


savingsPlanArn
String savingsPlanArn

 The unique Amazon Resource Name (ARN) for a particular Savings Plan.
 


attributes
Map<K,V> attributes

 The attribute that applies to a specific Dimension.
 


utilization
SavingsPlansUtilization utilization

 A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans
 eligible.
 


savings
SavingsPlansSavings savings

 The amount saved by using existing Savings Plans. Savings returns both net savings from savings plans as well as
 the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.
 


amortizedCommitment
SavingsPlansAmortizedCommitment amortizedCommitment

 The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings Plans
 fees.
 








Class com.amazonaws.services.costexplorer.model.ServiceQuotaExceededException extends AWSCostExplorerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costexplorer.model.ServiceSpecification extends Object implements Serializable


Serialized Fields


eC2Specification
EC2Specification eC2Specification

 The Amazon EC2 hardware specifications that you want AWS to provide recommendations for.
 








Class com.amazonaws.services.costexplorer.model.TagValues extends Object implements Serializable


Serialized Fields


key
String key

 The key for the tag.
 


values
List<E> values

 The specific value of the tag.
 








Class com.amazonaws.services.costexplorer.model.TargetInstance extends Object implements Serializable


Serialized Fields


estimatedMonthlyCost
String estimatedMonthlyCost

 Expected cost to operate this instance type on a monthly basis.
 


estimatedMonthlySavings
String estimatedMonthlySavings

 Estimated savings resulting from modification, on a monthly basis.
 


currencyCode
String currencyCode

 The currency code that Amazon Web Services used to calculate the costs for this instance.
 


defaultTargetInstance
Boolean defaultTargetInstance

 Indicates whether or not this recommendation is the defaulted Amazon Web Services recommendation.
 


resourceDetails
ResourceDetails resourceDetails

 Details on the target instance type.
 


expectedResourceUtilization
ResourceUtilization expectedResourceUtilization

 Expected utilization metrics for target instance type.
 








Class com.amazonaws.services.costexplorer.model.TerminateRecommendationDetail extends Object implements Serializable


Serialized Fields


estimatedMonthlySavings
String estimatedMonthlySavings

 Estimated savings resulting from modification, on a monthly basis.
 


currencyCode
String currencyCode

 The currency code that Amazon Web Services used to calculate the costs for this instance.
 








Class com.amazonaws.services.costexplorer.model.UnresolvableUsageUnitException extends AWSCostExplorerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.costexplorer.model.UpdateCostCategoryDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


costCategoryArn
String costCategoryArn

 The unique identifier for your Cost Category.
 


ruleVersion
String ruleVersion


rules
List<E> rules

 UpdateCostCategoryDefinition supports dimensions, Tags, and nested expressions. Currently the only
 dimensions supported is LINKED_ACCOUNT.
 
 
 Root level OR is not supported. We recommend you create a separate rule instead.
 
 
 Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match
 is used to determine that Cost Category value.
 








Class com.amazonaws.services.costexplorer.model.UpdateCostCategoryDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


costCategoryArn
String costCategoryArn

 The unique identifier for your Cost Category.
 


effectiveStart
String effectiveStart

 The Cost Category's effective start date.
 








Class com.amazonaws.services.costexplorer.model.UtilizationByTime extends Object implements Serializable


Serialized Fields


timePeriod
DateInterval timePeriod

 The period of time that this utilization was used for.
 


groups
List<E> groups

 The groups that this utilization result uses.
 


total
ReservationAggregates total

 The total number of reservation hours that were used.
 








Package com.amazonaws.services.databasemigrationservice.model




Class com.amazonaws.services.databasemigrationservice.model.AccessDeniedException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.AccountQuota extends Object implements Serializable


Serialized Fields


accountQuotaName
String accountQuotaName

 The name of the AWS DMS quota for this AWS account.
 


used
Long used

 The amount currently used toward the quota maximum.
 


max
Long max

 The maximum allowed value for the quota.
 








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


Serialized Fields


resourceArn
String resourceArn

 Identifies the AWS DMS resource to which tags should be added. The value for this parameter is an Amazon Resource
 Name (ARN).
 
 
 For AWS DMS, you can tag a replication instance, an endpoint, or a replication task.
 


tags
List<E> tags

 One or more tags to be assigned to the resource.
 








Class com.amazonaws.services.databasemigrationservice.model.AddTagsToResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.databasemigrationservice.model.ApplyPendingMaintenanceActionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the AWS DMS resource that the pending maintenance action applies to.
 


applyAction
String applyAction

 The pending maintenance action to apply to this resource.
 


optInType
String optInType

 A value that specifies the type of opt-in request, or undoes an opt-in request. You can't undo an opt-in request
 of type immediate.
 
 
 Valid values:
 
 
 
 
 immediate - Apply the maintenance action immediately.
 
 
 
 
 next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
 
 
 
 
 undo-opt-in - Cancel any existing next-maintenance opt-in requests.
 
 
 








Class com.amazonaws.services.databasemigrationservice.model.ApplyPendingMaintenanceActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourcePendingMaintenanceActions
ResourcePendingMaintenanceActions resourcePendingMaintenanceActions

 The AWS DMS resource that the pending maintenance action will be applied to.
 








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


Serialized Fields


name
String name

 The name of the availability zone.
 








Class com.amazonaws.services.databasemigrationservice.model.AWSDatabaseMigrationServiceException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.Certificate extends Object implements Serializable


Serialized Fields


certificateIdentifier
String certificateIdentifier

 A customer-assigned name for the certificate. 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.
 


certificateCreationDate
Date certificateCreationDate

 The date that the certificate was created.
 


certificatePem
String certificatePem

 The contents of a .pem file, which contains an X.509 certificate.
 


certificateWallet
ByteBuffer certificateWallet

 The location of an imported Oracle Wallet certificate for use with SSL.
 


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) for the certificate.
 


certificateOwner
String certificateOwner

 The owner of the certificate.
 


validFromDate
Date validFromDate

 The beginning date that the certificate is valid.
 


validToDate
Date validToDate

 The final date that the certificate is valid.
 


signingAlgorithm
String signingAlgorithm

 The signing algorithm for the certificate.
 


keyLength
Integer keyLength

 The key length of the cryptographic algorithm being used.
 








Class com.amazonaws.services.databasemigrationservice.model.Connection extends Object implements Serializable


Serialized Fields


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the replication instance.
 


endpointArn
String endpointArn

 The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
 


status
String status

 The connection status.
 


lastFailureMessage
String lastFailureMessage

 The error message when the connection last failed.
 


endpointIdentifier
String endpointIdentifier

 The identifier of the endpoint. Identifiers must begin with a letter; must contain only ASCII letters, digits,
 and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
 


replicationInstanceIdentifier
String replicationInstanceIdentifier

 The replication instance identifier. This parameter is stored as a lowercase string.
 








Class com.amazonaws.services.databasemigrationservice.model.CreateEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointIdentifier
String endpointIdentifier

 The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits,
 and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
 


endpointType
String endpointType

 The type of endpoint. Valid values are source and target.
 


engineName
String engineName

 The type of engine for the endpoint. Valid values, depending on the EndpointType value, include
 mysql, oracle, postgres, mariadb, aurora,
 aurora-postgresql, redshift, s3, db2, azuredb,
 sybase, dynamodb, mongodb, and sqlserver.
 


username
String username

 The user name to be used to log in to the endpoint database.
 


password
String password

 The password to be used to log in to the endpoint database.
 


serverName
String serverName

 The name of the server where the endpoint database resides.
 


port
Integer port

 The port used by the endpoint database.
 


databaseName
String databaseName

 The name of the endpoint database.
 


extraConnectionAttributes
String extraConnectionAttributes

 Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated
 by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For
 information on the attributes available for connecting your source or target endpoint, see Working with AWS DMS Endpoints in
 the AWS Database Migration Service User Guide.
 


kmsKeyId
String kmsKeyId

 An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
 
 
 If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption
 key.
 
 
 AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default
 encryption key for each AWS Region.
 


tags
List<E> tags

 One or more tags to be assigned to the endpoint.
 


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) for the certificate.
 


sslMode
String sslMode

 The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none
 


serviceAccessRoleArn
String serviceAccessRoleArn

 The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.
 


externalTableDefinition
String externalTableDefinition

 The external table definition.
 


dynamoDbSettings
DynamoDbSettings dynamoDbSettings

 Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available
 settings, see Using Object
 Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
 


s3Settings
S3Settings s3Settings

 Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see
 Extra
 Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service
 User Guide.
 


dmsTransferSettings
DmsTransferSettings dmsTransferSettings

 The settings in JSON format for the DMS transfer type of source endpoint.
 
 
 Possible settings include the following:
 
 
 
 
 ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
 
 
 
 
 BucketName - The name of the S3 bucket to use.
 
 
 
 
 CompressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set
 this value to NONE (the default). To keep the files uncompressed, don't use this value.
 
 
 
 
 Shorthand syntax for these settings is as follows:
 ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
 
 
 JSON syntax for these settings is as follows:
 { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" } 
 


mongoDbSettings
MongoDbSettings mongoDbSettings

 Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see
 the configuration properties section in  Using MongoDB as a Target for
 AWS Database Migration Service in the AWS Database Migration Service User Guide.
 


kinesisSettings
KinesisSettings kinesisSettings

 Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the
 available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User
 Guide.
 


elasticsearchSettings
ElasticsearchSettings elasticsearchSettings

 Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings,
 see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database
 Migration User Guide.
 


redshiftSettings
RedshiftSettings redshiftSettings








Class com.amazonaws.services.databasemigrationservice.model.CreateEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpoint
Endpoint endpoint

 The endpoint that was created.
 








Class com.amazonaws.services.databasemigrationservice.model.CreateEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subscriptionName
String subscriptionName

 The name of the AWS DMS event notification subscription. This name must be less than 255 characters.
 


snsTopicArn
String snsTopicArn

 The Amazon Resource Name (ARN) of the Amazon 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 AWS DMS resource that generates the events. For example, if you want to be notified of events
 generated by a replication instance, you set this parameter to replication-instance. If this value
 is not specified, all events are returned.
 
 
 Valid values: replication-instance | replication-task
 


eventCategories
List<E> eventCategories

 A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and
 Notifications in the AWS Database Migration Service User Guide.
 


sourceIds
List<E> sourceIds

 A list of identifiers for which AWS DMS provides notification events.
 
 
 If you don't specify a value, notifications are provided for all sources.
 
 
 If you specify multiple values, they must be of the same type. For example, if you specify a database instance
 ID, then all of the other values must be database instance IDs.
 


enabled
Boolean enabled

 A Boolean value; set to true to activate the subscription, or set to false to create
 the subscription but not activate it.
 


tags
List<E> tags

 One or more tags to be assigned to the event subscription.
 








Class com.amazonaws.services.databasemigrationservice.model.CreateEventSubscriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventSubscription
EventSubscription eventSubscription

 The event subscription that was created.
 








Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationInstanceIdentifier
String replicationInstanceIdentifier

 The replication instance identifier. This parameter is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 alphanumeric characters or hyphens.
 
 
 
 
 First character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: myrepinstance
 


allocatedStorage
Integer allocatedStorage

 The amount of storage (in gigabytes) to be initially allocated for the replication instance.
 


replicationInstanceClass
String replicationInstanceClass

 The compute and memory capacity of the replication instance as specified by the replication instance class.
 
 
 Valid Values:
 dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge 
 


vpcSecurityGroupIds
List<E> vpcSecurityGroupIds

 Specifies the VPC security group to be used with the replication instance. The VPC security group must work with
 the VPC containing the replication instance.
 


availabilityZone
String availabilityZone

 The AWS Availability Zone where the replication instance will be created. The default value is a random,
 system-chosen Availability Zone in the endpoint's AWS Region, for example: us-east-1d
 


replicationSubnetGroupIdentifier
String replicationSubnetGroupIdentifier

 A subnet group to associate with the replication instance.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
 
 
 Format: ddd:hh24:mi-ddd:hh24:mi
 
 
 Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random
 day of the week.
 
 
 Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
 
 
 Constraints: Minimum 30-minute window.
 


multiAZ
Boolean multiAZ

 Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the
 AvailabilityZone parameter if the Multi-AZ parameter is set to true.
 


engineVersion
String engineVersion

 The engine version number of the replication instance.
 


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 Indicates whether minor engine upgrades will be applied automatically to the replication instance during the
 maintenance window. This parameter defaults to true.
 
 
 Default: true
 


tags
List<E> tags

 One or more tags to be assigned to the replication instance.
 


kmsKeyId
String kmsKeyId

 An AWS KMS key identifier that is used to encrypt the data on the replication instance.
 
 
 If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption
 key.
 
 
 AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default
 encryption key for each AWS Region.
 


publiclyAccessible
Boolean publiclyAccessible

 Specifies the accessibility options for the replication instance. A value of true represents an
 instance with a public IP address. A value of false represents an instance with a private IP
 address. The default value is true.
 


dnsNameServers
String dnsNameServers

 A list of DNS name servers supported for the replication instance.
 








Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationInstance
ReplicationInstance replicationInstance

 The replication instance that was created.
 








Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationSubnetGroupIdentifier
String replicationSubnetGroupIdentifier

 The name for the replication subnet group. This value is stored as a lowercase string.
 
 
 Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens.
 Must not be "default".
 
 
 Example: mySubnetgroup
 


replicationSubnetGroupDescription
String replicationSubnetGroupDescription

 The description for the subnet group.
 


subnetIds
List<E> subnetIds

 One or more subnet IDs to be assigned to the subnet group.
 


tags
List<E> tags

 One or more tags to be assigned to the subnet group.
 








Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationSubnetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationSubnetGroup
ReplicationSubnetGroup replicationSubnetGroup

 The replication subnet group that was created.
 








Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationTaskIdentifier
String replicationTaskIdentifier

 An identifier for the replication task.
 
 
 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.
 
 
 


sourceEndpointArn
String sourceEndpointArn

 An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
 


targetEndpointArn
String targetEndpointArn

 An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
 


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of a replication instance.
 


migrationType
String migrationType

 The migration type. Valid values: full-load | cdc | full-load-and-cdc
 


tableMappings
String tableMappings

 The table mappings for the task, in JSON format. For more information, see Table
 Mapping in the AWS Database Migration User Guide.
 


replicationTaskSettings
String replicationTaskSettings

 Overall settings for the task, in JSON format. For more information, see Task
 Settings in the AWS Database Migration User Guide.
 


cdcStartTime
Date cdcStartTime

 Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition
 to specify when you want a CDC operation to start. Specifying both values results in an error.
 
 
 Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
 


cdcStartPosition
String cdcStartPosition

 Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or
 CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
 
 
 The value can be in date, checkpoint, or LSN/SCN format.
 
 
 Date Example: --cdc-start-position “2018-03-08T12:12:12”
 
 
 Checkpoint Example: --cdc-start-position
 "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
 
 
 LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
 
 
 
 When you use this task setting with a source PostgreSQL database, a logical replication slot should already be
 created and associated with the source endpoint. You can verify this by setting the slotName extra
 connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.
 
 


cdcStopPosition
String cdcStopPosition

 Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or
 commit time.
 
 
 Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”
 
 
 Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “
 


tags
List<E> tags

 One or more tags to be assigned to the replication task.
 








Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationTask
ReplicationTask replicationTask

 The replication task that was created.
 








Class com.amazonaws.services.databasemigrationservice.model.DeleteCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) of the deleted certificate.
 








Class com.amazonaws.services.databasemigrationservice.model.DeleteCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificate
Certificate certificate

 The Secure Sockets Layer (SSL) certificate.
 








Class com.amazonaws.services.databasemigrationservice.model.DeleteConnectionRequest 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.DeleteConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connection
Connection connection

 The connection that is being deleted.
 








Class com.amazonaws.services.databasemigrationservice.model.DeleteEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointArn
String endpointArn

 The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
 








Class com.amazonaws.services.databasemigrationservice.model.DeleteEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpoint
Endpoint endpoint

 The endpoint that was deleted.
 








Class com.amazonaws.services.databasemigrationservice.model.DeleteEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subscriptionName
String subscriptionName

 The name of the DMS event notification subscription to be deleted.
 








Class com.amazonaws.services.databasemigrationservice.model.DeleteEventSubscriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventSubscription
EventSubscription eventSubscription

 The event subscription that was deleted.
 








Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the replication instance to be deleted.
 








Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationInstance
ReplicationInstance replicationInstance

 The replication instance that was deleted.
 








Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationSubnetGroupIdentifier
String replicationSubnetGroupIdentifier

 The subnet group name of the replication instance.
 








Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationSubnetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationTaskArn
String replicationTaskArn

 The Amazon Resource Name (ARN) of the replication task to be deleted.
 








Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationTask
ReplicationTask replicationTask

 The deleted replication task.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.databasemigrationservice.model.DescribeAccountAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accountQuotas
List<E> accountQuotas

 Account quota information.
 


uniqueAccountIdentifier
String uniqueAccountIdentifier

 A unique AWS DMS identifier for an account in a particular AWS Region. The value of this identifier has the
 following format: c99999999999. DMS uses this identifier to name artifacts. For example, DMS uses
 this identifier to name the default Amazon S3 bucket for storing task assessment reports in a given AWS Region.
 The format of this S3 bucket name is the following:
 dms-AccountNumber-UniqueAccountIdentifier. Here is an example name for this default S3
 bucket: dms-111122223333-c44445555666.
 
 
 
 AWS DMS supports the UniqueAccountIdentifier parameter in versions 3.1.4 and later.
 
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeCertificatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 Filters applied to the certificate described in the form of key-value pairs.
 


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


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 vlue specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeCertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 The pagination token.
 


certificates
List<E> certificates

 The Secure Sockets Layer (SSL) certificates associated with the replication instance.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 The filters applied to the connection.
 
 
 Valid filter names: endpoint-arn | replication-instance-arn
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


connections
List<E> connections

 A description of the connections.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeEndpointsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 Filters applied to the describe action.
 
 
 Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


endpoints
List<E> endpoints

 Endpoint description.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeEndpointTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 Filters applied to the describe action.
 
 
 Valid filter names: engine-name | endpoint-type
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeEndpointTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


supportedEndpointTypes
List<E> supportedEndpointTypes

 The types of endpoints that are supported.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeEventCategoriesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceType
String sourceType

 The type of AWS DMS resource that generates events.
 
 
 Valid values: replication-instance | replication-task
 


filters
List<E> filters

 Filters applied to the action.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeEventCategoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventCategoryGroupList
List<E> eventCategoryGroupList

 A list of event categories.
 








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


Serialized Fields


sourceIdentifier
String sourceIdentifier

 The identifier of an event source.
 


sourceType
String sourceType

 The type of AWS DMS resource that generates events.
 
 
 Valid values: replication-instance | replication-task
 


startTime
Date startTime

 The start time for the events to be listed.
 


endTime
Date endTime

 The end time for the events to be listed.
 


duration
Integer duration

 The duration of the events to be listed.
 


eventCategories
List<E> eventCategories

 A list of event categories for the source type that you've chosen.
 


filters
List<E> filters

 Filters applied to the action.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeEventsResult extends AmazonWebServiceResult<ResponseMetadata> 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.
 


events
List<E> events

 The events described.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeEventSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subscriptionName
String subscriptionName

 The name of the AWS DMS event subscription to be described.
 


filters
List<E> filters

 Filters applied to the action.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeEventSubscriptionsResult extends AmazonWebServiceResult<ResponseMetadata> 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.
 


eventSubscriptionsList
List<E> eventSubscriptionsList

 A list of event subscriptions.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeOrderableReplicationInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeOrderableReplicationInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


orderableReplicationInstances
List<E> orderableReplicationInstances

 The order-able replication instances available.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribePendingMaintenanceActionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the replication instance.
 


filters
List<E> filters



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.DescribePendingMaintenanceActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pendingMaintenanceActions
List<E> pendingMaintenanceActions

 The pending maintenance 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.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeRefreshSchemasStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointArn
String endpointArn

 The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeRefreshSchemasStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


refreshSchemasStatus
RefreshSchemasStatus refreshSchemasStatus

 The status of the schema.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 Filters applied to the describe action.
 
 
 Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class |
 engine-version
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


replicationInstances
List<E> replicationInstances

 The replication instances described.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationInstanceTaskLogsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the replication instance.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationInstanceTaskLogsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the replication instance.
 


replicationInstanceTaskLogs
List<E> replicationInstanceTaskLogs

 An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and
 task log size (in bytes).
 


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.DescribeReplicationSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 Filters applied to the describe action.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationSubnetGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


replicationSubnetGroups
List<E> replicationSubnetGroups

 A description of the replication subnet groups.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationTaskAssessmentResultsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationTaskArn
String replicationTaskArn

 - The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified
 the API will return only one result and ignore the values of the max-records and marker parameters.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationTaskAssessmentResultsResult extends AmazonWebServiceResult<ResponseMetadata> 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.
 


bucketName
String bucketName

 - The Amazon S3 bucket where the task assessment report is located.
 


replicationTaskAssessmentResults
List<E> replicationTaskAssessmentResults

 The task assessment report.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 Filters applied to the describe action.
 
 
 Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn |
 replication-instance-arn
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


withoutSettings
Boolean withoutSettings

 An option to set to avoid returning information about settings. Use this to reduce overhead when setting
 information is too large. To use this option, choose true; otherwise, choose false (the
 default).
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


replicationTasks
List<E> replicationTasks

 A description of the replication tasks.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeSchemasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointArn
String endpointArn

 The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeSchemasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


schemas
List<E> schemas

 The described schema.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeTableStatisticsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationTaskArn
String replicationTaskArn

 The Amazon Resource Name (ARN) of the replication task.
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response. If more records exist than the specified
 MaxRecords value, a pagination token called a marker is included in the response so that the
 remaining results can be retrieved.
 
 
 Default: 100
 
 
 Constraints: Minimum 20, maximum 500.
 


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.
 


filters
List<E> filters

 Filters applied to the describe table statistics action.
 
 
 Valid filter names: schema-name | table-name | table-state
 
 
 A combination of filters creates an AND condition where each record matches all specified filters.
 








Class com.amazonaws.services.databasemigrationservice.model.DescribeTableStatisticsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationTaskArn
String replicationTaskArn

 The Amazon Resource Name (ARN) of the replication task.
 


tableStatistics
List<E> tableStatistics

 The table statistics.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.databasemigrationservice.model.DmsTransferSettings extends Object implements Serializable


Serialized Fields


serviceAccessRoleArn
String serviceAccessRoleArn

 The IAM role that has permission to access the Amazon S3 bucket.
 


bucketName
String bucketName

 The name of the S3 bucket to use.
 








Class com.amazonaws.services.databasemigrationservice.model.DynamoDbSettings extends Object implements Serializable


Serialized Fields


serviceAccessRoleArn
String serviceAccessRoleArn

 The Amazon Resource Name (ARN) used by the service access IAM role.
 








Class com.amazonaws.services.databasemigrationservice.model.ElasticsearchSettings extends Object implements Serializable


Serialized Fields


serviceAccessRoleArn
String serviceAccessRoleArn

 The Amazon Resource Name (ARN) used by service to access the IAM role.
 


endpointUri
String endpointUri

 The endpoint for the Elasticsearch cluster.
 


fullLoadErrorPercentage
Integer fullLoadErrorPercentage

 The maximum percentage of records that can fail to be written before a full load operation stops.
 


errorRetryDuration
Integer errorRetryDuration

 The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.
 








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


Serialized Fields


endpointIdentifier
String endpointIdentifier

 The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits,
 and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
 


endpointType
String endpointType

 The type of endpoint. Valid values are source and target.
 


engineName
String engineName

 The database engine name. Valid values, depending on the EndpointType, include mysql, oracle, postgres, mariadb,
 aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.
 


engineDisplayName
String engineDisplayName

 The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this
 value would be "Amazon Aurora MySQL."
 


username
String username

 The user name used to connect to the endpoint.
 


serverName
String serverName

 The name of the server at the endpoint.
 


port
Integer port

 The port value used to access the endpoint.
 


databaseName
String databaseName

 The name of the database at the endpoint.
 


extraConnectionAttributes
String extraConnectionAttributes

 Additional connection attributes used to connect to the endpoint.
 


status
String status

 The status of the endpoint.
 


kmsKeyId
String kmsKeyId

 An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.
 
 
 If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption
 key.
 
 
 AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default
 encryption key for each AWS Region.
 


endpointArn
String endpointArn

 The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
 


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
 


sslMode
String sslMode

 The SSL mode used to connect to the endpoint. The default value is none.
 


serviceAccessRoleArn
String serviceAccessRoleArn

 The Amazon Resource Name (ARN) used by the service access IAM role.
 


externalTableDefinition
String externalTableDefinition

 The external table definition.
 


externalId
String externalId

 Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent
 call to CreateEndpoint to create the endpoint with a cross-account.
 


dynamoDbSettings
DynamoDbSettings dynamoDbSettings

 The settings for the target DynamoDB database. For more information, see the DynamoDBSettings
 structure.
 


s3Settings
S3Settings s3Settings

 The settings for the S3 target endpoint. For more information, see the S3Settings structure.
 


dmsTransferSettings
DmsTransferSettings dmsTransferSettings

 The settings in JSON format for the DMS transfer type of source endpoint.
 
 
 Possible settings include the following:
 
 
 
 
 ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
 
 
 
 
 BucketName - The name of the S3 bucket to use.
 
 
 
 
 CompressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set
 this value to NONE (the default). To keep the files uncompressed, don't use this value.
 
 
 
 
 Shorthand syntax for these settings is as follows:
 ServiceAccessRoleArn=string,BucketName=string,CompressionType=string
 
 
 JSON syntax for these settings is as follows:
 { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" } 
 


mongoDbSettings
MongoDbSettings mongoDbSettings

 The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings
 structure.
 


kinesisSettings
KinesisSettings kinesisSettings

 The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings
 structure.
 


elasticsearchSettings
ElasticsearchSettings elasticsearchSettings

 The settings for the Elasticsearch source endpoint. For more information, see the
 ElasticsearchSettings structure.
 


redshiftSettings
RedshiftSettings redshiftSettings

 Settings for the Amazon Redshift endpoint.
 








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


Serialized Fields


sourceIdentifier
String sourceIdentifier

 The identifier of an event source.
 


sourceType
String sourceType

 The type of AWS DMS resource that generates events.
 
 
 Valid values: replication-instance | endpoint | replication-task
 


message
String message

 The event message.
 


eventCategories
List<E> eventCategories

 The event categories available for the specified source type.
 


date
Date date

 The date of the event.
 








Class com.amazonaws.services.databasemigrationservice.model.EventCategoryGroup extends Object implements Serializable


Serialized Fields


sourceType
String sourceType

 The type of AWS DMS resource that generates events.
 
 
 Valid values: replication-instance | replication-server | security-group | replication-task
 


eventCategories
List<E> eventCategories

 A list of event categories from a source type that you've chosen.
 








Class com.amazonaws.services.databasemigrationservice.model.EventSubscription extends Object implements Serializable


Serialized Fields


customerAwsId
String customerAwsId

 The AWS customer account associated with the AWS DMS event notification subscription.
 


custSubscriptionId
String custSubscriptionId

 The AWS DMS event notification subscription Id.
 


snsTopicArn
String snsTopicArn

 The topic ARN of the AWS DMS event notification subscription.
 


status
String status

 The status of the AWS DMS 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 AWS DMS no longer has permission to post to the SNS topic. The status
 "topic-not-exist" indicates that the topic was deleted after the subscription was created.
 


subscriptionCreationTime
String subscriptionCreationTime

 The time the RDS event notification subscription was created.
 


sourceType
String sourceType

 The type of AWS DMS resource that generates events.
 
 
 Valid values: replication-instance | replication-server | security-group | replication-task
 


sourceIdsList
List<E> sourceIdsList

 A list of source Ids for the event subscription.
 


eventCategoriesList
List<E> eventCategoriesList

 A lists of event categories.
 


enabled
Boolean enabled

 Boolean value that indicates if the event subscription is enabled.
 








Class com.amazonaws.services.databasemigrationservice.model.Filter extends Object implements Serializable


Serialized Fields


name
String name

 The name of the filter.
 


values
List<E> values

 The filter value.
 








Class com.amazonaws.services.databasemigrationservice.model.ImportCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateIdentifier
String certificateIdentifier

 A customer-assigned name for the certificate. 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.
 


certificatePem
String certificatePem

 The contents of a .pem file, which contains an X.509 certificate.
 


certificateWallet
ByteBuffer certificateWallet

 The location of an imported Oracle Wallet certificate for use with SSL.
 


tags
List<E> tags

 The tags associated with the certificate.
 








Class com.amazonaws.services.databasemigrationservice.model.ImportCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificate
Certificate certificate

 The certificate to be uploaded.
 








Class com.amazonaws.services.databasemigrationservice.model.InsufficientResourceCapacityException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.InvalidCertificateException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.InvalidResourceStateException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.InvalidSubnetException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.KinesisSettings extends Object implements Serializable


Serialized Fields


streamArn
String streamArn

 The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
 


messageFormat
String messageFormat

 The output format for the records created on the endpoint. The message format is JSON.
 


serviceAccessRoleArn
String serviceAccessRoleArn

 The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.
 








Class com.amazonaws.services.databasemigrationservice.model.KMSAccessDeniedException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.KMSDisabledException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.KMSInvalidStateException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.KMSKeyNotAccessibleException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.KMSNotFoundException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.KMSThrottlingException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.
 








Class com.amazonaws.services.databasemigrationservice.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagList
List<E> tagList

 A list of tags for the resource.
 








Class com.amazonaws.services.databasemigrationservice.model.ModifyEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointArn
String endpointArn

 The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
 


endpointIdentifier
String endpointIdentifier

 The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits,
 and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
 


endpointType
String endpointType

 The type of endpoint. Valid values are source and target.
 


engineName
String engineName

 The type of engine for the endpoint. Valid values, depending on the EndpointType, include mysql, oracle,
 postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and
 sqlserver.
 


username
String username

 The user name to be used to login to the endpoint database.
 


password
String password

 The password to be used to login to the endpoint database.
 


serverName
String serverName

 The name of the server where the endpoint database resides.
 


port
Integer port

 The port used by the endpoint database.
 


databaseName
String databaseName

 The name of the endpoint database.
 


extraConnectionAttributes
String extraConnectionAttributes

 Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an
 argument.
 


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) of the certificate used for SSL connection.
 


sslMode
String sslMode

 The SSL mode used to connect to the endpoint. The default value is none.
 


serviceAccessRoleArn
String serviceAccessRoleArn

 The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.
 


externalTableDefinition
String externalTableDefinition

 The external table definition.
 


dynamoDbSettings
DynamoDbSettings dynamoDbSettings

 Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available
 settings, see Using Object
 Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.
 


s3Settings
S3Settings s3Settings

 Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see
 Extra
 Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service
 User Guide.
 


dmsTransferSettings
DmsTransferSettings dmsTransferSettings

 The settings in JSON format for the DMS transfer type of source endpoint.
 
 
 Attributes include the following:
 
 
 
 
 serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.
 
 
 
 
 BucketName - The name of the S3 bucket to use.
 
 
 
 
 compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do
 not use to leave the files uncompressed.
 
 
 
 
 Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string
 
 
 JSON syntax:
 
 
 { "ServiceAccessRoleArn": "string", "BucketName": "string", "CompressionType": "none"|"gzip" }
 


mongoDbSettings
MongoDbSettings mongoDbSettings

 Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see
 the configuration properties section in  Using MongoDB as a Target for
 AWS Database Migration Service in the AWS Database Migration Service User Guide.
 


kinesisSettings
KinesisSettings kinesisSettings

 Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the
 available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User
 Guide.
 


elasticsearchSettings
ElasticsearchSettings elasticsearchSettings

 Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings,
 see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database
 Migration User Guide.
 


redshiftSettings
RedshiftSettings redshiftSettings








Class com.amazonaws.services.databasemigrationservice.model.ModifyEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpoint
Endpoint endpoint

 The modified endpoint.
 








Class com.amazonaws.services.databasemigrationservice.model.ModifyEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subscriptionName
String subscriptionName

 The name of the AWS DMS event notification subscription to be modified.
 


snsTopicArn
String snsTopicArn

 The Amazon Resource Name (ARN) of the Amazon 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 AWS DMS resource that generates the events you want to subscribe to.
 
 
 Valid values: replication-instance | replication-task
 


eventCategories
List<E> eventCategories

 A list of event categories for a source type that you want to subscribe to. Use the
 DescribeEventCategories action to see a list of event categories.
 


enabled
Boolean enabled

 A Boolean value; set to true to activate the subscription.
 








Class com.amazonaws.services.databasemigrationservice.model.ModifyEventSubscriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventSubscription
EventSubscription eventSubscription

 The modified event subscription.
 








Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the replication instance.
 


allocatedStorage
Integer allocatedStorage

 The amount of storage (in gigabytes) to be allocated for the replication instance.
 


applyImmediately
Boolean applyImmediately

 Indicates whether the changes should be applied immediately or during the next maintenance window.
 


replicationInstanceClass
String replicationInstanceClass

 The compute and memory capacity of the replication instance.
 
 
 Valid Values:
 dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge 
 


vpcSecurityGroupIds
List<E> vpcSecurityGroupIds

 Specifies the VPC security group to be used with the replication instance. The VPC security group must work with
 the VPC containing 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
 


multiAZ
Boolean multiAZ

 Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the
 AvailabilityZone parameter if the Multi-AZ parameter is set to true.
 


engineVersion
String engineVersion

 The engine version number of the replication instance.
 


allowMajorVersionUpgrade
Boolean allowMajorVersionUpgrade

 Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the
 change is asynchronously applied as soon as possible.
 
 
 This parameter must be set to true when specifying a value for the EngineVersion
 parameter that is a different major version than the replication instance's current version.
 


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 Indicates that minor version upgrades will be applied automatically to the replication instance during the
 maintenance window. Changing this parameter does not result in an outage except in the following case and the
 change is asynchronously applied as soon as possible. An outage will result if this parameter is set to
 true during the maintenance window, and a newer minor version is available, and AWS DMS has enabled
 auto patching for that engine version.
 


replicationInstanceIdentifier
String replicationInstanceIdentifier

 The replication instance identifier. This parameter is stored as a lowercase string.
 








Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationInstance
ReplicationInstance replicationInstance

 The modified replication instance.
 








Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationSubnetGroupIdentifier
String replicationSubnetGroupIdentifier

 The name of the replication instance subnet group.
 


replicationSubnetGroupDescription
String replicationSubnetGroupDescription

 A description for the replication instance subnet group.
 


subnetIds
List<E> subnetIds

 A list of subnet IDs.
 








Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationSubnetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationSubnetGroup
ReplicationSubnetGroup replicationSubnetGroup

 The modified replication subnet group.
 








Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationTaskArn
String replicationTaskArn

 The Amazon Resource Name (ARN) of the replication task.
 


replicationTaskIdentifier
String replicationTaskIdentifier

 The replication task identifier.
 
 
 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.
 
 
 


migrationType
String migrationType

 The migration type. Valid values: full-load | cdc | full-load-and-cdc
 


tableMappings
String tableMappings

 When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the
 path with file://. When working with the DMS API, provide the JSON as the parameter value, for
 example: --table-mappings file://mappingfile.json
 


replicationTaskSettings
String replicationTaskSettings

 JSON file that contains settings for the task, such as target metadata settings.
 


cdcStartTime
Date cdcStartTime

 Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition
 to specify when you want a CDC operation to start. Specifying both values results in an error.
 
 
 Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
 


cdcStartPosition
String cdcStartPosition

 Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or
 CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
 
 
 The value can be in date, checkpoint, or LSN/SCN format.
 
 
 Date Example: --cdc-start-position “2018-03-08T12:12:12”
 
 
 Checkpoint Example: --cdc-start-position
 "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
 
 
 LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
 
 
 
 When you use this task setting with a source PostgreSQL database, a logical replication slot should already be
 created and associated with the source endpoint. You can verify this by setting the slotName extra
 connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.
 
 


cdcStopPosition
String cdcStopPosition

 Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or
 commit time.
 
 
 Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”
 
 
 Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “
 








Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationTask
ReplicationTask replicationTask

 The replication task that was modified.
 








Class com.amazonaws.services.databasemigrationservice.model.MongoDbSettings extends Object implements Serializable


Serialized Fields


username
String username

 The user name you use to access the MongoDB source endpoint.
 


password
String password

 The password for the user account you use to access the MongoDB source endpoint.
 


serverName
String serverName

 The name of the server on the MongoDB source endpoint.
 


port
Integer port

 The port value for the MongoDB source endpoint.
 


databaseName
String databaseName

 The database name on the MongoDB source endpoint.
 


authType
String authType

 The authentication type you use to access the MongoDB source endpoint.
 
 
 Valid values: NO, PASSWORD
 
 
 When NO is selected, user name and password parameters are not used and can be empty.
 


authMechanism
String authMechanism

 The authentication mechanism you use to access the MongoDB source endpoint.
 
 
 Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1
 
 
 DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This setting is not
 used when authType=No.
 


nestingLevel
String nestingLevel

 Specifies either document or table mode.
 
 
 Valid values: NONE, ONE
 
 
 Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.
 


extractDocId
String extractDocId

 Specifies the document ID. Use this setting when NestingLevel is set to NONE.
 
 
 Default value is false.
 


docsToInvestigate
String docsToInvestigate

 Indicates the number of documents to preview to determine the document organization. Use this setting when
 NestingLevel is set to ONE.
 
 
 Must be a positive value greater than 0. Default value is 1000.
 


authSource
String authSource

 The MongoDB database name. This setting is not used when authType=NO.
 
 
 The default is admin.
 


kmsKeyId
String kmsKeyId

 The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify
 a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates
 the default encryption key for your AWS account. Your AWS account has a different default encryption key for each
 AWS Region.
 








Class com.amazonaws.services.databasemigrationservice.model.OrderableReplicationInstance extends Object implements Serializable


Serialized Fields


engineVersion
String engineVersion

 The version of the replication engine.
 


replicationInstanceClass
String replicationInstanceClass

 The compute and memory capacity of the replication instance.
 
 
 Valid Values:
 dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge 
 


storageType
String storageType

 The type of storage used by the replication instance.
 


minAllocatedStorage
Integer minAllocatedStorage

 The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
 


maxAllocatedStorage
Integer maxAllocatedStorage

 The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
 


defaultAllocatedStorage
Integer defaultAllocatedStorage

 The default amount of storage (in gigabytes) that is allocated for the replication instance.
 


includedAllocatedStorage
Integer includedAllocatedStorage

 The amount of storage (in gigabytes) that is allocated for the replication instance.
 


availabilityZones
List<E> availabilityZones

 List of Availability Zones for this replication instance.
 


releaseStatus
String releaseStatus

 The value returned when the specified EngineVersion of the replication instance is in Beta or test
 mode. This indicates some features might not work as expected.
 
 
 
 AWS DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.
 
 








Class com.amazonaws.services.databasemigrationservice.model.PendingMaintenanceAction extends Object implements Serializable


Serialized Fields


action
String action

 The type of pending maintenance action that is available for the resource.
 


autoAppliedAfterDate
Date autoAppliedAfterDate

 The date of the maintenance window when the action will be applied. The maintenance action will be applied to the
 resource during its first maintenance window after this date. If this date is specified, any
 next-maintenance opt-in requests are ignored.
 


forcedApplyDate
Date forcedApplyDate

 The date when the maintenance action will be automatically applied. The maintenance action will be applied to the
 resource on this date regardless of the maintenance window for the resource. If this date is specified, any
 immediate opt-in requests are ignored.
 


optInStatus
String optInStatus

 Indicates the type of opt-in request that has been received for the resource.
 


currentApplyDate
Date currentApplyDate

 The effective date when the pending maintenance action will be applied to the resource. This date takes into
 account opt-in requests received from the ApplyPendingMaintenanceAction API, the
 AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request
 has not been received and nothing has been specified as AutoAppliedAfterDate or
 ForcedApplyDate.
 


description
String description

 A description providing more detail about the maintenance action.
 








Class com.amazonaws.services.databasemigrationservice.model.RebootReplicationInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the replication instance.
 


forceFailover
Boolean forceFailover

 If this parameter is true, the reboot is conducted through a Multi-AZ failover. (If the instance
 isn't configured for Multi-AZ, then you can't specify true.)
 








Class com.amazonaws.services.databasemigrationservice.model.RebootReplicationInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationInstance
ReplicationInstance replicationInstance

 The replication instance that is being rebooted.
 








Class com.amazonaws.services.databasemigrationservice.model.RedshiftSettings extends Object implements Serializable


Serialized Fields


acceptAnyDate
Boolean acceptAnyDate

 A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be
 loaded without generating an error. You can choose true or false (the default).
 
 
 This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT
 parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a
 NULL value into that field.
 


afterConnectScript
String afterConnectScript

 Code to run after connecting. This parameter should contain the code itself, not the name of a file containing
 the code.
 


bucketFolder
String bucketFolder

 The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket.
 


bucketName
String bucketName

 The name of the S3 bucket you want to use
 


connectionTimeout
Integer connectionTimeout

 A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you
 initially establish a connection.
 


databaseName
String databaseName

 The name of the Amazon Redshift data warehouse (service) that you are working with.
 


dateFormat
String dateFormat

 The date format that you are using. Valid values are auto (case-sensitive), your date format string
 enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'.
 Using auto recognizes most strings, even some that aren't supported when you use a date format
 string.
 
 
 If your date and time values use formats different from each other, set this to auto.
 


emptyAsNull
Boolean emptyAsNull

 A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of
 true sets empty CHAR and VARCHAR fields to null. The default is false.
 


encryptionMode
String encryptionMode

 The type of server-side encryption that you want to use for your data. This encryption type is part of the
 endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3
 (the default) or SSE_KMS. To use SSE_S3, create an AWS Identity and Access Management
 (IAM) role with a policy that allows "arn:aws:s3:::*" to use the following actions:
 "s3:PutObject", "s3:ListBucket"
 


fileTransferUploadStreams
Integer fileTransferUploadStreams

 The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults
 to 10.
 


loadTimeout
Integer loadTimeout

 The amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.
 


maxFileSize
Integer maxFileSize

 The maximum size (in KB) of any .csv file used to transfer data to Amazon Redshift. This accepts a value from 1
 through 1,048,576. It defaults to 32,768 KB (32 MB).
 


password
String password

 The password for the user named in the username property.
 


port
Integer port

 The port number for Amazon Redshift. The default value is 5439.
 


removeQuotes
Boolean removeQuotes

 A value that specifies to remove surrounding quotation marks from strings in the incoming data. All characters
 within the quotation marks, including delimiters, are retained. Choose true to remove quotation
 marks. The default is false.
 


replaceInvalidChars
String replaceInvalidChars

 A list of characters that you want to replace. Use with ReplaceChars.
 


replaceChars
String replaceChars

 A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars,
 substituting the specified characters instead. The default is "?".
 


serverName
String serverName

 The name of the Amazon Redshift cluster you are using.
 


serviceAccessRoleArn
String serviceAccessRoleArn

 The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.
 


serverSideEncryptionKmsKeyId
String serverSideEncryptionKmsKeyId

 The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key
 ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.
 


timeFormat
String timeFormat

 The time format that you want to use. Valid values are auto (case-sensitive),
 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10.
 Using auto recognizes most strings, even some that aren't supported when you use a time format
 string.
 
 
 If your date and time values use formats different from each other, set this parameter to auto.
 


trimBlanks
Boolean trimBlanks

 A value that specifies to remove the trailing white space characters from a VARCHAR string. This parameter
 applies only to columns with a VARCHAR data type. Choose true to remove unneeded white space. The
 default is false.
 


truncateColumns
Boolean truncateColumns

 A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits
 in the column. This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4
 MB or less. Choose true to truncate data. The default is false.
 


username
String username

 An Amazon Redshift user name for a registered user.
 


writeBufferSize
Integer writeBufferSize

 The size of the write buffer to use in rows. Valid values range from 1 through 2,048. The default is 1,024. Use
 this setting to tune performance.
 








Class com.amazonaws.services.databasemigrationservice.model.RefreshSchemasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointArn
String endpointArn

 The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
 


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the replication instance.
 








Class com.amazonaws.services.databasemigrationservice.model.RefreshSchemasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


refreshSchemasStatus
RefreshSchemasStatus refreshSchemasStatus

 The status of the refreshed schema.
 








Class com.amazonaws.services.databasemigrationservice.model.RefreshSchemasStatus extends Object implements Serializable


Serialized Fields


endpointArn
String endpointArn

 The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
 


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the replication instance.
 


status
String status

 The status of the schema.
 


lastRefreshDate
Date lastRefreshDate

 The date the schema was last refreshed.
 


lastFailureMessage
String lastFailureMessage

 The last failure message for the schema.
 








Class com.amazonaws.services.databasemigrationservice.model.ReloadTablesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationTaskArn
String replicationTaskArn

 The Amazon Resource Name (ARN) of the replication task.
 


tablesToReload
List<E> tablesToReload

 The name and schema of the table to be reloaded.
 


reloadOption
String reloadOption

 Options for reload. Specify data-reload to reload the data and re-validate it if validation is
 enabled. Specify validate-only to re-validate the table. This option applies only when validation is
 enabled for the task.
 
 
 Valid values: data-reload, validate-only
 
 
 Default value is data-reload.
 








Class com.amazonaws.services.databasemigrationservice.model.ReloadTablesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationTaskArn
String replicationTaskArn

 The Amazon Resource Name (ARN) of the replication task.
 








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


Serialized Fields


resourceArn
String resourceArn

 An AWS DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name
 (ARN).
 


tagKeys
List<E> tagKeys

 The tag key (name) of the tag to be removed.
 








Class com.amazonaws.services.databasemigrationservice.model.RemoveTagsFromResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.databasemigrationservice.model.ReplicationInstance extends Object implements Serializable


Serialized Fields


replicationInstanceIdentifier
String replicationInstanceIdentifier

 The replication instance identifier. This parameter is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 alphanumeric characters or hyphens.
 
 
 
 
 First character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: myrepinstance
 


replicationInstanceClass
String replicationInstanceClass

 The compute and memory capacity of the replication instance.
 
 
 Valid Values:
 dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge 
 


replicationInstanceStatus
String replicationInstanceStatus

 The status of the replication instance.
 


allocatedStorage
Integer allocatedStorage

 The amount of storage (in gigabytes) that is allocated for the replication instance.
 


instanceCreateTime
Date instanceCreateTime

 The time the replication instance was created.
 


vpcSecurityGroups
List<E> vpcSecurityGroups

 The VPC security group for the instance.
 


availabilityZone
String availabilityZone

 The Availability Zone for the instance.
 


replicationSubnetGroup
ReplicationSubnetGroup replicationSubnetGroup

 The subnet group for the replication instance.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 The maintenance window times for the replication instance.
 


pendingModifiedValues
ReplicationPendingModifiedValues pendingModifiedValues

 The pending modification values.
 


multiAZ
Boolean multiAZ

 Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the
 AvailabilityZone parameter if the Multi-AZ parameter is set to true.
 


engineVersion
String engineVersion

 The engine version number of the replication instance.
 


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 Boolean value indicating if minor version upgrades will be automatically applied to the instance.
 


kmsKeyId
String kmsKeyId

 An AWS KMS key identifier that is used to encrypt the data on the replication instance.
 
 
 If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption
 key.
 
 
 AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default
 encryption key for each AWS Region.
 


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the replication instance.
 


replicationInstancePublicIpAddress
String replicationInstancePublicIpAddress
Deprecated. 

 The public IP address of the replication instance.
 


replicationInstancePrivateIpAddress
String replicationInstancePrivateIpAddress
Deprecated. 

 The private IP address of the replication instance.
 


replicationInstancePublicIpAddresses
List<E> replicationInstancePublicIpAddresses

 One or more public IP addresses for the replication instance.
 


replicationInstancePrivateIpAddresses
List<E> replicationInstancePrivateIpAddresses

 One or more private IP addresses 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.
 


secondaryAvailabilityZone
String secondaryAvailabilityZone

 The availability zone of the standby replication instance in a Multi-AZ deployment.
 


freeUntil
Date freeUntil

 The expiration date of the free replication instance that is part of the Free DMS program.
 


dnsNameServers
String dnsNameServers

 The DNS name servers for the replication instance.
 








Class com.amazonaws.services.databasemigrationservice.model.ReplicationInstanceTaskLog extends Object implements Serializable


Serialized Fields


replicationTaskName
String replicationTaskName

 The name of the replication task.
 


replicationTaskArn
String replicationTaskArn

 The Amazon Resource Name (ARN) of the replication task.
 


replicationInstanceTaskLogSize
Long replicationInstanceTaskLogSize

 The size, in bytes, of the replication task log.
 








Class com.amazonaws.services.databasemigrationservice.model.ReplicationPendingModifiedValues extends Object implements Serializable


Serialized Fields


replicationInstanceClass
String replicationInstanceClass

 The compute and memory capacity of the replication instance.
 
 
 Valid Values:
 dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge 
 


allocatedStorage
Integer allocatedStorage

 The amount of storage (in gigabytes) that is allocated for the replication instance.
 


multiAZ
Boolean multiAZ

 Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the
 AvailabilityZone parameter if the Multi-AZ parameter is set to true.
 


engineVersion
String engineVersion

 The engine version number of the replication instance.
 








Class com.amazonaws.services.databasemigrationservice.model.ReplicationSubnetGroup extends Object implements Serializable


Serialized Fields


replicationSubnetGroupIdentifier
String replicationSubnetGroupIdentifier

 The identifier of the replication instance subnet group.
 


replicationSubnetGroupDescription
String replicationSubnetGroupDescription

 A description for the replication subnet group.
 


vpcId
String vpcId

 The ID of the VPC.
 


subnetGroupStatus
String subnetGroupStatus

 The status of the subnet group.
 


subnets
List<E> subnets

 The subnets that are in the subnet group.
 








Class com.amazonaws.services.databasemigrationservice.model.ReplicationSubnetGroupDoesNotCoverEnoughAZsException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.ReplicationTask extends Object implements Serializable


Serialized Fields


replicationTaskIdentifier
String replicationTaskIdentifier

 The user-assigned replication task identifier or name.
 
 
 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.
 
 
 


sourceEndpointArn
String sourceEndpointArn

 The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
 


targetEndpointArn
String targetEndpointArn

 The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
 


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the replication instance.
 


migrationType
String migrationType

 The type of migration.
 


tableMappings
String tableMappings

 Table mappings specified in the task.
 


replicationTaskSettings
String replicationTaskSettings

 The settings for the replication task.
 


status
String status

 The status of the replication task.
 


lastFailureMessage
String lastFailureMessage

 The last error (failure) message generated for the replication instance.
 


stopReason
String stopReason

 The reason the replication task was stopped.
 


replicationTaskCreationDate
Date replicationTaskCreationDate

 The date the replication task was created.
 


replicationTaskStartDate
Date replicationTaskStartDate

 The date the replication task is scheduled to start.
 


cdcStartPosition
String cdcStartPosition

 Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition
 or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results
 in an error.
 
 
 The value can be in date, checkpoint, or LSN/SCN format.
 
 
 Date Example: --cdc-start-position “2018-03-08T12:12:12”
 
 
 Checkpoint Example: --cdc-start-position
 "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
 
 
 LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
 


cdcStopPosition
String cdcStopPosition

 Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or
 commit time.
 
 
 Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”
 
 
 Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “
 


recoveryCheckpoint
String recoveryCheckpoint

 Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this
 value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.
 


replicationTaskArn
String replicationTaskArn

 The Amazon Resource Name (ARN) of the replication task.
 


replicationTaskStats
ReplicationTaskStats replicationTaskStats

 The statistics for the task, including elapsed time, tables loaded, and table errors.
 








Class com.amazonaws.services.databasemigrationservice.model.ReplicationTaskAssessmentResult extends Object implements Serializable


Serialized Fields


replicationTaskIdentifier
String replicationTaskIdentifier

 The replication task identifier of the task on which the task assessment was run.
 


replicationTaskArn
String replicationTaskArn

 The Amazon Resource Name (ARN) of the replication task.
 


replicationTaskLastAssessmentDate
Date replicationTaskLastAssessmentDate

 The date the task assessment was completed.
 


assessmentStatus
String assessmentStatus

 The status of the task assessment.
 


assessmentResultsFile
String assessmentResultsFile

 The file containing the results of the task assessment.
 


assessmentResults
String assessmentResults

 The task assessment results in JSON format.
 


s3ObjectUrl
String s3ObjectUrl

 The URL of the S3 object containing the task assessment results.
 








Class com.amazonaws.services.databasemigrationservice.model.ReplicationTaskStats extends Object implements Serializable


Serialized Fields


fullLoadProgressPercent
Integer fullLoadProgressPercent

 The percent complete for the full load migration task.
 


elapsedTimeMillis
Long elapsedTimeMillis

 The elapsed time of the task, in milliseconds.
 


tablesLoaded
Integer tablesLoaded

 The number of tables loaded for this task.
 


tablesLoading
Integer tablesLoading

 The number of tables currently loading for this task.
 


tablesQueued
Integer tablesQueued

 The number of tables queued for this task.
 


tablesErrored
Integer tablesErrored

 The number of errors that have occurred during this task.
 


freshStartDate
Date freshStartDate

 The date the replication task was started either with a fresh start or a target reload.
 


startDate
Date startDate

 The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType.
 


stopDate
Date stopDate

 The date the replication task was stopped.
 


fullLoadStartDate
Date fullLoadStartDate

 The date the the replication task full load was started.
 


fullLoadFinishDate
Date fullLoadFinishDate

 The date the replication task full load was completed.
 








Class com.amazonaws.services.databasemigrationservice.model.ResourceAlreadyExistsException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceArn
String resourceArn








Class com.amazonaws.services.databasemigrationservice.model.ResourceNotFoundException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.ResourcePendingMaintenanceActions extends Object implements Serializable


Serialized Fields


resourceIdentifier
String resourceIdentifier

 The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to. For
 information about creating an ARN, see  Constructing an Amazon
 Resource Name (ARN) for AWS DMS in the DMS documentation.
 


pendingMaintenanceActionDetails
List<E> pendingMaintenanceActionDetails

 Detailed information about the pending maintenance action.
 








Class com.amazonaws.services.databasemigrationservice.model.ResourceQuotaExceededException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.S3Settings extends Object implements Serializable


Serialized Fields


serviceAccessRoleArn
String serviceAccessRoleArn

 The Amazon Resource Name (ARN) used by the service access IAM role.
 


externalTableDefinition
String externalTableDefinition

 The external table definition.
 


csvRowDelimiter
String csvRowDelimiter

 The delimiter used to separate rows in the source files. The default is a carriage return (\n).
 


csvDelimiter
String csvDelimiter

 The delimiter used to separate columns in the source files. The default is a comma.
 


bucketFolder
String bucketFolder

 An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path
  bucketFolder/schema_name/table_name/. If this parameter is not specified, then
 the path used is  schema_name/table_name/.
 


bucketName
String bucketName

 The name of the S3 bucket.
 


compressionType
String compressionType

 An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to
 NONE (the default) or do not use to leave the files uncompressed. Applies to both .csv and .parquet file formats.
 


encryptionMode
String encryptionMode

 The type of server-side encryption that you want to use for your data. This encryption type is part of the
 endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3
 (the default) or SSE_KMS. To use SSE_S3, you need an AWS Identity and Access Management
 (IAM) role with permission to allow "arn:aws:s3:::dms-*" to use the following actions:
 
 
 
 
 s3:CreateBucket
 
 
 
 
 s3:ListBucket
 
 
 
 
 s3:DeleteBucket
 
 
 
 
 s3:GetBucketLocation
 
 
 
 
 s3:GetObject
 
 
 
 
 s3:PutObject
 
 
 
 
 s3:DeleteObject
 
 
 
 
 s3:GetObjectVersion
 
 
 
 
 s3:GetBucketPolicy
 
 
 
 
 s3:PutBucketPolicy
 
 
 
 
 s3:DeleteBucketPolicy
 
 
 


serverSideEncryptionKmsKeyId
String serverSideEncryptionKmsKeyId

 If you are using SSE_KMS for the EncryptionMode, provide the AWS KMS key ID. The key
 that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and
 allows use of the key.
 
 
 Here is a CLI example:
 aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value 
 


dataFormat
String dataFormat

 The format of the data that you want to use for output. You can choose one of the following:
 
 
 
 
 csv : This is a row-based file format with comma-separated values (.csv).
 
 
 
 
 parquet : Apache Parquet (.parquet) is a columnar storage file format that features efficient
 compression and provides faster query response.
 
 
 


encodingType
String encodingType

 The type of encoding you are using:
 
 
 
 
 RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values
 more efficiently. This is the default.
 
 
 
 
 PLAIN doesn't use encoding at all. Values are stored as they are.
 
 
 
 
 PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is
 stored in a dictionary page for each column chunk.
 
 
 


dictPageSizeLimit
Integer dictPageSizeLimit

 The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is
 stored using an encoding type of PLAIN. This parameter defaults to 1024 * 1024 bytes (1 MiB), the
 maximum size of a dictionary page before it reverts to PLAIN encoding. This size is used for
 .parquet file format only.
 


rowGroupLength
Integer rowGroupLength

 The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row
 groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet
 file format only.
 
 
 If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in
 bytes (64 * 1024 * 1024).
 


dataPageSize
Integer dataPageSize

 The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for
 .parquet file format only.
 


parquetVersion
String parquetVersion

 The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or
 parquet_2_0.
 


enableStatistics
Boolean enableStatistics

 A value that enables statistics for Parquet pages and row groups. Choose true to enable statistics,
 false to disable. Statistics include NULL, DISTINCT, MAX, and
 MIN values. This parameter defaults to true. This value is used for .parquet file
 format only.
 


includeOpForFullLoad
Boolean includeOpForFullLoad

 A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only
 to indicate how the rows were added to the source database.
 
 
 
 AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and later.
 
 
 
 For full load, records can only be inserted. By default (the false setting), no information is
 recorded in these output files for a full load to indicate that the rows were inserted at the source database. If
 IncludeOpForFullLoad is set to true or y, the INSERT is recorded as an I
 annotation in the first field of the .csv file. This allows the format of your target records from a full load to
 be consistent with the target records from a CDC load.
 
 
 
 This setting works together with the CdcInsertsOnly parameter for output to .csv files only. For
 more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS Database Migration Service User
 Guide..
 
 


cdcInsertsOnly
Boolean cdcInsertsOnly

 A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage
 (.parquet) output files. By default (the false setting), the first field in a .csv or .parquet
 record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was
 inserted, updated, or deleted at the source database for a CDC load to the target.
 
 
 If CdcInsertsOnly is set to true or y, only INSERTs from the source
 database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends
 on the value of IncludeOpForFullLoad. If IncludeOpForFullLoad is set to
 true, the first field of every CDC record is set to I to indicate the INSERT operation at the
 source. If IncludeOpForFullLoad is set to false, every CDC record is written without a
 first field to indicate the INSERT operation at the source. For more information about how these settings work
 together, see Indicating Source DB Operations in Migrated S3 Data in the AWS Database Migration Service User
 Guide..
 
 
 
 AWS DMS supports this interaction between the CdcInsertsOnly and IncludeOpForFullLoad
 parameters in versions 3.1.4 and later.
 
 


timestampColumnName
String timestampColumnName

 A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an
 Amazon S3 target.
 
 
 
 AWS DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.
 
 
 
 DMS includes an additional STRING column in the .csv or .parquet object files of your migrated data
 when you set TimestampColumnName to a nonblank value.
 
 
 For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from
 the source to the target by DMS.
 
 
 For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of
 that row in the source database.
 
 
 The string format for this timestamp column value is yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the
 precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit
 timestamp supported by DMS for the source database.
 
 
 When the AddColumnName parameter is set to true, DMS also includes a name for the
 timestamp column that you set with TimestampColumnName.
 


parquetTimestampInMillisecond
Boolean parquetTimestampInMillisecond

 A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3
 object file in .parquet format.
 
 
 
 AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.
 
 
 
 When ParquetTimestampInMillisecond is set to true or y, AWS DMS writes all
 TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes
 them with microsecond precision.
 
 
 Currently, Amazon Athena and AWS Glue can handle only millisecond precision for TIMESTAMP values.
 Set this parameter to true for S3 endpoint object files that are .parquet formatted only if you plan
 to query or process the data with Athena or AWS Glue.
 
 
 
 AWS DMS writes any TIMESTAMP column values written to an S3 file in .csv format with microsecond
 precision.
 
 
 Setting ParquetTimestampInMillisecond has no effect on the string format of the timestamp column
 value that is inserted by setting the TimestampColumnName parameter.
 
 








Class com.amazonaws.services.databasemigrationservice.model.SNSInvalidTopicException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.SNSNoAuthorizationException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.StartReplicationTaskAssessmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationTaskArn
String replicationTaskArn

 The Amazon Resource Name (ARN) of the replication task.
 








Class com.amazonaws.services.databasemigrationservice.model.StartReplicationTaskAssessmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationTask
ReplicationTask replicationTask

 The assessed replication task.
 








Class com.amazonaws.services.databasemigrationservice.model.StartReplicationTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationTaskArn
String replicationTaskArn

 The Amazon Resource Name (ARN) of the replication task to be started.
 


startReplicationTaskType
String startReplicationTaskType

 The type of replication task.
 


cdcStartTime
Date cdcStartTime

 Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition
 to specify when you want a CDC operation to start. Specifying both values results in an error.
 
 
 Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”
 


cdcStartPosition
String cdcStartPosition

 Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or
 CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.
 
 
 The value can be in date, checkpoint, or LSN/SCN format.
 
 
 Date Example: --cdc-start-position “2018-03-08T12:12:12”
 
 
 Checkpoint Example: --cdc-start-position
 "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
 
 
 LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”
 
 
 
 When you use this task setting with a source PostgreSQL database, a logical replication slot should already be
 created and associated with the source endpoint. You can verify this by setting the slotName extra
 connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.
 
 


cdcStopPosition
String cdcStopPosition

 Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or
 commit time.
 
 
 Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”
 
 
 Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “
 








Class com.amazonaws.services.databasemigrationservice.model.StartReplicationTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationTask
ReplicationTask replicationTask

 The replication task started.
 








Class com.amazonaws.services.databasemigrationservice.model.StopReplicationTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationTaskArn
String replicationTaskArn

 The Amazon Resource Name(ARN) of the replication task to be stopped.
 








Class com.amazonaws.services.databasemigrationservice.model.StopReplicationTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


replicationTask
ReplicationTask replicationTask

 The replication task stopped.
 








Class com.amazonaws.services.databasemigrationservice.model.StorageQuotaExceededException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.Subnet extends Object implements Serializable


Serialized Fields


subnetIdentifier
String subnetIdentifier

 The subnet identifier.
 


subnetAvailabilityZone
AvailabilityZone subnetAvailabilityZone

 The Availability Zone of the subnet.
 


subnetStatus
String subnetStatus

 The status of the subnet.
 








Class com.amazonaws.services.databasemigrationservice.model.SubnetAlreadyInUseException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.SupportedEndpointType extends Object implements Serializable


Serialized Fields


engineName
String engineName

 The database engine name. Valid values, depending on the EndpointType, include mysql, oracle, postgres, mariadb,
 aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.
 


supportsCDC
Boolean supportsCDC

 Indicates if Change Data Capture (CDC) is supported.
 


endpointType
String endpointType

 The type of endpoint. Valid values are source and target.
 


engineDisplayName
String engineDisplayName

 The expanded name for the engine name. For example, if the EngineName parameter is "aurora," this
 value would be "Amazon Aurora MySQL."
 








Class com.amazonaws.services.databasemigrationservice.model.TableStatistics extends Object implements Serializable


Serialized Fields


schemaName
String schemaName

 The schema name.
 


tableName
String tableName

 The name of the table.
 


inserts
Long inserts

 The number of insert actions performed on a table.
 


deletes
Long deletes

 The number of delete actions performed on a table.
 


updates
Long updates

 The number of update actions performed on a table.
 


ddls
Long ddls

 The Data Definition Language (DDL) used to build and modify the structure of your tables.
 


fullLoadRows
Long fullLoadRows

 The number of rows added during the Full Load operation.
 


fullLoadCondtnlChkFailedRows
Long fullLoadCondtnlChkFailedRows

 The number of rows that failed conditional checks during the Full Load operation (valid only for DynamoDB as a
 target migrations).
 


fullLoadErrorRows
Long fullLoadErrorRows

 The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target
 migrations).
 


lastUpdateTime
Date lastUpdateTime

 The last time the table was updated.
 


tableState
String tableState

 The state of the tables described.
 
 
 Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error |
 Table all | Table updates | Table is being reloaded
 


validationPendingRecords
Long validationPendingRecords

 The number of records that have yet to be validated.
 


validationFailedRecords
Long validationFailedRecords

 The number of records that failed validation.
 


validationSuspendedRecords
Long validationSuspendedRecords

 The number of records that could not be validated.
 


validationState
String validationState

 The validation state of the table.
 
 
 The parameter can have the following values
 
 
 
 
 Not enabled—Validation is not enabled for the table in the migration task.
 
 
 
 
 Pending records—Some records in the table are waiting for validation.
 
 
 
 
 Mismatched records—Some records in the table do not match between the source and target.
 
 
 
 
 Suspended records—Some records in the table could not be validated.
 
 
 
 
 No primary key—The table could not be validated because it had no primary key.
 
 
 
 
 Table error—The table was not validated because it was in an error state and some data was not migrated.
 
 
 
 
 Validated—All rows in the table were validated. If the table is updated, the status can change from Validated.
 
 
 
 
 Error—The table could not be validated because of an unexpected error.
 
 
 


validationStateDetails
String validationStateDetails

 Additional details about the state of validation.
 








Class com.amazonaws.services.databasemigrationservice.model.TableToReload extends Object implements Serializable


Serialized Fields


schemaName
String schemaName

 The schema name of the table to be reloaded.
 


tableName
String tableName

 The table name of the table to be reloaded.
 








Class com.amazonaws.services.databasemigrationservice.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and
 cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits,
 white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
 


value
String value

 A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and
 cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits,
 white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
 








Class com.amazonaws.services.databasemigrationservice.model.TestConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


replicationInstanceArn
String replicationInstanceArn

 The Amazon Resource Name (ARN) of the replication instance.
 


endpointArn
String endpointArn

 The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
 








Class com.amazonaws.services.databasemigrationservice.model.TestConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connection
Connection connection

 The connection tested.
 








Class com.amazonaws.services.databasemigrationservice.model.UpgradeDependencyFailureException extends AWSDatabaseMigrationServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.databasemigrationservice.model.VpcSecurityGroupMembership extends Object implements Serializable


Serialized Fields


vpcSecurityGroupId
String vpcSecurityGroupId

 The VPC security group Id.
 


status
String status

 The status of the VPC security group.
 








Package com.amazonaws.services.dataexchange.model




Class com.amazonaws.services.dataexchange.model.AccessDeniedException extends AWSDataExchangeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dataexchange.model.AssetDestinationEntry extends Object implements Serializable


Serialized Fields


assetId
String assetId

 The unique identifier for the asset.
 


bucket
String bucket

 The S3 bucket that is the destination for the asset.
 


key
String key

 The name of the object in Amazon S3 for the asset.
 








Class com.amazonaws.services.dataexchange.model.AssetDetails extends Object implements Serializable


Serialized Fields


s3SnapshotAsset
S3SnapshotAsset s3SnapshotAsset








Class com.amazonaws.services.dataexchange.model.AssetEntry extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN for the asset.
 


assetDetails
AssetDetails assetDetails

 Information about the asset, including its size.
 


assetType
String assetType

 The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
 


createdAt
Date createdAt

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


dataSetId
String dataSetId

 The unique identifier for the data set associated with this asset.
 


id
String id

 The unique identifier for the asset.
 


name
String name

 The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting
 to Amazon S3, the asset name is used as default target S3 object key.
 


revisionId
String revisionId

 The unique identifier for the revision associated with this asset.
 


sourceId
String sourceId

 The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when
 an asset owner is viewing the entitled copy of its owned asset.
 


updatedAt
Date updatedAt

 The date and time that the asset was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.AssetSourceEntry extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The S3 bucket that's part of the source of the asset.
 


key
String key

 The name of the object in Amazon S3 for the asset.
 








Class com.amazonaws.services.dataexchange.model.AWSDataExchangeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dataexchange.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier for a job.
 








Class com.amazonaws.services.dataexchange.model.CancelJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.dataexchange.model.ConflictException extends AWSDataExchangeException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceId
String resourceId

 The unique identifier for the resource with the conflict.
 


resourceType
String resourceType

 The type of the resource with the conflict.
 








Class com.amazonaws.services.dataexchange.model.CreateDataSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assetType
String assetType

 The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
 


description
String description

 A description for the data set. This value can be up to 16,348 characters long.
 


name
String name

 The name of the data set.
 


tags
Map<K,V> tags

 A data set tag is an optional label that you can assign to a data set when you create it. Each tag consists of a
 key and an optional value, both of which you define. When you use tagging, you can also use tag-based access
 control in IAM policies to control access to these data sets and revisions.
 








Class com.amazonaws.services.dataexchange.model.CreateDataSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN for the data set.
 


assetType
String assetType

 The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
 


createdAt
Date createdAt

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


description
String description

 The description for the data set.
 


id
String id

 The unique identifier for the data set.
 


name
String name

 The name of the data set.
 


origin
String origin

 A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for
 subscribers).
 


originDetails
OriginDetails originDetails

 If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
 


sourceId
String sourceId

 The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is
 returned when a data set owner is viewing the entitled copy of its owned data set.
 


tags
Map<K,V> tags

 The tags for the data set.
 


updatedAt
Date updatedAt

 The date and time that the data set was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


details
RequestDetails details

 The details for the CreateJob request.
 


type
String type

 The type of job to be created.
 








Class com.amazonaws.services.dataexchange.model.CreateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN for the job.
 


createdAt
Date createdAt

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


details
ResponseDetails details

 Details about the job.
 


errors
List<E> errors

 The errors associated with jobs.
 


id
String id

 The unique identifier for the job.
 


state
String state

 The state of the job.
 


type
String type

 The job type.
 


updatedAt
Date updatedAt

 The date and time that the job was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.CreateRevisionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


comment
String comment

 An optional comment about the revision.
 


dataSetId
String dataSetId

 The unique identifier for a data set.
 


tags
Map<K,V> tags

 A revision tag is an optional label that you can assign to a revision when you create it. Each tag consists of a
 key and an optional value, both of which you define. When you use tagging, you can also use tag-based access
 control in IAM policies to control access to these data sets and revisions.
 








Class com.amazonaws.services.dataexchange.model.CreateRevisionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN for the revision
 


comment
String comment

 An optional comment about the revision.
 


createdAt
Date createdAt

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


dataSetId
String dataSetId

 The unique identifier for the data set associated with this revision.
 


finalized
Boolean finalized

 To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision
 tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this
 read-only state, you can publish the revision to your products.
 
 
 Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API,
 using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely
 identified by their ARN.
 


id
String id

 The unique identifier for the revision.
 


sourceId
String sourceId

 The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is
 returned when a revision owner is viewing the entitled copy of its owned revision.
 


tags
Map<K,V> tags

 The tags for the revision.
 


updatedAt
Date updatedAt

 The date and time that the revision was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.DataSetEntry extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN for the data set.
 


assetType
String assetType

 The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
 


createdAt
Date createdAt

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


description
String description

 The description for the data set.
 


id
String id

 The unique identifier for the data set.
 


name
String name

 The name of the data set.
 


origin
String origin

 A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for
 subscribers).
 


originDetails
OriginDetails originDetails

 If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
 


sourceId
String sourceId

 The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is
 returned when a data set owner is viewing the entitled copy of its owned data set.
 


updatedAt
Date updatedAt

 The date and time that the data set was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.DeleteAssetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assetId
String assetId

 The unique identifier for an asset.
 


dataSetId
String dataSetId

 The unique identifier for a data set.
 


revisionId
String revisionId

 The unique identifier for a revision.
 








Class com.amazonaws.services.dataexchange.model.DeleteAssetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.dataexchange.model.DeleteDataSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSetId
String dataSetId

 The unique identifier for a data set.
 








Class com.amazonaws.services.dataexchange.model.DeleteDataSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.dataexchange.model.DeleteRevisionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSetId
String dataSetId

 The unique identifier for a data set.
 


revisionId
String revisionId

 The unique identifier for a revision.
 








Class com.amazonaws.services.dataexchange.model.DeleteRevisionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.dataexchange.model.Details extends Object implements Serializable


Serialized Fields


importAssetFromSignedUrlJobErrorDetails
ImportAssetFromSignedUrlJobErrorDetails importAssetFromSignedUrlJobErrorDetails


importAssetsFromS3JobErrorDetails
List<E> importAssetsFromS3JobErrorDetails








Class com.amazonaws.services.dataexchange.model.ExportAssetsToS3RequestDetails extends Object implements Serializable


Serialized Fields


assetDestinations
List<E> assetDestinations

 The destination for the asset.
 


dataSetId
String dataSetId

 The unique identifier for the data set associated with this export job.
 


revisionId
String revisionId

 The unique identifier for the revision associated with this export request.
 








Class com.amazonaws.services.dataexchange.model.ExportAssetsToS3ResponseDetails extends Object implements Serializable


Serialized Fields


assetDestinations
List<E> assetDestinations

 The destination in Amazon S3 where the asset is exported.
 


dataSetId
String dataSetId

 The unique identifier for the data set associated with this export job.
 


revisionId
String revisionId

 The unique identifier for the revision associated with this export response.
 








Class com.amazonaws.services.dataexchange.model.ExportAssetToSignedUrlRequestDetails extends Object implements Serializable


Serialized Fields


assetId
String assetId

 The unique identifier for the asset that is exported to a signed URL.
 


dataSetId
String dataSetId

 The unique identifier for the data set associated with this export job.
 


revisionId
String revisionId

 The unique identifier for the revision associated with this export request.
 








Class com.amazonaws.services.dataexchange.model.ExportAssetToSignedUrlResponseDetails extends Object implements Serializable


Serialized Fields


assetId
String assetId

 The unique identifier for the asset associated with this export job.
 


dataSetId
String dataSetId

 The unique identifier for the data set associated with this export job.
 


revisionId
String revisionId

 The unique identifier for the revision associated with this export response.
 


signedUrl
String signedUrl

 The signed URL for the export request.
 


signedUrlExpiresAt
Date signedUrlExpiresAt

 The date and time that the signed URL expires, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.GetAssetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assetId
String assetId

 The unique identifier for an asset.
 


dataSetId
String dataSetId

 The unique identifier for a data set.
 


revisionId
String revisionId

 The unique identifier for a revision.
 








Class com.amazonaws.services.dataexchange.model.GetAssetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN for the asset.
 


assetDetails
AssetDetails assetDetails

 Information about the asset, including its size.
 


assetType
String assetType

 The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
 


createdAt
Date createdAt

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


dataSetId
String dataSetId

 The unique identifier for the data set associated with this asset.
 


id
String id

 The unique identifier for the asset.
 


name
String name

 The name of the asset When importing from Amazon S3, the S3 object key is used as the asset name. When exporting
 to Amazon S3, the asset name is used as default target S3 object key.
 


revisionId
String revisionId

 The unique identifier for the revision associated with this asset.
 


sourceId
String sourceId

 The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when
 an asset owner is viewing the entitled copy of its owned asset.
 


updatedAt
Date updatedAt

 The date and time that the asset was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.GetDataSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSetId
String dataSetId

 The unique identifier for a data set.
 








Class com.amazonaws.services.dataexchange.model.GetDataSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN for the data set.
 


assetType
String assetType

 The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
 


createdAt
Date createdAt

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


description
String description

 The description for the data set.
 


id
String id

 The unique identifier for the data set.
 


name
String name

 The name of the data set.
 


origin
String origin

 A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for
 subscribers).
 


originDetails
OriginDetails originDetails

 If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
 


sourceId
String sourceId

 The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is
 returned when a data set owner is viewing the entitled copy of its owned data set.
 


tags
Map<K,V> tags

 The tags for the data set.
 


updatedAt
Date updatedAt

 The date and time that the data set was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.GetJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier for a job.
 








Class com.amazonaws.services.dataexchange.model.GetJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN for the job.
 


createdAt
Date createdAt

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


details
ResponseDetails details

 Details about the job.
 


errors
List<E> errors

 The errors associated with jobs.
 


id
String id

 The unique identifier for the job.
 


state
String state

 The state of the job.
 


type
String type

 The job type.
 


updatedAt
Date updatedAt

 The date and time that the job was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.GetRevisionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSetId
String dataSetId

 The unique identifier for a data set.
 


revisionId
String revisionId

 The unique identifier for a revision.
 








Class com.amazonaws.services.dataexchange.model.GetRevisionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN for the revision
 


comment
String comment

 An optional comment about the revision.
 


createdAt
Date createdAt

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


dataSetId
String dataSetId

 The unique identifier for the data set associated with this revision.
 


finalized
Boolean finalized

 To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision
 tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this
 read-only state, you can publish the revision to your products.
 
 
 Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API,
 using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely
 identified by their ARN.
 


id
String id

 The unique identifier for the revision.
 


sourceId
String sourceId

 The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is
 returned when a revision owner is viewing the entitled copy of its owned revision.
 


tags
Map<K,V> tags

 The tags for the revision.
 


updatedAt
Date updatedAt

 The date and time that the revision was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.ImportAssetFromSignedUrlJobErrorDetails extends Object implements Serializable


Serialized Fields


assetName
String assetName








Class com.amazonaws.services.dataexchange.model.ImportAssetFromSignedUrlRequestDetails extends Object implements Serializable


Serialized Fields


assetName
String assetName

 The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name.
 


dataSetId
String dataSetId

 The unique identifier for the data set associated with this import job.
 


md5Hash
String md5Hash

 The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
 


revisionId
String revisionId

 The unique identifier for the revision associated with this import request.
 








Class com.amazonaws.services.dataexchange.model.ImportAssetFromSignedUrlResponseDetails extends Object implements Serializable


Serialized Fields


assetName
String assetName

 The name for the asset associated with this import response.
 


dataSetId
String dataSetId

 The unique identifier for the data set associated with this import job.
 


md5Hash
String md5Hash

 The Base64-encoded Md5 hash for the asset, used to ensure the integrity of the file at that location.
 


revisionId
String revisionId

 The unique identifier for the revision associated with this import response.
 


signedUrl
String signedUrl

 The signed URL.
 


signedUrlExpiresAt
Date signedUrlExpiresAt

 The time and date at which the signed URL expires, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.ImportAssetsFromS3RequestDetails extends Object implements Serializable


Serialized Fields


assetSources
List<E> assetSources

 Is a list of S3 bucket and object key pairs.
 


dataSetId
String dataSetId

 The unique identifier for the data set associated with this import job.
 


revisionId
String revisionId

 The unique identifier for the revision associated with this import request.
 








Class com.amazonaws.services.dataexchange.model.ImportAssetsFromS3ResponseDetails extends Object implements Serializable


Serialized Fields


assetSources
List<E> assetSources

 Is a list of Amazon S3 bucket and object key pairs.
 


dataSetId
String dataSetId

 The unique identifier for the data set associated with this import job.
 


revisionId
String revisionId

 The unique identifier for the revision associated with this import response.
 








Class com.amazonaws.services.dataexchange.model.InternalServerException extends AWSDataExchangeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dataexchange.model.JobEntry extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN for the job.
 


createdAt
Date createdAt

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


details
ResponseDetails details

 Details of the operation to be performed by the job, such as export destination details or import source details.
 


errors
List<E> errors

 Errors for jobs.
 


id
String id

 The unique identifier for the job.
 


state
String state

 The state of the job.
 


type
String type

 The job type.
 


updatedAt
Date updatedAt

 The date and time that the job was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.JobError extends Object implements Serializable


Serialized Fields


code
String code
The code for the job error.


details
Details details


limitName
String limitName

 The name of the limit that was reached.
 


limitValue
Double limitValue
The value of the exceeded limit.


message
String message
The message related to the job error.


resourceId
String resourceId
The unqiue identifier for the resource related to the error.


resourceType
String resourceType
The type of resource related to the error.








Class com.amazonaws.services.dataexchange.model.ListDataSetRevisionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSetId
String dataSetId

 The unique identifier for a data set.
 


maxResults
Integer maxResults

 The maximum number of results returned by a single call.
 


nextToken
String nextToken

 The token value retrieved from a previous call to access the next page of results.
 








Class com.amazonaws.services.dataexchange.model.ListDataSetRevisionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 The token value retrieved from a previous call to access the next page of results.
 


revisions
List<E> revisions

 The asset objects listed by the request.
 








Class com.amazonaws.services.dataexchange.model.ListDataSetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results returned by a single call.
 


nextToken
String nextToken

 The token value retrieved from a previous call to access the next page of results.
 


origin
String origin

 A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for
 subscribers).
 








Class com.amazonaws.services.dataexchange.model.ListDataSetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataSets
List<E> dataSets

 The data set objects listed by the request.
 


nextToken
String nextToken

 The token value retrieved from a previous call to access the next page of results.
 








Class com.amazonaws.services.dataexchange.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSetId
String dataSetId

 The unique identifier for a data set.
 


maxResults
Integer maxResults

 The maximum number of results returned by a single call.
 


nextToken
String nextToken

 The token value retrieved from a previous call to access the next page of results.
 


revisionId
String revisionId

 The unique identifier for a revision.
 








Class com.amazonaws.services.dataexchange.model.ListJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobs
List<E> jobs

 The jobs listed by the request.
 


nextToken
String nextToken

 The token value retrieved from a previous call to access the next page of results.
 








Class com.amazonaws.services.dataexchange.model.ListRevisionAssetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSetId
String dataSetId

 The unique identifier for a data set.
 


maxResults
Integer maxResults

 The maximum number of results returned by a single call.
 


nextToken
String nextToken

 The token value retrieved from a previous call to access the next page of results.
 


revisionId
String revisionId

 The unique identifier for a revision.
 








Class com.amazonaws.services.dataexchange.model.ListRevisionAssetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assets
List<E> assets

 The asset objects listed by the request.
 


nextToken
String nextToken

 The token value retrieved from a previous call to access the next page of results.
 








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


Serialized Fields


resourceArn
String resourceArn

 An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
 








Class com.amazonaws.services.dataexchange.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags
A label that consists of a customer-defined key and an optional value.








Class com.amazonaws.services.dataexchange.model.OriginDetails extends Object implements Serializable


Serialized Fields


productId
String productId








Class com.amazonaws.services.dataexchange.model.RequestDetails extends Object implements Serializable


Serialized Fields


exportAssetToSignedUrl
ExportAssetToSignedUrlRequestDetails exportAssetToSignedUrl

 Details about the export to signed URL request.
 


exportAssetsToS3
ExportAssetsToS3RequestDetails exportAssetsToS3

 Details about the export to Amazon S3 request.
 


importAssetFromSignedUrl
ImportAssetFromSignedUrlRequestDetails importAssetFromSignedUrl

 Details about the import from signed URL request.
 


importAssetsFromS3
ImportAssetsFromS3RequestDetails importAssetsFromS3

 Details about the import from Amazon S3 request.
 








Class com.amazonaws.services.dataexchange.model.ResourceNotFoundException extends AWSDataExchangeException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceId
String resourceId

 The unique identifier for the resource that couldn't be found.
 


resourceType
String resourceType

 The type of resource that couldn't be found.
 








Class com.amazonaws.services.dataexchange.model.ResponseDetails extends Object implements Serializable


Serialized Fields


exportAssetToSignedUrl
ExportAssetToSignedUrlResponseDetails exportAssetToSignedUrl

 Details for the export to signed URL response.
 


exportAssetsToS3
ExportAssetsToS3ResponseDetails exportAssetsToS3

 Details for the export to Amazon S3 response.
 


importAssetFromSignedUrl
ImportAssetFromSignedUrlResponseDetails importAssetFromSignedUrl

 Details for the import from signed URL response.
 


importAssetsFromS3
ImportAssetsFromS3ResponseDetails importAssetsFromS3

 Details for the import from Amazon S3 response.
 








Class com.amazonaws.services.dataexchange.model.RevisionEntry extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN for the revision.
 


comment
String comment

 An optional comment about the revision.
 


createdAt
Date createdAt

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


dataSetId
String dataSetId

 The unique identifier for the data set associated with this revision.
 


finalized
Boolean finalized

 To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision
 tells AWS Data Exchange that your changes to the assets in the revision are complete. After it's in this
 read-only state, you can publish the revision to your products.
 
 
 Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API,
 using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely
 identified by their ARN.
 


id
String id

 The unique identifier for the revision.
 


sourceId
String sourceId

 The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is
 returned when a revision owner is viewing the entitled copy of its owned revision.
 


updatedAt
Date updatedAt

 The date and time that the revision was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.S3SnapshotAsset extends Object implements Serializable


Serialized Fields


size
Double size

 The size of the S3 object that is the object.
 








Class com.amazonaws.services.dataexchange.model.ServiceLimitExceededException extends AWSDataExchangeException implements Serializable

serialVersionUID:
1L



Serialized Fields


limitName
String limitName

 The name of the quota that was exceeded.
 


limitValue
Double limitValue

 The maximum value for the service-specific limit.
 








Class com.amazonaws.services.dataexchange.model.StartJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier for a job.
 








Class com.amazonaws.services.dataexchange.model.StartJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.dataexchange.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
 


tags
Map<K,V> tags
A label that consists of a customer-defined key and an optional value.








Class com.amazonaws.services.dataexchange.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.dataexchange.model.ThrottlingException extends AWSDataExchangeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dataexchange.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 An Amazon Resource Name (ARN) that uniquely identifies an AWS resource.
 


tagKeys
List<E> tagKeys
The key tags.








Class com.amazonaws.services.dataexchange.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.dataexchange.model.UpdateAssetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assetId
String assetId

 The unique identifier for an asset.
 


dataSetId
String dataSetId

 The unique identifier for a data set.
 


name
String name

 The name of the asset. When importing from Amazon S3, the S3 object key is used as the asset name. When exporting
 to Amazon S3, the asset name is used as default target S3 object key.
 


revisionId
String revisionId

 The unique identifier for a revision.
 








Class com.amazonaws.services.dataexchange.model.UpdateAssetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN for the asset.
 


assetDetails
AssetDetails assetDetails

 Information about the asset, including its size.
 


assetType
String assetType

 The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
 


createdAt
Date createdAt

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


dataSetId
String dataSetId

 The unique identifier for the data set associated with this asset.
 


id
String id

 The unique identifier for the asset.
 


name
String name

 The name of the asset When importing from Amazon S3, the S3 object key is used as the asset name. When exporting
 to Amazon S3, the asset name is used as default target S3 object key.
 


revisionId
String revisionId

 The unique identifier for the revision associated with this asset.
 


sourceId
String sourceId

 The asset ID of the owned asset corresponding to the entitled asset being viewed. This parameter is returned when
 an asset owner is viewing the entitled copy of its owned asset.
 


updatedAt
Date updatedAt

 The date and time that the asset was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.UpdateDataSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSetId
String dataSetId

 The unique identifier for a data set.
 


description
String description

 The description for the data set.
 


name
String name

 The name of the data set.
 








Class com.amazonaws.services.dataexchange.model.UpdateDataSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN for the data set.
 


assetType
String assetType

 The type of file your data is stored in. Currently, the supported asset type is S3_SNAPSHOT.
 


createdAt
Date createdAt

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


description
String description

 The description for the data set.
 


id
String id

 The unique identifier for the data set.
 


name
String name

 The name of the data set.
 


origin
String origin

 A property that defines the data set as OWNED by the account (for providers) or ENTITLED to the account (for
 subscribers).
 


originDetails
OriginDetails originDetails

 If the origin of this data set is ENTITLED, includes the details for the product on AWS Marketplace.
 


sourceId
String sourceId

 The data set ID of the owned data set corresponding to the entitled data set being viewed. This parameter is
 returned when a data set owner is viewing the entitled copy of its owned data set.
 


updatedAt
Date updatedAt

 The date and time that the data set was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.UpdateRevisionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


comment
String comment

 An optional comment about the revision.
 


dataSetId
String dataSetId

 The unique identifier for a data set.
 


finalized
Boolean finalized

 Finalizing a revision tells AWS Data Exchange that your changes to the assets in the revision are complete. After
 it's in this read-only state, you can publish the revision to your products.
 


revisionId
String revisionId

 The unique identifier for a revision.
 








Class com.amazonaws.services.dataexchange.model.UpdateRevisionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN for the revision.
 


comment
String comment

 An optional comment about the revision.
 


createdAt
Date createdAt

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


dataSetId
String dataSetId

 The unique identifier for the data set associated with this revision.
 


finalized
Boolean finalized

 To publish a revision to a data set in a product, the revision must first be finalized. Finalizing a revision
 tells AWS Data Exchange that changes to the assets in the revision are complete. After it's in this read-only
 state, you can publish the revision to your products.
 
 
 Finalized revisions can be published through the AWS Data Exchange console or the AWS Marketplace Catalog API,
 using the StartChangeSet AWS Marketplace Catalog API action. When using the API, revisions are uniquely
 identified by their ARN.
 


id
String id

 The unique identifier for the revision.
 


sourceId
String sourceId

 The revision ID of the owned revision corresponding to the entitled revision being viewed. This parameter is
 returned when a revision owner is viewing the entitled copy of its owned revision.
 


updatedAt
Date updatedAt

 The date and time that the revision was last updated, in ISO 8601 format.
 








Class com.amazonaws.services.dataexchange.model.ValidationException extends AWSDataExchangeException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.datapipeline.model




Class com.amazonaws.services.datapipeline.model.ActivatePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline.
 


parameterValues
SdkInternalList<T> parameterValues

 A list of parameter values to pass to the pipeline at activation.
 


startTimestamp
Date startTimestamp

 The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.
 








Class com.amazonaws.services.datapipeline.model.ActivatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datapipeline.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline.
 


tags
SdkInternalList<T> tags

 The tags to add, as key/value pairs.
 








Class com.amazonaws.services.datapipeline.model.AddTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datapipeline.model.CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account,
 because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.
 


uniqueId
String uniqueId

 A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline.
 You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this
 parameter to ensure idempotency during repeated calls to CreatePipeline. For example, if the first
 call to CreatePipeline does not succeed, you can pass in the same unique identifier and pipeline
 name combination on a subsequent call to CreatePipeline. CreatePipeline ensures that if
 a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead,
 you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique
 identifier combination is scoped to the AWS account or IAM user credentials.
 


description
String description

 The description for the pipeline.
 


tags
SdkInternalList<T> tags

 A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more
 information, see Controlling User
 Access to Pipelines in the AWS Data Pipeline Developer Guide.
 








Class com.amazonaws.services.datapipeline.model.CreatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> 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.DataPipelineException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.datapipeline.model.DeactivatePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline.
 


cancelActive
Boolean cancelActive

 Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects
 to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.
 








Class com.amazonaws.services.datapipeline.model.DeactivatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datapipeline.model.DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline.
 








Class com.amazonaws.services.datapipeline.model.DeletePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datapipeline.model.DescribeObjectsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline that contains the object definitions.
 


objectIds
SdkInternalList<T> objectIds

 The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25
 identifiers in a single call to DescribeObjects.
 


evaluateExpressions
Boolean evaluateExpressions

 Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
 


marker
String marker

 The starting point for the results to be returned. For the first call, this value should be empty. As long as
 there are more results, continue to call DescribeObjects with the marker value from the previous
 call to retrieve the next set of results.
 








Class com.amazonaws.services.datapipeline.model.DescribeObjectsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelineObjects
SdkInternalList<T> pipelineObjects

 An array of object definitions.
 


marker
String marker

 The starting point for the next page of results. To view the next page of results, call
 DescribeObjects again with this marker value. If the value is null, there are no more results.
 


hasMoreResults
Boolean hasMoreResults

 Indicates whether there are more results to return.
 








Class com.amazonaws.services.datapipeline.model.DescribePipelinesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineIds
SdkInternalList<T> pipelineIds

 The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline
 IDs, call ListPipelines.
 








Class com.amazonaws.services.datapipeline.model.DescribePipelinesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelineDescriptionList
SdkInternalList<T> pipelineDescriptionList

 An array of descriptions for the specified pipelines.
 








Class com.amazonaws.services.datapipeline.model.EvaluateExpressionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline.
 


objectId
String objectId

 The ID of the object.
 


expression
String expression

 The expression to evaluate.
 








Class com.amazonaws.services.datapipeline.model.EvaluateExpressionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


evaluatedExpression
String evaluatedExpression

 The evaluated expression.
 








Class com.amazonaws.services.datapipeline.model.Field extends Object implements Serializable


Serialized Fields


key
String key

 The field identifier.
 


stringValue
String stringValue

 The field value, expressed as a String.
 


refValue
String refValue

 The field value, expressed as the identifier of another object.
 








Class com.amazonaws.services.datapipeline.model.GetPipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline.
 


version
String version

 The version of the pipeline definition to retrieve. Set this parameter to latest (default) to use
 the last definition saved to the pipeline or active to use the last definition that was activated.
 








Class com.amazonaws.services.datapipeline.model.GetPipelineDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelineObjects
SdkInternalList<T> pipelineObjects

 The objects defined in the pipeline.
 


parameterObjects
SdkInternalList<T> parameterObjects

 The parameter objects used in the pipeline definition.
 


parameterValues
SdkInternalList<T> parameterValues

 The parameter values used in the pipeline definition.
 








Class com.amazonaws.services.datapipeline.model.InstanceIdentity extends Object implements Serializable


Serialized Fields


document
String document

 A description of an EC2 instance that is generated when the instance is launched and exposed to the instance via
 the instance metadata service in the form of a JSON representation of an object.
 


signature
String signature

 A signature which can be used to verify the accuracy and authenticity of the information provided in the instance
 identity document.
 








Class com.amazonaws.services.datapipeline.model.InternalServiceErrorException extends DataPipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.datapipeline.model.InvalidRequestException extends DataPipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.datapipeline.model.ListPipelinesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


marker
String marker

 The starting point for the results to be returned. For the first call, this value should be empty. As long as
 there are more results, continue to call ListPipelines with the marker value from the previous call
 to retrieve the next set of results.
 








Class com.amazonaws.services.datapipeline.model.ListPipelinesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelineIdList
SdkInternalList<T> pipelineIdList

 The pipeline identifiers. If you require additional information about the pipelines, you can use these
 identifiers to call DescribePipelines and GetPipelineDefinition.
 


marker
String marker

 The starting point for the next page of results. To view the next page of results, call
 ListPipelinesOutput again with this marker value. If the value is null, there are no more results.
 


hasMoreResults
Boolean hasMoreResults

 Indicates whether there are more results that can be obtained by a subsequent call.
 








Class com.amazonaws.services.datapipeline.model.Operator extends Object implements Serializable


Serialized Fields


type
String type

 The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than
 or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal
 reference (REF_EQ) can be used only with reference fields. The other comparison types can be used
 only with String fields. The comparison types you can use apply only to certain object fields, as detailed below.
 
 
 The comparison operators EQ and REF_EQ act on the following fields:
 
 
 name
 @sphere
 parent
 @componentParent
 @instanceParent
 @status
 @scheduledStartTime
 @scheduledEndTime
 @actualStartTime
 @actualEndTime
 
 
 The comparison operators GE, LE, and BETWEEN act on the following fields:
 
 
 @scheduledStartTime
 @scheduledEndTime
 @actualStartTime
 @actualEndTime
 
 
 Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields,
 you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline.
 User-defined fields that you add to a pipeline should prefix their name with the string "my".
 


values
SdkInternalList<T> values

 The value that the actual field value will be compared with.
 








Class com.amazonaws.services.datapipeline.model.ParameterAttribute extends Object implements Serializable


Serialized Fields


key
String key

 The field identifier.
 


stringValue
String stringValue

 The field value, expressed as a String.
 








Class com.amazonaws.services.datapipeline.model.ParameterObject extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the parameter object.
 


attributes
SdkInternalList<T> attributes

 The attributes of the parameter object.
 








Class com.amazonaws.services.datapipeline.model.ParameterValue extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the parameter value.
 


stringValue
String stringValue

 The field value, expressed as a String.
 








Class com.amazonaws.services.datapipeline.model.PipelineDeletedException extends DataPipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.datapipeline.model.PipelineDescription extends Object implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form
 df-297EG78HU43EEXAMPLE.
 


name
String name

 The name of the pipeline.
 


fields
SdkInternalList<T> fields

 A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.
 


description
String description

 Description of the pipeline.
 


tags
SdkInternalList<T> tags

 A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see
 Controlling User
 Access to Pipelines in the AWS Data Pipeline Developer Guide.
 








Class com.amazonaws.services.datapipeline.model.PipelineIdName extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form
 df-297EG78HU43EEXAMPLE.
 


name
String name

 The name of the pipeline.
 








Class com.amazonaws.services.datapipeline.model.PipelineNotFoundException extends DataPipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.datapipeline.model.PipelineObject extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the object.
 


name
String name

 The name of the object.
 


fields
SdkInternalList<T> fields

 Key-value pairs that define the properties of the object.
 








Class com.amazonaws.services.datapipeline.model.PollForTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


workerGroup
String workerGroup

 The type of task the task runner is configured to accept and process. The worker group is set as a field on
 objects in the pipeline when they are created. You can only specify a single value for workerGroup
 in the call to PollForTask. There are no wildcard values permitted in workerGroup; the
 string must be an exact, case-sensitive, match.
 


hostname
String hostname

 The public DNS name of the calling task runner.
 


instanceIdentity
InstanceIdentity instanceIdentity

 Identity information for the EC2 instance that is hosting the task runner. You can get this value from the
 instance using http://169.254.169.254/latest/meta-data/instance-id. For more information, see Instance Metadata
 in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is
 running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your
 pipeline.
 








Class com.amazonaws.services.datapipeline.model.PollForTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskObject
TaskObject taskObject

 The information needed to complete the task that is being assigned to the task runner. One of the fields returned
 in this object is taskId, which contains an identifier for the task being assigned. The calling task
 runner uses taskId in subsequent calls to ReportTaskProgress and SetTaskStatus.
 








Class com.amazonaws.services.datapipeline.model.PutPipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline.
 


pipelineObjects
SdkInternalList<T> pipelineObjects

 The objects that define the pipeline. These objects overwrite the existing pipeline definition.
 


parameterObjects
SdkInternalList<T> parameterObjects

 The parameter objects used with the pipeline.
 


parameterValues
SdkInternalList<T> parameterValues

 The parameter values used with the pipeline.
 








Class com.amazonaws.services.datapipeline.model.PutPipelineDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


validationErrors
SdkInternalList<T> validationErrors

 The validation errors that are associated with the objects defined in pipelineObjects.
 


validationWarnings
SdkInternalList<T> validationWarnings

 The validation warnings that are associated with the objects defined in pipelineObjects.
 


errored
Boolean errored

 Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated
 until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.
 








Class com.amazonaws.services.datapipeline.model.Query extends Object implements Serializable


Serialized Fields


selectors
SdkInternalList<T> selectors

 List of selectors that define the query. An object must satisfy all of the selectors to match the query.
 








Class com.amazonaws.services.datapipeline.model.QueryObjectsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline.
 


query
Query query

 The query that defines the objects to be returned. The Query object can contain a maximum of ten
 selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be
 applied to components, instances, and attempts.
 


sphere
String sphere

 Indicates whether the query applies to components or instances. The possible values are: COMPONENT,
 INSTANCE, and ATTEMPT.
 


marker
String marker

 The starting point for the results to be returned. For the first call, this value should be empty. As long as
 there are more results, continue to call QueryObjects with the marker value from the previous call
 to retrieve the next set of results.
 


limit
Integer limit

 The maximum number of object names that QueryObjects will return in a single call. The default value
 is 100.
 








Class com.amazonaws.services.datapipeline.model.QueryObjectsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ids
SdkInternalList<T> ids

 The identifiers that match the query selectors.
 


marker
String marker

 The starting point for the next page of results. To view the next page of results, call QueryObjects
 again with this marker value. If the value is null, there are no more results.
 


hasMoreResults
Boolean hasMoreResults

 Indicates whether there are more results that can be obtained by a subsequent call.
 








Class com.amazonaws.services.datapipeline.model.RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline.
 


tagKeys
SdkInternalList<T> tagKeys

 The keys of the tags to remove.
 








Class com.amazonaws.services.datapipeline.model.RemoveTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datapipeline.model.ReportTaskProgressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
 


fields
SdkInternalList<T> fields

 Key-value pairs that define the properties of the ReportTaskProgressInput object.
 








Class com.amazonaws.services.datapipeline.model.ReportTaskProgressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


canceled
Boolean canceled

 If true, the calling task runner should cancel processing of the task. The task runner does not need to call
 SetTaskStatus for canceled tasks.
 








Class com.amazonaws.services.datapipeline.model.ReportTaskRunnerHeartbeatRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskrunnerId
String taskrunnerId

 The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline
 Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier
 when it launches the application. If you have written a custom task runner, you should assign a unique identifier
 for the task runner.
 


workerGroup
String workerGroup

 The type of task the task runner is configured to accept and process. The worker group is set as a field on
 objects in the pipeline when they are created. You can only specify a single value for workerGroup.
 There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive,
 match.
 


hostname
String hostname

 The public DNS name of the task runner.
 








Class com.amazonaws.services.datapipeline.model.ReportTaskRunnerHeartbeatResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


terminate
Boolean terminate

 Indicates whether the calling task runner should terminate.
 








Class com.amazonaws.services.datapipeline.model.Selector extends Object implements Serializable


Serialized Fields


fieldName
String fieldName

 The name of the field that the operator will be applied to. The field name is the "key" portion of the field
 definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set
 on the object, the condition fails.
 


operator
Operator operator








Class com.amazonaws.services.datapipeline.model.SetStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline that contains the objects.
 


objectIds
SdkInternalList<T> objectIds

 The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both
 types.
 


status
String status

 The status to be set on all the objects specified in objectIds. For components, use
 PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or
 MARK_FINISHED.
 








Class com.amazonaws.services.datapipeline.model.SetStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datapipeline.model.SetTaskStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
 


taskStatus
String taskStatus

 If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully.
 Preconditions use false.
 


errorId
String errorId

 If an error occurred during the task, this value specifies the error code. This value is set on the physical
 attempt object. It is used to display error information to the user. It should not start with string "Service_"
 which is reserved by the system.
 


errorMessage
String errorMessage

 If an error occurred during the task, this value specifies a text description of the error. This value is set on
 the physical attempt object. It is used to display error information to the user. The web service does not parse
 this value.
 


errorStackTrace
String errorStackTrace

 If an error occurred during the task, this value specifies the stack trace associated with the error. This value
 is set on the physical attempt object. It is used to display error information to the user. The web service does
 not parse this value.
 








Class com.amazonaws.services.datapipeline.model.SetTaskStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datapipeline.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key name of a tag defined by a user. For more information, see Controlling User
 Access to Pipelines in the AWS Data Pipeline Developer Guide.
 


value
String value

 The optional value portion of a tag defined by a user. For more information, see Controlling User
 Access to Pipelines in the AWS Data Pipeline Developer Guide.
 








Class com.amazonaws.services.datapipeline.model.TaskNotFoundException extends DataPipelineException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.datapipeline.model.TaskObject extends Object implements Serializable


Serialized Fields


taskId
String taskId

 An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress
 actions.
 


pipelineId
String pipelineId

 The ID of the pipeline that provided the task.
 


attemptId
String attemptId

 The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is
 attempted.
 


objects
Map<K,V> objects

 Connection information for the location where the task runner will publish the output of the task.
 








Class com.amazonaws.services.datapipeline.model.ValidatePipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline.
 


pipelineObjects
SdkInternalList<T> pipelineObjects

 The objects that define the pipeline changes to validate against the pipeline.
 


parameterObjects
SdkInternalList<T> parameterObjects

 The parameter objects used with the pipeline.
 


parameterValues
SdkInternalList<T> parameterValues

 The parameter values used with the pipeline.
 








Class com.amazonaws.services.datapipeline.model.ValidatePipelineDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


validationErrors
SdkInternalList<T> validationErrors

 Any validation errors that were found.
 


validationWarnings
SdkInternalList<T> validationWarnings

 Any validation warnings that were found.
 


errored
Boolean errored

 Indicates whether there were validation errors.
 








Class com.amazonaws.services.datapipeline.model.ValidationError extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the object that contains the validation error.
 


errors
SdkInternalList<T> errors

 A description of the validation error.
 








Class com.amazonaws.services.datapipeline.model.ValidationWarning extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the object that contains the validation warning.
 


warnings
SdkInternalList<T> warnings

 A description of the validation warning.
 








Package com.amazonaws.services.datasync.model




Class com.amazonaws.services.datasync.model.AgentListEntry extends Object implements Serializable


Serialized Fields


agentArn
String agentArn

 The Amazon Resource Name (ARN) of the agent.
 


name
String name

 The name of the agent.
 


status
String status

 The status of the agent.
 








Class com.amazonaws.services.datasync.model.AWSDataSyncException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.datasync.model.CancelTaskExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskExecutionArn
String taskExecutionArn

 The Amazon Resource Name (ARN) of the task execution to cancel.
 








Class com.amazonaws.services.datasync.model.CancelTaskExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datasync.model.CreateAgentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


activationKey
String activationKey

 Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects
 that enable you to get the agent IP address (port 80). Alternatively, you can get it from the AWS DataSync
 console.
 
 
 The redirect URL returned in the response provides you the activation key for your agent in the query string
 parameter activationKey. It might also include other activation-related parameters; however, these
 are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.
 
 
 For more information, see Activating an Agent in the AWS DataSync User Guide.
 


agentName
String agentName

 The name you configured for your agent. This value is a text reference that is used to identify the agent in the
 console.
 


tags
List<E> tags

 The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty
 string. This value helps you manage, filter, and search for your agents.
 
 
 
 Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the
 following special characters: + - = . _ : / @.
 
 


vpcEndpointId
String vpcEndpointId

 The ID of the VPC (Virtual Private Cloud) endpoint that the agent has access to. This is the client-side VPC
 endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a
 VPC Endpoint Service Configuration in the AWS VPC User Guide.
 
 
 VPC endpoint ID looks like this: vpce-01234d5aff67890e1.
 


subnetArns
List<E> subnetArns

 The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each
 data transfer task. The agent that runs a task must be private. When you start a task that is associated with an
 agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this
 case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the
 agent must be able to route to all these four network interfaces.
 


securityGroupArns
List<E> securityGroupArns

 The ARNs of the security groups used to protect your data transfer task subnets. See
 CreateAgentRequest$SubnetArns.
 








Class com.amazonaws.services.datasync.model.CreateAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


agentArn
String agentArn

 The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation to return a list of agents
 for your account and AWS Region.
 








Class com.amazonaws.services.datasync.model.CreateLocationEfsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subdirectory
String subdirectory

 A subdirectory in the location’s path. This subdirectory in the EFS file system is used to read data from the EFS
 source location or write data to the EFS destination. By default, AWS DataSync uses the root directory.
 
 
 
 Subdirectory must be specified with forward slashes. For example /path/to/folder.
 
 


efsFilesystemArn
String efsFilesystemArn

 The Amazon Resource Name (ARN) for the Amazon EFS file system.
 


ec2Config
Ec2Config ec2Config

 The subnet and security group that the Amazon EFS file system uses. The security group that you provide needs to
 be able to communicate with the security group on the mount target in the subnet specified.
 
 
 The exact relationship between security group M (of the mount target) and security group S (which you provide for
 DataSync to use at this stage) is as follows:
 
 
 
 
 Security group M (which you associate with the mount target) must allow inbound access for the Transmission
 Control Protocol (TCP) on the NFS port (2049) from security group S. You can enable inbound connections either by
 IP address (CIDR range) or security group.
 
 
 
 
 Security group S (provided to DataSync to access EFS) should have a rule that enables outbound connections to the
 NFS port on one of the file system’s mount targets. You can enable outbound connections either by IP address
 (CIDR range) or security group.
 
 
 For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount
 Targets in the Amazon EFS User Guide.
 
 
 


tags
List<E> tags

 The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string.
 This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for
 your location.
 








Class com.amazonaws.services.datasync.model.CreateLocationEfsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.
 








Class com.amazonaws.services.datasync.model.CreateLocationFsxWindowsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subdirectory
String subdirectory

 A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows file system is used to
 read data from the Amazon FSx for Windows source location or write data to the FSx for Windows destination.
 


fsxFilesystemArn
String fsxFilesystemArn

 The Amazon Resource Name (ARN) for the FSx for Windows file system.
 


securityGroupArns
List<E> securityGroupArns

 The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file
 system.
 


tags
List<E> tags

 The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string.
 This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for
 your location.
 


user
String user

 The user who has the permissions to access files and folders in the FSx for Windows file system.
 


domain
String domain

 The name of the Windows domain that the FSx for Windows server belongs to.
 


password
String password

 The password of the user who has the permissions to access files and folders in the FSx for Windows file system.
 








Class com.amazonaws.services.datasync.model.CreateLocationFsxWindowsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon Resource Name (ARN) of the FSx for Windows file system location that is created.
 








Class com.amazonaws.services.datasync.model.CreateLocationNfsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subdirectory
String subdirectory

 The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to
 the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that
 path. The path should be such that it can be mounted by other NFS clients in your network.
 
 
 To see all the paths exported by your NFS server. run "showmount -e nfs-server-name" from an NFS
 client that has access to your server. You can specify any directory that appears in the results, and any
 subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.
 
 
 To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To
 ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for
 all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read
 the files. For the agent to access directories, you must additionally enable all execute access.
 
 
 For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat
 Enterprise Linux documentation.
 


serverHostname
String serverHostname

 The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An
 agent that is installed on-premises uses this host name to mount the NFS server in a network.
 
 
 
 This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
 
 


onPremConfig
OnPremConfig onPremConfig

 Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.
 


mountOptions
NfsMountOptions mountOptions

 The NFS mount options that DataSync can use to mount your NFS share.
 


tags
List<E> tags

 The key-value pair that represents the tag that you want to add to the location. The value can be an empty
 string. We recommend using tags to name your resources.
 








Class com.amazonaws.services.datasync.model.CreateLocationNfsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon Resource Name (ARN) of the source NFS file system location that is created.
 








Class com.amazonaws.services.datasync.model.CreateLocationS3Request extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subdirectory
String subdirectory

 A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source
 location or write data to the S3 destination.
 


s3BucketArn
String s3BucketArn

 The Amazon Resource Name (ARN) of the Amazon S3 bucket.
 


s3StorageClass
String s3StorageClass

 The Amazon S3 storage class that you want to store your files in when this location is used as a task
 destination. For more information about S3 storage classes, see Amazon S3 Storage Classes in the Amazon Simple Storage
 Service Developer Guide. Some storage classes have behaviors that can affect your S3 storage cost. For
 detailed information, see using-storage-classes.
 


s3Config
S3Config s3Config


tags
List<E> tags

 The key-value pair that represents the tag that you want to add to the location. The value can be an empty
 string. We recommend using tags to name your resources.
 








Class com.amazonaws.services.datasync.model.CreateLocationS3Result extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.
 








Class com.amazonaws.services.datasync.model.CreateLocationSmbRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subdirectory
String subdirectory

 The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to
 the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that
 path. The path should be such that it can be mounted by other SMB clients in your network.
 
 
 
 Subdirectory must be specified with forward slashes. For example /path/to/folder.
 
 
 
 To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share,
 as well as to access all the data in that share. To ensure this, either ensure that the user/password specified
 belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and
 directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to
 mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must
 additionally enable all execute access.
 


serverHostname
String serverHostname

 The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An
 agent that is installed on-premises uses this hostname to mount the SMB server in a network.
 
 
 
 This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
 
 


user
String user

 The user who can mount the share, has the permissions to access files and folders in the SMB share.
 


domain
String domain

 The name of the Windows domain that the SMB server belongs to.
 


password
String password

 The password of the user who can mount the share, has the permissions to access files and folders in the SMB
 share.
 


agentArns
List<E> agentArns

 The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.
 


mountOptions
SmbMountOptions mountOptions

 The mount options used by DataSync to access the SMB server.
 


tags
List<E> tags

 The key-value pair that represents the tag that you want to add to the location. The value can be an empty
 string. We recommend using tags to name your resources.
 








Class com.amazonaws.services.datasync.model.CreateLocationSmbResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon Resource Name (ARN) of the source SMB file system location that is created.
 








Class com.amazonaws.services.datasync.model.CreateTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceLocationArn
String sourceLocationArn

 The Amazon Resource Name (ARN) of the source location for the task.
 


destinationLocationArn
String destinationLocationArn

 The Amazon Resource Name (ARN) of an AWS storage resource's location.
 


cloudWatchLogGroupArn
String cloudWatchLogGroupArn

 The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the
 task.
 
 
 For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch
 User Guide.
 
 
 For more information about how to use CloudWatch Logs with DataSync, see Monitoring Your Task in the AWS
 DataSync User Guide.
 


name
String name

 The name of a task. This value is a text reference that is used to identify the task in the console.
 


options
Options options

 The set of configuration options that control the behavior of a single execution of the task that occurs when you
 call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID)
 and group ID (GID), file permissions, data integrity verification, and so on.
 
 
 For each individual task execution, you can override these options by specifying the OverrideOptions
 before starting a the task execution. For more information, see the operation.
 


excludes
List<E> excludes

 A list of filter rules that determines which files to exclude from a task. The list should contain a single
 filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
 example, "/folder1|/folder2"
 
 
 


schedule
TaskSchedule schedule

 Specifies a schedule used to periodically transfer files from a source to a destination location. The schedule
 should be specified in UTC time. For more information, see task-scheduling.
 


tags
List<E> tags

 The key-value pair that represents the tag that you want to add to the resource. The value can be an empty
 string.
 








Class com.amazonaws.services.datasync.model.CreateTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskArn
String taskArn

 The Amazon Resource Name (ARN) of the task.
 








Class com.amazonaws.services.datasync.model.DeleteAgentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


agentArn
String agentArn

 The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list
 of agents for your account and AWS Region.
 








Class com.amazonaws.services.datasync.model.DeleteAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datasync.model.DeleteLocationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon Resource Name (ARN) of the location to delete.
 








Class com.amazonaws.services.datasync.model.DeleteLocationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datasync.model.DeleteTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskArn
String taskArn

 The Amazon Resource Name (ARN) of the task to delete.
 








Class com.amazonaws.services.datasync.model.DeleteTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datasync.model.DescribeAgentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


agentArn
String agentArn

 The Amazon Resource Name (ARN) of the agent to describe.
 








Class com.amazonaws.services.datasync.model.DescribeAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


agentArn
String agentArn

 The Amazon Resource Name (ARN) of the agent.
 


name
String name

 The name of the agent.
 


status
String status

 The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use.
 The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned
 off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent
 returns to ONLINE status.
 


lastConnectionTime
Date lastConnectionTime

 The time that the agent last connected to DataSyc.
 


creationTime
Date creationTime

 The time that the agent was activated (that is, created in your account).
 


endpointType
String endpointType

 The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not
 accessible over the public Internet.
 


privateLinkConfig
PrivateLinkConfig privateLinkConfig

 The subnet and the security group that DataSync used to access a VPC endpoint.
 








Class com.amazonaws.services.datasync.model.DescribeLocationEfsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon Resource Name (ARN) of the EFS location to describe.
 








Class com.amazonaws.services.datasync.model.DescribeLocationEfsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon resource Name (ARN) of the EFS location that was described.
 


locationUri
String locationUri

 The URL of the EFS location that was described.
 


ec2Config
Ec2Config ec2Config


creationTime
Date creationTime

 The time that the EFS location was created.
 








Class com.amazonaws.services.datasync.model.DescribeLocationFsxWindowsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon Resource Name (ARN) of the FSx for Windows location to describe.
 








Class com.amazonaws.services.datasync.model.DescribeLocationFsxWindowsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon resource Name (ARN) of the FSx for Windows location that was described.
 


locationUri
String locationUri

 The URL of the FSx for Windows location that was described.
 


securityGroupArns
List<E> securityGroupArns

 The Amazon Resource Names (ARNs) of the security groups that are configured for the for the FSx for Windows file
 system.
 


creationTime
Date creationTime

 The time that the FSx for Windows location was created.
 


user
String user

 The user who has the permissions to access files and folders in the FSx for Windows file system.
 


domain
String domain

 The name of the Windows domain that the FSx for Windows server belongs to.
 








Class com.amazonaws.services.datasync.model.DescribeLocationNfsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon resource Name (ARN) of the NFS location to describe.
 








Class com.amazonaws.services.datasync.model.DescribeLocationNfsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon resource Name (ARN) of the NFS location that was described.
 


locationUri
String locationUri

 The URL of the source NFS location that was described.
 


onPremConfig
OnPremConfig onPremConfig


mountOptions
NfsMountOptions mountOptions

 The NFS mount options that DataSync used to mount your NFS share.
 


creationTime
Date creationTime

 The time that the NFS location was created.
 








Class com.amazonaws.services.datasync.model.DescribeLocationS3Request extends AmazonWebServiceRequest implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.
 








Class com.amazonaws.services.datasync.model.DescribeLocationS3Result extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
 


locationUri
String locationUri

 The URL of the Amazon S3 location that was described.
 


s3StorageClass
String s3StorageClass

 The Amazon S3 storage class that you chose to store your files in when this location is used as a task
 destination. For more information about S3 storage classes, see Amazon S3 Storage Classes in the Amazon Simple Storage
 Service Developer Guide. Some storage classes have behaviors that can affect your S3 storage cost. For
 detailed information, see using-storage-classes.
 


s3Config
S3Config s3Config


creationTime
Date creationTime

 The time that the Amazon S3 bucket location was created.
 








Class com.amazonaws.services.datasync.model.DescribeLocationSmbRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon resource Name (ARN) of the SMB location to describe.
 








Class com.amazonaws.services.datasync.model.DescribeLocationSmbResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon resource Name (ARN) of the SMB location that was described.
 


locationUri
String locationUri

 The URL of the source SBM location that was described.
 


agentArns
List<E> agentArns

 The Amazon Resource Name (ARN) of the source SMB file system location that is created.
 


user
String user

 The user who can mount the share, has the permissions to access files and folders in the SMB share.
 


domain
String domain

 The name of the Windows domain that the SMB server belongs to.
 


mountOptions
SmbMountOptions mountOptions

 The mount options that are available for DataSync to use to access an SMB location.
 


creationTime
Date creationTime

 The time that the SMB location was created.
 








Class com.amazonaws.services.datasync.model.DescribeTaskExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskExecutionArn
String taskExecutionArn

 The Amazon Resource Name (ARN) of the task that is being executed.
 








Class com.amazonaws.services.datasync.model.DescribeTaskExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskExecutionArn
String taskExecutionArn

 The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn is
 hierarchical and includes TaskArn for the task that was executed.
 
 
 For example, a TaskExecution value with the ARN
 arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
 executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.
 


status
String status

 The status of the task execution.
 
 
 For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync
 User Guide.
 


options
Options options


excludes
List<E> excludes

 A list of filter rules that determines which files to exclude from a task. The list should contain a single
 filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
 example: "/folder1|/folder2"
 
 
 


includes
List<E> includes

 A list of filter rules that determines which files to include when running a task. The list should contain a
 single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a
 pipe), for example: "/folder1|/folder2"
 
 
 


startTime
Date startTime

 The time that the task execution was started.
 


estimatedFilesToTransfer
Long estimatedFilesToTransfer

 The expected number of files that is to be transferred over the network. This value is calculated during the
 PREPARING phase, before the TRANSFERRING phase. This value is the expected number of files to be transferred.
 It's calculated based on comparing the content of the source and destination locations and finding the delta that
 needs to be transferred.
 


estimatedBytesToTransfer
Long estimatedBytesToTransfer

 The estimated physical number of bytes that is to be transferred over the network.
 


filesTransferred
Long filesTransferred

 The actual number of files that was transferred over the network. This value is calculated and updated on an
 ongoing basis during the TRANSFERRING phase. It's updated periodically when each file is read from the source and
 sent over the network.
 
 
 If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer. This
 value can also be greater than EstimatedFilesTransferred in some cases. This element is
 implementation-specific for some location types, so don't use it as an indicator for a correct file number or to
 monitor your task execution.
 


bytesWritten
Long bytesWritten

 The number of logical bytes written to the destination AWS storage resource.
 


bytesTransferred
Long bytesTransferred

 The physical number of bytes transferred over the network.
 


result
TaskExecutionResultDetail result

 The result of the task execution.
 








Class com.amazonaws.services.datasync.model.DescribeTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskArn
String taskArn

 The Amazon Resource Name (ARN) of the task to describe.
 








Class com.amazonaws.services.datasync.model.DescribeTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskArn
String taskArn

 The Amazon Resource Name (ARN) of the task that was described.
 


status
String status

 The status of the task that was described.
 
 
 For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync
 User Guide.
 


name
String name

 The name of the task that was described.
 


currentTaskExecutionArn
String currentTaskExecutionArn

 The Amazon Resource Name (ARN) of the task execution that is syncing files.
 


sourceLocationArn
String sourceLocationArn

 The Amazon Resource Name (ARN) of the source file system's location.
 


destinationLocationArn
String destinationLocationArn

 The Amazon Resource Name (ARN) of the AWS storage resource's location.
 


cloudWatchLogGroupArn
String cloudWatchLogGroupArn

 The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the
 task.
 
 
 For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch
 User Guide.
 


sourceNetworkInterfaceArns
List<E> sourceNetworkInterfaceArns

 The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was created for your subnet.
 


destinationNetworkInterfaceArns
List<E> destinationNetworkInterfaceArns

 The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that was created for your
 subnet.
 


options
Options options

 The set of configuration options that control the behavior of a single execution of the task that occurs when you
 call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID)
 and group (GID), file permissions, data integrity verification, and so on.
 
 
 For each individual task execution, you can override these options by specifying the overriding
 OverrideOptions value to operation.
 


excludes
List<E> excludes

 A list of filter rules that determines which files to exclude from a task. The list should contain a single
 filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
 example: "/folder1|/folder2"
 
 
 


schedule
TaskSchedule schedule

 The schedule used to periodically transfer files from a source to a destination location.
 


errorCode
String errorCode

 Errors that AWS DataSync encountered during execution of the task. You can use this error code to help
 troubleshoot issues.
 


errorDetail
String errorDetail

 Detailed description of an error that was encountered during the task execution. You can use this information to
 help troubleshoot issues.
 


creationTime
Date creationTime

 The time that the task was created.
 








Class com.amazonaws.services.datasync.model.Ec2Config extends Object implements Serializable


Serialized Fields


subnetArn
String subnetArn

 The ARN of the subnet and the security group that DataSync uses to access the target EFS file system.
 


securityGroupArns
List<E> securityGroupArns

 The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.
 








Class com.amazonaws.services.datasync.model.FilterRule extends Object implements Serializable


Serialized Fields


filterType
String filterType

 The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.
 


value
String value

 A single filter string that consists of the patterns to include or exclude. The patterns are delimited by "|"
 (that is, a pipe), for example: /folder1|/folder2
 
 
 








Class com.amazonaws.services.datasync.model.InternalException extends AWSDataSyncException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.datasync.model.InvalidRequestException extends AWSDataSyncException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.datasync.model.ListAgentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of agents to list.
 


nextToken
String nextToken

 An opaque string that indicates the position at which to begin the next list of agents.
 








Class com.amazonaws.services.datasync.model.ListAgentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


agents
List<E> agents

 A list of agents in your account.
 


nextToken
String nextToken

 An opaque string that indicates the position at which to begin returning the next list of agents.
 








Class com.amazonaws.services.datasync.model.ListLocationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of locations to return.
 


nextToken
String nextToken

 An opaque string that indicates the position at which to begin the next list of locations.
 








Class com.amazonaws.services.datasync.model.ListLocationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


locations
List<E> locations

 An array that contains a list of locations.
 


nextToken
String nextToken

 An opaque string that indicates the position at which to begin returning the next list of locations.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource whose tags to list.
 


maxResults
Integer maxResults

 The maximum number of locations to return.
 


nextToken
String nextToken

 An opaque string that indicates the position at which to begin the next list of locations.
 








Class com.amazonaws.services.datasync.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 Array of resource tags.
 


nextToken
String nextToken

 An opaque string that indicates the position at which to begin returning the next list of resource tags.
 








Class com.amazonaws.services.datasync.model.ListTaskExecutionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskArn
String taskArn

 The Amazon Resource Name (ARN) of the task whose tasks you want to list.
 


maxResults
Integer maxResults

 The maximum number of executed tasks to list.
 


nextToken
String nextToken

 An opaque string that indicates the position at which to begin the next list of the executed tasks.
 








Class com.amazonaws.services.datasync.model.ListTaskExecutionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskExecutions
List<E> taskExecutions

 A list of executed tasks.
 


nextToken
String nextToken

 An opaque string that indicates the position at which to begin returning the next list of executed tasks.
 








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


Serialized Fields


maxResults
Integer maxResults

 The maximum number of tasks to return.
 


nextToken
String nextToken

 An opaque string that indicates the position at which to begin the next list of tasks.
 








Class com.amazonaws.services.datasync.model.ListTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tasks
List<E> tasks

 A list of all the tasks that are returned.
 


nextToken
String nextToken

 An opaque string that indicates the position at which to begin returning the next list of tasks.
 








Class com.amazonaws.services.datasync.model.LocationListEntry extends Object implements Serializable


Serialized Fields


locationArn
String locationArn

 The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the
 export path. For Amazon S3, the location is the prefix path that you want to mount and use as the root of the
 location.
 


locationUri
String locationUri

 Represents a list of URLs of a location. LocationUri returns an array that contains a list of
 locations when the ListLocations operation is called.
 
 
 Format: TYPE://GLOBAL_ID/SUBDIR.
 
 
 TYPE designates the type of location. Valid values: NFS | EFS | S3.
 
 
 GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is
 us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket name, such as myBucket.
 An example for NFS is a valid IPv4 address or a host name compliant with Domain Name Service (DNS).
 
 
 SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon
 EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat
 as the root of the location.
 
 








Class com.amazonaws.services.datasync.model.NfsMountOptions extends Object implements Serializable


Serialized Fields


version
String version

 The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the
 version specified, the sync will fail. If you don't specify a version, DataSync defaults to
 AUTOMATIC. That is, DataSync automatically selects a version based on negotiation with the NFS
 server.
 
 
 You can specify the following NFS versions:
 
 
 
 
  NFSv3  - stateless protocol version that allows for
 asynchronous writes on the server.
 
 
 
 
  NFSv4.0  - stateful, firewall-friendly protocol version
 that supports delegations and pseudo filesystems.
 
 
 
 
  NFSv4.1  - stateful protocol version that supports
 sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available
 in version 4.0.
 
 
 








Class com.amazonaws.services.datasync.model.OnPremConfig extends Object implements Serializable


Serialized Fields


agentArns
List<E> agentArns

 ARNs)of the agents to use for an NFS location.
 








Class com.amazonaws.services.datasync.model.Options extends Object implements Serializable


Serialized Fields


verifyMode
String verifyMode

 A value that determines whether a data integrity verification should be performed at the end of a task execution
 after all data and metadata have been transferred.
 
 
 Default value: POINT_IN_TIME_CONSISTENT.
 
 
 POINT_IN_TIME_CONSISTENT: Perform verification (recommended).
 
 
 ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.
 
 
 NONE: Skip verification.
 


overwriteMode
String overwriteMode

 A value that determines whether files at the destination should be overwritten or preserved when copying files.
 If set to NEVER a destination file will not be replaced by a source file, even if the destination
 file differs from the source file. If you modify files in the destination and you sync the files, you can use
 this value to protect against overwriting those changes.
 
 
 Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see
 using-storage-classes in the AWS DataSync User Guide.
 


atime
String atime

 A file metadata value that shows the last time a file was accessed (that is, when the file was read or written
 to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime
 attribute on all source files (that is, the version before the PREPARING phase). However, Atime's
 behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.
 
 
 Default value: BEST_EFFORT.
 
 
 BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
 
 
 NONE: Ignore Atime.
 
 
 
 If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.
 
 
 If Atime is set to NONE, Mtime must also be NONE.
 
 


mtime
String mtime

 A value that indicates the last time that a file was modified (that is, a file was written to) before the
 PREPARING phase.
 
 
 Default value: PRESERVE.
 
 
 PRESERVE: Preserve original Mtime (recommended)
 
 
 NONE: Ignore Mtime.
 
 
 
 If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
 
 
 If Mtime is set to NONE, Atime must also be set to NONE.
 
 


uid
String uid

 The user ID (UID) of the file's owner.
 
 
 Default value: INT_VALUE. This preserves the integer value of the ID.
 
 
 INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
 
 
 NONE: Ignore UID and GID.
 


gid
String gid

 The group ID (GID) of the file's owners.
 
 
 Default value: INT_VALUE. This preserves the integer value of the ID.
 
 
 INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
 
 
 NONE: Ignore UID and GID.
 


preserveDeletedFiles
String preserveDeletedFiles

 A value that specifies whether files in the destination that don't exist in the source file system should be
 preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum
 storage duration charges for certain storage classes. For detailed information, see using-storage-classes
 in the AWS DataSync User Guide.
 
 
 Default value: PRESERVE.
 
 
 PRESERVE: Ignore such destination files (recommended).
 
 
 REMOVE: Delete destination files that aren’t present in the source.
 


preserveDevices
String preserveDevices

 A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the
 source file system, and recreate the files with that device name and metadata on the destination.
 
 
 
 AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an
 end-of-file (EOF) marker.
 
 
 
 Default value: NONE.
 
 
 NONE: Ignore special devices (recommended).
 
 
 PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.
 


posixPermissions
String posixPermissions

 A value that determines which users or groups can access a file for a specific purpose such as reading, writing,
 or execution of the file.
 
 
 Default value: PRESERVE.
 
 
 PRESERVE: Preserve POSIX-style permissions (recommended).
 
 
 NONE: Ignore permissions.
 
 
 
 AWS DataSync can preserve extant permissions of a source location.
 
 


bytesPerSecond
Long bytesPerSecond

 A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of
 1 MB, set this value to 1048576 (=1024*1024).
 


taskQueueing
String taskQueueing

 A value that determines whether tasks should be queued before executing the tasks. If set to ENABLED
 , the tasks will be queued. The default is ENABLED.
 
 
 If you use the same agent to run multiple tasks you can enable the tasks to run in series. For more information
 see queue-task-execution.
 


logLevel
String logLevel

 A value that determines the type of logs DataSync will deliver to your AWS CloudWatch Logs file. If set to
 OFF, no logs will be delivered. BASIC will deliver a few logs per transfer operation
 and TRANSFER will deliver a verbose log that contains logs for every file that is transferred.
 








Class com.amazonaws.services.datasync.model.PrivateLinkConfig extends Object implements Serializable


Serialized Fields


vpcEndpointId
String vpcEndpointId

 The ID of the VPC endpoint that is configured for an agent. An agent that is configured with a VPC endpoint will
 not be accessible over the public Internet.
 


privateLinkEndpoint
String privateLinkEndpoint

 The private endpoint that is configured for an agent that has access to IP addresses in a PrivateLink. An agent that is
 configured with this endpoint will not be accessible over the public Internet.
 


subnetArns
List<E> subnetArns

 The Amazon Resource Names (ARNs) of the subnets that are configured for an agent activated in a VPC or an agent
 that has access to a VPC endpoint.
 


securityGroupArns
List<E> securityGroupArns

 The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2 resource that hosts an
 agent activated in a VPC or an agent that has access to a VPC endpoint.
 








Class com.amazonaws.services.datasync.model.S3Config extends Object implements Serializable


Serialized Fields


bucketAccessRoleArn
String bucketAccessRoleArn

 The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation.
 








Class com.amazonaws.services.datasync.model.SmbMountOptions extends Object implements Serializable


Serialized Fields


version
String version

 The specific SMB version that you want DataSync to use to mount your SMB share. If you don't specify a version,
 DataSync defaults to AUTOMATIC. That is, DataSync automatically selects a version based on
 negotiation with the SMB server.
 








Class com.amazonaws.services.datasync.model.StartTaskExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskArn
String taskArn

 The Amazon Resource Name (ARN) of the task to start.
 


overrideOptions
Options overrideOptions


includes
List<E> includes

 A list of filter rules that determines which files to include when running a task. The pattern should contain a
 single filter string that consists of the patterns to include. The patterns are delimited by "|" (that is, a
 pipe). For example: "/folder1|/folder2"
 
 
 








Class com.amazonaws.services.datasync.model.StartTaskExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskExecutionArn
String taskExecutionArn

 The Amazon Resource Name (ARN) of the specific task execution that was started.
 








Class com.amazonaws.services.datasync.model.TagListEntry extends Object implements Serializable


Serialized Fields


key
String key

 The key for an AWS resource tag.
 


value
String value

 The value for an AWS resource tag.
 








Class com.amazonaws.services.datasync.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource to apply the tag to.
 


tags
List<E> tags

 The tags to apply.
 








Class com.amazonaws.services.datasync.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datasync.model.TaskExecutionListEntry extends Object implements Serializable


Serialized Fields


taskExecutionArn
String taskExecutionArn

 The Amazon Resource Name (ARN) of the task that was executed.
 


status
String status

 The status of a task execution.
 








Class com.amazonaws.services.datasync.model.TaskExecutionResultDetail extends Object implements Serializable


Serialized Fields


prepareDuration
Long prepareDuration

 The total time in milliseconds that AWS DataSync spent in the PREPARING phase.
 


prepareStatus
String prepareStatus

 The status of the PREPARING phase.
 


totalDuration
Long totalDuration

 The total time in milliseconds that AWS DataSync took to transfer the file from the source to the destination
 location.
 


transferDuration
Long transferDuration

 The total time in milliseconds that AWS DataSync spent in the TRANSFERRING phase.
 


transferStatus
String transferStatus

 The status of the TRANSFERRING Phase.
 


verifyDuration
Long verifyDuration

 The total time in milliseconds that AWS DataSync spent in the VERIFYING phase.
 


verifyStatus
String verifyStatus

 The status of the VERIFYING Phase.
 


errorCode
String errorCode

 Errors that AWS DataSync encountered during execution of the task. You can use this error code to help
 troubleshoot issues.
 


errorDetail
String errorDetail

 Detailed description of an error that was encountered during the task execution. You can use this information to
 help troubleshoot issues.
 








Class com.amazonaws.services.datasync.model.TaskListEntry extends Object implements Serializable


Serialized Fields


taskArn
String taskArn

 The Amazon Resource Name (ARN) of the task.
 


status
String status

 The status of the task.
 


name
String name

 The name of the task.
 








Class com.amazonaws.services.datasync.model.TaskSchedule extends Object implements Serializable


Serialized Fields


scheduleExpression
String scheduleExpression

 A cron expression that specifies when AWS DataSync initiates a scheduled transfer from a source to a destination
 location.
 








Class com.amazonaws.services.datasync.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource to remove the tag from.
 


keys
List<E> keys

 The keys in the key-value pair in the tag to remove.
 








Class com.amazonaws.services.datasync.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datasync.model.UpdateAgentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


agentArn
String agentArn

 The Amazon Resource Name (ARN) of the agent to update.
 


name
String name

 The name that you want to use to configure the agent.
 








Class com.amazonaws.services.datasync.model.UpdateAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.datasync.model.UpdateTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskArn
String taskArn

 The Amazon Resource Name (ARN) of the resource name of the task to update.
 


options
Options options


excludes
List<E> excludes

 A list of filter rules that determines which files to exclude from a task. The list should contain a single
 filter string that consists of the patterns to exclude. The patterns are delimited by "|" (that is, a pipe), for
 example: "/folder1|/folder2"
 
 
 


schedule
TaskSchedule schedule

 Specifies a schedule used to periodically transfer files from a source to a destination location. You can
 configure your task to execute hourly, daily, weekly or on specific days of the week. You control when in the day
 or hour you want the task to execute. The time you specify is UTC time. For more information, see
 task-scheduling.
 


name
String name

 The name of the task to update.
 


cloudWatchLogGroupArn
String cloudWatchLogGroupArn

 The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.
 








Class com.amazonaws.services.datasync.model.UpdateTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.dax.model




Class com.amazonaws.services.dax.model.AmazonDaxException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


clusterName
String clusterName

 The name of the DAX cluster.
 


description
String description

 The description of the cluster.
 


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) that uniquely identifies the cluster.
 


totalNodes
Integer totalNodes

 The total number of nodes in the cluster.
 


activeNodes
Integer activeNodes

 The number of nodes in the cluster that are active (i.e., capable of serving requests).
 


nodeType
String nodeType

 The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)
 


status
String status

 The current status of the cluster.
 


clusterDiscoveryEndpoint
Endpoint clusterDiscoveryEndpoint

 The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications
 can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to
 intelligently route requests and responses to nodes in the DAX cluster.
 


nodeIdsToRemove
List<E> nodeIdsToRemove

 A list of nodes to be removed from the cluster.
 


nodes
List<E> nodes

 A list of nodes that are currently in the cluster.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 A range of time when maintenance of DAX cluster software will be performed. For example:
 sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed
 automatically within the maintenance window.
 


notificationConfiguration
NotificationConfiguration notificationConfiguration

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


subnetGroup
String subnetGroup

 The subnet group where the DAX cluster is running.
 


securityGroups
List<E> securityGroups

 A list of security groups, and the status of each, for the nodes in the cluster.
 


iamRoleArn
String iamRoleArn

 A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the
 role's permissions to access DynamoDB on your behalf.
 


parameterGroup
ParameterGroupStatus parameterGroup

 The parameter group being used by nodes in the cluster.
 


sSEDescription
SSEDescription sSEDescription

 The description of the server-side encryption status on the specified DAX cluster.
 








Class com.amazonaws.services.dax.model.ClusterAlreadyExistsException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.ClusterNotFoundException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.ClusterQuotaForCustomerExceededException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


clusterName
String clusterName

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


nodeType
String nodeType

 The compute and memory capacity of the nodes in the cluster.
 


description
String description

 A description of the cluster.
 


replicationFactor
Integer replicationFactor

 The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any
 read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read
 replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read
 replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is
 provided, its length must equal the ReplicationFactor.
 
 
 
 AWS recommends that you have at least two read replicas per cluster.
 
 


availabilityZones
List<E> availabilityZones

 The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or
 updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you
 omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
 


subnetGroupName
String subnetGroupName

 The name of the subnet group to be used for the replication group.
 
 
 
 DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group
 must exist in the same VPC.
 
 


securityGroupIds
List<E> securityGroupIds

 A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is
 system-generated.)
 
 
 If this parameter is not specified, DAX assigns the default VPC security group to each node.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 Specifies the weekly time range during which maintenance on the DAX 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
 
 
 
 If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a
 60-minute maintenance window on a randomly selected day of the week.
 
 


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


iamRoleArn
String iamRoleArn

 A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the
 role's permissions to access DynamoDB on your behalf.
 


parameterGroupName
String parameterGroupName

 The parameter group to be associated with the DAX cluster.
 


tags
List<E> tags

 A set of tags to associate with the DAX cluster.
 


sSESpecification
SSESpecification sSESpecification

 Represents the settings used to enable server-side encryption on the cluster.
 








Class com.amazonaws.services.dax.model.CreateClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 A description of the DAX cluster that you have created.
 








Class com.amazonaws.services.dax.model.CreateParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


parameterGroupName
String parameterGroupName

 The name of the parameter group to apply to all of the clusters in this replication group.
 


description
String description

 A description of the parameter group.
 








Class com.amazonaws.services.dax.model.CreateParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


parameterGroup
ParameterGroup parameterGroup

 Represents the output of a CreateParameterGroup action.
 








Class com.amazonaws.services.dax.model.CreateSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subnetGroupName
String subnetGroupName

 A name for the subnet group. This value is stored as a lowercase string.
 


description
String description

 A description for the subnet group
 


subnetIds
List<E> subnetIds

 A list of VPC subnet IDs for the subnet group.
 








Class com.amazonaws.services.dax.model.CreateSubnetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


subnetGroup
SubnetGroup subnetGroup

 Represents the output of a CreateSubnetGroup operation.
 








Class com.amazonaws.services.dax.model.DecreaseReplicationFactorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the DAX cluster from which you want to remove nodes.
 


newReplicationFactor
Integer newReplicationFactor

 The new number of nodes for the DAX cluster.
 


availabilityZones
List<E> availabilityZones

 The Availability Zone(s) from which to remove nodes.
 


nodeIdsToRemove
List<E> nodeIdsToRemove

 The unique identifiers of the nodes to be removed from the cluster.
 








Class com.amazonaws.services.dax.model.DecreaseReplicationFactorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 A description of the DAX cluster, after you have decreased its replication factor.
 








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


Serialized Fields


clusterName
String clusterName

 The name of the cluster to be deleted.
 








Class com.amazonaws.services.dax.model.DeleteClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 A description of the DAX cluster that is being deleted.
 








Class com.amazonaws.services.dax.model.DeleteParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


parameterGroupName
String parameterGroupName

 The name of the parameter group to delete.
 








Class com.amazonaws.services.dax.model.DeleteParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deletionMessage
String deletionMessage

 A user-specified message for this action (i.e., a reason for deleting the parameter group).
 








Class com.amazonaws.services.dax.model.DeleteSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subnetGroupName
String subnetGroupName

 The name of the subnet group to delete.
 








Class com.amazonaws.services.dax.model.DeleteSubnetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deletionMessage
String deletionMessage

 A user-specified message for this action (i.e., a reason for deleting the subnet group).
 








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


Serialized Fields


clusterNames
List<E> clusterNames

 The names of the DAX clusters being described.
 


maxResults
Integer maxResults

 The maximum number of results to include in the response. If more results exist than the specified
 MaxResults value, a token is included in the response so that the remaining results can be
 retrieved.
 
 
 The value for MaxResults must be between 20 and 100.
 


nextToken
String nextToken

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








Class com.amazonaws.services.dax.model.DescribeClustersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 Provides an identifier to allow retrieval of paginated results.
 


clusters
List<E> clusters

 The descriptions of your DAX clusters, in response to a DescribeClusters request.
 








Class com.amazonaws.services.dax.model.DescribeDefaultParametersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results to include in the response. If more results exist than the specified
 MaxResults value, a token is included in the response so that the remaining results can be
 retrieved.
 
 
 The value for MaxResults must be between 20 and 100.
 


nextToken
String nextToken

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








Class com.amazonaws.services.dax.model.DescribeDefaultParametersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 Provides an identifier to allow retrieval of paginated results.
 


parameters
List<E> parameters

 A list of parameters. Each element in the list represents one parameter.
 








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


Serialized Fields


sourceName
String sourceName

 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.
 


startTime
Date startTime

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


endTime
Date endTime

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


duration
Integer duration

 The number of minutes' worth of events to retrieve.
 


maxResults
Integer maxResults

 The maximum number of results to include in the response. If more results exist than the specified
 MaxResults value, a token is included in the response so that the remaining results can be
 retrieved.
 
 
 The value for MaxResults must be between 20 and 100.
 


nextToken
String nextToken

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








Class com.amazonaws.services.dax.model.DescribeEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 Provides an identifier to allow retrieval of paginated results.
 


events
List<E> events

 An array of events. Each element in the array represents one event.
 








Class com.amazonaws.services.dax.model.DescribeParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


parameterGroupNames
List<E> parameterGroupNames

 The names of the parameter groups.
 


maxResults
Integer maxResults

 The maximum number of results to include in the response. If more results exist than the specified
 MaxResults value, a token is included in the response so that the remaining results can be
 retrieved.
 
 
 The value for MaxResults must be between 20 and 100.
 


nextToken
String nextToken

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








Class com.amazonaws.services.dax.model.DescribeParameterGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 Provides an identifier to allow retrieval of paginated results.
 


parameterGroups
List<E> parameterGroups

 An array of parameter groups. Each element in the array represents one parameter group.
 








Class com.amazonaws.services.dax.model.DescribeParametersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


parameterGroupName
String parameterGroupName

 The name of the parameter group.
 


source
String source

 How the parameter is defined. For example, system denotes a system-defined parameter.
 


maxResults
Integer maxResults

 The maximum number of results to include in the response. If more results exist than the specified
 MaxResults value, a token is included in the response so that the remaining results can be
 retrieved.
 
 
 The value for MaxResults must be between 20 and 100.
 


nextToken
String nextToken

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








Class com.amazonaws.services.dax.model.DescribeParametersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 Provides an identifier to allow retrieval of paginated results.
 


parameters
List<E> parameters

 A list of parameters within a parameter group. Each element in the list represents one parameter.
 








Class com.amazonaws.services.dax.model.DescribeSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subnetGroupNames
List<E> subnetGroupNames

 The name of the subnet group.
 


maxResults
Integer maxResults

 The maximum number of results to include in the response. If more results exist than the specified
 MaxResults value, a token is included in the response so that the remaining results can be
 retrieved.
 
 
 The value for MaxResults must be between 20 and 100.
 


nextToken
String nextToken

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








Class com.amazonaws.services.dax.model.DescribeSubnetGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 Provides an identifier to allow retrieval of paginated results.
 


subnetGroups
List<E> subnetGroups

 An array of subnet groups. Each element in the array represents a single subnet group.
 








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


Serialized Fields


address
String address

 The DNS hostname of the endpoint.
 


port
Integer port

 The port number that applications should use to connect to the endpoint.
 








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


Serialized Fields


sourceName
String sourceName

 The source of the event. For example, if the event occurred at the node level, the source would be the node ID.
 


sourceType
String sourceType

 Specifies the origin of this event - a cluster, a parameter group, a node ID, etc.
 


message
String message

 A user-defined message associated with the event.
 


date
Date date

 The date and time when the event occurred.
 








Class com.amazonaws.services.dax.model.IncreaseReplicationFactorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the DAX cluster that will receive additional nodes.
 


newReplicationFactor
Integer newReplicationFactor

 The new number of nodes for the DAX cluster.
 


availabilityZones
List<E> availabilityZones

 The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are
 placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.
 








Class com.amazonaws.services.dax.model.IncreaseReplicationFactorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 A description of the DAX cluster. with its new replication factor.
 








Class com.amazonaws.services.dax.model.InsufficientClusterCapacityException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.InvalidARNException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.InvalidClusterStateException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.InvalidParameterCombinationException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.InvalidParameterGroupStateException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.InvalidParameterValueException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.InvalidSubnetException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.InvalidVPCNetworkStateException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceName
String resourceName

 The name of the DAX resource to which the tags belong.
 


nextToken
String nextToken

 An optional token returned from a prior request. Use this token for pagination of results from this action. If
 this parameter is specified, the response includes only results beyond the token.
 








Class com.amazonaws.services.dax.model.ListTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 A list of tags currently associated with the DAX cluster.
 


nextToken
String nextToken

 If this value is present, there are additional results to be displayed. To retrieve them, call
 ListTags again, with NextToken set to this value.
 








Class com.amazonaws.services.dax.model.Node extends Object implements Serializable


Serialized Fields


nodeId
String nodeId

 A system-generated identifier for the node.
 


endpoint
Endpoint endpoint

 The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly
 to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests
 and responses to nodes in the DAX cluster.
 


nodeCreateTime
Date nodeCreateTime

 The date and time (in UNIX epoch format) when the node was launched.
 


availabilityZone
String availabilityZone

 The Availability Zone (AZ) in which the node has been deployed.
 


nodeStatus
String nodeStatus

 The current status of the node. For example: available.
 


parameterGroupStatus
String parameterGroupStatus

 The status of the parameter group associated with this node. For example, in-sync.
 








Class com.amazonaws.services.dax.model.NodeNotFoundException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.NodeQuotaForClusterExceededException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.NodeQuotaForCustomerExceededException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.NodeTypeSpecificValue extends Object implements Serializable


Serialized Fields


nodeType
String nodeType

 A node type to which the parameter value applies.
 


value
String value

 The parameter value for this node type.
 








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


Serialized Fields


topicArn
String topicArn

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


topicStatus
String topicStatus

 The current state of the topic.
 








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


Serialized Fields


parameterName
String parameterName

 The name of the parameter.
 


parameterType
String parameterType

 Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.
 


parameterValue
String parameterValue

 The value for the parameter.
 


nodeTypeSpecificValues
List<E> nodeTypeSpecificValues

 A list of node types, and specific parameter values for each node.
 


description
String description

 A description of the parameter
 


source
String source

 How the parameter is defined. For example, system denotes a system-defined parameter.
 


dataType
String dataType

 The data type of the parameter. For example, integer:
 


allowedValues
String allowedValues

 A range of values within which the parameter can be set.
 


isModifiable
String isModifiable

 Whether the customer is allowed to modify the parameter.
 


changeType
String changeType

 The conditions under which changes to this parameter can be applied. For example, requires-reboot
 indicates that a new value for this parameter will only take effect if a node is rebooted.
 








Class com.amazonaws.services.dax.model.ParameterGroup extends Object implements Serializable


Serialized Fields


parameterGroupName
String parameterGroupName

 The name of the parameter group.
 


description
String description

 A description of the parameter group.
 








Class com.amazonaws.services.dax.model.ParameterGroupAlreadyExistsException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.ParameterGroupNotFoundException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.ParameterGroupQuotaExceededException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.ParameterGroupStatus extends Object implements Serializable


Serialized Fields


parameterGroupName
String parameterGroupName

 The name of the parameter group.
 


parameterApplyStatus
String parameterApplyStatus

 The status of parameter updates.
 


nodeIdsToReboot
List<E> nodeIdsToReboot

 The node IDs of one or more nodes to be rebooted.
 








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


Serialized Fields


parameterName
String parameterName

 The name of the parameter.
 


parameterValue
String parameterValue

 The value of the parameter.
 








Class com.amazonaws.services.dax.model.RebootNodeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the DAX cluster containing the node to be rebooted.
 


nodeId
String nodeId

 The system-assigned ID of the node to be rebooted.
 








Class com.amazonaws.services.dax.model.RebootNodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 A description of the DAX cluster after a node has been rebooted.
 








Class com.amazonaws.services.dax.model.SecurityGroupMembership extends Object implements Serializable


Serialized Fields


securityGroupIdentifier
String securityGroupIdentifier

 The unique ID for this security group.
 


status
String status

 The status of this security group.
 








Class com.amazonaws.services.dax.model.ServiceLinkedRoleNotFoundException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.SSEDescription extends Object implements Serializable


Serialized Fields


status
String status

 The current state of server-side encryption:
 
 
 
 
 ENABLING - Server-side encryption is being enabled.
 
 
 
 
 ENABLED - Server-side encryption is enabled.
 
 
 
 
 DISABLING - Server-side encryption is being disabled.
 
 
 
 
 DISABLED - Server-side encryption is disabled.
 
 
 








Class com.amazonaws.services.dax.model.SSESpecification extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
 








Class com.amazonaws.services.dax.model.Subnet extends Object implements Serializable


Serialized Fields


subnetIdentifier
String subnetIdentifier

 The system-assigned identifier for the subnet.
 


subnetAvailabilityZone
String subnetAvailabilityZone

 The Availability Zone (AZ) for the subnet.
 








Class com.amazonaws.services.dax.model.SubnetGroup extends Object implements Serializable


Serialized Fields


subnetGroupName
String subnetGroupName

 The name of the subnet group.
 


description
String description

 The description of the subnet group.
 


vpcId
String vpcId

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


subnets
List<E> subnets

 A list of subnets associated with the subnet group.
 








Class com.amazonaws.services.dax.model.SubnetGroupAlreadyExistsException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.SubnetGroupInUseException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.SubnetGroupNotFoundException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.SubnetGroupQuotaExceededException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.SubnetInUseException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.SubnetQuotaExceededException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If
 you try to add an existing tag (same key), the existing tag value will be updated to the new value.
 


value
String value

 The value of the tag. Tag values are case-sensitive and can be null.
 








Class com.amazonaws.services.dax.model.TagNotFoundException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.TagQuotaPerResourceExceededException extends AmazonDaxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dax.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceName
String resourceName

 The name of the DAX resource to which tags should be added.
 


tags
List<E> tags

 The tags to be assigned to the DAX resource.
 








Class com.amazonaws.services.dax.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The list of tags that are associated with the DAX resource.
 








Class com.amazonaws.services.dax.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceName
String resourceName

 The name of the DAX resource from which the tags should be removed.
 


tagKeys
List<E> tagKeys

 A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.
 








Class com.amazonaws.services.dax.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The tag keys that have been removed from the cluster.
 








Class com.amazonaws.services.dax.model.UpdateClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the DAX cluster to be modified.
 


description
String description

 A description of the changes being made to the cluster.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 A range of time when maintenance of DAX cluster software will be performed. For example:
 sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed
 automatically within the maintenance window.
 


notificationTopicArn
String notificationTopicArn

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


notificationTopicStatus
String notificationTopicStatus

 The current state of the topic.
 


parameterGroupName
String parameterGroupName

 The name of a parameter group for this cluster.
 


securityGroupIds
List<E> securityGroupIds

 A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is
 not specified, DAX assigns the default VPC security group to each node.
 








Class com.amazonaws.services.dax.model.UpdateClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 A description of the DAX cluster, after it has been modified.
 








Class com.amazonaws.services.dax.model.UpdateParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


parameterGroupName
String parameterGroupName

 The name of the parameter group.
 


parameterNameValues
List<E> parameterNameValues

 An array of name-value pairs for the parameters in the group. Each element in the array represents a single
 parameter.
 








Class com.amazonaws.services.dax.model.UpdateParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


parameterGroup
ParameterGroup parameterGroup

 The parameter group that has been modified.
 








Class com.amazonaws.services.dax.model.UpdateSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subnetGroupName
String subnetGroupName

 The name of the subnet group.
 


description
String description

 A description of the subnet group.
 


subnetIds
List<E> subnetIds

 A list of subnet IDs in the subnet group.
 








Class com.amazonaws.services.dax.model.UpdateSubnetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


subnetGroup
SubnetGroup subnetGroup

 The subnet group that has been modified.
 








Package com.amazonaws.services.detective.model




Class com.amazonaws.services.detective.model.AcceptInvitationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


graphArn
String graphArn

 The ARN of the behavior graph that the member account is accepting the invitation for.
 
 
 The member account status in the behavior graph must be INVITED.
 








Class com.amazonaws.services.detective.model.AcceptInvitationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.detective.model.Account extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The account identifier of the AWS account.
 


emailAddress
String emailAddress

 The AWS account root user email address for the AWS account.
 








Class com.amazonaws.services.detective.model.AmazonDetectiveException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.detective.model.ConflictException extends AmazonDetectiveException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.detective.model.CreateGraphRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.detective.model.CreateGraphResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


graphArn
String graphArn

 The ARN of the new behavior graph.
 








Class com.amazonaws.services.detective.model.CreateMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


graphArn
String graphArn

 The ARN of the behavior graph to invite the member accounts to contribute their data to.
 


message
String message

 Customized message text to include in the invitation email message to the invited member accounts.
 


accounts
List<E> accounts

 The list of AWS accounts to invite to become member accounts in the behavior graph. For each invited account, the
 account list contains the account identifier and the AWS account root user email address.
 








Class com.amazonaws.services.detective.model.CreateMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


members
List<E> members

 The set of member account invitation requests that Detective was able to process. This includes accounts that are
 being verified, that failed verification, and that passed verification and are being sent an invitation.
 


unprocessedAccounts
List<E> unprocessedAccounts

 The list of accounts for which Detective was unable to process the invitation request. For each account, the list
 provides the reason why the request could not be processed. The list includes accounts that are already member
 accounts in the behavior graph.
 








Class com.amazonaws.services.detective.model.DeleteGraphRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


graphArn
String graphArn

 The ARN of the behavior graph to disable.
 








Class com.amazonaws.services.detective.model.DeleteGraphResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.detective.model.DeleteMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


graphArn
String graphArn

 The ARN of the behavior graph to delete members from.
 


accountIds
List<E> accountIds

 The list of AWS account identifiers for the member accounts to delete from the behavior graph.
 








Class com.amazonaws.services.detective.model.DeleteMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accountIds
List<E> accountIds

 The list of AWS account identifiers for the member accounts that Detective successfully deleted from the behavior
 graph.
 


unprocessedAccounts
List<E> unprocessedAccounts

 The list of member accounts that Detective was not able to delete from the behavior graph. For each member
 account, provides the reason that the deletion could not be processed.
 








Class com.amazonaws.services.detective.model.DisassociateMembershipRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


graphArn
String graphArn

 The ARN of the behavior graph to remove the member account from.
 
 
 The member account's member status in the behavior graph must be ENABLED.
 








Class com.amazonaws.services.detective.model.DisassociateMembershipResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.detective.model.GetMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


graphArn
String graphArn

 The ARN of the behavior graph for which to request the member details.
 


accountIds
List<E> accountIds

 The list of AWS account identifiers for the member account for which to return member details.
 
 
 You cannot use GetMembers to retrieve information about member accounts that were removed from the
 behavior graph.
 








Class com.amazonaws.services.detective.model.GetMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


memberDetails
List<E> memberDetails

 The member account details that Detective is returning in response to the request.
 


unprocessedAccounts
List<E> unprocessedAccounts

 The requested member accounts for which Detective was unable to return member details.
 
 
 For each account, provides the reason why the request could not be processed.
 








Class com.amazonaws.services.detective.model.Graph extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the behavior graph.
 


createdTime
Date createdTime

 The date and time that the behavior graph was created. The value is in milliseconds since the epoch.
 








Class com.amazonaws.services.detective.model.InternalServerException extends AmazonDetectiveException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.detective.model.ListGraphsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 For requests to get the next page of results, the pagination token that was returned with the previous set of
 results. The initial request does not include a pagination token.
 


maxResults
Integer maxResults

 The maximum number of graphs to return at a time. The total must be less than the overall limit on the number of
 results to return, which is currently 200.
 








Class com.amazonaws.services.detective.model.ListGraphsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


graphList
List<E> graphList

 A list of behavior graphs that the account is a master for.
 


nextToken
String nextToken

 If there are more behavior graphs remaining in the results, then this is the pagination token to use to request
 the next page of behavior graphs.
 








Class com.amazonaws.services.detective.model.ListInvitationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 For requests to retrieve the next page of results, the pagination token that was returned with the previous page
 of results. The initial request does not include a pagination token.
 


maxResults
Integer maxResults

 The maximum number of behavior graph invitations to return in the response. The total must be less than the
 overall limit on the number of results to return, which is currently 200.
 








Class com.amazonaws.services.detective.model.ListInvitationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


invitations
List<E> invitations

 The list of behavior graphs for which the member account has open or accepted invitations.
 


nextToken
String nextToken

 If there are more behavior graphs remaining in the results, then this is the pagination token to use to request
 the next page of behavior graphs.
 








Class com.amazonaws.services.detective.model.ListMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


graphArn
String graphArn

 The ARN of the behavior graph for which to retrieve the list of member accounts.
 


nextToken
String nextToken

 For requests to retrieve the next page of member account results, the pagination token that was returned with the
 previous page of results. The initial request does not include a pagination token.
 


maxResults
Integer maxResults

 The maximum number of member accounts to include in the response. The total must be less than the overall limit
 on the number of results to return, which is currently 200.
 








Class com.amazonaws.services.detective.model.ListMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


memberDetails
List<E> memberDetails

 The list of member accounts in the behavior graph.
 
 
 The results include member accounts that did not pass verification and member accounts that have not yet accepted
 the invitation to the behavior graph. The results do not include member accounts that were removed from the
 behavior graph.
 


nextToken
String nextToken

 If there are more member accounts remaining in the results, then this is the pagination token to use to request
 the next page of member accounts.
 








Class com.amazonaws.services.detective.model.MemberDetail extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The AWS account identifier for the member account.
 


emailAddress
String emailAddress

 The AWS account root user email address for the member account.
 


graphArn
String graphArn

 The ARN of the behavior graph that the member account was invited to.
 


masterId
String masterId

 The AWS account identifier of the master account for the behavior graph.
 


status
String status

 The current membership status of the member account. The status can have one of the following values:
 
 
 
 
 INVITED - Indicates that the member was sent an invitation but has not yet responded.
 
 
 
 
 VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the account identifier and
 email address provided for the member account match. If they do match, then Detective sends the invitation. If
 the email address and account identifier don't match, then the member cannot be added to the behavior graph.
 
 
 
 
 VERIFICATION_FAILED - Indicates that the account and email address provided for the member account
 do not match, and Detective did not send an invitation to the account.
 
 
 
 
 ENABLED - Indicates that the member account accepted the invitation to contribute to the behavior
 graph.
 
 
 
 
 Member accounts that declined an invitation or that were removed from the behavior graph are not included.
 


invitedTime
Date invitedTime

 The date and time that Detective sent the invitation to the member account. The value is in milliseconds since
 the epoch.
 


updatedTime
Date updatedTime

 The date and time that the member account was last updated. The value is in milliseconds since the epoch.
 








Class com.amazonaws.services.detective.model.RejectInvitationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


graphArn
String graphArn

 The ARN of the behavior graph to reject the invitation to.
 
 
 The member account's current member status in the behavior graph must be INVITED.
 








Class com.amazonaws.services.detective.model.RejectInvitationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.detective.model.ResourceNotFoundException extends AmazonDetectiveException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.detective.model.ServiceQuotaExceededException extends AmazonDetectiveException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.detective.model.UnprocessedAccount extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The AWS account identifier of the member account that was not processed.
 


reason
String reason

 The reason that the member account request could not be processed.
 








Class com.amazonaws.services.detective.model.ValidationException extends AmazonDetectiveException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.devicefarm.model




Class com.amazonaws.services.devicefarm.model.AccountSettings extends Object implements Serializable


Serialized Fields


awsAccountNumber
String awsAccountNumber

 The AWS account number specified in the AccountSettings container.
 


unmeteredDevices
Map<K,V> unmeteredDevices

 Returns the unmetered devices you have purchased or want to purchase.
 


unmeteredRemoteAccessDevices
Map<K,V> unmeteredRemoteAccessDevices

 Returns the unmetered remote access devices you have purchased or want to purchase.
 


maxJobTimeoutMinutes
Integer maxJobTimeoutMinutes

 The maximum number of minutes a test run executes before it times out.
 


trialMinutes
TrialMinutes trialMinutes

 Information about an AWS account's usage of free trial device minutes.
 


maxSlots
Map<K,V> maxSlots

 The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an
 offering-id:number pair, where the offering-id represents one of the IDs returned by
 the ListOfferings command.
 


defaultJobTimeoutMinutes
Integer defaultJobTimeoutMinutes

 The default number of minutes (at the account level) a test run executes before it times out. The default value
 is 150 minutes.
 


skipAppResign
Boolean skipAppResign

 When set to true, for private devices, Device Farm does not sign your app again. For public devices,
 Device Farm always signs your apps again.
 
 
 For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.
 








Class com.amazonaws.services.devicefarm.model.ArgumentException extends AWSDeviceFarmException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.devicefarm.model.Artifact extends Object implements Serializable


Serialized Fields


arn
String arn

 The artifact's ARN.
 


name
String name

 The artifact's name.
 


type
String type

 The artifact's type.
 
 
 Allowed values include the following:
 
 
 
 
 UNKNOWN
 
 
 
 
 SCREENSHOT
 
 
 
 
 DEVICE_LOG
 
 
 
 
 MESSAGE_LOG
 
 
 
 
 VIDEO_LOG
 
 
 
 
 RESULT_LOG
 
 
 
 
 SERVICE_LOG
 
 
 
 
 WEBKIT_LOG
 
 
 
 
 INSTRUMENTATION_OUTPUT
 
 
 
 
 EXERCISER_MONKEY_OUTPUT: the artifact (log) generated by an Android fuzz test.
 
 
 
 
 CALABASH_JSON_OUTPUT
 
 
 
 
 CALABASH_PRETTY_OUTPUT
 
 
 
 
 CALABASH_STANDARD_OUTPUT
 
 
 
 
 CALABASH_JAVA_XML_OUTPUT
 
 
 
 
 AUTOMATION_OUTPUT
 
 
 
 
 APPIUM_SERVER_OUTPUT
 
 
 
 
 APPIUM_JAVA_OUTPUT
 
 
 
 
 APPIUM_JAVA_XML_OUTPUT
 
 
 
 
 APPIUM_PYTHON_OUTPUT
 
 
 
 
 APPIUM_PYTHON_XML_OUTPUT
 
 
 
 
 EXPLORER_EVENT_LOG
 
 
 
 
 EXPLORER_SUMMARY_LOG
 
 
 
 
 APPLICATION_CRASH_REPORT
 
 
 
 
 XCTEST_LOG
 
 
 
 
 VIDEO
 
 
 
 
 CUSTOMER_ARTIFACT
 
 
 
 
 CUSTOMER_ARTIFACT_LOG
 
 
 
 
 TESTSPEC_OUTPUT
 
 
 


extension
String extension

 The artifact's file extension.
 


url
String url

 The presigned Amazon S3 URL that can be used with a GET request to download the artifact's file.
 








Class com.amazonaws.services.devicefarm.model.AWSDeviceFarmException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.devicefarm.model.CannotDeleteException extends AWSDeviceFarmException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.devicefarm.model.Counters extends Object implements Serializable


Serialized Fields


total
Integer total

 The total number of entities.
 


passed
Integer passed

 The number of passed entities.
 


failed
Integer failed

 The number of failed entities.
 


warned
Integer warned

 The number of warned entities.
 


errored
Integer errored

 The number of errored entities.
 


stopped
Integer stopped

 The number of stopped entities.
 


skipped
Integer skipped

 The number of skipped entities.
 








Class com.amazonaws.services.devicefarm.model.CPU extends Object implements Serializable


Serialized Fields


frequency
String frequency

 The CPU's frequency.
 


architecture
String architecture

 The CPU's architecture (for example, x86 or ARM).
 


clock
Double clock

 The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as
 1200000000.
 








Class com.amazonaws.services.devicefarm.model.CreateDevicePoolRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectArn
String projectArn

 The ARN of the project for the device pool.
 


name
String name

 The device pool's name.
 


description
String description

 The device pool's description.
 


rules
List<E> rules

 The device pool's rules.
 


maxDevices
Integer maxDevices

 The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available
 and meet the criteria that you assign for the rules parameter. Depending on how many devices meet
 these constraints, your device pool might contain fewer devices than the value for this parameter.
 
 
 By specifying the maximum number of devices, you can control the costs that you incur by running tests.
 








Class com.amazonaws.services.devicefarm.model.CreateDevicePoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devicePool
DevicePool devicePool

 The newly created device pool.
 








Class com.amazonaws.services.devicefarm.model.CreateInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of your instance profile.
 


description
String description

 The description of your instance profile.
 


packageCleanup
Boolean packageCleanup

 When set to true, Device Farm removes app packages after a test run. The default value is
 false for private devices.
 


excludeAppPackagesFromCleanup
List<E> excludeAppPackagesFromCleanup

 An array of strings that specifies the list of app packages that should not be cleaned up from the device after a
 test run.
 
 
 The list of packages is considered only if you set packageCleanup to true.
 


rebootAfterUse
Boolean rebootAfterUse

 When set to true, Device Farm reboots the instance after a test run. The default value is
 true.
 








Class com.amazonaws.services.devicefarm.model.CreateInstanceProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceProfile
InstanceProfile instanceProfile

 An object that contains information about your instance profile.
 








Class com.amazonaws.services.devicefarm.model.CreateNetworkProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectArn
String projectArn

 The Amazon Resource Name (ARN) of the project for which you want to create a network profile.
 


name
String name

 The name for the new network profile.
 


description
String description

 The description of the network profile.
 


type
String type

 The type of network profile to create. Valid values are listed here.
 


uplinkBandwidthBits
Long uplinkBandwidthBits

 The data throughput rate in bits per second, as an integer from 0 to 104857600.
 


downlinkBandwidthBits
Long downlinkBandwidthBits

 The data throughput rate in bits per second, as an integer from 0 to 104857600.
 


uplinkDelayMs
Long uplinkDelayMs

 Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
 


downlinkDelayMs
Long downlinkDelayMs

 Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
 


uplinkJitterMs
Long uplinkJitterMs

 Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
 


downlinkJitterMs
Long downlinkJitterMs

 Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
 


uplinkLossPercent
Integer uplinkLossPercent

 Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
 


downlinkLossPercent
Integer downlinkLossPercent

 Proportion of received packets that fail to arrive from 0 to 100 percent.
 








Class com.amazonaws.services.devicefarm.model.CreateNetworkProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networkProfile
NetworkProfile networkProfile

 The network profile that is returned by the create network profile request.
 








Class com.amazonaws.services.devicefarm.model.CreateProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The project's name.
 


defaultJobTimeoutMinutes
Integer defaultJobTimeoutMinutes

 Sets the execution timeout value (in minutes) for a project. All test runs in this project use the specified
 execution timeout value unless overridden when scheduling a run.
 








Class com.amazonaws.services.devicefarm.model.CreateProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


project
Project project

 The newly created project.
 








Class com.amazonaws.services.devicefarm.model.CreateRemoteAccessSessionConfiguration extends Object implements Serializable


Serialized Fields


billingMethod
String billingMethod

 The billing method for the remote access session.
 


vpceConfigurationArns
List<E> vpceConfigurationArns

 An array of ARNs included in the VPC endpoint configuration.
 








Class com.amazonaws.services.devicefarm.model.CreateRemoteAccessSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectArn
String projectArn

 The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.
 


deviceArn
String deviceArn

 The ARN of the device for which you want to create a remote access session.
 


instanceArn
String instanceArn

 The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.
 


sshPublicKey
String sshPublicKey

 Ignored. The public key of the ssh key pair you want to use for connecting to remote devices in your
 remote debugging session. This key is required only if remoteDebugEnabled is set to
 true.
 
 
 Remote debugging is no longer
 supported.
 


remoteDebugEnabled
Boolean remoteDebugEnabled

 Set to true if you want to access devices remotely for debugging in your remote access session.
 
 
 Remote debugging is no longer
 supported.
 


remoteRecordEnabled
Boolean remoteRecordEnabled

 Set to true to enable remote recording for the remote access session.
 


remoteRecordAppArn
String remoteRecordAppArn

 The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.
 


name
String name

 The name of the remote access session to create.
 


clientId
String clientId

 Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the
 same clientId value in each call to CreateRemoteAccessSession. This identifier is
 required only if remoteDebugEnabled is set to true.
 
 
 Remote debugging is no longer
 supported.
 


configuration
CreateRemoteAccessSessionConfiguration configuration

 The configuration information for the remote access session request.
 


interactionMode
String interactionMode

 The interaction mode of the remote access session. Valid values are:
 
 
 
 
 INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run
 XCUITest framework-based tests in this mode.
 
 
 
 
 NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the
 fastest test execution speed. You can run XCUITest framework-based tests in this mode.
 
 
 
 
 VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests
 and watch the screen in this mode.
 
 
 


skipAppResign
Boolean skipAppResign

 When set to true, for private devices, Device Farm does not sign your app again. For public devices,
 Device Farm always signs your apps again.
 
 
 For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?
 








Class com.amazonaws.services.devicefarm.model.CreateRemoteAccessSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


remoteAccessSession
RemoteAccessSession remoteAccessSession

 A container that describes the remote access session when the request to create a remote access session is sent.
 








Class com.amazonaws.services.devicefarm.model.CreateTestGridProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Human-readable name of the Selenium testing project.
 


description
String description

 Human-readable description of the project.
 








Class com.amazonaws.services.devicefarm.model.CreateTestGridProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


testGridProject
TestGridProject testGridProject

 ARN of the Selenium testing project that was created.
 








Class com.amazonaws.services.devicefarm.model.CreateTestGridUrlRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectArn
String projectArn

 ARN (from CreateTestGridProject or ListTestGridProjects) to associate with the short-term URL.
 


expiresInSeconds
Integer expiresInSeconds

 Lifetime, in seconds, of the URL.
 








Class com.amazonaws.services.devicefarm.model.CreateTestGridUrlResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


url
String url

 A signed URL, expiring in CreateTestGridUrlRequest$expiresInSeconds seconds, to be passed to a
 RemoteWebDriver.
 


expires
Date expires

 The number of seconds the URL from CreateTestGridUrlResult$url stays active.
 








Class com.amazonaws.services.devicefarm.model.CreateUploadRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectArn
String projectArn

 The ARN of the project for the upload.
 


name
String name

 The upload's file name. The name should not contain any forward slashes (/). If you are uploading an
 iOS app, the file name must end with the .ipa extension. If you are uploading an Android app, the
 file name must end with the .apk extension. For all others, the file name must end with the
 .zip file extension.
 


type
String type

 The upload's upload type.
 
 
 Must be one of the following values:
 
 
 
 
 ANDROID_APP
 
 
 
 
 IOS_APP
 
 
 
 
 WEB_APP
 
 
 
 
 EXTERNAL_DATA
 
 
 
 
 APPIUM_JAVA_JUNIT_TEST_PACKAGE
 
 
 
 
 APPIUM_JAVA_TESTNG_TEST_PACKAGE
 
 
 
 
 APPIUM_PYTHON_TEST_PACKAGE
 
 
 
 
 APPIUM_NODE_TEST_PACKAGE
 
 
 
 
 APPIUM_RUBY_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_PYTHON_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_NODE_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_RUBY_TEST_PACKAGE
 
 
 
 
 CALABASH_TEST_PACKAGE
 
 
 
 
 INSTRUMENTATION_TEST_PACKAGE
 
 
 
 
 UIAUTOMATION_TEST_PACKAGE
 
 
 
 
 UIAUTOMATOR_TEST_PACKAGE
 
 
 
 
 XCTEST_TEST_PACKAGE
 
 
 
 
 XCTEST_UI_TEST_PACKAGE
 
 
 
 
 APPIUM_JAVA_JUNIT_TEST_SPEC
 
 
 
 
 APPIUM_JAVA_TESTNG_TEST_SPEC
 
 
 
 
 APPIUM_PYTHON_TEST_SPEC
 
 
 
 
 APPIUM_NODE_TEST_SPEC
 
 
 
 
 APPIUM_RUBY_TEST_SPEC
 
 
 
 
 APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
 
 
 
 
 APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
 
 
 
 
 APPIUM_WEB_PYTHON_TEST_SPEC
 
 
 
 
 APPIUM_WEB_NODE_TEST_SPEC
 
 
 
 
 APPIUM_WEB_RUBY_TEST_SPEC
 
 
 
 
 INSTRUMENTATION_TEST_SPEC
 
 
 
 
 XCTEST_UI_TEST_SPEC
 
 
 
 
 If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an
 ArgumentException error.
 


contentType
String contentType

 The upload's content type (for example, application/octet-stream).
 








Class com.amazonaws.services.devicefarm.model.CreateUploadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


upload
Upload upload

 The newly created upload.
 








Class com.amazonaws.services.devicefarm.model.CreateVPCEConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpceConfigurationName
String vpceConfigurationName

 The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.
 


vpceServiceName
String vpceServiceName

 The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.
 


serviceDnsName
String serviceDnsName

 The DNS name of the service running in your VPC that you want Device Farm to test.
 


vpceConfigurationDescription
String vpceConfigurationDescription

 An optional description that provides details about your VPC endpoint configuration.
 








Class com.amazonaws.services.devicefarm.model.CreateVPCEConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpceConfiguration
VPCEConfiguration vpceConfiguration

 An object that contains information about your VPC endpoint configuration.
 








Class com.amazonaws.services.devicefarm.model.CustomerArtifactPaths extends Object implements Serializable


Serialized Fields


iosPaths
List<E> iosPaths

 Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests are pulled
 from.
 


androidPaths
List<E> androidPaths

 Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests are
 pulled from.
 


deviceHostPaths
List<E> deviceHostPaths

 Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's
 tests are pulled from.
 








Class com.amazonaws.services.devicefarm.model.DeleteDevicePoolRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 Represents the Amazon Resource Name (ARN) of the Device Farm device pool to delete.
 








Class com.amazonaws.services.devicefarm.model.DeleteDevicePoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.devicefarm.model.DeleteInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.
 








Class com.amazonaws.services.devicefarm.model.DeleteInstanceProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.devicefarm.model.DeleteNetworkProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The ARN of the network profile to delete.
 








Class com.amazonaws.services.devicefarm.model.DeleteNetworkProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.devicefarm.model.DeleteProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 Represents the Amazon Resource Name (ARN) of the Device Farm project to delete.
 








Class com.amazonaws.services.devicefarm.model.DeleteProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.devicefarm.model.DeleteRemoteAccessSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the session for which you want to delete remote access.
 








Class com.amazonaws.services.devicefarm.model.DeleteRemoteAccessSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.devicefarm.model.DeleteRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) for the run to delete.
 








Class com.amazonaws.services.devicefarm.model.DeleteRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.devicefarm.model.DeleteTestGridProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectArn
String projectArn

 The ARN of the project to delete, from CreateTestGridProject or ListTestGridProjects.
 








Class com.amazonaws.services.devicefarm.model.DeleteTestGridProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.devicefarm.model.DeleteUploadRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 Represents the Amazon Resource Name (ARN) of the Device Farm upload to delete.
 








Class com.amazonaws.services.devicefarm.model.DeleteUploadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.devicefarm.model.DeleteVPCEConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.
 








Class com.amazonaws.services.devicefarm.model.DeleteVPCEConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.devicefarm.model.Device extends Object implements Serializable


Serialized Fields


arn
String arn

 The device's ARN.
 


name
String name

 The device's display name.
 


manufacturer
String manufacturer

 The device's manufacturer name.
 


model
String model

 The device's model name.
 


modelId
String modelId

 The device's model ID.
 


formFactor
String formFactor

 The device's form factor.
 
 
 Allowed values include:
 
 
 
 
 PHONE
 
 
 
 
 TABLET
 
 
 


platform
String platform

 The device's platform.
 
 
 Allowed values include:
 
 
 
 
 ANDROID
 
 
 
 
 IOS
 
 
 


os
String os

 The device's operating system type.
 


cpu
CPU cpu

 Information about the device's CPU.
 


resolution
Resolution resolution

 The resolution of the device.
 


heapSize
Long heapSize

 The device's heap size, expressed in bytes.
 


memory
Long memory

 The device's total memory size, expressed in bytes.
 


image
String image

 The device's image name.
 


carrier
String carrier

 The device's carrier.
 


radio
String radio

 The device's radio.
 


remoteAccessEnabled
Boolean remoteAccessEnabled

 Specifies whether remote access has been enabled for the specified device.
 


remoteDebugEnabled
Boolean remoteDebugEnabled

 This flag is set to true if remote debugging is enabled for the device.
 
 
 Remote debugging is no longer
 supported.
 


fleetType
String fleetType

 The type of fleet to which this device belongs. Possible values are PRIVATE and PUBLIC.
 


fleetName
String fleetName

 The name of the fleet to which this device belongs.
 


instances
List<E> instances

 The instances that belong to this device.
 


availability
String availability

 Indicates how likely a device is available for a test run. Currently available in the ListDevices and
 GetDevice API methods.
 








Class com.amazonaws.services.devicefarm.model.DeviceFilter extends Object implements Serializable


Serialized Fields


attribute
String attribute

 The aspect of a device such as platform or model used as the selection criteria in a device filter.
 
 
 The supported operators for each attribute are provided in the following list.
 
 
 ARN
 
 
 The Amazon Resource Name (ARN) of the device (for example,
 arn:aws:devicefarm:us-west-2::device:12345Example).
 
 
 Supported operators: EQUALS, IN, NOT_IN
 
 
 PLATFORM
 
 
 The device platform. Valid values are ANDROID or IOS.
 
 
 Supported operators: EQUALS
 
 
 OS_VERSION
 
 
 The operating system version (for example, 10.3.2).
 
 
 Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS,
 IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN
 
 
 MODEL
 
 
 The device model (for example, iPad 5th Gen).
 
 
 Supported operators: CONTAINS, EQUALS, IN, NOT_IN
 
 
 AVAILABILITY
 
 
 The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or
 TEMPORARY_NOT_AVAILABLE.
 
 
 Supported operators: EQUALS
 
 
 FORM_FACTOR
 
 
 The device form factor. Valid values are PHONE or TABLET.
 
 
 Supported operators: EQUALS
 
 
 MANUFACTURER
 
 
 The device manufacturer (for example, Apple).
 
 
 Supported operators: EQUALS, IN, NOT_IN
 
 
 REMOTE_ACCESS_ENABLED
 
 
 Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
 
 
 Supported operators: EQUALS
 
 
 REMOTE_DEBUG_ENABLED
 
 
 Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.
 
 
 Supported operators: EQUALS
 
 
 Because remote debugging is no longer supported, this
 filter is ignored.
 
 
 INSTANCE_ARN
 
 
 The Amazon Resource Name (ARN) of the device instance.
 
 
 Supported operators: EQUALS, IN, NOT_IN
 
 
 INSTANCE_LABELS
 
 
 The label of the device instance.
 
 
 Supported operators: CONTAINS
 
 
 FLEET_TYPE
 
 
 The fleet type. Valid values are PUBLIC or PRIVATE.
 
 
 Supported operators: EQUALS
 
 
 


operator
String operator

 Specifies how Device Farm compares the filter's attribute to the value. See the attribute descriptions.
 


values
List<E> values

 An array of one or more filter values used in a device filter.
 
 
 Operator Values
 
 
 
 
 The IN and NOT_IN operators can take a values array that has more than one element.
 
 
 
 
 The other operators require an array with a single element.
 
 
 
 
 Attribute Values
 
 
 
 
 The PLATFORM attribute can be set to ANDROID or IOS.
 
 
 
 
 The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
 
 
 
 
 The FORM_FACTOR attribute can be set to PHONE or TABLET.
 
 
 
 
 The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.
 
 
 








Class com.amazonaws.services.devicefarm.model.DeviceInstance extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the device instance.
 


deviceArn
String deviceArn

 The ARN of the device.
 


labels
List<E> labels

 An array of strings that describe the device instance.
 


status
String status

 The status of the device instance. Valid values are listed here.
 


udid
String udid

 Unique device identifier for the device instance.
 


instanceProfile
InstanceProfile instanceProfile

 A object that contains information about the instance profile.
 








Class com.amazonaws.services.devicefarm.model.DeviceMinutes extends Object implements Serializable


Serialized Fields


total
Double total

 When specified, represents the total minutes used by the resource to run tests.
 


metered
Double metered

 When specified, represents only the sum of metered minutes used by the resource to run tests.
 


unmetered
Double unmetered

 When specified, represents only the sum of unmetered minutes used by the resource to run tests.
 








Class com.amazonaws.services.devicefarm.model.DevicePool extends Object implements Serializable


Serialized Fields


arn
String arn

 The device pool's ARN.
 


name
String name

 The device pool's name.
 


description
String description

 The device pool's description.
 


type
String type

 The device pool's type.
 
 
 Allowed values include:
 
 
 
 
 CURATED: A device pool that is created and managed by AWS Device Farm.
 
 
 
 
 PRIVATE: A device pool that is created and managed by the device pool developer.
 
 
 


rules
List<E> rules

 Information about the device pool's rules.
 


maxDevices
Integer maxDevices

 The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available
 and meet the criteria that you assign for the rules parameter. Depending on how many devices meet
 these constraints, your device pool might contain fewer devices than the value for this parameter.
 
 
 By specifying the maximum number of devices, you can control the costs that you incur by running tests.
 








Class com.amazonaws.services.devicefarm.model.DevicePoolCompatibilityResult extends Object implements Serializable


Serialized Fields


device
Device device

 The device (phone or tablet) to return information about.
 


compatible
Boolean compatible

 Whether the result was compatible with the device pool.
 


incompatibilityMessages
List<E> incompatibilityMessages

 Information about the compatibility.
 








Class com.amazonaws.services.devicefarm.model.DeviceSelectionConfiguration extends Object implements Serializable


Serialized Fields


filters
List<E> filters

 Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and
 one or more values.
 
 
 
 
 Attribute
 
 
 The aspect of a device such as platform or model used as the selection criteria in a device filter.
 
 
 Allowed values include:
 
 
 
 
 ARN: The Amazon Resource Name (ARN) of the device (for example,
 arn:aws:devicefarm:us-west-2::device:12345Example).
 
 
 
 
 PLATFORM: The device platform. Valid values are ANDROID or IOS.
 
 
 
 
 OS_VERSION: The operating system version (for example, 10.3.2).
 
 
 
 
 MODEL: The device model (for example, iPad 5th Gen).
 
 
 
 
 AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or
 TEMPORARY_NOT_AVAILABLE.
 
 
 
 
 FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.
 
 
 
 
 MANUFACTURER: The device manufacturer (for example, Apple).
 
 
 
 
 REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
 
 
 
 
 REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because
 remote debugging is no longer
 supported, this filter is ignored.
 
 
 
 
 INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
 
 
 
 
 INSTANCE_LABELS: The label of the device instance.
 
 
 
 
 FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.
 
 
 
 
 
 
 Operator
 
 
 The filter operator.
 
 
 
 
 The EQUALS operator is available for every attribute except INSTANCE_LABELS.
 
 
 
 
 The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
 
 
 
 
 The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN
 attributes.
 
 
 
 
 The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the
 OS_VERSION attribute.
 
 
 
 
 
 
 Values
 
 
 An array of one or more filter values.
 
 
 Operator Values
 
 
 
 
 The IN and NOT_IN operators can take a values array that has more than one element.
 
 
 
 
 The other operators require an array with a single element.
 
 
 
 
 Attribute Values
 
 
 
 
 The PLATFORM attribute can be set to ANDROID or IOS.
 
 
 
 
 The AVAILABILITY attribute can be set to AVAILABLE, HIGHLY_AVAILABLE, BUSY, or TEMPORARY_NOT_AVAILABLE.
 
 
 
 
 The FORM_FACTOR attribute can be set to PHONE or TABLET.
 
 
 
 
 The FLEET_TYPE attribute can be set to PUBLIC or PRIVATE.
 
 
 
 
 


maxDevices
Integer maxDevices

 The maximum number of devices to be included in a test run.
 








Class com.amazonaws.services.devicefarm.model.DeviceSelectionResult extends Object implements Serializable


Serialized Fields


filters
List<E> filters

 The filters in a device selection result.
 


matchedDevicesCount
Integer matchedDevicesCount

 The number of devices that matched the device filter selection criteria.
 


maxDevices
Integer maxDevices

 The maximum number of devices to be selected by a device filter and included in a test run.
 








Class com.amazonaws.services.devicefarm.model.ExecutionConfiguration extends Object implements Serializable


Serialized Fields


jobTimeoutMinutes
Integer jobTimeoutMinutes

 The number of minutes a test run executes before it times out.
 


accountsCleanup
Boolean accountsCleanup

 True if account cleanup is enabled at the beginning of the test. Otherwise, false.
 


appPackagesCleanup
Boolean appPackagesCleanup

 True if app package cleanup is enabled at the beginning of the test. Otherwise, false.
 


videoCapture
Boolean videoCapture

 Set to true to enable video capture. Otherwise, set to false. The default is true.
 


skipAppResign
Boolean skipAppResign

 When set to true, for private devices, Device Farm does not sign your app again. For public devices,
 Device Farm always signs your apps again.
 
 
 For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.
 








Class com.amazonaws.services.devicefarm.model.GetAccountSettingsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.devicefarm.model.GetAccountSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accountSettings
AccountSettings accountSettings

 The account settings.
 








Class com.amazonaws.services.devicefarm.model.GetDeviceInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the instance you're requesting information about.
 








Class com.amazonaws.services.devicefarm.model.GetDeviceInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deviceInstance
DeviceInstance deviceInstance

 An object that contains information about your device instance.
 








Class com.amazonaws.services.devicefarm.model.GetDevicePoolCompatibilityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


devicePoolArn
String devicePoolArn

 The device pool's ARN.
 


appArn
String appArn

 The ARN of the app that is associated with the specified device pool.
 


testType
String testType

 The test type for the specified device pool.
 
 
 Allowed values include the following:
 
 
 
 
 BUILTIN_FUZZ.
 
 
 
 
 BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing
 screenshots at the same time.
 
 
 
 
 APPIUM_JAVA_JUNIT.
 
 
 
 
 APPIUM_JAVA_TESTNG.
 
 
 
 
 APPIUM_PYTHON.
 
 
 
 
 APPIUM_NODE.
 
 
 
 
 APPIUM_RUBY.
 
 
 
 
 APPIUM_WEB_JAVA_JUNIT.
 
 
 
 
 APPIUM_WEB_JAVA_TESTNG.
 
 
 
 
 APPIUM_WEB_PYTHON.
 
 
 
 
 APPIUM_WEB_NODE.
 
 
 
 
 APPIUM_WEB_RUBY.
 
 
 
 
 CALABASH.
 
 
 
 
 INSTRUMENTATION.
 
 
 
 
 UIAUTOMATION.
 
 
 
 
 UIAUTOMATOR.
 
 
 
 
 XCTEST.
 
 
 
 
 XCTEST_UI.
 
 
 


test
ScheduleRunTest test

 Information about the uploaded test to be run against the device pool.
 


configuration
ScheduleRunConfiguration configuration

 An object that contains information about the settings for a run.
 








Class com.amazonaws.services.devicefarm.model.GetDevicePoolCompatibilityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


compatibleDevices
List<E> compatibleDevices

 Information about compatible devices.
 


incompatibleDevices
List<E> incompatibleDevices

 Information about incompatible devices.
 








Class com.amazonaws.services.devicefarm.model.GetDevicePoolRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The device pool's ARN.
 








Class com.amazonaws.services.devicefarm.model.GetDevicePoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devicePool
DevicePool devicePool

 An object that contains information about the requested device pool.
 








Class com.amazonaws.services.devicefarm.model.GetDeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The device type's ARN.
 








Class com.amazonaws.services.devicefarm.model.GetDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


device
Device device

 An object that contains information about the requested device.
 








Class com.amazonaws.services.devicefarm.model.GetInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of an instance profile.
 








Class com.amazonaws.services.devicefarm.model.GetInstanceProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceProfile
InstanceProfile instanceProfile

 An object that contains information about an instance profile.
 








Class com.amazonaws.services.devicefarm.model.GetJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The job's ARN.
 








Class com.amazonaws.services.devicefarm.model.GetJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


job
Job job

 An object that contains information about the requested job.
 








Class com.amazonaws.services.devicefarm.model.GetNetworkProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The ARN of the network profile to return information about.
 








Class com.amazonaws.services.devicefarm.model.GetNetworkProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networkProfile
NetworkProfile networkProfile

 The network profile.
 








Class com.amazonaws.services.devicefarm.model.GetOfferingStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.GetOfferingStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


current
Map<K,V> current

 When specified, gets the offering status for the current period.
 


nextPeriod
Map<K,V> nextPeriod

 When specified, gets the offering status for the next period.
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.GetProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The project's ARN.
 








Class com.amazonaws.services.devicefarm.model.GetProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


project
Project project

 The project to get information about.
 








Class com.amazonaws.services.devicefarm.model.GetRemoteAccessSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.
 








Class com.amazonaws.services.devicefarm.model.GetRemoteAccessSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


remoteAccessSession
RemoteAccessSession remoteAccessSession

 A container that lists detailed information about the remote access session.
 








Class com.amazonaws.services.devicefarm.model.GetRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The run's ARN.
 








Class com.amazonaws.services.devicefarm.model.GetRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


run
Run run

 The run to get results from.
 








Class com.amazonaws.services.devicefarm.model.GetSuiteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The suite's ARN.
 








Class com.amazonaws.services.devicefarm.model.GetSuiteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


suite
Suite suite

 A collection of one or more tests.
 








Class com.amazonaws.services.devicefarm.model.GetTestGridProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectArn
String projectArn

 The ARN of the Selenium testing project, from either CreateTestGridProject or ListTestGridProjects.
 








Class com.amazonaws.services.devicefarm.model.GetTestGridProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


testGridProject
TestGridProject testGridProject

 A TestGridProject.
 








Class com.amazonaws.services.devicefarm.model.GetTestGridSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectArn
String projectArn

 The ARN for the project that this session belongs to. See CreateTestGridProject and
 ListTestGridProjects.
 


sessionId
String sessionId

 An ID associated with this session.
 


sessionArn
String sessionArn

 An ARN that uniquely identifies a TestGridSession.
 








Class com.amazonaws.services.devicefarm.model.GetTestGridSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


testGridSession
TestGridSession testGridSession

 The TestGridSession that was requested.
 








Class com.amazonaws.services.devicefarm.model.GetTestRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The test's ARN.
 








Class com.amazonaws.services.devicefarm.model.GetTestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


test
Test test

 A test condition that is evaluated.
 








Class com.amazonaws.services.devicefarm.model.GetUploadRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The upload's ARN.
 








Class com.amazonaws.services.devicefarm.model.GetUploadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


upload
Upload upload

 An app or a set of one or more tests to upload or that have been uploaded.
 








Class com.amazonaws.services.devicefarm.model.GetVPCEConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.
 








Class com.amazonaws.services.devicefarm.model.GetVPCEConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpceConfiguration
VPCEConfiguration vpceConfiguration

 An object that contains information about your VPC endpoint configuration.
 








Class com.amazonaws.services.devicefarm.model.IdempotencyException extends AWSDeviceFarmException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.devicefarm.model.IncompatibilityMessage extends Object implements Serializable


Serialized Fields


message
String message

 A message about the incompatibility.
 


type
String type

 The type of incompatibility.
 
 
 Allowed values include:
 
 
 
 
 ARN
 
 
 
 
 FORM_FACTOR (for example, phone or tablet)
 
 
 
 
 MANUFACTURER
 
 
 
 
 PLATFORM (for example, Android or iOS)
 
 
 
 
 REMOTE_ACCESS_ENABLED
 
 
 
 
 APPIUM_VERSION
 
 
 








Class com.amazonaws.services.devicefarm.model.InstallToRemoteAccessSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


remoteAccessSessionArn
String remoteAccessSessionArn

 The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.
 


appArn
String appArn

 The ARN of the app about which you are requesting information.
 








Class com.amazonaws.services.devicefarm.model.InstallToRemoteAccessSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appUpload
Upload appUpload

 An app to upload or that has been uploaded.
 








Class com.amazonaws.services.devicefarm.model.InstanceProfile extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the instance profile.
 


packageCleanup
Boolean packageCleanup

 When set to true, Device Farm removes app packages after a test run. The default value is
 false for private devices.
 


excludeAppPackagesFromCleanup
List<E> excludeAppPackagesFromCleanup

 An array of strings containing the list of app packages that should not be cleaned up from the device after a
 test run completes.
 
 
 The list of packages is considered only if you set packageCleanup to true.
 


rebootAfterUse
Boolean rebootAfterUse

 When set to true, Device Farm reboots the instance after a test run. The default value is
 true.
 


name
String name

 The name of the instance profile.
 


description
String description

 The description of the instance profile.
 








Class com.amazonaws.services.devicefarm.model.InternalServiceException extends AWSDeviceFarmException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.devicefarm.model.InvalidOperationException extends AWSDeviceFarmException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.devicefarm.model.Job extends Object implements Serializable


Serialized Fields


arn
String arn

 The job's ARN.
 


name
String name

 The job's name.
 


type
String type

 The job's type.
 
 
 Allowed values include the following:
 
 
 
 
 BUILTIN_FUZZ
 
 
 
 
 BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing
 screenshots at the same time.
 
 
 
 
 APPIUM_JAVA_JUNIT
 
 
 
 
 APPIUM_JAVA_TESTNG
 
 
 
 
 APPIUM_PYTHON
 
 
 
 
 APPIUM_NODE
 
 
 
 
 APPIUM_RUBY
 
 
 
 
 APPIUM_WEB_JAVA_JUNIT
 
 
 
 
 APPIUM_WEB_JAVA_TESTNG
 
 
 
 
 APPIUM_WEB_PYTHON
 
 
 
 
 APPIUM_WEB_NODE
 
 
 
 
 APPIUM_WEB_RUBY
 
 
 
 
 CALABASH
 
 
 
 
 INSTRUMENTATION
 
 
 
 
 UIAUTOMATION
 
 
 
 
 UIAUTOMATOR
 
 
 
 
 XCTEST
 
 
 
 
 XCTEST_UI
 
 
 


created
Date created

 When the job was created.
 


status
String status

 The job's status.
 
 
 Allowed values include:
 
 
 
 
 PENDING
 
 
 
 
 PENDING_CONCURRENCY
 
 
 
 
 PENDING_DEVICE
 
 
 
 
 PROCESSING
 
 
 
 
 SCHEDULING
 
 
 
 
 PREPARING
 
 
 
 
 RUNNING
 
 
 
 
 COMPLETED
 
 
 
 
 STOPPING
 
 
 


result
String result

 The job's result.
 
 
 Allowed values include:
 
 
 
 
 PENDING
 
 
 
 
 PASSED
 
 
 
 
 WARNED
 
 
 
 
 FAILED
 
 
 
 
 SKIPPED
 
 
 
 
 ERRORED
 
 
 
 
 STOPPED
 
 
 


started
Date started

 The job's start time.
 


stopped
Date stopped

 The job's stop time.
 


counters
Counters counters

 The job's result counters.
 


message
String message

 A message about the job's result.
 


device
Device device

 The device (phone or tablet).
 


instanceArn
String instanceArn

 The ARN of the instance.
 


deviceMinutes
DeviceMinutes deviceMinutes

 Represents the total (metered or unmetered) minutes used by the job.
 


videoEndpoint
String videoEndpoint

 The endpoint for streaming device video.
 


videoCapture
Boolean videoCapture

 This value is set to true if video capture is enabled. Otherwise, it is set to false.
 








Class com.amazonaws.services.devicefarm.model.LimitExceededException extends AWSDeviceFarmException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.devicefarm.model.ListArtifactsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The run, job, suite, or test ARN.
 


type
String type

 The artifacts' type.
 
 
 Allowed values include:
 
 
 
 
 FILE
 
 
 
 
 LOG
 
 
 
 
 SCREENSHOT
 
 
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListArtifactsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


artifacts
List<E> artifacts

 Information about the artifacts.
 


nextToken
String nextToken

 If the number of items that are returned is significantly large, this is an identifier that is also returned. It
 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.ListDeviceInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 An integer that specifies the maximum number of items you want to return in the API response.
 


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.ListDeviceInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deviceInstances
List<E> deviceInstances

 An object that contains information about your device instances.
 


nextToken
String nextToken

 An identifier that can be used in the next call to this operation to return the next set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListDevicePoolsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The project ARN.
 


type
String type

 The device pools' type.
 
 
 Allowed values include:
 
 
 
 
 CURATED: A device pool that is created and managed by AWS Device Farm.
 
 
 
 
 PRIVATE: A device pool that is created and managed by the device pool developer.
 
 
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListDevicePoolsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devicePools
List<E> devicePools

 Information about the device pools.
 


nextToken
String nextToken

 If the number of items that are returned is significantly large, this is an identifier that is also returned. It
 can be used in a subsequent call to this operation to return the next set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListDevicesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the project.
 


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.
 


filters
List<E> filters

 Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.
 
 
 
 
 Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.
 
 
 Allowed values include:
 
 
 
 
 ARN: The Amazon Resource Name (ARN) of the device (for example,
 arn:aws:devicefarm:us-west-2::device:12345Example).
 
 
 
 
 PLATFORM: The device platform. Valid values are ANDROID or IOS.
 
 
 
 
 OS_VERSION: The operating system version (for example, 10.3.2).
 
 
 
 
 MODEL: The device model (for example, iPad 5th Gen).
 
 
 
 
 AVAILABILITY: The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or
 TEMPORARY_NOT_AVAILABLE.
 
 
 
 
 FORM_FACTOR: The device form factor. Valid values are PHONE or TABLET.
 
 
 
 
 MANUFACTURER: The device manufacturer (for example, Apple).
 
 
 
 
 REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
 
 
 
 
 REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE. Because
 remote debugging is no longer
 supported, this attribute is ignored.
 
 
 
 
 INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.
 
 
 
 
 INSTANCE_LABELS: The label of the device instance.
 
 
 
 
 FLEET_TYPE: The fleet type. Valid values are PUBLIC or PRIVATE.
 
 
 
 
 
 
 Operator: The filter operator.
 
 
 
 
 The EQUALS operator is available for every attribute except INSTANCE_LABELS.
 
 
 
 
 The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.
 
 
 
 
 The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN
 attributes.
 
 
 
 
 The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the
 OS_VERSION attribute.
 
 
 
 
 
 
 Values: An array of one or more filter values.
 
 
 
 
 The IN and NOT_IN operators take a values array that has one or more elements.
 
 
 
 
 The other operators require an array with a single element.
 
 
 
 
 In a request, the AVAILABILITY attribute takes the following values: AVAILABLE, HIGHLY_AVAILABLE, BUSY, or
 TEMPORARY_NOT_AVAILABLE.
 
 
 
 
 








Class com.amazonaws.services.devicefarm.model.ListDevicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devices
List<E> devices

 Information about the devices.
 


nextToken
String nextToken

 If the number of items that are returned is significantly large, this is an identifier that is also returned. It
 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.ListInstanceProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 An integer that specifies the maximum number of items you want to return in the API response.
 


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.ListInstanceProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceProfiles
List<E> instanceProfiles

 An object that contains information about your instance profiles.
 


nextToken
String nextToken

 An identifier that can be used in the next call to this operation to return the next set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The run's Amazon Resource Name (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.
 








Class com.amazonaws.services.devicefarm.model.ListJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobs
List<E> jobs

 Information about the jobs.
 


nextToken
String nextToken

 If the number of items that are returned is significantly large, this is an identifier that is also returned. It
 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.ListNetworkProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the project for which you want to list network profiles.
 


type
String type

 The type of network profile to return information about. Valid values are listed here.
 


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.ListNetworkProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networkProfiles
List<E> networkProfiles

 A list of the available network profiles.
 


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.ListOfferingPromotionsRequest 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.ListOfferingPromotionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


offeringPromotions
List<E> offeringPromotions

 Information about the offering promotions.
 


nextToken
String nextToken

 An identifier to be used in the next call to this operation, to return the next set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListOfferingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListOfferingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


offerings
List<E> offerings

 A value that represents the list offering results.
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListOfferingTransactionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListOfferingTransactionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


offeringTransactions
List<E> offeringTransactions

 The audit log of subscriptions you have purchased and modified through AWS Device Farm.
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListProjectsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for
 the AWS account. You can also specify a 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.
 








Class com.amazonaws.services.devicefarm.model.ListProjectsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


projects
List<E> projects

 Information about the projects.
 


nextToken
String nextToken

 If the number of items that are returned is significantly large, this is an identifier that is also returned. It
 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.ListRemoteAccessSessionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the project about which you are requesting information.
 


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.ListRemoteAccessSessionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


remoteAccessSessions
List<E> remoteAccessSessions

 A container that represents the metadata from the service about each remote access session you are requesting.
 


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.ListRunsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the project for which you want to list runs.
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListRunsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


runs
List<E> runs

 Information about the runs.
 


nextToken
String nextToken

 If the number of items that are returned is significantly large, this is an identifier that is also returned. It
 can be used in a subsequent call to this operation to return the next set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListSamplesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the job used to list samples.
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListSamplesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


samples
List<E> samples

 Information about the samples.
 


nextToken
String nextToken

 If the number of items that are returned is significantly large, this is an identifier that is also returned. It
 can be used in a subsequent call to this operation to return the next set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListSuitesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The job's Amazon Resource Name (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.
 








Class com.amazonaws.services.devicefarm.model.ListSuitesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


suites
List<E> suites

 Information about the suites.
 


nextToken
String nextToken

 If the number of items that are returned is significantly large, this is an identifier that is also returned. It
 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.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the resource or resources for which to list tags. You can associate tags with
 the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE,
 INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL,
 DEVICE, and VPCE_CONFIGURATION.
 








Class com.amazonaws.services.devicefarm.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character
 length of 128 characters. Tag values can have a maximum length of 256 characters.
 








Class com.amazonaws.services.devicefarm.model.ListTestGridProjectsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResult
Integer maxResult

 Return no more than this number of results.
 


nextToken
String nextToken

 From a response, used to continue a paginated listing.
 








Class com.amazonaws.services.devicefarm.model.ListTestGridProjectsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


testGridProjects
List<E> testGridProjects

 The list of TestGridProjects, based on a ListTestGridProjectsRequest.
 


nextToken
String nextToken

 Used for pagination. Pass into ListTestGridProjects to get more results in a paginated request.
 








Class com.amazonaws.services.devicefarm.model.ListTestGridSessionActionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sessionArn
String sessionArn

 The ARN of the session to retrieve.
 


maxResult
Integer maxResult

 The maximum number of sessions to return per response.
 


nextToken
String nextToken

 Pagination token.
 








Class com.amazonaws.services.devicefarm.model.ListTestGridSessionActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


actions
List<E> actions

 The action taken by the session.
 


nextToken
String nextToken

 Pagination token.
 








Class com.amazonaws.services.devicefarm.model.ListTestGridSessionArtifactsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sessionArn
String sessionArn

 The ARN of a TestGridSession.
 


type
String type

 Limit results to a specified type of artifact.
 


maxResult
Integer maxResult

 The maximum number of results to be returned by a request.
 


nextToken
String nextToken

 Pagination token.
 








Class com.amazonaws.services.devicefarm.model.ListTestGridSessionArtifactsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


artifacts
List<E> artifacts

 A list of test grid session artifacts for a TestGridSession.
 


nextToken
String nextToken

 Pagination token.
 








Class com.amazonaws.services.devicefarm.model.ListTestGridSessionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectArn
String projectArn

 ARN of a TestGridProject.
 


status
String status

 Return only sessions in this state.
 


creationTimeAfter
Date creationTimeAfter

 Return only sessions created after this time.
 


creationTimeBefore
Date creationTimeBefore

 Return only sessions created before this time.
 


endTimeAfter
Date endTimeAfter

 Return only sessions that ended after this time.
 


endTimeBefore
Date endTimeBefore

 Return only sessions that ended before this time.
 


maxResult
Integer maxResult

 Return only this many results at a time.
 


nextToken
String nextToken

 Pagination token.
 








Class com.amazonaws.services.devicefarm.model.ListTestGridSessionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


testGridSessions
List<E> testGridSessions

 The sessions that match the criteria in a ListTestGridSessionsRequest.
 


nextToken
String nextToken

 Pagination token.
 








Class com.amazonaws.services.devicefarm.model.ListTestsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The test suite's Amazon Resource Name (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.
 








Class com.amazonaws.services.devicefarm.model.ListTestsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tests
List<E> tests

 Information about the tests.
 


nextToken
String nextToken

 If the number of items that are returned is significantly large, this is an identifier that is also returned. It
 can be used in a subsequent call to this operation to return the next set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListUniqueProblemsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The unique problems' ARNs.
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListUniqueProblemsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uniqueProblems
Map<K,V> uniqueProblems

 Information about the unique problems.
 
 
 Allowed values include:
 
 
 
 
 PENDING
 
 
 
 
 PASSED
 
 
 
 
 WARNED
 
 
 
 
 FAILED
 
 
 
 
 SKIPPED
 
 
 
 
 ERRORED
 
 
 
 
 STOPPED
 
 
 


nextToken
String nextToken

 If the number of items that are returned is significantly large, this is an identifier that is also returned. It
 can be used in a subsequent call to this operation to return the next set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListUploadsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the project for which you want to list uploads.
 


type
String type

 The type of upload.
 
 
 Must be one of the following values:
 
 
 
 
 ANDROID_APP
 
 
 
 
 IOS_APP
 
 
 
 
 WEB_APP
 
 
 
 
 EXTERNAL_DATA
 
 
 
 
 APPIUM_JAVA_JUNIT_TEST_PACKAGE
 
 
 
 
 APPIUM_JAVA_TESTNG_TEST_PACKAGE
 
 
 
 
 APPIUM_PYTHON_TEST_PACKAGE
 
 
 
 
 APPIUM_NODE_TEST_PACKAGE
 
 
 
 
 APPIUM_RUBY_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_PYTHON_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_NODE_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_RUBY_TEST_PACKAGE
 
 
 
 
 CALABASH_TEST_PACKAGE
 
 
 
 
 INSTRUMENTATION_TEST_PACKAGE
 
 
 
 
 UIAUTOMATION_TEST_PACKAGE
 
 
 
 
 UIAUTOMATOR_TEST_PACKAGE
 
 
 
 
 XCTEST_TEST_PACKAGE
 
 
 
 
 XCTEST_UI_TEST_PACKAGE
 
 
 
 
 APPIUM_JAVA_JUNIT_TEST_SPEC
 
 
 
 
 APPIUM_JAVA_TESTNG_TEST_SPEC
 
 
 
 
 APPIUM_PYTHON_TEST_SPEC
 
 
 
 
 APPIUM_NODE_TEST_SPEC
 
 
 
 
 APPIUM_RUBY_TEST_SPEC
 
 
 
 
 APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
 
 
 
 
 APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
 
 
 
 
 APPIUM_WEB_PYTHON_TEST_SPEC
 
 
 
 
 APPIUM_WEB_NODE_TEST_SPEC
 
 
 
 
 APPIUM_WEB_RUBY_TEST_SPEC
 
 
 
 
 INSTRUMENTATION_TEST_SPEC
 
 
 
 
 XCTEST_UI_TEST_SPEC
 
 
 


nextToken
String nextToken

 An identifier that was returned from the previous call to this operation, which can be used to return the next
 set of items in the list.
 








Class com.amazonaws.services.devicefarm.model.ListUploadsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uploads
List<E> uploads

 Information about the uploads.
 


nextToken
String nextToken

 If the number of items that are returned is significantly large, this is an identifier that is also returned. It
 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.ListVPCEConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 An integer that specifies the maximum number of items you want to return in the API response.
 


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.ListVPCEConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpceConfigurations
List<E> vpceConfigurations

 An array of VPCEConfiguration objects that contain information about your VPC endpoint
 configuration.
 


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.Location extends Object implements Serializable


Serialized Fields


latitude
Double latitude

 The latitude.
 


longitude
Double longitude

 The longitude.
 








Class com.amazonaws.services.devicefarm.model.MonetaryAmount extends Object implements Serializable


Serialized Fields


amount
Double amount

 The numerical amount of an offering or transaction.
 


currencyCode
String currencyCode

 The currency code of a monetary amount. For example, USD means U.S. dollars.
 








Class com.amazonaws.services.devicefarm.model.NetworkProfile extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the network profile.
 


name
String name

 The name of the network profile.
 


description
String description

 The description of the network profile.
 


type
String type

 The type of network profile. Valid values are listed here.
 


uplinkBandwidthBits
Long uplinkBandwidthBits

 The data throughput rate in bits per second, as an integer from 0 to 104857600.
 


downlinkBandwidthBits
Long downlinkBandwidthBits

 The data throughput rate in bits per second, as an integer from 0 to 104857600.
 


uplinkDelayMs
Long uplinkDelayMs

 Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
 


downlinkDelayMs
Long downlinkDelayMs

 Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
 


uplinkJitterMs
Long uplinkJitterMs

 Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
 


downlinkJitterMs
Long downlinkJitterMs

 Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
 


uplinkLossPercent
Integer uplinkLossPercent

 Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
 


downlinkLossPercent
Integer downlinkLossPercent

 Proportion of received packets that fail to arrive from 0 to 100 percent.
 








Class com.amazonaws.services.devicefarm.model.NotEligibleException extends AWSDeviceFarmException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.devicefarm.model.NotFoundException extends AWSDeviceFarmException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.devicefarm.model.Offering extends Object implements Serializable


Serialized Fields


id
String id

 The ID that corresponds to a device offering.
 


description
String description

 A string that describes the offering.
 


type
String type

 The type of offering (for example, RECURRING) for a device.
 


platform
String platform

 The platform of the device (for example, ANDROID or IOS).
 


recurringCharges
List<E> recurringCharges

 Specifies whether there are recurring charges for the offering.
 








Class com.amazonaws.services.devicefarm.model.OfferingPromotion extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the offering promotion.
 


description
String description

 A string that describes the offering promotion.
 








Class com.amazonaws.services.devicefarm.model.OfferingStatus extends Object implements Serializable


Serialized Fields


type
String type

 The type specified for the offering status.
 


offering
Offering offering

 Represents the metadata of an offering status.
 


quantity
Integer quantity

 The number of available devices in the offering.
 


effectiveOn
Date effectiveOn

 The date on which the offering is effective.
 








Class com.amazonaws.services.devicefarm.model.OfferingTransaction extends Object implements Serializable


Serialized Fields


offeringStatus
OfferingStatus offeringStatus

 The status of an offering transaction.
 


transactionId
String transactionId

 The transaction ID of the offering transaction.
 


offeringPromotionId
String offeringPromotionId

 The ID that corresponds to a device offering promotion.
 


createdOn
Date createdOn

 The date on which an offering transaction was created.
 


cost
MonetaryAmount cost

 The cost of an offering transaction.
 








Class com.amazonaws.services.devicefarm.model.Problem extends Object implements Serializable


Serialized Fields


run
ProblemDetail run

 Information about the associated run.
 


job
ProblemDetail job

 Information about the associated job.
 


suite
ProblemDetail suite

 Information about the associated suite.
 


test
ProblemDetail test

 Information about the associated test.
 


device
Device device

 Information about the associated device.
 


result
String result

 The problem's result.
 
 
 Allowed values include:
 
 
 
 
 PENDING
 
 
 
 
 PASSED
 
 
 
 
 WARNED
 
 
 
 
 FAILED
 
 
 
 
 SKIPPED
 
 
 
 
 ERRORED
 
 
 
 
 STOPPED
 
 
 


message
String message

 A message about the problem's result.
 








Class com.amazonaws.services.devicefarm.model.ProblemDetail extends Object implements Serializable


Serialized Fields


arn
String arn

 The problem detail's ARN.
 


name
String name

 The problem detail's name.
 








Class com.amazonaws.services.devicefarm.model.Project extends Object implements Serializable


Serialized Fields


arn
String arn

 The project's ARN.
 


name
String name

 The project's name.
 


defaultJobTimeoutMinutes
Integer defaultJobTimeoutMinutes

 The default number of minutes (at the project level) a test run executes before it times out. The default value
 is 150 minutes.
 


created
Date created

 When the project was created.
 








Class com.amazonaws.services.devicefarm.model.PurchaseOfferingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


offeringId
String offeringId

 The ID of the offering.
 


quantity
Integer quantity

 The number of device slots to purchase in an offering request.
 


offeringPromotionId
String offeringPromotionId

 The ID of the offering promotion to be applied to the purchase.
 








Class com.amazonaws.services.devicefarm.model.PurchaseOfferingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


offeringTransaction
OfferingTransaction offeringTransaction

 Represents the offering transaction for the purchase result.
 








Class com.amazonaws.services.devicefarm.model.Radios extends Object implements Serializable


Serialized Fields


wifi
Boolean wifi

 True if Wi-Fi is enabled at the beginning of the test. Otherwise, false.
 


bluetooth
Boolean bluetooth

 True if Bluetooth is enabled at the beginning of the test. Otherwise, false.
 


nfc
Boolean nfc

 True if NFC is enabled at the beginning of the test. Otherwise, false.
 


gps
Boolean gps

 True if GPS is enabled at the beginning of the test. Otherwise, false.
 








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


Serialized Fields


cost
MonetaryAmount cost

 The cost of the recurring charge.
 


frequency
String frequency

 The frequency in which charges recur.
 








Class com.amazonaws.services.devicefarm.model.RemoteAccessSession extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the remote access session.
 


name
String name

 The name of the remote access session.
 


created
Date created

 The date and time the remote access session was created.
 


status
String status

 The status of the remote access session. Can be any of the following:
 
 
 
 
 PENDING.
 
 
 
 
 PENDING_CONCURRENCY.
 
 
 
 
 PENDING_DEVICE.
 
 
 
 
 PROCESSING.
 
 
 
 
 SCHEDULING.
 
 
 
 
 PREPARING.
 
 
 
 
 RUNNING.
 
 
 
 
 COMPLETED.
 
 
 
 
 STOPPING.
 
 
 


result
String result

 The result of the remote access session. Can be any of the following:
 
 
 
 
 PENDING.
 
 
 
 
 PASSED.
 
 
 
 
 WARNED.
 
 
 
 
 FAILED.
 
 
 
 
 SKIPPED.
 
 
 
 
 ERRORED.
 
 
 
 
 STOPPED.
 
 
 


message
String message

 A message about the remote access session.
 


started
Date started

 The date and time the remote access session was started.
 


stopped
Date stopped

 The date and time the remote access session was stopped.
 


device
Device device

 The device (phone or tablet) used in the remote access session.
 


instanceArn
String instanceArn

 The ARN of the instance.
 


remoteDebugEnabled
Boolean remoteDebugEnabled

 This flag is set to true if remote debugging is enabled for the remote access session.
 
 
 Remote debugging is no longer
 supported.
 


remoteRecordEnabled
Boolean remoteRecordEnabled

 This flag is set to true if remote recording is enabled for the remote access session.
 


remoteRecordAppArn
String remoteRecordAppArn

 The ARN for the app to be recorded in the remote access session.
 


hostAddress
String hostAddress

 IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging
 is enabled for the remote access session.
 
 
 Remote debugging is no longer
 supported.
 


clientId
String clientId

 Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for
 the remote access session.
 
 
 Remote debugging is no longer
 supported.
 


billingMethod
String billingMethod

 The billing method of the remote access session. Possible values include METERED or
 UNMETERED. For more information about metered devices, see AWS Device
 Farm terminology.
 


deviceMinutes
DeviceMinutes deviceMinutes

 The number of minutes a device is used in a remote access session (including setup and teardown minutes).
 


endpoint
String endpoint

 The endpoint for the remote access sesssion.
 


deviceUdid
String deviceUdid

 Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote
 access session.
 
 
 Remote debugging is no longer
 supported.
 


interactionMode
String interactionMode

 The interaction mode of the remote access session. Valid values are:
 
 
 
 
 INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run
 XCUITest framework-based tests in this mode.
 
 
 
 
 NO_VIDEO: You are connected to the device, but cannot interact with it or view the screen. This mode has the
 fastest test execution speed. You can run XCUITest framework-based tests in this mode.
 
 
 
 
 VIDEO_ONLY: You can view the screen, but cannot touch or rotate it. You can run XCUITest framework-based tests
 and watch the screen in this mode.
 
 
 


skipAppResign
Boolean skipAppResign

 When set to true, for private devices, Device Farm does not sign your app again. For public devices,
 Device Farm always signs your apps again.
 
 
 For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.
 








Class com.amazonaws.services.devicefarm.model.RenewOfferingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


offeringId
String offeringId

 The ID of a request to renew an offering.
 


quantity
Integer quantity

 The quantity requested in an offering renewal.
 








Class com.amazonaws.services.devicefarm.model.RenewOfferingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


offeringTransaction
OfferingTransaction offeringTransaction

 Represents the status of the offering transaction for the renewal.
 








Class com.amazonaws.services.devicefarm.model.Resolution extends Object implements Serializable


Serialized Fields


width
Integer width

 The screen resolution's width, expressed in pixels.
 


height
Integer height

 The screen resolution's height, expressed in pixels.
 








Class com.amazonaws.services.devicefarm.model.Rule extends Object implements Serializable


Serialized Fields


attribute
String attribute

 The rule's stringified attribute. For example, specify the value as "\"abc\"".
 
 
 The supported operators for each attribute are provided in the following list.
 
 
 APPIUM_VERSION
 
 
 The Appium version for the test.
 
 
 Supported operators: CONTAINS
 
 
 ARN
 
 
 The Amazon Resource Name (ARN) of the device (for example,
 arn:aws:devicefarm:us-west-2::device:12345Example.
 
 
 Supported operators: EQUALS, IN, NOT_IN
 
 
 AVAILABILITY
 
 
 The current availability of the device. Valid values are AVAILABLE, HIGHLY_AVAILABLE, BUSY, or
 TEMPORARY_NOT_AVAILABLE.
 
 
 Supported operators: EQUALS
 
 
 FLEET_TYPE
 
 
 The fleet type. Valid values are PUBLIC or PRIVATE.
 
 
 Supported operators: EQUALS
 
 
 FORM_FACTOR
 
 
 The device form factor. Valid values are PHONE or TABLET.
 
 
 Supported operators: EQUALS, IN, NOT_IN
 
 
 INSTANCE_ARN
 
 
 The Amazon Resource Name (ARN) of the device instance.
 
 
 Supported operators: IN, NOT_IN
 
 
 INSTANCE_LABELS
 
 
 The label of the device instance.
 
 
 Supported operators: CONTAINS
 
 
 MANUFACTURER
 
 
 The device manufacturer (for example, Apple).
 
 
 Supported operators: EQUALS, IN, NOT_IN
 
 
 MODEL
 
 
 The device model, such as Apple iPad Air 2 or Google Pixel.
 
 
 Supported operators: CONTAINS, EQUALS, IN, NOT_IN
 
 
 OS_VERSION
 
 
 The operating system version (for example, 10.3.2).
 
 
 Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS,
 IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN
 
 
 PLATFORM
 
 
 The device platform. Valid values are ANDROID or IOS.
 
 
 Supported operators: EQUALS, IN, NOT_IN
 
 
 REMOTE_ACCESS_ENABLED
 
 
 Whether the device is enabled for remote access. Valid values are TRUE or FALSE.
 
 
 Supported operators: EQUALS
 
 
 REMOTE_DEBUG_ENABLED
 
 
 Whether the device is enabled for remote debugging. Valid values are TRUE or FALSE.
 
 
 Supported operators: EQUALS
 
 
 Because remote debugging is no longer supported, this
 filter is ignored.
 
 
 


operator
String operator

 Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by
 each attribute, see the attribute descriptions.
 


value
String value

 The rule's value.
 








Class com.amazonaws.services.devicefarm.model.Run extends Object implements Serializable


Serialized Fields


arn
String arn

 The run's ARN.
 


name
String name

 The run's name.
 


type
String type

 The run's type.
 
 
 Must be one of the following values:
 
 
 
 
 BUILTIN_FUZZ
 
 
 
 
 BUILTIN_EXPLORER
 
 
 
 For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the
 same time.
 
 
 
 
 APPIUM_JAVA_JUNIT
 
 
 
 
 APPIUM_JAVA_TESTNG
 
 
 
 
 APPIUM_PYTHON
 
 
 
 
 APPIUM_NODE
 
 
 
 
 APPIUM_RUBY
 
 
 
 
 APPIUM_WEB_JAVA_JUNIT
 
 
 
 
 APPIUM_WEB_JAVA_TESTNG
 
 
 
 
 APPIUM_WEB_PYTHON
 
 
 
 
 APPIUM_WEB_NODE
 
 
 
 
 APPIUM_WEB_RUBY
 
 
 
 
 CALABASH
 
 
 
 
 INSTRUMENTATION
 
 
 
 
 UIAUTOMATION
 
 
 
 
 UIAUTOMATOR
 
 
 
 
 XCTEST
 
 
 
 
 XCTEST_UI
 
 
 


platform
String platform

 The run's platform.
 
 
 Allowed values include:
 
 
 
 
 ANDROID
 
 
 
 
 IOS
 
 
 


created
Date created

 When the run was created.
 


status
String status

 The run's status.
 
 
 Allowed values include:
 
 
 
 
 PENDING
 
 
 
 
 PENDING_CONCURRENCY
 
 
 
 
 PENDING_DEVICE
 
 
 
 
 PROCESSING
 
 
 
 
 SCHEDULING
 
 
 
 
 PREPARING
 
 
 
 
 RUNNING
 
 
 
 
 COMPLETED
 
 
 
 
 STOPPING
 
 
 


result
String result

 The run's result.
 
 
 Allowed values include:
 
 
 
 
 PENDING
 
 
 
 
 PASSED
 
 
 
 
 WARNED
 
 
 
 
 FAILED
 
 
 
 
 SKIPPED
 
 
 
 
 ERRORED
 
 
 
 
 STOPPED
 
 
 


started
Date started

 The run's start time.
 


stopped
Date stopped

 The run's stop time.
 


counters
Counters counters

 The run's result counters.
 


message
String message

 A message about the run's result.
 


totalJobs
Integer totalJobs

 The total number of jobs for the run.
 


completedJobs
Integer completedJobs

 The total number of completed jobs.
 


billingMethod
String billingMethod

 Specifies the billing method for a test run: metered or unmetered. If the parameter is
 not specified, the default value is metered.
 
 
 
 If you have unmetered device slots, you must set this to unmetered to use them. Otherwise, the run
 is counted toward metered device minutes.
 
 


deviceMinutes
DeviceMinutes deviceMinutes

 Represents the total (metered or unmetered) minutes used by the test run.
 


networkProfile
NetworkProfile networkProfile

 The network profile being used for a test run.
 


parsingResultUrl
String parsingResultUrl

 Read-only URL for an object in an S3 bucket where you can get the parsing results of the test package. If the
 test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.
 


resultCode
String resultCode

 Supporting field for the result field. Set only if result is SKIPPED.
 PARSING_FAILED if the result is skipped because of test package parsing failure.
 


seed
Integer seed

 For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests
 ensures identical event sequences.
 


appUpload
String appUpload

 An app to upload or that has been uploaded.
 


eventCount
Integer eventCount

 For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.
 


jobTimeoutMinutes
Integer jobTimeoutMinutes

 The number of minutes the job executes before it times out.
 


devicePoolArn
String devicePoolArn

 The ARN of the device pool for the run.
 


locale
String locale

 Information about the locale that is used for the run.
 


radios
Radios radios

 Information about the radio states for the run.
 


location
Location location

 Information about the location that is used for the run.
 


customerArtifactPaths
CustomerArtifactPaths customerArtifactPaths

 Output CustomerArtifactPaths object for the test run.
 


webUrl
String webUrl

 The Device Farm console URL for the recording of the run.
 


skipAppResign
Boolean skipAppResign

 When set to true, for private devices, Device Farm does not sign your app again. For public devices,
 Device Farm always signs your apps again.
 
 
 For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.
 


testSpecArn
String testSpecArn

 The ARN of the YAML-formatted test specification for the run.
 


deviceSelectionResult
DeviceSelectionResult deviceSelectionResult

 The results of a device filter used to select the devices for a test run.
 








Class com.amazonaws.services.devicefarm.model.Sample extends Object implements Serializable


Serialized Fields


arn
String arn

 The sample's ARN.
 


type
String type

 The sample's type.
 
 
 Must be one of the following values:
 
 
 
 
 CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported
 by process, as a percentage.
 
 
 
 
 MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in
 kilobytes.
 
 
 
 
 NATIVE_AVG_DRAWTIME
 
 
 
 
 NATIVE_FPS
 
 
 
 
 NATIVE_FRAMES
 
 
 
 
 NATIVE_MAX_DRAWTIME
 
 
 
 
 NATIVE_MIN_DRAWTIME
 
 
 
 
 OPENGL_AVG_DRAWTIME
 
 
 
 
 OPENGL_FPS
 
 
 
 
 OPENGL_FRAMES
 
 
 
 
 OPENGL_MAX_DRAWTIME
 
 
 
 
 OPENGL_MIN_DRAWTIME
 
 
 
 
 RX
 
 
 
 
 RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process.
 
 
 
 
 THREADS: A threads sample type. This is expressed as the total number of threads per app process.
 
 
 
 
 TX
 
 
 
 
 TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.
 
 
 


url
String url

 The presigned Amazon S3 URL that can be used with a GET request to download the sample's file.
 








Class com.amazonaws.services.devicefarm.model.ScheduleRunConfiguration extends Object implements Serializable


Serialized Fields


extraDataPackageArn
String extraDataPackageArn

 The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm extracts to external
 data for Android or the app's sandbox for iOS.
 


networkProfileArn
String networkProfileArn

 Reserved for internal use.
 


locale
String locale

 Information about the locale that is used for the run.
 


location
Location location

 Information about the location that is used for the run.
 


vpceConfigurationArns
List<E> vpceConfigurationArns

 An array of ARNs for your VPC endpoint configurations.
 


customerArtifactPaths
CustomerArtifactPaths customerArtifactPaths

 Input CustomerArtifactPaths object for the scheduled run configuration.
 


radios
Radios radios

 Information about the radio states for the run.
 


auxiliaryApps
List<E> auxiliaryApps

 A list of upload ARNs for app packages to be installed with your app.
 


billingMethod
String billingMethod

 Specifies the billing method for a test run: metered or unmetered. If the parameter is
 not specified, the default value is metered.
 
 
 
 If you have purchased unmetered device slots, you must set this parameter to unmetered to make use
 of them. Otherwise, your run counts against your metered time.
 
 








Class com.amazonaws.services.devicefarm.model.ScheduleRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectArn
String projectArn

 The ARN of the project for the run to be scheduled.
 


appArn
String appArn

 The ARN of an application package to run tests against, created with CreateUpload. See ListUploads.
 


devicePoolArn
String devicePoolArn

 The ARN of the device pool for the run to be scheduled.
 


deviceSelectionConfiguration
DeviceSelectionConfiguration deviceSelectionConfiguration

 The filter criteria used to dynamically select a set of devices for a test run and the maximum number of devices
 to be included in the run.
 
 
 Either  devicePoolArn  or  deviceSelectionConfiguration  is required in a
 request.
 


name
String name

 The name for the run to be scheduled.
 


test
ScheduleRunTest test

 Information about the test for the run to be scheduled.
 


configuration
ScheduleRunConfiguration configuration

 Information about the settings for the run to be scheduled.
 


executionConfiguration
ExecutionConfiguration executionConfiguration

 Specifies configuration information about a test run, such as the execution timeout (in minutes).
 








Class com.amazonaws.services.devicefarm.model.ScheduleRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


run
Run run

 Information about the scheduled run.
 








Class com.amazonaws.services.devicefarm.model.ScheduleRunTest extends Object implements Serializable


Serialized Fields


type
String type

 The test's type.
 
 
 Must be one of the following values:
 
 
 
 
 BUILTIN_FUZZ
 
 
 
 
 BUILTIN_EXPLORER. For Android, an app explorer that traverses an Android app, interacting with it and capturing
 screenshots at the same time.
 
 
 
 
 APPIUM_JAVA_JUNIT
 
 
 
 
 APPIUM_JAVA_TESTNG
 
 
 
 
 APPIUM_PYTHON
 
 
 
 
 APPIUM_NODE
 
 
 
 
 APPIUM_RUBY
 
 
 
 
 APPIUM_WEB_JAVA_JUNIT
 
 
 
 
 APPIUM_WEB_JAVA_TESTNG
 
 
 
 
 APPIUM_WEB_PYTHON
 
 
 
 
 APPIUM_WEB_NODE
 
 
 
 
 APPIUM_WEB_RUBY
 
 
 
 
 CALABASH
 
 
 
 
 INSTRUMENTATION
 
 
 
 
 UIAUTOMATION
 
 
 
 
 UIAUTOMATOR
 
 
 
 
 XCTEST
 
 
 
 
 XCTEST_UI
 
 
 


testPackageArn
String testPackageArn

 The ARN of the uploaded test to be run.
 


testSpecArn
String testSpecArn

 The ARN of the YAML-formatted test specification.
 


filter
String filter

 The test's filter.
 


parameters
Map<K,V> parameters

 The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by
 name-value pairs of strings.
 
 
 For all tests:
 
 
 
 
 app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to
 false to disable it.
 
 
 
 
 For Calabash tests:
 
 
 
 
 profile: A cucumber profile (for example, my_profile_name).
 
 
 
 
 tags: You can limit execution to features or scenarios that have (or don't have) certain tags (for example, @smoke
 or @smoke,~@wip).
 
 
 
 
 For Appium tests (all types):
 
 
 
 
 appium_version: The Appium version. Currently supported values are 1.6.5 (and later), latest, and default.
 
 
 
 
 latest runs the latest Appium version supported by Device Farm (1.9.1).
 
 
 
 
 For default, Device Farm selects a compatible version of Appium for the device. The current behavior is to run
 1.7.2 on Android devices and iOS 9 and earlier and 1.7.2 for iOS 10 and later.
 
 
 
 
 This behavior is subject to change.
 
 
 
 
 
 
 For fuzz tests (Android only):
 
 
 
 
 event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.
 
 
 
 
 throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.
 
 
 
 
 seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical
 event sequences.
 
 
 
 
 For Explorer tests:
 
 
 
 
 username: A user name to use if the Explorer encounters a login form. If not supplied, no user name is inserted.
 
 
 
 
 password: A password to use if the Explorer encounters a login form. If not supplied, no password is inserted.
 
 
 
 
 For Instrumentation:
 
 
 
 
 filter: A test filter string. Examples:
 
 
 
 
 Running a single test case: com.android.abc.Test1
 
 
 
 
 Running a single test: com.android.abc.Test1#smoke
 
 
 
 
 Running multiple tests: com.android.abc.Test1,com.android.abc.Test2
 
 
 
 
 
 
 For XCTest and XCTestUI:
 
 
 
 
 filter: A test filter string. Examples:
 
 
 
 
 Running a single test class: LoginTests
 
 
 
 
 Running a multiple test classes: LoginTests,SmokeTests
 
 
 
 
 Running a single test: LoginTests/testValid
 
 
 
 
 Running multiple tests: LoginTests/testValid,LoginTests/testInvalid
 
 
 
 
 
 
 For UIAutomator:
 
 
 
 
 filter: A test filter string. Examples:
 
 
 
 
 Running a single test case: com.android.abc.Test1
 
 
 
 
 Running a single test: com.android.abc.Test1#smoke
 
 
 
 
 Running multiple tests: com.android.abc.Test1,com.android.abc.Test2
 
 
 
 
 








Class com.amazonaws.services.devicefarm.model.ServiceAccountException extends AWSDeviceFarmException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.devicefarm.model.StopJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.
 








Class com.amazonaws.services.devicefarm.model.StopJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


job
Job job

 The job that was stopped.
 








Class com.amazonaws.services.devicefarm.model.StopRemoteAccessSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the remote access session to stop.
 








Class com.amazonaws.services.devicefarm.model.StopRemoteAccessSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


remoteAccessSession
RemoteAccessSession remoteAccessSession

 A container that represents the metadata from the service about the remote access session you are stopping.
 








Class com.amazonaws.services.devicefarm.model.StopRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 Represents the Amazon Resource Name (ARN) of the Device Farm run to stop.
 








Class com.amazonaws.services.devicefarm.model.StopRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


run
Run run

 The run that was stopped.
 








Class com.amazonaws.services.devicefarm.model.Suite extends Object implements Serializable


Serialized Fields


arn
String arn

 The suite's ARN.
 


name
String name

 The suite's name.
 


type
String type

 The suite's type.
 
 
 Must be one of the following values:
 
 
 
 
 BUILTIN_FUZZ
 
 
 
 
 BUILTIN_EXPLORER
 
 
 
 Only available for Android; an app explorer that traverses an Android app, interacting with it and capturing
 screenshots at the same time.
 
 
 
 
 APPIUM_JAVA_JUNIT
 
 
 
 
 APPIUM_JAVA_TESTNG
 
 
 
 
 APPIUM_PYTHON
 
 
 
 
 APPIUM_NODE
 
 
 
 
 APPIUM_RUBY
 
 
 
 
 APPIUM_WEB_JAVA_JUNIT
 
 
 
 
 APPIUM_WEB_JAVA_TESTNG
 
 
 
 
 APPIUM_WEB_PYTHON
 
 
 
 
 APPIUM_WEB_NODE
 
 
 
 
 APPIUM_WEB_RUBY
 
 
 
 
 CALABASH
 
 
 
 
 INSTRUMENTATION
 
 
 
 
 UIAUTOMATION
 
 
 
 
 UIAUTOMATOR
 
 
 
 
 XCTEST
 
 
 
 
 XCTEST_UI
 
 
 


created
Date created

 When the suite was created.
 


status
String status

 The suite's status.
 
 
 Allowed values include:
 
 
 
 
 PENDING
 
 
 
 
 PENDING_CONCURRENCY
 
 
 
 
 PENDING_DEVICE
 
 
 
 
 PROCESSING
 
 
 
 
 SCHEDULING
 
 
 
 
 PREPARING
 
 
 
 
 RUNNING
 
 
 
 
 COMPLETED
 
 
 
 
 STOPPING
 
 
 


result
String result

 The suite's result.
 
 
 Allowed values include:
 
 
 
 
 PENDING
 
 
 
 
 PASSED
 
 
 
 
 WARNED
 
 
 
 
 FAILED
 
 
 
 
 SKIPPED
 
 
 
 
 ERRORED
 
 
 
 
 STOPPED
 
 
 


started
Date started

 The suite's start time.
 


stopped
Date stopped

 The suite's stop time.
 


counters
Counters counters

 The suite's result counters.
 


message
String message

 A message about the suite's result.
 


deviceMinutes
DeviceMinutes deviceMinutes

 Represents the total (metered or unmetered) minutes used by the test suite.
 








Class com.amazonaws.services.devicefarm.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 One part of a key-value pair that makes up a tag. A key is a general label that acts like a category
 for more specific tag values.
 


value
String value

 The optional part of a key-value pair that makes up a tag. A value acts as a descriptor in a tag
 category (key).
 








Class com.amazonaws.services.devicefarm.model.TagOperationException extends AWSDeviceFarmException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceName
String resourceName








Class com.amazonaws.services.devicefarm.model.TagPolicyException extends AWSDeviceFarmException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceName
String resourceName








Class com.amazonaws.services.devicefarm.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the resource or resources to which to add tags. You can associate tags with the
 following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE,
 INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL,
 DEVICE, and VPCE_CONFIGURATION.
 


tags
List<E> tags

 The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character
 length of 128 characters. Tag values can have a maximum length of 256 characters.
 








Class com.amazonaws.services.devicefarm.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.devicefarm.model.Test extends Object implements Serializable


Serialized Fields


arn
String arn

 The test's ARN.
 


name
String name

 The test's name.
 


type
String type

 The test's type.
 
 
 Must be one of the following values:
 
 
 
 
 BUILTIN_FUZZ
 
 
 
 
 BUILTIN_EXPLORER
 
 
 
 For Android, an app explorer that traverses an Android app, interacting with it and capturing screenshots at the
 same time.
 
 
 
 
 APPIUM_JAVA_JUNIT
 
 
 
 
 APPIUM_JAVA_TESTNG
 
 
 
 
 APPIUM_PYTHON
 
 
 
 
 APPIUM_NODE
 
 
 
 
 APPIUM_RUBY
 
 
 
 
 APPIUM_WEB_JAVA_JUNIT
 
 
 
 
 APPIUM_WEB_JAVA_TESTNG
 
 
 
 
 APPIUM_WEB_PYTHON
 
 
 
 
 APPIUM_WEB_NODE
 
 
 
 
 APPIUM_WEB_RUBY
 
 
 
 
 CALABASH
 
 
 
 
 INSTRUMENTATION
 
 
 
 
 UIAUTOMATION
 
 
 
 
 UIAUTOMATOR
 
 
 
 
 XCTEST
 
 
 
 
 XCTEST_UI
 
 
 


created
Date created

 When the test was created.
 


status
String status

 The test's status.
 
 
 Allowed values include:
 
 
 
 
 PENDING
 
 
 
 
 PENDING_CONCURRENCY
 
 
 
 
 PENDING_DEVICE
 
 
 
 
 PROCESSING
 
 
 
 
 SCHEDULING
 
 
 
 
 PREPARING
 
 
 
 
 RUNNING
 
 
 
 
 COMPLETED
 
 
 
 
 STOPPING
 
 
 


result
String result

 The test's result.
 
 
 Allowed values include:
 
 
 
 
 PENDING
 
 
 
 
 PASSED
 
 
 
 
 WARNED
 
 
 
 
 FAILED
 
 
 
 
 SKIPPED
 
 
 
 
 ERRORED
 
 
 
 
 STOPPED
 
 
 


started
Date started

 The test's start time.
 


stopped
Date stopped

 The test's stop time.
 


counters
Counters counters

 The test's result counters.
 


message
String message

 A message about the test's result.
 


deviceMinutes
DeviceMinutes deviceMinutes

 Represents the total (metered or unmetered) minutes used by the test.
 








Class com.amazonaws.services.devicefarm.model.TestGridProject extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN for the project.
 


name
String name

 A human-readable name for the project.
 


description
String description

 A human-readable description for the project.
 


created
Date created

 When the project was created.
 








Class com.amazonaws.services.devicefarm.model.TestGridSession extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the session.
 


status
String status

 The state of the session.
 


created
Date created

 The time that the session was started.
 


ended
Date ended

 The time the session ended.
 


billingMinutes
Double billingMinutes

 The number of billed minutes that were used for this session.
 


seleniumProperties
String seleniumProperties

 A JSON object of options and parameters passed to the Selenium WebDriver.
 








Class com.amazonaws.services.devicefarm.model.TestGridSessionAction extends Object implements Serializable


Serialized Fields


action
String action

 The action taken by the session.
 


started
Date started

 The time that the session invoked the action.
 


duration
Long duration

 The time, in milliseconds, that the action took to complete in the browser.
 


statusCode
String statusCode

 HTTP status code returned to the browser when the action was taken.
 


requestMethod
String requestMethod

 HTTP method that the browser used to make the request.
 








Class com.amazonaws.services.devicefarm.model.TestGridSessionArtifact extends Object implements Serializable


Serialized Fields


filename
String filename

 The file name of the artifact.
 


type
String type

 The kind of artifact.
 


url
String url

 A semi-stable URL to the content of the object.
 








Class com.amazonaws.services.devicefarm.model.TooManyTagsException extends AWSDeviceFarmException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceName
String resourceName








Class com.amazonaws.services.devicefarm.model.TrialMinutes extends Object implements Serializable


Serialized Fields


total
Double total

 The total number of free trial minutes that the account started with.
 


remaining
Double remaining

 The number of free trial minutes remaining in the account.
 








Class com.amazonaws.services.devicefarm.model.UniqueProblem extends Object implements Serializable


Serialized Fields


message
String message

 A message about the unique problems' result.
 


problems
List<E> problems

 Information about the problems.
 








Class com.amazonaws.services.devicefarm.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the resource or resources from which to delete tags. You can associate tags
 with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE,
 INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL,
 DEVICE, and VPCE_CONFIGURATION.
 


tagKeys
List<E> tagKeys

 The keys of the tags to be removed.
 








Class com.amazonaws.services.devicefarm.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.devicefarm.model.UpdateDeviceInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the device instance.
 


profileArn
String profileArn

 The ARN of the profile that you want to associate with the device instance.
 


labels
List<E> labels

 An array of strings that you want to associate with the device instance.
 








Class com.amazonaws.services.devicefarm.model.UpdateDeviceInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deviceInstance
DeviceInstance deviceInstance

 An object that contains information about your device instance.
 








Class com.amazonaws.services.devicefarm.model.UpdateDevicePoolRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the Device Farm device pool to update.
 


name
String name

 A string that represents the name of the device pool to update.
 


description
String description

 A description of the device pool to update.
 


rules
List<E> rules

 Represents the rules to modify for the device pool. Updating rules is optional. If you update rules for your
 request, the update replaces the existing rules.
 


maxDevices
Integer maxDevices

 The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available
 and that meet the criteria that you assign for the rules parameter. Depending on how many devices
 meet these constraints, your device pool might contain fewer devices than the value for this parameter.
 
 
 By specifying the maximum number of devices, you can control the costs that you incur by running tests.
 
 
 If you use this parameter in your request, you cannot use the clearMaxDevices parameter in the same
 request.
 


clearMaxDevices
Boolean clearMaxDevices

 Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to
 true, the maxDevices parameter does not apply, and Device Farm does not limit the
 number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that
 meet the criteria specified in the rules parameter.
 
 
 If you use this parameter in your request, you cannot use the maxDevices parameter in the same
 request.
 








Class com.amazonaws.services.devicefarm.model.UpdateDevicePoolResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devicePool
DevicePool devicePool

 The device pool you just updated.
 








Class com.amazonaws.services.devicefarm.model.UpdateInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the instance profile.
 


name
String name

 The updated name for your instance profile.
 


description
String description

 The updated description for your instance profile.
 


packageCleanup
Boolean packageCleanup

 The updated choice for whether you want to specify package cleanup. The default value is false for
 private devices.
 


excludeAppPackagesFromCleanup
List<E> excludeAppPackagesFromCleanup

 An array of strings that specifies the list of app packages that should not be cleaned up from the device after a
 test run is over.
 
 
 The list of packages is only considered if you set packageCleanup to true.
 


rebootAfterUse
Boolean rebootAfterUse

 The updated choice for whether you want to reboot the device after use. The default value is true.
 








Class com.amazonaws.services.devicefarm.model.UpdateInstanceProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceProfile
InstanceProfile instanceProfile

 An object that contains information about your instance profile.
 








Class com.amazonaws.services.devicefarm.model.UpdateNetworkProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.
 


name
String name

 The name of the network profile about which you are returning information.
 


description
String description

 The description of the network profile about which you are returning information.
 


type
String type

 The type of network profile to return information about. Valid values are listed here.
 


uplinkBandwidthBits
Long uplinkBandwidthBits

 The data throughput rate in bits per second, as an integer from 0 to 104857600.
 


downlinkBandwidthBits
Long downlinkBandwidthBits

 The data throughput rate in bits per second, as an integer from 0 to 104857600.
 


uplinkDelayMs
Long uplinkDelayMs

 Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
 


downlinkDelayMs
Long downlinkDelayMs

 Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.
 


uplinkJitterMs
Long uplinkJitterMs

 Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
 


downlinkJitterMs
Long downlinkJitterMs

 Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.
 


uplinkLossPercent
Integer uplinkLossPercent

 Proportion of transmitted packets that fail to arrive from 0 to 100 percent.
 


downlinkLossPercent
Integer downlinkLossPercent

 Proportion of received packets that fail to arrive from 0 to 100 percent.
 








Class com.amazonaws.services.devicefarm.model.UpdateNetworkProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networkProfile
NetworkProfile networkProfile

 A list of the available network profiles.
 








Class com.amazonaws.services.devicefarm.model.UpdateProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the project whose name to update.
 


name
String name

 A string that represents the new name of the project that you are updating.
 


defaultJobTimeoutMinutes
Integer defaultJobTimeoutMinutes

 The number of minutes a test run in the project executes before it times out.
 








Class com.amazonaws.services.devicefarm.model.UpdateProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


project
Project project

 The project to update.
 








Class com.amazonaws.services.devicefarm.model.UpdateTestGridProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectArn
String projectArn

 ARN of the project to update.
 


name
String name

 Human-readable name for the project.
 


description
String description

 Human-readable description for the project.
 








Class com.amazonaws.services.devicefarm.model.UpdateTestGridProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


testGridProject
TestGridProject testGridProject

 The project, including updated information.
 








Class com.amazonaws.services.devicefarm.model.UpdateUploadRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the uploaded test spec.
 


name
String name

 The upload's test spec file name. The name must not contain any forward slashes (/). The test spec file name must
 end with the .yaml or .yml file extension.
 


contentType
String contentType

 The upload's content type (for example, application/x-yaml).
 


editContent
Boolean editContent

 Set to true if the YAML file has changed and must be updated. Otherwise, set to false.
 








Class com.amazonaws.services.devicefarm.model.UpdateUploadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


upload
Upload upload

 A test spec uploaded to Device Farm.
 








Class com.amazonaws.services.devicefarm.model.UpdateVPCEConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.
 


vpceConfigurationName
String vpceConfigurationName

 The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.
 


vpceServiceName
String vpceServiceName

 The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.
 


serviceDnsName
String serviceDnsName

 The DNS (domain) name used to connect to your private service in your VPC. The DNS name must not already be in
 use on the internet.
 


vpceConfigurationDescription
String vpceConfigurationDescription

 An optional description that provides details about your VPC endpoint configuration.
 








Class com.amazonaws.services.devicefarm.model.UpdateVPCEConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpceConfiguration
VPCEConfiguration vpceConfiguration

 An object that contains information about your VPC endpoint configuration.
 








Class com.amazonaws.services.devicefarm.model.Upload extends Object implements Serializable


Serialized Fields


arn
String arn

 The upload's ARN.
 


name
String name

 The upload's file name.
 


created
Date created

 When the upload was created.
 


type
String type

 The upload's type.
 
 
 Must be one of the following values:
 
 
 
 
 ANDROID_APP
 
 
 
 
 IOS_APP
 
 
 
 
 WEB_APP
 
 
 
 
 EXTERNAL_DATA
 
 
 
 
 APPIUM_JAVA_JUNIT_TEST_PACKAGE
 
 
 
 
 APPIUM_JAVA_TESTNG_TEST_PACKAGE
 
 
 
 
 APPIUM_PYTHON_TEST_PACKAGE
 
 
 
 
 APPIUM_NODE_TEST_PACKAGE
 
 
 
 
 APPIUM_RUBY_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_PYTHON_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_NODE_TEST_PACKAGE
 
 
 
 
 APPIUM_WEB_RUBY_TEST_PACKAGE
 
 
 
 
 CALABASH_TEST_PACKAGE
 
 
 
 
 INSTRUMENTATION_TEST_PACKAGE
 
 
 
 
 UIAUTOMATION_TEST_PACKAGE
 
 
 
 
 UIAUTOMATOR_TEST_PACKAGE
 
 
 
 
 XCTEST_TEST_PACKAGE
 
 
 
 
 XCTEST_UI_TEST_PACKAGE
 
 
 
 
 APPIUM_JAVA_JUNIT_TEST_SPEC
 
 
 
 
 APPIUM_JAVA_TESTNG_TEST_SPEC
 
 
 
 
 APPIUM_PYTHON_TEST_SPEC
 
 
 
 
 APPIUM_NODE_TEST_SPEC
 
 
 
 
 APPIUM_RUBY_TEST_SPEC
 
 
 
 
 APPIUM_WEB_JAVA_JUNIT_TEST_SPEC
 
 
 
 
 APPIUM_WEB_JAVA_TESTNG_TEST_SPEC
 
 
 
 
 APPIUM_WEB_PYTHON_TEST_SPEC
 
 
 
 
 APPIUM_WEB_NODE_TEST_SPEC
 
 
 
 
 APPIUM_WEB_RUBY_TEST_SPEC
 
 
 
 
 INSTRUMENTATION_TEST_SPEC
 
 
 
 
 XCTEST_UI_TEST_SPEC
 
 
 


status
String status

 The upload's status.
 
 
 Must be one of the following values:
 
 
 
 
 FAILED
 
 
 
 
 INITIALIZED
 
 
 
 
 PROCESSING
 
 
 
 
 SUCCEEDED
 
 
 


url
String url

 The presigned Amazon S3 URL that was used to store a file using a PUT request.
 


metadata
String metadata

 The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and
 is displayed in the AWS Device Farm console after the associated app is uploaded.
 


contentType
String contentType

 The upload's content type (for example, application/octet-stream).
 


message
String message

 A message about the upload's result.
 


category
String category

 The upload's category. Allowed values include:
 
 
 
 
 CURATED: An upload managed by AWS Device Farm.
 
 
 
 
 PRIVATE: An upload managed by the AWS Device Farm customer.
 
 
 








Class com.amazonaws.services.devicefarm.model.VPCEConfiguration extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the VPC endpoint configuration.
 


vpceConfigurationName
String vpceConfigurationName

 The friendly name you give to your VPC endpoint configuration to manage your configurations more easily.
 


vpceServiceName
String vpceServiceName

 The name of the VPC endpoint service running in your AWS account that you want Device Farm to test.
 


serviceDnsName
String serviceDnsName

 The DNS name that maps to the private IP address of the service you want to access.
 


vpceConfigurationDescription
String vpceConfigurationDescription

 An optional description that provides details about your VPC endpoint configuration.
 








Package com.amazonaws.services.directconnect.model




Class com.amazonaws.services.directconnect.model.AcceptDirectConnectGatewayAssociationProposalRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


proposalId
String proposalId

 The ID of the request proposal.
 


associatedGatewayOwnerAccount
String associatedGatewayOwnerAccount

 The ID of the AWS account that owns the virtual private gateway or transit gateway.
 


overrideAllowedPrefixesToDirectConnectGateway
SdkInternalList<T> overrideAllowedPrefixesToDirectConnectGateway

 Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.
 
 
 For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.
 








Class com.amazonaws.services.directconnect.model.AcceptDirectConnectGatewayAssociationProposalResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directConnectGatewayAssociation
DirectConnectGatewayAssociation directConnectGatewayAssociation








Class com.amazonaws.services.directconnect.model.AllocateConnectionOnInterconnectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


bandwidth
String bandwidth

 The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps,
 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific
 requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
 


connectionName
String connectionName

 The name of the provisioned connection.
 


ownerAccount
String ownerAccount

 The ID of the AWS account of the customer for whom the connection will be provisioned.
 


interconnectId
String interconnectId

 The ID of the interconnect on which the connection will be provisioned.
 


vlan
Integer vlan

 The dedicated VLAN provisioned to the connection.
 








Class com.amazonaws.services.directconnect.model.AllocateConnectionOnInterconnectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


connectionName
String connectionName

 The name of the connection.
 


connectionState
String connectionState

 The state of the connection. The following are the possible values:
 
 
 
 
 ordering: The initial state of a hosted connection provisioned on an interconnect. The connection
 stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
 
 
 
 
 requested: The initial state of a standard connection. The connection stays in the requested state
 until the Letter of Authorization (LOA) is sent to the customer.
 
 
 
 
 pending: The connection has been approved and is being initialized.
 
 
 
 
 available: The network link is up and the connection is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The connection is being deleted.
 
 
 
 
 deleted: The connection has been deleted.
 
 
 
 
 rejected: A hosted connection in the ordering state enters the rejected
 state if it is deleted by the customer.
 
 
 
 
 unknown: The state of the connection is not available.
 
 
 


region
String region

 The AWS Region where the connection is located.
 


location
String location

 The location of the connection.
 


bandwidth
String bandwidth

 The bandwidth of the connection.
 


vlan
Integer vlan

 The ID of the VLAN.
 


partnerName
String partnerName

 The name of the AWS Direct Connect service provider associated with the connection.
 


loaIssueTime
Date loaIssueTime

 The time of the most recent call to DescribeLoa for this connection.
 


lagId
String lagId

 The ID of the LAG.
 


awsDevice
String awsDevice

 The Direct Connect endpoint on which the physical connection terminates.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the physical connection terminates.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the connection.
 


providerName
String providerName

 The name of the service provider associated with the connection.
 








Class com.amazonaws.services.directconnect.model.AllocateHostedConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the interconnect or LAG.
 


ownerAccount
String ownerAccount

 The ID of the AWS account ID of the customer for the connection.
 


bandwidth
String bandwidth

 The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps,
 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific
 requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
 


connectionName
String connectionName

 The name of the hosted connection.
 


vlan
Integer vlan

 The dedicated VLAN provisioned to the hosted connection.
 


tags
SdkInternalList<T> tags

 The tags associated with the connection.
 








Class com.amazonaws.services.directconnect.model.AllocateHostedConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


connectionName
String connectionName

 The name of the connection.
 


connectionState
String connectionState

 The state of the connection. The following are the possible values:
 
 
 
 
 ordering: The initial state of a hosted connection provisioned on an interconnect. The connection
 stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
 
 
 
 
 requested: The initial state of a standard connection. The connection stays in the requested state
 until the Letter of Authorization (LOA) is sent to the customer.
 
 
 
 
 pending: The connection has been approved and is being initialized.
 
 
 
 
 available: The network link is up and the connection is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The connection is being deleted.
 
 
 
 
 deleted: The connection has been deleted.
 
 
 
 
 rejected: A hosted connection in the ordering state enters the rejected
 state if it is deleted by the customer.
 
 
 
 
 unknown: The state of the connection is not available.
 
 
 


region
String region

 The AWS Region where the connection is located.
 


location
String location

 The location of the connection.
 


bandwidth
String bandwidth

 The bandwidth of the connection.
 


vlan
Integer vlan

 The ID of the VLAN.
 


partnerName
String partnerName

 The name of the AWS Direct Connect service provider associated with the connection.
 


loaIssueTime
Date loaIssueTime

 The time of the most recent call to DescribeLoa for this connection.
 


lagId
String lagId

 The ID of the LAG.
 


awsDevice
String awsDevice

 The Direct Connect endpoint on which the physical connection terminates.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the physical connection terminates.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the connection.
 


providerName
String providerName

 The name of the service provider associated with the connection.
 








Class com.amazonaws.services.directconnect.model.AllocatePrivateVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the connection on which the private virtual interface is provisioned.
 


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the virtual private interface.
 


newPrivateVirtualInterfaceAllocation
NewPrivateVirtualInterfaceAllocation newPrivateVirtualInterfaceAllocation

 Information about the private virtual interface.
 








Class com.amazonaws.services.directconnect.model.AllocatePrivateVirtualInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the virtual interface.
 


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


location
String location

 The location of the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


virtualInterfaceType
String virtualInterfaceType

 The type of virtual interface. The possible values are private and public.
 


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


amazonSideAsn
Long amazonSideAsn

 The autonomous system number (ASN) for the Amazon side of the connection.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


virtualInterfaceState
String virtualInterfaceState

 The state of the virtual interface. The following are the possible values:
 
 
 
 
 confirming: The creation of the virtual interface is pending confirmation from the virtual interface
 owner. If the owner of the virtual interface is different from the owner of the connection on which it is
 provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
 owner.
 
 
 
 
 verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
 validation before the virtual interface can be created.
 
 
 
 
 pending: A virtual interface is in this state from the time that it is created until the virtual
 interface is ready to forward traffic.
 
 
 
 
 available: A virtual interface that is able to forward traffic.
 
 
 
 
 down: A virtual interface that is BGP down.
 
 
 
 
 deleting: A virtual interface is in this state immediately after calling
 DeleteVirtualInterface until it can no longer forward traffic.
 
 
 
 
 deleted: A virtual interface that cannot forward traffic.
 
 
 
 
 rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
 interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
 enters the Rejected state.
 
 
 
 
 unknown: The state of the virtual interface is not available.
 
 
 


customerRouterConfig
String customerRouterConfig

 The customer router configuration.
 


mtu
Integer mtu

 The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway. Applies only to private virtual interfaces.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


routeFilterPrefixes
SdkInternalList<T> routeFilterPrefixes

 The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
 


bgpPeers
SdkInternalList<T> bgpPeers

 The BGP peers configured on this virtual interface.
 


region
String region

 The AWS Region where the virtual interface is located.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the virtual interface terminates.
 


tags
SdkInternalList<T> tags

 The tags associated with the virtual interface.
 








Class com.amazonaws.services.directconnect.model.AllocatePublicVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the connection on which the public virtual interface is provisioned.
 


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the public virtual interface.
 


newPublicVirtualInterfaceAllocation
NewPublicVirtualInterfaceAllocation newPublicVirtualInterfaceAllocation

 Information about the public virtual interface.
 








Class com.amazonaws.services.directconnect.model.AllocatePublicVirtualInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the virtual interface.
 


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


location
String location

 The location of the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


virtualInterfaceType
String virtualInterfaceType

 The type of virtual interface. The possible values are private and public.
 


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


amazonSideAsn
Long amazonSideAsn

 The autonomous system number (ASN) for the Amazon side of the connection.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


virtualInterfaceState
String virtualInterfaceState

 The state of the virtual interface. The following are the possible values:
 
 
 
 
 confirming: The creation of the virtual interface is pending confirmation from the virtual interface
 owner. If the owner of the virtual interface is different from the owner of the connection on which it is
 provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
 owner.
 
 
 
 
 verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
 validation before the virtual interface can be created.
 
 
 
 
 pending: A virtual interface is in this state from the time that it is created until the virtual
 interface is ready to forward traffic.
 
 
 
 
 available: A virtual interface that is able to forward traffic.
 
 
 
 
 down: A virtual interface that is BGP down.
 
 
 
 
 deleting: A virtual interface is in this state immediately after calling
 DeleteVirtualInterface until it can no longer forward traffic.
 
 
 
 
 deleted: A virtual interface that cannot forward traffic.
 
 
 
 
 rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
 interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
 enters the Rejected state.
 
 
 
 
 unknown: The state of the virtual interface is not available.
 
 
 


customerRouterConfig
String customerRouterConfig

 The customer router configuration.
 


mtu
Integer mtu

 The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway. Applies only to private virtual interfaces.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


routeFilterPrefixes
SdkInternalList<T> routeFilterPrefixes

 The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
 


bgpPeers
SdkInternalList<T> bgpPeers

 The BGP peers configured on this virtual interface.
 


region
String region

 The AWS Region where the virtual interface is located.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the virtual interface terminates.
 


tags
SdkInternalList<T> tags

 The tags associated with the virtual interface.
 








Class com.amazonaws.services.directconnect.model.AllocateTransitVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the connection on which the transit virtual interface is provisioned.
 


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the transit virtual interface.
 


newTransitVirtualInterfaceAllocation
NewTransitVirtualInterfaceAllocation newTransitVirtualInterfaceAllocation

 Information about the transit virtual interface.
 








Class com.amazonaws.services.directconnect.model.AllocateTransitVirtualInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualInterface
VirtualInterface virtualInterface








Class com.amazonaws.services.directconnect.model.AmazonDirectConnectException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.directconnect.model.AssociateConnectionWithLagRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the connection.
 


lagId
String lagId

 The ID of the LAG with which to associate the connection.
 








Class com.amazonaws.services.directconnect.model.AssociateConnectionWithLagResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


connectionName
String connectionName

 The name of the connection.
 


connectionState
String connectionState

 The state of the connection. The following are the possible values:
 
 
 
 
 ordering: The initial state of a hosted connection provisioned on an interconnect. The connection
 stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
 
 
 
 
 requested: The initial state of a standard connection. The connection stays in the requested state
 until the Letter of Authorization (LOA) is sent to the customer.
 
 
 
 
 pending: The connection has been approved and is being initialized.
 
 
 
 
 available: The network link is up and the connection is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The connection is being deleted.
 
 
 
 
 deleted: The connection has been deleted.
 
 
 
 
 rejected: A hosted connection in the ordering state enters the rejected
 state if it is deleted by the customer.
 
 
 
 
 unknown: The state of the connection is not available.
 
 
 


region
String region

 The AWS Region where the connection is located.
 


location
String location

 The location of the connection.
 


bandwidth
String bandwidth

 The bandwidth of the connection.
 


vlan
Integer vlan

 The ID of the VLAN.
 


partnerName
String partnerName

 The name of the AWS Direct Connect service provider associated with the connection.
 


loaIssueTime
Date loaIssueTime

 The time of the most recent call to DescribeLoa for this connection.
 


lagId
String lagId

 The ID of the LAG.
 


awsDevice
String awsDevice

 The Direct Connect endpoint on which the physical connection terminates.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the physical connection terminates.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the connection.
 


providerName
String providerName

 The name of the service provider associated with the connection.
 








Class com.amazonaws.services.directconnect.model.AssociatedGateway extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the associated gateway.
 


type
String type

 The type of associated gateway.
 


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the associated virtual private gateway or transit gateway.
 


region
String region

 The Region where the associated gateway is located.
 








Class com.amazonaws.services.directconnect.model.AssociateHostedConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the hosted connection.
 


parentConnectionId
String parentConnectionId

 The ID of the interconnect or the LAG.
 








Class com.amazonaws.services.directconnect.model.AssociateHostedConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


connectionName
String connectionName

 The name of the connection.
 


connectionState
String connectionState

 The state of the connection. The following are the possible values:
 
 
 
 
 ordering: The initial state of a hosted connection provisioned on an interconnect. The connection
 stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
 
 
 
 
 requested: The initial state of a standard connection. The connection stays in the requested state
 until the Letter of Authorization (LOA) is sent to the customer.
 
 
 
 
 pending: The connection has been approved and is being initialized.
 
 
 
 
 available: The network link is up and the connection is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The connection is being deleted.
 
 
 
 
 deleted: The connection has been deleted.
 
 
 
 
 rejected: A hosted connection in the ordering state enters the rejected
 state if it is deleted by the customer.
 
 
 
 
 unknown: The state of the connection is not available.
 
 
 


region
String region

 The AWS Region where the connection is located.
 


location
String location

 The location of the connection.
 


bandwidth
String bandwidth

 The bandwidth of the connection.
 


vlan
Integer vlan

 The ID of the VLAN.
 


partnerName
String partnerName

 The name of the AWS Direct Connect service provider associated with the connection.
 


loaIssueTime
Date loaIssueTime

 The time of the most recent call to DescribeLoa for this connection.
 


lagId
String lagId

 The ID of the LAG.
 


awsDevice
String awsDevice

 The Direct Connect endpoint on which the physical connection terminates.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the physical connection terminates.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the connection.
 


providerName
String providerName

 The name of the service provider associated with the connection.
 








Class com.amazonaws.services.directconnect.model.AssociateVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


connectionId
String connectionId

 The ID of the LAG or connection.
 








Class com.amazonaws.services.directconnect.model.AssociateVirtualInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the virtual interface.
 


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


location
String location

 The location of the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


virtualInterfaceType
String virtualInterfaceType

 The type of virtual interface. The possible values are private and public.
 


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


amazonSideAsn
Long amazonSideAsn

 The autonomous system number (ASN) for the Amazon side of the connection.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


virtualInterfaceState
String virtualInterfaceState

 The state of the virtual interface. The following are the possible values:
 
 
 
 
 confirming: The creation of the virtual interface is pending confirmation from the virtual interface
 owner. If the owner of the virtual interface is different from the owner of the connection on which it is
 provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
 owner.
 
 
 
 
 verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
 validation before the virtual interface can be created.
 
 
 
 
 pending: A virtual interface is in this state from the time that it is created until the virtual
 interface is ready to forward traffic.
 
 
 
 
 available: A virtual interface that is able to forward traffic.
 
 
 
 
 down: A virtual interface that is BGP down.
 
 
 
 
 deleting: A virtual interface is in this state immediately after calling
 DeleteVirtualInterface until it can no longer forward traffic.
 
 
 
 
 deleted: A virtual interface that cannot forward traffic.
 
 
 
 
 rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
 interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
 enters the Rejected state.
 
 
 
 
 unknown: The state of the virtual interface is not available.
 
 
 


customerRouterConfig
String customerRouterConfig

 The customer router configuration.
 


mtu
Integer mtu

 The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway. Applies only to private virtual interfaces.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


routeFilterPrefixes
SdkInternalList<T> routeFilterPrefixes

 The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
 


bgpPeers
SdkInternalList<T> bgpPeers

 The BGP peers configured on this virtual interface.
 


region
String region

 The AWS Region where the virtual interface is located.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the virtual interface terminates.
 


tags
SdkInternalList<T> tags

 The tags associated with the virtual interface.
 








Class com.amazonaws.services.directconnect.model.BGPPeer extends Object implements Serializable


Serialized Fields


bgpPeerId
String bgpPeerId

 The ID of the BGP peer.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


bgpPeerState
String bgpPeerState

 The state of the BGP peer. The following are the possible values:
 
 
 
 
 verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created.
 This state applies only to public virtual interfaces.
 
 
 
 
 pending: The BGP peer is created, and remains in this state until it is ready to be established.
 
 
 
 
 available: The BGP peer is ready to be established.
 
 
 
 
 deleting: The BGP peer is being deleted.
 
 
 
 
 deleted: The BGP peer is deleted and cannot be established.
 
 
 


bgpStatus
String bgpStatus

 The status of the BGP peer. The following are the possible values:
 
 
 
 
 up: The BGP peer is established. This state does not indicate the state of the routing function.
 Ensure that you are receiving routes over the BGP session.
 
 
 
 
 down: The BGP peer is down.
 
 
 
 
 unknown: The BGP peer status is not available.
 
 
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the BGP peer terminates.
 








Class com.amazonaws.services.directconnect.model.ConfirmConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the hosted connection.
 








Class com.amazonaws.services.directconnect.model.ConfirmConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectionState
String connectionState

 The state of the connection. The following are the possible values:
 
 
 
 
 ordering: The initial state of a hosted connection provisioned on an interconnect. The connection
 stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
 
 
 
 
 requested: The initial state of a standard connection. The connection stays in the requested state
 until the Letter of Authorization (LOA) is sent to the customer.
 
 
 
 
 pending: The connection has been approved and is being initialized.
 
 
 
 
 available: The network link is up and the connection is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The connection is being deleted.
 
 
 
 
 deleted: The connection has been deleted.
 
 
 
 
 rejected: A hosted connection in the ordering state enters the rejected
 state if it is deleted by the customer.
 
 
 
 
 unknown: The state of the connection is not available.
 
 
 








Class com.amazonaws.services.directconnect.model.ConfirmPrivateVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 








Class com.amazonaws.services.directconnect.model.ConfirmPrivateVirtualInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualInterfaceState
String virtualInterfaceState

 The state of the virtual interface. The following are the possible values:
 
 
 
 
 confirming: The creation of the virtual interface is pending confirmation from the virtual interface
 owner. If the owner of the virtual interface is different from the owner of the connection on which it is
 provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
 owner.
 
 
 
 
 verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
 validation before the virtual interface can be created.
 
 
 
 
 pending: A virtual interface is in this state from the time that it is created until the virtual
 interface is ready to forward traffic.
 
 
 
 
 available: A virtual interface that is able to forward traffic.
 
 
 
 
 down: A virtual interface that is BGP down.
 
 
 
 
 deleting: A virtual interface is in this state immediately after calling
 DeleteVirtualInterface until it can no longer forward traffic.
 
 
 
 
 deleted: A virtual interface that cannot forward traffic.
 
 
 
 
 rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
 interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
 enters the Rejected state.
 
 
 
 
 unknown: The state of the virtual interface is not available.
 
 
 








Class com.amazonaws.services.directconnect.model.ConfirmPublicVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 








Class com.amazonaws.services.directconnect.model.ConfirmPublicVirtualInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualInterfaceState
String virtualInterfaceState

 The state of the virtual interface. The following are the possible values:
 
 
 
 
 confirming: The creation of the virtual interface is pending confirmation from the virtual interface
 owner. If the owner of the virtual interface is different from the owner of the connection on which it is
 provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
 owner.
 
 
 
 
 verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
 validation before the virtual interface can be created.
 
 
 
 
 pending: A virtual interface is in this state from the time that it is created until the virtual
 interface is ready to forward traffic.
 
 
 
 
 available: A virtual interface that is able to forward traffic.
 
 
 
 
 down: A virtual interface that is BGP down.
 
 
 
 
 deleting: A virtual interface is in this state immediately after calling
 DeleteVirtualInterface until it can no longer forward traffic.
 
 
 
 
 deleted: A virtual interface that cannot forward traffic.
 
 
 
 
 rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
 interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
 enters the Rejected state.
 
 
 
 
 unknown: The state of the virtual interface is not available.
 
 
 








Class com.amazonaws.services.directconnect.model.ConfirmTransitVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 








Class com.amazonaws.services.directconnect.model.ConfirmTransitVirtualInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualInterfaceState
String virtualInterfaceState

 The state of the virtual interface. The following are the possible values:
 
 
 
 
 confirming: The creation of the virtual interface is pending confirmation from the virtual interface
 owner. If the owner of the virtual interface is different from the owner of the connection on which it is
 provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
 owner.
 
 
 
 
 verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
 validation before the virtual interface can be created.
 
 
 
 
 pending: A virtual interface is in this state from the time that it is created until the virtual
 interface is ready to forward traffic.
 
 
 
 
 available: A virtual interface that is able to forward traffic.
 
 
 
 
 down: A virtual interface that is BGP down.
 
 
 
 
 deleting: A virtual interface is in this state immediately after calling
 DeleteVirtualInterface until it can no longer forward traffic.
 
 
 
 
 deleted: A virtual interface that cannot forward traffic.
 
 
 
 
 rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
 interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
 enters the Rejected state.
 
 
 
 
 unknown: The state of the virtual interface is not available.
 
 
 








Class com.amazonaws.services.directconnect.model.Connection extends Object implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


connectionName
String connectionName

 The name of the connection.
 


connectionState
String connectionState

 The state of the connection. The following are the possible values:
 
 
 
 
 ordering: The initial state of a hosted connection provisioned on an interconnect. The connection
 stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
 
 
 
 
 requested: The initial state of a standard connection. The connection stays in the requested state
 until the Letter of Authorization (LOA) is sent to the customer.
 
 
 
 
 pending: The connection has been approved and is being initialized.
 
 
 
 
 available: The network link is up and the connection is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The connection is being deleted.
 
 
 
 
 deleted: The connection has been deleted.
 
 
 
 
 rejected: A hosted connection in the ordering state enters the rejected
 state if it is deleted by the customer.
 
 
 
 
 unknown: The state of the connection is not available.
 
 
 


region
String region

 The AWS Region where the connection is located.
 


location
String location

 The location of the connection.
 


bandwidth
String bandwidth

 The bandwidth of the connection.
 


vlan
Integer vlan

 The ID of the VLAN.
 


partnerName
String partnerName

 The name of the AWS Direct Connect service provider associated with the connection.
 


loaIssueTime
Date loaIssueTime

 The time of the most recent call to DescribeLoa for this connection.
 


lagId
String lagId

 The ID of the LAG.
 


awsDevice
String awsDevice

 The Direct Connect endpoint on which the physical connection terminates.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the physical connection terminates.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the connection.
 


providerName
String providerName

 The name of the service provider associated with the connection.
 








Class com.amazonaws.services.directconnect.model.CreateBGPPeerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


newBGPPeer
NewBGPPeer newBGPPeer

 Information about the BGP peer.
 








Class com.amazonaws.services.directconnect.model.CreateBGPPeerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualInterface
VirtualInterface virtualInterface

 The virtual interface.
 








Class com.amazonaws.services.directconnect.model.CreateConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


location
String location

 The location of the connection.
 


bandwidth
String bandwidth

 The bandwidth of the connection.
 


connectionName
String connectionName

 The name of the connection.
 


lagId
String lagId

 The ID of the LAG.
 


tags
SdkInternalList<T> tags

 The tags to associate with the lag.
 


providerName
String providerName

 The name of the service provider associated with the requested connection.
 








Class com.amazonaws.services.directconnect.model.CreateConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


connectionName
String connectionName

 The name of the connection.
 


connectionState
String connectionState

 The state of the connection. The following are the possible values:
 
 
 
 
 ordering: The initial state of a hosted connection provisioned on an interconnect. The connection
 stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
 
 
 
 
 requested: The initial state of a standard connection. The connection stays in the requested state
 until the Letter of Authorization (LOA) is sent to the customer.
 
 
 
 
 pending: The connection has been approved and is being initialized.
 
 
 
 
 available: The network link is up and the connection is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The connection is being deleted.
 
 
 
 
 deleted: The connection has been deleted.
 
 
 
 
 rejected: A hosted connection in the ordering state enters the rejected
 state if it is deleted by the customer.
 
 
 
 
 unknown: The state of the connection is not available.
 
 
 


region
String region

 The AWS Region where the connection is located.
 


location
String location

 The location of the connection.
 


bandwidth
String bandwidth

 The bandwidth of the connection.
 


vlan
Integer vlan

 The ID of the VLAN.
 


partnerName
String partnerName

 The name of the AWS Direct Connect service provider associated with the connection.
 


loaIssueTime
Date loaIssueTime

 The time of the most recent call to DescribeLoa for this connection.
 


lagId
String lagId

 The ID of the LAG.
 


awsDevice
String awsDevice

 The Direct Connect endpoint on which the physical connection terminates.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the physical connection terminates.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the connection.
 


providerName
String providerName

 The name of the service provider associated with the connection.
 








Class com.amazonaws.services.directconnect.model.CreateDirectConnectGatewayAssociationProposalRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


directConnectGatewayOwnerAccount
String directConnectGatewayOwnerAccount

 The ID of the AWS account that owns the Direct Connect gateway.
 


gatewayId
String gatewayId

 The ID of the virtual private gateway or transit gateway.
 


addAllowedPrefixesToDirectConnectGateway
SdkInternalList<T> addAllowedPrefixesToDirectConnectGateway

 The Amazon VPC prefixes to advertise to the Direct Connect gateway.
 


removeAllowedPrefixesToDirectConnectGateway
SdkInternalList<T> removeAllowedPrefixesToDirectConnectGateway

 The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.
 








Class com.amazonaws.services.directconnect.model.CreateDirectConnectGatewayAssociationProposalResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directConnectGatewayAssociationProposal
DirectConnectGatewayAssociationProposal directConnectGatewayAssociationProposal

 Information about the Direct Connect gateway proposal.
 








Class com.amazonaws.services.directconnect.model.CreateDirectConnectGatewayAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


gatewayId
String gatewayId

 The ID of the virtual private gateway or transit gateway.
 


addAllowedPrefixesToDirectConnectGateway
SdkInternalList<T> addAllowedPrefixesToDirectConnectGateway

 The Amazon VPC prefixes to advertise to the Direct Connect gateway
 
 
 This parameter is required when you create an association to a transit gateway.
 
 
 For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway.
 








Class com.amazonaws.services.directconnect.model.CreateDirectConnectGatewayAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directConnectGatewayAssociation
DirectConnectGatewayAssociation directConnectGatewayAssociation

 The association to be created.
 








Class com.amazonaws.services.directconnect.model.CreateDirectConnectGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directConnectGatewayName
String directConnectGatewayName

 The name of the Direct Connect gateway.
 


amazonSideAsn
Long amazonSideAsn

 The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the
 connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The
 default is 64512.
 








Class com.amazonaws.services.directconnect.model.CreateDirectConnectGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directConnectGateway
DirectConnectGateway directConnectGateway

 The Direct Connect gateway.
 








Class com.amazonaws.services.directconnect.model.CreateInterconnectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


interconnectName
String interconnectName

 The name of the interconnect.
 


bandwidth
String bandwidth

 The port bandwidth, in Gbps. The possible values are 1 and 10.
 


location
String location

 The location of the interconnect.
 


lagId
String lagId

 The ID of the LAG.
 


tags
SdkInternalList<T> tags

 The tags to associate with the interconnect.
 


providerName
String providerName

 The name of the service provider associated with the interconnect.
 








Class com.amazonaws.services.directconnect.model.CreateInterconnectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


interconnectId
String interconnectId

 The ID of the interconnect.
 


interconnectName
String interconnectName

 The name of the interconnect.
 


interconnectState
String interconnectState

 The state of the interconnect. The following are the possible values:
 
 
 
 
 requested: The initial state of an interconnect. The interconnect stays in the requested state until
 the Letter of Authorization (LOA) is sent to the customer.
 
 
 
 
 pending: The interconnect is approved, and is being initialized.
 
 
 
 
 available: The network link is up, and the interconnect is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The interconnect is being deleted.
 
 
 
 
 deleted: The interconnect is deleted.
 
 
 
 
 unknown: The state of the interconnect is not available.
 
 
 


region
String region

 The AWS Region where the connection is located.
 


location
String location

 The location of the connection.
 


bandwidth
String bandwidth

 The bandwidth of the connection.
 


loaIssueTime
Date loaIssueTime

 The time of the most recent call to DescribeLoa for this connection.
 


lagId
String lagId

 The ID of the LAG.
 


awsDevice
String awsDevice

 The Direct Connect endpoint on which the physical connection terminates.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the physical connection terminates.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the interconnect.
 


providerName
String providerName

 The name of the service provider associated with the interconnect.
 








Class com.amazonaws.services.directconnect.model.CreateLagRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


numberOfConnections
Integer numberOfConnections

 The number of physical connections initially provisioned and bundled by the LAG.
 


location
String location

 The location for the LAG.
 


connectionsBandwidth
String connectionsBandwidth

 The bandwidth of the individual physical connections bundled by the LAG. The possible values are 50Mbps, 100Mbps,
 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps.
 


lagName
String lagName

 The name of the LAG.
 


connectionId
String connectionId

 The ID of an existing connection to migrate to the LAG.
 


tags
SdkInternalList<T> tags

 The tags to associate with the LAG.
 


childConnectionTags
SdkInternalList<T> childConnectionTags

 The tags to associate with the automtically created LAGs.
 


providerName
String providerName

 The name of the service provider associated with the LAG.
 








Class com.amazonaws.services.directconnect.model.CreateLagResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectionsBandwidth
String connectionsBandwidth

 The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and
 10Gbps.
 


numberOfConnections
Integer numberOfConnections

 The number of physical connections bundled by the LAG, up to a maximum of 10.
 


lagId
String lagId

 The ID of the LAG.
 


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the LAG.
 


lagName
String lagName

 The name of the LAG.
 


lagState
String lagState

 The state of the LAG. The following are the possible values:
 
 
 
 
 requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of
 Authorization (LOA) is available.
 
 
 
 
 pending: The LAG has been approved and is being initialized.
 
 
 
 
 available: The network link is established and the LAG is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The LAG is being deleted.
 
 
 
 
 deleted: The LAG is deleted.
 
 
 
 
 unknown: The state of the LAG is not available.
 
 
 


location
String location

 The location of the LAG.
 


region
String region

 The AWS Region where the connection is located.
 


minimumLinks
Integer minimumLinks

 The minimum number of physical connections that must be operational for the LAG itself to be operational.
 


awsDevice
String awsDevice

 The AWS Direct Connect endpoint that hosts the LAG.
 


awsDeviceV2
String awsDeviceV2

 The AWS Direct Connect endpoint that hosts the LAG.
 


connections
SdkInternalList<T> connections

 The connections bundled by the LAG.
 


allowsHostedConnections
Boolean allowsHostedConnections

 Indicates whether the LAG can host other connections.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the LAG.
 


providerName
String providerName

 The name of the service provider associated with the LAG.
 








Class com.amazonaws.services.directconnect.model.CreatePrivateVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the connection.
 


newPrivateVirtualInterface
NewPrivateVirtualInterface newPrivateVirtualInterface

 Information about the private virtual interface.
 








Class com.amazonaws.services.directconnect.model.CreatePrivateVirtualInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the virtual interface.
 


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


location
String location

 The location of the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


virtualInterfaceType
String virtualInterfaceType

 The type of virtual interface. The possible values are private and public.
 


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


amazonSideAsn
Long amazonSideAsn

 The autonomous system number (ASN) for the Amazon side of the connection.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


virtualInterfaceState
String virtualInterfaceState

 The state of the virtual interface. The following are the possible values:
 
 
 
 
 confirming: The creation of the virtual interface is pending confirmation from the virtual interface
 owner. If the owner of the virtual interface is different from the owner of the connection on which it is
 provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
 owner.
 
 
 
 
 verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
 validation before the virtual interface can be created.
 
 
 
 
 pending: A virtual interface is in this state from the time that it is created until the virtual
 interface is ready to forward traffic.
 
 
 
 
 available: A virtual interface that is able to forward traffic.
 
 
 
 
 down: A virtual interface that is BGP down.
 
 
 
 
 deleting: A virtual interface is in this state immediately after calling
 DeleteVirtualInterface until it can no longer forward traffic.
 
 
 
 
 deleted: A virtual interface that cannot forward traffic.
 
 
 
 
 rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
 interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
 enters the Rejected state.
 
 
 
 
 unknown: The state of the virtual interface is not available.
 
 
 


customerRouterConfig
String customerRouterConfig

 The customer router configuration.
 


mtu
Integer mtu

 The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway. Applies only to private virtual interfaces.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


routeFilterPrefixes
SdkInternalList<T> routeFilterPrefixes

 The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
 


bgpPeers
SdkInternalList<T> bgpPeers

 The BGP peers configured on this virtual interface.
 


region
String region

 The AWS Region where the virtual interface is located.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the virtual interface terminates.
 


tags
SdkInternalList<T> tags

 The tags associated with the virtual interface.
 








Class com.amazonaws.services.directconnect.model.CreatePublicVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the connection.
 


newPublicVirtualInterface
NewPublicVirtualInterface newPublicVirtualInterface

 Information about the public virtual interface.
 








Class com.amazonaws.services.directconnect.model.CreatePublicVirtualInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the virtual interface.
 


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


location
String location

 The location of the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


virtualInterfaceType
String virtualInterfaceType

 The type of virtual interface. The possible values are private and public.
 


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


amazonSideAsn
Long amazonSideAsn

 The autonomous system number (ASN) for the Amazon side of the connection.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


virtualInterfaceState
String virtualInterfaceState

 The state of the virtual interface. The following are the possible values:
 
 
 
 
 confirming: The creation of the virtual interface is pending confirmation from the virtual interface
 owner. If the owner of the virtual interface is different from the owner of the connection on which it is
 provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
 owner.
 
 
 
 
 verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
 validation before the virtual interface can be created.
 
 
 
 
 pending: A virtual interface is in this state from the time that it is created until the virtual
 interface is ready to forward traffic.
 
 
 
 
 available: A virtual interface that is able to forward traffic.
 
 
 
 
 down: A virtual interface that is BGP down.
 
 
 
 
 deleting: A virtual interface is in this state immediately after calling
 DeleteVirtualInterface until it can no longer forward traffic.
 
 
 
 
 deleted: A virtual interface that cannot forward traffic.
 
 
 
 
 rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
 interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
 enters the Rejected state.
 
 
 
 
 unknown: The state of the virtual interface is not available.
 
 
 


customerRouterConfig
String customerRouterConfig

 The customer router configuration.
 


mtu
Integer mtu

 The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway. Applies only to private virtual interfaces.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


routeFilterPrefixes
SdkInternalList<T> routeFilterPrefixes

 The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
 


bgpPeers
SdkInternalList<T> bgpPeers

 The BGP peers configured on this virtual interface.
 


region
String region

 The AWS Region where the virtual interface is located.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the virtual interface terminates.
 


tags
SdkInternalList<T> tags

 The tags associated with the virtual interface.
 








Class com.amazonaws.services.directconnect.model.CreateTransitVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the connection.
 


newTransitVirtualInterface
NewTransitVirtualInterface newTransitVirtualInterface

 Information about the transit virtual interface.
 








Class com.amazonaws.services.directconnect.model.CreateTransitVirtualInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualInterface
VirtualInterface virtualInterface








Class com.amazonaws.services.directconnect.model.DeleteBGPPeerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


bgpPeerId
String bgpPeerId

 The ID of the BGP peer.
 








Class com.amazonaws.services.directconnect.model.DeleteBGPPeerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualInterface
VirtualInterface virtualInterface

 The virtual interface.
 








Class com.amazonaws.services.directconnect.model.DeleteConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the connection.
 








Class com.amazonaws.services.directconnect.model.DeleteConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


connectionName
String connectionName

 The name of the connection.
 


connectionState
String connectionState

 The state of the connection. The following are the possible values:
 
 
 
 
 ordering: The initial state of a hosted connection provisioned on an interconnect. The connection
 stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
 
 
 
 
 requested: The initial state of a standard connection. The connection stays in the requested state
 until the Letter of Authorization (LOA) is sent to the customer.
 
 
 
 
 pending: The connection has been approved and is being initialized.
 
 
 
 
 available: The network link is up and the connection is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The connection is being deleted.
 
 
 
 
 deleted: The connection has been deleted.
 
 
 
 
 rejected: A hosted connection in the ordering state enters the rejected
 state if it is deleted by the customer.
 
 
 
 
 unknown: The state of the connection is not available.
 
 
 


region
String region

 The AWS Region where the connection is located.
 


location
String location

 The location of the connection.
 


bandwidth
String bandwidth

 The bandwidth of the connection.
 


vlan
Integer vlan

 The ID of the VLAN.
 


partnerName
String partnerName

 The name of the AWS Direct Connect service provider associated with the connection.
 


loaIssueTime
Date loaIssueTime

 The time of the most recent call to DescribeLoa for this connection.
 


lagId
String lagId

 The ID of the LAG.
 


awsDevice
String awsDevice

 The Direct Connect endpoint on which the physical connection terminates.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the physical connection terminates.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the connection.
 


providerName
String providerName

 The name of the service provider associated with the connection.
 








Class com.amazonaws.services.directconnect.model.DeleteDirectConnectGatewayAssociationProposalRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


proposalId
String proposalId

 The ID of the proposal.
 








Class com.amazonaws.services.directconnect.model.DeleteDirectConnectGatewayAssociationProposalResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directConnectGatewayAssociationProposal
DirectConnectGatewayAssociationProposal directConnectGatewayAssociationProposal

 The ID of the associated gateway.
 








Class com.amazonaws.services.directconnect.model.DeleteDirectConnectGatewayAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationId
String associationId

 The ID of the Direct Connect gateway association.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway.
 








Class com.amazonaws.services.directconnect.model.DeleteDirectConnectGatewayAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directConnectGatewayAssociation
DirectConnectGatewayAssociation directConnectGatewayAssociation

 Information about the deleted association.
 








Class com.amazonaws.services.directconnect.model.DeleteDirectConnectGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 








Class com.amazonaws.services.directconnect.model.DeleteDirectConnectGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directConnectGateway
DirectConnectGateway directConnectGateway

 The Direct Connect gateway.
 








Class com.amazonaws.services.directconnect.model.DeleteInterconnectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


interconnectId
String interconnectId

 The ID of the interconnect.
 








Class com.amazonaws.services.directconnect.model.DeleteInterconnectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


interconnectState
String interconnectState

 The state of the interconnect. The following are the possible values:
 
 
 
 
 requested: The initial state of an interconnect. The interconnect stays in the requested state until
 the Letter of Authorization (LOA) is sent to the customer.
 
 
 
 
 pending: The interconnect is approved, and is being initialized.
 
 
 
 
 available: The network link is up, and the interconnect is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The interconnect is being deleted.
 
 
 
 
 deleted: The interconnect is deleted.
 
 
 
 
 unknown: The state of the interconnect is not available.
 
 
 








Class com.amazonaws.services.directconnect.model.DeleteLagRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


lagId
String lagId

 The ID of the LAG.
 








Class com.amazonaws.services.directconnect.model.DeleteLagResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectionsBandwidth
String connectionsBandwidth

 The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and
 10Gbps.
 


numberOfConnections
Integer numberOfConnections

 The number of physical connections bundled by the LAG, up to a maximum of 10.
 


lagId
String lagId

 The ID of the LAG.
 


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the LAG.
 


lagName
String lagName

 The name of the LAG.
 


lagState
String lagState

 The state of the LAG. The following are the possible values:
 
 
 
 
 requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of
 Authorization (LOA) is available.
 
 
 
 
 pending: The LAG has been approved and is being initialized.
 
 
 
 
 available: The network link is established and the LAG is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The LAG is being deleted.
 
 
 
 
 deleted: The LAG is deleted.
 
 
 
 
 unknown: The state of the LAG is not available.
 
 
 


location
String location

 The location of the LAG.
 


region
String region

 The AWS Region where the connection is located.
 


minimumLinks
Integer minimumLinks

 The minimum number of physical connections that must be operational for the LAG itself to be operational.
 


awsDevice
String awsDevice

 The AWS Direct Connect endpoint that hosts the LAG.
 


awsDeviceV2
String awsDeviceV2

 The AWS Direct Connect endpoint that hosts the LAG.
 


connections
SdkInternalList<T> connections

 The connections bundled by the LAG.
 


allowsHostedConnections
Boolean allowsHostedConnections

 Indicates whether the LAG can host other connections.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the LAG.
 


providerName
String providerName

 The name of the service provider associated with the LAG.
 








Class com.amazonaws.services.directconnect.model.DeleteVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 








Class com.amazonaws.services.directconnect.model.DeleteVirtualInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualInterfaceState
String virtualInterfaceState

 The state of the virtual interface. The following are the possible values:
 
 
 
 
 confirming: The creation of the virtual interface is pending confirmation from the virtual interface
 owner. If the owner of the virtual interface is different from the owner of the connection on which it is
 provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
 owner.
 
 
 
 
 verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
 validation before the virtual interface can be created.
 
 
 
 
 pending: A virtual interface is in this state from the time that it is created until the virtual
 interface is ready to forward traffic.
 
 
 
 
 available: A virtual interface that is able to forward traffic.
 
 
 
 
 down: A virtual interface that is BGP down.
 
 
 
 
 deleting: A virtual interface is in this state immediately after calling
 DeleteVirtualInterface until it can no longer forward traffic.
 
 
 
 
 deleted: A virtual interface that cannot forward traffic.
 
 
 
 
 rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
 interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
 enters the Rejected state.
 
 
 
 
 unknown: The state of the virtual interface is not available.
 
 
 








Class com.amazonaws.services.directconnect.model.DescribeConnectionLoaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the connection.
 


providerName
String providerName

 The name of the APN partner or service provider who establishes connectivity on your behalf. If you specify this
 parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.
 


loaContentType
String loaContentType

 The standard media type for the LOA-CFA document. The only supported value is application/pdf.
 








Class com.amazonaws.services.directconnect.model.DescribeConnectionLoaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loa
Loa loa

 The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).
 








Class com.amazonaws.services.directconnect.model.DescribeConnectionsOnInterconnectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


interconnectId
String interconnectId

 The ID of the interconnect.
 








Class com.amazonaws.services.directconnect.model.DescribeConnectionsOnInterconnectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connections
SdkInternalList<T> connections

 The connections.
 








Class com.amazonaws.services.directconnect.model.DescribeConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the connection.
 








Class com.amazonaws.services.directconnect.model.DescribeConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connections
SdkInternalList<T> connections

 The connections.
 








Class com.amazonaws.services.directconnect.model.DescribeDirectConnectGatewayAssociationProposalsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


proposalId
String proposalId

 The ID of the proposal.
 


associatedGatewayId
String associatedGatewayId

 The ID of the associated gateway.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 
 
 If MaxResults is given a value larger than 100, only 100 results are returned.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.directconnect.model.DescribeDirectConnectGatewayAssociationProposalsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directConnectGatewayAssociationProposals
SdkInternalList<T> directConnectGatewayAssociationProposals

 Describes the Direct Connect gateway association proposals.
 


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.directconnect.model.DescribeDirectConnectGatewayAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationId
String associationId

 The ID of the Direct Connect gateway association.
 


associatedGatewayId
String associatedGatewayId

 The ID of the associated gateway.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 
 
 If MaxResults is given a value larger than 100, only 100 results are returned.
 


nextToken
String nextToken

 The token provided in the previous call to retrieve the next page.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway.
 








Class com.amazonaws.services.directconnect.model.DescribeDirectConnectGatewayAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directConnectGatewayAssociations
SdkInternalList<T> directConnectGatewayAssociations

 Information about the associations.
 


nextToken
String nextToken

 The token to retrieve the next page.
 








Class com.amazonaws.services.directconnect.model.DescribeDirectConnectGatewayAttachmentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 
 
 If MaxResults is given a value larger than 100, only 100 results are returned.
 


nextToken
String nextToken

 The token provided in the previous call to retrieve the next page.
 








Class com.amazonaws.services.directconnect.model.DescribeDirectConnectGatewayAttachmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directConnectGatewayAttachments
SdkInternalList<T> directConnectGatewayAttachments

 The attachments.
 


nextToken
String nextToken

 The token to retrieve the next page.
 








Class com.amazonaws.services.directconnect.model.DescribeDirectConnectGatewaysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 
 
 If MaxResults is given a value larger than 100, only 100 results are returned.
 


nextToken
String nextToken

 The token provided in the previous call to retrieve the next page.
 








Class com.amazonaws.services.directconnect.model.DescribeDirectConnectGatewaysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directConnectGateways
SdkInternalList<T> directConnectGateways

 The Direct Connect gateways.
 


nextToken
String nextToken

 The token to retrieve the next page.
 








Class com.amazonaws.services.directconnect.model.DescribeHostedConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the interconnect or LAG.
 








Class com.amazonaws.services.directconnect.model.DescribeHostedConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connections
SdkInternalList<T> connections

 The connections.
 








Class com.amazonaws.services.directconnect.model.DescribeInterconnectLoaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


interconnectId
String interconnectId

 The ID of the interconnect.
 


providerName
String providerName

 The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the
 LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.
 


loaContentType
String loaContentType

 The standard media type for the LOA-CFA document. The only supported value is application/pdf.
 








Class com.amazonaws.services.directconnect.model.DescribeInterconnectLoaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loa
Loa loa

 The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).
 








Class com.amazonaws.services.directconnect.model.DescribeInterconnectsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


interconnectId
String interconnectId

 The ID of the interconnect.
 








Class com.amazonaws.services.directconnect.model.DescribeInterconnectsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


interconnects
SdkInternalList<T> interconnects

 The interconnects.
 








Class com.amazonaws.services.directconnect.model.DescribeLagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


lagId
String lagId

 The ID of the LAG.
 








Class com.amazonaws.services.directconnect.model.DescribeLagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


lags
SdkInternalList<T> lags

 The LAGs.
 








Class com.amazonaws.services.directconnect.model.DescribeLoaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of a connection, LAG, or interconnect.
 


providerName
String providerName

 The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the
 LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.
 


loaContentType
String loaContentType

 The standard media type for the LOA-CFA document. The only supported value is application/pdf.
 








Class com.amazonaws.services.directconnect.model.DescribeLoaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loaContent
ByteBuffer loaContent

 The binary contents of the LOA-CFA document.
 


loaContentType
String loaContentType

 The standard media type for the LOA-CFA document. The only supported value is application/pdf.
 








Class com.amazonaws.services.directconnect.model.DescribeLocationsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.directconnect.model.DescribeLocationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


locations
SdkInternalList<T> locations

 The locations.
 








Class com.amazonaws.services.directconnect.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArns
SdkInternalList<T> resourceArns

 The Amazon Resource Names (ARNs) of the resources.
 








Class com.amazonaws.services.directconnect.model.DescribeTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceTags
SdkInternalList<T> resourceTags

 Information about the tags.
 








Class com.amazonaws.services.directconnect.model.DescribeVirtualGatewaysRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.directconnect.model.DescribeVirtualGatewaysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualGateways
SdkInternalList<T> virtualGateways

 The virtual private gateways.
 








Class com.amazonaws.services.directconnect.model.DescribeVirtualInterfacesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the connection.
 


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 








Class com.amazonaws.services.directconnect.model.DescribeVirtualInterfacesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualInterfaces
SdkInternalList<T> virtualInterfaces

 The virtual interfaces
 








Class com.amazonaws.services.directconnect.model.DirectConnectClientException extends AmazonDirectConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.directconnect.model.DirectConnectGateway extends Object implements Serializable


Serialized Fields


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


directConnectGatewayName
String directConnectGatewayName

 The name of the Direct Connect gateway.
 


amazonSideAsn
Long amazonSideAsn

 The autonomous system number (ASN) for the Amazon side of the connection.
 


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the Direct Connect gateway.
 


directConnectGatewayState
String directConnectGatewayState

 The state of the Direct Connect gateway. The following are the possible values:
 
 
 
 
 pending: The initial state after calling CreateDirectConnectGateway.
 
 
 
 
 available: The Direct Connect gateway is ready for use.
 
 
 
 
 deleting: The initial state after calling DeleteDirectConnectGateway.
 
 
 
 
 deleted: The Direct Connect gateway is deleted and cannot pass traffic.
 
 
 


stateChangeError
String stateChangeError

 The error message if the state of an object failed to advance.
 








Class com.amazonaws.services.directconnect.model.DirectConnectGatewayAssociation extends Object implements Serializable


Serialized Fields


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


directConnectGatewayOwnerAccount
String directConnectGatewayOwnerAccount

 The ID of the AWS account that owns the associated gateway.
 


associationState
String associationState

 The state of the association. The following are the possible values:
 
 
 
 
 associating: The initial state after calling CreateDirectConnectGatewayAssociation.
 
 
 
 
 associated: The Direct Connect gateway and virtual private gateway or transit gateway are
 successfully associated and ready to pass traffic.
 
 
 
 
 disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.
 
 
 
 
 disassociated: The virtual private gateway or transit gateway is disassociated from the Direct
 Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway
 is stopped.
 
 
 


stateChangeError
String stateChangeError

 The error message if the state of an object failed to advance.
 


associatedGateway
AssociatedGateway associatedGateway

 Information about the associated gateway.
 


associationId
String associationId

 The ID of the Direct Connect gateway association.
 


allowedPrefixesToDirectConnectGateway
SdkInternalList<T> allowedPrefixesToDirectConnectGateway

 The Amazon VPC prefixes to advertise to the Direct Connect gateway.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway. Applies only to private virtual interfaces.
 


virtualGatewayRegion
String virtualGatewayRegion

 The AWS Region where the virtual private gateway is located.
 


virtualGatewayOwnerAccount
String virtualGatewayOwnerAccount

 The ID of the AWS account that owns the virtual private gateway.
 








Class com.amazonaws.services.directconnect.model.DirectConnectGatewayAssociationProposal extends Object implements Serializable


Serialized Fields


proposalId
String proposalId

 The ID of the association proposal.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


directConnectGatewayOwnerAccount
String directConnectGatewayOwnerAccount

 The ID of the AWS account that owns the Direct Connect gateway.
 


proposalState
String proposalState

 The state of the proposal. The following are possible values:
 
 
 
 
 accepted: The proposal has been accepted. The Direct Connect gateway association is available to use
 in this state.
 
 
 
 
 deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect
 gateway association cannot be used in this state.
 
 
 
 
 requested: The proposal has been requested. The Direct Connect gateway association cannot be used in
 this state.
 
 
 


associatedGateway
AssociatedGateway associatedGateway

 Information about the associated gateway.
 


existingAllowedPrefixesToDirectConnectGateway
SdkInternalList<T> existingAllowedPrefixesToDirectConnectGateway

 The existing Amazon VPC prefixes advertised to the Direct Connect gateway.
 


requestedAllowedPrefixesToDirectConnectGateway
SdkInternalList<T> requestedAllowedPrefixesToDirectConnectGateway

 The Amazon VPC prefixes to advertise to the Direct Connect gateway.
 








Class com.amazonaws.services.directconnect.model.DirectConnectGatewayAttachment extends Object implements Serializable


Serialized Fields


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


virtualInterfaceRegion
String virtualInterfaceRegion

 The AWS Region where the virtual interface is located.
 


virtualInterfaceOwnerAccount
String virtualInterfaceOwnerAccount

 The ID of the AWS account that owns the virtual interface.
 


attachmentState
String attachmentState

 The state of the attachment. The following are the possible values:
 
 
 
 
 attaching: The initial state after a virtual interface is created using the Direct Connect gateway.
 
 
 
 
 attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.
 
 
 
 
 detaching: The initial state after calling DeleteVirtualInterface.
 
 
 
 
 detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between
 the Direct Connect gateway and virtual interface is stopped.
 
 
 


attachmentType
String attachmentType

 The type of attachment.
 


stateChangeError
String stateChangeError

 The error message if the state of an object failed to advance.
 








Class com.amazonaws.services.directconnect.model.DirectConnectServerException extends AmazonDirectConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.directconnect.model.DisassociateConnectionFromLagRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the connection.
 


lagId
String lagId

 The ID of the LAG.
 








Class com.amazonaws.services.directconnect.model.DisassociateConnectionFromLagResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


connectionName
String connectionName

 The name of the connection.
 


connectionState
String connectionState

 The state of the connection. The following are the possible values:
 
 
 
 
 ordering: The initial state of a hosted connection provisioned on an interconnect. The connection
 stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
 
 
 
 
 requested: The initial state of a standard connection. The connection stays in the requested state
 until the Letter of Authorization (LOA) is sent to the customer.
 
 
 
 
 pending: The connection has been approved and is being initialized.
 
 
 
 
 available: The network link is up and the connection is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The connection is being deleted.
 
 
 
 
 deleted: The connection has been deleted.
 
 
 
 
 rejected: A hosted connection in the ordering state enters the rejected
 state if it is deleted by the customer.
 
 
 
 
 unknown: The state of the connection is not available.
 
 
 


region
String region

 The AWS Region where the connection is located.
 


location
String location

 The location of the connection.
 


bandwidth
String bandwidth

 The bandwidth of the connection.
 


vlan
Integer vlan

 The ID of the VLAN.
 


partnerName
String partnerName

 The name of the AWS Direct Connect service provider associated with the connection.
 


loaIssueTime
Date loaIssueTime

 The time of the most recent call to DescribeLoa for this connection.
 


lagId
String lagId

 The ID of the LAG.
 


awsDevice
String awsDevice

 The Direct Connect endpoint on which the physical connection terminates.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the physical connection terminates.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the connection.
 


providerName
String providerName

 The name of the service provider associated with the connection.
 








Class com.amazonaws.services.directconnect.model.DuplicateTagKeysException extends AmazonDirectConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.directconnect.model.Interconnect extends Object implements Serializable


Serialized Fields


interconnectId
String interconnectId

 The ID of the interconnect.
 


interconnectName
String interconnectName

 The name of the interconnect.
 


interconnectState
String interconnectState

 The state of the interconnect. The following are the possible values:
 
 
 
 
 requested: The initial state of an interconnect. The interconnect stays in the requested state until
 the Letter of Authorization (LOA) is sent to the customer.
 
 
 
 
 pending: The interconnect is approved, and is being initialized.
 
 
 
 
 available: The network link is up, and the interconnect is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The interconnect is being deleted.
 
 
 
 
 deleted: The interconnect is deleted.
 
 
 
 
 unknown: The state of the interconnect is not available.
 
 
 


region
String region

 The AWS Region where the connection is located.
 


location
String location

 The location of the connection.
 


bandwidth
String bandwidth

 The bandwidth of the connection.
 


loaIssueTime
Date loaIssueTime

 The time of the most recent call to DescribeLoa for this connection.
 


lagId
String lagId

 The ID of the LAG.
 


awsDevice
String awsDevice

 The Direct Connect endpoint on which the physical connection terminates.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the physical connection terminates.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the interconnect.
 


providerName
String providerName

 The name of the service provider associated with the interconnect.
 








Class com.amazonaws.services.directconnect.model.Lag extends Object implements Serializable


Serialized Fields


connectionsBandwidth
String connectionsBandwidth

 The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and
 10Gbps.
 


numberOfConnections
Integer numberOfConnections

 The number of physical connections bundled by the LAG, up to a maximum of 10.
 


lagId
String lagId

 The ID of the LAG.
 


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the LAG.
 


lagName
String lagName

 The name of the LAG.
 


lagState
String lagState

 The state of the LAG. The following are the possible values:
 
 
 
 
 requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of
 Authorization (LOA) is available.
 
 
 
 
 pending: The LAG has been approved and is being initialized.
 
 
 
 
 available: The network link is established and the LAG is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The LAG is being deleted.
 
 
 
 
 deleted: The LAG is deleted.
 
 
 
 
 unknown: The state of the LAG is not available.
 
 
 


location
String location

 The location of the LAG.
 


region
String region

 The AWS Region where the connection is located.
 


minimumLinks
Integer minimumLinks

 The minimum number of physical connections that must be operational for the LAG itself to be operational.
 


awsDevice
String awsDevice

 The AWS Direct Connect endpoint that hosts the LAG.
 


awsDeviceV2
String awsDeviceV2

 The AWS Direct Connect endpoint that hosts the LAG.
 


connections
SdkInternalList<T> connections

 The connections bundled by the LAG.
 


allowsHostedConnections
Boolean allowsHostedConnections

 Indicates whether the LAG can host other connections.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the LAG.
 


providerName
String providerName

 The name of the service provider associated with the LAG.
 








Class com.amazonaws.services.directconnect.model.Loa extends Object implements Serializable


Serialized Fields


loaContent
ByteBuffer loaContent

 The binary contents of the LOA-CFA document.
 


loaContentType
String loaContentType

 The standard media type for the LOA-CFA document. The only supported value is application/pdf.
 








Class com.amazonaws.services.directconnect.model.Location extends Object implements Serializable


Serialized Fields


locationCode
String locationCode

 The code for the location.
 


locationName
String locationName

 The name of the location. This includes the name of the colocation partner and the physical site of the building.
 


region
String region

 The AWS Region for the location.
 


availablePortSpeeds
SdkInternalList<T> availablePortSpeeds

 The available port speeds for the location.
 


availableProviders
SdkInternalList<T> availableProviders

 The name of the service provider for the location.
 








Class com.amazonaws.services.directconnect.model.NewBGPPeer extends Object implements Serializable


Serialized Fields


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 








Class com.amazonaws.services.directconnect.model.NewPrivateVirtualInterface extends Object implements Serializable


Serialized Fields


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


mtu
Integer mtu

 The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


tags
SdkInternalList<T> tags

 The tags associated with the private virtual interface.
 








Class com.amazonaws.services.directconnect.model.NewPrivateVirtualInterfaceAllocation extends Object implements Serializable


Serialized Fields


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


mtu
Integer mtu

 The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


tags
SdkInternalList<T> tags

 The tags associated with the private virtual interface.
 








Class com.amazonaws.services.directconnect.model.NewPublicVirtualInterface extends Object implements Serializable


Serialized Fields


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


routeFilterPrefixes
SdkInternalList<T> routeFilterPrefixes

 The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
 


tags
SdkInternalList<T> tags

 The tags associated with the public virtual interface.
 








Class com.amazonaws.services.directconnect.model.NewPublicVirtualInterfaceAllocation extends Object implements Serializable


Serialized Fields


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


routeFilterPrefixes
SdkInternalList<T> routeFilterPrefixes

 The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
 


tags
SdkInternalList<T> tags

 The tags associated with the public virtual interface.
 








Class com.amazonaws.services.directconnect.model.NewTransitVirtualInterface extends Object implements Serializable


Serialized Fields


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


mtu
Integer mtu

 The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


tags
SdkInternalList<T> tags

 The tags associated with the transitive virtual interface.
 








Class com.amazonaws.services.directconnect.model.NewTransitVirtualInterfaceAllocation extends Object implements Serializable


Serialized Fields


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


mtu
Integer mtu

 The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


tags
SdkInternalList<T> tags

 The tags associated with the transitive virtual interface.
 








Class com.amazonaws.services.directconnect.model.ResourceTag extends Object implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 


tags
SdkInternalList<T> tags

 The tags.
 








Class com.amazonaws.services.directconnect.model.RouteFilterPrefix extends Object implements Serializable


Serialized Fields


cidr
String cidr

 The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or
 shorter.
 








Class com.amazonaws.services.directconnect.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key.
 


value
String value

 The value.
 








Class com.amazonaws.services.directconnect.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 


tags
SdkInternalList<T> tags

 The tags to add.
 








Class com.amazonaws.services.directconnect.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directconnect.model.TooManyTagsException extends AmazonDirectConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.directconnect.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 


tagKeys
SdkInternalList<T> tagKeys

 The tag keys of the tags to remove.
 








Class com.amazonaws.services.directconnect.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directconnect.model.UpdateDirectConnectGatewayAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationId
String associationId

 The ID of the Direct Connect gateway association.
 


addAllowedPrefixesToDirectConnectGateway
SdkInternalList<T> addAllowedPrefixesToDirectConnectGateway

 The Amazon VPC prefixes to advertise to the Direct Connect gateway.
 


removeAllowedPrefixesToDirectConnectGateway
SdkInternalList<T> removeAllowedPrefixesToDirectConnectGateway

 The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.
 








Class com.amazonaws.services.directconnect.model.UpdateDirectConnectGatewayAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directConnectGatewayAssociation
DirectConnectGatewayAssociation directConnectGatewayAssociation








Class com.amazonaws.services.directconnect.model.UpdateLagRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


lagId
String lagId

 The ID of the LAG.
 


lagName
String lagName

 The name of the LAG.
 


minimumLinks
Integer minimumLinks

 The minimum number of physical connections that must be operational for the LAG itself to be operational.
 








Class com.amazonaws.services.directconnect.model.UpdateLagResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectionsBandwidth
String connectionsBandwidth

 The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and
 10Gbps.
 


numberOfConnections
Integer numberOfConnections

 The number of physical connections bundled by the LAG, up to a maximum of 10.
 


lagId
String lagId

 The ID of the LAG.
 


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the LAG.
 


lagName
String lagName

 The name of the LAG.
 


lagState
String lagState

 The state of the LAG. The following are the possible values:
 
 
 
 
 requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of
 Authorization (LOA) is available.
 
 
 
 
 pending: The LAG has been approved and is being initialized.
 
 
 
 
 available: The network link is established and the LAG is ready for use.
 
 
 
 
 down: The network link is down.
 
 
 
 
 deleting: The LAG is being deleted.
 
 
 
 
 deleted: The LAG is deleted.
 
 
 
 
 unknown: The state of the LAG is not available.
 
 
 


location
String location

 The location of the LAG.
 


region
String region

 The AWS Region where the connection is located.
 


minimumLinks
Integer minimumLinks

 The minimum number of physical connections that must be operational for the LAG itself to be operational.
 


awsDevice
String awsDevice

 The AWS Direct Connect endpoint that hosts the LAG.
 


awsDeviceV2
String awsDeviceV2

 The AWS Direct Connect endpoint that hosts the LAG.
 


connections
SdkInternalList<T> connections

 The connections bundled by the LAG.
 


allowsHostedConnections
Boolean allowsHostedConnections

 Indicates whether the LAG can host other connections.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


hasLogicalRedundancy
String hasLogicalRedundancy

 Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
 


tags
SdkInternalList<T> tags

 The tags associated with the LAG.
 


providerName
String providerName

 The name of the service provider associated with the LAG.
 








Class com.amazonaws.services.directconnect.model.UpdateVirtualInterfaceAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual private interface.
 


mtu
Integer mtu

 The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
 








Class com.amazonaws.services.directconnect.model.UpdateVirtualInterfaceAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the virtual interface.
 


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


location
String location

 The location of the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


virtualInterfaceType
String virtualInterfaceType

 The type of virtual interface. The possible values are private and public.
 


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


amazonSideAsn
Long amazonSideAsn

 The autonomous system number (ASN) for the Amazon side of the connection.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


virtualInterfaceState
String virtualInterfaceState

 The state of the virtual interface. The following are the possible values:
 
 
 
 
 confirming: The creation of the virtual interface is pending confirmation from the virtual interface
 owner. If the owner of the virtual interface is different from the owner of the connection on which it is
 provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
 owner.
 
 
 
 
 verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
 validation before the virtual interface can be created.
 
 
 
 
 pending: A virtual interface is in this state from the time that it is created until the virtual
 interface is ready to forward traffic.
 
 
 
 
 available: A virtual interface that is able to forward traffic.
 
 
 
 
 down: A virtual interface that is BGP down.
 
 
 
 
 deleting: A virtual interface is in this state immediately after calling
 DeleteVirtualInterface until it can no longer forward traffic.
 
 
 
 
 deleted: A virtual interface that cannot forward traffic.
 
 
 
 
 rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
 interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
 enters the Rejected state.
 
 
 
 
 unknown: The state of the virtual interface is not available.
 
 
 


customerRouterConfig
String customerRouterConfig

 The customer router configuration.
 


mtu
Integer mtu

 The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway. Applies only to private virtual interfaces.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


routeFilterPrefixes
SdkInternalList<T> routeFilterPrefixes

 The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
 


bgpPeers
SdkInternalList<T> bgpPeers

 The BGP peers configured on this virtual interface.
 


region
String region

 The AWS Region where the virtual interface is located.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the virtual interface terminates.
 


tags
SdkInternalList<T> tags

 The tags associated with the virtual interface.
 








Class com.amazonaws.services.directconnect.model.VirtualGateway extends Object implements Serializable


Serialized Fields


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway.
 


virtualGatewayState
String virtualGatewayState

 The state of the virtual private gateway. The following are the possible values:
 
 
 
 
 pending: Initial state after creating the virtual private gateway.
 
 
 
 
 available: Ready for use by a private virtual interface.
 
 
 
 
 deleting: Initial state after deleting the virtual private gateway.
 
 
 
 
 deleted: The virtual private gateway is deleted. The private virtual interface is unable to send
 traffic over this gateway.
 
 
 








Class com.amazonaws.services.directconnect.model.VirtualInterface extends Object implements Serializable


Serialized Fields


ownerAccount
String ownerAccount

 The ID of the AWS account that owns the virtual interface.
 


virtualInterfaceId
String virtualInterfaceId

 The ID of the virtual interface.
 


location
String location

 The location of the connection.
 


connectionId
String connectionId

 The ID of the connection.
 


virtualInterfaceType
String virtualInterfaceType

 The type of virtual interface. The possible values are private and public.
 


virtualInterfaceName
String virtualInterfaceName

 The name of the virtual interface assigned by the customer network.
 


vlan
Integer vlan

 The ID of the VLAN.
 


asn
Integer asn

 The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
 
 
 The valid values are 1-2147483647.
 


amazonSideAsn
Long amazonSideAsn

 The autonomous system number (ASN) for the Amazon side of the connection.
 


authKey
String authKey

 The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun
 lenth of 80 characters.
 


amazonAddress
String amazonAddress

 The IP address assigned to the Amazon interface.
 


customerAddress
String customerAddress

 The IP address assigned to the customer interface.
 


addressFamily
String addressFamily

 The address family for the BGP peer.
 


virtualInterfaceState
String virtualInterfaceState

 The state of the virtual interface. The following are the possible values:
 
 
 
 
 confirming: The creation of the virtual interface is pending confirmation from the virtual interface
 owner. If the owner of the virtual interface is different from the owner of the connection on which it is
 provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface
 owner.
 
 
 
 
 verifying: This state only applies to public virtual interfaces. Each public virtual interface needs
 validation before the virtual interface can be created.
 
 
 
 
 pending: A virtual interface is in this state from the time that it is created until the virtual
 interface is ready to forward traffic.
 
 
 
 
 available: A virtual interface that is able to forward traffic.
 
 
 
 
 down: A virtual interface that is BGP down.
 
 
 
 
 deleting: A virtual interface is in this state immediately after calling
 DeleteVirtualInterface until it can no longer forward traffic.
 
 
 
 
 deleted: A virtual interface that cannot forward traffic.
 
 
 
 
 rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual
 interface in the Confirming state is deleted by the virtual interface owner, the virtual interface
 enters the Rejected state.
 
 
 
 
 unknown: The state of the virtual interface is not available.
 
 
 


customerRouterConfig
String customerRouterConfig

 The customer router configuration.
 


mtu
Integer mtu

 The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
 


jumboFrameCapable
Boolean jumboFrameCapable

 Indicates whether jumbo frames (9001 MTU) are supported.
 


virtualGatewayId
String virtualGatewayId

 The ID of the virtual private gateway. Applies only to private virtual interfaces.
 


directConnectGatewayId
String directConnectGatewayId

 The ID of the Direct Connect gateway.
 


routeFilterPrefixes
SdkInternalList<T> routeFilterPrefixes

 The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.
 


bgpPeers
SdkInternalList<T> bgpPeers

 The BGP peers configured on this virtual interface.
 


region
String region

 The AWS Region where the virtual interface is located.
 


awsDeviceV2
String awsDeviceV2

 The Direct Connect endpoint on which the virtual interface terminates.
 


tags
SdkInternalList<T> tags

 The tags associated with the virtual interface.
 








Package com.amazonaws.services.directory.model




Class com.amazonaws.services.directory.model.AcceptSharedDirectoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sharedDirectoryId
String sharedDirectoryId

 Identifier of the shared directory in the directory consumer account. This identifier is different for each
 directory owner account.
 








Class com.amazonaws.services.directory.model.AcceptSharedDirectoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sharedDirectory
SharedDirectory sharedDirectory

 The shared directory in the directory consumer account.
 








Class com.amazonaws.services.directory.model.AccessDeniedException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.AddIpRoutesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier (ID) of the directory to which to add the address block.
 


ipRoutes
SdkInternalList<T> ipRoutes

 IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS
 server used for your on-premises domain.
 


updateSecurityGroupForDirectoryControllers
Boolean updateSecurityGroupForDirectoryControllers

 If set to true, updates the inbound and outbound rules of the security group that has the description:
 "AWS created security group for directory ID directory controllers." Following are the new rules:
 
 
 Inbound:
 
 
 
 
 Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0
 
 
 
 
 Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0
 
 
 
 
 Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0
 
 
 
 
 Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0
 
 
 
 
 Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0
 
 
 
 
 Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0
 
 
 
 
 Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0
 
 
 
 
 Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0
 
 
 
 
 Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0
 
 
 
 
 Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0
 
 
 
 
 Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0
 
 
 
 
 Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0
 
 
 
 
 Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0
 
 
 
 
 Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0
 
 
 
 
 Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0
 
 
 
 
 Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0
 
 
 
 
 Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0
 
 
 
 
 

 Outbound:
 
 
 
 
 Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0
 
 
 
 
 These security rules impact an internal network interface that is not exposed publicly.
 








Class com.amazonaws.services.directory.model.AddIpRoutesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


resourceId
String resourceId

 Identifier (ID) for the directory to which to add the tag.
 


tags
SdkInternalList<T> tags

 The tags to be assigned to the directory.
 








Class com.amazonaws.services.directory.model.AddTagsToResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


name
String name

 The name of the attribute.
 


value
String value

 The value of the attribute.
 








Class com.amazonaws.services.directory.model.AuthenticationFailedException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId

 The identifier of the request that caused the exception.
 








Class com.amazonaws.services.directory.model.AWSDirectoryServiceException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.directory.model.CancelSchemaExtensionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory whose schema extension will be canceled.
 


schemaExtensionId
String schemaExtensionId

 The identifier of the schema extension that will be canceled.
 








Class com.amazonaws.services.directory.model.CancelSchemaExtensionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.Certificate extends Object implements Serializable


Serialized Fields


certificateId
String certificateId

 The identifier of the certificate.
 


state
String state

 The state of the certificate.
 


stateReason
String stateReason

 Describes a state change for the certificate.
 


commonName
String commonName

 The common name for the certificate.
 


registeredDateTime
Date registeredDateTime

 The date and time that the certificate was registered.
 


expiryDateTime
Date expiryDateTime

 The date and time when the certificate will expire.
 








Class com.amazonaws.services.directory.model.CertificateAlreadyExistsException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.CertificateDoesNotExistException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.CertificateInfo extends Object implements Serializable


Serialized Fields


certificateId
String certificateId

 The identifier of the certificate.
 


commonName
String commonName

 The common name for the certificate.
 


state
String state

 The state of the certificate.
 








Class com.amazonaws.services.directory.model.CertificateInUseException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.CertificateLimitExceededException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.ClientException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.Computer extends Object implements Serializable


Serialized Fields


computerId
String computerId

 The identifier of the computer.
 


computerName
String computerName

 The computer name.
 


computerAttributes
SdkInternalList<T> computerAttributes

 An array of Attribute objects containing the LDAP attributes that belong to the computer account.
 








Class com.amazonaws.services.directory.model.ConditionalForwarder extends Object implements Serializable


Serialized Fields


remoteDomainName
String remoteDomainName

 The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.
 


dnsIpAddrs
SdkInternalList<T> dnsIpAddrs

 The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS
 server that your conditional forwarder points to.
 


replicationScope
String replicationScope

 The replication scope of the conditional forwarder. The only allowed value is Domain, which will
 replicate the conditional forwarder to all of the domain controllers for your AWS directory.
 








Class com.amazonaws.services.directory.model.ConnectDirectoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The fully qualified name of the on-premises directory, such as corp.example.com.
 


shortName
String shortName

 The NetBIOS name of the on-premises directory, such as CORP.
 


password
String password

 The password for the on-premises user account.
 


description
String description

 A description for the directory.
 


size
String size

 The size of the directory.
 


connectSettings
DirectoryConnectSettings connectSettings

 A DirectoryConnectSettings object that contains additional information for the operation.
 


tags
SdkInternalList<T> tags

 The tags to be assigned to AD Connector.
 








Class com.amazonaws.services.directory.model.ConnectDirectoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the new directory.
 








Class com.amazonaws.services.directory.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory for which to create the alias.
 


alias
String alias

 The requested alias.
 
 
 The alias must be unique amongst all aliases in AWS. This operation throws an
 EntityAlreadyExistsException error if the alias already exists.
 








Class com.amazonaws.services.directory.model.CreateAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory.
 


alias
String alias

 The alias for the directory.
 








Class com.amazonaws.services.directory.model.CreateComputerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory in which to create the computer account.
 


computerName
String computerName

 The name of the computer account.
 


password
String password

 A one-time password that is used to join the computer to the directory. You should generate a random, strong
 password to use for this parameter.
 


organizationalUnitDistinguishedName
String organizationalUnitDistinguishedName

 The fully-qualified distinguished name of the organizational unit to place the computer account in.
 


computerAttributes
SdkInternalList<T> computerAttributes

 An array of Attribute objects that contain any LDAP attributes to apply to the computer account.
 








Class com.amazonaws.services.directory.model.CreateComputerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


computer
Computer computer

 A Computer object that represents the computer account.
 








Class com.amazonaws.services.directory.model.CreateConditionalForwarderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The directory ID of the AWS directory for which you are creating the conditional forwarder.
 


remoteDomainName
String remoteDomainName

 The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
 


dnsIpAddrs
SdkInternalList<T> dnsIpAddrs

 The IP addresses of the remote DNS server associated with RemoteDomainName.
 








Class com.amazonaws.services.directory.model.CreateConditionalForwarderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.CreateDirectoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The fully qualified name for the directory, such as corp.example.com.
 


shortName
String shortName

 The NetBIOS name of the directory, such as CORP.
 


password
String password

 The password for the directory administrator. The directory creation process creates a directory administrator
 account with the user name Administrator and this password.
 
 
 If you need to change the password for the administrator account, you can use the ResetUserPassword API
 call.
 


description
String description

 A description for the directory.
 


size
String size

 The size of the directory.
 


vpcSettings
DirectoryVpcSettings vpcSettings

 A DirectoryVpcSettings object that contains additional information for the operation.
 


tags
SdkInternalList<T> tags

 The tags to be assigned to the Simple AD directory.
 








Class com.amazonaws.services.directory.model.CreateDirectoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory that was created.
 








Class com.amazonaws.services.directory.model.CreateLogSubscriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier of the directory to which you want to subscribe and receive real-time logs to your specified
 CloudWatch log group.
 


logGroupName
String logGroupName

 The name of the CloudWatch log group where the real-time domain controller logs are forwarded.
 








Class com.amazonaws.services.directory.model.CreateLogSubscriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.CreateMicrosoftADRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The fully qualified domain name for the AWS Managed Microsoft AD directory, such as corp.example.com
 . This name will resolve inside your VPC only. It does not need to be publicly resolvable.
 


shortName
String shortName

 The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default
 to the first part of your directory DNS. For example, CORP for the directory DNS
 corp.example.com.
 


password
String password

 The password for the default administrative user named Admin.
 
 
 If you need to change the password for the administrator account, you can use the ResetUserPassword API
 call.
 


description
String description

 A description for the directory. This label will appear on the AWS console Directory Details page
 after the directory is created.
 


vpcSettings
DirectoryVpcSettings vpcSettings

 Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
 


edition
String edition

 AWS Managed Microsoft AD is available in two editions: Standard and Enterprise.
 Enterprise is the default.
 


tags
SdkInternalList<T> tags

 The tags to be assigned to the AWS Managed Microsoft AD directory.
 








Class com.amazonaws.services.directory.model.CreateMicrosoftADResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory that was created.
 








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


Serialized Fields


directoryId
String directoryId

 The identifier of the directory of which to take a snapshot.
 


name
String name

 The descriptive name to apply to the snapshot.
 








Class com.amazonaws.services.directory.model.CreateSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


snapshotId
String snapshotId

 The identifier of the snapshot that was created.
 








Class com.amazonaws.services.directory.model.CreateTrustRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The Directory ID of the AWS Managed Microsoft AD directory for which to establish the trust relationship.
 


remoteDomainName
String remoteDomainName

 The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.
 


trustPassword
String trustPassword

 The trust password. The must be the same password that was used when creating the trust relationship on the
 external domain.
 


trustDirection
String trustDirection

 The direction of the trust relationship.
 


trustType
String trustType

 The trust relationship type. Forest is the default.
 


conditionalForwarderIpAddrs
SdkInternalList<T> conditionalForwarderIpAddrs

 The IP addresses of the remote DNS server associated with RemoteDomainName.
 


selectiveAuth
String selectiveAuth

 Optional parameter to enable selective authentication for the trust.
 








Class com.amazonaws.services.directory.model.CreateTrustResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trustId
String trustId

 A unique identifier for the trust relationship that was created.
 








Class com.amazonaws.services.directory.model.DeleteConditionalForwarderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The directory ID for which you are deleting the conditional forwarder.
 


remoteDomainName
String remoteDomainName

 The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional
 forwarder.
 








Class com.amazonaws.services.directory.model.DeleteConditionalForwarderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.DeleteDirectoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory to delete.
 








Class com.amazonaws.services.directory.model.DeleteDirectoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directoryId
String directoryId

 The directory identifier.
 








Class com.amazonaws.services.directory.model.DeleteLogSubscriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier of the directory whose log subscription you want to delete.
 








Class com.amazonaws.services.directory.model.DeleteLogSubscriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


snapshotId
String snapshotId

 The identifier of the directory snapshot to be deleted.
 








Class com.amazonaws.services.directory.model.DeleteSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


snapshotId
String snapshotId

 The identifier of the directory snapshot that was deleted.
 








Class com.amazonaws.services.directory.model.DeleteTrustRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trustId
String trustId

 The Trust ID of the trust relationship to be deleted.
 


deleteAssociatedConditionalForwarder
Boolean deleteAssociatedConditionalForwarder

 Delete a conditional forwarder as part of a DeleteTrustRequest.
 








Class com.amazonaws.services.directory.model.DeleteTrustResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trustId
String trustId

 The Trust ID of the trust relationship that was deleted.
 








Class com.amazonaws.services.directory.model.DeregisterCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory.
 


certificateId
String certificateId

 The identifier of the certificate.
 








Class com.amazonaws.services.directory.model.DeregisterCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.DeregisterEventTopicRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS
 topic.
 


topicName
String topicName

 The name of the SNS topic from which to remove the directory as a publisher.
 








Class com.amazonaws.services.directory.model.DeregisterEventTopicResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.DescribeCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory.
 


certificateId
String certificateId

 The identifier of the certificate.
 








Class com.amazonaws.services.directory.model.DescribeCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificate
Certificate certificate

 Information about the certificate, including registered date time, certificate state, the reason for the state,
 expiration date time, and certificate common name.
 








Class com.amazonaws.services.directory.model.DescribeConditionalForwardersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The directory ID for which to get the list of associated conditional forwarders.
 


remoteDomainNames
SdkInternalList<T> remoteDomainNames

 The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional
 forwarders. If this member is null, all conditional forwarders are returned.
 








Class com.amazonaws.services.directory.model.DescribeConditionalForwardersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


conditionalForwarders
SdkInternalList<T> conditionalForwarders

 The list of conditional forwarders that have been created.
 








Class com.amazonaws.services.directory.model.DescribeDirectoriesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryIds
SdkInternalList<T> directoryIds

 A list of identifiers of the directories for which to obtain the information. If this member is null, all
 directories that belong to the current account are returned.
 
 
 An empty list results in an InvalidParameterException being thrown.
 


nextToken
String nextToken

 The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories.
 Pass null if this is the first call.
 


limit
Integer limit

 The maximum number of items to return. If this value is zero, the maximum number of items is specified by the
 limitations of the operation.
 








Class com.amazonaws.services.directory.model.DescribeDirectoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directoryDescriptions
SdkInternalList<T> directoryDescriptions

 The list of DirectoryDescription objects that were retrieved.
 
 
 It is possible that this list contains less than the number of items specified in the Limit member
 of the request. This occurs if there are less than the requested number of items left to retrieve, or if the
 limitations of the operation have been exceeded.
 


nextToken
String nextToken

 If not null, more results are available. Pass this value for the NextToken parameter in a subsequent
 call to DescribeDirectories to retrieve the next set of items.
 








Class com.amazonaws.services.directory.model.DescribeDomainControllersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier of the directory for which to retrieve the domain controller information.
 


domainControllerIds
SdkInternalList<T> domainControllerIds

 A list of identifiers for the domain controllers whose information will be provided.
 


nextToken
String nextToken

 The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers.
 Pass null if this is the first call.
 


limit
Integer limit

 The maximum number of items to return.
 








Class com.amazonaws.services.directory.model.DescribeDomainControllersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainControllers
SdkInternalList<T> domainControllers

 List of the DomainController objects that were retrieved.
 


nextToken
String nextToken

 If not null, more results are available. Pass this value for the NextToken parameter in a subsequent
 call to DescribeDomainControllers retrieve the next set of items.
 








Class com.amazonaws.services.directory.model.DescribeEventTopicsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all
 Directory IDs are returned.
 


topicNames
SdkInternalList<T> topicNames

 A list of SNS topic names for which to obtain the information. If this member is null, all associations for the
 specified Directory ID are returned.
 
 
 An empty list results in an InvalidParameterException being thrown.
 








Class com.amazonaws.services.directory.model.DescribeEventTopicsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventTopics
SdkInternalList<T> eventTopics

 A list of SNS topic names that receive status messages from the specified Directory ID.
 








Class com.amazonaws.services.directory.model.DescribeLDAPSSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory.
 


type
String type

 The type of LDAP security the customer wants to enable, either server or client. Currently supports only
 Client, (the default).
 


nextToken
String nextToken

 The type of next token used for pagination.
 


limit
Integer limit

 Specifies the number of items that should be displayed on one page.
 








Class com.amazonaws.services.directory.model.DescribeLDAPSSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


lDAPSSettingsInfo
SdkInternalList<T> lDAPSSettingsInfo

 Information about LDAP security for the specified directory, including status of enablement, state last updated
 date time, and the reason for the state.
 


nextToken
String nextToken

 The next token used to retrieve the LDAPS settings if the number of setting types exceeds page limit and there is
 another page.
 








Class com.amazonaws.services.directory.model.DescribeSharedDirectoriesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ownerDirectoryId
String ownerDirectoryId

 Returns the identifier of the directory in the directory owner account.
 


sharedDirectoryIds
SdkInternalList<T> sharedDirectoryIds

 A list of identifiers of all shared directories in your account.
 


nextToken
String nextToken

 The DescribeSharedDirectoriesResult.NextToken value from a previous call to
 DescribeSharedDirectories. Pass null if this is the first call.
 


limit
Integer limit

 The number of shared directories to return in the response object.
 








Class com.amazonaws.services.directory.model.DescribeSharedDirectoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sharedDirectories
SdkInternalList<T> sharedDirectories

 A list of all shared directories in your account.
 


nextToken
String nextToken

 If not null, token that indicates that more results are available. Pass this value for the NextToken
 parameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items.
 








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


Serialized Fields


directoryId
String directoryId

 The identifier of the directory for which to retrieve snapshot information.
 


snapshotIds
SdkInternalList<T> snapshotIds

 A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all
 snapshots are returned using the Limit and NextToken members.
 


nextToken
String nextToken

 The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if
 this is the first call.
 


limit
Integer limit

 The maximum number of objects to return.
 








Class com.amazonaws.services.directory.model.DescribeSnapshotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


snapshots
SdkInternalList<T> snapshots

 The list of Snapshot objects that were retrieved.
 
 
 It is possible that this list contains less than the number of items specified in the Limit member of the
 request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations
 of the operation have been exceeded.
 


nextToken
String nextToken

 If not null, more results are available. Pass this value in the NextToken member of a subsequent call to
 DescribeSnapshots.
 








Class com.amazonaws.services.directory.model.DescribeTrustsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The Directory ID of the AWS directory that is a part of the requested trust relationship.
 


trustIds
SdkInternalList<T> trustIds

 A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all
 trust relationships that belong to the current account are returned.
 
 
 An empty list results in an InvalidParameterException being thrown.
 


nextToken
String nextToken

 The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this
 is the first call.
 


limit
Integer limit

 The maximum number of objects to return.
 








Class com.amazonaws.services.directory.model.DescribeTrustsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trusts
SdkInternalList<T> trusts

 The list of Trust objects that were retrieved.
 
 
 It is possible that this list contains less than the number of items specified in the Limit member of the
 request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations
 of the operation have been exceeded.
 


nextToken
String nextToken

 If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call
 to DescribeTrusts to retrieve the next set of items.
 








Class com.amazonaws.services.directory.model.DirectoryAlreadySharedException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.DirectoryConnectSettings extends Object implements Serializable


Serialized Fields


vpcId
String vpcId

 The identifier of the VPC in which the AD Connector is created.
 


subnetIds
SdkInternalList<T> subnetIds

 A list of subnet identifiers in the VPC in which the AD Connector is created.
 


customerDnsIps
SdkInternalList<T> customerDnsIps

 A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory.
 


customerUserName
String customerUserName

 The user name of an account in the on-premises directory that is used to connect to the directory. This account
 must have the following permissions:
 
 
 
 
 Read users and groups
 
 
 
 
 Create computer objects
 
 
 
 
 Join computers to the domain
 
 
 








Class com.amazonaws.services.directory.model.DirectoryConnectSettingsDescription extends Object implements Serializable


Serialized Fields


vpcId
String vpcId

 The identifier of the VPC that the AD Connector is in.
 


subnetIds
SdkInternalList<T> subnetIds

 A list of subnet identifiers in the VPC that the AD Connector is in.
 


customerUserName
String customerUserName

 The user name of the service account in the on-premises directory.
 


securityGroupId
String securityGroupId

 The security group identifier for the AD Connector directory.
 


availabilityZones
SdkInternalList<T> availabilityZones

 A list of the Availability Zones that the directory is in.
 


connectIps
SdkInternalList<T> connectIps

 The IP addresses of the AD Connector servers.
 








Class com.amazonaws.services.directory.model.DirectoryDescription extends Object implements Serializable


Serialized Fields


directoryId
String directoryId

 The directory identifier.
 


name
String name

 The fully qualified name of the directory.
 


shortName
String shortName

 The short name of the directory.
 


size
String size

 The directory size.
 


edition
String edition

 The edition associated with this directory.
 


alias
String alias

 The alias for the directory. If no alias has been created for the directory, the alias is the directory
 identifier, such as d-XXXXXXXXXX.
 


accessUrl
String accessUrl

 The access URL for the directory, such as http://<alias>.awsapps.com. If no alias has been
 created for the directory, <alias> is the directory identifier, such as
 d-XXXXXXXXXX.
 


description
String description

 The description for the directory.
 


dnsIpAddrs
SdkInternalList<T> dnsIpAddrs

 The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the
 IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP
 addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is
 connected.
 


stage
String stage

 The current stage of the directory.
 


shareStatus
String shareStatus

 Current directory status of the shared AWS Managed Microsoft AD directory.
 


shareMethod
String shareMethod

 The method used when sharing a directory to determine whether the directory should be shared within your AWS
 organization (ORGANIZATIONS) or with any AWS account by sending a shared directory request (
 HANDSHAKE).
 


shareNotes
String shareNotes

 A directory share request that is sent by the directory owner to the directory consumer. The request includes a
 typed message to help the directory consumer administrator determine whether to approve or reject the share
 invitation.
 


launchTime
Date launchTime

 Specifies when the directory was created.
 


stageLastUpdatedDateTime
Date stageLastUpdatedDateTime

 The date and time that the stage was last updated.
 


type
String type

 The directory size.
 


vpcSettings
DirectoryVpcSettingsDescription vpcSettings

 A DirectoryVpcSettingsDescription object that contains additional information about a directory. This
 member is only present if the directory is a Simple AD or Managed AD directory.
 


connectSettings
DirectoryConnectSettingsDescription connectSettings

 A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector
 directory. This member is only present if the directory is an AD Connector directory.
 


radiusSettings
RadiusSettings radiusSettings

 A RadiusSettings object that contains information about the RADIUS server configured for this directory.
 


radiusStatus
String radiusStatus

 The status of the RADIUS MFA server connection.
 


stageReason
String stageReason

 Additional information about the directory stage.
 


ssoEnabled
Boolean ssoEnabled

 Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and
 DisableSso.
 


desiredNumberOfDomainControllers
Integer desiredNumberOfDomainControllers

 The desired number of domain controllers in the directory if the directory is Microsoft AD.
 


ownerDirectoryDescription
OwnerDirectoryDescription ownerDirectoryDescription

 Describes the AWS Managed Microsoft AD directory in the directory owner account.
 








Class com.amazonaws.services.directory.model.DirectoryDoesNotExistException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.DirectoryLimitExceededException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.DirectoryLimits extends Object implements Serializable


Serialized Fields


cloudOnlyDirectoriesLimit
Integer cloudOnlyDirectoriesLimit

 The maximum number of cloud directories allowed in the Region.
 


cloudOnlyDirectoriesCurrentCount
Integer cloudOnlyDirectoriesCurrentCount

 The current number of cloud directories in the Region.
 


cloudOnlyDirectoriesLimitReached
Boolean cloudOnlyDirectoriesLimitReached

 Indicates if the cloud directory limit has been reached.
 


cloudOnlyMicrosoftADLimit
Integer cloudOnlyMicrosoftADLimit

 The maximum number of AWS Managed Microsoft AD directories allowed in the region.
 


cloudOnlyMicrosoftADCurrentCount
Integer cloudOnlyMicrosoftADCurrentCount

 The current number of AWS Managed Microsoft AD directories in the region.
 


cloudOnlyMicrosoftADLimitReached
Boolean cloudOnlyMicrosoftADLimitReached

 Indicates if the AWS Managed Microsoft AD directory limit has been reached.
 


connectedDirectoriesLimit
Integer connectedDirectoriesLimit

 The maximum number of connected directories allowed in the Region.
 


connectedDirectoriesCurrentCount
Integer connectedDirectoriesCurrentCount

 The current number of connected directories in the Region.
 


connectedDirectoriesLimitReached
Boolean connectedDirectoriesLimitReached

 Indicates if the connected directory limit has been reached.
 








Class com.amazonaws.services.directory.model.DirectoryNotSharedException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.DirectoryUnavailableException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.DirectoryVpcSettings extends Object implements Serializable


Serialized Fields


vpcId
String vpcId

 The identifier of the VPC in which to create the directory.
 


subnetIds
SdkInternalList<T> subnetIds

 The identifiers of the subnets for the directory servers. The two subnets must be in different Availability
 Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.
 








Class com.amazonaws.services.directory.model.DirectoryVpcSettingsDescription extends Object implements Serializable


Serialized Fields


vpcId
String vpcId

 The identifier of the VPC that the directory is in.
 


subnetIds
SdkInternalList<T> subnetIds

 The identifiers of the subnets for the directory servers.
 


securityGroupId
String securityGroupId

 The domain controller security group identifier for the directory.
 


availabilityZones
SdkInternalList<T> availabilityZones

 The list of Availability Zones that the directory is in.
 








Class com.amazonaws.services.directory.model.DisableLDAPSRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory.
 


type
String type

 The type of LDAP security that the customer wants to enable. The security can be either server or client, but
 currently only the default Client is supported.
 








Class com.amazonaws.services.directory.model.DisableLDAPSResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.DisableRadiusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory for which to disable MFA.
 








Class com.amazonaws.services.directory.model.DisableRadiusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.DisableSsoRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory for which to disable single-sign on.
 


userName
String userName

 The username of an alternate account to use to disable single-sign on. This is only used for AD Connector
 directories. This account must have privileges to remove a service principal name.
 
 
 If the AD Connector service account does not have privileges to remove a service principal name, you can specify
 an alternate account with the UserName and Password parameters. These credentials are only used to
 disable single sign-on and are not stored by the service. The AD Connector service account is not changed.
 


password
String password

 The password of an alternate account to use to disable single-sign on. This is only used for AD Connector
 directories. For more information, see the UserName parameter.
 








Class com.amazonaws.services.directory.model.DisableSsoResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.DomainController extends Object implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier of the directory where the domain controller resides.
 


domainControllerId
String domainControllerId

 Identifies a specific domain controller in the directory.
 


dnsIpAddr
String dnsIpAddr

 The IP address of the domain controller.
 


vpcId
String vpcId

 The identifier of the VPC that contains the domain controller.
 


subnetId
String subnetId

 Identifier of the subnet in the VPC that contains the domain controller.
 


availabilityZone
String availabilityZone

 The Availability Zone where the domain controller is located.
 


status
String status

 The status of the domain controller.
 


statusReason
String statusReason

 A description of the domain controller state.
 


launchTime
Date launchTime

 Specifies when the domain controller was created.
 


statusLastUpdatedDateTime
Date statusLastUpdatedDateTime

 The date and time that the status was last updated.
 








Class com.amazonaws.services.directory.model.DomainControllerLimitExceededException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.EnableLDAPSRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory.
 


type
String type

 The type of LDAP security the customer wants to enable. The security can be either server or client, but
 currently only the default Client is supported.
 








Class com.amazonaws.services.directory.model.EnableLDAPSResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.EnableRadiusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory for which to enable MFA.
 


radiusSettings
RadiusSettings radiusSettings

 A RadiusSettings object that contains information about the RADIUS server.
 








Class com.amazonaws.services.directory.model.EnableRadiusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.EnableSsoRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory for which to enable single-sign on.
 


userName
String userName

 The username of an alternate account to use to enable single-sign on. This is only used for AD Connector
 directories. This account must have privileges to add a service principal name.
 
 
 If the AD Connector service account does not have privileges to add a service principal name, you can specify an
 alternate account with the UserName and Password parameters. These credentials are only used to
 enable single sign-on and are not stored by the service. The AD Connector service account is not changed.
 


password
String password

 The password of an alternate account to use to enable single-sign on. This is only used for AD Connector
 directories. For more information, see the UserName parameter.
 








Class com.amazonaws.services.directory.model.EnableSsoResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.EntityAlreadyExistsException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.EntityDoesNotExistException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.EventTopic extends Object implements Serializable


Serialized Fields


directoryId
String directoryId

 The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.
 


topicName
String topicName

 The name of an AWS SNS topic the receives status messages from the directory.
 


topicArn
String topicArn

 The SNS topic ARN (Amazon Resource Name).
 


createdDateTime
Date createdDateTime

 The date and time of when you associated your directory with the SNS topic.
 


status
String status

 The topic registration status.
 








Class com.amazonaws.services.directory.model.GetDirectoryLimitsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.directory.model.GetDirectoryLimitsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


directoryLimits
DirectoryLimits directoryLimits

 A DirectoryLimits object that contains the directory limits for the current rRegion.
 








Class com.amazonaws.services.directory.model.GetSnapshotLimitsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 Contains the identifier of the directory to obtain the limits for.
 








Class com.amazonaws.services.directory.model.GetSnapshotLimitsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


snapshotLimits
SnapshotLimits snapshotLimits

 A SnapshotLimits object that contains the manual snapshot limits for the specified directory.
 








Class com.amazonaws.services.directory.model.InsufficientPermissionsException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.InvalidCertificateException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.InvalidLDAPSStatusException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.InvalidNextTokenException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.InvalidParameterException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.InvalidPasswordException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.InvalidTargetException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.IpRoute extends Object implements Serializable


Serialized Fields


cidrIp
String cidrIp

 IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server
 used for your on-premises domain. For a single IP address use a CIDR address block with /32. For example
 10.0.0.0/32.
 


description
String description

 Description of the address block.
 








Class com.amazonaws.services.directory.model.IpRouteInfo extends Object implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier (ID) of the directory associated with the IP addresses.
 


cidrIp
String cidrIp

 IP address block in the IpRoute.
 


ipRouteStatusMsg
String ipRouteStatusMsg

 The status of the IP address block.
 


addedDateTime
Date addedDateTime

 The date and time the address block was added to the directory.
 


ipRouteStatusReason
String ipRouteStatusReason

 The reason for the IpRouteStatusMsg.
 


description
String description

 Description of the IpRouteInfo.
 








Class com.amazonaws.services.directory.model.IpRouteLimitExceededException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.LDAPSSettingInfo extends Object implements Serializable


Serialized Fields


lDAPSStatus
String lDAPSStatus

 The state of the LDAPS settings.
 


lDAPSStatusReason
String lDAPSStatusReason

 Describes a state change for LDAPS.
 


lastUpdatedDateTime
Date lastUpdatedDateTime

 The date and time when the LDAPS settings were last updated.
 








Class com.amazonaws.services.directory.model.ListCertificatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory.
 


nextToken
String nextToken

 A token for requesting another page of certificates if the NextToken response element indicates that
 more certificates are available. Use the value of the returned NextToken element in your request
 until the token comes back as null. Pass null if this is the first call.
 


limit
Integer limit

 The number of items that should show up on one page
 








Class com.amazonaws.services.directory.model.ListCertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 Indicates whether another page of certificates is available when the number of available certificates exceeds the
 page limit.
 


certificatesInfo
SdkInternalList<T> certificatesInfo

 A list of certificates with basic details including certificate ID, certificate common name, certificate state.
 








Class com.amazonaws.services.directory.model.ListIpRoutesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier (ID) of the directory for which you want to retrieve the IP addresses.
 


nextToken
String nextToken

 The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the
 first call.
 


limit
Integer limit

 Maximum number of items to return. If this value is zero, the maximum number of items is specified by the
 limitations of the operation.
 








Class com.amazonaws.services.directory.model.ListIpRoutesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ipRoutesInfo
SdkInternalList<T> ipRoutesInfo

 A list of IpRoutes.
 


nextToken
String nextToken

 If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call
 to ListIpRoutes to retrieve the next set of items.
 








Class com.amazonaws.services.directory.model.ListLogSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 If a DirectoryID is provided, lists only the log subscription associated with that directory. If no
 DirectoryId is provided, lists all log subscriptions associated with your AWS account. If there are no log
 subscriptions for the AWS account or the directory, an empty list will be returned.
 


nextToken
String nextToken

 The token for the next set of items to return.
 


limit
Integer limit

 The maximum number of items returned.
 








Class com.amazonaws.services.directory.model.ListLogSubscriptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


logSubscriptions
SdkInternalList<T> logSubscriptions

 A list of active LogSubscription objects for calling the AWS account.
 


nextToken
String nextToken

 The token for the next set of items to return.
 








Class com.amazonaws.services.directory.model.ListSchemaExtensionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory from which to retrieve the schema extension information.
 


nextToken
String nextToken

 The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions.
 Pass null if this is the first call.
 


limit
Integer limit

 The maximum number of items to return.
 








Class com.amazonaws.services.directory.model.ListSchemaExtensionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


schemaExtensionsInfo
SdkInternalList<T> schemaExtensionsInfo

 Information about the schema extensions applied to the directory.
 


nextToken
String nextToken

 If not null, more results are available. Pass this value for the NextToken parameter in a subsequent
 call to ListSchemaExtensions to retrieve the next set of items.
 








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


Serialized Fields


resourceId
String resourceId

 Identifier (ID) of the directory for which you want to retrieve tags.
 


nextToken
String nextToken

 Reserved for future use.
 


limit
Integer limit

 Reserved for future use.
 








Class com.amazonaws.services.directory.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 List of tags returned by the ListTagsForResource operation.
 


nextToken
String nextToken

 Reserved for future use.
 








Class com.amazonaws.services.directory.model.LogSubscription extends Object implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier (ID) of the directory that you want to associate with the log subscription.
 


logGroupName
String logGroupName

 The name of the log group.
 


subscriptionCreatedDateTime
Date subscriptionCreatedDateTime

 The date and time that the log subscription was created.
 








Class com.amazonaws.services.directory.model.NoAvailableCertificateException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.OrganizationsException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.OwnerDirectoryDescription extends Object implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier of the AWS Managed Microsoft AD directory in the directory owner account.
 


accountId
String accountId

 Identifier of the directory owner account.
 


dnsIpAddrs
SdkInternalList<T> dnsIpAddrs

 IP address of the directory’s domain controllers.
 


vpcSettings
DirectoryVpcSettingsDescription vpcSettings

 Information about the VPC settings for the directory.
 


radiusSettings
RadiusSettings radiusSettings

 A RadiusSettings object that contains information about the RADIUS server.
 


radiusStatus
String radiusStatus

 Information about the status of the RADIUS server.
 








Class com.amazonaws.services.directory.model.RadiusSettings extends Object implements Serializable


Serialized Fields


radiusServers
SdkInternalList<T> radiusServers

 An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your
 RADIUS server load balancer.
 


radiusPort
Integer radiusPort

 The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic
 over this port from the AWS Directory Service servers.
 


radiusTimeout
Integer radiusTimeout

 The amount of time, in seconds, to wait for the RADIUS server to respond.
 


radiusRetries
Integer radiusRetries

 The maximum number of times that communication with the RADIUS server is attempted.
 


sharedSecret
String sharedSecret

 Required for enabling RADIUS on the directory.
 


authenticationProtocol
String authenticationProtocol

 The protocol specified for your RADIUS endpoints.
 


displayLabel
String displayLabel

 Not currently used.
 


useSameUsername
Boolean useSameUsername

 Not currently used.
 








Class com.amazonaws.services.directory.model.RegisterCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory.
 


certificateData
String certificateData

 The certificate PEM string that needs to be registered.
 








Class com.amazonaws.services.directory.model.RegisterCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificateId
String certificateId

 The identifier of the certificate.
 








Class com.amazonaws.services.directory.model.RegisterEventTopicRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The Directory ID that will publish status messages to the SNS topic.
 


topicName
String topicName

 The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region
 as the specified Directory ID.
 








Class com.amazonaws.services.directory.model.RegisterEventTopicResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.RejectSharedDirectoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sharedDirectoryId
String sharedDirectoryId

 Identifier of the shared directory in the directory consumer account. This identifier is different for each
 directory owner account.
 








Class com.amazonaws.services.directory.model.RejectSharedDirectoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sharedDirectoryId
String sharedDirectoryId

 Identifier of the shared directory in the directory consumer account.
 








Class com.amazonaws.services.directory.model.RemoveIpRoutesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier (ID) of the directory from which you want to remove the IP addresses.
 


cidrIps
SdkInternalList<T> cidrIps

 IP address blocks that you want to remove.
 








Class com.amazonaws.services.directory.model.RemoveIpRoutesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


resourceId
String resourceId

 Identifier (ID) of the directory from which to remove the tag.
 


tagKeys
SdkInternalList<T> tagKeys

 The tag key (name) of the tag to be removed.
 








Class com.amazonaws.services.directory.model.RemoveTagsFromResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.ResetUserPasswordRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the user resides.
 


userName
String userName

 The user name of the user whose password will be reset.
 


newPassword
String newPassword

 The new password that will be reset.
 








Class com.amazonaws.services.directory.model.ResetUserPasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.RestoreFromSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


snapshotId
String snapshotId

 The identifier of the snapshot to restore from.
 








Class com.amazonaws.services.directory.model.RestoreFromSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.SchemaExtensionInfo extends Object implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory to which the schema extension is applied.
 


schemaExtensionId
String schemaExtensionId

 The identifier of the schema extension.
 


description
String description

 A description of the schema extension.
 


schemaExtensionStatus
String schemaExtensionStatus

 The current status of the schema extension.
 


schemaExtensionStatusReason
String schemaExtensionStatusReason

 The reason for the SchemaExtensionStatus.
 


startDateTime
Date startDateTime

 The date and time that the schema extension started being applied to the directory.
 


endDateTime
Date endDateTime

 The date and time that the schema extension was completed.
 








Class com.amazonaws.services.directory.model.ServiceException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.SharedDirectory extends Object implements Serializable


Serialized Fields


ownerAccountId
String ownerAccountId

 Identifier of the directory owner account, which contains the directory that has been shared to the consumer
 account.
 


ownerDirectoryId
String ownerDirectoryId

 Identifier of the directory in the directory owner account.
 


shareMethod
String shareMethod

 The method used when sharing a directory to determine whether the directory should be shared within your AWS
 organization (ORGANIZATIONS) or with any AWS account by sending a shared directory request (
 HANDSHAKE).
 


sharedAccountId
String sharedAccountId

 Identifier of the directory consumer account that has access to the shared directory (
 OwnerDirectoryId) in the directory owner account.
 


sharedDirectoryId
String sharedDirectoryId

 Identifier of the shared directory in the directory consumer account. This identifier is different for each
 directory owner account.
 


shareStatus
String shareStatus

 Current directory status of the shared AWS Managed Microsoft AD directory.
 


shareNotes
String shareNotes

 A directory share request that is sent by the directory owner to the directory consumer. The request includes a
 typed message to help the directory consumer administrator determine whether to approve or reject the share
 invitation.
 


createdDateTime
Date createdDateTime

 The date and time that the shared directory was created.
 


lastUpdatedDateTime
Date lastUpdatedDateTime

 The date and time that the shared directory was last updated.
 








Class com.amazonaws.services.directory.model.ShareDirectoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.
 


shareNotes
String shareNotes

 A directory share request that is sent by the directory owner to the directory consumer. The request includes a
 typed message to help the directory consumer administrator determine whether to approve or reject the share
 invitation.
 


shareTarget
ShareTarget shareTarget

 Identifier for the directory consumer account with whom the directory is to be shared.
 


shareMethod
String shareMethod

 The method used when sharing a directory to determine whether the directory should be shared within your AWS
 organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request (
 HANDSHAKE).
 








Class com.amazonaws.services.directory.model.ShareDirectoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sharedDirectoryId
String sharedDirectoryId

 Identifier of the directory that is stored in the directory consumer account that is shared from the specified
 directory (DirectoryId).
 








Class com.amazonaws.services.directory.model.ShareLimitExceededException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.ShareTarget extends Object implements Serializable


Serialized Fields


id
String id

 Identifier of the directory consumer account.
 


type
String type

 Type of identifier to be used in the Id field.
 








Class com.amazonaws.services.directory.model.Snapshot extends Object implements Serializable


Serialized Fields


directoryId
String directoryId

 The directory identifier.
 


snapshotId
String snapshotId

 The snapshot identifier.
 


type
String type

 The snapshot type.
 


name
String name

 The descriptive name of the snapshot.
 


status
String status

 The snapshot status.
 


startTime
Date startTime

 The date and time that the snapshot was taken.
 








Class com.amazonaws.services.directory.model.SnapshotLimitExceededException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.SnapshotLimits extends Object implements Serializable


Serialized Fields


manualSnapshotsLimit
Integer manualSnapshotsLimit

 The maximum number of manual snapshots allowed.
 


manualSnapshotsCurrentCount
Integer manualSnapshotsCurrentCount

 The current number of manual snapshots of the directory.
 


manualSnapshotsLimitReached
Boolean manualSnapshotsLimitReached

 Indicates if the manual snapshot limit has been reached.
 








Class com.amazonaws.services.directory.model.StartSchemaExtensionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory for which the schema extension will be applied to.
 


createSnapshotBeforeSchemaExtension
Boolean createSnapshotBeforeSchemaExtension

 If true, creates a snapshot of the directory before applying the schema extension.
 


ldifContent
String ldifContent

 The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be
 formatted in an ldif file with \n. See the example request below for more details. The file size can be no larger
 than 1MB.
 


description
String description

 A description of the schema extension.
 








Class com.amazonaws.services.directory.model.StartSchemaExtensionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


schemaExtensionId
String schemaExtensionId

 The identifier of the schema extension that will be applied.
 








Class com.amazonaws.services.directory.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The
 string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java
 regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
 


value
String value

 The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of
 Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex:
 "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
 








Class com.amazonaws.services.directory.model.TagLimitExceededException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.Trust extends Object implements Serializable


Serialized Fields


directoryId
String directoryId

 The Directory ID of the AWS directory involved in the trust relationship.
 


trustId
String trustId

 The unique ID of the trust relationship.
 


remoteDomainName
String remoteDomainName

 The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.
 


trustType
String trustType

 The trust relationship type. Forest is the default.
 


trustDirection
String trustDirection

 The trust relationship direction.
 


trustState
String trustState

 The trust relationship state.
 


createdDateTime
Date createdDateTime

 The date and time that the trust relationship was created.
 


lastUpdatedDateTime
Date lastUpdatedDateTime

 The date and time that the trust relationship was last updated.
 


stateLastUpdatedDateTime
Date stateLastUpdatedDateTime

 The date and time that the TrustState was last updated.
 


trustStateReason
String trustStateReason

 The reason for the TrustState.
 


selectiveAuth
String selectiveAuth

 Current state of selective authentication for the trust.
 








Class com.amazonaws.services.directory.model.UnshareDirectoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the AWS Managed Microsoft AD directory that you want to stop sharing.
 


unshareTarget
UnshareTarget unshareTarget

 Identifier for the directory consumer account with whom the directory has to be unshared.
 








Class com.amazonaws.services.directory.model.UnshareDirectoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sharedDirectoryId
String sharedDirectoryId

 Identifier of the directory stored in the directory consumer account that is to be unshared from the specified
 directory (DirectoryId).
 








Class com.amazonaws.services.directory.model.UnshareTarget extends Object implements Serializable


Serialized Fields


id
String id

 Identifier of the directory consumer account.
 


type
String type

 Type of identifier to be used in the Id field.
 








Class com.amazonaws.services.directory.model.UnsupportedOperationException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.UpdateConditionalForwarderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The directory ID of the AWS directory for which to update the conditional forwarder.
 


remoteDomainName
String remoteDomainName

 The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
 


dnsIpAddrs
SdkInternalList<T> dnsIpAddrs

 The updated IP addresses of the remote DNS server associated with the conditional forwarder.
 








Class com.amazonaws.services.directory.model.UpdateConditionalForwarderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.UpdateNumberOfDomainControllersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 Identifier of the directory to which the domain controllers will be added or removed.
 


desiredNumber
Integer desiredNumber

 The number of domain controllers desired in the directory.
 








Class com.amazonaws.services.directory.model.UpdateNumberOfDomainControllersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.UpdateRadiusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


directoryId
String directoryId

 The identifier of the directory for which to update the RADIUS server information.
 


radiusSettings
RadiusSettings radiusSettings

 A RadiusSettings object that contains information about the RADIUS server.
 








Class com.amazonaws.services.directory.model.UpdateRadiusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.directory.model.UpdateTrustRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trustId
String trustId

 Identifier of the trust relationship.
 


selectiveAuth
String selectiveAuth

 Updates selective authentication for the trust.
 








Class com.amazonaws.services.directory.model.UpdateTrustResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId


trustId
String trustId

 Identifier of the trust relationship.
 








Class com.amazonaws.services.directory.model.UserDoesNotExistException extends AWSDirectoryServiceException implements Serializable

serialVersionUID:
1L



Serialized Fields


requestId
String requestId








Class com.amazonaws.services.directory.model.VerifyTrustRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trustId
String trustId

 The unique Trust ID of the trust relationship to verify.
 








Class com.amazonaws.services.directory.model.VerifyTrustResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trustId
String trustId

 The unique Trust ID of the trust relationship that was verified.
 








Package com.amazonaws.services.dlm.model




Class com.amazonaws.services.dlm.model.AmazonDLMException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dlm.model.CreateLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


executionRoleArn
String executionRoleArn

 The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
 


description
String description

 A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.
 


state
String state

 The desired activation state of the lifecycle policy after creation.
 


policyDetails
PolicyDetails policyDetails

 The configuration details of the lifecycle policy.
 


tags
Map<K,V> tags

 The tags to apply to the lifecycle policy during creation.
 








Class com.amazonaws.services.dlm.model.CreateLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyId
String policyId

 The identifier of the lifecycle policy.
 








Class com.amazonaws.services.dlm.model.CreateRule extends Object implements Serializable


Serialized Fields


interval
Integer interval

 The interval between snapshots. The supported values are 2, 3, 4, 6, 8, 12, and 24.
 


intervalUnit
String intervalUnit

 The interval unit.
 


times
List<E> times

 The time, in UTC, to start the operation. The supported format is hh:mm.
 
 
 The operation occurs within a one-hour window following the specified time.
 








Class com.amazonaws.services.dlm.model.CrossRegionCopyRetainRule extends Object implements Serializable


Serialized Fields


interval
Integer interval

 The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200
 weeks, or 36500 days.
 


intervalUnit
String intervalUnit

 The unit of time for time-based retention.
 








Class com.amazonaws.services.dlm.model.CrossRegionCopyRule extends Object implements Serializable


Serialized Fields


targetRegion
String targetRegion

 The target Region.
 


encrypted
Boolean encrypted

 To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using
 this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by
 default is not enabled.
 


cmkArn
String cmkArn

 The Amazon Resource Name (ARN) of the AWS KMS customer master key (CMK) to use for EBS encryption. If this
 parameter is not specified, your AWS managed CMK for EBS is used.
 


copyTags
Boolean copyTags

 Copy all user-defined tags from the source snapshot to the copied snapshot.
 


retainRule
CrossRegionCopyRetainRule retainRule

 The retention rule.
 








Class com.amazonaws.services.dlm.model.DeleteLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The identifier of the lifecycle policy.
 








Class com.amazonaws.services.dlm.model.DeleteLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.dlm.model.FastRestoreRule extends Object implements Serializable


Serialized Fields


count
Integer count

 The number of snapshots to be enabled with fast snapshot restore.
 


interval
Integer interval

 The amount of time to enable fast snapshot restore. The maximum is 100 years. This is equivalent to 1200 months,
 5200 weeks, or 36500 days.
 


intervalUnit
String intervalUnit

 The unit of time for enabling fast snapshot restore.
 


availabilityZones
List<E> availabilityZones

 The Availability Zones in which to enable fast snapshot restore.
 








Class com.amazonaws.services.dlm.model.GetLifecyclePoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyIds
List<E> policyIds

 The identifiers of the data lifecycle policies.
 


state
String state

 The activation state.
 


resourceTypes
List<E> resourceTypes

 The resource type.
 


targetTags
List<E> targetTags

 The target tag for a policy.
 
 
 Tags are strings in the format key=value.
 


tagsToAdd
List<E> tagsToAdd

 The tags to add to objects created by the policy.
 
 
 Tags are strings in the format key=value.
 
 
 These user-defined tags are added in addition to the AWS-added lifecycle tags.
 








Class com.amazonaws.services.dlm.model.GetLifecyclePoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policies
List<E> policies

 Summary information about the lifecycle policies.
 








Class com.amazonaws.services.dlm.model.GetLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The identifier of the lifecycle policy.
 








Class com.amazonaws.services.dlm.model.GetLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
LifecyclePolicy policy

 Detailed information about the lifecycle policy.
 








Class com.amazonaws.services.dlm.model.InternalServerException extends AmazonDLMException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.dlm.model.InvalidRequestException extends AmazonDLMException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code


requiredParameters
List<E> requiredParameters

 The request omitted one or more required parameters.
 


mutuallyExclusiveParameters
List<E> mutuallyExclusiveParameters

 The request included parameters that cannot be provided together.
 








Class com.amazonaws.services.dlm.model.LifecyclePolicy extends Object implements Serializable


Serialized Fields


policyId
String policyId

 The identifier of the lifecycle policy.
 


description
String description

 The description of the lifecycle policy.
 


state
String state

 The activation state of the lifecycle policy.
 


statusMessage
String statusMessage

 The description of the status.
 


executionRoleArn
String executionRoleArn

 The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
 


dateCreated
Date dateCreated

 The local date and time when the lifecycle policy was created.
 


dateModified
Date dateModified

 The local date and time when the lifecycle policy was last modified.
 


policyDetails
PolicyDetails policyDetails

 The configuration of the lifecycle policy
 


tags
Map<K,V> tags

 The tags.
 


policyArn
String policyArn

 The Amazon Resource Name (ARN) of the policy.
 








Class com.amazonaws.services.dlm.model.LifecyclePolicySummary extends Object implements Serializable


Serialized Fields


policyId
String policyId

 The identifier of the lifecycle policy.
 


description
String description

 The description of the lifecycle policy.
 


state
String state

 The activation state of the lifecycle policy.
 


tags
Map<K,V> tags

 The tags.
 








Class com.amazonaws.services.dlm.model.LimitExceededException extends AmazonDLMException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code


resourceType
String resourceType

 Value is the type of resource for which a limit was exceeded.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 








Class com.amazonaws.services.dlm.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 Information about the tags.
 








Class com.amazonaws.services.dlm.model.Parameters extends Object implements Serializable


Serialized Fields


excludeBootVolume
Boolean excludeBootVolume

 When executing an EBS Snapshot Management – Instance policy, execute all CreateSnapshots calls with the
 excludeBootVolume set to the supplied field. Defaults to false. Only valid for EBS Snapshot
 Management – Instance policies.
 








Class com.amazonaws.services.dlm.model.PolicyDetails extends Object implements Serializable


Serialized Fields


policyType
String policyType

 This field determines the valid target resource types and actions a policy can manage. This field defaults to
 EBS_SNAPSHOT_MANAGEMENT if not present.
 


resourceTypes
List<E> resourceTypes

 The resource type.
 


targetTags
List<E> targetTags

 The single tag that identifies targeted resources for this policy.
 


schedules
List<E> schedules

 The schedule of policy-defined actions.
 


parameters
Parameters parameters

 A set of optional parameters that can be provided by the policy.
 








Class com.amazonaws.services.dlm.model.ResourceNotFoundException extends AmazonDLMException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code


resourceType
String resourceType

 Value is the type of resource that was not found.
 


resourceIds
List<E> resourceIds

 Value is a list of resource IDs that were not found.
 








Class com.amazonaws.services.dlm.model.RetainRule extends Object implements Serializable


Serialized Fields


count
Integer count

 The number of snapshots to retain for each volume, up to a maximum of 1000.
 


interval
Integer interval

 The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200
 weeks, or 36500 days.
 


intervalUnit
String intervalUnit

 The unit of time for time-based retention.
 








Class com.amazonaws.services.dlm.model.Schedule extends Object implements Serializable


Serialized Fields


name
String name

 The name of the schedule.
 


copyTags
Boolean copyTags

 Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.
 


tagsToAdd
List<E> tagsToAdd

 The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle
 tags.
 


variableTags
List<E> variableTags

 A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any
 valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or
 $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.
 


createRule
CreateRule createRule

 The creation rule.
 


retainRule
RetainRule retainRule

 The retention rule.
 


fastRestoreRule
FastRestoreRule fastRestoreRule

 The rule for enabling fast snapshot restore.
 


crossRegionCopyRules
List<E> crossRegionCopyRules

 The rule for cross-Region snapshot copies.
 








Class com.amazonaws.services.dlm.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The tag key.
 


value
String value

 The tag value.
 








Class com.amazonaws.services.dlm.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 


tags
Map<K,V> tags

 One or more tags.
 








Class com.amazonaws.services.dlm.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.dlm.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 


tagKeys
List<E> tagKeys

 The tag keys.
 








Class com.amazonaws.services.dlm.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.dlm.model.UpdateLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The identifier of the lifecycle policy.
 


executionRoleArn
String executionRoleArn

 The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
 


state
String state

 The desired activation state of the lifecycle policy after creation.
 


description
String description

 A description of the lifecycle policy.
 


policyDetails
PolicyDetails policyDetails

 The configuration of the lifecycle policy. You cannot update the policy type or the resource type.
 








Class com.amazonaws.services.dlm.model.UpdateLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.docdb.model




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


Serialized Fields


resourceName
String resourceName

 The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name (ARN).
 


tags
List<E> tags

 The tags to be assigned to the Amazon DocumentDB resource.
 








Class com.amazonaws.services.docdb.model.AddTagsToResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.docdb.model.AmazonDocDBException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.ApplyPendingMaintenanceActionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceIdentifier
String resourceIdentifier

 The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.
 


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 can't be undone.
 
 
 Valid values:
 
 
 
 
 immediate - Apply the maintenance action immediately.
 
 
 
 
 next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
 
 
 
 
 undo-opt-in - Cancel any existing next-maintenance opt-in requests.
 
 
 








Class com.amazonaws.services.docdb.model.AuthorizationNotFoundException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


name
String name

 The name of the Availability Zone.
 








Class com.amazonaws.services.docdb.model.Certificate extends Object implements Serializable


Serialized Fields


certificateIdentifier
String certificateIdentifier

 The unique key that identifies a certificate.
 
 
 Example: rds-ca-2019
 


certificateType
String certificateType

 The type of the certificate.
 
 
 Example: CA
 


thumbprint
String thumbprint

 The thumbprint of the certificate.
 


validFrom
Date validFrom

 The starting date-time from which the certificate is valid.
 
 
 Example: 2019-07-31T17:57:09Z
 


validTill
Date validTill

 The date-time after which the certificate is no longer valid.
 
 
 Example: 2024-07-31T17:57:09Z
 


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) for the certificate.
 
 
 Example: arn:aws:rds:us-east-1::cert:rds-ca-2019
 








Class com.amazonaws.services.docdb.model.CertificateNotFoundException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.CloudwatchLogsExportConfiguration extends Object implements Serializable


Serialized Fields


enableLogTypes
List<E> enableLogTypes

 The list of log types to enable.
 


disableLogTypes
List<E> disableLogTypes

 The list of log types to disable.
 








Class com.amazonaws.services.docdb.model.CopyDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceDBClusterParameterGroupIdentifier
String sourceDBClusterParameterGroupIdentifier

 The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.
 
 
 Constraints:
 
 
 
 
 Must specify a valid DB cluster parameter group.
 
 
 
 
 If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter
 group identifier; for example, my-db-cluster-param-group, or a valid ARN.
 
 
 
 
 If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter
 group ARN; for example, arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.
 
 
 


targetDBClusterParameterGroupIdentifier
String targetDBClusterParameterGroupIdentifier

 The identifier for the copied DB cluster parameter group.
 
 
 Constraints:
 
 
 
 
 Cannot be null, empty, or blank.
 
 
 
 
 Must contain from 1 to 255 letters, numbers, or hyphens.
 
 
 
 
 The first character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: my-cluster-param-group1
 


targetDBClusterParameterGroupDescription
String targetDBClusterParameterGroupDescription

 A description for the copied DB cluster parameter group.
 


tags
List<E> tags

 The tags that are to be assigned to the parameter group.
 








Class com.amazonaws.services.docdb.model.CopyDBClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceDBClusterSnapshotIdentifier
String sourceDBClusterSnapshotIdentifier

 The identifier of the DB cluster snapshot to copy. This parameter is not case sensitive.
 
 
 You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.
 
 
 Constraints:
 
 
 
 
 Must specify a valid system snapshot in the "available" state.
 
 
 
 
 If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.
 
 
 
 
 If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN.
 
 
 
 
 Example: my-cluster-snapshot1
 


targetDBClusterSnapshotIdentifier
String targetDBClusterSnapshotIdentifier

 The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is
 not case sensitive.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 letters, numbers, or hyphens.
 
 
 
 
 The first character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: my-cluster-snapshot2
 


kmsKeyId
String kmsKeyId

 The AWS KMS key ID for an encrypted DB cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN),
 AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key.
 
 
 If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for
 KmsKeyId to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for
 KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same AWS KMS key as the
 source DB cluster snapshot.
 
 
 If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a
 value for KmsKeyId.
 
 
 To copy an encrypted DB cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID
 that you want to use to encrypt the copy of the DB cluster snapshot in the destination Region. AWS KMS encryption
 keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one Region
 in another Region.
 
 
 If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an
 error is returned.
 


preSignedUrl
String preSignedUrl

 The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action
 in the AWS Region that contains the source DB cluster snapshot to copy. You must use the
 PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another AWS Region.
 
 
 The presigned URL must be a valid request for the CopyDBSClusterSnapshot API action that can be
 executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The presigned URL
 request must contain the following parameter values:
 
 
 
 
 KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster
 snapshot in the destination AWS Region. This is the same identifier for both the
 CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained
 in the presigned URL.
 
 
 
 
 DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.
 
 
 
 
 SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster
 snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS
 Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your
 SourceDBClusterSnapshotIdentifier looks like the following example:
 arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115.
 
 
 


copyTags
Boolean copyTags

 Set to true to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot,
 and otherwise false. The default is false.
 


tags
List<E> tags

 The tags to be assigned to the DB cluster snapshot.
 








Class com.amazonaws.services.docdb.model.CreateDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group.
 
 
 Constraints:
 
 
 
 
 Must match the name of an existing DBClusterParameterGroup.
 
 
 
 
 
 This value is stored as a lowercase string.
 
 


dBParameterGroupFamily
String dBParameterGroupFamily

 The DB cluster parameter group family name.
 


description
String description

 The description for the DB cluster parameter group.
 


tags
List<E> tags

 The tags to be assigned to the DB cluster parameter group.
 








Class com.amazonaws.services.docdb.model.CreateDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZones
List<E> availabilityZones

 A list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in.
 


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. This parameter is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 letters, numbers, or hyphens.
 
 
 
 
 The first character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: my-cluster
 


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group to associate with this DB cluster.
 


vpcSecurityGroupIds
List<E> vpcSecurityGroupIds

 A list of EC2 VPC security groups to associate with this DB cluster.
 


dBSubnetGroupName
String dBSubnetGroupName

 A DB subnet group to associate with this DB cluster.
 
 
 Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
 
 
 Example: mySubnetgroup
 


engine
String engine

 The name of the database engine to be used for this DB cluster.
 
 
 Valid values: docdb
 


engineVersion
String engineVersion

 The version number of the database engine to use.
 


port
Integer port

 The port number on which the instances in the DB cluster accept connections.
 


masterUsername
String masterUsername

 The name of the master user for the DB cluster.
 
 
 Constraints:
 
 
 
 
 Must be from 1 to 63 letters or numbers.
 
 
 
 
 The 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 forward
 slash (/), double quote ("), or the "at" symbol (@).
 
 
 Constraints: Must contain from 8 to 100 characters.
 


preferredBackupWindow
String preferredBackupWindow

 The daily time range during which automated backups are created if automated backups are enabled using the
 BackupRetentionPeriod parameter.
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.
 
 
 Constraints:
 
 
 
 
 Must be in the format hh24:mi-hh24:mi.
 
 
 
 
 Must 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
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring
 on a random day of the week.
 
 
 Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
 
 
 Constraints: Minimum 30-minute window.
 


tags
List<E> tags

 The tags to be assigned to the DB cluster.
 


storageEncrypted
Boolean storageEncrypted

 Specifies whether the DB cluster is encrypted.
 


kmsKeyId
String kmsKeyId

 The AWS KMS key identifier for an encrypted DB cluster.
 
 
 The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating
 a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB
 cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
 
 
 If an encryption key is not specified in KmsKeyId:
 
 
 
 
 If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the
 encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key.
 
 
 
 
 If the StorageEncrypted parameter is true and ReplicationSourceIdentifier
 is not specified, Amazon DocumentDB uses 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.
 
 
 If you create a replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a
 KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS
 Region.
 


enableCloudwatchLogsExports
List<E> enableCloudwatchLogsExports

 A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
 


deletionProtection
Boolean deletionProtection

 Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot
 be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection
 protects clusters from being accidentally deleted.
 








Class com.amazonaws.services.docdb.model.CreateDBClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 letters, numbers, or hyphens.
 
 
 
 
 The first character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: my-cluster-snapshot1
 


dBClusterIdentifier
String dBClusterIdentifier

 The identifier of the DB cluster to create a snapshot for. This parameter is not case sensitive.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing DBCluster.
 
 
 
 
 Example: my-cluster
 


tags
List<E> tags

 The tags to be assigned to the DB cluster snapshot.
 








Class com.amazonaws.services.docdb.model.CreateDBInstanceRequest 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 letters, numbers, or hyphens.
 
 
 
 
 The first character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: mydbinstance
 


dBInstanceClass
String dBInstanceClass

 The compute and memory capacity of the DB instance; for example, db.r5.large.
 


engine
String engine

 The name of the database engine to be used for this instance.
 
 
 Valid value: docdb
 


availabilityZone
String availabilityZone

 The Amazon EC2 Availability Zone that the DB instance is created in.
 
 
 Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
 
 
 Example: us-east-1d
 
 
 Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter
 is set to true. The specified Availability Zone must be in the same AWS Region as the current
 endpoint.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
 
 
 Format: ddd:hh24:mi-ddd:hh24:mi
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring
 on a random day of the week.
 
 
 Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
 
 
 Constraints: Minimum 30-minute window.
 


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
 
 
 Default: true
 


tags
List<E> tags

 The tags to be assigned to the DB instance. You can assign up to 10 tags to an instance.
 


dBClusterIdentifier
String dBClusterIdentifier

 The identifier of the DB cluster that the instance will belong to.
 


promotionTier
Integer promotionTier

 A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after
 a failure of the existing primary instance.
 
 
 Default: 1
 
 
 Valid values: 0-15
 








Class com.amazonaws.services.docdb.model.CreateDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName

 The name for the DB subnet group. This value is stored as a lowercase string.
 
 
 Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not
 be default.
 
 
 Example: mySubnetgroup
 


dBSubnetGroupDescription
String dBSubnetGroupDescription

 The description for the DB subnet group.
 


subnetIds
List<E> subnetIds

 The Amazon EC2 subnet IDs for the DB subnet group.
 


tags
List<E> tags

 The tags to be assigned to the DB subnet group.
 








Class com.amazonaws.services.docdb.model.DBCluster extends Object implements Serializable


Serialized Fields


availabilityZones
List<E> availabilityZones

 Provides the list of Amazon 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.
 


dBClusterIdentifier
String dBClusterIdentifier

 Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
 


dBClusterParameterGroup
String dBClusterParameterGroup

 Specifies the name of the DB cluster parameter group for the DB cluster.
 


dBSubnetGroup
String dBSubnetGroup

 Specifies information on the subnet group that is associated with the DB cluster, including the name,
 description, and subnets in the subnet group.
 


status
String status

 Specifies the current state of this DB cluster.
 


percentProgress
String percentProgress

 Specifies the progress of the operation as a percentage.
 


earliestRestorableTime
Date earliestRestorableTime

 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.
 


readerEndpoint
String readerEndpoint

 The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load balances connections across the
 Amazon DocumentDB replicas that are available in a DB cluster. As clients request new connections to the reader
 endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the DB
 cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in
 your DB cluster.
 
 
 If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary
 instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas
 in the cluster, you can then reconnect to the reader endpoint.
 


multiAZ
Boolean multiAZ

 Specifies whether the DB cluster has instances in multiple Availability Zones.
 


engine
String engine

 Provides the name of the database engine to be used for this DB cluster.
 


engineVersion
String engineVersion

 Indicates the database engine version.
 


latestRestorableTime
Date latestRestorableTime

 Specifies the latest time to which a database can be restored with point-in-time restore.
 


port
Integer port

 Specifies the port that the database engine is listening on.
 


masterUsername
String masterUsername

 Contains the master user name for the DB cluster.
 


preferredBackupWindow
String preferredBackupWindow

 Specifies the daily time range during which automated backups are created if automated backups are enabled, as
 determined by the BackupRetentionPeriod.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
 


dBClusterMembers
List<E> dBClusterMembers

 Provides the list of instances that make up the DB cluster.
 


vpcSecurityGroups
List<E> vpcSecurityGroups

 Provides a list of virtual private cloud (VPC) security groups that the DB cluster belongs to.
 


hostedZoneId
String hostedZoneId

 Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
 


storageEncrypted
Boolean storageEncrypted

 Specifies whether the DB cluster is encrypted.
 


kmsKeyId
String kmsKeyId

 If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
 


dbClusterResourceId
String dbClusterResourceId

 The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log
 entries whenever the AWS KMS key for the DB cluster is accessed.
 


dBClusterArn
String dBClusterArn

 The Amazon Resource Name (ARN) for the DB cluster.
 


associatedRoles
List<E> associatedRoles

 Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
 IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services
 on your behalf.
 


clusterCreateTime
Date clusterCreateTime

 Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
 


enabledCloudwatchLogsExports
List<E> enabledCloudwatchLogsExports

 A list of log types that this DB cluster is configured to export to Amazon CloudWatch Logs.
 


deletionProtection
Boolean deletionProtection

 Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot
 be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection
 protects clusters from being accidentally deleted.
 








Class com.amazonaws.services.docdb.model.DBClusterAlreadyExistsException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBClusterMember extends Object implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 Specifies the instance identifier for this member of the DB cluster.
 


isClusterWriter
Boolean isClusterWriter

 A value that is true if the cluster member is the primary instance for the DB cluster and
 false otherwise.
 


dBClusterParameterGroupStatus
String dBClusterParameterGroupStatus

 Specifies the status of the DB cluster parameter group for this member of the DB cluster.
 


promotionTier
Integer promotionTier

 A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after
 a failure of the existing primary instance.
 








Class com.amazonaws.services.docdb.model.DBClusterNotFoundException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBClusterParameterGroup extends Object implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 Provides the name of the DB cluster parameter group.
 


dBParameterGroupFamily
String dBParameterGroupFamily

 Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.
 


description
String description

 Provides the customer-specified description for this DB cluster parameter group.
 


dBClusterParameterGroupArn
String dBClusterParameterGroupArn

 The Amazon Resource Name (ARN) for the DB cluster parameter group.
 








Class com.amazonaws.services.docdb.model.DBClusterParameterGroupNotFoundException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBClusterQuotaExceededException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBClusterRole extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
 


status
String status

 Describes the state of association between the IAM role and the DB cluster. The Status property
 returns one of the following values:
 
 
 
 
 ACTIVE - The IAM role ARN is associated with the DB cluster and can be used to access other AWS
 services on your behalf.
 
 
 
 
 PENDING - The IAM role ARN is being associated with the DB cluster.
 
 
 
 
 INVALID - The IAM role ARN is associated with the DB cluster, but the DB cluster cannot assume the
 IAM role to access other AWS services on your behalf.
 
 
 








Class com.amazonaws.services.docdb.model.DBClusterSnapshot extends Object implements Serializable


Serialized Fields


availabilityZones
List<E> availabilityZones

 Provides the list of Amazon EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
 


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 Specifies the identifier for the DB cluster snapshot.
 


dBClusterIdentifier
String dBClusterIdentifier

 Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
 


snapshotCreateTime
Date snapshotCreateTime

 Provides the time when the snapshot was taken, in UTC.
 


engine
String engine

 Specifies the name of the database engine.
 


status
String status

 Specifies the status of this DB cluster snapshot.
 


port
Integer port

 Specifies the port that the DB cluster was listening on at the time of the snapshot.
 


vpcId
String vpcId

 Provides the virtual private cloud (VPC) ID that is associated with the DB cluster snapshot.
 


clusterCreateTime
Date clusterCreateTime

 Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
 


masterUsername
String masterUsername

 Provides the master user name for the DB cluster snapshot.
 


engineVersion
String engineVersion

 Provides the version of the database engine for this DB cluster snapshot.
 


snapshotType
String snapshotType

 Provides the type of the DB cluster snapshot.
 


percentProgress
Integer percentProgress

 Specifies the percentage of the estimated data that has been transferred.
 


storageEncrypted
Boolean storageEncrypted

 Specifies whether the DB cluster snapshot is encrypted.
 


kmsKeyId
String kmsKeyId

 If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster
 snapshot.
 


dBClusterSnapshotArn
String dBClusterSnapshotArn

 The Amazon Resource Name (ARN) for the DB cluster snapshot.
 


sourceDBClusterSnapshotArn
String sourceDBClusterSnapshotArn

 If the DB cluster snapshot was copied from a source DB cluster snapshot, the ARN for the source DB cluster
 snapshot; otherwise, a null value.
 








Class com.amazonaws.services.docdb.model.DBClusterSnapshotAlreadyExistsException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBClusterSnapshotAttribute extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 The name of the manual DB cluster snapshot attribute.
 
 
 The attribute named restore refers to the list of AWS accounts that have permission to copy or
 restore the manual DB cluster snapshot.
 


attributeValues
List<E> attributeValues

 The values for the manual DB cluster snapshot attribute.
 
 
 If the AttributeName field is set to restore, then this element returns a list of IDs
 of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of
 all is in the list, then the manual DB cluster snapshot is public and available for any AWS account
 to copy or restore.
 








Class com.amazonaws.services.docdb.model.DBClusterSnapshotAttributesResult extends Object implements Serializable


Serialized Fields


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 The identifier of the DB cluster snapshot that the attributes apply to.
 


dBClusterSnapshotAttributes
List<E> dBClusterSnapshotAttributes

 The list of attributes and values for the DB cluster snapshot.
 








Class com.amazonaws.services.docdb.model.DBClusterSnapshotNotFoundException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBEngineVersion extends Object implements Serializable


Serialized Fields


engine
String engine

 The name of the database engine.
 


engineVersion
String engineVersion

 The version number of the database engine.
 


dBParameterGroupFamily
String dBParameterGroupFamily

 The name of the DB parameter group family for the database engine.
 


dBEngineDescription
String dBEngineDescription

 The description of the database engine.
 


dBEngineVersionDescription
String dBEngineVersionDescription

 The description of the database engine version.
 


validUpgradeTarget
List<E> validUpgradeTarget

 A list of engine versions that this database engine version can be upgraded to.
 


exportableLogTypes
List<E> exportableLogTypes

 The types of logs that the database engine has available for export to Amazon CloudWatch Logs.
 


supportsLogExportsToCloudwatchLogs
Boolean supportsLogExportsToCloudwatchLogs

 A value that indicates whether the engine version supports exporting the log types specified by
 ExportableLogTypes to CloudWatch Logs.
 








Class com.amazonaws.services.docdb.model.DBInstance extends Object implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 Contains a user-provided database identifier. This identifier is the unique key that identifies a DB instance.
 


dBInstanceClass
String dBInstanceClass

 Contains the name of the compute and memory capacity class of the DB instance.
 


engine
String engine

 Provides the name of the database engine to be used for this DB instance.
 


dBInstanceStatus
String dBInstanceStatus

 Specifies the current state of this database.
 


endpoint
Endpoint endpoint

 Specifies the connection endpoint.
 


instanceCreateTime
Date instanceCreateTime

 Provides the date and time that the DB instance was created.
 


preferredBackupWindow
String preferredBackupWindow

 Specifies the daily time range during which automated backups are created if automated backups are enabled, as
 determined by the BackupRetentionPeriod.
 


backupRetentionPeriod
Integer backupRetentionPeriod

 Specifies the number of days for which automatic DB snapshots are retained.
 


vpcSecurityGroups
List<E> vpcSecurityGroups

 Provides a list of VPC security group elements that the DB instance belongs to.
 


availabilityZone
String availabilityZone

 Specifies the name of the Availability Zone that the DB instance is located in.
 


dBSubnetGroup
DBSubnetGroup dBSubnetGroup

 Specifies information on the subnet group that is associated with the DB instance, including the name,
 description, and subnets in the subnet group.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
 


pendingModifiedValues
PendingModifiedValues pendingModifiedValues

 Specifies that changes to the DB instance are pending. This element is included only when changes are pending.
 Specific changes are identified by subelements.
 


latestRestorableTime
Date latestRestorableTime

 Specifies the latest time to which a database can be restored with point-in-time restore.
 


engineVersion
String engineVersion

 Indicates the database engine version.
 


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 Indicates that minor version patches are applied automatically.
 


publiclyAccessible
Boolean publiclyAccessible

 Not supported. Amazon DocumentDB does not currently support public endpoints. The value of
 PubliclyAccessible is always false.
 


statusInfos
List<E> statusInfos

 The status of a read replica. If the instance is not a read replica, this is blank.
 


dBClusterIdentifier
String dBClusterIdentifier

 Contains the name of the DB cluster that the DB instance is a member of if the DB instance is a member of a DB
 cluster.
 


storageEncrypted
Boolean storageEncrypted

 Specifies whether or not the DB instance is encrypted.
 


kmsKeyId
String kmsKeyId

 If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
 


dbiResourceId
String dbiResourceId

 The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log
 entries whenever the AWS KMS key for the DB instance is accessed.
 


cACertificateIdentifier
String cACertificateIdentifier

 The identifier of the CA certificate for this DB instance.
 


promotionTier
Integer promotionTier

 A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after
 a failure of the existing primary instance.
 


dBInstanceArn
String dBInstanceArn

 The Amazon Resource Name (ARN) for the DB instance.
 


enabledCloudwatchLogsExports
List<E> enabledCloudwatchLogsExports

 A list of log types that this DB instance is configured to export to Amazon CloudWatch Logs.
 








Class com.amazonaws.services.docdb.model.DBInstanceAlreadyExistsException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBInstanceNotFoundException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBInstanceStatusInfo extends Object implements Serializable


Serialized Fields


statusType
String statusType

 This value is currently "read replication."
 


normal
Boolean normal

 A Boolean value that is true if the instance is operating normally, or false if the
 instance is in an error state.
 


status
String status

 Status of the DB instance. For a StatusType of read replica, the values can be
 replicating, error, stopped, or terminated.
 


message
String message

 Details of the error if there is an error for the instance. If the instance is not in an error state, this value
 is blank.
 








Class com.amazonaws.services.docdb.model.DBParameterGroupAlreadyExistsException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBParameterGroupNotFoundException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBParameterGroupQuotaExceededException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBSecurityGroupNotFoundException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBSnapshotAlreadyExistsException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBSnapshotNotFoundException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBSubnetGroup extends Object implements Serializable


Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName

 The name of the DB subnet group.
 


dBSubnetGroupDescription
String dBSubnetGroupDescription

 Provides the description of the DB subnet group.
 


vpcId
String vpcId

 Provides the virtual private cloud (VPC) ID of the DB subnet group.
 


subnetGroupStatus
String subnetGroupStatus

 Provides the status of the DB subnet group.
 


subnets
List<E> subnets

 Detailed information about one or more subnets within a DB subnet group.
 


dBSubnetGroupArn
String dBSubnetGroupArn

 The Amazon Resource Name (ARN) for the DB subnet group.
 








Class com.amazonaws.services.docdb.model.DBSubnetGroupAlreadyExistsException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBSubnetGroupDoesNotCoverEnoughAZsException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBSubnetGroupNotFoundException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBSubnetGroupQuotaExceededException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBSubnetQuotaExceededException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DBUpgradeDependencyFailureException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.DeleteDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group.
 
 
 Constraints:
 
 
 
 
 Must be the name of an existing DB cluster parameter group.
 
 
 
 
 You can't delete a default DB cluster parameter group.
 
 
 
 
 Cannot be associated with any DB clusters.
 
 
 








Class com.amazonaws.services.docdb.model.DeleteDBClusterParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.docdb.model.DeleteDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case sensitive.
 
 
 Constraints:
 
 
 
 
 Must match an existing DBClusterIdentifier.
 
 
 


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.
 
 
 
 If SkipFinalSnapshot is false, you must specify a
 FinalDBSnapshotIdentifier parameter.
 
 
 
 Default: false
 


finalDBSnapshotIdentifier
String finalDBSnapshotIdentifier

 The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is
 set to false.
 
 
 
 Specifying this parameter and also setting the SkipFinalShapshot parameter to true
 results in an error.
 
 
 
 Constraints:
 
 
 
 
 Must be from 1 to 255 letters, numbers, or hyphens.
 
 
 
 
 The first character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 








Class com.amazonaws.services.docdb.model.DeleteDBClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 The identifier of the DB cluster snapshot to delete.
 
 
 Constraints: Must be the name of an existing DB cluster snapshot in the available state.
 








Class com.amazonaws.services.docdb.model.DeleteDBInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.
 
 
 Constraints:
 
 
 
 
 Must match the name of an existing DB instance.
 
 
 








Class com.amazonaws.services.docdb.model.DeleteDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName

 The name of the database subnet group to delete.
 
 
 
 You can't delete the default subnet group.
 
 
 
 Constraints:
 
 
 Must match the name of an existing DBSubnetGroup. Must not be default.
 
 
 Example: mySubnetgroup
 








Class com.amazonaws.services.docdb.model.DeleteDBSubnetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.docdb.model.DescribeCertificatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateIdentifier
String certificateIdentifier

 The user-supplied certificate identifier. If this parameter is specified, information for only the specified
 certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is
 returned. This parameter is not case sensitive.
 
 
 Constraints
 
 
 
 
 Must match an existing CertificateIdentifier.
 
 
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response. If more records exist than the specified
 MaxRecords value, a pagination token called a marker is included in the response so that the
 remaining results can be retrieved.
 
 
 Default: 100
 
 
 Constraints:
 
 
 
 
 Minimum: 20
 
 
 
 
 Maximum: 100
 
 
 


marker
String marker

 An optional pagination token provided by a previous DescribeCertificates request. If this parameter
 is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 








Class com.amazonaws.services.docdb.model.DescribeCertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificates
List<E> certificates

 A list of certificates for this AWS account.
 


marker
String marker

 An optional pagination token provided if the number of records retrieved is greater than MaxRecords.
 If this parameter is specified, the marker specifies the next record in the list. Including the value of
 Marker in the next call to DescribeCertificates results in the next page of
 certificates.
 








Class com.amazonaws.services.docdb.model.DescribeDBClusterParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of a specific DB cluster parameter group to return details for.
 
 
 Constraints:
 
 
 
 
 If provided, must match the name of an existing DBClusterParameterGroup.
 
 
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response. If more records exist than the specified
 MaxRecords value, a pagination token (marker) is included in the response so that the remaining
 results can be retrieved.
 
 
 Default: 100
 
 
 Constraints: Minimum 20, maximum 100.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.docdb.model.DescribeDBClusterParameterGroupsResult extends AmazonWebServiceResult<ResponseMetadata> 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.
 


dBClusterParameterGroups
List<E> dBClusterParameterGroups

 A list of DB cluster parameter groups.
 








Class com.amazonaws.services.docdb.model.DescribeDBClusterParametersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of a specific DB cluster parameter group to return parameter details for.
 
 
 Constraints:
 
 
 
 
 If provided, must match the name of an existing DBClusterParameterGroup.
 
 
 


source
String source

 A value that indicates to return only parameters for a specific source. Parameter sources can be
 engine, service, or customer.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response. If more records exist than the specified
 MaxRecords value, a pagination token (marker) is included in the response so that the remaining
 results can be retrieved.
 
 
 Default: 100
 
 
 Constraints: Minimum 20, maximum 100.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.docdb.model.DescribeDBClusterParametersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


parameters
List<E> parameters

 Provides a list of parameters for the DB cluster parameter group.
 


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.docdb.model.DescribeDBClusterSnapshotAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 The identifier for the DB cluster snapshot to describe the attributes for.
 








Class com.amazonaws.services.docdb.model.DescribeDBClusterSnapshotsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used with the
 DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.
 
 
 Constraints:
 
 
 
 
 If provided, must match the identifier of an existing DBCluster.
 
 
 


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 A specific DB cluster snapshot identifier to describe. This parameter can't be used with the
 DBClusterIdentifier parameter. This value is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 If provided, must match the identifier of an existing DBClusterSnapshot.
 
 
 
 
 If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
 
 
 


snapshotType
String snapshotType

 The type of DB cluster snapshots to be returned. You can specify one of the following values:
 
 
 
 
 automated - Return all DB cluster snapshots that Amazon DocumentDB has automatically created for
 your AWS account.
 
 
 
 
 manual - Return all DB cluster snapshots that you have manually created for your AWS account.
 
 
 
 
 shared - Return all manual DB cluster snapshots that have been shared to your AWS account.
 
 
 
 
 public - Return all DB cluster snapshots that have been marked as public.
 
 
 
 
 If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are
 returned. You can include shared DB cluster snapshots with these results by setting the
 IncludeShared parameter to true. You can include public DB cluster snapshots with these
 results by setting the IncludePublic parameter to true.
 
 
 The IncludeShared and IncludePublic parameters don't apply for
 SnapshotType values of manual or automated. The IncludePublic
 parameter doesn't apply when SnapshotType is set to shared. The
 IncludeShared parameter doesn't apply when SnapshotType is set to public.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response. If more records exist than the specified
 MaxRecords value, a pagination token (marker) is included in the response so that the remaining
 results can be retrieved.
 
 
 Default: 100
 
 
 Constraints: Minimum 20, maximum 100.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


includeShared
Boolean includeShared

 Set to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS
 account has been given permission to copy or restore, and otherwise false. The default is
 false.
 


includePublic
Boolean includePublic

 Set to true to include manual DB cluster snapshots that are public and can be copied or restored by
 any AWS account, and otherwise false. The default is false.
 








Class com.amazonaws.services.docdb.model.DescribeDBClusterSnapshotsResult extends AmazonWebServiceResult<ResponseMetadata> 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.
 


dBClusterSnapshots
List<E> dBClusterSnapshots

 Provides a list of DB cluster snapshots.
 








Class com.amazonaws.services.docdb.model.DescribeDBClustersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The user-provided DB cluster identifier. If this parameter is specified, information from only the specific DB
 cluster is returned. This parameter isn't case sensitive.
 
 
 Constraints:
 
 
 
 
 If provided, must match an existing DBClusterIdentifier.
 
 
 


filters
List<E> filters

 A filter that specifies one or more DB clusters to describe.
 
 
 Supported filters:
 
 
 
 
 db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
 results list only includes information about the DB clusters identified by these ARNs.
 
 
 


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 (marker) is included in the response so that the remaining
 results can be retrieved.
 
 
 Default: 100
 
 
 Constraints: Minimum 20, maximum 100.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.docdb.model.DescribeDBClustersResult extends AmazonWebServiceResult<ResponseMetadata> 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.
 


dBClusters
List<E> dBClusters

 A list of DB clusters.
 








Class com.amazonaws.services.docdb.model.DescribeDBEngineVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


engine
String engine

 The database engine to return.
 


engineVersion
String engineVersion

 The database engine version to return.
 
 
 Example: 5.1.49
 


dBParameterGroupFamily
String dBParameterGroupFamily

 The name of a specific DB parameter group family to return details for.
 
 
 Constraints:
 
 
 
 
 If provided, must match an existing DBParameterGroupFamily.
 
 
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response. If more records exist than the specified
 MaxRecords value, a pagination token (marker) is included in the response so that the remaining
 results can be retrieved.
 
 
 Default: 100
 
 
 Constraints: Minimum 20, maximum 100.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


defaultOnly
Boolean defaultOnly

 Indicates that only the default version of the specified engine or engine and major version combination is
 returned.
 


listSupportedCharacterSets
Boolean listSupportedCharacterSets

 If this parameter is specified and the requested engine supports the CharacterSetName parameter for
 CreateDBInstance, the response includes a list of supported character sets for each engine version.
 


listSupportedTimezones
Boolean listSupportedTimezones

 If this parameter is specified and the requested engine supports the TimeZone parameter for
 CreateDBInstance, the response includes a list of supported time zones for each engine version.
 








Class com.amazonaws.services.docdb.model.DescribeDBEngineVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


dBEngineVersions
List<E> dBEngineVersions

 Detailed information about one or more DB engine versions.
 








Class com.amazonaws.services.docdb.model.DescribeDBInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 The user-provided instance identifier. If this parameter is specified, information from only the specific DB
 instance is returned. This parameter isn't case sensitive.
 
 
 Constraints:
 
 
 
 
 If provided, must match the identifier of an existing DBInstance.
 
 
 


filters
List<E> filters

 A filter that specifies one or more DB instances to describe.
 
 
 Supported filters:
 
 
 
 
 db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
 results list includes only the information about the DB instances that are associated with the DB clusters that
 are identified by these ARNs.
 
 
 
 
 db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list includes
 only the information about the DB instances that are identified by these ARNs.
 
 
 


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 (marker) is included in the response so that the remaining
 results can be retrieved.
 
 
 Default: 100
 
 
 Constraints: Minimum 20, maximum 100.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.docdb.model.DescribeDBInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


dBInstances
List<E> dBInstances

 Detailed information about one or more DB instances.
 








Class com.amazonaws.services.docdb.model.DescribeDBSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName

 The name of the DB subnet group to return details for.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response. If more records exist than the specified
 MaxRecords value, a pagination token (marker) is included in the response so that the remaining
 results can be retrieved.
 
 
 Default: 100
 
 
 Constraints: Minimum 20, maximum 100.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.docdb.model.DescribeDBSubnetGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


dBSubnetGroups
List<E> dBSubnetGroups

 Detailed information about one or more DB subnet groups.
 








Class com.amazonaws.services.docdb.model.DescribeEngineDefaultClusterParametersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBParameterGroupFamily
String dBParameterGroupFamily

 The name of the DB cluster parameter group family to return the engine parameter information for.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response. If more records exist than the specified
 MaxRecords value, a pagination token (marker) is included in the response so that the remaining
 results can be retrieved.
 
 
 Default: 100
 
 
 Constraints: Minimum 20, maximum 100.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.docdb.model.DescribeEventCategoriesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceType
String sourceType

 The type of source that is generating the events.
 
 
 Valid values: db-instance, db-parameter-group, db-security-group,
 db-snapshot
 


filters
List<E> filters

 This parameter is not currently supported.
 








Class com.amazonaws.services.docdb.model.DescribeEventCategoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventCategoriesMapList
List<E> eventCategoriesMapList

 A list of event category maps.
 








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


Serialized Fields


sourceIdentifier
String sourceIdentifier

 The identifier of the event source for which events are returned. If not specified, then all sources are included
 in the response.
 
 
 Constraints:
 
 
 
 
 If SourceIdentifier is provided, SourceType must also be provided.
 
 
 
 
 If the source type is DBInstance, a DBInstanceIdentifier must be provided.
 
 
 
 
 If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.
 
 
 
 
 If the source type is DBParameterGroup, a DBParameterGroupName must be provided.
 
 
 
 
 If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.
 
 
 
 
 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.
 
 
 Example: 2009-07-08T18:00Z
 


endTime
Date endTime

 The end of the time interval for which to retrieve events, specified in ISO 8601 format.
 
 
 Example: 2009-07-08T18:00Z
 


duration
Integer duration

 The number of minutes to retrieve events for.
 
 
 Default: 60
 


eventCategories
List<E> eventCategories

 A list of event categories that trigger notifications for an event notification subscription.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response. If more records exist than the specified
 MaxRecords value, a pagination token (marker) is included in the response so that the remaining
 results can be retrieved.
 
 
 Default: 100
 
 
 Constraints: Minimum 20, maximum 100.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.docdb.model.DescribeEventsResult extends AmazonWebServiceResult<ResponseMetadata> 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.
 


events
List<E> events

 Detailed information about one or more events.
 








Class com.amazonaws.services.docdb.model.DescribeOrderableDBInstanceOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


engine
String engine

 The name of the engine to retrieve DB instance options for.
 


engineVersion
String engineVersion

 The engine version filter value. Specify this parameter to show only the available offerings that match the
 specified engine version.
 


dBInstanceClass
String dBInstanceClass

 The DB instance class filter value. Specify this parameter to show only the available offerings that match the
 specified DB instance class.
 


licenseModel
String licenseModel

 The license model filter value. Specify this parameter to show only the available offerings that match the
 specified license model.
 


vpc
Boolean vpc

 The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC
 offerings.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response. If more records exist than the specified
 MaxRecords value, a pagination token (marker) is included in the response so that the remaining
 results can be retrieved.
 
 
 Default: 100
 
 
 Constraints: Minimum 20, maximum 100.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.docdb.model.DescribeOrderableDBInstanceOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


orderableDBInstanceOptions
List<E> orderableDBInstanceOptions

 The options that are available for a particular orderable DB instance.
 


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.docdb.model.DescribePendingMaintenanceActionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceIdentifier
String resourceIdentifier

 The ARN of a resource to return pending maintenance actions for.
 


filters
List<E> filters

 A filter that specifies one or more resources to return pending maintenance actions for.
 
 
 Supported filters:
 
 
 
 
 db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
 results list includes only pending maintenance actions for the DB clusters identified by these ARNs.
 
 
 
 
 db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list includes
 only pending maintenance actions for the DB instances identified by these ARNs.
 
 
 


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 (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.docdb.model.DescribePendingMaintenanceActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pendingMaintenanceActions
List<E> pendingMaintenanceActions

 The maintenance actions to be applied.
 


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.docdb.model.Endpoint extends Object implements Serializable


Serialized Fields


address
String address

 Specifies the DNS address of the DB instance.
 


port
Integer port

 Specifies the port that the database engine is listening on.
 


hostedZoneId
String hostedZoneId

 Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
 








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


Serialized Fields


dBParameterGroupFamily
String dBParameterGroupFamily

 The name of the DB cluster parameter group family to return the engine parameter information for.
 


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
List<E> parameters

 The parameters of a particular DB cluster parameter group family.
 








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


Serialized Fields


sourceIdentifier
String sourceIdentifier

 Provides the identifier for the source of the event.
 


sourceType
String sourceType

 Specifies the source type for this event.
 


message
String message

 Provides the text of this event.
 


eventCategories
List<E> eventCategories

 Specifies the category for the event.
 


date
Date date

 Specifies the date and time of the event.
 


sourceArn
String sourceArn

 The Amazon Resource Name (ARN) for the event.
 








Class com.amazonaws.services.docdb.model.EventCategoriesMap extends Object implements Serializable


Serialized Fields


sourceType
String sourceType

 The source type that the returned categories belong to.
 


eventCategories
List<E> eventCategories

 The event categories for the specified source type.
 








Class com.amazonaws.services.docdb.model.FailoverDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 A DB cluster identifier to force a failover for. This parameter is not case sensitive.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing DBCluster.
 
 
 


targetDBInstanceIdentifier
String targetDBInstanceIdentifier

 The name of the instance to promote to the primary instance.
 
 
 You must specify the instance identifier for an Amazon DocumentDB replica in the DB cluster. For example,
 mydbcluster-replica1.
 








Class com.amazonaws.services.docdb.model.Filter extends Object implements Serializable


Serialized Fields


name
String name

 The name of the filter. Filter names are case sensitive.
 


values
List<E> values

 One or more filter values. Filter values are case sensitive.
 








Class com.amazonaws.services.docdb.model.InstanceQuotaExceededException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InsufficientDBClusterCapacityException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InsufficientDBInstanceCapacityException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InsufficientStorageClusterCapacityException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InvalidDBClusterSnapshotStateException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InvalidDBClusterStateException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InvalidDBInstanceStateException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InvalidDBParameterGroupStateException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InvalidDBSecurityGroupStateException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InvalidDBSnapshotStateException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InvalidDBSubnetGroupStateException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InvalidDBSubnetStateException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InvalidRestoreException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InvalidSubnetException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.InvalidVPCNetworkStateException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.KMSKeyNotAccessibleException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


resourceName
String resourceName

 The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).
 


filters
List<E> filters

 This parameter is not currently supported.
 








Class com.amazonaws.services.docdb.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagList
List<E> tagList

 A list of one or more tags.
 








Class com.amazonaws.services.docdb.model.ModifyDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group to modify.
 


parameters
List<E> parameters

 A list of parameters in the DB cluster parameter group to modify.
 








Class com.amazonaws.services.docdb.model.ModifyDBClusterParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of a DB cluster parameter group.
 
 
 Constraints:
 
 
 
 
 Must be from 1 to 255 letters or numbers.
 
 
 
 
 The 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.docdb.model.ModifyDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The DB cluster identifier for the cluster that is being modified. This parameter is not case sensitive.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing DBCluster.
 
 
 


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 letters, numbers, or hyphens.
 
 
 
 
 The first character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: my-cluster2
 


applyImmediately
Boolean applyImmediately

 A value that specifies whether the changes in this request and any pending changes 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 affects only the NewDBClusterIdentifier and
 MasterUserPassword values. If you set this parameter value to false, the changes to the
 NewDBClusterIdentifier and MasterUserPassword values are applied during the next
 maintenance window. All other changes are applied immediately, regardless of the value of the
 ApplyImmediately parameter.
 
 
 Default: false
 


backupRetentionPeriod
Integer backupRetentionPeriod

 The number of days for which automated backups are retained. You must specify a minimum value of 1.
 
 
 Default: 1
 
 
 Constraints:
 
 
 
 
 Must be a value from 1 to 35.
 
 
 


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group to use for the DB cluster.
 


vpcSecurityGroupIds
List<E> vpcSecurityGroupIds

 A list of virtual private cloud (VPC) security groups that the DB cluster will belong to.
 


port
Integer port

 The port number on which the DB cluster accepts connections.
 
 
 Constraints: Must be a value from 1150 to 65535.
 
 
 Default: The same port as the original DB cluster.
 


masterUserPassword
String masterUserPassword

 The password for the master database user. This password can contain any printable ASCII character except forward
 slash (/), double quote ("), or the "at" symbol (@).
 
 
 Constraints: Must contain from 8 to 100 characters.
 


preferredBackupWindow
String preferredBackupWindow

 The daily time range during which automated backups are created if automated backups are enabled, using the
 BackupRetentionPeriod parameter.
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.
 
 
 Constraints:
 
 
 
 
 Must be in the format hh24:mi-hh24:mi.
 
 
 
 
 Must 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
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring
 on a random day of the week.
 
 
 Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
 
 
 Constraints: Minimum 30-minute window.
 


cloudwatchLogsExportConfiguration
CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration

 The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific DB
 instance or DB cluster. The EnableLogTypes and DisableLogTypes arrays determine which
 logs are exported (or not exported) to CloudWatch Logs.
 


engineVersion
String engineVersion

 The version number of the database engine to which you want to upgrade. Changing this parameter results in an
 outage. The change is applied during the next maintenance window unless the ApplyImmediately
 parameter is set to true.
 


deletionProtection
Boolean deletionProtection

 Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot
 be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection
 protects clusters from being accidentally deleted.
 








Class com.amazonaws.services.docdb.model.ModifyDBClusterSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 The identifier for the DB cluster snapshot to modify the attributes for.
 


attributeName
String attributeName

 The name of the DB cluster snapshot attribute to modify.
 
 
 To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to
 restore.
 


valuesToAdd
List<E> valuesToAdd

 A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.
 
 
 To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or
 more AWS account IDs. To make the manual DB cluster snapshot restorable by any AWS account, set it to
 all. Do not add the all value for any manual DB cluster snapshots that contain private
 information that you don't want to be available to all AWS accounts.
 


valuesToRemove
List<E> valuesToRemove

 A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.
 
 
 To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to
 include one or more AWS account identifiers. To remove authorization for any AWS account to copy or restore the
 DB cluster snapshot, set it to all . If you specify all, an AWS account whose account
 ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster
 snapshot.
 








Class com.amazonaws.services.docdb.model.ModifyDBInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 The DB instance identifier. This value is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing DBInstance.
 
 
 


dBInstanceClass
String dBInstanceClass

 The new compute and memory capacity of the DB instance; for example, db.r5.large. Not all DB
 instance classes are available in all AWS Regions.
 
 
 If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
 maintenance window, unless ApplyImmediately is specified as true for this request.
 
 
 Default: Uses existing setting.
 


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 are applied on the next reboot.
 
 
 Default: false
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage.
 Changing this parameter doesn't 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, changing this parameter causes a reboot of the DB instance. If you
 are 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 that 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.
 


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
 Changing this parameter doesn't result in an outage except in the following case, and the change is
 asynchronously applied as soon as possible. An outage results if this parameter is set to true
 during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled
 automatic patching for that engine version.
 


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 occurs immediately if you set Apply Immediately to true.
 It occurs during the next maintenance window if you set Apply Immediately to false.
 This value is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 letters, numbers, or hyphens.
 
 
 
 
 The first character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: mydbinstance
 


cACertificateIdentifier
String cACertificateIdentifier

 Indicates the certificate that needs to be associated with the instance.
 


promotionTier
Integer promotionTier

 A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after
 a failure of the existing primary instance.
 
 
 Default: 1
 
 
 Valid values: 0-15
 








Class com.amazonaws.services.docdb.model.ModifyDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName

 The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet
 group.
 
 
 Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
 
 
 Example: mySubnetgroup
 


dBSubnetGroupDescription
String dBSubnetGroupDescription

 The description for the DB subnet group.
 


subnetIds
List<E> subnetIds

 The Amazon EC2 subnet IDs for the DB subnet group.
 








Class com.amazonaws.services.docdb.model.OrderableDBInstanceOption extends Object implements Serializable


Serialized Fields


engine
String engine

 The engine type of a DB instance.
 


engineVersion
String engineVersion

 The engine version of a DB instance.
 


dBInstanceClass
String dBInstanceClass

 The DB instance class for a DB instance.
 


licenseModel
String licenseModel

 The license model for a DB instance.
 


availabilityZones
List<E> availabilityZones

 A list of Availability Zones for a DB instance.
 


vpc
Boolean vpc

 Indicates whether a DB instance is in a virtual private cloud (VPC).
 








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


Serialized Fields


parameterName
String parameterName

 Specifies the name of the parameter.
 


parameterValue
String parameterValue

 Specifies the value of the parameter.
 


description
String description

 Provides a description of the parameter.
 


source
String source

 Indicates the source of the parameter value.
 


applyType
String applyType

 Specifies the engine-specific parameters type.
 


dataType
String dataType

 Specifies the valid data type for the parameter.
 


allowedValues
String allowedValues

 Specifies the valid range of values for the parameter.
 


isModifiable
Boolean isModifiable

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


minimumEngineVersion
String minimumEngineVersion

 The earliest engine version to which the parameter can apply.
 


applyMethod
String applyMethod

 Indicates when to apply parameter updates.
 








Class com.amazonaws.services.docdb.model.PendingCloudwatchLogsExports extends Object implements Serializable


Serialized Fields


logTypesToEnable
List<E> logTypesToEnable

 Log types that are in the process of being deactivated. After they are deactivated, these log types aren't
 exported to CloudWatch Logs.
 


logTypesToDisable
List<E> logTypesToDisable

 Log types that are in the process of being enabled. After they are enabled, these log types are exported to
 Amazon CloudWatch Logs.
 








Class com.amazonaws.services.docdb.model.PendingMaintenanceAction extends Object implements Serializable


Serialized Fields


action
String action

 The type of pending maintenance action that is available for the resource.
 


autoAppliedAfterDate
Date autoAppliedAfterDate

 The date of the maintenance window when the action is applied. The maintenance action is applied to the resource
 during its first maintenance window after this date. If this date is specified, any next-maintenance
 opt-in requests are ignored.
 


forcedApplyDate
Date forcedApplyDate

 The date when the maintenance action is automatically applied. The maintenance action is applied to the resource
 on this date regardless of the maintenance window for the resource. If this date is specified, any
 immediate opt-in requests are ignored.
 


optInStatus
String optInStatus

 Indicates the type of opt-in request that has been received for the resource.
 


currentApplyDate
Date currentApplyDate

 The effective date when the pending maintenance action is applied to the resource.
 


description
String description

 A description providing more detail about the maintenance action.
 








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


Serialized Fields


dBInstanceClass
String dBInstanceClass

 Contains the new DBInstanceClass for the DB instance that will be applied or is currently being
 applied.
 


allocatedStorage
Integer allocatedStorage

 Contains the new AllocatedStorage size for the DB instance that will be applied or is currently
 being applied.
 


masterUserPassword
String masterUserPassword

 Contains the pending or currently in-progress change of the master credentials for the DB instance.
 


port
Integer port

 Specifies the pending port for the DB instance.
 


backupRetentionPeriod
Integer backupRetentionPeriod

 Specifies the pending number of days for which automated backups are retained.
 


multiAZ
Boolean multiAZ

 Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
 


engineVersion
String engineVersion

 Indicates the database engine version.
 


licenseModel
String licenseModel

 The license model for the DB instance.
 
 
 Valid values: license-included, bring-your-own-license,
 general-public-license
 


iops
Integer iops

 Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
 


dBInstanceIdentifier
String dBInstanceIdentifier

 Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being
 applied.
 


storageType
String storageType

 Specifies the storage type to be associated with the DB instance.
 


cACertificateIdentifier
String cACertificateIdentifier

 Specifies the identifier of the certificate authority (CA) certificate for the DB instance.
 


dBSubnetGroupName
String dBSubnetGroupName

 The new DB subnet group for the DB instance.
 


pendingCloudwatchLogsExports
PendingCloudwatchLogsExports pendingCloudwatchLogsExports

 A list of the log types whose configuration is still pending. These log types are in the process of being
 activated or deactivated.
 








Class com.amazonaws.services.docdb.model.RebootDBInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 The DB instance identifier. This parameter is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing DBInstance.
 
 
 


forceFailover
Boolean forceFailover

 When true, the reboot is conducted through a Multi-AZ failover.
 
 
 Constraint: You can't specify true if the instance is not configured for Multi-AZ.
 








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


Serialized Fields


resourceName
String resourceName

 The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).
 


tagKeys
List<E> tagKeys

 The tag key (name) of the tag to be removed.
 








Class com.amazonaws.services.docdb.model.RemoveTagsFromResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.docdb.model.ResetDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group to reset.
 


resetAllParameters
Boolean resetAllParameters

 A value that is set to true to reset all parameters in the DB cluster parameter group to their
 default values, and false otherwise. You can't use this parameter if there is a list of parameter
 names specified for the Parameters parameter.
 


parameters
List<E> parameters

 A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this
 parameter if the ResetAllParameters parameter is set to true.
 








Class com.amazonaws.services.docdb.model.ResetDBClusterParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of a DB cluster parameter group.
 
 
 Constraints:
 
 
 
 
 Must be from 1 to 255 letters or numbers.
 
 
 
 
 The 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.docdb.model.ResourceNotFoundException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.ResourcePendingMaintenanceActions extends Object implements Serializable


Serialized Fields


resourceIdentifier
String resourceIdentifier

 The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.
 


pendingMaintenanceActionDetails
List<E> pendingMaintenanceActionDetails

 A list that provides details about the pending maintenance actions for the resource.
 








Class com.amazonaws.services.docdb.model.RestoreDBClusterFromSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZones
List<E> availabilityZones

 Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.
 


dBClusterIdentifier
String dBClusterIdentifier

 The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case
 sensitive.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 letters, numbers, or hyphens.
 
 
 
 
 The first character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: my-snapshot-id
 


snapshotIdentifier
String snapshotIdentifier

 The identifier for the DB snapshot or DB cluster snapshot to restore from.
 
 
 You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can
 use only the ARN to specify a DB snapshot.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing snapshot.
 
 
 


engine
String engine

 The database engine to use for the new DB cluster.
 
 
 Default: The same as source.
 
 
 Constraint: Must be compatible with the engine of the source.
 


engineVersion
String engineVersion

 The version of the database engine to use for the new DB cluster.
 


port
Integer port

 The port number on which the new DB cluster accepts connections.
 
 
 Constraints: Must be a value from 1150 to 65535.
 
 
 Default: The same port as the original DB cluster.
 


dBSubnetGroupName
String dBSubnetGroupName

 The name of the DB subnet group to use for the new DB cluster.
 
 
 Constraints: If provided, must match the name of an existing DBSubnetGroup.
 
 
 Example: mySubnetgroup
 


vpcSecurityGroupIds
List<E> vpcSecurityGroupIds

 A list of virtual private cloud (VPC) security groups that the new DB cluster will belong to.
 


tags
List<E> tags

 The tags to be assigned to the restored DB cluster.
 


kmsKeyId
String kmsKeyId

 The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster
 snapshot.
 
 
 The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring
 a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster,
 then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
 
 
 If you do not specify a value for the KmsKeyId parameter, then the following occurs:
 
 
 
 
 If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB
 cluster is encrypted using the AWS KMS key that was used to encrypt the DB snapshot or the DB cluster snapshot.
 
 
 
 
 If the DB snapshot or the DB cluster snapshot in SnapshotIdentifier is not encrypted, then the
 restored DB cluster is not encrypted.
 
 
 


enableCloudwatchLogsExports
List<E> enableCloudwatchLogsExports

 A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
 


deletionProtection
Boolean deletionProtection

 Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot
 be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection
 protects clusters from being accidentally deleted.
 








Class com.amazonaws.services.docdb.model.RestoreDBClusterToPointInTimeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The name of the new DB cluster to be created.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 letters, numbers, or hyphens.
 
 
 
 
 The first character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 


sourceDBClusterIdentifier
String sourceDBClusterIdentifier

 The identifier of the source DB cluster from which to restore.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing DBCluster.
 
 
 


restoreToTime
Date restoreToTime

 The date and time to restore the DB cluster to.
 
 
 Valid values: A time in Universal Coordinated Time (UTC) format.
 
 
 Constraints:
 
 
 
 
 Must be before the latest restorable time for the DB instance.
 
 
 
 
 Must be specified if the UseLatestRestorableTime parameter is not provided.
 
 
 
 
 Cannot be specified if the UseLatestRestorableTime parameter is true.
 
 
 
 
 Cannot be specified if the RestoreType parameter is copy-on-write.
 
 
 
 
 Example: 2015-03-07T23:45:00Z
 


useLatestRestorableTime
Boolean useLatestRestorableTime

 A value that is set to true to restore the DB cluster to the latest restorable backup time, and
 false otherwise.
 
 
 Default: false
 
 
 Constraints: Cannot be specified if the RestoreToTime parameter is provided.
 


port
Integer port

 The port number on which the new DB cluster accepts connections.
 
 
 Constraints: Must be a value from 1150 to 65535.
 
 
 Default: The default port for the engine.
 


dBSubnetGroupName
String dBSubnetGroupName

 The DB subnet group name to use for the new DB cluster.
 
 
 Constraints: If provided, must match the name of an existing DBSubnetGroup.
 
 
 Example: mySubnetgroup
 


vpcSecurityGroupIds
List<E> vpcSecurityGroupIds

 A list of VPC security groups that the new DB cluster belongs to.
 


tags
List<E> tags

 The tags to be assigned to the restored DB cluster.
 


kmsKeyId
String kmsKeyId

 The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.
 
 
 The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring
 a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster,
 then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.
 
 
 You can restore to a new DB cluster and encrypt the new DB cluster with an AWS KMS key that is different from the
 AWS KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the AWS KMS key
 identified by the KmsKeyId parameter.
 
 
 If you do not specify a value for the KmsKeyId parameter, then the following occurs:
 
 
 
 
 If the DB cluster is encrypted, then the restored DB cluster is encrypted using the AWS 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 not encrypted, then the restore request is
 rejected.
 


enableCloudwatchLogsExports
List<E> enableCloudwatchLogsExports

 A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.
 


deletionProtection
Boolean deletionProtection

 Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot
 be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection
 protects clusters from being accidentally deleted.
 








Class com.amazonaws.services.docdb.model.SharedSnapshotQuotaExceededException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.SnapshotQuotaExceededException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.StartDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52
 








Class com.amazonaws.services.docdb.model.StopDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52
 








Class com.amazonaws.services.docdb.model.StorageQuotaExceededException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.StorageTypeNotSupportedException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.Subnet extends Object implements Serializable


Serialized Fields


subnetIdentifier
String subnetIdentifier

 Specifies the identifier of the subnet.
 


subnetAvailabilityZone
AvailabilityZone subnetAvailabilityZone

 Specifies the Availability Zone for the subnet.
 


subnetStatus
String subnetStatus

 Specifies the status of the subnet.
 








Class com.amazonaws.services.docdb.model.SubnetAlreadyInUseException extends AmazonDocDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.docdb.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be
 prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_',
 '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
 


value
String value

 The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be
 prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_',
 '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
 








Class com.amazonaws.services.docdb.model.UpgradeTarget extends Object implements Serializable


Serialized Fields


engine
String engine

 The name of the upgrade target database engine.
 


engineVersion
String engineVersion

 The version number of the upgrade target database engine.
 


description
String description

 The version of the database engine that a DB instance can be upgraded to.
 


autoUpgrade
Boolean autoUpgrade

 A value that indicates whether the target version is applied to any source DB instances that have
 AutoMinorVersionUpgrade set to true.
 


isMajorVersionUpgrade
Boolean isMajorVersionUpgrade

 A value that indicates whether a database engine is upgraded to a major version.
 








Class com.amazonaws.services.docdb.model.VpcSecurityGroupMembership extends Object implements Serializable


Serialized Fields


vpcSecurityGroupId
String vpcSecurityGroupId

 The name of the VPC security group.
 


status
String status

 The status of the VPC security group.
 








Package com.amazonaws.services.dynamodbv2.datamodeling




Class com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMapper.BatchGetItemException extends SdkClientException implements Serializable


Serialized Fields


unprocessedKeys
Map<K,V> unprocessedKeys


responses
Map<K,V> responses








Class com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMappingException extends RuntimeException implements Serializable

serialVersionUID:
-4883173289978517967L





Package com.amazonaws.services.dynamodbv2.document




Class com.amazonaws.services.dynamodbv2.document.IncompatibleTypeException extends SdkClientException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.dynamodbv2.document.utils




Class com.amazonaws.services.dynamodbv2.document.utils.FluentArrayList extends ArrayList<E> implements Serializable

serialVersionUID:
-8269850815375778149L





Class com.amazonaws.services.dynamodbv2.document.utils.FluentHashMap extends LinkedHashMap<K,V> implements Serializable

serialVersionUID:
4857340227048063855L





Class com.amazonaws.services.dynamodbv2.document.utils.FluentHashSet extends LinkedHashSet<E> implements Serializable

serialVersionUID:
-549868294257559427L





Class com.amazonaws.services.dynamodbv2.document.utils.NameMap extends FluentHashMap<String,String> implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.document.utils.ValueList extends FluentArrayList<Object> implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.document.utils.ValueMap extends FluentHashMap<String,Object> implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.dynamodbv2.model




Class com.amazonaws.services.dynamodbv2.model.AmazonDynamoDBException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.ArchivalSummary extends Object implements Serializable


Serialized Fields


archivalDateTime
Date archivalDateTime

 The date and time when table archival was initiated by DynamoDB, in UNIX epoch time format.
 


archivalReason
String archivalReason

 The reason DynamoDB archived the table. Currently, the only possible value is:
 
 
 
 
 INACCESSIBLE_ENCRYPTION_CREDENTIALS - The table was archived due to the table's AWS KMS key being
 inaccessible for more than seven days. An On-Demand backup was created at the archival time.
 
 
 


archivalBackupArn
String archivalBackupArn

 The Amazon Resource Name (ARN) of the backup the table was archived to, when applicable in the archival reason.
 If you wish to restore this backup to the same table name, you will need to delete the original table.
 








Class com.amazonaws.services.dynamodbv2.model.AttributeDefinition extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 A name for the attribute.
 


attributeType
String attributeType

 The data type for the attribute, where:
 
 
 
 
 S - the attribute is of type String
 
 
 
 
 N - the attribute is of type Number
 
 
 
 
 B - the attribute is of type Binary
 
 
 








Class com.amazonaws.services.dynamodbv2.model.AttributeValue extends Object implements Serializable


Serialized Fields


s
String s

 An attribute of type String. For example:
 
 
 "S": "Hello"
 


n
String n

 An attribute of type Number. For example:
 
 
 "N": "123.45"
 
 
 Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and
 libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
 


b
ByteBuffer b

 An attribute of type Binary. For example:
 
 
 "B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"
 


sS
List<E> sS

 An attribute of type String Set. For example:
 
 
 "SS": ["Giraffe", "Hippo" ,"Zebra"]
 


nS
List<E> nS

 An attribute of type Number Set. For example:
 
 
 "NS": ["42.2", "-19", "7.5", "3.14"]
 
 
 Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and
 libraries. However, DynamoDB treats them as number type attributes for mathematical operations.
 


bS
List<E> bS

 An attribute of type Binary Set. For example:
 
 
 "BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]
 


m
Map<K,V> m

 An attribute of type Map. For example:
 
 
 "M": {"Name": {"S": "Joe"}, "Age": {"N": "35"}}
 


l
List<E> l

 An attribute of type List. For example:
 
 
 "L": [ {"S": "Cookies"} , {"S": "Coffee"}, {"N", "3.14159"}]
 


nULLValue
Boolean nULLValue

 An attribute of type Null. For example:
 
 
 "NULL": true
 


bOOL
Boolean bOOL

 An attribute of type Boolean. For example:
 
 
 "BOOL": true
 








Class com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate extends Object implements Serializable


Serialized Fields


value
AttributeValue value

 Represents the data for an attribute.
 
 
 Each attribute value is described as a name-value pair. The name is the data type, and the value is the data
 itself.
 
 
 For more information, see Data Types in the Amazon DynamoDB Developer Guide.
 


action
String action

 Specifies how to perform the update. Valid values are PUT (default), DELETE, and
 ADD. The behavior depends on whether the specified primary key already exists in the table.
 
 
 If an item with the specified Key is found in the table:
 
 
 
 
 PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by
 the new value.
 
 
 
 
 DELETE - If no value is specified, the attribute and its value are removed from the item. The data
 type of the specified value must match the existing value's data type.
 
 
 If a set of values is specified, then those values are subtracted from the old set. For example, if the
 attribute value was the set [a,b,c] and the DELETE action specified [a,c],
 then the final attribute value would be [b]. Specifying an empty set is an error.
 
 
 
 
 ADD - If the attribute does not already exist, then the attribute and its values are added to the
 item. If the attribute does exist, then the behavior of ADD depends on the data type of the
 attribute:
 
 
 
 
 If the existing attribute is a number, and if Value is also a number, then the Value is
 mathematically added to the existing attribute. If Value is a negative number, then it is subtracted
 from the existing attribute.
 
 
 
 If you use ADD to increment or decrement a number value for an item that doesn't exist before the
 update, DynamoDB uses 0 as the initial value.
 
 
 In addition, if you use ADD to update an existing item, and intend to increment or decrement an
 attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose
 that the item you want to update does not yet have an attribute named itemcount, but you decide to
 ADD the number 3 to this attribute anyway, even though it currently does not exist.
 DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add
 3 to it. The result will be a new itemcount attribute in the item, with a value of
 3.
 
 
 
 
 If the existing data type is a set, and if the Value is also a set, then the Value is
 added to the existing set. (This is a set operation, not mathematical addition.) For example, if the
 attribute value was the set [1,2], and the ADD action specified [3], then
 the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set
 attribute and the attribute type specified does not match the existing set type.
 
 
 Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the
 Value must also be a set of strings. The same holds true for number sets and binary sets.
 
 
 
 
 This action is only valid for an existing attribute whose data type is number or is a set. Do not use
 ADD for any other data types.
 
 
 
 
 If no item with the specified Key is found:
 
 
 
 
 PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.
 
 
 
 
 DELETE - Nothing happens; there is no attribute to delete.
 
 
 
 
 ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the
 attribute value. The only data types allowed are number and number set; no other data types can be specified.
 
 
 








Class com.amazonaws.services.dynamodbv2.model.AutoScalingPolicyDescription extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The name of the scaling policy.
 


targetTrackingScalingPolicyConfiguration
AutoScalingTargetTrackingScalingPolicyConfigurationDescription targetTrackingScalingPolicyConfiguration

 Represents a target tracking scaling policy configuration.
 








Class com.amazonaws.services.dynamodbv2.model.AutoScalingPolicyUpdate extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The name of the scaling policy.
 


targetTrackingScalingPolicyConfiguration
AutoScalingTargetTrackingScalingPolicyConfigurationUpdate targetTrackingScalingPolicyConfiguration

 Represents a target tracking scaling policy configuration.
 








Class com.amazonaws.services.dynamodbv2.model.AutoScalingSettingsDescription extends Object implements Serializable


Serialized Fields


minimumUnits
Long minimumUnits

 The minimum capacity units that a global table or global secondary index should be scaled down to.
 


maximumUnits
Long maximumUnits

 The maximum capacity units that a global table or global secondary index should be scaled up to.
 


autoScalingDisabled
Boolean autoScalingDisabled

 Disabled auto scaling for this global table or global secondary index.
 


autoScalingRoleArn
String autoScalingRoleArn

 Role ARN used for configuring the auto scaling policy.
 


scalingPolicies
List<E> scalingPolicies

 Information about the scaling policies.
 








Class com.amazonaws.services.dynamodbv2.model.AutoScalingSettingsUpdate extends Object implements Serializable


Serialized Fields


minimumUnits
Long minimumUnits

 The minimum capacity units that a global table or global secondary index should be scaled down to.
 


maximumUnits
Long maximumUnits

 The maximum capacity units that a global table or global secondary index should be scaled up to.
 


autoScalingDisabled
Boolean autoScalingDisabled

 Disabled auto scaling for this global table or global secondary index.
 


autoScalingRoleArn
String autoScalingRoleArn

 Role ARN used for configuring auto scaling policy.
 


scalingPolicyUpdate
AutoScalingPolicyUpdate scalingPolicyUpdate

 The scaling policy to apply for scaling target global table or global secondary index capacity units.
 








Class com.amazonaws.services.dynamodbv2.model.AutoScalingTargetTrackingScalingPolicyConfigurationDescription extends Object implements Serializable


Serialized Fields


disableScaleIn
Boolean disableScaleIn

 Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled
 and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled
 and the target tracking policy can remove capacity from the scalable resource. The default value is false.
 


scaleInCooldown
Integer scaleInCooldown

 The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
 The cooldown period is used to block subsequent scale in requests until it has expired. You should 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.
 


scaleOutCooldown
Integer scaleOutCooldown

 The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.
 While the cooldown period 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. You should
 continuously (but not excessively) scale out.
 


targetValue
Double targetValue

 The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base
 2).
 








Class com.amazonaws.services.dynamodbv2.model.AutoScalingTargetTrackingScalingPolicyConfigurationUpdate extends Object implements Serializable


Serialized Fields


disableScaleIn
Boolean disableScaleIn

 Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled
 and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled
 and the target tracking policy can remove capacity from the scalable resource. The default value is false.
 


scaleInCooldown
Integer scaleInCooldown

 The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.
 The cooldown period is used to block subsequent scale in requests until it has expired. You should 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.
 


scaleOutCooldown
Integer scaleOutCooldown

 The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.
 While the cooldown period 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. You should
 continuously (but not excessively) scale out.
 


targetValue
Double targetValue

 The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base
 2).
 








Class com.amazonaws.services.dynamodbv2.model.BackupDescription extends Object implements Serializable


Serialized Fields


backupDetails
BackupDetails backupDetails

 Contains the details of the backup created for the table.
 


sourceTableDetails
SourceTableDetails sourceTableDetails

 Contains the details of the table when the backup was created.
 


sourceTableFeatureDetails
SourceTableFeatureDetails sourceTableFeatureDetails

 Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs,
 streams, TTL.
 








Class com.amazonaws.services.dynamodbv2.model.BackupDetails extends Object implements Serializable


Serialized Fields


backupArn
String backupArn

 ARN associated with the backup.
 


backupName
String backupName

 Name of the requested backup.
 


backupSizeBytes
Long backupSizeBytes

 Size of the backup in bytes.
 


backupStatus
String backupStatus

 Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
 


backupType
String backupType

 BackupType:
 
 
 
 
 USER - You create and manage these using the on-demand backup feature.
 
 
 
 
 SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is
 automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore
 the deleted table to the state it was in just before the point of deletion.
 
 
 
 
 AWS_BACKUP - On-demand backup created by you from AWS Backup service.
 
 
 


backupCreationDateTime
Date backupCreationDateTime

 Time at which the backup was created. This is the request time of the backup.
 


backupExpiryDateTime
Date backupExpiryDateTime

 Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand
 backup expires automatically 35 days after its creation.
 








Class com.amazonaws.services.dynamodbv2.model.BackupInUseException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.BackupNotFoundException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.BackupSummary extends Object implements Serializable


Serialized Fields


tableName
String tableName

 Name of the table.
 


tableId
String tableId

 Unique identifier for the table.
 


tableArn
String tableArn

 ARN associated with the table.
 


backupArn
String backupArn

 ARN associated with the backup.
 


backupName
String backupName

 Name of the specified backup.
 


backupCreationDateTime
Date backupCreationDateTime

 Time at which the backup was created.
 


backupExpiryDateTime
Date backupExpiryDateTime

 Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand
 backup expires automatically 35 days after its creation.
 


backupStatus
String backupStatus

 Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
 


backupType
String backupType

 BackupType:
 
 
 
 
 USER - You create and manage these using the on-demand backup feature.
 
 
 
 
 SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is
 automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore
 the deleted table to the state it was in just before the point of deletion.
 
 
 
 
 AWS_BACKUP - On-demand backup created by you from AWS Backup service.
 
 
 


backupSizeBytes
Long backupSizeBytes

 Size of the backup in bytes.
 








Class com.amazonaws.services.dynamodbv2.model.BatchGetItemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


requestItems
Map<K,V> requestItems

 A map of one or more table names and, for each table, a map that describes one or more items to retrieve from
 that table. Each table name can be used only once per BatchGetItem request.
 
 
 Each element in the map of items to retrieve consists of the following:
 
 
 
 
 ConsistentRead - If true, a strongly consistent read is used; if false
 (the default), an eventually consistent read is used.
 
 
 
 
 ExpressionAttributeNames - One or more substitution tokens for attribute names in the
 ProjectionExpression parameter. The following are some use cases for using
 ExpressionAttributeNames:
 
 
 
 
 To access an attribute whose name conflicts with a DynamoDB reserved word.
 
 
 
 
 To create a placeholder for repeating occurrences of an attribute name in an expression.
 
 
 
 
 To prevent special characters in an attribute name from being misinterpreted in an expression.
 
 
 
 
 Use the # character in an expression to dereference an attribute name. For example, consider the following
 attribute name:
 
 
 
 
 Percentile
 
 
 
 
 The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
 the complete list of reserved words, see Reserved Words in
 the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
 ExpressionAttributeNames:
 
 
 
 
 {"#P":"Percentile"}
 
 
 
 
 You could then use this substitution in an expression, as in this example:
 
 
 
 
 #P = :val
 
 
 
 
 
 Tokens that begin with the : character are expression attribute values, which are placeholders for
 the actual value at runtime.
 
 
 
 For more information about 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 are returned. If any of the requested attributes are not
 found, they do not appear in the result.
 
 
 For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
 
 
 
 
 AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For
 more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
 
 
 


returnConsumedCapacity
String returnConsumedCapacity








Class com.amazonaws.services.dynamodbv2.model.BatchGetItemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


responses
Map<K,V> responses

 A map of table name to a list of items. Each object in Responses consists of a table name, along
 with a map of attribute data consisting of the data type and attribute value.
 


unprocessedKeys
Map<K,V> unprocessedKeys

 A map of tables and their respective keys that were not processed with the current response. The
 UnprocessedKeys value is in the same form as RequestItems, so the value can be provided
 directly to a subsequent BatchGetItem operation. For more information, see RequestItems
 in the Request Parameters section.
 
 
 Each element consists of:
 
 
 
 
 Keys - An array of primary key attribute values that define specific items in the table.
 
 
 
 
 ProjectionExpression - One or more attributes to be retrieved from the table or index. By default,
 all attributes are returned. If a requested attribute is not found, it does not appear in the result.
 
 
 
 
 ConsistentRead - The consistency of a read operation. If set to true, then a strongly
 consistent read is used; otherwise, an eventually consistent read is used.
 
 
 
 
 If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
 


consumedCapacity
List<E> consumedCapacity

 The read capacity units consumed by the entire BatchGetItem operation.
 
 
 Each element consists of:
 
 
 
 
 TableName - The table that consumed the provisioned throughput.
 
 
 
 
 CapacityUnits - The total number of capacity units consumed.
 
 
 








Class com.amazonaws.services.dynamodbv2.model.BatchWriteItemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


requestItems
Map<K,V> requestItems

 A map of one or more table names and, for each table, a list of operations to be performed (
 DeleteRequest or PutRequest). Each element in the map consists of the following:
 
 
 
 
 DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be
 deleted is identified by a Key subelement:
 
 
 
 
 Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map
 consists of an attribute name and an attribute value. For each primary key, you must provide all of the
 key attributes. For example, with a simple primary key, you only need to provide a value for the partition key.
 For a composite primary key, you must provide values for both the partition key and the sort key.
 
 
 
 
 
 
 PutRequest - Perform a PutItem operation on the specified item. The item to be put is
 identified by an Item subelement:
 
 
 
 
 Item - A map of attributes and their values. Each entry in this map consists of an attribute name
 and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths
 greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected
 with a ValidationException exception.
 
 
 If you specify any attributes that are part of an index key, then the data types for those attributes must match
 those of the schema in the table's attribute definition.
 
 
 
 
 


returnConsumedCapacity
String returnConsumedCapacity


returnItemCollectionMetrics
String returnItemCollectionMetrics

 Determines whether item collection metrics are returned. If set to SIZE, the response includes
 statistics about item collections, if any, that were modified during the operation are returned in the response.
 If set to NONE (the default), no statistics are returned.
 








Class com.amazonaws.services.dynamodbv2.model.BatchWriteItemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unprocessedItems
Map<K,V> unprocessedItems

 A map of tables and requests against those tables that were not processed. The UnprocessedItems
 value is in the same form as RequestItems, so you can provide this value directly to a subsequent
 BatchGetItem operation. For more information, see RequestItems in the Request
 Parameters section.
 
 
 Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to
 perform (DeleteRequest or PutRequest).
 
 
 
 
 DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be
 deleted is identified by a Key subelement:
 
 
 
 
 Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map
 consists of an attribute name and an attribute value.
 
 
 
 
 
 
 PutRequest - Perform a PutItem operation on the specified item. The item to be put is
 identified by an Item subelement:
 
 
 
 
 Item - A map of attributes and their values. Each entry in this map consists of an attribute name
 and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths
 greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected
 with a ValidationException exception.
 
 
 If you specify any attributes that are part of an index key, then the data types for those attributes must match
 those of the schema in the table's attribute definition.
 
 
 
 
 
 
 If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.
 


itemCollectionMetrics
Map<K,V> itemCollectionMetrics

 A list of tables that were processed by BatchWriteItem and, for each table, information about any
 item collections that were affected by individual DeleteItem or PutItem operations.
 
 
 Each entry consists of the following subelements:
 
 
 
 
 ItemCollectionKey - The partition key value of the item collection. This is the same as the
 partition key value of the item.
 
 
 
 
 SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element
 array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the
 items in the table, plus the size of all attributes projected into all of the local secondary indexes on the
 table. Use this estimate to measure whether a local secondary index is approaching its size limit.
 
 
 The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
 
 
 


consumedCapacity
List<E> consumedCapacity

 The capacity units consumed by the entire BatchWriteItem operation.
 
 
 Each element consists of:
 
 
 
 
 TableName - The table that consumed the provisioned throughput.
 
 
 
 
 CapacityUnits - The total number of capacity units consumed.
 
 
 








Class com.amazonaws.services.dynamodbv2.model.BillingModeSummary extends Object implements Serializable


Serialized Fields


billingMode
String billingMode

 Controls how you are charged for read and write throughput and how you manage capacity. This setting can be
 changed later.
 
 
 
 
 PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using
 PROVISIONED for predictable workloads.
 
 
 
 
 PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend
 using PAY_PER_REQUEST for unpredictable workloads.
 
 
 


lastUpdateToPayPerRequestDateTime
Date lastUpdateToPayPerRequestDateTime

 Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.
 








Class com.amazonaws.services.dynamodbv2.model.CancellationReason extends Object implements Serializable


Serialized Fields


item
Map<K,V> item

 Item in the request which caused the transaction to get cancelled.
 


code
String code

 Status code for the result of the cancelled transaction.
 


message
String message

 Cancellation reason message description.
 








Class com.amazonaws.services.dynamodbv2.model.Capacity extends Object implements Serializable


Serialized Fields


readCapacityUnits
Double readCapacityUnits

 The total number of read capacity units consumed on a table or an index.
 


writeCapacityUnits
Double writeCapacityUnits

 The total number of write capacity units consumed on a table or an index.
 


capacityUnits
Double capacityUnits

 The total number of capacity units consumed on a table or an index.
 








Class com.amazonaws.services.dynamodbv2.model.Condition extends Object implements Serializable


Serialized Fields


attributeValueList
List<E> attributeValueList

 One or more values to evaluate against the supplied attribute. The number of values in the list depends on the
 ComparisonOperator being used.
 
 
 For type Number, value comparisons are numeric.
 
 
 String value comparisons for greater than, equals, or less than are based on ASCII character code values. For
 example, a is greater than A, and a is greater than B. For a
 list of code values, see http://en.wikipedia
 .org/wiki/ASCII#ASCII_printable_characters.
 
 
 For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
 


comparisonOperator
String comparisonOperator

 A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
 
 
 The following comparison operators are available:
 
 
 EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
 
 
 The following are descriptions of each comparison operator.
 
 
 
 
 EQ : Equal. EQ is supported for all data types, 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 data types, 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 data types, 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 data types, 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 in a list.
 
 
 AttributeValueList can contain one or more AttributeValue elements of type String,
 Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the
 input are equal to the item attribute, the expression evaluates to true.
 
 
 
 
 BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
 
 
 AttributeValueList must contain two AttributeValue elements of the same type, either
 String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or
 equal to, the first element and less than, or equal to, the second element. If an item contains an
 AttributeValue element of a different type than the one provided in the request, the value does not
 match. For example, {"S":"6"} does not compare to {"N":"6"}. Also,
 {"N":"6"} does not compare to {"NS":["6", "2", "1"]}
 
 
 
 
 For usage examples of AttributeValueList and ComparisonOperator, see Legacy
 Conditional Parameters in the Amazon DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.ConditionalCheckFailedException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.ConditionCheck extends Object implements Serializable


Serialized Fields


key
Map<K,V> key

 The primary key of the item to be checked. Each element consists of an attribute name and a value for that
 attribute.
 


tableName
String tableName

 Name of the table for the check item request.
 


conditionExpression
String conditionExpression

 A condition that must be satisfied in order for a conditional update to succeed.
 


expressionAttributeNames
Map<K,V> expressionAttributeNames

 One or more substitution tokens for attribute names in an expression.
 


expressionAttributeValues
Map<K,V> expressionAttributeValues

 One or more values that can be substituted in an expression.
 


returnValuesOnConditionCheckFailure
String returnValuesOnConditionCheckFailure

 Use ReturnValuesOnConditionCheckFailure to get the item attributes if the
 ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid
 values are: NONE and ALL_OLD.
 








Class com.amazonaws.services.dynamodbv2.model.ConsumedCapacity extends Object implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table that was affected by the operation.
 


capacityUnits
Double capacityUnits

 The total number of capacity units consumed by the operation.
 


readCapacityUnits
Double readCapacityUnits

 The total number of read capacity units consumed by the operation.
 


writeCapacityUnits
Double writeCapacityUnits

 The total number of write capacity units consumed by the operation.
 


table
Capacity table

 The amount of throughput consumed on the table affected by the operation.
 


localSecondaryIndexes
Map<K,V> localSecondaryIndexes

 The amount of throughput consumed on each local index affected by the operation.
 


globalSecondaryIndexes
Map<K,V> globalSecondaryIndexes

 The amount of throughput consumed on each global index affected by the operation.
 








Class com.amazonaws.services.dynamodbv2.model.ContinuousBackupsDescription extends Object implements Serializable


Serialized Fields


continuousBackupsStatus
String continuousBackupsStatus

 ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED
 


pointInTimeRecoveryDescription
PointInTimeRecoveryDescription pointInTimeRecoveryDescription

 The description of the point in time recovery settings applied to the table.
 








Class com.amazonaws.services.dynamodbv2.model.ContinuousBackupsUnavailableException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.ContributorInsightsSummary extends Object implements Serializable


Serialized Fields


tableName
String tableName

 Name of the table associated with the summary.
 


indexName
String indexName

 Name of the index associated with the summary, if any.
 


contributorInsightsStatus
String contributorInsightsStatus

 Describes the current status for contributor insights for the given table and index, if applicable.
 








Class com.amazonaws.services.dynamodbv2.model.CreateBackupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table.
 


backupName
String backupName

 Specified name for the backup.
 








Class com.amazonaws.services.dynamodbv2.model.CreateBackupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


backupDetails
BackupDetails backupDetails

 Contains the details of the backup created for the table.
 








Class com.amazonaws.services.dynamodbv2.model.CreateGlobalSecondaryIndexAction extends Object implements Serializable


Serialized Fields


indexName
String indexName

 The name of the global secondary index to be created.
 


keySchema
List<E> keySchema

 The key schema for the global secondary index.
 


projection
Projection projection

 Represents attributes that are copied (projected) from the table into an index. These are in addition to the
 primary key attributes and index key attributes, which are automatically projected.
 


provisionedThroughput
ProvisionedThroughput provisionedThroughput

 Represents the provisioned throughput settings for the specified global secondary index.
 
 
 For current minimum and maximum provisioned throughput values, see Limits in the Amazon
 DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.CreateGlobalTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalTableName
String globalTableName

 The global table name.
 


replicationGroup
List<E> replicationGroup

 The Regions where the global table needs to be created.
 








Class com.amazonaws.services.dynamodbv2.model.CreateGlobalTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


globalTableDescription
GlobalTableDescription globalTableDescription

 Contains the details of the global table.
 








Class com.amazonaws.services.dynamodbv2.model.CreateReplicaAction extends Object implements Serializable


Serialized Fields


regionName
String regionName

 The Region of the replica to be added.
 








Class com.amazonaws.services.dynamodbv2.model.CreateReplicationGroupMemberAction extends Object implements Serializable


Serialized Fields


regionName
String regionName

 The Region where the new replica will be created.
 


kMSMasterKeyId
String kMSMasterKeyId

 The AWS KMS customer master key (CMK) that should be used for AWS KMS encryption in the new replica. To specify a
 CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this
 parameter if the key is different from the default DynamoDB KMS master key alias/aws/dynamodb.
 


provisionedThroughputOverride
ProvisionedThroughputOverride provisionedThroughputOverride

 Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput
 settings.
 


globalSecondaryIndexes
List<E> globalSecondaryIndexes

 Replica-specific global secondary index settings.
 








Class com.amazonaws.services.dynamodbv2.model.CreateTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


attributeDefinitions
List<E> attributeDefinitions

 An array of attributes that describe the key schema for the table and indexes.
 


tableName
String tableName

 The name of the table to create.
 


keySchema
List<E> keySchema

 Specifies the attributes that make up the primary key for a table or an index. The attributes in
 KeySchema must also be defined in the AttributeDefinitions array. For more information,
 see Data Model in
 the Amazon DynamoDB Developer Guide.
 
 
 Each KeySchemaElement in the array is composed of:
 
 
 
 
 AttributeName - The name of this key attribute.
 
 
 
 
 KeyType - The role that the key attribute will assume:
 
 
 
 
 HASH - partition key
 
 
 
 
 RANGE - sort key
 
 
 
 
 
 
 
 The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from
 the 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 Working with Tables in the Amazon DynamoDB Developer Guide.
 


localSecondaryIndexes
List<E> localSecondaryIndexes

 One or more local secondary indexes (the maximum is 5) 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 is 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 100. If you project the same attribute into two different indexes, this
 counts as two distinct attributes when determining the total.
 
 
 
 
 


globalSecondaryIndexes
List<E> globalSecondaryIndexes

 One or more global secondary indexes (the maximum is 20) 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 is 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 100. 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.
 
 
 


billingMode
String billingMode

 Controls how you are charged for read and write throughput and how you manage capacity. This setting can be
 changed later.
 
 
 
 
 PROVISIONED - We recommend using PROVISIONED for predictable workloads.
 PROVISIONED sets the billing mode to Provisioned Mode.
 
 
 
 
 PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads.
 PAY_PER_REQUEST sets the billing mode to On-Demand Mode.
 
 
 


provisionedThroughput
ProvisionedThroughput provisionedThroughput

 Represents the provisioned throughput settings for a specified table or index. The settings can be modified using
 the UpdateTable operation.
 
 
 If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as
 PAY_PER_REQUEST, you cannot specify this property.
 
 
 For current minimum and maximum provisioned throughput values, see Limits in the Amazon
 DynamoDB Developer Guide.
 


streamSpecification
StreamSpecification streamSpecification

 The settings for DynamoDB Streams on the table. These settings consist of:
 
 
 
 
 StreamEnabled - Indicates whether DynamoDB 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.
 
 
 
 
 


sSESpecification
SSESpecification sSESpecification

 Represents the settings used to enable server-side encryption.
 


tags
List<E> tags

 A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.
 








Class com.amazonaws.services.dynamodbv2.model.CreateTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableDescription
TableDescription tableDescription

 Represents the properties of the table.
 








Class com.amazonaws.services.dynamodbv2.model.Delete extends Object implements Serializable


Serialized Fields


key
Map<K,V> key

 The primary key of the item to be deleted. Each element consists of an attribute name and a value for that
 attribute.
 


tableName
String tableName

 Name of the table in which the item to be deleted resides.
 


conditionExpression
String conditionExpression

 A condition that must be satisfied in order for a conditional delete to succeed.
 


expressionAttributeNames
Map<K,V> expressionAttributeNames

 One or more substitution tokens for attribute names in an expression.
 


expressionAttributeValues
Map<K,V> expressionAttributeValues

 One or more values that can be substituted in an expression.
 


returnValuesOnConditionCheckFailure
String returnValuesOnConditionCheckFailure

 Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete
 condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
 








Class com.amazonaws.services.dynamodbv2.model.DeleteBackupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


backupArn
String backupArn

 The ARN associated with the backup.
 








Class com.amazonaws.services.dynamodbv2.model.DeleteBackupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


backupDescription
BackupDescription backupDescription

 Contains the description of the backup created for the table.
 








Class com.amazonaws.services.dynamodbv2.model.DeleteGlobalSecondaryIndexAction extends Object implements Serializable


Serialized Fields


indexName
String indexName

 The name of the global secondary index to be deleted.
 








Class com.amazonaws.services.dynamodbv2.model.DeleteItemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table from which to delete the item.
 


key
Map<K,V> key

 A map of attribute names to AttributeValue objects, representing the primary key of the item to
 delete.
 
 
 For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only
 need to provide a value for the partition key. For a composite primary key, you must provide values for both the
 partition key and the sort key.
 


expected
Map<K,V> expected

 This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
 


conditionalOperator
String conditionalOperator

 This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
 


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.
 
 


returnConsumedCapacity
String returnConsumedCapacity


returnItemCollectionMetrics
String returnItemCollectionMetrics

 Determines whether item collection metrics are returned. If set to SIZE, the response includes
 statistics about item collections, if any, that were modified during the operation are returned in the response.
 If set to NONE (the default), no statistics are returned.
 


conditionExpression
String conditionExpression

 A condition that must be satisfied in order for a conditional DeleteItem to succeed.
 
 
 An expression can contain any of the following:
 
 
 
 
 Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
 
 
 These function names are case-sensitive.
 
 
 
 
 Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN 
 
 
 
 
 Logical operators: AND | OR | NOT
 
 
 
 
 For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.
 


expressionAttributeNames
Map<K,V> expressionAttributeNames

 One or more substitution tokens for attribute names in an expression. The following are some use cases for using
 ExpressionAttributeNames:
 
 
 
 
 To access an attribute whose name conflicts with a DynamoDB reserved word.
 
 
 
 
 To create a placeholder for repeating occurrences of an attribute name in an expression.
 
 
 
 
 To prevent special characters in an attribute name from being misinterpreted in an expression.
 
 
 
 
 Use the # character in an expression to dereference an attribute name. For example, consider the following
 attribute name:
 
 
 
 
 Percentile
 
 
 
 
 The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
 the complete list of reserved words, see Reserved Words in
 the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
 ExpressionAttributeNames:
 
 
 
 
 {"#P":"Percentile"}
 
 
 
 
 You could then use this substitution in an expression, as in this example:
 
 
 
 
 #P = :val
 
 
 
 
 
 Tokens that begin with the : character are expression attribute values, which are placeholders for
 the actual value at runtime.
 
 
 
 For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
 


expressionAttributeValues
Map<K,V> expressionAttributeValues

 One or more values that can be substituted in an expression.
 
 
 Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that
 you wanted to check whether the value of the ProductStatus attribute was one of the following:
 
 
 Available | Backordered | Discontinued
 
 
 You would first need to specify ExpressionAttributeValues as follows:
 
 
 { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
 
 
 You could then use these values in an expression, such as this:
 
 
 ProductStatus IN (:avail, :back, :disc)
 
 
 For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.DeleteItemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
Map<K,V> attributes

 A map of attribute names to AttributeValue objects, representing the item as it appeared before the
 DeleteItem operation. This map appears in the response only if ReturnValues was
 specified as ALL_OLD in the request.
 


consumedCapacity
ConsumedCapacity consumedCapacity

 The capacity units consumed by the DeleteItem operation. The data returned includes the total
 provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation.
 ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was
 specified. For more information, see Provisioned Mode in the Amazon DynamoDB Developer Guide.
 


itemCollectionMetrics
ItemCollectionMetrics itemCollectionMetrics

 Information about item collections, if any, that were affected by the DeleteItem operation.
 ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was
 specified. 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.
 
 
 
 
 SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element
 array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the
 items in the table, plus the size of all attributes projected into all of the local secondary indexes on that
 table. Use this estimate to measure whether a local secondary index is approaching its size limit.
 
 
 The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
 
 
 








Class com.amazonaws.services.dynamodbv2.model.DeleteReplicaAction extends Object implements Serializable


Serialized Fields


regionName
String regionName

 The Region of the replica to be removed.
 








Class com.amazonaws.services.dynamodbv2.model.DeleteReplicationGroupMemberAction extends Object implements Serializable


Serialized Fields


regionName
String regionName

 The Region where the replica exists.
 








Class com.amazonaws.services.dynamodbv2.model.DeleteRequest extends Object implements Serializable


Serialized Fields


key
Map<K,V> key

 A map of attribute name to attribute values, representing the primary key of the item to delete. All of the
 table's primary key attributes must be specified, and their data types must match those of the table's key
 schema.
 








Class com.amazonaws.services.dynamodbv2.model.DeleteTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table to delete.
 








Class com.amazonaws.services.dynamodbv2.model.DeleteTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableDescription
TableDescription tableDescription

 Represents the properties of a table.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeBackupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


backupArn
String backupArn

 The Amazon Resource Name (ARN) associated with the backup.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeBackupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


backupDescription
BackupDescription backupDescription

 Contains the description of the backup created for the table.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeContinuousBackupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 Name of the table for which the customer wants to check the continuous backups and point in time recovery
 settings.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeContinuousBackupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


continuousBackupsDescription
ContinuousBackupsDescription continuousBackupsDescription

 Represents the continuous backups and point in time recovery settings on the table.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeContributorInsightsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table to describe.
 


indexName
String indexName

 The name of the global secondary index to describe, if applicable.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeContributorInsightsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table being described.
 


indexName
String indexName

 The name of the global secondary index being described.
 


contributorInsightsRuleList
List<E> contributorInsightsRuleList

 List of names of the associated Alpine rules.
 


contributorInsightsStatus
String contributorInsightsStatus

 Current Status contributor insights.
 


lastUpdateDateTime
Date lastUpdateDateTime

 Timestamp of the last time the status was changed.
 


failureException
FailureException failureException

 Returns information about the last failure that encountered.
 
 
 The most common exceptions for a FAILED status are:
 
 
 
 
 LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable
 Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying.
 
 
 
 
 AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient
 permissions.
 
 
 
 
 AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient
 permissions.
 
 
 
 
 InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.
 
 
 








Class com.amazonaws.services.dynamodbv2.model.DescribeEndpointsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.dynamodbv2.model.DescribeEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpoints
List<E> endpoints

 List of endpoints.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeGlobalTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalTableName
String globalTableName

 The name of the global table.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeGlobalTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


globalTableDescription
GlobalTableDescription globalTableDescription

 Contains the details of the global table.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeGlobalTableSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalTableName
String globalTableName

 The name of the global table to describe.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeGlobalTableSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


globalTableName
String globalTableName

 The name of the global table.
 


replicaSettings
List<E> replicaSettings

 The Region-specific settings for the global table.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeLimitsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.dynamodbv2.model.DescribeLimitsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accountMaxReadCapacityUnits
Long accountMaxReadCapacityUnits

 The maximum total read capacity units that your account allows you to provision across all of your tables in this
 Region.
 


accountMaxWriteCapacityUnits
Long accountMaxWriteCapacityUnits

 The maximum total write capacity units that your account allows you to provision across all of your tables in
 this Region.
 


tableMaxReadCapacityUnits
Long tableMaxReadCapacityUnits

 The maximum read capacity units that your account allows you to provision for a new table that you are creating
 in this Region, including the read capacity units provisioned for its global secondary indexes (GSIs).
 


tableMaxWriteCapacityUnits
Long tableMaxWriteCapacityUnits

 The maximum write capacity units that your account allows you to provision for a new table that you are creating
 in this Region, including the write capacity units provisioned for its global secondary indexes (GSIs).
 








Class com.amazonaws.services.dynamodbv2.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamArn
String streamArn

 The Amazon Resource Name (ARN) for the stream.
 


limit
Integer limit

 The maximum number of shard objects to return. The upper limit is 100.
 


exclusiveStartShardId
String exclusiveStartShardId

 The shard ID of the first item that this operation will evaluate. Use the value that was returned for
 LastEvaluatedShardId in the previous operation.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeStreamResult extends AmazonWebServiceResult<ResponseMetadata> 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.DescribeTableReplicaAutoScalingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeTableReplicaAutoScalingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableAutoScalingDescription
TableAutoScalingDescription tableAutoScalingDescription

 Represents the auto scaling properties of the table.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table to describe.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


table
TableDescription table

 The properties of the table.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeTimeToLiveRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table to be described.
 








Class com.amazonaws.services.dynamodbv2.model.DescribeTimeToLiveResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


timeToLiveDescription
TimeToLiveDescription timeToLiveDescription









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


Serialized Fields


address
String address

 IP address of the endpoint.
 


cachePeriodInMinutes
Long cachePeriodInMinutes

 Endpoint cache time to live (TTL) value.
 








Class com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue extends Object implements Serializable


Serialized Fields


value
AttributeValue value

 Represents the data for the expected attribute.
 
 
 Each attribute value is described as a name-value pair. The name is the data type, and the value is the data
 itself.
 
 
 For more information, see Data Types in the Amazon DynamoDB Developer Guide.
 


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
 ConditionCheckFailedException.
 
 
 
 
 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
 ConditionCheckFailedException.
 
 
 
 
 The default setting for Exists is true. If you supply a Value all by
 itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true,
 because it is implied.
 
 
 DynamoDB returns a ValidationException if:
 
 
 
 
 Exists is true but there is no Value to check. (You expect a value to
 exist, but don't specify what that value is.)
 
 
 
 
 Exists is false but you also provide a Value. (You cannot expect an
 attribute to have a value, while also expecting it not to exist.)
 
 
 


comparisonOperator
String comparisonOperator

 A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than,
 less than, etc.
 
 
 The following comparison operators are available:
 
 
 EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
 
 
 The following are descriptions of each comparison operator.
 
 
 
 
 EQ : Equal. EQ is supported for all data types, 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 data types, 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 data types, 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 data types, 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 in a list.
 
 
 AttributeValueList can contain one or more AttributeValue elements of type String,
 Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the
 input are equal to the item attribute, the expression evaluates to true.
 
 
 
 
 BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.
 
 
 AttributeValueList must contain two AttributeValue elements of the same type, either
 String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or
 equal to, the first element and less than, or equal to, the second element. If an item contains an
 AttributeValue element of a different type than the one provided in the request, the value does not
 match. For example, {"S":"6"} does not compare to {"N":"6"}. Also,
 {"N":"6"} does not compare to {"NS":["6", "2", "1"]}
 
 
 


attributeValueList
List<E> attributeValueList

 One or more values to evaluate against the supplied attribute. The number of values in the list depends on the
 ComparisonOperator being used.
 
 
 For type Number, value comparisons are numeric.
 
 
 String value comparisons for greater than, equals, or less than are based on ASCII character code values. For
 example, a is greater than A, and a is greater than B. For a
 list of code values, see http://en.wikipedia
 .org/wiki/ASCII#ASCII_printable_characters.
 
 
 For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
 
 
 For information on specifying data types in JSON, see JSON Data Format in
 the Amazon DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.ExpiredIteratorException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.FailureException extends Object implements Serializable


Serialized Fields


exceptionName
String exceptionName

 Exception name.
 


exceptionDescription
String exceptionDescription

 Description of the failure.
 








Class com.amazonaws.services.dynamodbv2.model.Get extends Object implements Serializable


Serialized Fields


key
Map<K,V> key

 A map of attribute names to AttributeValue objects that specifies the primary key of the item to
 retrieve.
 


tableName
String tableName

 The name of the table from which to retrieve the specified item.
 


projectionExpression
String projectionExpression

 A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes
 in the expression must be separated by commas. If no attribute names are specified, then all attributes of the
 specified item are returned. If any of the requested attributes are not found, they do not appear in the result.
 


expressionAttributeNames
Map<K,V> expressionAttributeNames

 One or more substitution tokens for attribute names in the ProjectionExpression parameter.
 








Class com.amazonaws.services.dynamodbv2.model.GetItemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table containing the requested item.
 


key
Map<K,V> key

 A map of attribute names to AttributeValue objects, representing the primary key of the item to
 retrieve.
 
 
 For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only
 need to provide a value for the partition key. For a composite primary key, you must provide values for both the
 partition key and the sort key.
 


attributesToGet
List<E> attributesToGet

 This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.
 


consistentRead
Boolean consistentRead

 Determines the read consistency model: If set to true, then the operation uses strongly consistent
 reads; otherwise, the operation uses eventually consistent reads.
 


returnConsumedCapacity
String returnConsumedCapacity


projectionExpression
String projectionExpression

 A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars,
 sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
 
 
 If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not
 found, they do not appear in the result.
 
 
 For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
 


expressionAttributeNames
Map<K,V> expressionAttributeNames

 One or more substitution tokens for attribute names in an expression. The following are some use cases for using
 ExpressionAttributeNames:
 
 
 
 
 To access an attribute whose name conflicts with a DynamoDB reserved word.
 
 
 
 
 To create a placeholder for repeating occurrences of an attribute name in an expression.
 
 
 
 
 To prevent special characters in an attribute name from being misinterpreted in an expression.
 
 
 
 
 Use the # character in an expression to dereference an attribute name. For example, consider the following
 attribute name:
 
 
 
 
 Percentile
 
 
 
 
 The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
 the complete list of reserved words, see Reserved Words in
 the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
 ExpressionAttributeNames:
 
 
 
 
 {"#P":"Percentile"}
 
 
 
 
 You could then use this substitution in an expression, as in this example:
 
 
 
 
 #P = :val
 
 
 
 
 
 Tokens that begin with the : character are expression attribute values, which are placeholders for
 the actual value at runtime.
 
 
 
 For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.GetItemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


item
Map<K,V> item

 A map of attribute names to AttributeValue objects, as specified by
 ProjectionExpression.
 


consumedCapacity
ConsumedCapacity consumedCapacity

 The capacity units consumed by the GetItem operation. The data returned includes the total
 provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation.
 ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was
 specified. For more information, see Read/Write Capacity Mode in the Amazon DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.GetRecordsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


shardIterator
String shardIterator

 A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to
 access the stream records in this shard.
 


limit
Integer limit

 The maximum number of records to return from the shard. The upper limit is 1000.
 








Class com.amazonaws.services.dynamodbv2.model.GetRecordsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


records
List<E> records

 The stream records from the shard, which were retrieved using the shard iterator.
 


nextShardIterator
String nextShardIterator

 The next position in the shard from which to start sequentially reading stream records. If set to
 null, the shard has been closed and the requested iterator will not return any more data.
 








Class com.amazonaws.services.dynamodbv2.model.GetShardIteratorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamArn
String streamArn

 The Amazon Resource Name (ARN) for the stream.
 


shardId
String shardId

 The identifier of the shard. The iterator will be returned for this shard ID.
 


shardIteratorType
String shardIteratorType

 Determines how the shard iterator is used to start reading stream records from the shard:
 
 
 
 
 AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.
 
 
 
 
 AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence
 number.
 
 
 
 
 TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in
 the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this
 limit are subject to removal (trimming) from the stream.
 
 
 
 
 LATEST - Start reading just after the most recent stream record in the shard, so that you always
 read the most recent data in the shard.
 
 
 


sequenceNumber
String sequenceNumber

 The sequence number of a stream record in the shard from which to start reading.
 








Class com.amazonaws.services.dynamodbv2.model.GetShardIteratorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


shardIterator
String shardIterator

 The position in the shard from which to start reading stream records sequentially. A shard iterator specifies
 this position using the sequence number of a stream record in a shard.
 








Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndex extends Object implements Serializable


Serialized Fields


indexName
String indexName

 The name of the global secondary index. The name must be unique among all other indexes on this table.
 


keySchema
List<E> keySchema

 The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and
 key types:
 
 
 
 
 HASH - partition key
 
 
 
 
 RANGE - sort key
 
 
 
 
 
 The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from
 DynamoDB's 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

 Represents attributes that are copied (projected) from the table into the global secondary index. These are in
 addition to the primary key attributes and index key attributes, which are automatically projected.
 


provisionedThroughput
ProvisionedThroughput provisionedThroughput

 Represents the provisioned throughput settings for the specified global secondary index.
 
 
 For current minimum and maximum provisioned throughput values, see Limits in the Amazon
 DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexAutoScalingUpdate extends Object implements Serializable


Serialized Fields


indexName
String indexName

 The name of the global secondary index.
 


provisionedWriteCapacityAutoScalingUpdate
AutoScalingSettingsUpdate provisionedWriteCapacityAutoScalingUpdate








Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexDescription extends Object implements Serializable


Serialized Fields


indexName
String indexName

 The name of the global secondary index.
 


keySchema
List<E> keySchema

 The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and
 key types:
 
 
 
 
 HASH - partition key
 
 
 
 
 RANGE - sort key
 
 
 
 
 
 The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from
 DynamoDB's 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

 Represents attributes that are copied (projected) from the table into the global secondary index. These are in
 addition to the primary key attributes and index key attributes, which are automatically projected.
 


indexStatus
String indexStatus

 The current state of the global secondary index:
 
 
 
 
 CREATING - The index is being created.
 
 
 
 
 UPDATING - The index is being updated.
 
 
 
 
 DELETING - The index is being deleted.
 
 
 
 
 ACTIVE - The index is ready for use.
 
 
 


backfilling
Boolean backfilling

 Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the
 table and determining whether they can be added to the index. (Not all items will qualify: For example, a
 partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After
 all items have been processed, the backfilling operation is complete and Backfilling is false.
 
 
 You can delete an index that is being created during the Backfilling phase when
 IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that
 is being created when IndexStatus is set to CREATING and Backfilling is false.
 
 
 
 For indexes that were created during a CreateTable operation, the Backfilling attribute
 does not appear in the DescribeTable output.
 
 


provisionedThroughput
ProvisionedThroughputDescription provisionedThroughput

 Represents the provisioned throughput settings for the specified global secondary index.
 
 
 For current minimum and maximum provisioned throughput values, see Limits in the Amazon
 DynamoDB Developer Guide.
 


indexSizeBytes
Long indexSizeBytes

 The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours.
 Recent changes might not be reflected in this value.
 


itemCount
Long itemCount

 The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent
 changes might not be reflected in this value.
 


indexArn
String indexArn

 The Amazon Resource Name (ARN) that uniquely identifies the index.
 








Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexInfo extends Object implements Serializable


Serialized Fields


indexName
String indexName

 The name of the global secondary index.
 


keySchema
List<E> keySchema

 The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and
 key types:
 
 
 
 
 HASH - partition key
 
 
 
 
 RANGE - sort key
 
 
 
 
 
 The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from
 DynamoDB's 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

 Represents attributes that are copied (projected) from the table into the global secondary index. These are in
 addition to the primary key attributes and index key attributes, which are automatically projected.
 


provisionedThroughput
ProvisionedThroughput provisionedThroughput

 Represents the provisioned throughput settings for the specified global secondary index.
 








Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexUpdate extends Object implements Serializable


Serialized Fields


update
UpdateGlobalSecondaryIndexAction update

 The name of an existing global secondary index, along with new provisioned throughput settings to be applied to
 that index.
 


create
CreateGlobalSecondaryIndexAction create

 The parameters required for creating a global secondary index on an existing table:
 
 
 
 
 IndexName 
 
 
 
 
 KeySchema 
 
 
 
 
 AttributeDefinitions 
 
 
 
 
 Projection 
 
 
 
 
 ProvisionedThroughput 
 
 
 


delete
DeleteGlobalSecondaryIndexAction delete

 The name of an existing global secondary index to be removed.
 








Class com.amazonaws.services.dynamodbv2.model.GlobalTable extends Object implements Serializable


Serialized Fields


globalTableName
String globalTableName

 The global table name.
 


replicationGroup
List<E> replicationGroup

 The Regions where the global table has replicas.
 








Class com.amazonaws.services.dynamodbv2.model.GlobalTableAlreadyExistsException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.GlobalTableDescription extends Object implements Serializable


Serialized Fields


replicationGroup
List<E> replicationGroup

 The Regions where the global table has replicas.
 


globalTableArn
String globalTableArn

 The unique identifier of the global table.
 


creationDateTime
Date creationDateTime

 The creation time of the global table.
 


globalTableStatus
String globalTableStatus

 The current state of the global table:
 
 
 
 
 CREATING - The global table is being created.
 
 
 
 
 UPDATING - The global table is being updated.
 
 
 
 
 DELETING - The global table is being deleted.
 
 
 
 
 ACTIVE - The global table is ready for use.
 
 
 


globalTableName
String globalTableName

 The global table name.
 








Class com.amazonaws.services.dynamodbv2.model.GlobalTableGlobalSecondaryIndexSettingsUpdate 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.
 


provisionedWriteCapacityUnits
Long provisionedWriteCapacityUnits

 The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
 


provisionedWriteCapacityAutoScalingSettingsUpdate
AutoScalingSettingsUpdate provisionedWriteCapacityAutoScalingSettingsUpdate

 Auto scaling settings for managing a global secondary index's write capacity units.
 








Class com.amazonaws.services.dynamodbv2.model.GlobalTableNotFoundException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.IdempotentParameterMismatchException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.Identity extends Object implements Serializable


Serialized Fields


principalId
String principalId

 A unique identifier for the entity that made the call. For Time To Live, the principalId is
 "dynamodb.amazonaws.com".
 


type
String type

 The type of the identity. For Time To Live, the type is "Service".
 








Class com.amazonaws.services.dynamodbv2.model.IndexNotFoundException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.InternalServerErrorException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.InvalidRestoreTimeException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.ItemCollectionMetrics extends Object implements Serializable


Serialized Fields


itemCollectionKey
Map<K,V> itemCollectionKey

 The partition key value of the item collection. This value is the same as the partition key value of the item.
 


sizeEstimateRangeGB
List<E> sizeEstimateRangeGB

 An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and
 an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of
 all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure
 whether a local secondary index is approaching its size limit.
 
 
 The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
 








Class com.amazonaws.services.dynamodbv2.model.ItemCollectionSizeLimitExceededException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.ItemResponse extends Object implements Serializable


Serialized Fields


item
Map<K,V> item

 Map of attribute data consisting of the data type and attribute value.
 








Class com.amazonaws.services.dynamodbv2.model.KeysAndAttributes extends Object implements Serializable


Serialized Fields


keys
List<E> keys

 The primary key attribute values that define the items and the attributes associated with the items.
 


attributesToGet
List<E> attributesToGet

 This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy
 Conditional Parameters in the Amazon DynamoDB Developer Guide.
 


consistentRead
Boolean consistentRead

 The consistency of a read operation. If set to true, then a strongly consistent read is used;
 otherwise, an eventually consistent read is used.
 


projectionExpression
String projectionExpression

 A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars,
 sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated
 by commas.
 
 
 If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are
 not found, they will not appear in the result.
 
 
 For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
 


expressionAttributeNames
Map<K,V> expressionAttributeNames

 One or more substitution tokens for attribute names in an expression. The following are some use cases for using
 ExpressionAttributeNames:
 
 
 
 
 To access an attribute whose name conflicts with a DynamoDB reserved word.
 
 
 
 
 To create a placeholder for repeating occurrences of an attribute name in an expression.
 
 
 
 
 To prevent special characters in an attribute name from being misinterpreted in an expression.
 
 
 
 
 Use the # character in an expression to dereference an attribute name. For example, consider the following
 attribute name:
 
 
 
 
 Percentile
 
 
 
 
 The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
 the complete list of reserved words, see Reserved Words in
 the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
 ExpressionAttributeNames:
 
 
 
 
 {"#P":"Percentile"}
 
 
 
 
 You could then use this substitution in an expression, as in this example:
 
 
 
 
 #P = :val
 
 
 
 
 
 Tokens that begin with the : character are expression attribute values, which are placeholders for
 the actual value at runtime.
 
 
 
 For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.KeySchemaElement extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 The name of a key attribute.
 


keyType
String keyType

 The role that this key attribute will assume:
 
 
 
 
 HASH - partition key
 
 
 
 
 RANGE - sort key
 
 
 
 
 
 The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from
 DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their
 partition key values.
 
 
 The sort key of an item is also known as its range attribute. The term "range attribute" derives from the
 way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key
 value.
 
 








Class com.amazonaws.services.dynamodbv2.model.LimitExceededException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.ListBackupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The backups from the table specified by TableName are listed.
 


limit
Integer limit

 Maximum number of backups to return at once.
 


timeRangeLowerBound
Date timeRangeLowerBound

 Only backups created after this time are listed. TimeRangeLowerBound is inclusive.
 


timeRangeUpperBound
Date timeRangeUpperBound

 Only backups created before this time are listed. TimeRangeUpperBound is exclusive.
 


exclusiveStartBackupArn
String exclusiveStartBackupArn

 LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the
 current page of results was returned, inclusive of the current page of results. This value may be specified as
 the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next
 page of results.
 


backupType
String backupType

 The backups from the table specified by BackupType are listed.
 
 
 Where BackupType can be:
 
 
 
 
 USER - On-demand backup created by you.
 
 
 
 
 SYSTEM - On-demand backup automatically created by DynamoDB.
 
 
 
 
 ALL - All types of on-demand backups (USER and SYSTEM).
 
 
 








Class com.amazonaws.services.dynamodbv2.model.ListBackupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


backupSummaries
List<E> backupSummaries

 List of BackupSummary objects.
 


lastEvaluatedBackupArn
String lastEvaluatedBackupArn

 The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page
 of results. This value may be specified as the ExclusiveStartBackupArn of a new
 ListBackups operation in order to fetch the next page of results.
 
 
 If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are
 no more results to be retrieved.
 
 
 If LastEvaluatedBackupArn is not empty, this may or may not indicate that there is more data to be
 returned. All results are guaranteed to have been returned if and only if no value for
 LastEvaluatedBackupArn is returned.
 








Class com.amazonaws.services.dynamodbv2.model.ListContributorInsightsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table.
 


nextToken
String nextToken

 A token to for the desired page, if there is one.
 


maxResults
Integer maxResults

 Maximum number of results to return per page.
 








Class com.amazonaws.services.dynamodbv2.model.ListContributorInsightsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contributorInsightsSummaries
List<E> contributorInsightsSummaries

 A list of ContributorInsightsSummary.
 


nextToken
String nextToken

 A token to go to the next page if there is one.
 








Class com.amazonaws.services.dynamodbv2.model.ListGlobalTablesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


exclusiveStartGlobalTableName
String exclusiveStartGlobalTableName

 The first global table name that this operation will evaluate.
 


limit
Integer limit

 The maximum number of table names to return.
 


regionName
String regionName

 Lists the global tables in a specific Region.
 








Class com.amazonaws.services.dynamodbv2.model.ListGlobalTablesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


globalTables
List<E> globalTables

 List of global table names.
 


lastEvaluatedGlobalTableName
String lastEvaluatedGlobalTableName

 Last evaluated global table name.
 








Class com.amazonaws.services.dynamodbv2.model.ListStreamsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 If this parameter is provided, then only the streams associated with this table name are returned.
 


limit
Integer limit

 The maximum number of streams to return. The upper limit is 100.
 


exclusiveStartStreamArn
String exclusiveStartStreamArn

 The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was
 returned for LastEvaluatedStreamArn in the previous operation.
 








Class com.amazonaws.services.dynamodbv2.model.ListStreamsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streams
List<E> streams

 A list of stream descriptors associated with the current account and endpoint.
 


lastEvaluatedStreamArn
String lastEvaluatedStreamArn

 The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to
 start a new operation, excluding this value in the new request.
 
 
 If LastEvaluatedStreamArn is empty, then the "last page" of results has been processed and there is
 no more data to be retrieved.
 
 
 If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there is more data in the
 result set. The only way to know when you have reached the end of the result set is when
 LastEvaluatedStreamArn is empty.
 








Class com.amazonaws.services.dynamodbv2.model.ListTablesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


exclusiveStartTableName
String exclusiveStartTableName

 The first table name that this operation will evaluate. Use the value that was returned for
 LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.
 


limit
Integer limit

 A maximum number of table names to return. If this parameter is not specified, the limit is 100.
 








Class com.amazonaws.services.dynamodbv2.model.ListTablesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableNames
List<E> tableNames

 The names of the tables associated with the current account at the current endpoint. The maximum size of this
 array is 100.
 
 
 If LastEvaluatedTableName also appears in the output, you can use this value as the
 ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the
 next page of results.
 


lastEvaluatedTableName
String lastEvaluatedTableName

 The name of the last table in the current page of results. Use this value as the
 ExclusiveStartTableName in a new request to obtain the next page of results, until all the table
 names are returned.
 
 
 If you do not receive a LastEvaluatedTableName value in the response, this means that there are no
 more table names to be retrieved.
 








Class com.amazonaws.services.dynamodbv2.model.ListTagsOfResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).
 


nextToken
String nextToken

 An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource.
 When provided in this manner, this API fetches the next page of results.
 








Class com.amazonaws.services.dynamodbv2.model.ListTagsOfResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The tags currently associated with the Amazon DynamoDB resource.
 


nextToken
String nextToken

 If this value is returned, there are additional results to be displayed. To retrieve them, call
 ListTagsOfResource again, with NextToken set to this value.
 








Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndex extends Object implements Serializable


Serialized Fields


indexName
String indexName

 The name of the local secondary index. The name must be unique among all other indexes on this table.
 


keySchema
List<E> keySchema

 The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key
 types:
 
 
 
 
 HASH - partition key
 
 
 
 
 RANGE - sort key
 
 
 
 
 
 The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from
 DynamoDB's 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

 Represents attributes that are copied (projected) from the table into the local secondary index. These are in
 addition to the primary key attributes and index key attributes, which are automatically projected.
 








Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexDescription extends Object implements Serializable


Serialized Fields


indexName
String indexName

 Represents the name of the local secondary index.
 


keySchema
List<E> keySchema

 The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key
 types:
 
 
 
 
 HASH - partition key
 
 
 
 
 RANGE - sort key
 
 
 
 
 
 The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from
 DynamoDB's 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

 Represents attributes that are copied (projected) from the table into the global secondary index. These are in
 addition to the primary key attributes and index key attributes, which are automatically projected.
 


indexSizeBytes
Long indexSizeBytes

 The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours.
 Recent changes might not be reflected in this value.
 


itemCount
Long itemCount

 The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent
 changes might not be reflected in this value.
 


indexArn
String indexArn

 The Amazon Resource Name (ARN) that uniquely identifies the index.
 








Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexInfo extends Object implements Serializable


Serialized Fields


indexName
String indexName

 Represents the name of the local secondary index.
 


keySchema
List<E> keySchema

 The complete key schema for a local 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's 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

 Represents attributes that are copied (projected) from the table into the global secondary index. These are in
 addition to the primary key attributes and index key attributes, which are automatically projected.
 








Class com.amazonaws.services.dynamodbv2.model.PointInTimeRecoveryDescription extends Object implements Serializable


Serialized Fields


pointInTimeRecoveryStatus
String pointInTimeRecoveryStatus

 The current state of point in time recovery:
 
 
 
 
 ENABLING - Point in time recovery is being enabled.
 
 
 
 
 ENABLED - Point in time recovery is enabled.
 
 
 
 
 DISABLED - Point in time recovery is disabled.
 
 
 


earliestRestorableDateTime
Date earliestRestorableDateTime

 Specifies the earliest point in time you can restore your table to. You can restore your table to any point in
 time during the last 35 days.
 


latestRestorableDateTime
Date latestRestorableDateTime

 LatestRestorableDateTime is typically 5 minutes before the current time.
 








Class com.amazonaws.services.dynamodbv2.model.PointInTimeRecoverySpecification extends Object implements Serializable


Serialized Fields


pointInTimeRecoveryEnabled
Boolean pointInTimeRecoveryEnabled

 Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
 








Class com.amazonaws.services.dynamodbv2.model.PointInTimeRecoveryUnavailableException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.Projection extends Object implements Serializable


Serialized Fields


projectionType
String projectionType

 The set of attributes that are projected into the index:
 
 
 
 
 KEYS_ONLY - Only the index and primary keys are projected into the index.
 
 
 
 
 INCLUDE - Only the specified table attributes are projected into the index. The list of projected
 attributes is in NonKeyAttributes.
 
 
 
 
 ALL - All of the table attributes are projected into the index.
 
 
 


nonKeyAttributes
List<E> nonKeyAttributes

 Represents the non-key attribute names which will be projected into the index.
 
 
 For local secondary indexes, the total count of NonKeyAttributes summed across all of the local
 secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts
 as two distinct attributes when determining the total.
 








Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput extends Object implements Serializable


Serialized Fields


readCapacityUnits
Long readCapacityUnits

 The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
 ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.
 
 
 If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
 


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.
 
 
 If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.
 








Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputDescription extends Object implements Serializable


Serialized Fields


lastIncreaseDateTime
Date lastIncreaseDateTime

 The date and time of the last provisioned throughput increase for this table.
 


lastDecreaseDateTime
Date lastDecreaseDateTime

 The date and time of the last provisioned throughput decrease for this table.
 


numberOfDecreasesToday
Long numberOfDecreasesToday

 The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums
 on provisioned throughput decreases, see Limits in the Amazon
 DynamoDB Developer Guide.
 


readCapacityUnits
Long readCapacityUnits

 The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
 ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads,
 so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent
 ReadCapacityUnits per second.
 


writeCapacityUnits
Long writeCapacityUnits

 The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
 








Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputExceededException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputOverride extends Object implements Serializable


Serialized Fields


readCapacityUnits
Long readCapacityUnits

 Replica-specific read capacity units. If not specified, uses the source table's read capacity settings.
 








Class com.amazonaws.services.dynamodbv2.model.Put extends Object implements Serializable


Serialized Fields


item
Map<K,V> item

 A map of attribute name to attribute values, representing the primary key of the item to be written 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 that are part of an index key
 schema for the table, their types must match the index key schema.
 


tableName
String tableName

 Name of the table in which to write the item.
 


conditionExpression
String conditionExpression

 A condition that must be satisfied in order for a conditional update to succeed.
 


expressionAttributeNames
Map<K,V> expressionAttributeNames

 One or more substitution tokens for attribute names in an expression.
 


expressionAttributeValues
Map<K,V> expressionAttributeValues

 One or more values that can be substituted in an expression.
 


returnValuesOnConditionCheckFailure
String returnValuesOnConditionCheckFailure

 Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition
 fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
 








Class com.amazonaws.services.dynamodbv2.model.PutItemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table to contain the item.
 


item
Map<K,V> item

 A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you
 can optionally provide other attribute name-value pairs for the item.
 
 
 You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need
 to provide a value for the partition key. For a composite primary key, you must provide both values for both the
 partition key and the sort key.
 
 
 If you specify any attributes that are part of an index key, then the data types for those attributes must match
 those of the schema in the table's attribute definition.
 
 
 For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
 
 
 Each element in the Item map is an AttributeValue object.
 


expected
Map<K,V> expected

 This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
 


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.
 
 


returnConsumedCapacity
String returnConsumedCapacity


returnItemCollectionMetrics
String returnItemCollectionMetrics

 Determines whether item collection metrics are returned. If set to SIZE, the response includes
 statistics about item collections, if any, that were modified during the operation are returned in the response.
 If set to NONE (the default), no statistics are returned.
 


conditionalOperator
String conditionalOperator

 This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
 


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 Condition Expressions in the Amazon DynamoDB Developer Guide.
 


expressionAttributeNames
Map<K,V> expressionAttributeNames

 One or more substitution tokens for attribute names in an expression. The following are some use cases for using
 ExpressionAttributeNames:
 
 
 
 
 To access an attribute whose name conflicts with a DynamoDB reserved word.
 
 
 
 
 To create a placeholder for repeating occurrences of an attribute name in an expression.
 
 
 
 
 To prevent special characters in an attribute name from being misinterpreted in an expression.
 
 
 
 
 Use the # character in an expression to dereference an attribute name. For example, consider the following
 attribute name:
 
 
 
 
 Percentile
 
 
 
 
 The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
 the complete list of reserved words, see Reserved Words in
 the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
 ExpressionAttributeNames:
 
 
 
 
 {"#P":"Percentile"}
 
 
 
 
 You could then use this substitution in an expression, as in this example:
 
 
 
 
 #P = :val
 
 
 
 
 
 Tokens that begin with the : character are expression attribute values, which are placeholders for
 the actual value at runtime.
 
 
 
 For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
 


expressionAttributeValues
Map<K,V> expressionAttributeValues

 One or more values that can be substituted in an expression.
 
 
 Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that
 you wanted to check whether the value of the ProductStatus attribute was one of the following:
 
 
 Available | Backordered | Discontinued
 
 
 You would first need to specify ExpressionAttributeValues as follows:
 
 
 { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
 
 
 You could then use these values in an expression, such as this:
 
 
 ProductStatus IN (:avail, :back, :disc)
 
 
 For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.PutItemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
Map<K,V> attributes

 The attribute values as they appeared before the PutItem operation, but only if
 ReturnValues is specified as ALL_OLD in the request. Each element consists of an
 attribute name and an attribute value.
 


consumedCapacity
ConsumedCapacity consumedCapacity

 The capacity units consumed by the PutItem operation. The data returned includes the total
 provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation.
 ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was
 specified. For more information, see Read/Write Capacity Mode in the Amazon DynamoDB Developer Guide.
 


itemCollectionMetrics
ItemCollectionMetrics itemCollectionMetrics

 Information about item collections, if any, that were affected by the PutItem operation.
 ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was
 specified. 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.
 
 
 
 
 SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element
 array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the
 items in the table, plus the size of all attributes projected into all of the local secondary indexes on that
 table. Use this estimate to measure whether a local secondary index is approaching its size limit.
 
 
 The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
 
 
 








Class com.amazonaws.services.dynamodbv2.model.PutRequest extends Object implements Serializable


Serialized Fields


item
Map<K,V> item

 A map of attribute name to attribute values, representing the primary key of an item to be processed by
 PutItem. All of the table's primary key attributes must be specified, and their data types must
 match those of the table's key schema. If any attributes are present in the item that are part of an index key
 schema for the table, their types must match the index key schema.
 








Class com.amazonaws.services.dynamodbv2.model.QueryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table containing the requested items.
 


indexName
String indexName

 The name of an index to query. This index can be any local secondary index or global secondary index on the
 table. Note that if you use the IndexName parameter, you must also provide TableName.
 


select
String select

 The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the
 count of matching items, or in the case of an index, some or all of the attributes projected into the index.
 
 
 
 
 ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query
 a local secondary index, then for each matching item in the index, DynamoDB fetches 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 or scan 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 fetches each of these attributes from the parent table. This extra fetching
 incurs additional throughput cost and latency.
 
 
 If you query or scan a global secondary index, you can only request attributes that are projected into the index.
 Global secondary index queries cannot fetch attributes from the parent table.
 
 
 
 
 If neither Select nor AttributesToGet are specified, DynamoDB defaults to
 ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an
 index. You cannot use both Select and AttributesToGet together in a single request,
 unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to
 specifying AttributesToGet without any value for Select.)
 
 
 
 If you use the ProjectionExpression parameter, then the value for Select can only be
 SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.
 
 


attributesToGet
List<E> attributesToGet

 This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet 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 dataset size exceeds 1 MB before DynamoDB reaches this
 limit, it stops the operation and returns the matching values up to the limit, and a key in
 LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information,
 see Query and
 Scan in the Amazon DynamoDB Developer Guide.
 


consistentRead
Boolean consistentRead

 Determines the read consistency model: If set to true, then the operation uses strongly consistent
 reads; otherwise, the operation uses eventually consistent reads.
 
 
 Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index
 with ConsistentRead set to true, you will receive a ValidationException.
 


keyConditions
Map<K,V> keyConditions

 This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.
 


queryFilter
Map<K,V> queryFilter

 This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.
 


conditionalOperator
String conditionalOperator

 This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
 


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 UTF-8 bytes.
 For type Binary, DynamoDB treats each byte of the binary data as unsigned.
 
 
 If ScanIndexForward is true, DynamoDB returns the results in the order in which they
 are stored (by sort key value). This is the default behavior. If ScanIndexForward is
 false, DynamoDB reads the results in reverse order by sort key value, and then returns the results
 to the client.
 


exclusiveStartKey
Map<K,V> exclusiveStartKey

 The primary key of the first item that this operation will evaluate. Use the value that was returned for
 LastEvaluatedKey in the previous operation.
 
 
 The data type for ExclusiveStartKey must be String, Number, or Binary. No set data types are
 allowed.
 


returnConsumedCapacity
String returnConsumedCapacity


projectionExpression
String projectionExpression

 A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars,
 sets, or elements of a JSON document. The attributes in the expression must be separated by commas.
 
 
 If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are
 not found, they will not appear in the result.
 
 
 For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
 


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 does not allow key attributes. You cannot define a filter expression based on a
 partition key or a sort key.
 
 
 
 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.
 


keyConditionExpression
String keyConditionExpression

 The condition that specifies the key values 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 optionally perform one of several comparison tests on a single sort key value. This allows
 Query 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.
 


expressionAttributeNames
Map<K,V> expressionAttributeNames

 One or more substitution tokens for attribute names in an expression. The following are some use cases for using
 ExpressionAttributeNames:
 
 
 
 
 To access an attribute whose name conflicts with a DynamoDB reserved word.
 
 
 
 
 To create a placeholder for repeating occurrences of an attribute name in an expression.
 
 
 
 
 To prevent special characters in an attribute name from being misinterpreted in an expression.
 
 
 
 
 Use the # character in an expression to dereference an attribute name. For example, consider the following
 attribute name:
 
 
 
 
 Percentile
 
 
 
 
 The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
 the complete list of reserved words, see Reserved Words in
 the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
 ExpressionAttributeNames:
 
 
 
 
 {"#P":"Percentile"}
 
 
 
 
 You could then use this substitution in an expression, as in this example:
 
 
 
 
 #P = :val
 
 
 
 
 
 Tokens that begin with the : character are expression attribute values, which are placeholders for
 the actual value at runtime.
 
 
 
 For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
 


expressionAttributeValues
Map<K,V> expressionAttributeValues

 One or more values that can be substituted in an expression.
 
 
 Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that
 you wanted to check whether the value of the ProductStatus attribute was one of the following:
 
 
 Available | Backordered | Discontinued
 
 
 You would first need to specify ExpressionAttributeValues as follows:
 
 
 { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
 
 
 You could then use these values in an expression, such as this:
 
 
 ProductStatus IN (:avail, :back, :disc)
 
 
 For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.QueryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


items
List<E> items

 An array of item attributes that match the query criteria. Each element in this array consists of an attribute
 name and the value for that attribute.
 


count
Integer count

 The number of items in the response.
 
 
 If you used a QueryFilter in the request, then Count is the number of items returned
 after the filter was applied, and ScannedCount is the number of matching items before the filter was
 applied.
 
 
 If you did not use a filter in the request, then Count and ScannedCount are the same.
 


scannedCount
Integer scannedCount

 The number of items evaluated, before any QueryFilter is applied. A high ScannedCount
 value with few, or no, Count results indicates an inefficient Query operation. For more
 information, see Count and
 ScannedCount in the Amazon DynamoDB Developer Guide.
 
 
 If you did not use a filter in the request, then ScannedCount is the same as Count.
 


lastEvaluatedKey
Map<K,V> lastEvaluatedKey

 The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to
 start a new operation, excluding this value in the new request.
 
 
 If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no
 more data to be retrieved.
 
 
 If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result
 set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey
 is empty.
 


consumedCapacity
ConsumedCapacity consumedCapacity

 The capacity units consumed by the Query operation. The data returned includes the total provisioned
 throughput consumed, along with statistics for the table and any indexes involved in the operation.
 ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was
 specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.Record extends Object implements Serializable


Serialized Fields


eventID
String eventID

 A globally unique identifier for the event that was recorded in this stream record.
 


eventName
String eventName

 The type of data modification that was performed on the DynamoDB table:
 
 
 
 
 INSERT - a new item was added to the table.
 
 
 
 
 MODIFY - one or more of an existing item's attributes were modified.
 
 
 
 
 REMOVE - the item was deleted from the table
 
 
 


eventVersion
String eventVersion

 The version number of the stream record format. This number is updated whenever the structure of
 Record is modified.
 
 
 Client applications must not assume that eventVersion will remain at a particular value, as this
 number is subject to change at any time. In general, eventVersion will only increase as the
 low-level DynamoDB Streams API evolves.
 


eventSource
String eventSource

 The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.
 


awsRegion
String awsRegion

 The region in which the GetRecords request was received.
 


dynamodb
StreamRecord dynamodb

 The main body of the stream record, containing all of the DynamoDB-specific fields.
 


userIdentity
Identity userIdentity

 Items that are deleted by the Time to Live process after expiration have the following fields:
 
 
 
 
 Records[].userIdentity.type
 
 
 "Service"
 
 
 
 
 Records[].userIdentity.principalId
 
 
 "dynamodb.amazonaws.com"
 
 
 








Class com.amazonaws.services.dynamodbv2.model.Replica extends Object implements Serializable


Serialized Fields


regionName
String regionName

 The Region where the replica needs to be created.
 








Class com.amazonaws.services.dynamodbv2.model.ReplicaAlreadyExistsException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.ReplicaAutoScalingDescription extends Object implements Serializable


Serialized Fields


regionName
String regionName

 The Region where the replica exists.
 


globalSecondaryIndexes
List<E> globalSecondaryIndexes

 Replica-specific global secondary index auto scaling settings.
 


replicaProvisionedReadCapacityAutoScalingSettings
AutoScalingSettingsDescription replicaProvisionedReadCapacityAutoScalingSettings


replicaProvisionedWriteCapacityAutoScalingSettings
AutoScalingSettingsDescription replicaProvisionedWriteCapacityAutoScalingSettings


replicaStatus
String replicaStatus

 The current state of the replica:
 
 
 
 
 CREATING - The replica is being created.
 
 
 
 
 UPDATING - The replica is being updated.
 
 
 
 
 DELETING - The replica is being deleted.
 
 
 
 
 ACTIVE - The replica is ready for use.
 
 
 








Class com.amazonaws.services.dynamodbv2.model.ReplicaAutoScalingUpdate extends Object implements Serializable


Serialized Fields


regionName
String regionName

 The Region where the replica exists.
 


replicaGlobalSecondaryIndexUpdates
List<E> replicaGlobalSecondaryIndexUpdates

 Represents the auto scaling settings of global secondary indexes that will be modified.
 


replicaProvisionedReadCapacityAutoScalingUpdate
AutoScalingSettingsUpdate replicaProvisionedReadCapacityAutoScalingUpdate








Class com.amazonaws.services.dynamodbv2.model.ReplicaDescription extends Object implements Serializable


Serialized Fields


regionName
String regionName

 The name of the Region.
 


replicaStatus
String replicaStatus

 The current state of the replica:
 
 
 
 
 CREATING - The replica is being created.
 
 
 
 
 UPDATING - The replica is being updated.
 
 
 
 
 DELETING - The replica is being deleted.
 
 
 
 
 ACTIVE - The replica is ready for use.
 
 
 


replicaStatusDescription
String replicaStatusDescription

 Detailed information about the replica status.
 


replicaStatusPercentProgress
String replicaStatusPercentProgress

 Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
 


kMSMasterKeyId
String kMSMasterKeyId

 The AWS KMS customer master key (CMK) of the replica that will be used for AWS KMS encryption.
 


provisionedThroughputOverride
ProvisionedThroughputOverride provisionedThroughputOverride

 Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput
 settings.
 


globalSecondaryIndexes
List<E> globalSecondaryIndexes

 Replica-specific global secondary index settings.
 








Class com.amazonaws.services.dynamodbv2.model.ReplicaGlobalSecondaryIndex extends Object implements Serializable


Serialized Fields


indexName
String indexName

 The name of the global secondary index.
 


provisionedThroughputOverride
ProvisionedThroughputOverride provisionedThroughputOverride

 Replica table GSI-specific provisioned throughput. If not specified, uses the source table GSI's read capacity
 settings.
 








Class com.amazonaws.services.dynamodbv2.model.ReplicaGlobalSecondaryIndexAutoScalingDescription extends Object implements Serializable


Serialized Fields


indexName
String indexName

 The name of the global secondary index.
 


indexStatus
String indexStatus

 The current state of the replica 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.
 
 
 


provisionedReadCapacityAutoScalingSettings
AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings


provisionedWriteCapacityAutoScalingSettings
AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings








Class com.amazonaws.services.dynamodbv2.model.ReplicaGlobalSecondaryIndexAutoScalingUpdate extends Object implements Serializable


Serialized Fields


indexName
String indexName

 The name of the global secondary index.
 


provisionedReadCapacityAutoScalingUpdate
AutoScalingSettingsUpdate provisionedReadCapacityAutoScalingUpdate








Class com.amazonaws.services.dynamodbv2.model.ReplicaGlobalSecondaryIndexDescription extends Object implements Serializable


Serialized Fields


indexName
String indexName

 The name of the global secondary index.
 


provisionedThroughputOverride
ProvisionedThroughputOverride provisionedThroughputOverride

 If not described, uses the source table GSI's read capacity settings.
 








Class com.amazonaws.services.dynamodbv2.model.ReplicaGlobalSecondaryIndexSettingsDescription 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.
 


indexStatus
String indexStatus

 The current status of the global secondary index:
 
 
 
 
 CREATING - The global secondary index is being created.
 
 
 
 
 UPDATING - The global secondary index is being updated.
 
 
 
 
 DELETING - The global secondary index is being deleted.
 
 
 
 
 ACTIVE - The global secondary index is ready for use.
 
 
 


provisionedReadCapacityUnits
Long provisionedReadCapacityUnits

 The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
 ThrottlingException.
 


provisionedReadCapacityAutoScalingSettings
AutoScalingSettingsDescription provisionedReadCapacityAutoScalingSettings

 Auto scaling settings for a global secondary index replica's read capacity units.
 


provisionedWriteCapacityUnits
Long provisionedWriteCapacityUnits

 The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
 


provisionedWriteCapacityAutoScalingSettings
AutoScalingSettingsDescription provisionedWriteCapacityAutoScalingSettings

 Auto scaling settings for a global secondary index replica's write capacity units.
 








Class com.amazonaws.services.dynamodbv2.model.ReplicaGlobalSecondaryIndexSettingsUpdate 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.
 


provisionedReadCapacityUnits
Long provisionedReadCapacityUnits

 The maximum number of strongly consistent reads consumed per second before DynamoDB returns a
 ThrottlingException.
 


provisionedReadCapacityAutoScalingSettingsUpdate
AutoScalingSettingsUpdate provisionedReadCapacityAutoScalingSettingsUpdate

 Auto scaling settings for managing a global secondary index replica's read capacity units.
 








Class com.amazonaws.services.dynamodbv2.model.ReplicaNotFoundException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.ReplicaSettingsDescription extends Object implements Serializable


Serialized Fields


regionName
String regionName

 The Region name of the replica.
 


replicaStatus
String replicaStatus

 The current state of the Region:
 
 
 
 
 CREATING - The Region is being created.
 
 
 
 
 UPDATING - The Region is being updated.
 
 
 
 
 DELETING - The Region is being deleted.
 
 
 
 
 ACTIVE - The Region is ready for use.
 
 
 


replicaBillingModeSummary
BillingModeSummary replicaBillingModeSummary

 The read/write capacity mode of the replica.
 


replicaProvisionedReadCapacityUnits
Long replicaProvisionedReadCapacityUnits

 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.
 


replicaProvisionedReadCapacityAutoScalingSettings
AutoScalingSettingsDescription replicaProvisionedReadCapacityAutoScalingSettings

 Auto scaling settings for a global table replica's read capacity units.
 


replicaProvisionedWriteCapacityUnits
Long replicaProvisionedWriteCapacityUnits

 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.
 


replicaProvisionedWriteCapacityAutoScalingSettings
AutoScalingSettingsDescription replicaProvisionedWriteCapacityAutoScalingSettings

 Auto scaling settings for a global table replica's write capacity units.
 


replicaGlobalSecondaryIndexSettings
List<E> replicaGlobalSecondaryIndexSettings

 Replica global secondary index settings for the global table.
 








Class com.amazonaws.services.dynamodbv2.model.ReplicaSettingsUpdate extends Object implements Serializable


Serialized Fields


regionName
String regionName

 The Region of the replica to be added.
 


replicaProvisionedReadCapacityUnits
Long replicaProvisionedReadCapacityUnits

 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.
 


replicaProvisionedReadCapacityAutoScalingSettingsUpdate
AutoScalingSettingsUpdate replicaProvisionedReadCapacityAutoScalingSettingsUpdate

 Auto scaling settings for managing a global table replica's read capacity units.
 


replicaGlobalSecondaryIndexSettingsUpdate
List<E> replicaGlobalSecondaryIndexSettingsUpdate

 Represents the settings of a global secondary index for a global table that will be modified.
 








Class com.amazonaws.services.dynamodbv2.model.ReplicationGroupUpdate extends Object implements Serializable


Serialized Fields


create
CreateReplicationGroupMemberAction create

 The parameters required for creating a replica for the table.
 


update
UpdateReplicationGroupMemberAction update

 The parameters required for updating a replica for the table.
 


delete
DeleteReplicationGroupMemberAction delete

 The parameters required for deleting a replica for the table.
 








Class com.amazonaws.services.dynamodbv2.model.ReplicaUpdate extends Object implements Serializable


Serialized Fields


create
CreateReplicaAction create

 The parameters required for creating a replica on an existing global table.
 


delete
DeleteReplicaAction delete

 The name of the existing replica to be removed.
 








Class com.amazonaws.services.dynamodbv2.model.RequestLimitExceededException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.ResourceInUseException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.ResourceNotFoundException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.RestoreSummary extends Object implements Serializable


Serialized Fields


sourceBackupArn
String sourceBackupArn

 The Amazon Resource Name (ARN) of the backup from which the table was restored.
 


sourceTableArn
String sourceTableArn

 The ARN of the source table of the backup that is being restored.
 


restoreDateTime
Date restoreDateTime

 Point in time or source backup time.
 


restoreInProgress
Boolean restoreInProgress

 Indicates if a restore is in progress or not.
 








Class com.amazonaws.services.dynamodbv2.model.RestoreTableFromBackupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetTableName
String targetTableName

 The name of the new table to which the backup must be restored.
 


backupArn
String backupArn

 The Amazon Resource Name (ARN) associated with the backup.
 


billingModeOverride
String billingModeOverride

 The billing mode of the restored table.
 


globalSecondaryIndexOverride
List<E> globalSecondaryIndexOverride

 List of global secondary indexes for the restored table. The indexes provided should match existing secondary
 indexes. You can choose to exclude some or all of the indexes at the time of restore.
 


localSecondaryIndexOverride
List<E> localSecondaryIndexOverride

 List of local secondary indexes for the restored table. The indexes provided should match existing secondary
 indexes. You can choose to exclude some or all of the indexes at the time of restore.
 


provisionedThroughputOverride
ProvisionedThroughput provisionedThroughputOverride

 Provisioned throughput settings for the restored table.
 








Class com.amazonaws.services.dynamodbv2.model.RestoreTableFromBackupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableDescription
TableDescription tableDescription

 The description of the table created from an existing backup.
 








Class com.amazonaws.services.dynamodbv2.model.RestoreTableToPointInTimeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceTableName
String sourceTableName

 Name of the source table that is being restored.
 


targetTableName
String targetTableName

 The name of the new table to which it must be restored to.
 


useLatestRestorableTime
Boolean useLatestRestorableTime

 Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes
 before the current time.
 


restoreDateTime
Date restoreDateTime

 Time in the past to restore the table to.
 


billingModeOverride
String billingModeOverride

 The billing mode of the restored table.
 


globalSecondaryIndexOverride
List<E> globalSecondaryIndexOverride

 List of global secondary indexes for the restored table. The indexes provided should match existing secondary
 indexes. You can choose to exclude some or all of the indexes at the time of restore.
 


localSecondaryIndexOverride
List<E> localSecondaryIndexOverride

 List of local secondary indexes for the restored table. The indexes provided should match existing secondary
 indexes. You can choose to exclude some or all of the indexes at the time of restore.
 


provisionedThroughputOverride
ProvisionedThroughput provisionedThroughputOverride

 Provisioned throughput settings for the restored table.
 








Class com.amazonaws.services.dynamodbv2.model.RestoreTableToPointInTimeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableDescription
TableDescription tableDescription

 Represents the properties of a table.
 








Class com.amazonaws.services.dynamodbv2.model.ScanRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table containing the requested items; or, if you provide IndexName, the name of the
 table to which that index belongs.
 


indexName
String indexName

 The name of a secondary index to scan. This index can be any local secondary index or global secondary index.
 Note that if you use the IndexName parameter, you must also provide TableName.
 


attributesToGet
List<E> attributesToGet

 This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet 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 dataset 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 Working with
 Queries in the Amazon DynamoDB Developer Guide.
 


select
String select

 The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, 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 fetches 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 or scan a local secondary index and request only attributes that are projected into that index, the
 operation reads only the index and not the table. If any of the requested attributes are not projected into the
 local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching
 incurs additional throughput cost and latency.
 
 
 If you query or scan 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.
 
 


scanFilter
Map<K,V> scanFilter

 This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.
 


conditionalOperator
String conditionalOperator

 This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
 


exclusiveStartKey
Map<K,V> exclusiveStartKey

 The primary key of the first item that this operation will evaluate. Use the value that was returned for
 LastEvaluatedKey in the previous operation.
 
 
 The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
 
 
 In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the
 same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
 


returnConsumedCapacity
String returnConsumedCapacity


totalSegments
Integer totalSegments

 For a parallel Scan request, TotalSegments represents the total number of segments into
 which the Scan operation will be divided. The value of TotalSegments corresponds to the
 number of application workers that will perform the parallel scan. For example, if you want to use four
 application threads to scan a table or an index, specify a TotalSegments value of 4.
 
 
 The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000.
 If you specify a TotalSegments value of 1, the Scan operation will be sequential rather
 than parallel.
 
 
 If you specify TotalSegments, you must also specify Segment.
 


segment
Integer segment

 For a parallel Scan request, Segment identifies an individual segment to be scanned by
 an application worker.
 
 
 Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application
 threads to scan a table or an index, then the first thread specifies a Segment value of 0, the
 second thread specifies 1, and so on.
 
 
 The value of LastEvaluatedKey returned from a parallel Scan request must be used as
 ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
 
 
 The value for Segment must be greater than or equal to 0, and less than the value provided for
 TotalSegments.
 
 
 If you provide Segment, you must also provide TotalSegments.
 


projectionExpression
String projectionExpression

 A string that identifies one or more attributes to retrieve from the specified table or index. These attributes
 can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by
 commas.
 
 
 If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are
 not found, they will not appear in the result.
 
 
 For more information, see Specifying Item Attributes 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.
 


expressionAttributeNames
Map<K,V> expressionAttributeNames

 One or more substitution tokens for attribute names in an expression. The following are some use cases for using
 ExpressionAttributeNames:
 
 
 
 
 To access an attribute whose name conflicts with a DynamoDB reserved word.
 
 
 
 
 To create a placeholder for repeating occurrences of an attribute name in an expression.
 
 
 
 
 To prevent special characters in an attribute name from being misinterpreted in an expression.
 
 
 
 
 Use the # character in an expression to dereference an attribute name. For example, consider the following
 attribute name:
 
 
 
 
 Percentile
 
 
 
 
 The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
 the complete list of reserved words, see Reserved Words in
 the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
 ExpressionAttributeNames:
 
 
 
 
 {"#P":"Percentile"}
 
 
 
 
 You could then use this substitution in an expression, as in this example:
 
 
 
 
 #P = :val
 
 
 
 
 
 Tokens that begin with the : character are expression attribute values, which are placeholders for
 the actual value at runtime.
 
 
 
 For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
 


expressionAttributeValues
Map<K,V> expressionAttributeValues

 One or more values that can be substituted in an expression.
 
 
 Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that
 you wanted to check whether the value of the ProductStatus attribute was one of the following:
 
 
 Available | Backordered | Discontinued
 
 
 You would first need to specify ExpressionAttributeValues as follows:
 
 
 { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
 
 
 You could then use these values in an expression, such as this:
 
 
 ProductStatus IN (:avail, :back, :disc)
 
 
 For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
 


consistentRead
Boolean consistentRead

 A Boolean value that determines the read consistency model during the scan:
 
 
 
 
 If ConsistentRead is false, then the data returned from Scan might not
 contain the results from other recently completed write operations (PutItem, UpdateItem
 , or DeleteItem).
 
 
 
 
 If ConsistentRead is true, then all of the write operations that completed before the
 Scan began are guaranteed to be contained in the Scan response.
 
 
 
 
 The default setting for ConsistentRead is false.
 
 
 The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global
 secondary index with ConsistentRead set to true, you will receive a ValidationException
 .
 








Class com.amazonaws.services.dynamodbv2.model.ScanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


items
List<E> items

 An array of item attributes that match the scan criteria. Each element in this array consists of an attribute
 name and the value for that attribute.
 


count
Integer count

 The number of items in the response.
 
 
 If you set ScanFilter in the request, then Count is the number of items returned after
 the filter was applied, and ScannedCount is the number of matching items before the filter was
 applied.
 
 
 If you did not use a filter in the request, then Count is the same as ScannedCount.
 


scannedCount
Integer scannedCount

 The number of items evaluated, before any ScanFilter is applied. A high ScannedCount
 value with few, or no, Count results indicates an inefficient Scan operation. For more
 information, see Count and
 ScannedCount in the Amazon DynamoDB Developer Guide.
 
 
 If you did not use a filter in the request, then ScannedCount is the same as Count.
 


lastEvaluatedKey
Map<K,V> lastEvaluatedKey

 The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to
 start a new operation, excluding this value in the new request.
 
 
 If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no
 more data to be retrieved.
 
 
 If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result
 set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey
 is empty.
 


consumedCapacity
ConsumedCapacity consumedCapacity

 The capacity units consumed by the Scan operation. The data returned includes the total provisioned
 throughput consumed, along with statistics for the table and any indexes involved in the operation.
 ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was
 specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.SequenceNumberRange extends Object implements Serializable


Serialized Fields


startingSequenceNumber
String startingSequenceNumber

 The first sequence number.
 


endingSequenceNumber
String endingSequenceNumber

 The last sequence number.
 








Class com.amazonaws.services.dynamodbv2.model.Shard extends Object implements Serializable


Serialized Fields


shardId
String shardId

 The system-generated identifier for this shard.
 


sequenceNumberRange
SequenceNumberRange sequenceNumberRange

 The range of possible sequence numbers for the shard.
 


parentShardId
String parentShardId

 The shard ID of the current shard's parent.
 








Class com.amazonaws.services.dynamodbv2.model.SourceTableDetails extends Object implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table for which the backup was created.
 


tableId
String tableId

 Unique identifier for the table for which the backup was created.
 


tableArn
String tableArn

 ARN of the table for which backup was created.
 


tableSizeBytes
Long tableSizeBytes

 Size of the table in bytes. Note that this is an approximate value.
 


keySchema
List<E> keySchema

 Schema of the table.
 


tableCreationDateTime
Date tableCreationDateTime

 Time when the source table was created.
 


provisionedThroughput
ProvisionedThroughput provisionedThroughput

 Read IOPs and Write IOPS on the table when the backup was created.
 


itemCount
Long itemCount

 Number of items in the table. Note that this is an approximate value.
 


billingMode
String billingMode

 Controls how you are charged for read and write throughput and how you manage capacity. This setting can be
 changed later.
 
 
 
 
 PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using
 PROVISIONED for predictable workloads.
 
 
 
 
 PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend
 using PAY_PER_REQUEST for unpredictable workloads.
 
 
 








Class com.amazonaws.services.dynamodbv2.model.SourceTableFeatureDetails extends Object implements Serializable


Serialized Fields


localSecondaryIndexes
List<E> localSecondaryIndexes

 Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and
 Projection for the LSIs on the table at the time of backup.
 


globalSecondaryIndexes
List<E> globalSecondaryIndexes

 Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema,
 Projection, and ProvisionedThroughput for the GSIs on the table at the time of backup.
 


streamDescription
StreamSpecification streamDescription

 Stream settings on the table when the backup was created.
 


timeToLiveDescription
TimeToLiveDescription timeToLiveDescription

 Time to Live settings on the table when the backup was created.
 


sSEDescription
SSEDescription sSEDescription

 The description of the server-side encryption status on the table when the backup was created.
 








Class com.amazonaws.services.dynamodbv2.model.SSEDescription extends Object implements Serializable


Serialized Fields


status
String status

 Represents the current state of server-side encryption. The only supported values are:
 
 
 
 
 ENABLED - Server-side encryption is enabled.
 
 
 
 
 UPDATING - Server-side encryption is being updated.
 
 
 


sSEType
String sSEType

 Server-side encryption type. The only supported value is:
 
 
 
 
 KMS - Server-side encryption that uses AWS Key Management Service. The key is stored in your account
 and is managed by AWS KMS (AWS KMS charges apply).
 
 
 


kMSMasterKeyArn
String kMSMasterKeyArn

 The AWS KMS customer master key (CMK) ARN used for the AWS KMS encryption.
 


inaccessibleEncryptionDateTime
Date inaccessibleEncryptionDateTime

 Indicates the time, in UNIX epoch date format, when DynamoDB detected that the table's AWS KMS key was
 inaccessible. This attribute will automatically be cleared when DynamoDB detects that the table's AWS KMS key is
 accessible again. DynamoDB will initiate the table archival process when table's AWS KMS key remains inaccessible
 for more than seven days from this date.
 








Class com.amazonaws.services.dynamodbv2.model.SSESpecification extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true),
 server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If
 disabled (false) or not specified, server-side encryption is set to AWS owned CMK.
 


sSEType
String sSEType

 Server-side encryption type. The only supported value is:
 
 
 
 
 KMS - Server-side encryption that uses AWS Key Management Service. The key is stored in your account
 and is managed by AWS KMS (AWS KMS charges apply).
 
 
 


kMSMasterKeyId
String kMSMasterKeyId

 The AWS KMS customer master key (CMK) that should be used for the AWS KMS encryption. To specify a CMK, use its
 key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if
 the key is different from the default DynamoDB customer master key alias/aws/dynamodb.
 








Class com.amazonaws.services.dynamodbv2.model.Stream extends Object implements Serializable


Serialized Fields


streamArn
String streamArn

 The Amazon Resource Name (ARN) for the stream.
 


tableName
String tableName

 The DynamoDB table with which the stream is associated.
 


streamLabel
String streamLabel

 A timestamp, in ISO 8601 format, for this stream.
 
 
 Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a
 stream from another table might have the same timestamp. However, the combination of the following three elements
 is guaranteed to be unique:
 
 
 
 
 the AWS customer ID.
 
 
 
 
 the table name
 
 
 
 
 the StreamLabel
 
 
 








Class com.amazonaws.services.dynamodbv2.model.StreamDescription extends Object implements Serializable


Serialized Fields


streamArn
String streamArn

 The Amazon Resource Name (ARN) for the stream.
 


streamLabel
String streamLabel

 A timestamp, in ISO 8601 format, for this stream.
 
 
 Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a
 stream from another table might have the same timestamp. However, the combination of the following three elements
 is guaranteed to be unique:
 
 
 
 
 the AWS customer ID.
 
 
 
 
 the table name
 
 
 
 
 the StreamLabel
 
 
 


streamStatus
String streamStatus

 Indicates the current status of the stream:
 
 
 
 
 ENABLING - Streams is currently being enabled on the DynamoDB table.
 
 
 
 
 ENABLED - 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 items from the table, as they appeared after they were modified.
 
 
 
 
 OLD_IMAGE - entire items from the table, as they appeared before they were modified.
 
 
 
 
 NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.
 
 
 


creationRequestDateTime
Date creationRequestDateTime

 The date and time when the request to create this stream was issued.
 


tableName
String tableName

 The DynamoDB table with which the stream is associated.
 


keySchema
List<E> keySchema

 The key attribute(s) of the stream's DynamoDB table.
 


shards
List<E> shards

 The shards that comprise the stream.
 


lastEvaluatedShardId
String lastEvaluatedShardId

 The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to
 start a new operation, excluding this value in the new request.
 
 
 If LastEvaluatedShardId is empty, then the "last page" of results has been processed and there is
 currently no more data to be retrieved.
 
 
 If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the
 result set. The only way to know when you have reached the end of the result set is when
 LastEvaluatedShardId is empty.
 








Class com.amazonaws.services.dynamodbv2.model.StreamRecord extends Object implements Serializable


Serialized Fields


approximateCreationDateTime
Date approximateCreationDateTime

 The approximate date and time when the stream record was created, in UNIX epoch time format.
 


keys
Map<K,V> keys

 The primary key attribute(s) for the DynamoDB item that was modified.
 


newImage
Map<K,V> newImage

 The item in the DynamoDB table as it appeared after it was modified.
 


oldImage
Map<K,V> oldImage

 The item in the DynamoDB table as it appeared before it was modified.
 


sequenceNumber
String sequenceNumber

 The sequence number of the stream record.
 


sizeBytes
Long sizeBytes

 The size of the stream record, in bytes.
 


streamViewType
String streamViewType

 The type of data from the modified DynamoDB item that was captured in this stream record:
 
 
 
 
 KEYS_ONLY - only the key attributes of the modified item.
 
 
 
 
 NEW_IMAGE - the entire item, as it appeared after it was modified.
 
 
 
 
 OLD_IMAGE - the entire item, as it appeared before it was modified.
 
 
 
 
 NEW_AND_OLD_IMAGES - both the new and the old item images of the item.
 
 
 








Class com.amazonaws.services.dynamodbv2.model.StreamSpecification extends Object implements Serializable


Serialized Fields


streamEnabled
Boolean streamEnabled

 Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
 


streamViewType
String streamViewType

 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.TableAlreadyExistsException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.TableAutoScalingDescription extends Object implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table.
 


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.
 
 
 


replicas
List<E> replicas

 Represents replicas of the global table.
 








Class com.amazonaws.services.dynamodbv2.model.TableDescription extends Object implements Serializable


Serialized Fields


attributeDefinitions
List<E> attributeDefinitions

 An array of AttributeDefinition objects. Each of these objects describes one attribute in the table
 and index key schema.
 
 
 Each AttributeDefinition object in this array is composed of:
 
 
 
 
 AttributeName - The name of the attribute.
 
 
 
 
 AttributeType - The data type for the attribute.
 
 
 


tableName
String tableName

 The name of the table.
 


keySchema
List<E> keySchema

 The primary key structure for the table. Each KeySchemaElement consists of:
 
 
 
 
 AttributeName - The name of the attribute.
 
 
 
 
 KeyType - The role of the attribute:
 
 
 
 
 HASH - partition key
 
 
 
 
 RANGE - sort key
 
 
 
 
 
 The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from
 DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their
 partition key values.
 
 
 The sort key of an item is also known as its range attribute. The term "range attribute" derives from the
 way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key
 value.
 
 
 
 
 For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
 


tableStatus
String tableStatus

 The current state of the table:
 
 
 
 
 CREATING - The table is being created.
 
 
 
 
 UPDATING - The table is being updated.
 
 
 
 
 DELETING - The table is being deleted.
 
 
 
 
 ACTIVE - The table is ready for use.
 
 
 
 
 INACCESSIBLE_ENCRYPTION_CREDENTIALS - The AWS KMS key used to encrypt the table in inaccessible.
 Table operations may fail due to failure to use the AWS KMS key. DynamoDB will initiate the table archival
 process when a table's AWS KMS key remains inaccessible for more than seven days.
 
 
 
 
 ARCHIVING - The table is being archived. Operations are not allowed until archival is complete.
 
 
 
 
 ARCHIVED - The table has been archived. See the ArchivalReason for more information.
 
 
 


creationDateTime
Date creationDateTime

 The date and time when the table was created, in UNIX epoch time
 format.
 


provisionedThroughput
ProvisionedThroughputDescription provisionedThroughput

 The provisioned throughput settings for the table, consisting of read and write capacity units, along with data
 about increases and decreases.
 


tableSizeBytes
Long tableSizeBytes

 The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours.
 Recent changes might not be reflected in this value.
 


itemCount
Long itemCount

 The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent
 changes might not be reflected in this value.
 


tableArn
String tableArn

 The Amazon Resource Name (ARN) that uniquely identifies the table.
 


tableId
String tableId

 Unique identifier for the table for which the backup was created.
 


billingModeSummary
BillingModeSummary billingModeSummary

 Contains the details for the read/write capacity mode.
 


localSecondaryIndexes
List<E> localSecondaryIndexes

 Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value.
 Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of
 data within a given item collection cannot exceed 10 GB. Each element is composed of:
 
 
 
 
 IndexName - The name of the local secondary index.
 
 
 
 
 KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be
 between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.
 
 
 
 
 Projection - Specifies attributes that are copied (projected) from the table into the index. These
 are in addition to the primary key attributes and index key attributes, which are automatically projected. Each
 attribute specification is composed of:
 
 
 
 
 ProjectionType - One of the following:
 
 
 
 
 KEYS_ONLY - Only the index and primary keys are projected into the index.
 
 
 
 
 INCLUDE - Only the specified table attributes are projected into the index. The list of projected
 attributes is in NonKeyAttributes.
 
 
 
 
 ALL - All of the table attributes are projected into the index.
 
 
 
 
 
 
 NonKeyAttributes - A list of one or more non-key attribute names that are projected into the
 secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of
 the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this
 counts as two distinct attributes when determining the total.
 
 
 
 
 
 
 IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value
 approximately every six hours. Recent changes might not be reflected in this value.
 
 
 
 
 ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately
 every six hours. Recent changes might not be reflected in this value.
 
 
 
 
 If the table is in the DELETING state, no information about indexes will be returned.
 


globalSecondaryIndexes
List<E> globalSecondaryIndexes

 The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each
 element is composed of:
 
 
 
 
 Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only
 when a new global secondary index is added to the table. It is the process by which DynamoDB populates the new
 index with data from the table. (This attribute does not appear for indexes that were created during a
 CreateTable operation.)
 
 
 You can delete an index that is being created during the Backfilling phase when
 IndexStatus is set to CREATING and Backfilling is true. You can't delete the index that
 is being created when IndexStatus is set to CREATING and Backfilling is false. (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 is in NonKeyAttributes.
 
 
 
 
 ALL - All of the table attributes are projected into the index.
 
 
 
 
 
 
 NonKeyAttributes - A list of one or more non-key attribute names that are projected into the
 secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of
 the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this
 counts as two distinct attributes when determining the total.
 
 
 
 
 
 
 ProvisionedThroughput - The provisioned throughput settings for the global secondary index,
 consisting of read and write capacity units, along with data about increases and decreases.
 
 
 
 
 If the table is in the DELETING state, no information about indexes will be returned.
 


streamSpecification
StreamSpecification streamSpecification

 The current DynamoDB Streams configuration for the table.
 


latestStreamLabel
String latestStreamLabel

 A timestamp, in ISO 8601 format, for this stream.
 
 
 Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a
 stream from another table might have the same timestamp. However, the combination of the following three elements
 is guaranteed to be unique:
 
 
 
 
 AWS customer ID
 
 
 
 
 Table name
 
 
 
 
 StreamLabel
 
 
 


latestStreamArn
String latestStreamArn

 The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
 


globalTableVersion
String globalTableVersion

 Represents the version of global tables in
 use, if the table is replicated across AWS Regions.
 


replicas
List<E> replicas

 Represents replicas of the table.
 


restoreSummary
RestoreSummary restoreSummary

 Contains details for the restore.
 


sSEDescription
SSEDescription sSEDescription

 The description of the server-side encryption status on the specified table.
 


archivalSummary
ArchivalSummary archivalSummary

 Contains information about the table archive.
 








Class com.amazonaws.services.dynamodbv2.model.TableInUseException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.TableNotFoundException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same
 key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.
 


value
String value

 The value of the tag. Tag values are case-sensitive and can be null.
 








Class com.amazonaws.services.dynamodbv2.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name
 (ARN).
 


tags
List<E> tags

 The tags to be assigned to the Amazon DynamoDB resource.
 








Class com.amazonaws.services.dynamodbv2.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.dynamodbv2.model.TimeToLiveDescription extends Object implements Serializable


Serialized Fields


timeToLiveStatus
String timeToLiveStatus

 The TTL status for the table.
 


attributeName
String attributeName

 The name of the TTL attribute for items in the table.
 








Class com.amazonaws.services.dynamodbv2.model.TimeToLiveSpecification extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
 


attributeName
String attributeName

 The name of the TTL attribute used to store the expiration time for items in the table.
 








Class com.amazonaws.services.dynamodbv2.model.TransactGetItem extends Object implements Serializable


Serialized Fields


get
Get get

 Contains the primary key that identifies the item to get, together with the name of the table that contains the
 item, and optionally the specific attributes of the item to retrieve.
 








Class com.amazonaws.services.dynamodbv2.model.TransactGetItemsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transactItems
List<E> transactItems

 An ordered array of up to 25 TransactGetItem objects, each of which contains a Get
 structure.
 


returnConsumedCapacity
String returnConsumedCapacity

 A value of TOTAL causes consumed capacity information to be returned, and a value of
 NONE prevents that information from being returned. No other value is valid.
 








Class com.amazonaws.services.dynamodbv2.model.TransactGetItemsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


consumedCapacity
List<E> consumedCapacity

 If the ReturnConsumedCapacity value was TOTAL, this is an array of
 ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in
 the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units
 consumed by the TransactGetItems call in that table.
 


responses
List<E> responses

 An ordered array of up to 25 ItemResponse objects, each of which corresponds to the
 TransactGetItem object in the same position in the TransactItems array. Each
 ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the
 requested item.
 
 
 If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the
 requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.
 








Class com.amazonaws.services.dynamodbv2.model.TransactionCanceledException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L



Serialized Fields


cancellationReasons
List<E> cancellationReasons

 A list of cancellation reasons.
 








Class com.amazonaws.services.dynamodbv2.model.TransactionConflictException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.TransactionInProgressException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.TransactWriteItem extends Object implements Serializable


Serialized Fields


conditionCheck
ConditionCheck conditionCheck

 A request to perform a check item operation.
 


put
Put put

 A request to perform a PutItem operation.
 


delete
Delete delete

 A request to perform a DeleteItem operation.
 


update
Update update

 A request to perform an UpdateItem operation.
 








Class com.amazonaws.services.dynamodbv2.model.TransactWriteItemsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transactItems
List<E> transactItems

 An ordered array of up to 25 TransactWriteItem objects, each of which contains a
 ConditionCheck, Put, Update, or Delete object. These can
 operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two
 of them can operate on the same item.
 


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 and are returned in the
 response. If set to NONE (the default), no statistics are returned.
 


clientRequestToken
String clientRequestToken

 Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning
 that multiple identical calls have the same effect as one single call.
 
 
 Although multiple identical calls using the same client request token produce the same result on the server (no
 side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity>
 parameter is set, then the initial TransactWriteItems call returns the amount of write capacity
 units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token
 return the number of read capacity units consumed in reading the item.
 
 
 A client request token is valid for 10 minutes after the first request that uses it is completed. After 10
 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request
 with the same client token for more than 10 minutes, or the result might not be idempotent.
 
 
 If you submit a request with the same client token but a change in other parameters within the 10-minute
 idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.
 








Class com.amazonaws.services.dynamodbv2.model.TransactWriteItemsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


consumedCapacity
List<E> consumedCapacity

 The capacity units consumed by the entire TransactWriteItems operation. The values of the list are
 ordered according to the ordering of the TransactItems request parameter.
 


itemCollectionMetrics
Map<K,V> itemCollectionMetrics

 A list of tables that were processed by TransactWriteItems and, for each table, information about
 any item collections that were affected by individual UpdateItem, PutItem, or
 DeleteItem operations.
 








Class com.amazonaws.services.dynamodbv2.model.TrimmedDataAccessException extends AmazonDynamoDBException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.dynamodbv2.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The DynamoDB resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).
 


tagKeys
List<E> tagKeys

 A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the
 DynamoDB resource.
 








Class com.amazonaws.services.dynamodbv2.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.dynamodbv2.model.Update extends Object implements Serializable


Serialized Fields


key
Map<K,V> key

 The primary key of the item to be updated. Each element consists of an attribute name and a value for that
 attribute.
 


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.
 


tableName
String tableName

 Name of the table for the UpdateItem request.
 


conditionExpression
String conditionExpression

 A condition that must be satisfied in order for a conditional update to succeed.
 


expressionAttributeNames
Map<K,V> expressionAttributeNames

 One or more substitution tokens for attribute names in an expression.
 


expressionAttributeValues
Map<K,V> expressionAttributeValues

 One or more values that can be substituted in an expression.
 


returnValuesOnConditionCheckFailure
String returnValuesOnConditionCheckFailure

 Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update
 condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE, ALL_OLD,
 UPDATED_OLD, ALL_NEW, UPDATED_NEW.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateContinuousBackupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table.
 


pointInTimeRecoverySpecification
PointInTimeRecoverySpecification pointInTimeRecoverySpecification

 Represents the settings used to enable point in time recovery.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateContinuousBackupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


continuousBackupsDescription
ContinuousBackupsDescription continuousBackupsDescription

 Represents the continuous backups and point in time recovery settings on the table.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateContributorInsightsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table.
 


indexName
String indexName

 The global secondary index name, if applicable.
 


contributorInsightsAction
String contributorInsightsAction

 Represents the contributor insights action.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateContributorInsightsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table.
 


indexName
String indexName

 The name of the global secondary index, if applicable.
 


contributorInsightsStatus
String contributorInsightsStatus

 The status of contributor insights
 








Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalSecondaryIndexAction extends Object implements Serializable


Serialized Fields


indexName
String indexName

 The name of the global secondary index to be updated.
 


provisionedThroughput
ProvisionedThroughput provisionedThroughput

 Represents the provisioned throughput settings for the specified global secondary index.
 
 
 For current minimum and maximum provisioned throughput values, see Limits in the Amazon
 DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalTableName
String globalTableName

 The global table name.
 


replicaUpdates
List<E> replicaUpdates

 A list of Regions that should be added or removed from the global table.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


globalTableDescription
GlobalTableDescription globalTableDescription

 Contains the details of the global table.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalTableSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalTableName
String globalTableName

 The name of the global table
 


globalTableBillingMode
String globalTableBillingMode

 The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table
 defaults to PROVISIONED capacity billing mode.
 
 
 
 
 PROVISIONED - We recommend using PROVISIONED for predictable workloads.
 PROVISIONED sets the billing mode to Provisioned Mode.
 
 
 
 
 PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads.
 PAY_PER_REQUEST sets the billing mode to On-Demand Mode.
 
 
 


globalTableProvisionedWriteCapacityUnits
Long globalTableProvisionedWriteCapacityUnits

 The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
 


globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate
AutoScalingSettingsUpdate globalTableProvisionedWriteCapacityAutoScalingSettingsUpdate

 Auto scaling settings for managing provisioned write capacity for the global table.
 


globalTableGlobalSecondaryIndexSettingsUpdate
List<E> globalTableGlobalSecondaryIndexSettingsUpdate

 Represents the settings of a global secondary index for a global table that will be modified.
 


replicaSettingsUpdate
List<E> replicaSettingsUpdate

 Represents the settings for a global table in a Region that will be modified.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalTableSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


globalTableName
String globalTableName

 The name of the global table.
 


replicaSettings
List<E> replicaSettings

 The Region-specific settings for the global table.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateItemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table containing the item to update.
 


key
Map<K,V> key

 The primary key of the item to be updated. Each element consists of an attribute name and a value for that
 attribute.
 
 
 For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only
 need to provide a value for the partition key. For a composite primary key, you must provide values for both the
 partition key and the sort key.
 


attributeUpdates
Map<K,V> attributeUpdates

 This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
 


expected
Map<K,V> expected

 This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
 


conditionalOperator
String conditionalOperator

 This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
 


returnValues
String returnValues

 Use ReturnValues if you want to get the item attributes as they appear before or after they are
 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 - Returns all of the attributes of the item, as they appeared before the UpdateItem
 operation.
 
 
 
 
 UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
 
 
 
 
 ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
 
 
 
 
 UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
 
 
 
 
 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.
 
 
 The values returned are strongly consistent.
 


returnConsumedCapacity
String returnConsumedCapacity


returnItemCollectionMetrics
String returnItemCollectionMetrics

 Determines whether item collection metrics are returned. If set to SIZE, the response includes
 statistics about item collections, if any, that were modified during the operation are returned in the response.
 If set to NONE (the default), no statistics are returned.
 


updateExpression
String updateExpression

 An expression that defines one or more attributes to be updated, the action to be performed on them, and new
 values 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 attributes 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.
 


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 about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
 


expressionAttributeNames
Map<K,V> expressionAttributeNames

 One or more substitution tokens for attribute names in an expression. The following are some use cases for using
 ExpressionAttributeNames:
 
 
 
 
 To access an attribute whose name conflicts with a DynamoDB reserved word.
 
 
 
 
 To create a placeholder for repeating occurrences of an attribute name in an expression.
 
 
 
 
 To prevent special characters in an attribute name from being misinterpreted in an expression.
 
 
 
 
 Use the # character in an expression to dereference an attribute name. For example, consider the following
 attribute name:
 
 
 
 
 Percentile
 
 
 
 
 The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For
 the complete list of reserved words, see Reserved Words in
 the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for
 ExpressionAttributeNames:
 
 
 
 
 {"#P":"Percentile"}
 
 
 
 
 You could then use this substitution in an expression, as in this example:
 
 
 
 
 #P = :val
 
 
 
 
 
 Tokens that begin with the : character are expression attribute values, which are placeholders for
 the actual value at runtime.
 
 
 
 For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
 


expressionAttributeValues
Map<K,V> expressionAttributeValues

 One or more values that can be substituted in an expression.
 
 
 Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that
 you wanted to check whether the value of the ProductStatus attribute was one of the following:
 
 
 Available | Backordered | Discontinued
 
 
 You would first need to specify ExpressionAttributeValues as follows:
 
 
 { ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
 
 
 You could then use these values in an expression, such as this:
 
 
 ProductStatus IN (:avail, :back, :disc)
 
 
 For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateItemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
Map<K,V> attributes

 A map of attribute values as they appear before or after the UpdateItem operation, as determined by
 the ReturnValues parameter.
 
 
 The Attributes map is only present if ReturnValues was specified as something other
 than NONE in the request. Each element represents one attribute.
 


consumedCapacity
ConsumedCapacity consumedCapacity

 The capacity units consumed by the UpdateItem operation. The data returned includes the total
 provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation.
 ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was
 specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.
 


itemCollectionMetrics
ItemCollectionMetrics itemCollectionMetrics

 Information about item collections, if any, that were affected by the UpdateItem operation.
 ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was
 specified. 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.
 
 
 
 
 SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element
 array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the
 items in the table, plus the size of all attributes projected into all of the local secondary indexes on that
 table. Use this estimate to measure whether a local secondary index is approaching its size limit.
 
 
 The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
 
 
 








Class com.amazonaws.services.dynamodbv2.model.UpdateReplicationGroupMemberAction extends Object implements Serializable


Serialized Fields


regionName
String regionName

 The Region where the replica exists.
 


kMSMasterKeyId
String kMSMasterKeyId

 The AWS KMS customer master key (CMK) of the replica that should be used for AWS KMS encryption. To specify a
 CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this
 parameter if the key is different from the default DynamoDB KMS master key alias/aws/dynamodb.
 


provisionedThroughputOverride
ProvisionedThroughputOverride provisionedThroughputOverride

 Replica-specific provisioned throughput. If not specified, uses the source table's provisioned throughput
 settings.
 


globalSecondaryIndexes
List<E> globalSecondaryIndexes

 Replica-specific global secondary index settings.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateTableReplicaAutoScalingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalSecondaryIndexUpdates
List<E> globalSecondaryIndexUpdates

 Represents the auto scaling settings of the global secondary indexes of the replica to be updated.
 


tableName
String tableName

 The name of the global table to be updated.
 


provisionedWriteCapacityAutoScalingUpdate
AutoScalingSettingsUpdate provisionedWriteCapacityAutoScalingUpdate


replicaUpdates
List<E> replicaUpdates

 Represents the auto scaling settings of replicas of the table that will be modified.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateTableReplicaAutoScalingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableAutoScalingDescription
TableAutoScalingDescription tableAutoScalingDescription

 Returns information about the auto scaling settings of a table with replicas.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


attributeDefinitions
List<E> attributeDefinitions

 An array of attributes that describe the key schema for the table and indexes. If you are adding a new global
 secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.
 


tableName
String tableName

 The name of the table to be updated.
 


billingMode
String billingMode

 Controls how you are charged for read and write throughput and how you manage capacity. When switching from
 pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned
 capacity values are estimated based on the consumed read and write capacity of your table and global secondary
 indexes over the past 30 minutes.
 
 
 
 
 PROVISIONED - We recommend using PROVISIONED for predictable workloads.
 PROVISIONED sets the billing mode to Provisioned Mode.
 
 
 
 
 PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads.
 PAY_PER_REQUEST sets the billing mode to On-Demand Mode.
 
 
 


provisionedThroughput
ProvisionedThroughput provisionedThroughput

 The new provisioned throughput settings for the specified table or index.
 


globalSecondaryIndexUpdates
List<E> globalSecondaryIndexUpdates

 An array of one or more global secondary indexes for the table. For each index in the array, you can request one
 action:
 
 
 
 
 Create - add a new global secondary index to the table.
 
 
 
 
 Update - modify the provisioned throughput settings of an existing global secondary index.
 
 
 
 
 Delete - remove a global secondary index from the table.
 
 
 
 
 You can create or delete only one global secondary index per UpdateTable operation.
 
 
 For more information, see Managing Global
 Secondary Indexes in the Amazon DynamoDB Developer Guide.
 


streamSpecification
StreamSpecification streamSpecification

 Represents the DynamoDB Streams configuration for the table.
 
 
 
 You receive a ResourceInUseException if you try to enable a stream on a table that already has a
 stream, or if you try to disable a stream on a table that doesn't have a stream.
 
 


sSESpecification
SSESpecification sSESpecification

 The new server-side encryption settings for the specified table.
 


replicaUpdates
List<E> replicaUpdates

 A list of replica update actions (create, delete, or update) for the table.
 
 
 
 This property only applies to Version
 2019.11.21 of global tables.
 
 








Class com.amazonaws.services.dynamodbv2.model.UpdateTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableDescription
TableDescription tableDescription

 Represents the properties of the table.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateTimeToLiveRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table to be configured.
 


timeToLiveSpecification
TimeToLiveSpecification timeToLiveSpecification

 Represents the settings used to enable or disable Time to Live for the specified table.
 








Class com.amazonaws.services.dynamodbv2.model.UpdateTimeToLiveResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


timeToLiveSpecification
TimeToLiveSpecification timeToLiveSpecification

 Represents the output of an UpdateTimeToLive operation.
 








Class com.amazonaws.services.dynamodbv2.model.WriteRequest extends Object implements Serializable


Serialized Fields


putRequest
PutRequest putRequest

 A request to perform a PutItem operation.
 


deleteRequest
DeleteRequest deleteRequest

 A request to perform a DeleteItem operation.
 








Package com.amazonaws.services.dynamodbv2.util




Class com.amazonaws.services.dynamodbv2.util.TableUtils.TableNeverTransitionedToStateException extends SdkClientException implements Serializable

serialVersionUID:
8920567021104846647L





Package com.amazonaws.services.ebs.model




Class com.amazonaws.services.ebs.model.AmazonEBSException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ebs.model.Block extends Object implements Serializable


Serialized Fields


blockIndex
Integer blockIndex

 The block index.
 


blockToken
String blockToken

 The block token for the block index.
 








Class com.amazonaws.services.ebs.model.ChangedBlock extends Object implements Serializable


Serialized Fields


blockIndex
Integer blockIndex

 The block index.
 


firstBlockToken
String firstBlockToken

 The block token for the block index of the first snapshot ID specified in the
 list changed blocks operation. This value is absent if the first snapshot does not have the changed
 block that is on the second snapshot.
 


secondBlockToken
String secondBlockToken

 The block token for the block index of the second snapshot ID specified in the
 list changed blocks operation.
 








Class com.amazonaws.services.ebs.model.GetSnapshotBlockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


snapshotId
String snapshotId

 The ID of the snapshot containing the block from which to get data.
 


blockIndex
Integer blockIndex

 The block index of the block from which to get data.
 
 
 Obtain the block index by running the list changed blocks or
 list snapshot blocks operations.
 


blockToken
String blockToken

 The block token of the block from which to get data.
 
 
 Obtain the block token by running the list changed blocks or
 list snapshot blocks operations.
 








Class com.amazonaws.services.ebs.model.GetSnapshotBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataLength
Integer dataLength

 The size of the data in the block.
 


blockData
InputStream blockData

 The data content of the block.
 


checksum
String checksum

 The checksum generated for the block.
 


checksumAlgorithm
String checksumAlgorithm

 The algorithm used to generate the checksum for the block, such as SHA256.
 








Class com.amazonaws.services.ebs.model.ListChangedBlocksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


firstSnapshotId
String firstSnapshotId

 The ID of the first snapshot to use for the comparison.
 


secondSnapshotId
String secondSnapshotId

 The ID of the second snapshot to use for the comparison.
 


nextToken
String nextToken

 The token to request the next page of results.
 


maxResults
Integer maxResults

 The number of results to return.
 


startingBlockIndex
Integer startingBlockIndex

 The block index from which the comparison should start.
 
 
 The list in the response will start from this block index or the next valid block index in the snapshots.
 








Class com.amazonaws.services.ebs.model.ListChangedBlocksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


changedBlocks
List<E> changedBlocks

 An array of objects containing information about the changed blocks.
 


expiryTime
Date expiryTime

 The time when the block token expires.
 


volumeSize
Long volumeSize

 The size of the volume in GB.
 


blockSize
Integer blockSize

 The size of the block.
 


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.ebs.model.ListSnapshotBlocksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


snapshotId
String snapshotId

 The ID of the snapshot from which to get block indexes and block tokens.
 


nextToken
String nextToken

 The token to request the next page of results.
 


maxResults
Integer maxResults

 The number of results to return.
 


startingBlockIndex
Integer startingBlockIndex

 The block index from which the list should start. The list in the response will start from this block index or
 the next valid block index in the snapshot.
 








Class com.amazonaws.services.ebs.model.ListSnapshotBlocksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


blocks
List<E> blocks

 An array of objects containing information about the blocks.
 


expiryTime
Date expiryTime

 The time when the block token expires.
 


volumeSize
Long volumeSize

 The size of the volume in GB.
 


blockSize
Integer blockSize

 The size of the block.
 


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.ebs.model.ResourceNotFoundException extends AmazonEBSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ebs.model.ValidationException extends AmazonEBSException implements Serializable

serialVersionUID:
1L



Serialized Fields


reason
String reason

 The reason for the validation exception.
 








Package com.amazonaws.services.ec2.model




Class com.amazonaws.services.ec2.model.AcceptReservedInstancesExchangeQuoteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reservedInstanceIds
SdkInternalList<T> reservedInstanceIds

 The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same
 or higher value.
 


targetConfigurations
SdkInternalList<T> targetConfigurations

 The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved
 Instances.
 








Class com.amazonaws.services.ec2.model.AcceptReservedInstancesExchangeQuoteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


exchangeId
String exchangeId

 The ID of the successful exchange.
 








Class com.amazonaws.services.ec2.model.AcceptTransitGatewayPeeringAttachmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the transit gateway attachment.
 








Class com.amazonaws.services.ec2.model.AcceptTransitGatewayPeeringAttachmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayPeeringAttachment
TransitGatewayPeeringAttachment transitGatewayPeeringAttachment

 The transit gateway peering attachment.
 








Class com.amazonaws.services.ec2.model.AcceptTransitGatewayVpcAttachmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 








Class com.amazonaws.services.ec2.model.AcceptTransitGatewayVpcAttachmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayVpcAttachment
TransitGatewayVpcAttachment transitGatewayVpcAttachment

 The VPC attachment.
 








Class com.amazonaws.services.ec2.model.AcceptVpcEndpointConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceId
String serviceId

 The ID of the VPC endpoint service.
 


vpcEndpointIds
SdkInternalList<T> vpcEndpointIds

 The IDs of one or more interface VPC endpoints.
 








Class com.amazonaws.services.ec2.model.AcceptVpcEndpointConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unsuccessful
SdkInternalList<T> unsuccessful

 Information about the interface endpoints that were not accepted, if applicable.
 








Class com.amazonaws.services.ec2.model.AcceptVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcPeeringConnectionId
String vpcPeeringConnectionId

 The ID of the VPC peering connection. You must specify this parameter in the request.
 








Class com.amazonaws.services.ec2.model.AcceptVpcPeeringConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcPeeringConnection
VpcPeeringConnection vpcPeeringConnection

 Information about the VPC peering connection.
 








Class com.amazonaws.services.ec2.model.AccountAttribute extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 The name of the account attribute.
 


attributeValues
SdkInternalList<T> attributeValues

 The values for the account attribute.
 








Class com.amazonaws.services.ec2.model.AccountAttributeValue extends Object implements Serializable


Serialized Fields


attributeValue
String attributeValue

 The value of the attribute.
 








Class com.amazonaws.services.ec2.model.ActiveInstance extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 


instanceType
String instanceType

 The instance type.
 


spotInstanceRequestId
String spotInstanceRequestId

 The ID of the Spot Instance request.
 


instanceHealth
String instanceHealth

 The health status of the instance. If the status of either the instance status check or the system status check
 is impaired, the health status of the instance is unhealthy. Otherwise, the health
 status is healthy.
 








Class com.amazonaws.services.ec2.model.Address extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance that the address is associated with (if any).
 


publicIp
String publicIp

 The Elastic IP address.
 


allocationId
String allocationId

 The ID representing the allocation of the address for use with EC2-VPC.
 


associationId
String associationId

 The ID representing the association of the address with an instance in a VPC.
 


domain
String domain

 Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or
 instances in a VPC (vpc).
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


networkInterfaceOwnerId
String networkInterfaceOwnerId

 The ID of the AWS account that owns the network interface.
 


privateIpAddress
String privateIpAddress

 The private IP address associated with the Elastic IP address.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the Elastic IP address.
 


publicIpv4Pool
String publicIpv4Pool

 The ID of an address pool.
 


networkBorderGroup
String networkBorderGroup

 The name of the location from which the IP address is advertised.
 


customerOwnedIp
String customerOwnedIp

 The customer-owned IP address.
 


customerOwnedIpv4Pool
String customerOwnedIpv4Pool

 The ID of the customer-owned address pool.
 








Class com.amazonaws.services.ec2.model.AdvertiseByoipCidrRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cidr
String cidr

 The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only
 a portion of the provisioned range.
 








Class com.amazonaws.services.ec2.model.AdvertiseByoipCidrResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


byoipCidr
ByoipCidr byoipCidr

 Information about the address range.
 








Class com.amazonaws.services.ec2.model.AllocateAddressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domain
String domain

 Set to vpc to allocate the address for use with instances in a VPC.
 
 
 Default: The address is for use with instances in EC2-Classic.
 


address
String address

 [EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.
 


publicIpv4Pool
String publicIpv4Pool

 The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address
 pool. To specify a specific address from the address pool, use the Address parameter instead.
 


networkBorderGroup
String networkBorderGroup

 The location from which the IP address is advertised. Use this parameter to limit the address to this location.
 
 
 Use DescribeVpcs to
 view the network border groups.
 
 
 
 You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will
 receive an InvalidParameterCombination error. For more information, see Error Codes.
 
 


customerOwnedIpv4Pool
String customerOwnedIpv4Pool

 The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address
 pool. Alternatively, specify a specific address from the address pool.
 








Class com.amazonaws.services.ec2.model.AllocateAddressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


publicIp
String publicIp

 The Elastic IP address.
 


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.
 


publicIpv4Pool
String publicIpv4Pool

 The ID of an address pool.
 


networkBorderGroup
String networkBorderGroup

 The location from which the IP address is advertised.
 


domain
String domain

 Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or
 instances in a VPC (vpc).
 


customerOwnedIp
String customerOwnedIp

 The customer-owned IP address.
 


customerOwnedIpv4Pool
String customerOwnedIpv4Pool

 The ID of the customer-owned address pool.
 








Class com.amazonaws.services.ec2.model.AllocateHostsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


autoPlacement
String autoPlacement

 Indicates whether the host accepts any untargeted instance launches that match its instance type configuration,
 or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see
  Understanding Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.
 
 
 Default: on
 


availabilityZone
String availabilityZone

 The Availability Zone in which to allocate the Dedicated Host.
 


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.
 


instanceType
String instanceType

 Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the
 Dedicated Hosts support instances of the specified instance type only.
 
 
 If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this
 parameter and specify InstanceFamily instead. You cannot specify InstanceType and
 InstanceFamily in the same request.
 


instanceFamily
String instanceFamily

 Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the
 Dedicated Hosts support multiple instance types within that instance family.
 
 
 If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify
 InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same
 request.
 


quantity
Integer quantity

 The number of Dedicated Hosts to allocate to your account with these parameters.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the Dedicated Host during creation.
 


hostRecovery
String hostRecovery

 Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by
 default. For more information, see  Host Recovery in
 the Amazon Elastic Compute Cloud User Guide.
 
 
 Default: off
 








Class com.amazonaws.services.ec2.model.AllocateHostsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hostIds
SdkInternalList<T> hostIds

 The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.
 








Class com.amazonaws.services.ec2.model.AllowedPrincipal extends Object implements Serializable


Serialized Fields


principalType
String principalType

 The type of principal.
 


principal
String principal

 The Amazon Resource Name (ARN) of the principal.
 








Class com.amazonaws.services.ec2.model.AmazonEC2Exception extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ec2.model.ApplySecurityGroupsToClientVpnTargetNetworkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint.
 


vpcId
String vpcId

 The ID of the VPC in which the associated target network is located.
 


securityGroupIds
SdkInternalList<T> securityGroupIds

 The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied
 to an associated target network.
 








Class com.amazonaws.services.ec2.model.ApplySecurityGroupsToClientVpnTargetNetworkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityGroupIds
SdkInternalList<T> securityGroupIds

 The IDs of the applied security groups.
 








Class com.amazonaws.services.ec2.model.AssignedPrivateIpAddress extends Object implements Serializable


Serialized Fields


privateIpAddress
String privateIpAddress

 The private IP address assigned to the network interface.
 








Class com.amazonaws.services.ec2.model.AssignIpv6AddressesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ipv6AddressCount
Integer ipv6AddressCount

 The number of IPv6 addresses to assign to the network interface. Amazon EC2 automatically selects the IPv6
 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
 


ipv6Addresses
SdkInternalList<T> ipv6Addresses

 One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're
 specifying a number of IPv6 addresses.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 








Class com.amazonaws.services.ec2.model.AssignIpv6AddressesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assignedIpv6Addresses
SdkInternalList<T> assignedIpv6Addresses

 The IPv6 addresses assigned to the network interface.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 








Class com.amazonaws.services.ec2.model.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
SdkInternalList<T> privateIpAddresses

 One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't
 specify this parameter when also specifying a number of secondary IP addresses.
 
 
 If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
 


secondaryPrivateIpAddressCount
Integer secondaryPrivateIpAddressCount

 The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when
 also specifying private IP addresses.
 








Class com.amazonaws.services.ec2.model.AssignPrivateIpAddressesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


assignedPrivateIpAddresses
SdkInternalList<T> assignedPrivateIpAddresses

 The private IP addresses assigned to the network interface.
 








Class com.amazonaws.services.ec2.model.AssociateAddressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


allocationId
String allocationId

 [EC2-VPC] The allocation ID. This is required for EC2-VPC.
 


instanceId
String instanceId

 The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or
 the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one
 network interface is attached.
 


publicIp
String publicIp

 The Elastic IP address to associate with the instance. This is required for EC2-Classic.
 


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.
 


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.
 
 
 For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
 


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.
 








Class com.amazonaws.services.ec2.model.AssociateAddressResult extends AmazonWebServiceResult<ResponseMetadata> 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.AssociateClientVpnTargetNetworkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint.
 


subnetId
String subnetId

 The ID of the subnet to associate with the Client VPN endpoint.
 


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.
 








Class com.amazonaws.services.ec2.model.AssociateClientVpnTargetNetworkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


associationId
String associationId

 The unique ID of the target network association.
 


status
AssociationStatus status

 The current state of the target network association.
 








Class com.amazonaws.services.ec2.model.AssociateDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dhcpOptionsId
String dhcpOptionsId

 The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
 


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.AssociateDhcpOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.AssociatedTargetNetwork extends Object implements Serializable


Serialized Fields


networkId
String networkId

 The ID of the subnet.
 


networkType
String networkType

 The target network type.
 








Class com.amazonaws.services.ec2.model.AssociateIamInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


iamInstanceProfile
IamInstanceProfileSpecification iamInstanceProfile

 The IAM instance profile.
 


instanceId
String instanceId

 The ID of the instance.
 








Class com.amazonaws.services.ec2.model.AssociateIamInstanceProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


iamInstanceProfileAssociation
IamInstanceProfileAssociation iamInstanceProfileAssociation

 Information about the IAM instance profile association.
 








Class com.amazonaws.services.ec2.model.AssociateRouteTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


routeTableId
String routeTableId

 The ID of the route table.
 


subnetId
String subnetId

 The ID of the subnet.
 


gatewayId
String gatewayId

 The ID of the internet gateway or virtual private gateway.
 








Class com.amazonaws.services.ec2.model.AssociateRouteTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


associationId
String associationId

 The route table association ID. This ID is required for disassociating the route table.
 


associationState
RouteTableAssociationState associationState

 The state of the association.
 








Class com.amazonaws.services.ec2.model.AssociateSubnetCidrBlockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ipv6CidrBlock
String ipv6CidrBlock

 The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.
 


subnetId
String subnetId

 The ID of your subnet.
 








Class com.amazonaws.services.ec2.model.AssociateSubnetCidrBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ipv6CidrBlockAssociation
SubnetIpv6CidrBlockAssociation ipv6CidrBlockAssociation

 Information about the IPv6 CIDR block association.
 


subnetId
String subnetId

 The ID of the subnet.
 








Class com.amazonaws.services.ec2.model.AssociateTransitGatewayMulticastDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the transit gateway attachment to associate with the transit gateway multicast domain.
 


subnetIds
SdkInternalList<T> subnetIds

 The IDs of the subnets to associate with the transit gateway multicast domain.
 








Class com.amazonaws.services.ec2.model.AssociateTransitGatewayMulticastDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


associations
TransitGatewayMulticastDomainAssociations associations

 Information about the transit gateway multicast domain associations.
 








Class com.amazonaws.services.ec2.model.AssociateTransitGatewayRouteTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the transit gateway route table.
 


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 








Class com.amazonaws.services.ec2.model.AssociateTransitGatewayRouteTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


association
TransitGatewayAssociation association

 The ID of the association.
 








Class com.amazonaws.services.ec2.model.AssociateVpcCidrBlockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amazonProvidedIpv6CidrBlock
Boolean amazonProvidedIpv6CidrBlock

 Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of
 IPv6 addresses, or the size of the CIDR block.
 


cidrBlock
String cidrBlock

 An IPv4 CIDR block to associate with the VPC.
 


vpcId
String vpcId

 The ID of the VPC.
 


ipv6Pool
String ipv6Pool

 The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
 


ipv6CidrBlock
String ipv6CidrBlock

 An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
 
 
 To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
 


ipv6CidrBlockNetworkBorderGroup
String ipv6CidrBlockNetworkBorderGroup

 The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CiDR block
 to this location.
 
 
 You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
 
 
 You can have one IPv6 CIDR block association per network border group.
 








Class com.amazonaws.services.ec2.model.AssociateVpcCidrBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ipv6CidrBlockAssociation
VpcIpv6CidrBlockAssociation ipv6CidrBlockAssociation

 Information about the IPv6 CIDR block association.
 


cidrBlockAssociation
VpcCidrBlockAssociation cidrBlockAssociation

 Information about the IPv4 CIDR block association.
 


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.AssociationStatus extends Object implements Serializable


Serialized Fields


code
String code

 The state of the target network association.
 


message
String message

 A message about the status of the target network association, if applicable.
 








Class com.amazonaws.services.ec2.model.AttachClassicLinkVpcRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groups
SdkInternalList<T> 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.AttachInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


internetGatewayId
String internetGatewayId

 The ID of the internet gateway.
 


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.AttachInternetGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attachmentId
String attachmentId

 The ID of the network interface attachment.
 








Class com.amazonaws.services.ec2.model.AttachVolumeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


device
String device

 The device name (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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attachment
VolumeAttachment attachment

 Describes volume attachment details.
 








Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcAttachment
VpcAttachment vpcAttachment

 Information about the attachment.
 








Class com.amazonaws.services.ec2.model.AuthorizationRule extends Object implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint with which the authorization rule is associated.
 


description
String description

 A brief description of the authorization rule.
 


groupId
String groupId

 The ID of the Active Directory group to which the authorization rule grants access.
 


accessAll
Boolean accessAll

 Indicates whether the authorization rule grants access to all clients.
 


destinationCidr
String destinationCidr

 The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.
 


status
ClientVpnAuthorizationRuleStatus status

 The current state of the authorization rule.
 








Class com.amazonaws.services.ec2.model.AuthorizeClientVpnIngressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint.
 


targetNetworkCidr
String targetNetworkCidr

 The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
 


accessGroupId
String accessGroupId

 The ID of the Active Directory group to grant access.
 


authorizeAllGroups
Boolean authorizeAllGroups

 Indicates whether to grant access to all clients. Use true to grant all clients who successfully
 establish a VPN connection access to the network.
 


description
String description

 A brief description of the authorization rule.
 


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.
 








Class com.amazonaws.services.ec2.model.AuthorizeClientVpnIngressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
ClientVpnAuthorizationRuleStatus status

 The current state of the authorization rule.
 








Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupEgressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId

 The ID of the security group.
 


ipPermissions
SdkInternalList<T> ipPermissions

 The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the
 same set of permissions.
 


cidrIp
String cidrIp

 Not supported. Use a set of IP permissions to specify the CIDR.
 


fromPort
Integer fromPort

 Not supported. Use a set of IP permissions to specify the port.
 


ipProtocol
String ipProtocol

 Not supported. Use a set of IP permissions to specify the protocol name or number.
 


toPort
Integer toPort

 Not supported. Use a set of IP permissions to specify the port.
 


sourceSecurityGroupName
String sourceSecurityGroupName

 Not supported. Use a set of IP permissions to specify a destination security group.
 


sourceSecurityGroupOwnerId
String sourceSecurityGroupOwnerId

 Not supported. Use a set of IP permissions to specify a destination security group.
 








Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupEgressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cidrIp
String cidrIp

 The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source security group.
 To specify an IPv6 address range, use a set of IP permissions.
 
 
 Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
 


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 types. If you specify all ICMP types, you must specify all codes.
 
 
 Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
 


groupId
String groupId

 The ID of the security group. You must specify either the security group ID or the security group name in the
 request. For security groups in a nondefault VPC, you must specify the security group ID.
 


groupName
String groupName

 [EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the
 security group name in the request.
 


ipPermissions
SdkInternalList<T> ipPermissions

 The sets of IP permissions.
 


ipProtocol
String ipProtocol

 The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify
 icmpv6, use a set of IP permissions.
 
 
 [VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than
 tcp, udp, or icmp, traffic on all ports is allowed, regardless of any
 ports you specify.
 
 
 Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
 


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

 [nondefault VPC] The AWS account ID 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 codes. If you specify all ICMP types, you must specify all codes.
 
 
 Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
 








Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupIngressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


state
String state

 The state of the Availability Zone or Local Zone.
 


optInStatus
String optInStatus

 For Availability Zones, this parameter always has the value of opt-in-not-required.
 
 
 For Local Zones, this parameter is the opt in status. The possible values are opted-in, and
 not-opted-in.
 


messages
SdkInternalList<T> messages

 Any messages about the Availability Zone or Local Zone.
 


regionName
String regionName

 The name of the Region.
 


zoneName
String zoneName

 The name of the Availability Zone or Local Zone.
 


zoneId
String zoneId

 The ID of the Availability Zone or Local Zone.
 


groupName
String groupName

 For Availability Zones, this parameter has the same value as the Region name.
 
 
 For Local Zones, the name of the associated group, for example us-west-2-lax-1.
 


networkBorderGroup
String networkBorderGroup

 The name of the location from which the address is advertised.
 








Class com.amazonaws.services.ec2.model.AvailabilityZoneMessage extends Object implements Serializable


Serialized Fields


message
String message

 The message about the Availability Zone or Local Zone.
 








Class com.amazonaws.services.ec2.model.AvailableCapacity extends Object implements Serializable


Serialized Fields


availableInstanceCapacity
SdkInternalList<T> availableInstanceCapacity

 The number of instances that can be launched onto the Dedicated Host depending on the host's available capacity.
 For Dedicated Hosts that support multiple instance types, this parameter represents the number of instances for
 each instance size that is supported on the host.
 


availableVCpus
Integer availableVCpus

 The number of vCPUs available for launching instances onto the Dedicated Host.
 








Class com.amazonaws.services.ec2.model.BlockDeviceMapping extends Object implements Serializable


Serialized Fields


deviceName
String deviceName

 The device name (for example, /dev/sdh or xvdh).
 


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.
 
 
 NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block
 device mapping has no effect.
 
 
 Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the
 instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device
 mapping for the AMI.
 


ebs
EbsBlockDevice ebs

 Parameters used to automatically set up EBS volumes when the instance is launched.
 


noDevice
String noDevice

 Suppresses the specified device included in the block device mapping of the AMI.
 








Class com.amazonaws.services.ec2.model.BundleInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance to bundle.
 
 
 Type: String
 
 
 Default: None
 
 
 Required: Yes
 


storage
Storage storage

 The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon
 EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
 








Class com.amazonaws.services.ec2.model.BundleInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bundleTask
BundleTask bundleTask

 Information about the bundle task.
 








Class com.amazonaws.services.ec2.model.BundleTask extends Object implements Serializable


Serialized Fields


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 extends Object implements Serializable


Serialized Fields


code
String code

 The error code.
 


message
String message

 The error message.
 








Class com.amazonaws.services.ec2.model.ByoipCidr extends Object implements Serializable


Serialized Fields


cidr
String cidr

 The address range, in CIDR notation.
 


description
String description

 The description of the address range.
 


statusMessage
String statusMessage

 Upon success, contains the ID of the address pool. Otherwise, contains an error message.
 


state
String state

 The state of the address pool.
 








Class com.amazonaws.services.ec2.model.CancelBundleTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


bundleId
String bundleId

 The ID of the bundle task.
 








Class com.amazonaws.services.ec2.model.CancelBundleTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bundleTask
BundleTask bundleTask

 Information about the bundle task.
 








Class com.amazonaws.services.ec2.model.CancelCapacityReservationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


capacityReservationId
String capacityReservationId

 The ID of the Capacity Reservation to be cancelled.
 








Class com.amazonaws.services.ec2.model.CancelCapacityReservationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.CancelConversionTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


conversionTaskId
String conversionTaskId

 The ID of the conversion task.
 


reasonMessage
String reasonMessage

 The reason for canceling the conversion task.
 








Class com.amazonaws.services.ec2.model.CancelConversionTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.CancelExportTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


exportTaskId
String exportTaskId

 The ID of the export task. This is the ID returned by CreateInstanceExportTask.
 








Class com.amazonaws.services.ec2.model.CancelExportTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> 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 extends Object implements Serializable


Serialized Fields


spotInstanceRequestId
String spotInstanceRequestId

 The ID of the Spot Instance request.
 


state
String state

 The state of the Spot Instance request.
 








Class com.amazonaws.services.ec2.model.CancelReservedInstancesListingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reservedInstancesListingId
String reservedInstancesListingId

 The ID of the Reserved Instance listing.
 








Class com.amazonaws.services.ec2.model.CancelReservedInstancesListingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservedInstancesListings
SdkInternalList<T> reservedInstancesListings

 The Reserved Instance listing.
 








Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsError extends Object implements Serializable


Serialized Fields


code
String code

 The error code.
 


message
String message

 The description for the error code.
 








Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsErrorItem extends Object implements Serializable


Serialized Fields


error
CancelSpotFleetRequestsError error

 The error.
 


spotFleetRequestId
String spotFleetRequestId

 The ID of the Spot Fleet request.
 








Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


spotFleetRequestIds
SdkInternalList<T> spotFleetRequestIds

 The IDs of the Spot Fleet requests.
 


terminateInstances
Boolean terminateInstances

 Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
 








Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successfulFleetRequests
SdkInternalList<T> successfulFleetRequests

 Information about the Spot Fleet requests that are successfully canceled.
 


unsuccessfulFleetRequests
SdkInternalList<T> unsuccessfulFleetRequests

 Information about the Spot Fleet requests that are not successfully canceled.
 








Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


spotInstanceRequestIds
SdkInternalList<T> spotInstanceRequestIds

 One or more Spot Instance request IDs.
 








Class com.amazonaws.services.ec2.model.CancelSpotInstanceRequestsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cancelledSpotInstanceRequests
SdkInternalList<T> cancelledSpotInstanceRequests

 One or more Spot Instance requests.
 








Class com.amazonaws.services.ec2.model.CapacityReservation extends Object implements Serializable


Serialized Fields


capacityReservationId
String capacityReservationId

 The ID of the Capacity Reservation.
 


ownerId
String ownerId

 The ID of the AWS account that owns the Capacity Reservation.
 


capacityReservationArn
String capacityReservationArn

 The Amazon Resource Name (ARN) of the Capacity Reservation.
 


availabilityZoneId
String availabilityZoneId

 The Availability Zone ID of the Capacity Reservation.
 


instanceType
String instanceType

 The type of instance for which the Capacity Reservation reserves capacity.
 


instancePlatform
String instancePlatform

 The type of operating system for which the Capacity Reservation reserves capacity.
 


availabilityZone
String availabilityZone

 The Availability Zone in which the capacity is reserved.
 


tenancy
String tenancy

 Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy
 settings:
 
 
 
 
 default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.
 
 
 
 
 dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a
 single AWS account.
 
 
 


totalInstanceCount
Integer totalInstanceCount

 The total number of instances for which the Capacity Reservation reserves capacity.
 


availableInstanceCount
Integer availableInstanceCount

 The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
 


ebsOptimized
Boolean ebsOptimized

 Indicates whether the Capacity Reservation supports EBS-optimized instances. 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.
 


ephemeralStorage
Boolean ephemeralStorage

 Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
 


state
String state

 The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
 
 
 
 
 active - The Capacity Reservation is active and the capacity is available for your use.
 
 
 
 
 expired - The Capacity Reservation expired automatically at the date and time specified in your
 request. The reserved capacity is no longer available for your use.
 
 
 
 
 cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer
 available for your use.
 
 
 
 
 pending - The Capacity Reservation request was successful but the capacity provisioning is still
 pending.
 
 
 
 
 failed - The Capacity Reservation request has failed. A request might fail due to invalid request
 parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
 
 
 


endDate
Date endDate

 The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved
 capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
 expired when it reaches its end date and time.
 


endDateType
String endDateType

 Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following
 end types:
 
 
 
 
 unlimited - The Capacity Reservation remains active until you explicitly cancel it.
 
 
 
 
 limited - The Capacity Reservation expires automatically at a specified date and time.
 
 
 


instanceMatchCriteria
String instanceMatchCriteria

 Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
 
 
 
 
 open - The Capacity Reservation accepts all instances that have matching attributes (instance type,
 platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation
 automatically without specifying any additional parameters.
 
 
 
 
 targeted - The Capacity Reservation only accepts instances that have matching attributes (instance
 type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only
 permitted instances can use the reserved capacity.
 
 
 


createDate
Date createDate

 The date and time at which the Capacity Reservation was created.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the Capacity Reservation.
 








Class com.amazonaws.services.ec2.model.CapacityReservationOptions extends Object implements Serializable


Serialized Fields


usageStrategy
String usageStrategy

 Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
 
 
 If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to
 fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity
 Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is
 applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining
 On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price
 or prioritized).
 
 
 If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand
 allocation strategy.
 








Class com.amazonaws.services.ec2.model.CapacityReservationOptionsRequest extends Object implements Serializable


Serialized Fields


usageStrategy
String usageStrategy

 Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.
 
 
 If you specify use-capacity-reservations-first, the fleet uses unused Capacity Reservations to
 fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity
 Reservations, the On-Demand allocation strategy (lowest-price or prioritized) is
 applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining
 On-Demand target capacity is launched according to the On-Demand allocation strategy (lowest-price
 or prioritized).
 
 
 If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand
 allocation strategy.
 








Class com.amazonaws.services.ec2.model.CapacityReservationSpecification extends Object implements Serializable


Serialized Fields


capacityReservationPreference
String capacityReservationPreference

 Indicates the instance's Capacity Reservation preferences. Possible preferences include:
 
 
 
 
 open - The instance can run in any open Capacity Reservation that has matching
 attributes (instance type, platform, Availability Zone).
 
 
 
 
 none - The instance avoids running in a Capacity Reservation even if one is available. The instance
 runs as an On-Demand Instance.
 
 
 


capacityReservationTarget
CapacityReservationTarget capacityReservationTarget

 Information about the target Capacity Reservation.
 








Class com.amazonaws.services.ec2.model.CapacityReservationSpecificationResponse extends Object implements Serializable


Serialized Fields


capacityReservationPreference
String capacityReservationPreference

 Describes the instance's Capacity Reservation preferences. Possible preferences include:
 
 
 
 
 open - The instance can run in any open Capacity Reservation that has matching
 attributes (instance type, platform, Availability Zone).
 
 
 
 
 none - The instance avoids running in a Capacity Reservation even if one is available. The instance
 runs in On-Demand capacity.
 
 
 


capacityReservationTarget
CapacityReservationTargetResponse capacityReservationTarget

 Information about the targeted Capacity Reservation.
 








Class com.amazonaws.services.ec2.model.CapacityReservationTarget extends Object implements Serializable


Serialized Fields


capacityReservationId
String capacityReservationId

 The ID of the Capacity Reservation.
 








Class com.amazonaws.services.ec2.model.CapacityReservationTargetResponse extends Object implements Serializable


Serialized Fields


capacityReservationId
String capacityReservationId

 The ID of the Capacity Reservation.
 








Class com.amazonaws.services.ec2.model.CertificateAuthentication extends Object implements Serializable


Serialized Fields


clientRootCertificateChain
String clientRootCertificateChain

 The ARN of the client certificate.
 








Class com.amazonaws.services.ec2.model.CertificateAuthenticationRequest extends Object implements Serializable


Serialized Fields


clientRootCertificateChainArn
String clientRootCertificateChainArn

 The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be
 provisioned in AWS Certificate Manager (ACM).
 








Class com.amazonaws.services.ec2.model.CidrAuthorizationContext extends Object implements Serializable


Serialized Fields


message
String message

 The plain-text authorization message for the prefix and account.
 


signature
String signature

 The signed authorization message for the prefix and account.
 








Class com.amazonaws.services.ec2.model.CidrBlock extends Object implements Serializable


Serialized Fields


cidrBlock
String cidrBlock

 The IPv4 CIDR block.
 








Class com.amazonaws.services.ec2.model.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 extends Object implements Serializable


Serialized Fields


groups
SdkInternalList<T> groups

 A list of security groups.
 


instanceId
String instanceId

 The ID of the instance.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the instance.
 


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.ClassicLoadBalancer extends Object implements Serializable


Serialized Fields


name
String name

 The name of the load balancer.
 








Class com.amazonaws.services.ec2.model.ClassicLoadBalancersConfig extends Object implements Serializable


Serialized Fields


classicLoadBalancers
SdkInternalList<T> classicLoadBalancers

 One or more Classic Load Balancers.
 








Class com.amazonaws.services.ec2.model.ClientCertificateRevocationListStatus extends Object implements Serializable


Serialized Fields


code
String code

 The state of the client certificate revocation list.
 


message
String message

 A message about the status of the client certificate revocation list, if applicable.
 








Class com.amazonaws.services.ec2.model.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.ClientVpnAuthentication extends Object implements Serializable


Serialized Fields


type
String type

 The authentication type used.
 


activeDirectory
DirectoryServiceAuthentication activeDirectory

 Information about the Active Directory, if applicable.
 


mutualAuthentication
CertificateAuthentication mutualAuthentication

 Information about the authentication certificates, if applicable.
 








Class com.amazonaws.services.ec2.model.ClientVpnAuthenticationRequest extends Object implements Serializable


Serialized Fields


type
String type

 The type of client authentication to be used. Specify certificate-authentication to use
 certificate-based authentication, or directory-service-authentication to use Active Directory
 authentication.
 


activeDirectory
DirectoryServiceAuthenticationRequest activeDirectory

 Information about the Active Directory to be used, if applicable. You must provide this information if
 Type is directory-service-authentication.
 


mutualAuthentication
CertificateAuthenticationRequest mutualAuthentication

 Information about the authentication certificates to be used, if applicable. You must provide this information if
 Type is certificate-authentication.
 








Class com.amazonaws.services.ec2.model.ClientVpnAuthorizationRuleStatus extends Object implements Serializable


Serialized Fields


code
String code

 The state of the authorization rule.
 


message
String message

 A message about the status of the authorization rule, if applicable.
 








Class com.amazonaws.services.ec2.model.ClientVpnConnection extends Object implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint to which the client is connected.
 


timestamp
String timestamp

 The current date and time.
 


connectionId
String connectionId

 The ID of the client connection.
 


username
String username

 The username of the client who established the client connection. This information is only provided if Active
 Directory client authentication is used.
 


connectionEstablishedTime
String connectionEstablishedTime

 The date and time the client connection was established.
 


ingressBytes
String ingressBytes

 The number of bytes sent by the client.
 


egressBytes
String egressBytes

 The number of bytes received by the client.
 


ingressPackets
String ingressPackets

 The number of packets sent by the client.
 


egressPackets
String egressPackets

 The number of packets received by the client.
 


clientIp
String clientIp

 The IP address of the client.
 


commonName
String commonName

 The common name associated with the client. This is either the name of the client certificate, or the Active
 Directory user name.
 


status
ClientVpnConnectionStatus status

 The current state of the client connection.
 


connectionEndTime
String connectionEndTime

 The date and time the client connection was terminated.
 








Class com.amazonaws.services.ec2.model.ClientVpnConnectionStatus extends Object implements Serializable


Serialized Fields


code
String code

 The state of the client connection.
 


message
String message

 A message about the status of the client connection, if applicable.
 








Class com.amazonaws.services.ec2.model.ClientVpnEndpoint extends Object implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint.
 


description
String description

 A brief description of the endpoint.
 


status
ClientVpnEndpointStatus status

 The current state of the Client VPN endpoint.
 


creationTime
String creationTime

 The date and time the Client VPN endpoint was created.
 


deletionTime
String deletionTime

 The date and time the Client VPN endpoint was deleted, if applicable.
 


dnsName
String dnsName

 The DNS name to be used by clients when connecting to the Client VPN endpoint.
 


clientCidrBlock
String clientCidrBlock

 The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
 


dnsServers
SdkInternalList<T> dnsServers

 Information about the DNS servers to be used for DNS resolution.
 


splitTunnel
Boolean splitTunnel

 Indicates whether split-tunnel is enabled in the AWS Client VPN endpoint.
 
 
 For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN
 Endpoint in the AWS Client VPN Administrator Guide.
 


vpnProtocol
String vpnProtocol

 The protocol used by the VPN session.
 


transportProtocol
String transportProtocol

 The transport protocol used by the Client VPN endpoint.
 


vpnPort
Integer vpnPort

 The port number for the Client VPN endpoint.
 


associatedTargetNetworks
SdkInternalList<T> associatedTargetNetworks
Deprecated. 

 Information about the associated target networks. A target network is a subnet in a VPC.
 


serverCertificateArn
String serverCertificateArn

 The ARN of the server certificate.
 


authenticationOptions
SdkInternalList<T> authenticationOptions

 Information about the authentication method used by the Client VPN endpoint.
 


connectionLogOptions
ConnectionLogResponseOptions connectionLogOptions

 Information about the client connection logging options for the Client VPN endpoint.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the Client VPN endpoint.
 








Class com.amazonaws.services.ec2.model.ClientVpnEndpointStatus extends Object implements Serializable


Serialized Fields


code
String code

 The state of the Client VPN endpoint. Possible states include:
 
 
 
 
 pending-associate - The Client VPN endpoint has been created but no target networks have been
 associated. The Client VPN endpoint cannot accept connections.
 
 
 
 
 available - The Client VPN endpoint has been created and a target network has been associated. The
 Client VPN endpoint can accept connections.
 
 
 
 
 deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept
 connections.
 
 
 
 
 deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept
 connections.
 
 
 


message
String message

 A message about the status of the Client VPN endpoint.
 








Class com.amazonaws.services.ec2.model.ClientVpnRoute extends Object implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint with which the route is associated.
 


destinationCidr
String destinationCidr

 The IPv4 address range, in CIDR notation, of the route destination.
 


targetSubnet
String targetSubnet

 The ID of the subnet through which traffic is routed.
 


type
String type

 The route type.
 


origin
String origin

 Indicates how the route was associated with the Client VPN endpoint. associate indicates that the
 route was automatically added when the target network was associated with the Client VPN endpoint.
 add-route indicates that the route was manually added using the CreateClientVpnRoute action.
 


status
ClientVpnRouteStatus status

 The current state of the route.
 


description
String description

 A brief description of the route.
 








Class com.amazonaws.services.ec2.model.ClientVpnRouteStatus extends Object implements Serializable


Serialized Fields


code
String code

 The state of the Client VPN endpoint route.
 


message
String message

 A message about the status of the Client VPN endpoint route, if applicable.
 








Class com.amazonaws.services.ec2.model.CoipAddressUsage extends Object implements Serializable


Serialized Fields


allocationId
String allocationId

 The allocation ID of the address.
 


awsAccountId
String awsAccountId

 The AWS account ID.
 


awsService
String awsService

 The AWS service.
 


coIp
String coIp

 The customer-owned IP address.
 








Class com.amazonaws.services.ec2.model.CoipPool extends Object implements Serializable


Serialized Fields


poolId
String poolId

 The ID of the address pool.
 


poolCidrs
SdkInternalList<T> poolCidrs

 The address ranges of the address pool.
 


localGatewayRouteTableId
String localGatewayRouteTableId

 The ID of the local gateway route table.
 


tags
SdkInternalList<T> tags

 The tags.
 








Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> 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.ConnectionLogOptions extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Indicates whether connection logging is enabled.
 


cloudwatchLogGroup
String cloudwatchLogGroup

 The name of the CloudWatch Logs log group.
 


cloudwatchLogStream
String cloudwatchLogStream

 The name of the CloudWatch Logs log stream to which the connection data is published.
 








Class com.amazonaws.services.ec2.model.ConnectionLogResponseOptions extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Indicates whether client connection logging is enabled for the Client VPN endpoint.
 


cloudwatchLogGroup
String cloudwatchLogGroup

 The name of the Amazon CloudWatch Logs log group to which connection logging data is published.
 


cloudwatchLogStream
String cloudwatchLogStream

 The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.
 








Class com.amazonaws.services.ec2.model.ConnectionNotification extends Object implements Serializable


Serialized Fields


connectionNotificationId
String connectionNotificationId

 The ID of the notification.
 


serviceId
String serviceId

 The ID of the endpoint service.
 


vpcEndpointId
String vpcEndpointId

 The ID of the VPC endpoint.
 


connectionNotificationType
String connectionNotificationType

 The type of notification.
 


connectionNotificationArn
String connectionNotificationArn

 The ARN of the SNS topic for the notification.
 


connectionEvents
SdkInternalList<T> connectionEvents

 The events for the notification. Valid values are Accept, Connect, Delete,
 and Reject.
 


connectionNotificationState
String connectionNotificationState

 The state of the notification.
 








Class com.amazonaws.services.ec2.model.ConversionTask extends Object implements Serializable


Serialized Fields


conversionTaskId
String conversionTaskId

 The ID of the conversion task.
 


expirationTime
String expirationTime

 The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel
 the task.
 


importInstance
ImportInstanceTaskDetails importInstance

 If the task is for importing an instance, this contains information about the import instance task.
 


importVolume
ImportVolumeTaskDetails importVolume

 If the task is for importing a volume, this contains information about the import volume task.
 


state
String state

 The state of the conversion task.
 


statusMessage
String statusMessage

 The status message related to the conversion task.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the task.
 








Class com.amazonaws.services.ec2.model.CopyFpgaImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceFpgaImageId
String sourceFpgaImageId

 The ID of the source AFI.
 


description
String description

 The description for the new AFI.
 


name
String name

 The name for the new AFI. The default is the name of the source AFI.
 


sourceRegion
String sourceRegion

 The Region that contains the source AFI.
 


clientToken
String clientToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
 information, see Ensuring
 Idempotency.
 








Class com.amazonaws.services.ec2.model.CopyFpgaImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fpgaImageId
String fpgaImageId

 The ID of the new AFI.
 








Class com.amazonaws.services.ec2.model.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. You can encrypt a copy of an
 unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS
 is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId.
 For more information, see Amazon
 EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
 


kmsKeyId
String kmsKeyId

 An identifier for the symmetric 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. If a KmsKeyId is specified, the
 Encrypted flag must also be set.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/". For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
 though you provided an invalid identifier. This action will eventually report failure.
 
 
 The specified CMK must exist in the Region that the snapshot is being copied to.
 
 
 Amazon EBS does not support asymmetric CMKs.
 


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


imageId
String imageId

 The ID of the new AMI.
 








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


Serialized Fields


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.
 
 
 The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example,
 ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the --region
 parameter or the default Region in your AWS configuration file.
 


encrypted
Boolean encrypted

 To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using
 this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this
 parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information,
 see Amazon EBS Encryption in
 the Amazon Elastic Compute Cloud User Guide.
 


kmsKeyId
String kmsKeyId

 The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS
 encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is
 specified, the encrypted state must be true.
 
 
 You can specify the CMK using any of the following:
 
 
 
 
 Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
 
 
 
 
 Key alias. For example, alias/ExampleAlias.
 
 
 
 
 Key ARN. For example,
 arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
 
 
 
 
 Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
 
 
 
 
 AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the
 action can appear to complete, but eventually fails.
 


presignedUrl
String presignedUrl

 When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This
 parameter is optional for unencrypted snapshots. For more information, see Query Requests.
 
 
 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.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the new snapshot.
 








Class com.amazonaws.services.ec2.model.CopySnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


snapshotId
String snapshotId

 The ID of the new snapshot.
 


tags
SdkInternalList<T> tags

 Any tags applied to the new snapshot.
 








Class com.amazonaws.services.ec2.model.CpuOptions extends Object implements Serializable


Serialized Fields


coreCount
Integer coreCount

 The number of CPU cores for the instance.
 


threadsPerCore
Integer threadsPerCore

 The number of threads per CPU core.
 








Class com.amazonaws.services.ec2.model.CpuOptionsRequest extends Object implements Serializable


Serialized Fields


coreCount
Integer coreCount

 The number of CPU cores for the instance.
 


threadsPerCore
Integer threadsPerCore

 The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1
 . Otherwise, specify the default value of 2.
 








Class com.amazonaws.services.ec2.model.CreateCapacityReservationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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.
 
 
 Constraint: Maximum 64 ASCII characters.
 


instanceType
String instanceType

 The instance type for which to reserve capacity. For more information, see Instance Types in the
 Amazon Elastic Compute Cloud User Guide.
 


instancePlatform
String instancePlatform

 The type of operating system for which to reserve capacity.
 


availabilityZone
String availabilityZone

 The Availability Zone in which to create the Capacity Reservation.
 


availabilityZoneId
String availabilityZoneId

 The ID of the Availability Zone in which to create the Capacity Reservation.
 


tenancy
String tenancy

 Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy
 settings:
 
 
 
 
 default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.
 
 
 
 
 dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a
 single AWS account.
 
 
 


instanceCount
Integer instanceCount

 The number of instances for which to reserve capacity.
 


ebsOptimized
Boolean ebsOptimized

 Indicates whether the Capacity Reservation supports EBS-optimized instances. 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.
 


ephemeralStorage
Boolean ephemeralStorage

 Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.
 


endDate
Date endDate

 The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved
 capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
 expired when it reaches its end date and time.
 
 
 You must provide an EndDate value if EndDateType is limited. Omit
 EndDate if EndDateType is unlimited.
 
 
 If the EndDateType is limited, the Capacity Reservation is cancelled within an hour
 from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed
 to end between 13:30:55 and 14:30:55 on 5/31/2019.
 


endDateType
String endDateType

 Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following
 end types:
 
 
 
 
 unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide
 an EndDate if the EndDateType is unlimited.
 
 
 
 
 limited - The Capacity Reservation expires automatically at a specified date and time. You must
 provide an EndDate value if the EndDateType value is limited.
 
 
 


instanceMatchCriteria
String instanceMatchCriteria

 Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
 
 
 
 
 open - The Capacity Reservation automatically matches all instances that have matching attributes
 (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity
 Reservation automatically without specifying any additional parameters.
 
 
 
 
 targeted - The Capacity Reservation only accepts instances that have matching attributes (instance
 type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only
 permitted instances can use the reserved capacity.
 
 
 
 
 Default: open
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the Capacity Reservation during launch.
 








Class com.amazonaws.services.ec2.model.CreateCapacityReservationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


capacityReservation
CapacityReservation capacityReservation

 Information about the Capacity Reservation.
 








Class com.amazonaws.services.ec2.model.CreateClientVpnEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientCidrBlock
String clientCidrBlock

 The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot
 overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add
 manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block
 should be /22 or greater.
 


serverCertificateArn
String serverCertificateArn

 The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide.
 


authenticationOptions
SdkInternalList<T> authenticationOptions

 Information about the authentication method to be used to authenticate clients.
 


connectionLogOptions
ConnectionLogOptions connectionLogOptions

 Information about the client connection logging options.
 
 
 If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream.
 The following information is logged:
 
 
 
 
 Client connection requests
 
 
 
 
 Client connection results (successful and unsuccessful)
 
 
 
 
 Reasons for unsuccessful client connection requests
 
 
 
 
 Client connection termination time
 
 
 


dnsServers
SdkInternalList<T> dnsServers

 Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS
 servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.
 


transportProtocol
String transportProtocol

 The transport protocol to be used by the VPN session.
 
 
 Default value: udp
 


vpnPort
Integer vpnPort

 The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
 
 
 Valid Values: 443 | 1194
 
 
 Default Value: 443
 


description
String description

 A brief description of the Client VPN endpoint.
 


splitTunnel
Boolean splitTunnel

 Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
 
 
 By default, split-tunnel on a VPN endpoint is disabled.
 
 
 For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN
 Endpoint in the AWS Client VPN Administrator Guide.
 


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.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the Client VPN endpoint during creation.
 








Class com.amazonaws.services.ec2.model.CreateClientVpnEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint.
 


status
ClientVpnEndpointStatus status

 The current state of the Client VPN endpoint.
 


dnsName
String dnsName

 The DNS name to be used by clients when establishing their VPN session.
 








Class com.amazonaws.services.ec2.model.CreateClientVpnRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint to which to add the route.
 


destinationCidrBlock
String destinationCidrBlock

 The IPv4 address range, in CIDR notation, of the route destination. For example:
 
 
 
 
 To add a route for Internet access, enter 0.0.0.0/0
 
 
 
 
 To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
 
 
 
 
 To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range
 
 
 
 
 Route address ranges cannot overlap with the CIDR range specified for client allocation.
 


targetVpcSubnetId
String targetVpcSubnetId

 The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target
 network of the Client VPN endpoint.
 


description
String description

 A brief description of the route.
 


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.
 








Class com.amazonaws.services.ec2.model.CreateClientVpnRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
ClientVpnRouteStatus status

 The current state of the route.
 








Class com.amazonaws.services.ec2.model.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.
 


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) for the customer gateway certificate.
 


type
String type

 The type of VPN connection that this customer gateway supports (ipsec.1).
 


deviceName
String deviceName

 A name for the customer gateway device.
 
 
 Length Constraints: Up to 255 characters.
 








Class com.amazonaws.services.ec2.model.CreateCustomerGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


customerGateway
CustomerGateway customerGateway

 Information about the customer gateway.
 








Class com.amazonaws.services.ec2.model.CreateDefaultSubnetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone in which to create the default subnet.
 








Class com.amazonaws.services.ec2.model.CreateDefaultSubnetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


subnet
Subnet subnet

 Information about the subnet.
 








Class com.amazonaws.services.ec2.model.CreateDefaultVpcRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.ec2.model.CreateDefaultVpcResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpc
Vpc vpc

 Information about the VPC.
 








Class com.amazonaws.services.ec2.model.CreateDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dhcpConfigurations
SdkInternalList<T> dhcpConfigurations

 A DHCP configuration option.
 








Class com.amazonaws.services.ec2.model.CreateDhcpOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dhcpOptions
DhcpOptions dhcpOptions

 A set of DHCP options.
 








Class com.amazonaws.services.ec2.model.CreateEgressOnlyInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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.
 


vpcId
String vpcId

 The ID of the VPC for which to create the egress-only internet gateway.
 








Class com.amazonaws.services.ec2.model.CreateEgressOnlyInternetGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientToken
String clientToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 


egressOnlyInternetGateway
EgressOnlyInternetGateway egressOnlyInternetGateway

 Information about the egress-only internet gateway.
 








Class com.amazonaws.services.ec2.model.CreateFleetError extends Object implements Serializable


Serialized Fields


launchTemplateAndOverrides
LaunchTemplateAndOverridesResponse launchTemplateAndOverrides

 The launch templates and overrides that were used for launching the instances. The values that you specify in the
 Overrides replace the values in the launch template.
 


lifecycle
String lifecycle

 Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
 


errorCode
String errorCode

 The error code that indicates why the instance could not be launched. For more information about error codes, see
 Error Codes.
 


errorMessage
String errorMessage

 The error message that describes why the instance could not be launched. For more information about error
 messages, see Error
 Codes.
 








Class com.amazonaws.services.ec2.model.CreateFleetInstance extends Object implements Serializable


Serialized Fields


launchTemplateAndOverrides
LaunchTemplateAndOverridesResponse launchTemplateAndOverrides

 The launch templates and overrides that were used for launching the instances. The values that you specify in the
 Overrides replace the values in the launch template.
 


lifecycle
String lifecycle

 Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
 


instanceIds
SdkInternalList<T> instanceIds

 The IDs of the instances.
 


instanceType
String instanceType

 The instance type.
 


platform
String platform

 The value is Windows for Windows instances. Otherwise, the value is blank.
 








Class com.amazonaws.services.ec2.model.CreateFleetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientToken
String clientToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
 information, see Ensuring
 Idempotency.
 


spotOptions
SpotOptionsRequest spotOptions

 Describes the configuration of Spot Instances in an EC2 Fleet.
 


onDemandOptions
OnDemandOptionsRequest onDemandOptions

 Describes the configuration of On-Demand Instances in an EC2 Fleet.
 


excessCapacityTerminationPolicy
String excessCapacityTerminationPolicy

 Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is
 decreased below the current size of the EC2 Fleet.
 


launchTemplateConfigs
SdkInternalList<T> launchTemplateConfigs

 The configuration for the EC2 Fleet.
 


targetCapacitySpecification
TargetCapacitySpecificationRequest targetCapacitySpecification

 The number of units to request.
 


terminateInstancesWithExpiration
Boolean terminateInstancesWithExpiration

 Indicates whether running instances should be terminated when the EC2 Fleet expires.
 


type
String type

 The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and
 maintains it by replenishing interrupted Spot Instances (maintain). A value of instant
 places a synchronous one-time request, and returns errors for any instances that could not be launched. A value
 of request places an asynchronous one-time request without maintaining capacity or submitting
 requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.
 


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 EC2 Fleet requests are
 placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.
 


replaceUnhealthyInstances
Boolean replaceUnhealthyInstances

 Indicates whether EC2 Fleet should replace unhealthy instances.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be
 fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch
 template. For information about tagging after launch, see Tagging Your
 Resources.
 








Class com.amazonaws.services.ec2.model.CreateFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fleetId
String fleetId

 The ID of the EC2 Fleet.
 


errors
SdkInternalList<T> errors

 Information about the instances that could not be launched by the fleet. Valid only when Type is set to
 instant.
 


instances
SdkInternalList<T> instances

 Information about the instances that were launched by the fleet. Valid only when Type is set to
 instant.
 








Class com.amazonaws.services.ec2.model.CreateFlowLogsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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.
 


deliverLogsPermissionArn
String deliverLogsPermissionArn

 The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your
 account.
 
 
 If you specify LogDestinationType as s3, do not specify
 DeliverLogsPermissionArn or LogGroupName.
 


logGroupName
String logGroupName

 The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
 
 
 If you specify LogDestinationType as s3, do not specify
 DeliverLogsPermissionArn or LogGroupName.
 


resourceIds
SdkInternalList<T> resourceIds

 The ID of the subnet, network interface, or VPC for which you want to create a flow log.
 
 
 Constraints: Maximum of 1000 resources
 


resourceType
String resourceType

 The type of resource for which to create the flow log. For example, if you specified a VPC ID for the
 ResourceId property, specify VPC for this property.
 


trafficType
String trafficType

 The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
 


logDestinationType
String logDestinationType

 Specifies the type of destination to which the flow log data is to be published. Flow log data can be published
 to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify
 cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.
 
 
 If you specify LogDestinationType as s3, do not specify
 DeliverLogsPermissionArn or LogGroupName.
 
 
 Default: cloud-watch-logs
 


logDestination
String logDestination

 Specifies the destination to which the flow log data is to be published. Flow log data can be published to a
 CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value
 specified for LogDestinationType.
 
 
 If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource
 Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs,
 specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use
 LogGroupName instead.
 
 
 If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a
 subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format:
 bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a
 bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You
 cannot use AWSLogs as a subfolder name. This is a reserved term.
 


logFormat
String logFormat

 The fields to include in the flow log record, in the order in which they should appear. For a list of available
 fields, see Flow Log
 Records. If you omit this parameter, the flow log is created using the default format. If you specify this
 parameter, you must specify at least one field.
 
 
 Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single
 quotation marks (' ') to surround the parameter value.
 
 
 Only applicable to flow logs that are published to an Amazon S3 bucket.
 


maxAggregationInterval
Integer maxAggregationInterval

 The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
 You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).
 
 
 For network interfaces attached to Nitro-based
 instances, the aggregation interval is always 60 seconds, regardless of the value that you specify.
 
 
 Default: 600
 








Class com.amazonaws.services.ec2.model.CreateFlowLogsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientToken
String clientToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 


flowLogIds
SdkInternalList<T> flowLogIds

 The IDs of the flow logs.
 


unsuccessful
SdkInternalList<T> unsuccessful

 Information about the flow logs that could not be created successfully.
 








Class com.amazonaws.services.ec2.model.CreateFpgaImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputStorageLocation
StorageLocation inputStorageLocation

 The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
 


logsStorageLocation
StorageLocation logsStorageLocation

 The location in Amazon S3 for the output logs.
 


description
String description

 A description for the AFI.
 


name
String name

 A name for the AFI.
 


clientToken
String clientToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
 information, see Ensuring
 Idempotency.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the FPGA image during creation.
 








Class com.amazonaws.services.ec2.model.CreateFpgaImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fpgaImageId
String fpgaImageId

 The FPGA image identifier (AFI ID).
 


fpgaImageGlobalId
String fpgaImageGlobalId

 The global FPGA image identifier (AGFI ID).
 








Class com.amazonaws.services.ec2.model.CreateImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


blockDeviceMappings
SdkInternalList<T> blockDeviceMappings

 The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or
 snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.
 


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


imageId
String imageId

 The ID of the new AMI.
 








Class com.amazonaws.services.ec2.model.CreateInstanceExportTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description

 A description for the conversion task or the resource being exported. The maximum length is 255 bytes.
 


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


exportTask
ExportTask exportTask

 Information about the instance export task.
 








Class com.amazonaws.services.ec2.model.CreateInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.ec2.model.CreateInternetGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


internetGateway
InternetGateway internetGateway

 Information about the internet gateway.
 








Class com.amazonaws.services.ec2.model.CreateKeyPairRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyName
String keyName

 A unique name for the key pair.
 
 
 Constraints: Up to 255 ASCII characters
 








Class com.amazonaws.services.ec2.model.CreateKeyPairResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyPair
KeyPair keyPair

 Describes a key pair.
 








Class com.amazonaws.services.ec2.model.CreateLaunchTemplateRequest 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
 Ensuring
 Idempotency.
 
 
 Constraint: Maximum 128 ASCII characters.
 


launchTemplateName
String launchTemplateName

 A name for the launch template.
 


versionDescription
String versionDescription

 A description for the first version of the launch template.
 


launchTemplateData
RequestLaunchTemplateData launchTemplateData

 The information for the launch template.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the launch template during creation.
 








Class com.amazonaws.services.ec2.model.CreateLaunchTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


launchTemplate
LaunchTemplate launchTemplate

 Information about the launch template.
 








Class com.amazonaws.services.ec2.model.CreateLaunchTemplateVersionRequest 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
 Ensuring
 Idempotency.
 
 
 Constraint: Maximum 128 ASCII characters.
 


launchTemplateId
String launchTemplateId

 The ID of the launch template. You must specify either the launch template ID or launch template name in the
 request.
 


launchTemplateName
String launchTemplateName

 The name of the launch template. You must specify either the launch template ID or launch template name in the
 request.
 


sourceVersion
String sourceVersion

 The version number of the launch template version on which to base the new version. The new version inherits the
 same launch parameters as the source version, except for parameters that you specify in
 LaunchTemplateData. Snapshots applied to the block device mapping are ignored when creating a new
 version unless they are explicitly included.
 


versionDescription
String versionDescription

 A description for the version of the launch template.
 


launchTemplateData
RequestLaunchTemplateData launchTemplateData

 The information for the launch template.
 








Class com.amazonaws.services.ec2.model.CreateLaunchTemplateVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


launchTemplateVersion
LaunchTemplateVersion launchTemplateVersion

 Information about the launch template version.
 








Class com.amazonaws.services.ec2.model.CreateLocalGatewayRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationCidrBlock
String destinationCidrBlock

 The CIDR range used for destination matches. Routing decisions are based on the most specific match.
 


localGatewayRouteTableId
String localGatewayRouteTableId

 The ID of the local gateway route table.
 


localGatewayVirtualInterfaceGroupId
String localGatewayVirtualInterfaceGroupId

 The ID of the virtual interface group.
 








Class com.amazonaws.services.ec2.model.CreateLocalGatewayRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


route
LocalGatewayRoute route

 Information about the route.
 








Class com.amazonaws.services.ec2.model.CreateLocalGatewayRouteTableVpcAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


localGatewayRouteTableId
String localGatewayRouteTableId

 The ID of the local gateway route table.
 


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.CreateLocalGatewayRouteTableVpcAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


localGatewayRouteTableVpcAssociation
LocalGatewayRouteTableVpcAssociation localGatewayRouteTableVpcAssociation

 Information about the association.
 








Class com.amazonaws.services.ec2.model.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 that 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 extends AmazonWebServiceResult<ResponseMetadata> 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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cidrBlock
String cidrBlock

 The IPv4 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 or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6)
 with an IPv6 CIDR block.
 


ipv6CidrBlock
String ipv6CidrBlock

 The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).
 


networkAclId
String networkAclId

 The ID of the network ACL.
 


portRange
PortRange portRange

 TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17
 (UDP).
 


protocol
String protocol

 The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6"
 (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes
 that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP
 types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an
 IPv6 CIDR block, you must specify an ICMP type and code.
 


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. The range 32767 to 65535 is reserved for internal use.
 








Class com.amazonaws.services.ec2.model.CreateNetworkAclEntryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.CreateNetworkAclRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.CreateNetworkAclResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networkAcl
NetworkAcl networkAcl

 Information about the network ACL.
 








Class com.amazonaws.services.ec2.model.CreateNetworkInterfacePermissionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


awsAccountId
String awsAccountId

 The AWS account ID.
 


awsService
String awsService

 The AWS service. Currently not supported.
 


permission
String permission

 The type of permission to grant.
 








Class com.amazonaws.services.ec2.model.CreateNetworkInterfacePermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


interfacePermission
NetworkInterfacePermission interfacePermission

 Information about the permission for the network interface.
 








Class com.amazonaws.services.ec2.model.CreateNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description

 A description for the network interface.
 


groups
SdkInternalList<T> groups

 The IDs of one or more security groups.
 


ipv6AddressCount
Integer ipv6AddressCount

 The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6
 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet
 has the AssignIpv6AddressOnCreation attribute set to true, you can specify
 0 to override this setting.
 


ipv6Addresses
SdkInternalList<T> ipv6Addresses

 One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if
 you're specifying a number of IPv6 addresses.
 


privateIpAddress
String privateIpAddress

 The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2
 selects one for you from the subnet's IPv4 CIDR 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
SdkInternalList<T> privateIpAddresses

 One or more private IPv4 addresses.
 


secondaryPrivateIpAddressCount
Integer secondaryPrivateIpAddressCount

 The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of
 secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR 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 IP Addresses
 Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.
 


interfaceType
String interfaceType

 Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For
 more information, see  Elastic Fabric
 Adapter 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networkInterface
NetworkInterface networkInterface

 Information about the network interface.
 








Class com.amazonaws.services.ec2.model.CreatePlacementGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 A name for the placement group. Must be unique within the scope of your account for the Region.
 
 
 Constraints: Up to 255 ASCII characters
 


strategy
String strategy

 The placement strategy.
 


partitionCount
Integer partitionCount

 The number of partitions. Valid only when Strategy is set to partition.
 








Class com.amazonaws.services.ec2.model.CreatePlacementGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.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
SdkInternalList<T> priceSchedules

 A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance
 term.
 


reservedInstancesId
String reservedInstancesId

 The ID of the active Standard Reserved Instance.
 








Class com.amazonaws.services.ec2.model.CreateReservedInstancesListingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservedInstancesListings
SdkInternalList<T> reservedInstancesListings

 Information about the Standard Reserved Instance listing.
 








Class com.amazonaws.services.ec2.model.CreateRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationCidrBlock
String destinationCidrBlock

 The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific
 match.
 


destinationIpv6CidrBlock
String destinationIpv6CidrBlock

 The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
 


egressOnlyInternetGatewayId
String egressOnlyInternetGatewayId

 [IPv6 traffic only] The ID of an egress-only internet gateway.
 


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

 [IPv4 traffic only] The ID of a NAT gateway.
 


transitGatewayId
String transitGatewayId

 The ID of a transit gateway.
 


localGatewayId
String localGatewayId

 The ID of the local 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.CreateRouteTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.CreateRouteTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


routeTable
RouteTable routeTable

 Information about the route table.
 








Class com.amazonaws.services.ec2.model.CreateSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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. Cannot start with sg-.
 
 
 Constraints for EC2-Classic: ASCII characters
 
 
 Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
 


vpcId
String vpcId

 [EC2-VPC] The ID of the VPC. Required for EC2-VPC.
 








Class com.amazonaws.services.ec2.model.CreateSecurityGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


groupId
String groupId

 The ID of the security group.
 








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


Serialized Fields


description
String description

 A description for the snapshot.
 


volumeId
String volumeId

 The ID of the EBS volume.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the snapshot during creation.
 








Class com.amazonaws.services.ec2.model.CreateSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


snapshot
Snapshot snapshot

 Describes a snapshot.
 








Class com.amazonaws.services.ec2.model.CreateSnapshotsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description

 A description propagated to every snapshot specified by the instance.
 


instanceSpecification
InstanceSpecification instanceSpecification

 The instance to specify which volumes should be included in the snapshots.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 Tags to apply to every snapshot specified by the instance.
 


copyTagsFromSource
String copyTagsFromSource

 Copies the tags from the specified volume to corresponding snapshot.
 








Class com.amazonaws.services.ec2.model.CreateSnapshotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


snapshots
SdkInternalList<T> snapshots

 List of snapshots.
 








Class com.amazonaws.services.ec2.model.CreateSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


bucket
String bucket

 The Amazon S3 bucket in which to store the Spot Instance data feed.
 


prefix
String prefix

 A prefix for the data feed file names.
 








Class com.amazonaws.services.ec2.model.CreateSpotDatafeedSubscriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


spotDatafeedSubscription
SpotDatafeedSubscription spotDatafeedSubscription

 The Spot Instance data feed subscription.
 








Class com.amazonaws.services.ec2.model.CreateSubnetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone or Local Zone for the subnet.
 
 
 Default: AWS selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a
 different zone for each subnet.
 
 
 To create a subnet in a Local Zone, set this value to the Local Zone ID, for example
 us-west-2-lax-1a. For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide.
 


availabilityZoneId
String availabilityZoneId

 The AZ ID or the Local Zone ID of the subnet.
 


cidrBlock
String cidrBlock

 The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.
 


ipv6CidrBlock
String ipv6CidrBlock

 The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
 


outpostArn
String outpostArn

 The Amazon Resource Name (ARN) of the Outpost.
 


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.CreateSubnetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


subnet
Subnet subnet

 Information about the subnet.
 








Class com.amazonaws.services.ec2.model.CreateTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resources
SdkInternalList<T> resources

 The IDs of the resources, separated by spaces.
 
 
 Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
 


tags
SdkInternalList<T> tags

 The 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.CreateTrafficMirrorFilterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description

 The description of the Traffic Mirror filter.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to assign to a Traffic Mirror filter.
 


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.
 








Class com.amazonaws.services.ec2.model.CreateTrafficMirrorFilterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorFilter
TrafficMirrorFilter trafficMirrorFilter

 Information about the Traffic Mirror filter.
 


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.
 








Class com.amazonaws.services.ec2.model.CreateTrafficMirrorFilterRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trafficMirrorFilterId
String trafficMirrorFilterId

 The ID of the filter that this rule is associated with.
 


trafficDirection
String trafficDirection

 The type of traffic (ingress | egress).
 


ruleNumber
Integer ruleNumber

 The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given
 direction. The rules are processed in ascending order by rule number.
 


ruleAction
String ruleAction

 The action to take (accept | reject) on the filtered traffic.
 


destinationPortRange
TrafficMirrorPortRangeRequest destinationPortRange

 The destination port range.
 


sourcePortRange
TrafficMirrorPortRangeRequest sourcePortRange

 The source port range.
 


protocol
Integer protocol

 The protocol, for example UDP, to assign to the Traffic Mirror rule.
 
 
 For information about the protocol value, see Protocol Numbers on the
 Internet Assigned Numbers Authority (IANA) website.
 


destinationCidrBlock
String destinationCidrBlock

 The destination CIDR block to assign to the Traffic Mirror rule.
 


sourceCidrBlock
String sourceCidrBlock

 The source CIDR block to assign to the Traffic Mirror rule.
 


description
String description

 The description of the Traffic Mirror rule.
 


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.
 








Class com.amazonaws.services.ec2.model.CreateTrafficMirrorFilterRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorFilterRule
TrafficMirrorFilterRule trafficMirrorFilterRule

 The Traffic Mirror rule.
 


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.
 








Class com.amazonaws.services.ec2.model.CreateTrafficMirrorSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkInterfaceId
String networkInterfaceId

 The ID of the source network interface.
 


trafficMirrorTargetId
String trafficMirrorTargetId

 The ID of the Traffic Mirror target.
 


trafficMirrorFilterId
String trafficMirrorFilterId

 The ID of the Traffic Mirror filter.
 


packetLength
Integer packetLength

 The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this
 parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in
 bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the
 filter criteria are copied to the target.
 
 
 If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number
 of bytes in each packet to mirror.
 


sessionNumber
Integer sessionNumber

 The session number determines the order in which sessions are evaluated when an interface is used by multiple
 sessions. The first session with a matching filter is the one that mirrors the packets.
 
 
 Valid values are 1-32766.
 


virtualNetworkId
Integer virtualNetworkId

 The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify a VirtualNetworkId,
 an account-wide unique id is chosen at random.
 


description
String description

 The description of the Traffic Mirror session.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to assign to a Traffic Mirror session.
 


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.
 








Class com.amazonaws.services.ec2.model.CreateTrafficMirrorSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorSession
TrafficMirrorSession trafficMirrorSession

 Information about the Traffic Mirror session.
 


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.
 








Class com.amazonaws.services.ec2.model.CreateTrafficMirrorTargetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkInterfaceId
String networkInterfaceId

 The network interface ID that is associated with the target.
 


networkLoadBalancerArn
String networkLoadBalancerArn

 The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.
 


description
String description

 The description of the Traffic Mirror target.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to assign to the Traffic Mirror target.
 


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.
 








Class com.amazonaws.services.ec2.model.CreateTrafficMirrorTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorTarget
TrafficMirrorTarget trafficMirrorTarget

 Information about the Traffic Mirror target.
 


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.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayMulticastDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayId
String transitGatewayId

 The ID of the transit gateway.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags for the transit gateway multicast domain.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayMulticastDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayMulticastDomain
TransitGatewayMulticastDomain transitGatewayMulticastDomain

 Information about the transit gateway multicast domain.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayPeeringAttachmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayId
String transitGatewayId

 The ID of the transit gateway.
 


peerTransitGatewayId
String peerTransitGatewayId

 The ID of the peer transit gateway with which to create the peering attachment.
 


peerAccountId
String peerAccountId

 The AWS account ID of the owner of the peer transit gateway.
 


peerRegion
String peerRegion

 The Region where the peer transit gateway is located.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the transit gateway peering attachment.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayPeeringAttachmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayPeeringAttachment
TransitGatewayPeeringAttachment transitGatewayPeeringAttachment

 The transit gateway peering attachment.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description

 A description of the transit gateway.
 


options
TransitGatewayRequestOptions options

 The transit gateway options.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the transit gateway.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGateway
TransitGateway transitGateway

 Information about the transit gateway.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationCidrBlock
String destinationCidrBlock

 The CIDR range used for destination matches. Routing decisions are based on the most specific match.
 


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the transit gateway route table.
 


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 


blackhole
Boolean blackhole

 Indicates whether to drop traffic that matches this route.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


route
TransitGatewayRoute route

 Information about the route.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayRouteTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayId
String transitGatewayId

 The ID of the transit gateway.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the transit gateway route table.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayRouteTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayRouteTable
TransitGatewayRouteTable transitGatewayRouteTable

 Information about the transit gateway route table.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayVpcAttachmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayId
String transitGatewayId

 The ID of the transit gateway.
 


vpcId
String vpcId

 The ID of the VPC.
 


subnetIds
SdkInternalList<T> subnetIds

 The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least
 one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one
 IP address from each specified subnet.
 


options
CreateTransitGatewayVpcAttachmentRequestOptions options

 The VPC attachment options.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the VPC attachment.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayVpcAttachmentRequestOptions extends Object implements Serializable


Serialized Fields


dnsSupport
String dnsSupport

 Enable or disable DNS support. The default is enable.
 


ipv6Support
String ipv6Support

 Enable or disable IPv6 support. The default is enable.
 








Class com.amazonaws.services.ec2.model.CreateTransitGatewayVpcAttachmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayVpcAttachment
TransitGatewayVpcAttachment transitGatewayVpcAttachment

 Information about the VPC attachment.
 








Class com.amazonaws.services.ec2.model.CreateVolumePermission extends Object implements Serializable


Serialized Fields


group
String group

 The group to be added or removed. The possible value is all.
 


userId
String userId

 The AWS account ID to be added or removed.
 








Class com.amazonaws.services.ec2.model.CreateVolumePermissionModifications extends Object implements Serializable


Serialized Fields


add
SdkInternalList<T> add

 Adds the specified AWS account ID or group to the list.
 


remove
SdkInternalList<T> remove

 Removes the specified AWS account ID or group from the list.
 








Class com.amazonaws.services.ec2.model.CreateVolumeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone in which to create the volume.
 


encrypted
Boolean encrypted

 Specifies whether the volume should be encrypted. The effect of setting the encryption state to true
 depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether
 encryption by default is enabled. For more information, see Encryption by
 Default in the Amazon Elastic Compute Cloud User Guide.
 
 
 Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more
 information, see Supported Instance Types.
 


iops
Integer iops

 The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB.
 Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based
 instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the
 Amazon Elastic Compute Cloud User Guide.
 
 
 This parameter is valid only for Provisioned IOPS SSD (io1) volumes.
 


kmsKeyId
String kmsKeyId

 The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS
 encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is
 specified, the encrypted state must be true.
 
 
 You can specify the CMK using any of the following:
 
 
 
 
 Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
 
 
 
 
 Key alias. For example, alias/ExampleAlias.
 
 
 
 
 Key ARN. For example,
 arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
 
 
 
 
 Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
 
 
 
 
 AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the
 action can appear to complete, but eventually fails.
 


outpostArn
String outpostArn

 The Amazon Resource Name (ARN) of the Outpost.
 


size
Integer size

 The size of the volume, in GiBs.
 
 
 Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1,
 500-16,384 for sc1, and 1-1,024 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.
 
 
 
 At least one of Size or SnapshotId is required.
 
 


snapshotId
String snapshotId

 The snapshot from which to create the volume.
 
 
 
 At least one of Size or SnapshotId are required.
 
 


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


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the volume during creation.
 








Class com.amazonaws.services.ec2.model.CreateVolumeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


volume
Volume volume

 Describes a volume.
 








Class com.amazonaws.services.ec2.model.CreateVpcEndpointConnectionNotificationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceId
String serviceId

 The ID of the endpoint service.
 


vpcEndpointId
String vpcEndpointId

 The ID of the endpoint.
 


connectionNotificationArn
String connectionNotificationArn

 The ARN of the SNS topic for the notifications.
 


connectionEvents
SdkInternalList<T> connectionEvents

 One or more endpoint events for which to receive notifications. Valid values are Accept,
 Connect, Delete, and Reject.
 


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.
 








Class com.amazonaws.services.ec2.model.CreateVpcEndpointConnectionNotificationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectionNotification
ConnectionNotification connectionNotification

 Information about the notification.
 


clientToken
String clientToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 








Class com.amazonaws.services.ec2.model.CreateVpcEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcEndpointType
String vpcEndpointType

 The type of endpoint.
 
 
 Default: Gateway
 


vpcId
String vpcId

 The ID of the VPC in which the endpoint will be used.
 


serviceName
String serviceName

 The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get
 the name from the service provider.
 


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
SdkInternalList<T> routeTableIds

 (Gateway endpoint) One or more route table IDs.
 


subnetIds
SdkInternalList<T> subnetIds

 (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.
 


securityGroupIds
SdkInternalList<T> securityGroupIds

 (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.
 


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.
 


privateDnsEnabled
Boolean privateDnsEnabled

 (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private
 hosted zone contains a record set for the default public DNS name for the service for the Region (for example,
 kinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses of the endpoint network
 interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead
 of the public DNS names that are automatically generated by the VPC endpoint service.
 
 
 To use a private hosted zone, you must set the following VPC attributes to true:
 enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC
 attributes.
 
 
 Default: true
 








Class com.amazonaws.services.ec2.model.CreateVpcEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcEndpoint
VpcEndpoint vpcEndpoint

 Information about the endpoint.
 


clientToken
String clientToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 








Class com.amazonaws.services.ec2.model.CreateVpcEndpointServiceConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


acceptanceRequired
Boolean acceptanceRequired

 Indicates whether requests from service consumers to create an endpoint to your service must be accepted. To
 accept a request, use AcceptVpcEndpointConnections.
 


privateDnsName
String privateDnsName

 The private DNS name to assign to the VPC endpoint service.
 


networkLoadBalancerArns
SdkInternalList<T> networkLoadBalancerArns

 The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.
 


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.
 








Class com.amazonaws.services.ec2.model.CreateVpcEndpointServiceConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serviceConfiguration
ServiceConfiguration serviceConfiguration

 Information about the service configuration.
 


clientToken
String clientToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 








Class com.amazonaws.services.ec2.model.CreateVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


peerOwnerId
String peerOwnerId

 The AWS account ID of the owner of the accepter VPC.
 
 
 Default: Your AWS account ID
 


peerVpcId
String peerVpcId

 The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the
 request.
 


vpcId
String vpcId

 The ID of the requester VPC. You must specify this parameter in the request.
 


peerRegion
String peerRegion

 The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which
 you make the request.
 
 
 Default: The Region in which you make the request.
 








Class com.amazonaws.services.ec2.model.CreateVpcPeeringConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcPeeringConnection
VpcPeeringConnection vpcPeeringConnection

 Information about the VPC peering connection.
 








Class com.amazonaws.services.ec2.model.CreateVpcRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cidrBlock
String cidrBlock

 The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.
 


amazonProvidedIpv6CidrBlock
Boolean amazonProvidedIpv6CidrBlock

 Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of
 IP addresses, or the size of the CIDR block.
 


ipv6Pool
String ipv6Pool

 The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
 


ipv6CidrBlock
String ipv6CidrBlock

 The IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.
 
 
 To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
 


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
 


ipv6CidrBlockNetworkBorderGroup
String ipv6CidrBlockNetworkBorderGroup

 The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to
 this location.
 
 
 You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.
 








Class com.amazonaws.services.ec2.model.CreateVpcResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpc
Vpc vpc

 Information about the VPC.
 








Class com.amazonaws.services.ec2.model.CreateVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


customerGatewayId
String customerGatewayId

 The ID of the customer gateway.
 


type
String type

 The type of VPN connection (ipsec.1).
 


vpnGatewayId
String vpnGatewayId

 The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit
 gateway.
 


transitGatewayId
String transitGatewayId

 The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.
 


options
VpnConnectionOptionsSpecification options

 The options for the VPN connection.
 








Class com.amazonaws.services.ec2.model.CreateVpnConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpnConnection
VpnConnection vpnConnection

 Information about the VPN connection.
 








Class com.amazonaws.services.ec2.model.CreateVpnConnectionRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.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.
 


amazonSideAsn
Long amazonSideAsn

 A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it
 must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294
 range.
 
 
 Default: 64512
 








Class com.amazonaws.services.ec2.model.CreateVpnGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpnGateway
VpnGateway vpnGateway

 Information about the virtual private gateway.
 








Class com.amazonaws.services.ec2.model.CreditSpecification extends Object implements Serializable


Serialized Fields


cpuCredits
String cpuCredits

 The credit option for CPU usage of a T2 or T3 instance. Valid values are standard and
 unlimited.
 








Class com.amazonaws.services.ec2.model.CreditSpecificationRequest extends Object implements Serializable


Serialized Fields


cpuCredits
String cpuCredits

 The credit option for CPU usage of a T2 or T3 instance. Valid values are standard and
 unlimited.
 








Class com.amazonaws.services.ec2.model.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.
 


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) for the customer gateway certificate.
 


state
String state

 The current state of the customer gateway (pending | available | deleting | deleted).
 


type
String type

 The type of VPN connection the customer gateway supports (ipsec.1).
 


deviceName
String deviceName

 The name of customer gateway device.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the customer gateway.
 








Class com.amazonaws.services.ec2.model.DeleteClientVpnEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN to be deleted.
 








Class com.amazonaws.services.ec2.model.DeleteClientVpnEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
ClientVpnEndpointStatus status

 The current state of the Client VPN endpoint.
 








Class com.amazonaws.services.ec2.model.DeleteClientVpnRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint from which the route is to be deleted.
 


targetVpcSubnetId
String targetVpcSubnetId

 The ID of the target subnet used by the route.
 


destinationCidrBlock
String destinationCidrBlock

 The IPv4 address range, in CIDR notation, of the route to be deleted.
 








Class com.amazonaws.services.ec2.model.DeleteClientVpnRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
ClientVpnRouteStatus status

 The current state of the route.
 








Class com.amazonaws.services.ec2.model.DeleteCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


customerGatewayId
String customerGatewayId

 The ID of the customer gateway.
 








Class com.amazonaws.services.ec2.model.DeleteCustomerGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dhcpOptionsId
String dhcpOptionsId

 The ID of the DHCP options set.
 








Class com.amazonaws.services.ec2.model.DeleteDhcpOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteEgressOnlyInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


egressOnlyInternetGatewayId
String egressOnlyInternetGatewayId

 The ID of the egress-only internet gateway.
 








Class com.amazonaws.services.ec2.model.DeleteEgressOnlyInternetGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnCode
Boolean returnCode

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.DeleteFleetError 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.DeleteFleetErrorItem extends Object implements Serializable


Serialized Fields


error
DeleteFleetError error

 The error.
 


fleetId
String fleetId

 The ID of the EC2 Fleet.
 








Class com.amazonaws.services.ec2.model.DeleteFleetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetIds
SdkInternalList<T> fleetIds

 The IDs of the EC2 Fleets.
 


terminateInstances
Boolean terminateInstances

 Indicates whether to terminate instances for an EC2 Fleet if it is deleted successfully.
 








Class com.amazonaws.services.ec2.model.DeleteFleetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successfulFleetDeletions
SdkInternalList<T> successfulFleetDeletions

 Information about the EC2 Fleets that are successfully deleted.
 


unsuccessfulFleetDeletions
SdkInternalList<T> unsuccessfulFleetDeletions

 Information about the EC2 Fleets that are not successfully deleted.
 








Class com.amazonaws.services.ec2.model.DeleteFleetSuccessItem extends Object implements Serializable


Serialized Fields


currentFleetState
String currentFleetState

 The current state of the EC2 Fleet.
 


previousFleetState
String previousFleetState

 The previous state of the EC2 Fleet.
 


fleetId
String fleetId

 The ID of the EC2 Fleet.
 








Class com.amazonaws.services.ec2.model.DeleteFlowLogsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowLogIds
SdkInternalList<T> flowLogIds

 One or more flow log IDs.
 
 
 Constraint: Maximum of 1000 flow log IDs.
 








Class com.amazonaws.services.ec2.model.DeleteFlowLogsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unsuccessful
SdkInternalList<T> unsuccessful

 Information about the flow logs that could not be deleted successfully.
 








Class com.amazonaws.services.ec2.model.DeleteFpgaImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fpgaImageId
String fpgaImageId

 The ID of the AFI.
 








Class com.amazonaws.services.ec2.model.DeleteFpgaImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Is true if the request succeeds, and an error otherwise.
 








Class com.amazonaws.services.ec2.model.DeleteInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


internetGatewayId
String internetGatewayId

 The ID of the internet gateway.
 








Class com.amazonaws.services.ec2.model.DeleteInternetGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteKeyPairRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyName
String keyName

 The name of the key pair.
 








Class com.amazonaws.services.ec2.model.DeleteKeyPairResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteLaunchTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


launchTemplateId
String launchTemplateId

 The ID of the launch template. You must specify either the launch template ID or launch template name in the
 request.
 


launchTemplateName
String launchTemplateName

 The name of the launch template. You must specify either the launch template ID or launch template name in the
 request.
 








Class com.amazonaws.services.ec2.model.DeleteLaunchTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


launchTemplate
LaunchTemplate launchTemplate

 Information about the launch template.
 








Class com.amazonaws.services.ec2.model.DeleteLaunchTemplateVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


launchTemplateId
String launchTemplateId

 The ID of the launch template. You must specify either the launch template ID or launch template name in the
 request.
 


launchTemplateName
String launchTemplateName

 The name of the launch template. You must specify either the launch template ID or launch template name in the
 request.
 


versions
SdkInternalList<T> versions

 The version numbers of one or more launch template versions to delete.
 








Class com.amazonaws.services.ec2.model.DeleteLaunchTemplateVersionsResponseErrorItem extends Object implements Serializable


Serialized Fields


launchTemplateId
String launchTemplateId

 The ID of the launch template.
 


launchTemplateName
String launchTemplateName

 The name of the launch template.
 


versionNumber
Long versionNumber

 The version number of the launch template.
 


responseError
ResponseError responseError

 Information about the error.
 








Class com.amazonaws.services.ec2.model.DeleteLaunchTemplateVersionsResponseSuccessItem extends Object implements Serializable


Serialized Fields


launchTemplateId
String launchTemplateId

 The ID of the launch template.
 


launchTemplateName
String launchTemplateName

 The name of the launch template.
 


versionNumber
Long versionNumber

 The version number of the launch template.
 








Class com.amazonaws.services.ec2.model.DeleteLaunchTemplateVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successfullyDeletedLaunchTemplateVersions
SdkInternalList<T> successfullyDeletedLaunchTemplateVersions

 Information about the launch template versions that were successfully deleted.
 


unsuccessfullyDeletedLaunchTemplateVersions
SdkInternalList<T> unsuccessfullyDeletedLaunchTemplateVersions

 Information about the launch template versions that could not be deleted.
 








Class com.amazonaws.services.ec2.model.DeleteLocalGatewayRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationCidrBlock
String destinationCidrBlock

 The CIDR range for the route. This must match the CIDR for the route exactly.
 


localGatewayRouteTableId
String localGatewayRouteTableId

 The ID of the local gateway route table.
 








Class com.amazonaws.services.ec2.model.DeleteLocalGatewayRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


route
LocalGatewayRoute route

 Information about the route.
 








Class com.amazonaws.services.ec2.model.DeleteLocalGatewayRouteTableVpcAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


localGatewayRouteTableVpcAssociationId
String localGatewayRouteTableVpcAssociationId

 The ID of the association.
 








Class com.amazonaws.services.ec2.model.DeleteLocalGatewayRouteTableVpcAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


localGatewayRouteTableVpcAssociation
LocalGatewayRouteTableVpcAssociation localGatewayRouteTableVpcAssociation

 Information about the association.
 








Class com.amazonaws.services.ec2.model.DeleteNatGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


natGatewayId
String natGatewayId

 The ID of the NAT gateway.
 








Class com.amazonaws.services.ec2.model.DeleteNatGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


natGatewayId
String natGatewayId

 The ID of the NAT gateway.
 








Class com.amazonaws.services.ec2.model.DeleteNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteNetworkAclRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkAclId
String networkAclId

 The ID of the network ACL.
 








Class com.amazonaws.services.ec2.model.DeleteNetworkAclResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteNetworkInterfacePermissionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkInterfacePermissionId
String networkInterfacePermissionId

 The ID of the network interface permission.
 


force
Boolean force

 Specify true to remove the permission even if the network interface is attached to an instance.
 








Class com.amazonaws.services.ec2.model.DeleteNetworkInterfacePermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds, otherwise returns an error.
 








Class com.amazonaws.services.ec2.model.DeleteNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 








Class com.amazonaws.services.ec2.model.DeleteNetworkInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeletePlacementGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name of the placement group.
 








Class com.amazonaws.services.ec2.model.DeletePlacementGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteQueuedReservedInstancesError extends Object implements Serializable


Serialized Fields


code
String code

 The error code.
 


message
String message

 The error message.
 








Class com.amazonaws.services.ec2.model.DeleteQueuedReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reservedInstancesIds
SdkInternalList<T> reservedInstancesIds

 The IDs of the Reserved Instances.
 








Class com.amazonaws.services.ec2.model.DeleteQueuedReservedInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successfulQueuedPurchaseDeletions
SdkInternalList<T> successfulQueuedPurchaseDeletions

 Information about the queued purchases that were successfully deleted.
 


failedQueuedPurchaseDeletions
SdkInternalList<T> failedQueuedPurchaseDeletions

 Information about the queued purchases that could not be deleted.
 








Class com.amazonaws.services.ec2.model.DeleteRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationCidrBlock
String destinationCidrBlock

 The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
 


destinationIpv6CidrBlock
String destinationIpv6CidrBlock

 The IPv6 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteRouteTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


routeTableId
String routeTableId

 The ID of the route table.
 








Class com.amazonaws.services.ec2.model.DeleteRouteTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


snapshotId
String snapshotId

 The ID of the EBS snapshot.
 








Class com.amazonaws.services.ec2.model.DeleteSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.ec2.model.DeleteSpotDatafeedSubscriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteSubnetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subnetId
String subnetId

 The ID of the subnet.
 








Class com.amazonaws.services.ec2.model.DeleteSubnetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resources
SdkInternalList<T> resources

 The IDs of the resources, separated by spaces.
 
 
 Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
 


tags
SdkInternalList<T> tags

 The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key
 without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an
 empty string as the tag value, we delete the tag only if its value is an empty string.
 
 
 If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete
 AWS-generated tags (tags that have the aws: prefix).
 








Class com.amazonaws.services.ec2.model.DeleteTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteTrafficMirrorFilterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trafficMirrorFilterId
String trafficMirrorFilterId

 The ID of the Traffic Mirror filter.
 








Class com.amazonaws.services.ec2.model.DeleteTrafficMirrorFilterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorFilterId
String trafficMirrorFilterId

 The ID of the Traffic Mirror filter.
 








Class com.amazonaws.services.ec2.model.DeleteTrafficMirrorFilterRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trafficMirrorFilterRuleId
String trafficMirrorFilterRuleId

 The ID of the Traffic Mirror rule.
 








Class com.amazonaws.services.ec2.model.DeleteTrafficMirrorFilterRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorFilterRuleId
String trafficMirrorFilterRuleId

 The ID of the deleted Traffic Mirror rule.
 








Class com.amazonaws.services.ec2.model.DeleteTrafficMirrorSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trafficMirrorSessionId
String trafficMirrorSessionId

 The ID of the Traffic Mirror session.
 








Class com.amazonaws.services.ec2.model.DeleteTrafficMirrorSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorSessionId
String trafficMirrorSessionId

 The ID of the deleted Traffic Mirror session.
 








Class com.amazonaws.services.ec2.model.DeleteTrafficMirrorTargetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trafficMirrorTargetId
String trafficMirrorTargetId

 The ID of the Traffic Mirror target.
 








Class com.amazonaws.services.ec2.model.DeleteTrafficMirrorTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorTargetId
String trafficMirrorTargetId

 The ID of the deleted Traffic Mirror target.
 








Class com.amazonaws.services.ec2.model.DeleteTransitGatewayMulticastDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 








Class com.amazonaws.services.ec2.model.DeleteTransitGatewayMulticastDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayMulticastDomain
TransitGatewayMulticastDomain transitGatewayMulticastDomain

 Information about the deleted transit gateway multicast domain.
 








Class com.amazonaws.services.ec2.model.DeleteTransitGatewayPeeringAttachmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the transit gateway peering attachment.
 








Class com.amazonaws.services.ec2.model.DeleteTransitGatewayPeeringAttachmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayPeeringAttachment
TransitGatewayPeeringAttachment transitGatewayPeeringAttachment

 The transit gateway peering attachment.
 








Class com.amazonaws.services.ec2.model.DeleteTransitGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayId
String transitGatewayId

 The ID of the transit gateway.
 








Class com.amazonaws.services.ec2.model.DeleteTransitGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGateway
TransitGateway transitGateway

 Information about the deleted transit gateway.
 








Class com.amazonaws.services.ec2.model.DeleteTransitGatewayRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the transit gateway route table.
 


destinationCidrBlock
String destinationCidrBlock

 The CIDR range for the route. This must match the CIDR for the route exactly.
 








Class com.amazonaws.services.ec2.model.DeleteTransitGatewayRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


route
TransitGatewayRoute route

 Information about the route.
 








Class com.amazonaws.services.ec2.model.DeleteTransitGatewayRouteTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the transit gateway route table.
 








Class com.amazonaws.services.ec2.model.DeleteTransitGatewayRouteTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayRouteTable
TransitGatewayRouteTable transitGatewayRouteTable

 Information about the deleted transit gateway route table.
 








Class com.amazonaws.services.ec2.model.DeleteTransitGatewayVpcAttachmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 








Class com.amazonaws.services.ec2.model.DeleteTransitGatewayVpcAttachmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayVpcAttachment
TransitGatewayVpcAttachment transitGatewayVpcAttachment

 Information about the deleted VPC attachment.
 








Class com.amazonaws.services.ec2.model.DeleteVolumeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


volumeId
String volumeId

 The ID of the volume.
 








Class com.amazonaws.services.ec2.model.DeleteVolumeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteVpcEndpointConnectionNotificationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionNotificationIds
SdkInternalList<T> connectionNotificationIds

 One or more notification IDs.
 








Class com.amazonaws.services.ec2.model.DeleteVpcEndpointConnectionNotificationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unsuccessful
SdkInternalList<T> unsuccessful

 Information about the notifications that could not be deleted successfully.
 








Class com.amazonaws.services.ec2.model.DeleteVpcEndpointServiceConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceIds
SdkInternalList<T> serviceIds

 The IDs of one or more services.
 








Class com.amazonaws.services.ec2.model.DeleteVpcEndpointServiceConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unsuccessful
SdkInternalList<T> unsuccessful

 Information about the service configurations that were not deleted, if applicable.
 








Class com.amazonaws.services.ec2.model.DeleteVpcEndpointsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcEndpointIds
SdkInternalList<T> vpcEndpointIds

 One or more VPC endpoint IDs.
 








Class com.amazonaws.services.ec2.model.DeleteVpcEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unsuccessful
SdkInternalList<T> unsuccessful

 Information about the VPC endpoints that were not successfully deleted.
 








Class com.amazonaws.services.ec2.model.DeleteVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcPeeringConnectionId
String vpcPeeringConnectionId

 The ID of the VPC peering connection.
 








Class com.amazonaws.services.ec2.model.DeleteVpcPeeringConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.DeleteVpcRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.DeleteVpcResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpnConnectionId
String vpnConnectionId

 The ID of the VPN connection.
 








Class com.amazonaws.services.ec2.model.DeleteVpnConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeleteVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpnGatewayId
String vpnGatewayId

 The ID of the virtual private gateway.
 








Class com.amazonaws.services.ec2.model.DeleteVpnGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeprovisionByoipCidrRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cidr
String cidr

 The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned
 the address range.
 








Class com.amazonaws.services.ec2.model.DeprovisionByoipCidrResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


byoipCidr
ByoipCidr byoipCidr

 Information about the address range.
 








Class com.amazonaws.services.ec2.model.DeregisterImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageId
String imageId

 The ID of the AMI.
 








Class com.amazonaws.services.ec2.model.DeregisterImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DeregisterTransitGatewayMulticastGroupMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


groupIpAddress
String groupIpAddress

 The IP address assigned to the transit gateway multicast group.
 


networkInterfaceIds
SdkInternalList<T> networkInterfaceIds

 The IDs of the group members' network interfaces.
 








Class com.amazonaws.services.ec2.model.DeregisterTransitGatewayMulticastGroupMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deregisteredMulticastGroupMembers
TransitGatewayMulticastDeregisteredGroupMembers deregisteredMulticastGroupMembers

 Information about the deregistered members.
 








Class com.amazonaws.services.ec2.model.DeregisterTransitGatewayMulticastGroupSourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


groupIpAddress
String groupIpAddress

 The IP address assigned to the transit gateway multicast group.
 


networkInterfaceIds
SdkInternalList<T> networkInterfaceIds

 The IDs of the group sources' network interfaces.
 








Class com.amazonaws.services.ec2.model.DeregisterTransitGatewayMulticastGroupSourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deregisteredMulticastGroupSources
TransitGatewayMulticastDeregisteredGroupSources deregisteredMulticastGroupSources

 Information about the deregistered group sources.
 








Class com.amazonaws.services.ec2.model.DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


attributeNames
SdkInternalList<T> attributeNames

 The account attribute names.
 








Class com.amazonaws.services.ec2.model.DescribeAccountAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accountAttributes
SdkInternalList<T> accountAttributes

 Information about the account attributes.
 








Class com.amazonaws.services.ec2.model.DescribeAddressesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters. Filter names and values are case-sensitive.
 
 
 
 
 allocation-id - [EC2-VPC] The allocation ID for the address.
 
 
 
 
 association-id - [EC2-VPC] The association ID for the address.
 
 
 
 
 domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC
 (vpc).
 
 
 
 
 instance-id - The ID of the instance the address is associated with, if any.
 
 
 
 
 network-border-group - The location from where the IP address is advertised.
 
 
 
 
 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.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 


publicIps
SdkInternalList<T> publicIps

 One or more Elastic IP addresses.
 
 
 Default: Describes all your Elastic IP addresses.
 


allocationIds
SdkInternalList<T> allocationIds

 [EC2-VPC] Information about the allocation IDs.
 








Class com.amazonaws.services.ec2.model.DescribeAddressesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


addresses
SdkInternalList<T> addresses

 Information about the Elastic IP addresses.
 








Class com.amazonaws.services.ec2.model.DescribeAggregateIdFormatRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.ec2.model.DescribeAggregateIdFormatResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


useLongIdsAggregated
Boolean useLongIdsAggregated

 Indicates whether all resource types in the Region are configured to use longer IDs. This value is only
 true if all users are configured to use longer IDs for all resources types in the Region.
 


statuses
SdkInternalList<T> statuses

 Information about each resource's ID format.
 








Class com.amazonaws.services.ec2.model.DescribeAvailabilityZonesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group
 associated with the Local Zone (for example, us-west-2-lax-1).
 
 
 
 
 message - The Availability Zone or Local Zone message.
 
 
 
 
 opt-in-status - The opt in status (opted-in, and not-opted-in |
 opt-in-not-required).
 
 
 
 
 region-name - The name of the Region for the Availability Zone or Local Zone (for example,
 us-east-1).
 
 
 
 
 state - The state of the Availability Zone or Local Zone (available |
 information | impaired | unavailable).
 
 
 
 
 zone-id - The ID of the Availability Zone (for example, use1-az1) or the Local Zone
 (for example, use usw2-lax1-az1).
 
 
 
 
 zone-name - The name of the Availability Zone (for example, us-east-1a) or the Local
 Zone (for example, use us-west-2-lax-1a).
 
 
 


zoneNames
SdkInternalList<T> zoneNames

 The names of the Availability Zones and Local Zones.
 


zoneIds
SdkInternalList<T> zoneIds

 The IDs of the Availability Zones and Local Zones.
 


allAvailabilityZones
Boolean allAvailabilityZones

 Include all Availability Zones and Local Zones regardless of your opt in status.
 
 
 If you do not use this parameter, the results include only the zones for the Regions where you have chosen the
 option to opt in.
 








Class com.amazonaws.services.ec2.model.DescribeAvailabilityZonesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


availabilityZones
SdkInternalList<T> availabilityZones

 Information about the Availability Zones and Local Zones.
 








Class com.amazonaws.services.ec2.model.DescribeBundleTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


bundleIds
SdkInternalList<T> bundleIds

 The bundle task IDs.
 
 
 Default: Describes all your bundle tasks.
 


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 bundle-id - The ID of the bundle task.
 
 
 
 
 error-code - If the task failed, the error code returned.
 
 
 
 
 error-message - If the task failed, the error message returned.
 
 
 
 
 instance-id - The ID of the instance.
 
 
 
 
 progress - The level of task completion, as a percentage (for example, 20%).
 
 
 
 
 s3-bucket - The Amazon S3 bucket to store the AMI.
 
 
 
 
 s3-prefix - The beginning of the AMI name.
 
 
 
 
 start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
 
 
 
 
 state - The state of the task (pending | waiting-for-shutdown |
 bundling | storing | cancelling | complete |
 failed).
 
 
 
 
 update-time - The time of the most recent update for the task.
 
 
 








Class com.amazonaws.services.ec2.model.DescribeBundleTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bundleTasks
SdkInternalList<T> bundleTasks

 Information about the bundle tasks.
 








Class com.amazonaws.services.ec2.model.DescribeByoipCidrsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeByoipCidrsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


byoipCidrs
SdkInternalList<T> byoipCidrs

 Information about your address ranges.
 


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.DescribeCapacityReservationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


capacityReservationIds
SdkInternalList<T> capacityReservationIds

 The ID of the Capacity Reservation.
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return for the request in a single page. The remaining results can be seen by
 sending another request with the returned nextToken value.
 


filters
SdkInternalList<T> filters

 One or more filters.
 








Class com.amazonaws.services.ec2.model.DescribeCapacityReservationsResult extends AmazonWebServiceResult<ResponseMetadata> 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.
 


capacityReservations
SdkInternalList<T> capacityReservations

 Information about the Capacity Reservations.
 








Class com.amazonaws.services.ec2.model.DescribeClassicLinkInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 group-id - The ID of a VPC security group that's associated with the instance.
 
 
 
 
 instance-id - The ID of the instance.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 vpc-id - The ID of the VPC to which the instance is linked.
 
 
 vpc-id - The ID of the VPC that the instance is linked to.
 
 
 


instanceIds
SdkInternalList<T> 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 with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 
 
 Constraint: If the value is greater than 1000, we return only 1000 items.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeClassicLinkInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instances
SdkInternalList<T> instances

 Information about one or more linked EC2-Classic instances.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. This value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeClientVpnAuthorizationRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint.
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 


filters
SdkInternalList<T> filters

 One or more filters. Filter names and values are case-sensitive.
 
 
 
 
 description - The description of the authorization rule.
 
 
 
 
 destination-cidr - The CIDR of the network to which the authorization rule applies.
 
 
 
 
 group-id - The ID of the Active Directory group to which the authorization rule grants access.
 
 
 


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








Class com.amazonaws.services.ec2.model.DescribeClientVpnAuthorizationRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


authorizationRules
SdkInternalList<T> authorizationRules

 Information about the authorization rules.
 


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.DescribeClientVpnConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint.
 


filters
SdkInternalList<T> filters

 One or more filters. Filter names and values are case-sensitive.
 
 
 
 
 connection-id - The ID of the connection.
 
 
 
 
 username - For Active Directory client authentication, the user name of the client who established
 the client connection.
 
 
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return for the request in a single page. The remaining results can be seen by
 sending another request with the nextToken value.
 








Class com.amazonaws.services.ec2.model.DescribeClientVpnConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connections
SdkInternalList<T> connections

 Information about the active and terminated client connections.
 


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.DescribeClientVpnEndpointsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointIds
SdkInternalList<T> clientVpnEndpointIds

 The ID of the Client VPN endpoint.
 


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


nextToken
String nextToken

 The token to retrieve the next page of results.
 


filters
SdkInternalList<T> filters

 One or more filters. Filter names and values are case-sensitive.
 
 
 
 
 endpoint-id - The ID of the Client VPN endpoint.
 
 
 
 
 transport-protocol - The transport protocol (tcp | udp).
 
 
 








Class com.amazonaws.services.ec2.model.DescribeClientVpnEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientVpnEndpoints
SdkInternalList<T> clientVpnEndpoints

 Information about the Client VPN endpoints.
 


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.DescribeClientVpnRoutesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint.
 


filters
SdkInternalList<T> filters

 One or more filters. Filter names and values are case-sensitive.
 
 
 
 
 destination-cidr - The CIDR of the route destination.
 
 
 
 
 origin - How the route was associated with the Client VPN endpoint (associate |
 add-route).
 
 
 
 
 target-subnet - The ID of the subnet through which traffic is routed.
 
 
 


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


nextToken
String nextToken

 The token to retrieve the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeClientVpnRoutesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


routes
SdkInternalList<T> routes

 Information about the Client VPN endpoint routes.
 


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.DescribeClientVpnTargetNetworksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint.
 


associationIds
SdkInternalList<T> associationIds

 The IDs of the target network associations.
 


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


nextToken
String nextToken

 The token to retrieve the next page of results.
 


filters
SdkInternalList<T> filters

 One or more filters. Filter names and values are case-sensitive.
 
 
 
 
 association-id - The ID of the association.
 
 
 
 
 target-network-id - The ID of the subnet specified as the target network.
 
 
 
 
 vpc-id - The ID of the VPC in which the target network is located.
 
 
 








Class com.amazonaws.services.ec2.model.DescribeClientVpnTargetNetworksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientVpnTargetNetworks
SdkInternalList<T> clientVpnTargetNetworks

 Information about the associated target networks.
 


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.DescribeCoipPoolsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


poolIds
SdkInternalList<T> poolIds

 The IDs of the address pools.
 


filters
SdkInternalList<T> filters

 The filters. The following are the possible values:
 
 
 
 
 coip-pool.pool-id
 
 
 
 
 
 
 coip-pool.local-gateway-route-table-id
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeCoipPoolsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


coipPools
SdkInternalList<T> coipPools

 Information about the address pools.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. This value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeConversionTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


conversionTaskIds
SdkInternalList<T> conversionTaskIds

 The conversion task IDs.
 








Class com.amazonaws.services.ec2.model.DescribeConversionTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


conversionTasks
SdkInternalList<T> conversionTasks

 Information about the conversion tasks.
 








Class com.amazonaws.services.ec2.model.DescribeCustomerGatewaysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


customerGatewayIds
SdkInternalList<T> customerGatewayIds

 One or more customer gateway IDs.
 
 
 Default: Describes all your customer gateways.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
 
 
 
 
 customer-gateway-id - The ID of the customer gateway.
 
 
 
 
 ip-address - The IP address of the customer gateway's Internet-routable external interface.
 
 
 
 
 state - The state of the customer gateway (pending | available |
 deleting | deleted).
 
 
 
 
 type - The type of customer gateway. Currently, the only supported type is ipsec.1.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 








Class com.amazonaws.services.ec2.model.DescribeCustomerGatewaysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


customerGateways
SdkInternalList<T> customerGateways

 Information about one or more customer gateways.
 








Class com.amazonaws.services.ec2.model.DescribeDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dhcpOptionsIds
SdkInternalList<T> dhcpOptionsIds

 The IDs of one or more DHCP options sets.
 
 
 Default: Describes all your DHCP options sets.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 dhcp-options-id - The ID of a DHCP options set.
 
 
 
 
 key - The key for one of the options (for example, domain-name).
 
 
 
 
 value - The value for one of the options.
 
 
 
 
 owner-id - The ID of the AWS account that owns the DHCP options set.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 


nextToken
String nextToken

 The token for the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 








Class com.amazonaws.services.ec2.model.DescribeDhcpOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dhcpOptions
SdkInternalList<T> dhcpOptions

 Information about one or more DHCP options sets.
 


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.DescribeEgressOnlyInternetGatewaysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


egressOnlyInternetGatewayIds
SdkInternalList<T> egressOnlyInternetGatewayIds

 One or more egress-only internet gateway IDs.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 








Class com.amazonaws.services.ec2.model.DescribeEgressOnlyInternetGatewaysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


egressOnlyInternetGateways
SdkInternalList<T> egressOnlyInternetGateways

 Information about the egress-only internet 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.DescribeElasticGpusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


elasticGpuIds
SdkInternalList<T> elasticGpuIds

 The Elastic Graphics accelerator IDs.
 


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides.
 
 
 
 
 elastic-gpu-health - The status of the Elastic Graphics accelerator (OK |
 IMPAIRED).
 
 
 
 
 elastic-gpu-state - The state of the Elastic Graphics accelerator (ATTACHED).
 
 
 
 
 elastic-gpu-type - The type of Elastic Graphics accelerator; for example, eg1.medium.
 
 
 
 
 instance-id - The ID of the instance to which the Elastic Graphics accelerator is associated.
 
 
 


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.
 


nextToken
String nextToken

 The token to request the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeElasticGpusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


elasticGpuSet
SdkInternalList<T> elasticGpuSet

 Information about the Elastic Graphics accelerators.
 


maxResults
Integer maxResults

 The total number of items to return. If the total number of items available is more than the value specified in
 max-items then a Next-Token will be provided in the output that you can use to resume pagination.
 


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.DescribeExportImageTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 Filter tasks using the task-state filter and one of the following values: active,
 completed, deleting, or deleted.
 


exportImageTaskIds
SdkInternalList<T> exportImageTaskIds

 The IDs of the export image tasks.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 


nextToken
String nextToken

 A token that indicates the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeExportImageTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


exportImageTasks
SdkInternalList<T> exportImageTasks

 Information about the export image tasks.
 


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.DescribeExportTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


exportTaskIds
SdkInternalList<T> exportTaskIds

 The export task IDs.
 


filters
SdkInternalList<T> filters

 the filters for the export tasks.
 








Class com.amazonaws.services.ec2.model.DescribeExportTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


exportTasks
SdkInternalList<T> exportTasks

 Information about the export tasks.
 








Class com.amazonaws.services.ec2.model.DescribeFastSnapshotRestoresRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The filters. The possible values are:
 
 
 
 
 availability-zone: The Availability Zone of the snapshot.
 
 
 
 
 owner-id: The ID of the AWS account that owns the snapshot.
 
 
 
 
 snapshot-id: The ID of the snapshot.
 
 
 
 
 state: The state of fast snapshot restores for the snapshot (enabling |
 optimizing | enabled | disabling | disabled).
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeFastSnapshotRestoresResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fastSnapshotRestores
SdkInternalList<T> fastSnapshotRestores

 Information about the state of fast snapshot restores.
 


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.DescribeFastSnapshotRestoreSuccessItem extends Object implements Serializable


Serialized Fields


snapshotId
String snapshotId

 The ID of the snapshot.
 


availabilityZone
String availabilityZone

 The Availability Zone.
 


state
String state

 The state of fast snapshot restores.
 


stateTransitionReason
String stateTransitionReason

 The reason for the state transition. The possible values are as follows:
 
 
 
 
 Client.UserInitiated - The state successfully transitioned to enabling or
 disabling.
 
 
 
 
 Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to
 optimizing, enabled, or disabled.
 
 
 


ownerId
String ownerId

 The ID of the AWS account that owns the snapshot.
 


ownerAlias
String ownerAlias

 The alias of the snapshot owner.
 


enablingTime
Date enablingTime

 The time at which fast snapshot restores entered the enabling state.
 


optimizingTime
Date optimizingTime

 The time at which fast snapshot restores entered the optimizing state.
 


enabledTime
Date enabledTime

 The time at which fast snapshot restores entered the enabled state.
 


disablingTime
Date disablingTime

 The time at which fast snapshot restores entered the disabling state.
 


disabledTime
Date disabledTime

 The time at which fast snapshot restores entered the disabled state.
 








Class com.amazonaws.services.ec2.model.DescribeFleetError extends Object implements Serializable


Serialized Fields


launchTemplateAndOverrides
LaunchTemplateAndOverridesResponse launchTemplateAndOverrides

 The launch templates and overrides that were used for launching the instances. The values that you specify in the
 Overrides replace the values in the launch template.
 


lifecycle
String lifecycle

 Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
 


errorCode
String errorCode

 The error code that indicates why the instance could not be launched. For more information about error codes, see
 Error Codes.
 


errorMessage
String errorMessage

 The error message that describes why the instance could not be launched. For more information about error
 messages, see Error
 Codes.
 








Class com.amazonaws.services.ec2.model.DescribeFleetHistoryRequest 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.
 


fleetId
String fleetId

 The ID of the EC2 Fleet.
 


startTime
Date startTime

 The start date and time for the events, in UTC format (for example,
 YYYY-MM-DDTHH:MM:SSZ).
 








Class com.amazonaws.services.ec2.model.DescribeFleetHistoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


historyRecords
SdkInternalList<T> historyRecords

 Information about the events in the history of the EC2 Fleet.
 


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 for the next set of results.
 


fleetId
String fleetId

 The ID of the EC Fleet.
 


startTime
Date startTime

 The start date and time for the events, in UTC format (for example,
 YYYY-MM-DDTHH:MM:SSZ).
 








Class com.amazonaws.services.ec2.model.DescribeFleetInstancesRequest 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.
 


fleetId
String fleetId

 The ID of the EC2 Fleet.
 


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 instance-type - The instance type.
 
 
 








Class com.amazonaws.services.ec2.model.DescribeFleetInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


activeInstances
SdkInternalList<T> activeInstances

 The running instances. This list is refreshed periodically and might be out of date.
 


nextToken
String nextToken

 The token for the next set of results.
 


fleetId
String fleetId

 The ID of the EC2 Fleet.
 








Class com.amazonaws.services.ec2.model.DescribeFleetsInstances extends Object implements Serializable


Serialized Fields


launchTemplateAndOverrides
LaunchTemplateAndOverridesResponse launchTemplateAndOverrides

 The launch templates and overrides that were used for launching the instances. The values that you specify in the
 Overrides replace the values in the launch template.
 


lifecycle
String lifecycle

 Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
 


instanceIds
SdkInternalList<T> instanceIds

 The IDs of the instances.
 


instanceType
String instanceType

 The instance type.
 


platform
String platform

 The value is Windows for Windows instances. Otherwise, the value is blank.
 








Class com.amazonaws.services.ec2.model.DescribeFleetsRequest 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.
 


fleetIds
SdkInternalList<T> fleetIds

 The ID of the EC2 Fleets.
 


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 activity-status - The progress of the EC2 Fleet ( error |
 pending-fulfillment | pending-termination | fulfilled).
 
 
 
 
 excess-capacity-termination-policy - Indicates whether to terminate running instances if the target
 capacity is decreased below the current EC2 Fleet size (true | false).
 
 
 
 
 fleet-state - The state of the EC2 Fleet (submitted | active |
 deleted | failed | deleted-running | deleted-terminating |
 modifying).
 
 
 
 
 replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (
 true | false).
 
 
 
 
 type - The type of request (instant | request | maintain).
 
 
 








Class com.amazonaws.services.ec2.model.DescribeFleetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 The token for the next set of results.
 


fleets
SdkInternalList<T> fleets

 Information about the EC2 Fleets.
 








Class com.amazonaws.services.ec2.model.DescribeFlowLogsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
SdkInternalList<T> filter

 One or more filters.
 
 
 
 
 deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).
 
 
 
 
 log-destination-type - The type of destination to which the flow log publishes data. Possible
 destination types include cloud-watch-logs and S3.
 
 
 
 
 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
SdkInternalList<T> flowLogIds

 One or more flow log IDs.
 
 
 Constraint: Maximum of 1000 flow log IDs.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeFlowLogsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowLogs
SdkInternalList<T> flowLogs

 Information about the flow logs.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. This value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeFpgaImageAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fpgaImageId
String fpgaImageId

 The ID of the AFI.
 


attribute
String attribute

 The AFI attribute.
 








Class com.amazonaws.services.ec2.model.DescribeFpgaImageAttributeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fpgaImageAttribute
FpgaImageAttribute fpgaImageAttribute

 Information about the attribute.
 








Class com.amazonaws.services.ec2.model.DescribeFpgaImagesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fpgaImageIds
SdkInternalList<T> fpgaImageIds

 The AFI IDs.
 


owners
SdkInternalList<T> owners

 Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or
 an AWS owner alias (valid values are amazon | aws-marketplace).
 


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 create-time - The creation time of the AFI.
 
 
 
 
 fpga-image-id - The FPGA image identifier (AFI ID).
 
 
 
 
 fpga-image-global-id - The global FPGA image identifier (AGFI ID).
 
 
 
 
 name - The name of the AFI.
 
 
 
 
 owner-id - The AWS account ID of the AFI owner.
 
 
 
 
 product-code - The product code.
 
 
 
 
 shell-version - The version of the AWS Shell that was used to create the bitstream.
 
 
 
 
 state - The state of the AFI (pending | failed | available |
 unavailable).
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 update-time - The time of the most recent update.
 
 
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 








Class com.amazonaws.services.ec2.model.DescribeFpgaImagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fpgaImages
SdkInternalList<T> fpgaImages

 Information about the FPGA images.
 


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.DescribeHostReservationOfferingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
SdkInternalList<T> filter

 The filters.
 
 
 
 
 instance-family - The instance family of the offering (for example, m4).
 
 
 
 
 payment-option - The payment option (NoUpfront | PartialUpfront |
 AllUpfront).
 
 
 


maxDuration
Integer maxDuration

 This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in
 one-year and three-year terms. The number of seconds specified must be the number of seconds in a year
 (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.
 


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 receive an error.
 


minDuration
Integer minDuration

 This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are
 available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a
 year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 


offeringId
String offeringId

 The ID of the reservation offering.
 








Class com.amazonaws.services.ec2.model.DescribeHostReservationOfferingsResult extends AmazonWebServiceResult<ResponseMetadata> 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.
 


offeringSet
SdkInternalList<T> offeringSet

 Information about the offerings.
 








Class com.amazonaws.services.ec2.model.DescribeHostReservationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
SdkInternalList<T> filter

 The filters.
 
 
 
 
 instance-family - The instance family (for example, m4).
 
 
 
 
 payment-option - The payment option (NoUpfront | PartialUpfront |
 AllUpfront).
 
 
 
 
 state - The state of the reservation (payment-pending | payment-failed |
 active | retired).
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 


hostReservationIdSet
SdkInternalList<T> hostReservationIdSet

 The host reservation 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 500. If
 maxResults is given a larger value than 500, you receive an error.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeHostReservationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hostReservationSet
SdkInternalList<T> hostReservationSet

 Details about the reservation's configuration.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. This value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeHostsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
SdkInternalList<T> filter

 The filters.
 
 
 
 
 auto-placement - Whether auto-placement is enabled or disabled (on | off).
 
 
 
 
 availability-zone - The Availability Zone of the host.
 
 
 
 
 client-token - The idempotency token that you provided when you allocated the host.
 
 
 
 
 host-reservation-id - The ID of the reservation assigned to this host.
 
 
 
 
 instance-type - The instance type size that the Dedicated Host is configured to support.
 
 
 
 
 state - The allocation state of the Dedicated Host (available |
 under-assessment | permanent-failure | released |
 released-permanent-failure).
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 


hostIds
SdkInternalList<T> 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 receive an error.
 
 
 You cannot specify this parameter and the host IDs parameter in the same request.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeHostsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hosts
SdkInternalList<T> hosts

 Information about the Dedicated Hosts.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. This value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeIamInstanceProfileAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationIds
SdkInternalList<T> associationIds

 The IAM instance profile associations.
 


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 instance-id - The ID of the instance.
 
 
 
 
 state - The state of the association (associating | associated |
 disassociating | disassociated).
 
 
 


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

 The token to request the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeIamInstanceProfileAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


iamInstanceProfileAssociations
SdkInternalList<T> iamInstanceProfileAssociations

 Information about the IAM instance profile associations.
 


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.DescribeIdentityIdFormatRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


principalArn
String principalArn

 The ARN of the principal, which can be an IAM role, IAM user, or the root user.
 


resource
String resource

 The type of resource: bundle | conversion-task | customer-gateway |
 dhcp-options | elastic-ip-allocation | elastic-ip-association |
 export-task | flow-log | image | import-task |
 instance | internet-gateway | network-acl |
 network-acl-association | network-interface | network-interface-attachment
 | prefix-list | reservation | route-table |
 route-table-association | security-group | snapshot | subnet
 | subnet-cidr-block-association | volume | vpc |
 vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
 vpn-connection | vpn-gateway
 








Class com.amazonaws.services.ec2.model.DescribeIdentityIdFormatResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


statuses
SdkInternalList<T> statuses

 Information about the ID format for the resources.
 








Class com.amazonaws.services.ec2.model.DescribeIdFormatRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resource
String resource

 The type of resource: bundle | conversion-task | customer-gateway |
 dhcp-options | elastic-ip-allocation | elastic-ip-association |
 export-task | flow-log | image | import-task |
 instance | internet-gateway | network-acl |
 network-acl-association | network-interface | network-interface-attachment
 | prefix-list | reservation | route-table |
 route-table-association | security-group | snapshot | subnet
 | subnet-cidr-block-association | volume | vpc |
 vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
 vpn-connection | vpn-gateway
 








Class com.amazonaws.services.ec2.model.DescribeIdFormatResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


statuses
SdkInternalList<T> statuses

 Information about the ID format for the resource.
 








Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


imageAttribute
ImageAttribute imageAttribute

 Describes an image attribute.
 








Class com.amazonaws.services.ec2.model.DescribeImagesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


executableUsers
SdkInternalList<T> executableUsers

 Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the
 sender of the request), or all (public AMIs).
 


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 architecture - The image architecture (i386 | x86_64 | arm64
 ).
 
 
 
 
 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 specified in the block device mapping (for
 example, /dev/sdh or xvdh).
 
 
 
 
 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).
 
 
 
 
 block-device-mapping.encrypted - A Boolean that indicates whether the EBS volume is encrypted.
 
 
 
 
 description - The description of the image (provided during image creation).
 
 
 
 
 ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
 
 
 
 
 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 - String value from an Amazon-maintained list (amazon |
 aws-marketplace | microsoft) of snapshot owners. Not to be confused with the
 user-configured AWS account alias, which is set from the IAM console.
 
 
 
 
 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 device 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.
 
 
 
 
 sriov-net-support - A value of simple indicates that enhanced networking with the Intel
 82599 VF interface is enabled.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 virtualization-type - The virtualization type (paravirtual | hvm).
 
 
 


imageIds
SdkInternalList<T> imageIds

 The image IDs.
 
 
 Default: Describes all images available to you.
 


owners
SdkInternalList<T> owners

 Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the
 request), or an AWS owner alias (valid values are amazon | aws-marketplace |
 microsoft). Omitting this option returns all images for which you have launch permissions,
 regardless of ownership.
 








Class com.amazonaws.services.ec2.model.DescribeImagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


images
SdkInternalList<T> images

 Information about the images.
 








Class com.amazonaws.services.ec2.model.DescribeImportImageTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 Filter tasks using the task-state filter and one of the following values: active,
 completed, deleting, or deleted.
 


importTaskIds
SdkInternalList<T> importTaskIds

 The IDs of the import image tasks.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 


nextToken
String nextToken

 A token that indicates the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeImportImageTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


importImageTasks
SdkInternalList<T> importImageTasks

 A list of zero or more import image tasks that are currently active or were completed or canceled in the previous
 7 days.
 


nextToken
String nextToken

 The token to use to get the next page of results. This value is null when there are no more results
 to return.
 








Class com.amazonaws.services.ec2.model.DescribeImportSnapshotTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The filters.
 


importTaskIds
SdkInternalList<T> 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


importSnapshotTasks
SdkInternalList<T> importSnapshotTasks

 A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the
 previous 7 days.
 


nextToken
String nextToken

 The token to use to get the next page of results. This value is null when there are no more results
 to return.
 








Class com.amazonaws.services.ec2.model.DescribeInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


attribute
String attribute

 The instance attribute.
 
 
 Note: The enaSupport attribute is not supported at this time.
 


instanceId
String instanceId

 The ID of the instance.
 








Class com.amazonaws.services.ec2.model.DescribeInstanceAttributeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceAttribute
InstanceAttribute instanceAttribute

 Describes an instance attribute.
 








Class com.amazonaws.services.ec2.model.DescribeInstanceCreditSpecificationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 instance-id - The ID of the instance.
 
 
 


instanceIds
SdkInternalList<T> instanceIds

 The instance IDs.
 
 
 Default: Describes all your instances.
 
 
 Constraints: Maximum 1000 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.DescribeInstanceCreditSpecificationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceCreditSpecifications
SdkInternalList<T> instanceCreditSpecifications

 Information about the credit option for CPU usage of an instance.
 


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.DescribeInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 affinity - The affinity setting for an instance running on a Dedicated Host (default |
 host).
 
 
 
 
 architecture - The instance architecture (i386 | x86_64 |
 arm64).
 
 
 
 
 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 specified in the block device mapping (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.
 
 
 
 
 hibernation-options.configured - A Boolean that indicates whether the instance is enabled for
 hibernation. A value of true means that the instance is enabled for hibernation.
 
 
 
 
 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 used
 for internal purposes 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 IPv4 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.
 
 
 
 
 metadata-options.http-tokens - The metadata request authorization state (optional |
 required)
 
 
 
 
 metadata-options.http-put-response-hop-limit - The http metadata request put response hop limit
 (integer, possible values 1 to 64)
 
 
 
 
 metadata-options.http-endpoint - Enable or disable metadata access on http endpoint (
 enabled | disabled)
 
 
 
 
 monitoring-state - Indicates whether detailed monitoring is enabled (disabled |
 enabled).
 
 
 
 
 network-interface.addresses.private-ip-address - The private IPv4 address associated with the
 network interface.
 
 
 
 
 network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is
 the primary private IPv4 address.
 
 
 
 
 network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP
 address (IPv4) with a network interface.
 
 
 
 
 network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address
 associated with the network interface.
 
 
 
 
 network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the
 network interface.
 
 
 
 
 network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated
 with the network interface.
 
 
 
 
 network-interface.association.allocation-id - The allocation ID returned when you allocated the
 Elastic IP address (IPv4) for your network interface.
 
 
 
 
 network-interface.association.association-id - The association ID returned when the network
 interface was associated with an IPv4 address.
 
 
 
 
 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.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.availability-zone - The Availability Zone for the network interface.
 
 
 
 
 network-interface.description - The description of the network interface.
 
 
 
 
 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.ipv6-addresses.ipv6-address - The IPv6 address associated with the network
 interface.
 
 
 
 
 network-interface.mac-address - The MAC address of 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.private-dns-name - The private DNS name of 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.source-dest-check - Whether the network interface performs source/destination
 checking. A value of true means that checking is enabled, and false means that checking
 is disabled. The value must be false for the network interface to perform network address
 translation (NAT) in your VPC.
 
 
 
 
 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.
 
 
 
 
 owner-id - The AWS account ID of the instance owner.
 
 
 
 
 placement-group-name - The name of the placement group for the instance.
 
 
 
 
 placement-partition-number - The partition in which the instance is located.
 
 
 
 
 platform - The platform. To list only Windows instances, use windows.
 
 
 
 
 private-dns-name - The private IPv4 DNS name of the instance.
 
 
 
 
 private-ip-address - The private IPv4 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 get one reservation ID. If you launch ten instances using the same
 launch request, you also get one reservation ID.
 
 
 
 
 root-device-name - The device name of the root device volume (for example, /dev/sda1).
 
 
 
 
 root-device-type - The type of the root device volume (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 that 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> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 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.
 
 
 


instanceIds
SdkInternalList<T> instanceIds

 The 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 in the same call.
 


nextToken
String nextToken

 The token to request the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservations
SdkInternalList<T> reservations

 Information about the reservations.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. This value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The 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.instance-event-id - The ID of the event whose date and time you are modifying.
 
 
 
 
 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).
 
 
 
 
 event.not-before-deadline - The deadline for starting the 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 used for internal purposes 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).
 
 
 


instanceIds
SdkInternalList<T> instanceIds

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


includeAllInstances
Boolean includeAllInstances

 When true, includes the health status for all instances. When false, includes the
 health status for running instances only.
 
 
 Default: false
 








Class com.amazonaws.services.ec2.model.DescribeInstanceStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceStatuses
SdkInternalList<T> instanceStatuses

 Information about the status of the 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.DescribeInstanceTypeOfferingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


locationType
String locationType

 The location type.
 


filters
SdkInternalList<T> filters

 One or more filters. Filter names and values are case-sensitive.
 
 
 
 
 location - This depends on the location type. For example, if the location type is
 region (default), the location is the Region code (for example, us-east-2.)
 
 
 
 
 instance-type - The instance type.
 
 
 


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 next token value.
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeInstanceTypeOfferingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceTypeOfferings
SdkInternalList<T> instanceTypeOfferings

 The instance types offered.
 


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.DescribeInstanceTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceTypes
SdkInternalList<T> instanceTypes

 The instance types. For more information, see Instance Types in the
 Amazon Elastic Compute Cloud User Guide.
 


filters
SdkInternalList<T> filters

 One or more filters. Filter names and values are case-sensitive.
 
 
 
 
 auto-recovery-supported - Indicates whether auto recovery is supported. (true |
 false)
 
 
 
 
 bare-metal - Indicates whether it is a bare metal instance type. (true |
 false)
 
 
 
 
 burstable-performance-supported - Indicates whether it is a burstable performance instance type. (
 true | false)
 
 
 
 
 current-generation - Indicates whether this instance type is the latest generation instance type of
 an instance family. (true | false)
 
 
 
 
 ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized. (
 true | false)
 
 
 
 
 ebs-info.encryption-support - Indicates whether EBS encryption is supported. (true |
 false)
 
 
 
 
 free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier. (
 true | false)
 
 
 
 
 hibernation-supported - Indicates whether On-Demand hibernation is supported. (true |
 false)
 
 
 
 
 hypervisor - The hypervisor used. (nitro | xen)
 
 
 
 
 instance-storage-info.disk.count - The number of local disks.
 
 
 
 
 instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
 
 
 
 
 instance-storage-info.disk.type - The storage technology for the local instance storage disks. (
 hdd | ssd)
 
 
 
 
 instance-storage-info.total-size-in-gb - The total amount of storage available from all local
 instance storage, in GB.
 
 
 
 
 instance-storage-supported - Indicates whether the instance type has local instance storage. (
 true | false)
 
 
 
 
 memory-info.size-in-mib - The memory size.
 
 
 
 
 network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required.
 (required | supported | unsupported)
 
 
 
 
 network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network
 interface.
 
 
 
 
 network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network
 interface.
 
 
 
 
 network-info.ipv6-supported - Indicates whether the instance type supports IPv6. (true
 | false)
 
 
 
 
 network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
 
 
 
 
 network-info.network-performance - Describes the network performance.
 
 
 
 
 processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
 
 
 
 
 vcpu-info.default-cores - The default number of cores for the instance type.
 
 
 
 
 vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
 
 
 
 
 vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
 
 
 


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 next token value.
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeInstanceTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceTypes
SdkInternalList<T> instanceTypes

 The instance type. For more information, see Instance Types in the
 Amazon Elastic Compute Cloud User Guide.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. This value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeInternetGatewaysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 attachment.state - The current state of the attachment between the gateway and the VPC (
 available). Present only if a VPC is attached.
 
 
 
 
 attachment.vpc-id - The ID of an attached VPC.
 
 
 
 
 internet-gateway-id - The ID of the Internet gateway.
 
 
 
 
 owner-id - The ID of the AWS account that owns the internet gateway.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 


internetGatewayIds
SdkInternalList<T> internetGatewayIds

 One or more internet gateway IDs.
 
 
 Default: Describes all your internet gateways.
 


nextToken
String nextToken

 The token for the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 








Class com.amazonaws.services.ec2.model.DescribeInternetGatewaysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


internetGateways
SdkInternalList<T> internetGateways

 Information about one or more internet 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.DescribeIpv6PoolsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


poolIds
SdkInternalList<T> poolIds

 The IDs of the IPv6 address pools.
 


nextToken
String nextToken

 The token for the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 








Class com.amazonaws.services.ec2.model.DescribeIpv6PoolsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ipv6Pools
SdkInternalList<T> ipv6Pools

 Information about the IPv6 address pools.
 


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.DescribeKeyPairsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 fingerprint - The fingerprint of the key pair.
 
 
 
 
 key-name - The name of the key pair.
 
 
 


keyNames
SdkInternalList<T> keyNames

 The key pair names.
 
 
 Default: Describes all your key pairs.
 


keyPairIds
SdkInternalList<T> keyPairIds

 The IDs of the key pairs.
 








Class com.amazonaws.services.ec2.model.DescribeKeyPairsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyPairs
SdkInternalList<T> keyPairs

 Information about the key pairs.
 








Class com.amazonaws.services.ec2.model.DescribeLaunchTemplatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


launchTemplateIds
SdkInternalList<T> launchTemplateIds

 One or more launch template IDs.
 


launchTemplateNames
SdkInternalList<T> launchTemplateNames

 One or more launch template names.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 create-time - The time the launch template was created.
 
 
 
 
 launch-template-name - The name of the launch template.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 


nextToken
String nextToken

 The token to request the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call. To retrieve the remaining results, make another call
 with the returned NextToken value. This value can be between 1 and 200.
 








Class com.amazonaws.services.ec2.model.DescribeLaunchTemplatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


launchTemplates
SdkInternalList<T> launchTemplates

 Information about the launch templates.
 


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.DescribeLaunchTemplateVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


launchTemplateId
String launchTemplateId

 The ID of the launch template. You must specify either the launch template ID or launch template name in the
 request.
 


launchTemplateName
String launchTemplateName

 The name of the launch template. You must specify either the launch template ID or launch template name in the
 request.
 


versions
SdkInternalList<T> versions

 One or more versions of the launch template.
 


minVersion
String minVersion

 The version number after which to describe launch template versions.
 


maxVersion
String maxVersion

 The version number up to which to describe launch template versions.
 


nextToken
String nextToken

 The token to request the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call. To retrieve the remaining results, make another call
 with the returned NextToken value. This value can be between 1 and 200.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 create-time - The time the launch template version was created.
 
 
 
 
 ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
 
 
 
 
 iam-instance-profile - The ARN of the IAM instance profile.
 
 
 
 
 image-id - The ID of the AMI.
 
 
 
 
 instance-type - The instance type.
 
 
 
 
 is-default-version - A boolean that indicates whether the launch template version is the default
 version.
 
 
 
 
 kernel-id - The kernel ID.
 
 
 
 
 ram-disk-id - The RAM disk ID.
 
 
 








Class com.amazonaws.services.ec2.model.DescribeLaunchTemplateVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


launchTemplateVersions
SdkInternalList<T> launchTemplateVersions

 Information about the launch template versions.
 


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.DescribeLocalGatewayRouteTablesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


localGatewayRouteTableIds
SdkInternalList<T> localGatewayRouteTableIds

 The IDs of the local gateway route tables.
 


filters
SdkInternalList<T> filters

 One or more filters.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeLocalGatewayRouteTablesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


localGatewayRouteTables
SdkInternalList<T> localGatewayRouteTables

 Information about the local gateway route tables.
 


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.DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


localGatewayRouteTableVirtualInterfaceGroupAssociationIds
SdkInternalList<T> localGatewayRouteTableVirtualInterfaceGroupAssociationIds

 The IDs of the associations.
 


filters
SdkInternalList<T> filters

 One or more filters.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


localGatewayRouteTableVirtualInterfaceGroupAssociations
SdkInternalList<T> localGatewayRouteTableVirtualInterfaceGroupAssociations

 Information about the associations.
 


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.DescribeLocalGatewayRouteTableVpcAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


localGatewayRouteTableVpcAssociationIds
SdkInternalList<T> localGatewayRouteTableVpcAssociationIds

 The IDs of the associations.
 


filters
SdkInternalList<T> filters

 One or more filters.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeLocalGatewayRouteTableVpcAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


localGatewayRouteTableVpcAssociations
SdkInternalList<T> localGatewayRouteTableVpcAssociations

 Information about the associations.
 


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.DescribeLocalGatewaysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


localGatewayIds
SdkInternalList<T> localGatewayIds

 The IDs of the local gateways.
 


filters
SdkInternalList<T> filters

 One or more filters.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeLocalGatewaysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


localGateways
SdkInternalList<T> localGateways

 Information about the local 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.DescribeLocalGatewayVirtualInterfaceGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


localGatewayVirtualInterfaceGroupIds
SdkInternalList<T> localGatewayVirtualInterfaceGroupIds

 The IDs of the virtual interface groups.
 


filters
SdkInternalList<T> filters

 One or more filters.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeLocalGatewayVirtualInterfaceGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


localGatewayVirtualInterfaceGroups
SdkInternalList<T> localGatewayVirtualInterfaceGroups

 The virtual interface groups.
 


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.DescribeLocalGatewayVirtualInterfacesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


localGatewayVirtualInterfaceIds
SdkInternalList<T> localGatewayVirtualInterfaceIds

 The IDs of the virtual interfaces.
 


filters
SdkInternalList<T> filters

 One or more filters.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeLocalGatewayVirtualInterfacesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


localGatewayVirtualInterfaces
SdkInternalList<T> localGatewayVirtualInterfaces

 Information about the virtual interfaces.
 


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.DescribeMovingAddressesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 moving-status - The status of the Elastic IP address (MovingToVpc |
 RestoringToClassic).
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return for the request in a single page. The remaining results of the initial
 request can be seen by sending another request with the returned NextToken value. This value can be
 between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.
 
 
 Default: If no value is provided, the default is 1000.
 


nextToken
String nextToken

 The token for the next page of results.
 


publicIps
SdkInternalList<T> publicIps

 One or more Elastic IP addresses.
 








Class com.amazonaws.services.ec2.model.DescribeMovingAddressesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


movingAddressStatuses
SdkInternalList<T> movingAddressStatuses

 The status for each Elastic IP address.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. This value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeNatGatewaysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
SdkInternalList<T> filter

 One or more filters.
 
 
 
 
 nat-gateway-id - The ID of the NAT gateway.
 
 
 
 
 state - The state of the NAT gateway (pending | failed |
 available | deleting | deleted).
 
 
 
 
 subnet-id - The ID of the subnet in which the NAT gateway resides.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 vpc-id - The ID of the VPC in which the NAT gateway resides.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


natGatewayIds
SdkInternalList<T> natGatewayIds

 One or more NAT gateway IDs.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeNatGatewaysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


natGateways
SdkInternalList<T> natGateways

 Information about the NAT gateways.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. This value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeNetworkAclsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 association.association-id - The ID of an association ID for the ACL.
 
 
 
 
 association.network-acl-id - The ID of the network ACL involved in the association.
 
 
 
 
 association.subnet-id - The ID of the subnet involved in the association.
 
 
 
 
 default - Indicates whether the ACL is the default network ACL for the VPC.
 
 
 
 
 entry.cidr - The IPv4 CIDR range specified in the entry.
 
 
 
 
 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.ipv6-cidr - The IPv6 CIDR range specified in the entry.
 
 
 
 
 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 set of ACL entries.
 
 
 
 
 network-acl-id - The ID of the network ACL.
 
 
 
 
 owner-id - The ID of the AWS account that owns the network ACL.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 vpc-id - The ID of the VPC for the network ACL.
 
 
 


networkAclIds
SdkInternalList<T> networkAclIds

 One or more network ACL IDs.
 
 
 Default: Describes all your network ACLs.
 


nextToken
String nextToken

 The token for the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 








Class com.amazonaws.services.ec2.model.DescribeNetworkAclsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networkAcls
SdkInternalList<T> networkAcls

 Information about one or more network ACLs.
 


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.DescribeNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


attribute
String attribute

 The attribute of the network interface. This parameter is required.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 








Class com.amazonaws.services.ec2.model.DescribeNetworkInterfaceAttributeResult extends AmazonWebServiceResult<ResponseMetadata> 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
SdkInternalList<T> 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.DescribeNetworkInterfacePermissionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkInterfacePermissionIds
SdkInternalList<T> networkInterfacePermissionIds

 One or more network interface permission IDs.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 network-interface-permission.network-interface-permission-id - The ID of the permission.
 
 
 
 
 network-interface-permission.network-interface-id - The ID of the network interface.
 
 
 
 
 network-interface-permission.aws-account-id - The AWS account ID.
 
 
 
 
 network-interface-permission.aws-service - The AWS service.
 
 
 
 
 network-interface-permission.permission - The type of permission (INSTANCE-ATTACH |
 EIP-ASSOCIATE).
 
 
 


nextToken
String nextToken

 The token to request the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call. To retrieve the remaining results, make another call
 with the returned NextToken value. If this parameter is not specified, up to 50 results are returned
 by default.
 








Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacePermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networkInterfacePermissions
SdkInternalList<T> networkInterfacePermissions

 The network interface permissions.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
 
 
 
 
 addresses.primary - Whether the private IPv4 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 (IPv4).
 
 
 
 
 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 IPv4 address.
 
 
 
 
 association.allocation-id - The allocation ID returned when you allocated the Elastic IP address
 (IPv4) for your network interface.
 
 
 
 
 association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network
 interface.
 
 
 
 
 association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
 
 
 
 
 association.public-dns-name - The public DNS name for the network interface (IPv4).
 
 
 
 
 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.
 
 
 
 
 ipv6-addresses.ipv6-address - An IPv6 address 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 IPv4 address or addresses of the network interface.
 
 
 
 
 private-dns-name - The private DNS name of the network interface (IPv4).
 
 
 
 
 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-dest-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> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 vpc-id - The ID of the VPC for the network interface.
 
 
 


networkInterfaceIds
SdkInternalList<T> networkInterfaceIds

 One or more network interface IDs.
 
 
 Default: Describes all your network interfaces.
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 


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. You cannot specify this parameter and the network interface IDs
 parameter in the same request.
 








Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networkInterfaces
SdkInternalList<T> networkInterfaces

 Information about one or more network interfaces.
 


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.DescribePlacementGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The 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 | spread |
 partition).
 
 
 


groupNames
SdkInternalList<T> groupNames

 The names of the placement groups.
 
 
 Default: Describes all your placement groups, or only those otherwise specified.
 


groupIds
SdkInternalList<T> groupIds

 The IDs of the placement groups.
 








Class com.amazonaws.services.ec2.model.DescribePlacementGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


placementGroups
SdkInternalList<T> placementGroups

 Information about the placement groups.
 








Class com.amazonaws.services.ec2.model.DescribePrefixListsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 prefix-list-id: The ID of a prefix list.
 
 
 
 
 prefix-list-name: The name of a prefix list.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 


prefixListIds
SdkInternalList<T> prefixListIds

 One or more prefix list IDs.
 








Class com.amazonaws.services.ec2.model.DescribePrefixListsResult extends AmazonWebServiceResult<ResponseMetadata> 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.
 


prefixLists
SdkInternalList<T> prefixLists

 All available prefix lists.
 








Class com.amazonaws.services.ec2.model.DescribePrincipalIdFormatRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resources
SdkInternalList<T> resources

 The type of resource: bundle | conversion-task | customer-gateway |
 dhcp-options | elastic-ip-allocation | elastic-ip-association |
 export-task | flow-log | image | import-task |
 instance | internet-gateway | network-acl |
 network-acl-association | network-interface | network-interface-attachment
 | prefix-list | reservation | route-table |
 route-table-association | security-group | snapshot | subnet
 | subnet-cidr-block-association | volume | vpc |
 vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
 vpn-connection | vpn-gateway
 


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

 The token to request the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribePrincipalIdFormatResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


principals
SdkInternalList<T> principals

 Information about the ID format settings for the ARN.
 


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.DescribePublicIpv4PoolsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


poolIds
SdkInternalList<T> poolIds

 The IDs of the address pools.
 


nextToken
String nextToken

 The token for the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 








Class com.amazonaws.services.ec2.model.DescribePublicIpv4PoolsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


publicIpv4Pools
SdkInternalList<T> publicIpv4Pools

 Information about the address pools.
 


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.DescribeRegionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
 
 
 
 
 opt-in-status - The opt-in status of the Region (opt-in-not-required |
 opted-in | not-opted-in).
 
 
 
 
 region-name - The name of the Region (for example, us-east-1).
 
 
 


regionNames
SdkInternalList<T> regionNames

 The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.
 


allRegions
Boolean allRegions

 Indicates whether to display all Regions, including Regions that are disabled for your account.
 








Class com.amazonaws.services.ec2.model.DescribeRegionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


regions
SdkInternalList<T> regions

 Information about the Regions.
 








Class com.amazonaws.services.ec2.model.DescribeReservedInstancesListingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 reserved-instances-id - The ID of the Reserved Instances.
 
 
 
 
 reserved-instances-listing-id - The ID of the Reserved Instances listing.
 
 
 
 
 status - The status of the Reserved Instance listing (pending | active |
 cancelled | closed).
 
 
 
 
 status-message - The reason for the status.
 
 
 


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservedInstancesListings
SdkInternalList<T> reservedInstancesListings

 Information about the Reserved Instance listing.
 








Class com.amazonaws.services.ec2.model.DescribeReservedInstancesModificationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 client-token - The idempotency token for the modification request.
 
 
 
 
 create-date - The time when the modification request was created.
 
 
 
 
 effective-date - The time when the modification becomes effective.
 
 
 
 
 modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the
 modification request. This ID is only available when the status of the modification is fulfilled.
 
 
 
 
 modification-result.target-configuration.availability-zone - The Availability Zone for the new
 Reserved Instances.
 
 
 
 
 modification-result.target-configuration.instance-count  - The number of new Reserved Instances.
 
 
 
 
 modification-result.target-configuration.instance-type - The instance type of the new Reserved
 Instances.
 
 
 
 
 modification-result.target-configuration.platform - The network platform of the new Reserved
 Instances (EC2-Classic | EC2-VPC).
 
 
 
 
 reserved-instances-id - The ID of the Reserved Instances modified.
 
 
 
 
 reserved-instances-modification-id - The ID of the modification request.
 
 
 
 
 status - The status of the Reserved Instances modification request (processing |
 fulfilled | failed).
 
 
 
 
 status-message - The reason for the status.
 
 
 
 
 update-date - The time when the modification request was last updated.
 
 
 


reservedInstancesModificationIds
SdkInternalList<T> reservedInstancesModificationIds

 IDs for the submitted modification request.
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeReservedInstancesModificationsResult extends AmazonWebServiceResult<ResponseMetadata> 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
SdkInternalList<T> reservedInstancesModifications

 The Reserved Instance modification information.
 








Class com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone in which the Reserved Instance can be used.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 availability-zone - The Availability Zone where the Reserved Instance can be used.
 
 
 
 
 duration - The duration of the Reserved Instance (for example, one year or three years), in seconds
 (31536000 | 94608000).
 
 
 
 
 fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
 
 
 
 
 instance-type - The instance type that is covered by the reservation.
 
 
 
 
 marketplace - Set to true to show only Reserved Instance Marketplace offerings. When
 this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance
 Marketplace are listed.
 
 
 
 
 product-description - The Reserved Instance product platform description. Instances that include
 (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account
 holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) |
 SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux |
 Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) |
 Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) |
 Windows with SQL Server Web |  Windows with SQL Server Web (Amazon VPC) |
 Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))
 
 
 
 
 reserved-instances-offering-id - The Reserved Instances offering ID.
 
 
 
 
 scope - The scope of the Reserved Instance (Availability Zone or Region).
 
 
 
 
 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.
 


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
 


minDuration
Long minDuration

 The minimum duration (in seconds) to filter when searching for offerings.
 
 
 Default: 2592000 (1 month)
 


offeringClass
String offeringClass

 The offering class of the Reserved Instance. Can be standard or convertible.
 


productDescription
String productDescription

 The Reserved Instance product platform description. Instances that include (Amazon VPC) in the
 description are for use with Amazon VPC.
 


reservedInstancesOfferingIds
SdkInternalList<T> reservedInstancesOfferingIds

 One or more Reserved Instances offering IDs.
 


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).
 
 
 Important: The host value cannot be used with this parameter. Use the default or
 dedicated values only.
 
 
 Default: default
 


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
 


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.
 








Class com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservedInstancesOfferings
SdkInternalList<T> reservedInstancesOfferings

 A list of Reserved Instances offerings.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. This value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 availability-zone - The Availability Zone where the Reserved Instance can be used.
 
 
 
 
 duration - The duration of the Reserved Instance (one year or three years), in seconds (
 31536000 | 94608000).
 
 
 
 
 end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
 
 
 
 
 fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
 
 
 
 
 instance-type - The instance type that is covered by the reservation.
 
 
 
 
 scope - The scope of the Reserved Instance (Region or Availability Zone).
 
 
 
 
 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> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
 
 
 


offeringClass
String offeringClass

 Describes whether the Reserved Instance is Standard or Convertible.
 


reservedInstancesIds
SdkInternalList<T> reservedInstancesIds

 One or more Reserved Instance IDs.
 
 
 Default: Describes all your Reserved Instances, or only those otherwise specified.
 


offeringType
String offeringType

 The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only
 have access to the Medium Utilization Reserved Instance offering type.
 








Class com.amazonaws.services.ec2.model.DescribeReservedInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservedInstances
SdkInternalList<T> reservedInstances

 A list of Reserved Instances.
 








Class com.amazonaws.services.ec2.model.DescribeRouteTablesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 association.route-table-association-id - The ID of an association ID for the route table.
 
 
 
 
 association.route-table-id - The ID of the route table involved in the association.
 
 
 
 
 association.subnet-id - The ID of the subnet involved in the association.
 
 
 
 
 association.main - Indicates whether the route table is the main route table for the VPC (
 true | false). Route tables that do not have an association ID are not returned in the
 response.
 
 
 
 
 owner-id - The ID of the AWS account that owns the route table.
 
 
 
 
 route-table-id - The ID of the route table.
 
 
 
 
 route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
 
 
 
 
 route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
 
 
 
 
 route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the
 table.
 
 
 
 
 route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a
 route in the route 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.transit-gateway-id - The ID of a transit 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> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 transit-gateway-id - The ID of a transit gateway.
 
 
 
 
 vpc-id - The ID of the VPC for the route table.
 
 
 


routeTableIds
SdkInternalList<T> routeTableIds

 One or more route table IDs.
 
 
 Default: Describes all your route tables.
 


nextToken
String nextToken

 The token for the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 








Class com.amazonaws.services.ec2.model.DescribeRouteTablesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


routeTables
SdkInternalList<T> routeTables

 Information about one or more route tables.
 


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.DescribeScheduledInstanceAvailabilityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The 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 extends AmazonWebServiceResult<ResponseMetadata> 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
SdkInternalList<T> scheduledInstanceAvailabilitySet

 Information about the available Scheduled Instances.
 








Class com.amazonaws.services.ec2.model.DescribeScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The 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
SdkInternalList<T> scheduledInstanceIds

 The Scheduled Instance IDs.
 


slotStartTimeRange
SlotStartTimeRangeRequest slotStartTimeRange

 The time period for the first schedule to start.
 








Class com.amazonaws.services.ec2.model.DescribeScheduledInstancesResult extends AmazonWebServiceResult<ResponseMetadata> 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
SdkInternalList<T> scheduledInstanceSet

 Information about the Scheduled Instances.
 








Class com.amazonaws.services.ec2.model.DescribeSecurityGroupReferencesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
SdkInternalList<T> groupId

 The IDs of the security groups in your account.
 








Class com.amazonaws.services.ec2.model.DescribeSecurityGroupReferencesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityGroupReferenceSet
SdkInternalList<T> securityGroupReferenceSet

 Information about the VPCs with the referencing security groups.
 








Class com.amazonaws.services.ec2.model.DescribeSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The 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.cidr - An IPv4 CIDR block for an outbound security group rule.
 
 
 
 
 egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP
 protocols, or an ICMP type number.
 
 
 
 
 egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound
 security group rule.
 
 
 
 
 egress.ip-permission.group-name - The name of a security group that has been referenced in an
 outbound security group rule.
 
 
 
 
 egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
 
 
 
 
 egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which a security group
 rule allows outbound access.
 
 
 
 
 egress.ip-permission.protocol - The IP protocol for an outbound security group rule (
 tcp | udp | icmp or a protocol number).
 
 
 
 
 egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP
 protocols, or an ICMP code.
 
 
 
 
 egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound
 security group rule.
 
 
 
 
 group-id - The ID of the security group.
 
 
 
 
 group-name - The name of the security group.
 
 
 
 
 ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
 
 
 
 
 ip-permission.from-port - For an inbound rule, 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 referenced in an inbound security
 group rule.
 
 
 
 
 ip-permission.group-name - The name of a security group that has been referenced in an inbound
 security group rule.
 
 
 
 
 ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
 
 
 
 
 ip-permission.prefix-list-id - The ID (prefix) of the AWS service from which a security group rule
 allows inbound access.
 
 
 
 
 ip-permission.protocol - The IP protocol for an inbound security group rule (tcp |
 udp | icmp or a protocol number).
 
 
 
 
 ip-permission.to-port - For an inbound rule, 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 referenced in an inbound security
 group rule.
 
 
 
 
 owner-id - The AWS account ID of the owner of the security group.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 vpc-id - The ID of the VPC specified when the security group was created.
 
 
 


groupIds
SdkInternalList<T> groupIds

 The IDs of the security groups. Required for security groups in a nondefault VPC.
 
 
 Default: Describes all your security groups.
 


groupNames
SdkInternalList<T> groupNames

 [EC2-Classic and default VPC only] The names of the security groups. 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.
 


nextToken
String nextToken

 The token to request the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call. To retrieve the remaining results, make another request
 with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not
 specified, then all results are returned.
 








Class com.amazonaws.services.ec2.model.DescribeSecurityGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityGroups
SdkInternalList<T> securityGroups

 Information about the security groups.
 


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.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


createVolumePermissions
SdkInternalList<T> createVolumePermissions

 The users and groups that have the permissions for creating volumes from the snapshot.
 


productCodes
SdkInternalList<T> productCodes

 The product codes.
 


snapshotId
String snapshotId

 The ID of the EBS snapshot.
 








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


Serialized Fields


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 description - A description of the snapshot.
 
 
 
 
 encrypted - Indicates whether the snapshot is encrypted (true | false)
 
 
 
 
 owner-alias - Value from an Amazon-maintained list (amazon | self |
 all | aws-marketplace | microsoft) of snapshot owners. Not to be confused
 with the user-configured AWS account alias, which is set from the IAM console.
 
 
 
 
 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> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 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
SdkInternalList<T> ownerIds

 Describes the snapshots owned by these owners.
 


restorableByUserIds
SdkInternalList<T> restorableByUserIds

 The IDs of the AWS accounts that can create volumes from the snapshot.
 


snapshotIds
SdkInternalList<T> snapshotIds

 The snapshot IDs.
 
 
 Default: Describes the snapshots for which you have create volume permissions.
 








Class com.amazonaws.services.ec2.model.DescribeSnapshotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


snapshots
SdkInternalList<T> snapshots

 Information about the snapshots.
 


nextToken
String nextToken

 The NextToken value to include in a future DescribeSnapshots request. When the results
 of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve
 the next page of results. This value is null when there are no more results to return.
 








Class com.amazonaws.services.ec2.model.DescribeSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.ec2.model.DescribeSpotDatafeedSubscriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


spotDatafeedSubscription
SpotDatafeedSubscription spotDatafeedSubscription

 The Spot Instance data feed subscription.
 








Class com.amazonaws.services.ec2.model.DescribeSpotFleetInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


activeInstances
SdkInternalList<T> activeInstances

 The running instances. 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 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


historyRecords
SdkInternalList<T> 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 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
SdkInternalList<T> spotFleetRequestIds

 The IDs of the Spot Fleet requests.
 








Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestsResult extends AmazonWebServiceResult<ResponseMetadata> 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
SdkInternalList<T> spotFleetRequestConfigs

 Information about the configuration of your Spot Fleet.
 








Class com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 availability-zone-group - The Availability Zone group.
 
 
 
 
 create-time - The time stamp when the Spot Instance request was created.
 
 
 
 
 fault-code - The fault code related to the request.
 
 
 
 
 fault-message - The fault message related to the request.
 
 
 
 
 instance-id - The ID of the instance that fulfilled the request.
 
 
 
 
 launch-group - The Spot Instance launch group.
 
 
 
 
 launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on
 instance termination.
 
 
 
 
 launch.block-device-mapping.device-name - The device name for the volume in the block device mapping
 (for example, /dev/sdh or xvdh).
 
 
 
 
 launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
 
 
 
 
 launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
 
 
 
 
 launch.block-device-mapping.volume-type - The type of 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 ID of the security group for the instance.
 
 
 
 
 launch.group-name - The name of 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 detailed monitoring is enabled for the Spot Instance.
 
 
 
 
 launch.ramdisk-id - The RAM disk ID.
 
 
 
 
 launched-availability-zone - The Availability Zone in which the request is launched.
 
 
 
 
 network-interface.addresses.primary - Indicates whether the IP address is the primary private IP
 address.
 
 
 
 
 network-interface.delete-on-termination - Indicates whether the network interface is deleted when
 the instance is terminated.
 
 
 
 
 network-interface.description - A description of the network interface.
 
 
 
 
 network-interface.device-index - The index of the device for the network interface attachment on the
 instance.
 
 
 
 
 network-interface.group-id - The ID of the security group associated with the network interface.
 
 
 
 
 network-interface.network-interface-id - The ID of the network interface.
 
 
 
 
 network-interface.private-ip-address - The primary private IP address of the network interface.
 
 
 
 
 network-interface.subnet-id - The ID of the subnet for the instance.
 
 
 
 
 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 request status information can help you
 track your Amazon EC2 Spot Instance requests. For more information, see Spot Request Status in the
 Amazon EC2 User Guide for Linux Instances.
 
 
 
 
 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> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 type - The type of Spot Instance request (one-time | persistent).
 
 
 
 
 valid-from - The start date of the request.
 
 
 
 
 valid-until - The end date of the request.
 
 
 


spotInstanceRequestIds
SdkInternalList<T> spotInstanceRequestIds

 One or more Spot Instance request IDs.
 


nextToken
String nextToken

 The token to request the next set of results. This value is null when there are no more results to
 return.
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the
 remaining results, make another call with the returned NextToken value.
 








Class com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


spotInstanceRequests
SdkInternalList<T> spotInstanceRequests

 One or more Spot Instance requests.
 


nextToken
String nextToken

 The token to use to retrieve the next set of results. This value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeSpotPriceHistoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 availability-zone - The Availability Zone for which prices should be returned.
 
 
 
 
 instance-type - The type of instance (for example, m3.medium).
 
 
 
 
 product-description - The product description for the Spot price (Linux/UNIX |
 SUSE Linux | Windows | Linux/UNIX (Amazon VPC) |
 SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
 
 
 
 
 spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less
 than comparison is not supported).
 
 
 
 
 timestamp - The time stamp of the Spot price history, in UTC format (for example,
 YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or
 less than comparison is not supported.
 
 
 


availabilityZone
String availabilityZone

 Filters the results by the specified Availability Zone.
 


endTime
Date endTime

 The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format
 (for example, YYYY-MM-DDTHH:MM:SSZ).
 


instanceTypes
SdkInternalList<T> 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
SdkInternalList<T> 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 The token required to retrieve the next set of results. This value is null or an empty string when there are no
 more results to return.
 


spotPriceHistory
SdkInternalList<T> spotPriceHistory

 The historical Spot prices.
 








Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> 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
SdkInternalList<T> staleSecurityGroupSet

 Information about the stale security groups.
 








Class com.amazonaws.services.ec2.model.DescribeSubnetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 availability-zone - The Availability Zone for the subnet. You can also use
 availabilityZone as the filter name.
 
 
 
 
 availability-zone-id - The ID of the Availability Zone for the subnet. You can also use
 availabilityZoneId as the filter name.
 
 
 
 
 available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
 
 
 
 
 cidr-block - The IPv4 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
 cidrBlock as the filter names.
 
 
 
 
 default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can
 also use defaultForAz as the filter name.
 
 
 
 
 ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
 
 
 
 
 ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated
 with the subnet.
 
 
 
 
 ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
 
 
 
 
 owner-id - The ID of the AWS account that owns the subnet.
 
 
 
 
 state - The state of the subnet (pending | available).
 
 
 
 
 subnet-arn - The Amazon Resource Name (ARN) of the subnet.
 
 
 
 
 subnet-id - The ID of the subnet.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 vpc-id - The ID of the VPC for the subnet.
 
 
 


subnetIds
SdkInternalList<T> subnetIds

 One or more subnet IDs.
 
 
 Default: Describes all your subnets.
 


nextToken
String nextToken

 The token for the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 








Class com.amazonaws.services.ec2.model.DescribeSubnetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


subnets
SdkInternalList<T> subnets

 Information about one or more subnets.
 


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.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The filters.
 
 
 
 
 key - The tag key.
 
 
 
 
 resource-id - The ID of the resource.
 
 
 
 
 resource-type - The resource type (customer-gateway | dedicated-host |
 dhcp-options | elastic-ip | fleet | fpga-image |
 image | instance | host-reservation | internet-gateway |
 launch-template | natgateway | network-acl |
 network-interface | reserved-instances | route-table |
 security-group | snapshot | spot-instances-request | subnet |
 volume | vpc | vpc-peering-connection | vpn-connection |
 vpn-gateway).
 
 
 
 
 tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the
 filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
 
 
 
 
 value - The tag value.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the
 remaining results, make another call with the returned NextToken value.
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeTagsResult extends AmazonWebServiceResult<ResponseMetadata> 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
SdkInternalList<T> tags

 The tags.
 








Class com.amazonaws.services.ec2.model.DescribeTrafficMirrorFiltersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trafficMirrorFilterIds
SdkInternalList<T> trafficMirrorFilterIds

 The ID of the Traffic Mirror filter.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 description: The Traffic Mirror filter description.
 
 
 
 
 traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeTrafficMirrorFiltersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorFilters
SdkInternalList<T> trafficMirrorFilters

 Information about one or more Traffic Mirror filters.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. The value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeTrafficMirrorSessionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trafficMirrorSessionIds
SdkInternalList<T> trafficMirrorSessionIds

 The ID of the Traffic Mirror session.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 description: The Traffic Mirror session description.
 
 
 
 
 network-interface-id: The ID of the Traffic Mirror session network interface.
 
 
 
 
 owner-id: The ID of the account that owns the Traffic Mirror session.
 
 
 
 
 packet-length: The assigned number of packets to mirror.
 
 
 
 
 session-number: The assigned session number.
 
 
 
 
 traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
 
 
 
 
 traffic-mirror-session-id: The ID of the Traffic Mirror session.
 
 
 
 
 traffic-mirror-target-id: The ID of the Traffic Mirror target.
 
 
 
 
 virtual-network-id: The virtual network ID of the Traffic Mirror session.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeTrafficMirrorSessionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorSessions
SdkInternalList<T> trafficMirrorSessions

 Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described.
 Alternatively, you can filter the results.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. The value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeTrafficMirrorTargetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trafficMirrorTargetIds
SdkInternalList<T> trafficMirrorTargetIds

 The ID of the Traffic Mirror targets.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 description: The Traffic Mirror target description.
 
 
 
 
 network-interface-id: The ID of the Traffic Mirror session network interface.
 
 
 
 
 network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is
 associated with the session.
 
 
 
 
 owner-id: The ID of the account that owns the Traffic Mirror session.
 
 
 
 
 traffic-mirror-target-id: The ID of the Traffic Mirror target.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeTrafficMirrorTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorTargets
SdkInternalList<T> trafficMirrorTargets

 Information about one or more Traffic Mirror targets.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. The value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeTransitGatewayAttachmentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayAttachmentIds
SdkInternalList<T> transitGatewayAttachmentIds

 The IDs of the attachments.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 association.state - The state of the association (associating | associated
 | disassociating).
 
 
 
 
 association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
 
 
 
 
 resource-id - The ID of the resource.
 
 
 
 
 resource-owner-id - The ID of the AWS account that owns the resource.
 
 
 
 
 resource-type - The resource type (vpc | vpn).
 
 
 
 
 state - The state of the attachment (available | deleted |
 deleting | failed | modifying | pendingAcceptance |
 pending | rollingBack | rejected | rejecting).
 
 
 
 
 transit-gateway-attachment-id - The ID of the attachment.
 
 
 
 
 transit-gateway-id - The ID of the transit gateway.
 
 
 
 
 transit-gateway-owner-id - The ID of the AWS account that owns the transit gateway.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeTransitGatewayAttachmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayAttachments
SdkInternalList<T> transitGatewayAttachments

 Information about the attachments.
 


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.DescribeTransitGatewayMulticastDomainsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayMulticastDomainIds
SdkInternalList<T> transitGatewayMulticastDomainIds

 The ID of the transit gateway multicast domain.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 state - The state of the transit gateway multicast domain. Valid values are pending |
 available | deleting | deleted.
 
 
 
 
 transit-gateway-id - The ID of the transit gateway.
 
 
 
 
 transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeTransitGatewayMulticastDomainsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayMulticastDomains
SdkInternalList<T> transitGatewayMulticastDomains

 Information about the transit gateway multicast domains.
 


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.DescribeTransitGatewayPeeringAttachmentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayAttachmentIds
SdkInternalList<T> transitGatewayAttachmentIds

 One or more IDs of the transit gateway peering attachments.
 


filters
SdkInternalList<T> filters

 One or more filters.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeTransitGatewayPeeringAttachmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayPeeringAttachments
SdkInternalList<T> transitGatewayPeeringAttachments

 The transit gateway peering attachments.
 


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.DescribeTransitGatewayRouteTablesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayRouteTableIds
SdkInternalList<T> transitGatewayRouteTableIds

 The IDs of the transit gateway route tables.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 default-association-route-table - Indicates whether this is the default association route table for
 the transit gateway (true | false).
 
 
 
 
 default-propagation-route-table - Indicates whether this is the default propagation route table for
 the transit gateway (true | false).
 
 
 
 
 state - The state of the attachment (available | deleted |
 deleting | failed | modifying | pendingAcceptance |
 pending | rollingBack | rejected | rejecting).
 
 
 
 
 transit-gateway-id - The ID of the transit gateway.
 
 
 
 
 transit-gateway-route-table-id - The ID of the transit gateway route table.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeTransitGatewayRouteTablesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayRouteTables
SdkInternalList<T> transitGatewayRouteTables

 Information about the transit gateway route tables.
 


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.DescribeTransitGatewaysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayIds
SdkInternalList<T> transitGatewayIds

 The IDs of the transit gateways.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 options.propagation-default-route-table-id - The ID of the default propagation route table.
 
 
 
 
 options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
 
 
 
 
 options.association-default-route-table-id - The ID of the default association route table.
 
 
 
 
 options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of
 attachment requests (enable | disable).
 
 
 
 
 options.default-route-table-association - Indicates whether resource attachments are automatically
 associated with the default association route table (enable | disable).
 
 
 
 
 options.default-route-table-propagation - Indicates whether resource attachments automatically
 propagate routes to the default propagation route table (enable | disable).
 
 
 
 
 options.dns-support - Indicates whether DNS support is enabled (enable |
 disable).
 
 
 
 
 options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (
 enable | disable).
 
 
 
 
 owner-id - The ID of the AWS account that owns the transit gateway.
 
 
 
 
 state - The state of the attachment (available | deleted |
 deleting | failed | modifying | pendingAcceptance |
 pending | rollingBack | rejected | rejecting).
 
 
 
 
 transit-gateway-id - The ID of the transit gateway.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeTransitGatewaysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGateways
SdkInternalList<T> transitGateways

 Information about the transit 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.DescribeTransitGatewayVpcAttachmentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayAttachmentIds
SdkInternalList<T> transitGatewayAttachmentIds

 The IDs of the attachments.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 state - The state of the attachment (available | deleted |
 deleting | failed | modifying | pendingAcceptance |
 pending | rollingBack | rejected | rejecting).
 
 
 
 
 transit-gateway-attachment-id - The ID of the attachment.
 
 
 
 
 transit-gateway-id - The ID of the transit gateway.
 
 
 
 
 vpc-id - The ID of the VPC.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeTransitGatewayVpcAttachmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayVpcAttachments
SdkInternalList<T> transitGatewayVpcAttachments

 Information about the VPC attachments.
 


nextToken
String nextToken

 The token to use to retrieve the next page of results. This value is null when there are no more
 results to return.
 








Class com.amazonaws.services.ec2.model.DescribeVolumeAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


attribute
String attribute

 The attribute of the volume. This parameter is required.
 


volumeId
String volumeId

 The ID of the volume.
 








Class com.amazonaws.services.ec2.model.DescribeVolumeAttributeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


autoEnableIO
Boolean autoEnableIO

 The state of autoEnableIO attribute.
 


productCodes
SdkInternalList<T> productCodes

 A list of product codes.
 


volumeId
String volumeId

 The ID of the volume.
 








Class com.amazonaws.services.ec2.model.DescribeVolumesModificationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


volumeIds
SdkInternalList<T> volumeIds

 The IDs of the volumes for which in-progress modifications will be described.
 


filters
SdkInternalList<T> filters

 The filters. Supported filters: volume-id, modification-state, target-size, target-iops, target-volume-type, original-size,
 original-iops, original-volume-type, start-time.
 


nextToken
String nextToken

 The nextToken value returned by a previous paginated request.
 


maxResults
Integer maxResults

 The maximum number of results (up to a limit of 500) to be returned in a paginated request.
 








Class com.amazonaws.services.ec2.model.DescribeVolumesModificationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


volumesModifications
SdkInternalList<T> volumesModifications

 Information about the volume modifications.
 


nextToken
String nextToken

 Token for pagination, null if there are no more results
 








Class com.amazonaws.services.ec2.model.DescribeVolumesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The 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 specified in the block device mapping (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).
 
 
 
 
 availability-zone - The Availability Zone in which the volume was created.
 
 
 
 
 create-time - The time stamp when the volume was created.
 
 
 
 
 encrypted - Indicates whether the volume is encrypted (true | false)
 
 
 
 
 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> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 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.
 
 
 


volumeIds
SdkInternalList<T> volumeIds

 The volume IDs.
 


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 500; if MaxResults is given a value larger than 500, only 500 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.
 








Class com.amazonaws.services.ec2.model.DescribeVolumesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


volumes
SdkInternalList<T> volumes

 Information about the volumes.
 


nextToken
String nextToken

 The NextToken value to include in a future DescribeVolumes request. When the results of
 a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the
 next page of results. This value is null when there are no more results to return.
 








Class com.amazonaws.services.ec2.model.DescribeVolumeStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 The 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
SdkInternalList<T> volumeIds

 The IDs of the volumes.
 
 
 Default: Describes all your volumes.
 








Class com.amazonaws.services.ec2.model.DescribeVolumeStatusResult extends AmazonWebServiceResult<ResponseMetadata> 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
SdkInternalList<T> volumeStatuses

 Information about the status of the volumes.
 








Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcId
String vpcId

 The ID of the VPC.
 


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.
 








Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkDnsSupportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 


vpcIds
SdkInternalList<T> vpcIds

 One or more VPC IDs.
 








Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkDnsSupportResult extends AmazonWebServiceResult<ResponseMetadata> 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.
 


vpcs
SdkInternalList<T> vpcs

 Information about the ClassicLink DNS support status of the VPCs.
 








Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true |
 false).
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 


vpcIds
SdkInternalList<T> vpcIds

 One or more VPCs for which you want to describe the ClassicLink status.
 








Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcs
SdkInternalList<T> vpcs

 The ClassicLink status of one or more VPCs.
 








Class com.amazonaws.services.ec2.model.DescribeVpcEndpointConnectionNotificationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionNotificationId
String connectionNotificationId

 The ID of the notification.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 connection-notification-arn - The ARN of the SNS topic for the notification.
 
 
 
 
 connection-notification-id - The ID of the notification.
 
 
 
 
 connection-notification-state - The state of the notification (Enabled |
 Disabled).
 
 
 
 
 connection-notification-type - The type of notification (Topic).
 
 
 
 
 service-id - The ID of the endpoint service.
 
 
 
 
 vpc-endpoint-id - The ID of the VPC endpoint.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return in a single call. To retrieve the remaining results, make another request
 with the returned NextToken value.
 


nextToken
String nextToken

 The token to request the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeVpcEndpointConnectionNotificationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectionNotificationSet
SdkInternalList<T> connectionNotificationSet

 One or more notifications.
 


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.DescribeVpcEndpointConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 service-id - The ID of the service.
 
 
 
 
 vpc-endpoint-owner - The AWS account number of the owner of the endpoint.
 
 
 
 
 vpc-endpoint-state - The state of the endpoint (pendingAcceptance |
 pending | available | deleting | deleted |
 rejected | failed).
 
 
 
 
 vpc-endpoint-id - The ID of the endpoint.
 
 
 


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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are
 returned.
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeVpcEndpointConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcEndpointConnections
SdkInternalList<T> vpcEndpointConnections

 Information about one or more VPC endpoint connections.
 


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.DescribeVpcEndpointServiceConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceIds
SdkInternalList<T> serviceIds

 The IDs of one or more services.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 service-name - The name of the service.
 
 
 
 
 service-id - The ID of the service.
 
 
 
 
 service-state - The state of the service (Pending | Available |
 Deleting | Deleted | Failed).
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 


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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are
 returned.
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeVpcEndpointServiceConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serviceConfigurations
SdkInternalList<T> serviceConfigurations

 Information about one or more services.
 


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.DescribeVpcEndpointServicePermissionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceId
String serviceId

 The ID of the service.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 principal - The ARN of the principal.
 
 
 
 
 principal-type - The principal type (All | Service |
 OrganizationUnit | Account | User | Role).
 
 
 


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 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are
 returned.
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 








Class com.amazonaws.services.ec2.model.DescribeVpcEndpointServicePermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


allowedPrincipals
SdkInternalList<T> allowedPrincipals

 Information about one or more allowed principals.
 


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.DescribeVpcEndpointServicesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceNames
SdkInternalList<T> serviceNames

 One or more service names.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 service-name - The name of the service.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 


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 1,000, we return only 1,000 items.
 


nextToken
String nextToken

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








Class com.amazonaws.services.ec2.model.DescribeVpcEndpointServicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serviceNames
SdkInternalList<T> serviceNames

 A list of supported services.
 


serviceDetails
SdkInternalList<T> serviceDetails

 Information about the service.
 


nextToken
String nextToken

 The token to use when requesting the next set of items. If there are no additional items to return, the string is
 empty.
 








Class com.amazonaws.services.ec2.model.DescribeVpcEndpointsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcEndpointIds
SdkInternalList<T> vpcEndpointIds

 One or more endpoint IDs.
 


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 service-name - The name of the 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 (pendingAcceptance |
 pending | available | deleting | deleted |
 rejected | failed).
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 


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 1,000, we return only 1,000 items.
 


nextToken
String nextToken

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








Class com.amazonaws.services.ec2.model.DescribeVpcEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcEndpoints
SdkInternalList<T> vpcEndpoints

 Information about the endpoints.
 


nextToken
String nextToken

 The token to use when requesting the next set of items. If there are no additional items to return, the string is
 empty.
 








Class com.amazonaws.services.ec2.model.DescribeVpcPeeringConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
 
 
 
 
 accepter-vpc-info.owner-id - The AWS account ID of the owner of the accepter VPC.
 
 
 
 
 accepter-vpc-info.vpc-id - The ID of the accepter VPC.
 
 
 
 
 expiration-time - The expiration date and time for the VPC peering connection.
 
 
 
 
 requester-vpc-info.cidr-block - The IPv4 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 |
 deleting | deleted | rejected).
 
 
 
 
 status-message - A message that provides more information about the status of the VPC peering
 connection, if applicable.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 vpc-peering-connection-id - The ID of the VPC peering connection.
 
 
 


vpcPeeringConnectionIds
SdkInternalList<T> vpcPeeringConnectionIds

 One or more VPC peering connection IDs.
 
 
 Default: Describes all your VPC peering connections.
 


nextToken
String nextToken

 The token for the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 








Class com.amazonaws.services.ec2.model.DescribeVpcPeeringConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcPeeringConnections
SdkInternalList<T> vpcPeeringConnections

 Information about the VPC peering connections.
 


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.DescribeVpcsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 cidr - The primary IPv4 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).
 
 
 
 
 cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
 
 
 
 
 cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with
 the VPC.
 
 
 
 
 cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
 
 
 
 
 dhcp-options-id - The ID of a set of DHCP options.
 
 
 
 
 ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
 
 
 
 
 ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR
 block is allocated.
 
 
 
 
 ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated
 with the VPC.
 
 
 
 
 ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
 
 
 
 
 isDefault - Indicates whether the VPC is the default VPC.
 
 
 
 
 owner-id - The ID of the AWS account that owns the VPC.
 
 
 
 
 state - The state of the VPC (pending | available).
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 vpc-id - The ID of the VPC.
 
 
 


vpcIds
SdkInternalList<T> vpcIds

 One or more VPC IDs.
 
 
 Default: Describes all your VPCs.
 


nextToken
String nextToken

 The token for the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 








Class com.amazonaws.services.ec2.model.DescribeVpcsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcs
SdkInternalList<T> vpcs

 Information about one or more VPCs.
 


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.DescribeVpnConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 customer-gateway-configuration - The configuration information for the customer gateway.
 
 
 
 
 customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
 
 
 
 
 state - The state of the VPN connection (pending | available |
 deleting | deleted).
 
 
 
 
 option.static-routes-only - Indicates whether the connection has static routes only. Used for
 devices that do not support Border Gateway Protocol (BGP).
 
 
 
 
 route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a
 customer data center.
 
 
 
 
 bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
 
 
 
 
 tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 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.
 
 
 
 
 transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
 
 
 


vpnConnectionIds
SdkInternalList<T> vpnConnectionIds

 One or more VPN connection IDs.
 
 
 Default: Describes your VPN connections.
 








Class com.amazonaws.services.ec2.model.DescribeVpnConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpnConnections
SdkInternalList<T> vpnConnections

 Information about one or more VPN connections.
 








Class com.amazonaws.services.ec2.model.DescribeVpnGatewaysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 One or more filters.
 
 
 
 
 amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
 
 
 
 
 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> - The key/value combination of a tag assigned to the resource. Use the tag key in
 the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
 the key Owner and the value TeamA, specify tag:Owner for the filter name
 and TeamA for the filter value.
 
 
 
 
 tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
 a tag with a specific key, regardless of the tag value.
 
 
 
 
 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
SdkInternalList<T> vpnGatewayIds

 One or more virtual private gateway IDs.
 
 
 Default: Describes all your virtual private gateways.
 








Class com.amazonaws.services.ec2.model.DescribeVpnGatewaysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpnGateways
SdkInternalList<T> vpnGateways

 Information about one or more virtual private gateways.
 








Class com.amazonaws.services.ec2.model.DetachClassicLinkVpcRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance to unlink from the VPC.
 


vpcId
String vpcId

 The ID of the VPC to which the instance is linked.
 








Class com.amazonaws.services.ec2.model.DetachClassicLinkVpcResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.DetachInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


internetGatewayId
String internetGatewayId

 The ID of the internet gateway.
 


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.DetachInternetGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DetachNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


attachmentId
String attachmentId

 The ID of the attachment.
 


force
Boolean force

 Specifies whether to force a detachment.
 
 
 
 
 
 Use the Force parameter only as a last resort to detach a network interface from a failed instance.
 
 
 
 
 If you use the Force parameter to detach a network interface, you might not be able to attach a
 different network interface to the same index on the instance without first stopping and starting the instance.
 
 
 
 
 If you force the detachment of a network interface, the instance metadata might
 not get updated. This means that the attributes associated with the detached network interface might still be
 visible. The instance metadata will get updated when you stop and start the instance.
 
 
 
 








Class com.amazonaws.services.ec2.model.DetachNetworkInterfaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attachment
VolumeAttachment attachment

 Describes volume attachment details.
 








Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DhcpConfiguration extends Object implements Serializable


Serialized Fields


key
String key

 The name of a DHCP option.
 


values
SdkInternalList<T> values

 One or more values for the DHCP option.
 








Class com.amazonaws.services.ec2.model.DhcpOptions extends Object implements Serializable


Serialized Fields


dhcpConfigurations
SdkInternalList<T> dhcpConfigurations

 One or more DHCP options in the set.
 


dhcpOptionsId
String dhcpOptionsId

 The ID of the set of DHCP options.
 


ownerId
String ownerId

 The ID of the AWS account that owns the DHCP options set.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the DHCP options set.
 








Class com.amazonaws.services.ec2.model.DirectoryServiceAuthentication extends Object implements Serializable


Serialized Fields


directoryId
String directoryId

 The ID of the Active Directory used for authentication.
 








Class com.amazonaws.services.ec2.model.DirectoryServiceAuthenticationRequest extends Object implements Serializable


Serialized Fields


directoryId
String directoryId

 The ID of the Active Directory to be used for authentication.
 








Class com.amazonaws.services.ec2.model.DisableEbsEncryptionByDefaultRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.ec2.model.DisableEbsEncryptionByDefaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ebsEncryptionByDefault
Boolean ebsEncryptionByDefault

 The updated status of encryption by default.
 








Class com.amazonaws.services.ec2.model.DisableFastSnapshotRestoreErrorItem extends Object implements Serializable


Serialized Fields


snapshotId
String snapshotId

 The ID of the snapshot.
 


fastSnapshotRestoreStateErrors
SdkInternalList<T> fastSnapshotRestoreStateErrors

 The errors.
 








Class com.amazonaws.services.ec2.model.DisableFastSnapshotRestoresRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZones
SdkInternalList<T> availabilityZones

 One or more Availability Zones. For example, us-east-2a.
 


sourceSnapshotIds
SdkInternalList<T> sourceSnapshotIds

 The IDs of one or more snapshots. For example, snap-1234567890abcdef0.
 








Class com.amazonaws.services.ec2.model.DisableFastSnapshotRestoresResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successful
SdkInternalList<T> successful

 Information about the snapshots for which fast snapshot restores were successfully disabled.
 


unsuccessful
SdkInternalList<T> unsuccessful

 Information about the snapshots for which fast snapshot restores could not be disabled.
 








Class com.amazonaws.services.ec2.model.DisableFastSnapshotRestoreStateError extends Object implements Serializable


Serialized Fields


code
String code

 The error code.
 


message
String message

 The error message.
 








Class com.amazonaws.services.ec2.model.DisableFastSnapshotRestoreStateErrorItem extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone.
 


error
DisableFastSnapshotRestoreStateError error

 The error.
 








Class com.amazonaws.services.ec2.model.DisableFastSnapshotRestoreSuccessItem extends Object implements Serializable


Serialized Fields


snapshotId
String snapshotId

 The ID of the snapshot.
 


availabilityZone
String availabilityZone

 The Availability Zone.
 


state
String state

 The state of fast snapshot restores for the snapshot.
 


stateTransitionReason
String stateTransitionReason

 The reason for the state transition. The possible values are as follows:
 
 
 
 
 Client.UserInitiated - The state successfully transitioned to enabling or
 disabling.
 
 
 
 
 Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to
 optimizing, enabled, or disabled.
 
 
 


ownerId
String ownerId

 The ID of the AWS account that owns the snapshot.
 


ownerAlias
String ownerAlias

 The alias of the snapshot owner.
 


enablingTime
Date enablingTime

 The time at which fast snapshot restores entered the enabling state.
 


optimizingTime
Date optimizingTime

 The time at which fast snapshot restores entered the optimizing state.
 


enabledTime
Date enabledTime

 The time at which fast snapshot restores entered the enabled state.
 


disablingTime
Date disablingTime

 The time at which fast snapshot restores entered the disabling state.
 


disabledTime
Date disabledTime

 The time at which fast snapshot restores entered the disabled state.
 








Class com.amazonaws.services.ec2.model.DisableTransitGatewayRouteTablePropagationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the propagation route table.
 


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 








Class com.amazonaws.services.ec2.model.DisableTransitGatewayRouteTablePropagationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


propagation
TransitGatewayPropagation propagation

 Information about route propagation.
 








Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkDnsSupportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkDnsSupportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.DisassociateAddressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DisassociateClientVpnTargetNetworkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint from which to disassociate the target network.
 


associationId
String associationId

 The ID of the target network association.
 








Class com.amazonaws.services.ec2.model.DisassociateClientVpnTargetNetworkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


associationId
String associationId

 The ID of the target network association.
 


status
AssociationStatus status

 The current state of the target network association.
 








Class com.amazonaws.services.ec2.model.DisassociateIamInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationId
String associationId

 The ID of the IAM instance profile association.
 








Class com.amazonaws.services.ec2.model.DisassociateIamInstanceProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


iamInstanceProfileAssociation
IamInstanceProfileAssociation iamInstanceProfileAssociation

 Information about the IAM instance profile association.
 








Class com.amazonaws.services.ec2.model.DisassociateRouteTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationId
String associationId

 The association ID representing the current association between the route table and subnet.
 








Class com.amazonaws.services.ec2.model.DisassociateRouteTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.DisassociateSubnetCidrBlockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationId
String associationId

 The association ID for the CIDR block.
 








Class com.amazonaws.services.ec2.model.DisassociateSubnetCidrBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ipv6CidrBlockAssociation
SubnetIpv6CidrBlockAssociation ipv6CidrBlockAssociation

 Information about the IPv6 CIDR block association.
 


subnetId
String subnetId

 The ID of the subnet.
 








Class com.amazonaws.services.ec2.model.DisassociateTransitGatewayMulticastDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 


subnetIds
SdkInternalList<T> subnetIds

 The IDs of the subnets;
 








Class com.amazonaws.services.ec2.model.DisassociateTransitGatewayMulticastDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


associations
TransitGatewayMulticastDomainAssociations associations

 Information about the association.
 








Class com.amazonaws.services.ec2.model.DisassociateTransitGatewayRouteTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the transit gateway route table.
 


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 








Class com.amazonaws.services.ec2.model.DisassociateTransitGatewayRouteTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


association
TransitGatewayAssociation association

 Information about the association.
 








Class com.amazonaws.services.ec2.model.DisassociateVpcCidrBlockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationId
String associationId

 The association ID for the CIDR block.
 








Class com.amazonaws.services.ec2.model.DisassociateVpcCidrBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ipv6CidrBlockAssociation
VpcIpv6CidrBlockAssociation ipv6CidrBlockAssociation

 Information about the IPv6 CIDR block association.
 


cidrBlockAssociation
VpcCidrBlockAssociation cidrBlockAssociation

 Information about the IPv4 CIDR block association.
 


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.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 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 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 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.DiskInfo extends Object implements Serializable


Serialized Fields


sizeInGB
Long sizeInGB

 The size of the disk in GB.
 


count
Integer count

 The number of disks with this configuration.
 


type
String type

 The type of disk.
 








Class com.amazonaws.services.ec2.model.DnsEntry extends Object implements Serializable


Serialized Fields


dnsName
String dnsName

 The DNS name.
 


hostedZoneId
String hostedZoneId

 The ID of the private hosted zone.
 








Class com.amazonaws.services.ec2.model.DnsServersOptionsModifyStructure extends Object implements Serializable


Serialized Fields


customDnsServers
SdkInternalList<T> customDnsServers

 The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers.
 Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values.
 


enabled
Boolean enabled

 Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers.
 








Class com.amazonaws.services.ec2.model.EbsBlockDevice extends Object implements Serializable


Serialized Fields


deleteOnTermination
Boolean deleteOnTermination

 Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination in the Amazon Elastic Compute Cloud User Guide.
 


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, see Amazon
 EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
 
 
 Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1
 volumes in most Regions. Maximum io1 IOPS of 64,000 is guaranteed only on Nitro-based
 instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the
 Amazon Elastic Compute Cloud User Guide.
 
 
 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.
 
 
 Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the
 snapshot size.
 
 
 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.
 


volumeType
String volumeType

 The volume type. If you set the type to io1, you must also specify the Iops parameter. If you
 set the type to gp2, st1, sc1, or standard, you must omit the
 Iops parameter.
 
 
 Default: gp2
 


kmsKeyId
String kmsKeyId

 Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is
 encrypted.
 
 
 This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and
 
 RequestSpotInstances.
 


encrypted
Boolean encrypted

 Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot.
 The effect of setting the encryption state to true depends on the volume origin (new or from a
 snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more
 information, see Amazon EBS
 Encryption in the Amazon Elastic Compute Cloud User Guide.
 
 
 In no case can you remove encryption from an encrypted volume.
 
 
 Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see
 Supported Instance Types.
 








Class com.amazonaws.services.ec2.model.EbsInfo extends Object implements Serializable


Serialized Fields


ebsOptimizedSupport
String ebsOptimizedSupport

 Indicates that the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-Optimized Instances
 in Amazon EC2 User Guide for Linux Instances.
 


encryptionSupport
String encryptionSupport

 Indicates whether Amazon EBS encryption is supported.
 








Class com.amazonaws.services.ec2.model.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 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.EgressOnlyInternetGateway extends Object implements Serializable


Serialized Fields


attachments
SdkInternalList<T> attachments

 Information about the attachment of the egress-only internet gateway.
 


egressOnlyInternetGatewayId
String egressOnlyInternetGatewayId

 The ID of the egress-only internet gateway.
 


tags
SdkInternalList<T> tags

 The tags assigned to the egress-only internet gateway.
 








Class com.amazonaws.services.ec2.model.ElasticGpuAssociation extends Object implements Serializable


Serialized Fields


elasticGpuId
String elasticGpuId

 The ID of the Elastic Graphics accelerator.
 


elasticGpuAssociationId
String elasticGpuAssociationId

 The ID of the association.
 


elasticGpuAssociationState
String elasticGpuAssociationState

 The state of the association between the instance and the Elastic Graphics accelerator.
 


elasticGpuAssociationTime
String elasticGpuAssociationTime

 The time the Elastic Graphics accelerator was associated with the instance.
 








Class com.amazonaws.services.ec2.model.ElasticGpuHealth extends Object implements Serializable


Serialized Fields


status
String status

 The health status.
 








Class com.amazonaws.services.ec2.model.ElasticGpus extends Object implements Serializable


Serialized Fields


elasticGpuId
String elasticGpuId

 The ID of the Elastic Graphics accelerator.
 


availabilityZone
String availabilityZone

 The Availability Zone in the which the Elastic Graphics accelerator resides.
 


elasticGpuType
String elasticGpuType

 The type of Elastic Graphics accelerator.
 


elasticGpuHealth
ElasticGpuHealth elasticGpuHealth

 The status of the Elastic Graphics accelerator.
 


elasticGpuState
String elasticGpuState

 The state of the Elastic Graphics accelerator.
 


instanceId
String instanceId

 The ID of the instance to which the Elastic Graphics accelerator is attached.
 


tags
SdkInternalList<T> tags

 The tags assigned to the Elastic Graphics accelerator.
 








Class com.amazonaws.services.ec2.model.ElasticGpuSpecification extends Object implements Serializable


Serialized Fields


type
String type

 The type of Elastic Graphics accelerator. For more information about the values to specify for Type,
 see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the Amazon Elastic
 Compute Cloud User Guide for Windows Instances.
 








Class com.amazonaws.services.ec2.model.ElasticGpuSpecificationResponse extends Object implements Serializable


Serialized Fields


type
String type

 The elastic GPU type.
 








Class com.amazonaws.services.ec2.model.ElasticInferenceAccelerator extends Object implements Serializable


Serialized Fields


type
String type

 The type of elastic inference accelerator. The possible values are eia1.medium,
 eia1.large, and eia1.xlarge.
 


count
Integer count

 The number of elastic inference accelerators to attach to the instance.
 
 
 Default: 1
 








Class com.amazonaws.services.ec2.model.ElasticInferenceAcceleratorAssociation extends Object implements Serializable


Serialized Fields


elasticInferenceAcceleratorArn
String elasticInferenceAcceleratorArn

 The Amazon Resource Name (ARN) of the elastic inference accelerator.
 


elasticInferenceAcceleratorAssociationId
String elasticInferenceAcceleratorAssociationId

 The ID of the association.
 


elasticInferenceAcceleratorAssociationState
String elasticInferenceAcceleratorAssociationState

 The state of the elastic inference accelerator.
 


elasticInferenceAcceleratorAssociationTime
Date elasticInferenceAcceleratorAssociationTime

 The time at which the elastic inference accelerator is associated with an instance.
 








Class com.amazonaws.services.ec2.model.EnableEbsEncryptionByDefaultRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.ec2.model.EnableEbsEncryptionByDefaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ebsEncryptionByDefault
Boolean ebsEncryptionByDefault

 The updated status of encryption by default.
 








Class com.amazonaws.services.ec2.model.EnableFastSnapshotRestoreErrorItem extends Object implements Serializable


Serialized Fields


snapshotId
String snapshotId

 The ID of the snapshot.
 


fastSnapshotRestoreStateErrors
SdkInternalList<T> fastSnapshotRestoreStateErrors

 The errors.
 








Class com.amazonaws.services.ec2.model.EnableFastSnapshotRestoresRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZones
SdkInternalList<T> availabilityZones

 One or more Availability Zones. For example, us-east-2a.
 


sourceSnapshotIds
SdkInternalList<T> sourceSnapshotIds

 The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify a snapshot
 that was shared with you from another AWS account.
 








Class com.amazonaws.services.ec2.model.EnableFastSnapshotRestoresResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successful
SdkInternalList<T> successful

 Information about the snapshots for which fast snapshot restores were successfully enabled.
 


unsuccessful
SdkInternalList<T> unsuccessful

 Information about the snapshots for which fast snapshot restores could not be enabled.
 








Class com.amazonaws.services.ec2.model.EnableFastSnapshotRestoreStateError extends Object implements Serializable


Serialized Fields


code
String code

 The error code.
 


message
String message

 The error message.
 








Class com.amazonaws.services.ec2.model.EnableFastSnapshotRestoreStateErrorItem extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone.
 


error
EnableFastSnapshotRestoreStateError error

 The error.
 








Class com.amazonaws.services.ec2.model.EnableFastSnapshotRestoreSuccessItem extends Object implements Serializable


Serialized Fields


snapshotId
String snapshotId

 The ID of the snapshot.
 


availabilityZone
String availabilityZone

 The Availability Zone.
 


state
String state

 The state of fast snapshot restores.
 


stateTransitionReason
String stateTransitionReason

 The reason for the state transition. The possible values are as follows:
 
 
 
 
 Client.UserInitiated - The state successfully transitioned to enabling or
 disabling.
 
 
 
 
 Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to
 optimizing, enabled, or disabled.
 
 
 


ownerId
String ownerId

 The ID of the AWS account that owns the snapshot.
 


ownerAlias
String ownerAlias

 The alias of the snapshot owner.
 


enablingTime
Date enablingTime

 The time at which fast snapshot restores entered the enabling state.
 


optimizingTime
Date optimizingTime

 The time at which fast snapshot restores entered the optimizing state.
 


enabledTime
Date enabledTime

 The time at which fast snapshot restores entered the enabled state.
 


disablingTime
Date disablingTime

 The time at which fast snapshot restores entered the disabling state.
 


disabledTime
Date disabledTime

 The time at which fast snapshot restores entered the disabled state.
 








Class com.amazonaws.services.ec2.model.EnableTransitGatewayRouteTablePropagationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the propagation route table.
 


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 








Class com.amazonaws.services.ec2.model.EnableTransitGatewayRouteTablePropagationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


propagation
TransitGatewayPropagation propagation

 Information about route propagation.
 








Class com.amazonaws.services.ec2.model.EnableVgwRoutePropagationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


gatewayId
String gatewayId

 The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to
 the same VPC that the routing tables are associated with.
 


routeTableId
String routeTableId

 The ID of the route table. The routing table must be associated with the same VPC that the virtual private
 gateway is attached to.
 








Class com.amazonaws.services.ec2.model.EnableVgwRoutePropagationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.EnableVolumeIORequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


volumeId
String volumeId

 The ID of the volume.
 








Class com.amazonaws.services.ec2.model.EnableVolumeIOResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkDnsSupportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkDnsSupportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.EventInformation extends Object implements Serializable


Serialized Fields


eventDescription
String eventDescription

 The description of the event.
 


eventSubType
String eventSubType

 The event.
 
 
 The following are the error events:
 
 
 
 
 iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet did not have the required permissions either to
 launch or terminate an instance.
 
 
 
 
 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 EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to
 maintain the target number of running Spot Instances.
 
 
 
 
 cancelled - The EC2 Fleet or Spot Fleet request is canceled and has no running Spot Instances. The
 EC2 Fleet or Spot Fleet will be deleted two days after its instances were terminated.
 
 
 
 
 cancelled_running - The EC2 Fleet or Spot Fleet request is canceled and does not launch additional
 Spot Instances. Existing Spot Instances continue to run until they are interrupted or terminated.
 
 
 
 
 cancelled_terminating - The EC2 Fleet or Spot Fleet request is canceled and its Spot Instances are
 terminating.
 
 
 
 
 expired - The EC2 Fleet or 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 EC2 Fleet or Spot Fleet request was accepted and is in
 progress.
 
 
 
 
 modify_successful - The EC2 Fleet or Spot Fleet request was modified.
 
 
 
 
 price_update - The price for a launch configuration was adjusted because it was too high. This
 change is permanent.
 
 
 
 
 submitted - The EC2 Fleet or 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 request was fulfilled and a new instance was launched.
 
 
 
 
 terminated - An instance was terminated by the user.
 
 
 
 
 The following are the Information events:
 
 
 
 
 launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch
 instances have failed. For more information, see the description of the event.
 
 
 
 
 launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot
 price or the Spot price is above the On-Demand price.
 
 
 
 
 fleetProgressHalted - The price in every launch specification is not valid. A launch specification
 might become valid if the Spot price changes.
 
 
 


instanceId
String instanceId

 The ID of the instance. This information is available only for instanceChange events.
 








Class com.amazonaws.services.ec2.model.ExportClientVpnClientCertificateRevocationListRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint.
 








Class com.amazonaws.services.ec2.model.ExportClientVpnClientCertificateRevocationListResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificateRevocationList
String certificateRevocationList

 Information about the client certificate revocation list.
 


status
ClientCertificateRevocationListStatus status

 The current state of the client certificate revocation list.
 








Class com.amazonaws.services.ec2.model.ExportClientVpnClientConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint.
 








Class com.amazonaws.services.ec2.model.ExportClientVpnClientConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientConfiguration
String clientConfiguration

 The contents of the Client VPN endpoint configuration file.
 








Class com.amazonaws.services.ec2.model.ExportImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientToken
String clientToken

 Token to enable idempotency for export image requests.
 


description
String description

 A description of the image being exported. The maximum length is 255 bytes.
 


diskImageFormat
String diskImageFormat

 The disk image format.
 


imageId
String imageId

 The ID of the image.
 


s3ExportLocation
ExportTaskS3LocationRequest s3ExportLocation

 Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to
 the AWS account [email protected].
 


roleName
String roleName

 The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this
 parameter is not specified, the default role is named 'vmimport'.
 








Class com.amazonaws.services.ec2.model.ExportImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


description
String description

 A description of the image being exported.
 


diskImageFormat
String diskImageFormat

 The disk image format for the exported image.
 


exportImageTaskId
String exportImageTaskId

 The ID of the export image task.
 


imageId
String imageId

 The ID of the image.
 


roleName
String roleName

 The name of the role that grants VM Import/Export permission to export images to your S3 bucket.
 


progress
String progress

 The percent complete of the export image task.
 


s3ExportLocation
ExportTaskS3Location s3ExportLocation

 Information about the destination S3 bucket.
 


status
String status

 The status of the export image task. The possible values are active, completed,
 deleting, and deleted.
 


statusMessage
String statusMessage

 The status message for the export image task.
 








Class com.amazonaws.services.ec2.model.ExportImageTask extends Object implements Serializable


Serialized Fields


description
String description

 A description of the image being exported.
 


exportImageTaskId
String exportImageTaskId

 The ID of the export image task.
 


imageId
String imageId

 The ID of the image.
 


progress
String progress

 The percent complete of the export image task.
 


s3ExportLocation
ExportTaskS3Location s3ExportLocation

 Information about the destination S3 bucket.
 


status
String status

 The status of the export image task. The possible values are active, completed,
 deleting, and deleted.
 


statusMessage
String statusMessage

 The status message for the export image task.
 








Class com.amazonaws.services.ec2.model.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.
 


tags
SdkInternalList<T> tags

 The tags for the export task.
 








Class com.amazonaws.services.ec2.model.ExportTaskS3Location extends Object implements Serializable


Serialized Fields


s3Bucket
String s3Bucket

 The destination S3 bucket.
 


s3Prefix
String s3Prefix

 The prefix (logical hierarchy) in the bucket.
 








Class com.amazonaws.services.ec2.model.ExportTaskS3LocationRequest extends Object implements Serializable


Serialized Fields


s3Bucket
String s3Bucket

 The destination S3 bucket.
 


s3Prefix
String s3Prefix

 The prefix (logical hierarchy) in the bucket.
 








Class com.amazonaws.services.ec2.model.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 [email protected].
 


s3Key
String s3Key

 The encryption key for your S3 bucket.
 








Class com.amazonaws.services.ec2.model.ExportToS3TaskSpecification extends Object implements Serializable


Serialized Fields


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 [email protected].
 


s3Prefix
String s3Prefix

 The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' +
 diskImageFormat.
 








Class com.amazonaws.services.ec2.model.ExportTransitGatewayRoutesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the route table.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
 
 
 
 
 attachment.resource-id - The resource id of the transit gateway attachment.
 
 
 
 
 route-search.exact-match - The exact match of the specified filter.
 
 
 
 
 route-search.longest-prefix-match - The longest prefix that matches the route.
 
 
 
 
 route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
 
 
 
 
 route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example,
 if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as
 10.0.1.0/30, then the result returns 10.0.1.0/29.
 
 
 
 
 state - The state of the attachment (available | deleted |
 deleting | failed | modifying | pendingAcceptance |
 pending | rollingBack | rejected | rejecting).
 
 
 
 
 transit-gateway-route-destination-cidr-block - The CIDR range.
 
 
 
 
 type - The type of route (active | blackhole).
 
 
 


s3Bucket
String s3Bucket

 The name of the S3 bucket.
 








Class com.amazonaws.services.ec2.model.ExportTransitGatewayRoutesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


s3Location
String s3Location

 The URL of the exported file in Amazon S3. For example,
 s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.
 








Class com.amazonaws.services.ec2.model.FailedQueuedPurchaseDeletion extends Object implements Serializable


Serialized Fields


error
DeleteQueuedReservedInstancesError error

 The error.
 


reservedInstancesId
String reservedInstancesId

 The ID of the Reserved Instance.
 








Class com.amazonaws.services.ec2.model.Filter extends Object implements Serializable


Serialized Fields


name
String name

 The name of the filter. Filter names are case-sensitive.
 


values
SdkInternalList<T> values

 The filter values. Filter values are case-sensitive.
 








Class com.amazonaws.services.ec2.model.FleetData extends Object implements Serializable


Serialized Fields


activityStatus
String activityStatus

 The progress of the EC2 Fleet. If there is an error, the status is error. After all requests are
 placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than
 its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status
 is pending_termination while instances are terminating.
 


createTime
Date createTime

 The creation date and time of the EC2 Fleet.
 


fleetId
String fleetId

 The ID of the EC2 Fleet.
 


fleetState
String fleetState

 The state of the EC2 Fleet.
 


clientToken
String clientToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more
 information, see Ensuring
 Idempotency.
 
 
 Constraints: Maximum 64 ASCII characters
 


excessCapacityTerminationPolicy
String excessCapacityTerminationPolicy

 Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased
 below the current size of the EC2 Fleet.
 


fulfilledCapacity
Double fulfilledCapacity

 The number of units fulfilled by this request compared to the set target capacity.
 


fulfilledOnDemandCapacity
Double fulfilledOnDemandCapacity

 The number of units fulfilled by this request compared to the set target On-Demand capacity.
 


launchTemplateConfigs
SdkInternalList<T> launchTemplateConfigs

 The launch template and overrides.
 


targetCapacitySpecification
TargetCapacitySpecification targetCapacitySpecification

 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. If the request type
 is maintain, you can specify a target capacity of 0 and add capacity later.
 


terminateInstancesWithExpiration
Boolean terminateInstancesWithExpiration

 Indicates whether running instances should be terminated when the EC2 Fleet expires.
 


type
String type

 The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also
 attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the
 required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit
 requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2
 Fleet places the required requests to meet this target capacity. It also automatically replenishes any
 interrupted Spot Instances. Default: maintain.
 


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 instance requests are
 placed or able to fulfill the request. The default end date is 7 days from the current date.
 


replaceUnhealthyInstances
Boolean replaceUnhealthyInstances

 Indicates whether EC2 Fleet should replace unhealthy instances.
 


spotOptions
SpotOptions spotOptions

 The configuration of Spot Instances in an EC2 Fleet.
 


onDemandOptions
OnDemandOptions onDemandOptions

 The allocation strategy of On-Demand Instances in an EC2 Fleet.
 


tags
SdkInternalList<T> tags

 The tags for an EC2 Fleet resource.
 


errors
SdkInternalList<T> errors

 Information about the instances that could not be launched by the fleet. Valid only when Type is set to
 instant.
 


instances
SdkInternalList<T> instances

 Information about the instances that were launched by the fleet. Valid only when Type is set to
 instant.
 








Class com.amazonaws.services.ec2.model.FleetLaunchTemplateConfig extends Object implements Serializable


Serialized Fields


launchTemplateSpecification
FleetLaunchTemplateSpecification launchTemplateSpecification

 The launch template.
 


overrides
SdkInternalList<T> overrides

 Any parameters that you specify override the same parameters in the launch template.
 








Class com.amazonaws.services.ec2.model.FleetLaunchTemplateConfigRequest extends Object implements Serializable


Serialized Fields


launchTemplateSpecification
FleetLaunchTemplateSpecificationRequest launchTemplateSpecification

 The launch template to use. You must specify either the launch template ID or launch template name in the
 request.
 


overrides
SdkInternalList<T> overrides

 Any parameters that you specify override the same parameters in the launch template.
 








Class com.amazonaws.services.ec2.model.FleetLaunchTemplateOverrides extends Object implements Serializable


Serialized Fields


instanceType
String instanceType

 The instance type.
 


maxPrice
String maxPrice

 The maximum price per unit hour that you are willing to pay for a Spot Instance.
 


subnetId
String subnetId

 The ID of the subnet in which to launch the instances.
 


availabilityZone
String availabilityZone

 The Availability Zone in which to launch the instances.
 


weightedCapacity
Double weightedCapacity

 The number of units provided by the specified instance type.
 


priority
Double priority

 The priority for the launch template override. If AllocationStrategy is set to prioritized,
 EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand
 capacity. The highest priority is launched first. Valid values are whole numbers starting at 0. The
 lower the number, the higher the priority. If no number is set, the override has the lowest priority.
 


placement
PlacementResponse placement

 The location where the instance launched, if applicable.
 








Class com.amazonaws.services.ec2.model.FleetLaunchTemplateOverridesRequest extends Object implements Serializable


Serialized Fields


instanceType
String instanceType

 The instance type.
 


maxPrice
String maxPrice

 The maximum price per unit hour that you are willing to pay for a Spot Instance.
 


subnetId
String subnetId

 The ID of the subnet in which to launch the instances.
 


availabilityZone
String availabilityZone

 The Availability Zone in which to launch the instances.
 


weightedCapacity
Double weightedCapacity

 The number of units provided by the specified instance type.
 


priority
Double priority

 The priority for the launch template override. If AllocationStrategy is set to prioritized,
 EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand
 capacity. The highest priority is launched first. Valid values are whole numbers starting at 0. The
 lower the number, the higher the priority. If no number is set, the launch template override has the lowest
 priority.
 


placement
Placement placement

 The location where the instance launched, if applicable.
 








Class com.amazonaws.services.ec2.model.FleetLaunchTemplateSpecification extends Object implements Serializable


Serialized Fields


launchTemplateId
String launchTemplateId

 The ID of the launch template. You must specify either a template ID or a template name.
 


launchTemplateName
String launchTemplateName

 The name of the launch template. You must specify either a template name or a template ID.
 


version
String version

 The version number of the launch template. You must specify a version number.
 








Class com.amazonaws.services.ec2.model.FleetLaunchTemplateSpecificationRequest extends Object implements Serializable


Serialized Fields


launchTemplateId
String launchTemplateId

 The ID of the launch template.
 


launchTemplateName
String launchTemplateName

 The name of the launch template.
 


version
String version

 The version number of the launch template. Note: This is a required parameter and will be updated soon.
 








Class com.amazonaws.services.ec2.model.FlowLog extends Object implements Serializable


Serialized Fields


creationTime
Date creationTime

 The date and time the flow log was created.
 


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


logDestinationType
String logDestinationType

 Specifies the type of destination to which the flow log data is published. Flow log data can be published to
 CloudWatch Logs or Amazon S3.
 


logDestination
String logDestination

 Specifies the destination to which the flow log data is published. Flow log data can be published to an
 CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element
 indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the
 flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is
 published.
 


logFormat
String logFormat

 The format of the flow log record.
 


maxAggregationInterval
Integer maxAggregationInterval

 The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow
 log record.
 
 
 For network interfaces attached to Nitro-based
 instances, the aggregation interval is always 60 seconds (1 minute), regardless of the specified value.
 








Class com.amazonaws.services.ec2.model.FpgaDeviceInfo extends Object implements Serializable


Serialized Fields


name
String name

 The name of the FPGA accelerator.
 


manufacturer
String manufacturer

 The manufacturer of the FPGA accelerator.
 


count
Integer count

 The count of FPGA accelerators for the instance type.
 


memoryInfo
FpgaDeviceMemoryInfo memoryInfo

 Describes the memory for the FPGA accelerator for the instance type.
 








Class com.amazonaws.services.ec2.model.FpgaDeviceMemoryInfo extends Object implements Serializable


Serialized Fields


sizeInMiB
Integer sizeInMiB

 The size (in MiB) for the memory available to the FPGA accelerator.
 








Class com.amazonaws.services.ec2.model.FpgaImage extends Object implements Serializable


Serialized Fields


fpgaImageId
String fpgaImageId

 The FPGA image identifier (AFI ID).
 


fpgaImageGlobalId
String fpgaImageGlobalId

 The global FPGA image identifier (AGFI ID).
 


name
String name

 The name of the AFI.
 


description
String description

 The description of the AFI.
 


shellVersion
String shellVersion

 The version of the AWS Shell that was used to create the bitstream.
 


pciId
PciId pciId

 Information about the PCI bus.
 


state
FpgaImageState state

 Information about the state of the AFI.
 


createTime
Date createTime

 The date and time the AFI was created.
 


updateTime
Date updateTime

 The time of the most recent update to the AFI.
 


ownerId
String ownerId

 The AWS account ID of the AFI owner.
 


ownerAlias
String ownerAlias

 The alias of the AFI owner. Possible values include self, amazon, and
 aws-marketplace.
 


productCodes
SdkInternalList<T> productCodes

 The product codes for the AFI.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the AFI.
 


publicValue
Boolean publicValue

 Indicates whether the AFI is public.
 


dataRetentionSupport
Boolean dataRetentionSupport

 Indicates whether data retention support is enabled for the AFI.
 








Class com.amazonaws.services.ec2.model.FpgaImageAttribute extends Object implements Serializable


Serialized Fields


fpgaImageId
String fpgaImageId

 The ID of the AFI.
 


name
String name

 The name of the AFI.
 


description
String description

 The description of the AFI.
 


loadPermissions
SdkInternalList<T> loadPermissions

 The load permissions.
 


productCodes
SdkInternalList<T> productCodes

 The product codes.
 








Class com.amazonaws.services.ec2.model.FpgaImageState extends Object implements Serializable


Serialized Fields


code
String code

 The state. The following are the possible values:
 
 
 
 
 pending - AFI bitstream generation is in progress.
 
 
 
 
 available - The AFI is available for use.
 
 
 
 
 failed - AFI bitstream generation failed.
 
 
 
 
 unavailable - The AFI is no longer available for use.
 
 
 


message
String message

 If the state is failed, this is the error message.
 








Class com.amazonaws.services.ec2.model.FpgaInfo extends Object implements Serializable


Serialized Fields


fpgas
SdkInternalList<T> fpgas

 Describes the FPGAs for the instance type.
 


totalFpgaMemoryInMiB
Integer totalFpgaMemoryInMiB

 The total memory of all FPGA accelerators for the instance type.
 








Class com.amazonaws.services.ec2.model.GetAssociatedIpv6PoolCidrsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


poolId
String poolId

 The ID of the IPv6 address pool.
 


nextToken
String nextToken

 The token for the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 








Class com.amazonaws.services.ec2.model.GetAssociatedIpv6PoolCidrsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ipv6CidrAssociations
SdkInternalList<T> ipv6CidrAssociations

 Information about the IPv6 CIDR block associations.
 


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.GetCapacityReservationUsageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


capacityReservationId
String capacityReservationId

 The ID of the Capacity Reservation.
 


nextToken
String nextToken

 The token to retrieve the next page of results.
 


maxResults
Integer maxResults

 The maximum number of results to return for the request in a single page. The remaining results can be seen by
 sending another request with the returned nextToken value.
 
 
 Valid range: Minimum value of 1. Maximum value of 1000.
 








Class com.amazonaws.services.ec2.model.GetCapacityReservationUsageResult extends AmazonWebServiceResult<ResponseMetadata> 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.
 


capacityReservationId
String capacityReservationId

 The ID of the Capacity Reservation.
 


instanceType
String instanceType

 The type of instance for which the Capacity Reservation reserves capacity.
 


totalInstanceCount
Integer totalInstanceCount

 The number of instances for which the Capacity Reservation reserves capacity.
 


availableInstanceCount
Integer availableInstanceCount

 The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
 


state
String state

 The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
 
 
 
 
 active - The Capacity Reservation is active and the capacity is available for your use.
 
 
 
 
 expired - The Capacity Reservation expired automatically at the date and time specified in your
 request. The reserved capacity is no longer available for your use.
 
 
 
 
 cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer
 available for your use.
 
 
 
 
 pending - The Capacity Reservation request was successful but the capacity provisioning is still
 pending.
 
 
 
 
 failed - The Capacity Reservation request has failed. A request might fail due to invalid request
 parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
 
 
 


instanceUsages
SdkInternalList<T> instanceUsages

 Information about the Capacity Reservation usage.
 








Class com.amazonaws.services.ec2.model.GetCoipPoolUsageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


poolId
String poolId

 The ID of the address pool.
 


filters
SdkInternalList<T> filters

 The filters. The following are the possible values:
 
 
 
 
 coip-address-usage.allocation-id
 
 
 
 
 
 
 coip-address-usage.aws-account-id
 
 
 
 
 
 
 coip-address-usage.aws-service
 
 
 
 
 
 
 coip-address-usage.co-ip
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.GetCoipPoolUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


coipPoolId
String coipPoolId

 The ID of the customer-owned address pool.
 


coipAddressUsages
SdkInternalList<T> coipAddressUsages

 Information about the address usage.
 


localGatewayRouteTableId
String localGatewayRouteTableId

 The ID of the local gateway route table.
 








Class com.amazonaws.services.ec2.model.GetConsoleOutputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 


latest
Boolean latest

 When enabled, retrieves the latest console output for the instance.
 
 
 Default: disabled (false)
 








Class com.amazonaws.services.ec2.model.GetConsoleOutputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 


output
String output

 The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you.
 


timestamp
Date timestamp

 The time at which the output was last updated.
 








Class com.amazonaws.services.ec2.model.GetConsoleScreenshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 


wakeUp
Boolean wakeUp

 When set to true, acts as keystroke input and wakes up an instance that's in standby or "sleep"
 mode.
 








Class com.amazonaws.services.ec2.model.GetConsoleScreenshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


imageData
String imageData

 The data that comprises the image.
 


instanceId
String instanceId

 The ID of the instance.
 








Class com.amazonaws.services.ec2.model.GetDefaultCreditSpecificationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceFamily
String instanceFamily

 The instance family.
 








Class com.amazonaws.services.ec2.model.GetDefaultCreditSpecificationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceFamilyCreditSpecification
InstanceFamilyCreditSpecification instanceFamilyCreditSpecification

 The default credit option for CPU usage of the instance family.
 








Class com.amazonaws.services.ec2.model.GetEbsDefaultKmsKeyIdRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.ec2.model.GetEbsDefaultKmsKeyIdResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


kmsKeyId
String kmsKeyId

 The Amazon Resource Name (ARN) of the default CMK for encryption by default.
 








Class com.amazonaws.services.ec2.model.GetEbsEncryptionByDefaultRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.ec2.model.GetEbsEncryptionByDefaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ebsEncryptionByDefault
Boolean ebsEncryptionByDefault

 Indicates whether encryption by default is enabled.
 








Class com.amazonaws.services.ec2.model.GetHostReservationPurchasePreviewRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hostIdSet
SdkInternalList<T> hostIdSet

 The IDs of the Dedicated Hosts with which the reservation is associated.
 


offeringId
String offeringId

 The offering ID of the reservation.
 








Class com.amazonaws.services.ec2.model.GetHostReservationPurchasePreviewResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


currencyCode
String currencyCode

 The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified.
 At this time, the only supported currency is USD.
 


purchase
SdkInternalList<T> purchase

 The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
 


totalHourlyPrice
String totalHourlyPrice

 The potential total hourly price of the reservation per hour.
 


totalUpfrontPrice
String totalUpfrontPrice

 The potential total upfront price. This is billed immediately.
 








Class com.amazonaws.services.ec2.model.GetLaunchTemplateDataRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 








Class com.amazonaws.services.ec2.model.GetLaunchTemplateDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


launchTemplateData
ResponseLaunchTemplateData launchTemplateData

 The instance data.
 








Class com.amazonaws.services.ec2.model.GetPasswordDataRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the Windows instance.
 








Class com.amazonaws.services.ec2.model.GetPasswordDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the Windows instance.
 


passwordData
String passwordData

 The password of the instance. Returns an empty string if the password is not available.
 


timestamp
Date timestamp

 The time the data was last updated.
 








Class com.amazonaws.services.ec2.model.GetReservedInstancesExchangeQuoteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reservedInstanceIds
SdkInternalList<T> reservedInstanceIds

 The IDs of the Convertible Reserved Instances to exchange.
 


targetConfigurations
SdkInternalList<T> targetConfigurations

 The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved
 Instances.
 








Class com.amazonaws.services.ec2.model.GetReservedInstancesExchangeQuoteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


currencyCode
String currencyCode

 The currency of the transaction.
 


isValidExchange
Boolean isValidExchange

 If true, the exchange is valid. If false, the exchange cannot be completed.
 


outputReservedInstancesWillExpireAt
Date outputReservedInstancesWillExpireAt

 The new end date of the reservation term.
 


paymentDue
String paymentDue

 The total true upfront charge for the exchange.
 


reservedInstanceValueRollup
ReservationValue reservedInstanceValueRollup

 The cost associated with the Reserved Instance.
 


reservedInstanceValueSet
SdkInternalList<T> reservedInstanceValueSet

 The configuration of your Convertible Reserved Instances.
 


targetConfigurationValueRollup
ReservationValue targetConfigurationValueRollup

 The cost associated with the Reserved Instance.
 


targetConfigurationValueSet
SdkInternalList<T> targetConfigurationValueSet

 The values of the target Convertible Reserved Instances.
 


validationFailureReason
String validationFailureReason

 Describes the reason why the exchange cannot be completed.
 








Class com.amazonaws.services.ec2.model.GetTransitGatewayAttachmentPropagationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 transit-gateway-route-table-id - The ID of the transit gateway route table.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.GetTransitGatewayAttachmentPropagationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayAttachmentPropagations
SdkInternalList<T> transitGatewayAttachmentPropagations

 Information about the propagation route tables.
 


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.GetTransitGatewayMulticastDomainAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 resource-id - The ID of the resource.
 
 
 
 
 resource-type - The type of resource. The valid value is: vpc.
 
 
 
 
 state - The state of the subnet association. Valid values are associated |
 associating | disassociated | disassociating.
 
 
 
 
 subnet-id - The ID of the subnet.
 
 
 
 
 transit-gateway-attachment-id - The id of the transit gateway attachment.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.GetTransitGatewayMulticastDomainAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


multicastDomainAssociations
SdkInternalList<T> multicastDomainAssociations

 Information about the multicast domain associations.
 


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.GetTransitGatewayRouteTableAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the transit gateway route table.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 resource-id - The ID of the resource.
 
 
 
 
 resource-type - The resource type (vpc | vpn).
 
 
 
 
 transit-gateway-attachment-id - The ID of the attachment.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.GetTransitGatewayRouteTableAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


associations
SdkInternalList<T> associations

 Information about the associations.
 


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.GetTransitGatewayRouteTablePropagationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the transit gateway route table.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 resource-id - The ID of the resource.
 
 
 
 
 resource-type - The resource type (vpc | vpn).
 
 
 
 
 transit-gateway-attachment-id - The ID of the attachment.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.GetTransitGatewayRouteTablePropagationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayRouteTablePropagations
SdkInternalList<T> transitGatewayRouteTablePropagations

 Information about the route table propagations.
 


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.GpuDeviceInfo extends Object implements Serializable


Serialized Fields


name
String name

 The name of the GPU accelerator.
 


manufacturer
String manufacturer

 The manufacturer of the GPU accelerator.
 


count
Integer count

 The number of GPUs for the instance type.
 


memoryInfo
GpuDeviceMemoryInfo memoryInfo

 Describes the memory available to the GPU accelerator.
 








Class com.amazonaws.services.ec2.model.GpuDeviceMemoryInfo extends Object implements Serializable


Serialized Fields


sizeInMiB
Integer sizeInMiB

 The size (in MiB) for the memory available to the GPU accelerator.
 








Class com.amazonaws.services.ec2.model.GpuInfo extends Object implements Serializable


Serialized Fields


gpus
SdkInternalList<T> gpus

 Describes the GPU accelerators for the instance type.
 


totalGpuMemoryInMiB
Integer totalGpuMemoryInMiB

 The total size of the memory for the GPU accelerators for the instance type.
 








Class com.amazonaws.services.ec2.model.GroupIdentifier extends Object implements Serializable


Serialized Fields


groupName
String groupName

 The name of the security group.
 


groupId
String groupId

 The ID of the security group.
 








Class com.amazonaws.services.ec2.model.HibernationOptions extends Object implements Serializable


Serialized Fields


configured
Boolean configured

 If this parameter is set to true, your instance is enabled for hibernation; otherwise, it is not
 enabled for hibernation.
 








Class com.amazonaws.services.ec2.model.HibernationOptionsRequest extends Object implements Serializable


Serialized Fields


configured
Boolean configured

 If you set this parameter to true, your instance is enabled for hibernation.
 
 
 Default: false
 








Class com.amazonaws.services.ec2.model.HistoryRecord extends Object implements Serializable


Serialized Fields


eventInformation
EventInformation eventInformation

 Information about the event.
 


eventType
String eventType

 The event type.
 
 
 
 
 error - An error with the Spot Fleet request.
 
 
 
 
 fleetRequestChange - A change in the status or configuration of the Spot Fleet request.
 
 
 
 
 instanceChange - An instance was launched or terminated.
 
 
 
 
 Information - An informational event.
 
 
 


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.HistoryRecordEntry extends Object implements Serializable


Serialized Fields


eventInformation
EventInformation eventInformation

 Information about the event.
 


eventType
String eventType

 The event type.
 


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

 Information about the instances running on the Dedicated Host.
 


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.
 


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
SdkInternalList<T> instances

 The IDs and instance type that are currently running on the Dedicated Host.
 


state
String state

 The Dedicated Host's state.
 


allocationTime
Date allocationTime

 The time that the Dedicated Host was allocated.
 


releaseTime
Date releaseTime

 The time that the Dedicated Host was released.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the Dedicated Host.
 


hostRecovery
String hostRecovery

 Indicates whether host recovery is enabled or disabled for the Dedicated Host.
 


allowsMultipleInstanceTypes
String allowsMultipleInstanceTypes

 Indicates whether the Dedicated Host supports multiple instance types of the same instance family, or a specific
 instance type only. one indicates that the Dedicated Host supports multiple instance types in the
 instance family. off indicates that the Dedicated Host supports a single instance type only.
 


ownerId
String ownerId

 The ID of the AWS account that owns the Dedicated Host.
 


availabilityZoneId
String availabilityZoneId

 The ID of the Availability Zone in which the Dedicated Host is allocated.
 


memberOfServiceLinkedResourceGroup
Boolean memberOfServiceLinkedResourceGroup

 Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is
 true, the host is in a host resource group; otherwise, it is not.
 








Class com.amazonaws.services.ec2.model.HostInstance extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of instance that is running on the Dedicated Host.
 


instanceType
String instanceType

 The instance type (for example, m3.medium) of the running instance.
 


ownerId
String ownerId

 The ID of the AWS account that owns the instance.
 








Class com.amazonaws.services.ec2.model.HostOffering extends Object implements Serializable


Serialized Fields


currencyCode
String currencyCode

 The currency of the offering.
 


duration
Integer duration

 The duration of the offering (in seconds).
 


hourlyPrice
String hourlyPrice

 The hourly price of the offering.
 


instanceFamily
String instanceFamily

 The instance family of the offering.
 


offeringId
String offeringId

 The ID of the offering.
 


paymentOption
String paymentOption

 The available payment option.
 


upfrontPrice
String upfrontPrice

 The upfront price of the offering. Does not apply to No Upfront offerings.
 








Class com.amazonaws.services.ec2.model.HostProperties extends Object implements Serializable


Serialized Fields


cores
Integer cores

 The number of cores on the Dedicated Host.
 


instanceType
String instanceType

 The instance type supported by the Dedicated Host. For example, m5.large. If the host supports
 multiple instance types, no instanceType is returned.
 


instanceFamily
String instanceFamily

 The instance family supported by the Dedicated Host. For example, m5.
 


sockets
Integer sockets

 The number of sockets on the Dedicated Host.
 


totalVCpus
Integer totalVCpus

 The total number of vCPUs on the Dedicated Host.
 








Class com.amazonaws.services.ec2.model.HostReservation extends Object implements Serializable


Serialized Fields


count
Integer count

 The number of Dedicated Hosts the reservation is associated with.
 


currencyCode
String currencyCode

 The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this
 time, the only supported currency is USD.
 


duration
Integer duration

 The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) |
 94608000 (3 years).
 


end
Date end

 The date and time that the reservation ends.
 


hostIdSet
SdkInternalList<T> hostIdSet

 The IDs of the Dedicated Hosts associated with the reservation.
 


hostReservationId
String hostReservationId

 The ID of the reservation that specifies the associated Dedicated Hosts.
 


hourlyPrice
String hourlyPrice

 The hourly price of the reservation.
 


instanceFamily
String instanceFamily

 The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same
 in order for it to benefit from the reservation.
 


offeringId
String offeringId

 The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
 


paymentOption
String paymentOption

 The payment option selected for this reservation.
 


start
Date start

 The date and time that the reservation started.
 


state
String state

 The state of the reservation.
 


upfrontPrice
String upfrontPrice

 The upfront price of the reservation.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the Dedicated Host Reservation.
 








Class com.amazonaws.services.ec2.model.IamInstanceProfile extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the instance profile.
 


id
String id

 The ID of the instance profile.
 








Class com.amazonaws.services.ec2.model.IamInstanceProfileAssociation extends Object implements Serializable


Serialized Fields


associationId
String associationId

 The ID of the association.
 


instanceId
String instanceId

 The ID of the instance.
 


iamInstanceProfile
IamInstanceProfile iamInstanceProfile

 The IAM instance profile.
 


state
String state

 The state of the association.
 


timestamp
Date timestamp

 The time the IAM instance profile was associated with the instance.
 








Class com.amazonaws.services.ec2.model.IamInstanceProfileSpecification extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the instance profile.
 


name
String name

 The name of the instance profile.
 








Class com.amazonaws.services.ec2.model.IcmpTypeCode extends Object implements Serializable


Serialized Fields


code
Integer code

 The ICMP code. A value of -1 means all codes for the specified ICMP type.
 


type
Integer type

 The ICMP type. A value of -1 means all types.
 








Class com.amazonaws.services.ec2.model.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.IKEVersionsListValue extends Object implements Serializable


Serialized Fields


value
String value

 The IKE version.
 








Class com.amazonaws.services.ec2.model.IKEVersionsRequestListValue extends Object implements Serializable


Serialized Fields


value
String value

 The IKE version.
 








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


Serialized Fields


architecture
String architecture

 The architecture of the image.
 


creationDate
String creationDate

 The date and time the image was created.
 


imageId
String imageId

 The ID of the AMI.
 


imageLocation
String imageLocation

 The location of the AMI.
 


imageType
String imageType

 The type of image.
 


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.
 


kernelId
String kernelId

 The kernel associated with the image, if any. Only applicable for machine images.
 


ownerId
String ownerId

 The AWS account ID of the image owner.
 


platform
String platform

 This value is set to windows for Windows AMIs; otherwise, it is blank.
 


productCodes
SdkInternalList<T> productCodes

 Any product codes associated with the AMI.
 


ramdiskId
String ramdiskId

 The RAM disk associated with the image, if any. Only applicable for machine images.
 


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.
 


blockDeviceMappings
SdkInternalList<T> blockDeviceMappings

 Any block device mapping entries.
 


description
String description

 The description of the AMI that was provided during image creation.
 


enaSupport
Boolean enaSupport

 Specifies whether enhanced networking with ENA is enabled.
 


hypervisor
String hypervisor

 The hypervisor type of the image.
 


imageOwnerAlias
String imageOwnerAlias

 The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI
 owner.
 


name
String name

 The name of the AMI that was provided during image creation.
 


rootDeviceName
String rootDeviceName

 The device name of the root device volume (for example, /dev/sda1).
 


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 with the Intel 82599 Virtual Function interface is enabled.
 


stateReason
StateReason stateReason

 The reason for the state change.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the image.
 


virtualizationType
String virtualizationType

 The type of virtualization of the AMI.
 








Class com.amazonaws.services.ec2.model.ImageAttribute extends Object implements Serializable


Serialized Fields


blockDeviceMappings
SdkInternalList<T> blockDeviceMappings

 The block device mapping entries.
 


imageId
String imageId

 The ID of the AMI.
 


launchPermissions
SdkInternalList<T> launchPermissions

 The launch permissions.
 


productCodes
SdkInternalList<T> productCodes

 The product codes.
 


description
String description

 A description for the AMI.
 


kernelId
String kernelId

 The kernel ID.
 


ramdiskId
String ramdiskId

 The RAM disk ID.
 


sriovNetSupport
String sriovNetSupport

 Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
 








Class com.amazonaws.services.ec2.model.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: 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.ImportClientVpnClientCertificateRevocationListRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint to which the client certificate revocation list applies.
 


certificateRevocationList
String certificateRevocationList

 The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Administrator Guide.
 








Class com.amazonaws.services.ec2.model.ImportClientVpnClientCertificateRevocationListResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.ImportImageLicenseConfigurationRequest extends Object implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

 The ARN of a license configuration.
 








Class com.amazonaws.services.ec2.model.ImportImageLicenseConfigurationResponse extends Object implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

 The ARN of a license configuration.
 








Class com.amazonaws.services.ec2.model.ImportImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


architecture
String architecture

 The architecture of the virtual machine.
 
 
 Valid values: i386 | x86_64 | arm64
 


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
SdkInternalList<T> diskContainers

 Information about the disk containers.
 


encrypted
Boolean encrypted

 Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used
 unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more
 information, see Amazon EBS
 Encryption in the Amazon Elastic Compute Cloud User Guide.
 


hypervisor
String hypervisor

 The target hypervisor platform.
 
 
 Valid values: xen
 


kmsKeyId
String kmsKeyId

 An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when
 creating the encrypted AMI. 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. If a KmsKeyId is specified, the
 Encrypted flag must also be set.
 
 
 The CMK identifier may be provided in any of the following formats:
 
 
 
 
 Key ID
 
 
 
 
 Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the
 AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example,
 arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
 
 
 
 
 ARN using key ID. The ID 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.
 
 
 
 
 ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the
 CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example,
 arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
 
 
 
 
 AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
 though you provided an invalid identifier. This action will eventually report failure.
 
 
 The specified CMK must exist in the Region that the AMI is being copied to.
 
 
 Amazon EBS does not support asymmetric CMKs.
 


licenseType
String licenseType

 The license type to be used for the Amazon Machine Image (AMI) after importing.
 
 
 By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify
 AWS to replace the source-system license with an AWS license, if appropriate. Specify
 BYOL to retain the source-system license, if appropriate.
 
 
 To use BYOL, you must have existing licenses with rights to use these licenses in a third party
 cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide.
 


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


licenseSpecifications
SdkInternalList<T> licenseSpecifications

 The ARNs of the license configurations.
 








Class com.amazonaws.services.ec2.model.ImportImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


architecture
String architecture

 The architecture of the virtual machine.
 


description
String description

 A description of the import task.
 


encrypted
Boolean encrypted

 Indicates whether the AMI is encypted.
 


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.
 


kmsKeyId
String kmsKeyId

 The identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to
 create the encrypted AMI.
 


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


licenseSpecifications
SdkInternalList<T> licenseSpecifications

 The ARNs of the license configurations.
 








Class com.amazonaws.services.ec2.model.ImportImageTask extends Object implements Serializable


Serialized Fields


architecture
String architecture

 The architecture of the virtual machine.
 
 
 Valid values: i386 | x86_64 | arm64
 


description
String description

 A description of the import task.
 


encrypted
Boolean encrypted

 Indicates whether the image is encrypted.
 


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.
 


kmsKeyId
String kmsKeyId

 The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the
 encrypted image.
 


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


tags
SdkInternalList<T> tags

 The tags for the import image task.
 


licenseSpecifications
SdkInternalList<T> licenseSpecifications

 The ARNs of the license configurations that are associated with the import image task.
 








Class com.amazonaws.services.ec2.model.ImportInstanceLaunchSpecification extends Object implements Serializable


Serialized Fields


additionalInfo
String additionalInfo

 Reserved.
 


architecture
String architecture

 The architecture of the instance.
 


groupIds
SdkInternalList<T> groupIds

 The security group IDs.
 


groupNames
SdkInternalList<T> groupNames

 The 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 Instance
 Types in the VM Import/Export 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 user data to make available to the instance.
 








Class com.amazonaws.services.ec2.model.ImportInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description

 A description for the instance being imported.
 


diskImages
SdkInternalList<T> diskImages

 The disk image.
 


launchSpecification
ImportInstanceLaunchSpecification launchSpecification

 The launch specification.
 


platform
String platform

 The instance operating system.
 








Class com.amazonaws.services.ec2.model.ImportInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


conversionTask
ConversionTask conversionTask

 Information about the conversion task.
 








Class com.amazonaws.services.ec2.model.ImportInstanceTaskDetails extends Object implements Serializable


Serialized Fields


description
String description

 A description of the task.
 


instanceId
String instanceId

 The ID of the instance.
 


platform
String platform

 The instance operating system.
 


volumes
SdkInternalList<T> volumes

 The volumes.
 








Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyName
String keyName

 A unique name for the key pair.
 


publicKeyMaterial
String publicKeyMaterial

 The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is
 performed for you.
 








Class com.amazonaws.services.ec2.model.ImportKeyPairResult extends AmazonWebServiceResult<ResponseMetadata> 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 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.
 


encrypted
Boolean encrypted

 Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is
 used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For
 more information, see Amazon EBS
 Encryption in the Amazon Elastic Compute Cloud User Guide.
 


kmsKeyId
String kmsKeyId

 An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when
 creating the encrypted snapshot. 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. If a KmsKeyId is specified, the
 Encrypted flag must also be set.
 
 
 The CMK identifier may be provided in any of the following formats:
 
 
 
 
 Key ID
 
 
 
 
 Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the
 AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example,
 arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
 
 
 
 
 ARN using key ID. The ID 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.
 
 
 
 
 ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the
 CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example,
 arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
 
 
 
 
 AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even
 though you provided an invalid identifier. This action will eventually report failure.
 
 
 The specified CMK must exist in the Region that the snapshot is being copied to.
 
 
 Amazon EBS does not support asymmetric CMKs.
 


roleName
String roleName

 The name of the role to use when not using the default role, 'vmimport'.
 








Class com.amazonaws.services.ec2.model.ImportSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> 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 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.
 


tags
SdkInternalList<T> tags

 The tags for the import snapshot task.
 








Class com.amazonaws.services.ec2.model.ImportVolumeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone for the resulting EBS volume.
 


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


conversionTask
ConversionTask conversionTask

 Information about the conversion task.
 








Class com.amazonaws.services.ec2.model.ImportVolumeTaskDetails extends Object implements Serializable


Serialized Fields


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.InferenceAcceleratorInfo extends Object implements Serializable


Serialized Fields


accelerators
SdkInternalList<T> accelerators

 Describes the Inference accelerators for the instance type.
 








Class com.amazonaws.services.ec2.model.InferenceDeviceInfo extends Object implements Serializable


Serialized Fields


count
Integer count

 The number of Inference accelerators for the instance type.
 


name
String name

 The name of the Inference accelerator.
 


manufacturer
String manufacturer

 The manufacturer of the Inference accelerator.
 








Class com.amazonaws.services.ec2.model.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.
 


imageId
String imageId

 The ID of the AMI used to launch the instance.
 


instanceId
String instanceId

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

 (IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the
 Amazon EC2 network. This name is not available until the instance enters the running state.
 
 
 [EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS
 resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your
 custom domain name servers must resolve the hostname as appropriate.
 


privateIpAddress
String privateIpAddress

 The private IPv4 address assigned to the instance.
 


productCodes
SdkInternalList<T> productCodes

 The product codes attached to this instance, if applicable.
 


publicDnsName
String publicDnsName

 (IPv4 only) 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 IPv4 address assigned to the instance, if applicable.
 


ramdiskId
String ramdiskId

 The RAM disk associated with this instance, if applicable.
 


state
InstanceState state

 The current state of the instance.
 


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.
 


vpcId
String vpcId

 [EC2-VPC] The ID of the VPC in which the instance is running.
 


architecture
String architecture

 The architecture of the image.
 


blockDeviceMappings
SdkInternalList<T> 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 Amazon 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.
 


enaSupport
Boolean enaSupport

 Specifies whether enhanced networking with ENA is enabled.
 


hypervisor
String hypervisor

 The hypervisor type of the instance.
 


iamInstanceProfile
IamInstanceProfile iamInstanceProfile

 The IAM instance profile associated with the instance, if applicable.
 


instanceLifecycle
String instanceLifecycle

 Indicates whether this is a Spot Instance or a Scheduled Instance.
 


elasticGpuAssociations
SdkInternalList<T> elasticGpuAssociations

 The Elastic GPU associated with the instance.
 


elasticInferenceAcceleratorAssociations
SdkInternalList<T> elasticInferenceAcceleratorAssociations

 The elastic inference accelerator associated with the instance.
 


networkInterfaces
SdkInternalList<T> networkInterfaces

 [EC2-VPC] The network interfaces for the instance.
 


outpostArn
String outpostArn

 The Amazon Resource Name (ARN) of the Outpost.
 


rootDeviceName
String rootDeviceName

 The device name of the root device volume (for example, /dev/sda1).
 


rootDeviceType
String rootDeviceType

 The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
 


securityGroups
SdkInternalList<T> securityGroups

 The 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 that checking is
 enabled, and false means that 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 with the Intel 82599 Virtual Function interface is enabled.
 


stateReason
StateReason stateReason

 The reason for the most recent state transition.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the instance.
 


virtualizationType
String virtualizationType

 The virtualization type of the instance.
 


cpuOptions
CpuOptions cpuOptions

 The CPU options for the instance.
 


capacityReservationId
String capacityReservationId

 The ID of the Capacity Reservation.
 


capacityReservationSpecification
CapacityReservationSpecificationResponse capacityReservationSpecification

 Information about the Capacity Reservation targeting option.
 


hibernationOptions
HibernationOptions hibernationOptions

 Indicates whether the instance is enabled for hibernation.
 


licenses
SdkInternalList<T> licenses

 The license configurations.
 


metadataOptions
InstanceMetadataOptionsResponse metadataOptions

 The metadata options for the instance.
 








Class com.amazonaws.services.ec2.model.InstanceAttribute extends Object implements Serializable


Serialized Fields


groups
SdkInternalList<T> groups

 The security groups associated with the instance.
 


blockDeviceMappings
SdkInternalList<T> 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.
 


enaSupport
Boolean enaSupport

 Indicates whether enhanced networking with ENA is enabled.
 


ebsOptimized
Boolean ebsOptimized

 Indicates whether the instance is optimized for Amazon EBS I/O.
 


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
SdkInternalList<T> productCodes

 A list of product codes.
 


ramdiskId
String ramdiskId

 The RAM disk ID.
 


rootDeviceName
String rootDeviceName

 The device name of the root device volume (for example, /dev/sda1).
 


sourceDestCheck
Boolean sourceDestCheck

 Indicates whether source/destination checking is enabled. A value of true means that checking is
 enabled, and false means that checking is disabled. This value must be false for a NAT
 instance to perform NAT.
 


sriovNetSupport
String sriovNetSupport

 Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
 


userData
String userData

 The user data.
 








Class com.amazonaws.services.ec2.model.InstanceBlockDeviceMapping extends Object implements Serializable


Serialized Fields


deviceName
String deviceName

 The device name (for example, /dev/sdh or xvdh).
 


ebs
EbsInstanceBlockDevice ebs

 Parameters used to automatically set up EBS volumes when the instance is launched.
 








Class com.amazonaws.services.ec2.model.InstanceBlockDeviceMappingSpecification extends Object implements Serializable


Serialized Fields


deviceName
String deviceName

 The device name (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 extends Object implements Serializable


Serialized Fields


availableCapacity
Integer availableCapacity

 The number of instances that can be launched onto the Dedicated Host based on the host's available capacity.
 


instanceType
String instanceType

 The instance type supported by the Dedicated Host.
 


totalCapacity
Integer totalCapacity

 The total number of instances that can be launched onto the Dedicated Host if there are no instances running on
 it.
 








Class com.amazonaws.services.ec2.model.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.InstanceCreditSpecification extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 


cpuCredits
String cpuCredits

 The credit option for CPU usage of the instance. Valid values are standard and
 unlimited.
 








Class com.amazonaws.services.ec2.model.InstanceCreditSpecificationRequest extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 


cpuCredits
String cpuCredits

 The credit option for CPU usage of the instance. Valid values are standard and
 unlimited.
 








Class com.amazonaws.services.ec2.model.InstanceExportDetails extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the resource being exported.
 


targetEnvironment
String targetEnvironment

 The target virtualization environment.
 








Class com.amazonaws.services.ec2.model.InstanceFamilyCreditSpecification extends Object implements Serializable


Serialized Fields


instanceFamily
String instanceFamily

 The instance family.
 


cpuCredits
String cpuCredits

 The default credit option for CPU usage of the instance family. Valid values are standard and
 unlimited.
 








Class com.amazonaws.services.ec2.model.InstanceIpv6Address extends Object implements Serializable


Serialized Fields


ipv6Address
String ipv6Address

 The IPv6 address.
 








Class com.amazonaws.services.ec2.model.InstanceIpv6AddressRequest extends Object implements Serializable


Serialized Fields


ipv6Address
String ipv6Address

 The IPv6 address.
 








Class com.amazonaws.services.ec2.model.InstanceMarketOptionsRequest extends Object implements Serializable


Serialized Fields


marketType
String marketType

 The market type.
 


spotOptions
SpotMarketOptions spotOptions

 The options for Spot Instances.
 








Class com.amazonaws.services.ec2.model.InstanceMetadataOptionsRequest extends Object implements Serializable


Serialized Fields


httpTokens
String httpTokens

 The state of token usage for your instance metadata requests. If the parameter is not specified in the request,
 the default state is optional.
 
 
 If the state is optional, you can choose to retrieve instance metadata with or without a signed
 token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
 credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0
 role credentials are returned.
 
 
 If the state is required, you must send a signed token header with any instance metadata retrieval
 requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the
 version 1.0 credentials are not available.
 


httpPutResponseHopLimit
Integer httpPutResponseHopLimit

 The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further
 instance metadata requests can travel.
 
 
 Default: 1
 
 
 Possible values: Integers from 1 to 64
 


httpEndpoint
String httpEndpoint

 This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not
 specified, the default state is enabled.
 
 
 
 If you specify a value of disabled, you will not be able to access your instance metadata.
 
 








Class com.amazonaws.services.ec2.model.InstanceMetadataOptionsResponse extends Object implements Serializable


Serialized Fields


state
String state

 The state of the metadata option changes.
 
 
 pending - The metadata options are being updated and the instance is not ready to process metadata
 traffic with the new selection.
 
 
 applied - The metadata options have been successfully applied on the instance.
 


httpTokens
String httpTokens

 The state of token usage for your instance metadata requests. If the parameter is not specified in the request,
 the default state is optional.
 
 
 If the state is optional, you can choose to retrieve instance metadata with or without a signed
 token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
 credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0
 role credentials are returned.
 
 
 If the state is required, you must send a signed token header with any instance metadata retrieval
 requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the
 version 1.0 credentials are not available.
 


httpPutResponseHopLimit
Integer httpPutResponseHopLimit

 The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further
 instance metadata requests can travel.
 
 
 Default: 1
 
 
 Possible values: Integers from 1 to 64
 


httpEndpoint
String httpEndpoint

 This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not
 specified, the default state is enabled.
 
 
 
 If you specify a value of disabled, you will not be able to access your instance metadata.
 
 








Class com.amazonaws.services.ec2.model.InstanceMonitoring extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 


monitoring
Monitoring monitoring

 The monitoring for the instance.
 








Class com.amazonaws.services.ec2.model.InstanceNetworkInterface extends Object implements Serializable


Serialized Fields


association
InstanceNetworkInterfaceAssociation association

 The association information for an Elastic IPv4 associated with the network interface.
 


attachment
InstanceNetworkInterfaceAttachment attachment

 The network interface attachment.
 


description
String description

 The description.
 


groups
SdkInternalList<T> groups

 One or more security groups.
 


ipv6Addresses
SdkInternalList<T> ipv6Addresses

 One or more IPv6 addresses associated with the network interface.
 


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 IPv4 address of the network interface within the subnet.
 


privateIpAddresses
SdkInternalList<T> privateIpAddresses

 One or more private IPv4 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.
 


interfaceType
String interfaceType

 Describes the type of network interface.
 
 
 Valid values: interface | efa
 








Class com.amazonaws.services.ec2.model.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 extends Object implements Serializable


Serialized Fields


attachTime
Date attachTime

 The time stamp when the attachment initiated.
 


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.
 


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 extends Object implements Serializable


Serialized Fields


associatePublicIpAddress
Boolean associatePublicIpAddress

 Indicates whether to assign a public IPv4 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 position of the network interface in the attachment order. A primary network interface has a device index of
 0.
 
 
 If you specify a network interface when launching an instance, you must specify the device index.
 


groups
SdkInternalList<T> groups

 The IDs of the security groups for the network interface. Applies only if creating a network interface when
 launching an instance.
 


ipv6AddressCount
Integer ipv6AddressCount

 A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the
 range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same
 request. You can specify this option if you've specified a minimum number of instances to launch.
 


ipv6Addresses
SdkInternalList<T> ipv6Addresses

 One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to
 assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a
 minimum number of instances to launch.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


privateIpAddress
String privateIpAddress

 The private IPv4 address of the network interface. Applies only if creating a network interface when launching an
 instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
 


privateIpAddresses
SdkInternalList<T> privateIpAddresses

 One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be
 designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
 


secondaryPrivateIpAddressCount
Integer secondaryPrivateIpAddressCount

 The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private
 IP address using the private IP addresses option. You cannot specify this option if you're launching more than
 one instance in a RunInstances request.
 


subnetId
String subnetId

 The ID of the subnet associated with the network interface. Applies only if creating a network interface when
 launching an instance.
 


interfaceType
String interfaceType

 The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more
 information, see Elastic Fabric
 Adapter in the Amazon Elastic Compute Cloud User Guide.
 
 
 If you are not creating an EFA, specify interface or omit this parameter.
 
 
 Valid values: interface | efa
 








Class com.amazonaws.services.ec2.model.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 IPv4 address is the primary private IP address of the network interface.
 


privateDnsName
String privateDnsName

 The private IPv4 DNS name.
 


privateIpAddress
String privateIpAddress

 The private IPv4 address of the network interface.
 








Class com.amazonaws.services.ec2.model.InstanceSpecification extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance to specify which volumes should be snapshotted.
 


excludeBootVolume
Boolean excludeBootVolume

 Excludes the root volume from being snapshotted.
 








Class com.amazonaws.services.ec2.model.InstanceState extends Object implements Serializable


Serialized Fields


code
Integer code

 The state of the instance as a 16-bit unsigned integer.
 
 
 The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535.
 These numerical values are used for internal purposes and should be ignored.
 
 
 The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
 
 
 The valid values for instance-state-code will all be in the range of the low byte and they are:
 
 
 
 
 0 : pending
 
 
 
 
 16 : running
 
 
 
 
 32 : shutting-down
 
 
 
 
 48 : terminated
 
 
 
 
 64 : stopping
 
 
 
 
 80 : stopped
 
 
 
 
 You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
 


name
String name

 The current state of the instance.
 








Class com.amazonaws.services.ec2.model.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 extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone of the instance.
 


outpostArn
String outpostArn

 The Amazon Resource Name (ARN) of the Outpost.
 


events
SdkInternalList<T> 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 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 extends Object implements Serializable


Serialized Fields


instanceEventId
String instanceEventId

 The ID of the event.
 


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.
 


notBeforeDeadline
Date notBeforeDeadline

 The deadline for starting the event.
 








Class com.amazonaws.services.ec2.model.InstanceStatusSummary extends Object implements Serializable


Serialized Fields


details
SdkInternalList<T> details

 The system instance health or application instance health.
 


status
String status

 The status.
 








Class com.amazonaws.services.ec2.model.InstanceStorageInfo extends Object implements Serializable


Serialized Fields


totalSizeInGB
Long totalSizeInGB

 The total size of the disks, in GB.
 


disks
SdkInternalList<T> disks

 Array describing the disks that are available for the instance type.
 








Class com.amazonaws.services.ec2.model.InstanceTypeInfo extends Object implements Serializable


Serialized Fields


instanceType
String instanceType

 The instance type. For more information, see Instance Types in the
 Amazon Elastic Compute Cloud User Guide.
 


currentGeneration
Boolean currentGeneration

 Indicates whether the instance type is a current generation.
 


freeTierEligible
Boolean freeTierEligible

 Indicates whether the instance type is eligible for the free tier.
 


supportedUsageClasses
SdkInternalList<T> supportedUsageClasses

 Indicates whether the instance type is offered for spot or On-Demand.
 


supportedRootDeviceTypes
SdkInternalList<T> supportedRootDeviceTypes

 Indicates the supported root device types.
 


bareMetal
Boolean bareMetal

 Indicates whether the instance is bare metal.
 


hypervisor
String hypervisor

 Indicates the hypervisor used for the instance type.
 


processorInfo
ProcessorInfo processorInfo

 Describes the processor.
 


vCpuInfo
VCpuInfo vCpuInfo

 Describes the vCPU configurations for the instance type.
 


memoryInfo
MemoryInfo memoryInfo

 Describes the memory for the instance type.
 


instanceStorageSupported
Boolean instanceStorageSupported

 Indicates whether instance storage is supported.
 


instanceStorageInfo
InstanceStorageInfo instanceStorageInfo

 Describes the disks for the instance type.
 


ebsInfo
EbsInfo ebsInfo

 Describes the Amazon EBS settings for the instance type.
 


networkInfo
NetworkInfo networkInfo

 Describes the network settings for the instance type.
 


gpuInfo
GpuInfo gpuInfo

 Describes the GPU accelerator settings for the instance type.
 


fpgaInfo
FpgaInfo fpgaInfo

 Describes the FPGA accelerator settings for the instance type.
 


placementGroupInfo
PlacementGroupInfo placementGroupInfo

 Describes the placement group settings for the instance type.
 


inferenceAcceleratorInfo
InferenceAcceleratorInfo inferenceAcceleratorInfo

 Describes the Inference accelerator settings for the instance type.
 


hibernationSupported
Boolean hibernationSupported

 Indicates whether On-Demand hibernation is supported.
 


burstablePerformanceSupported
Boolean burstablePerformanceSupported

 Indicates whether the instance type is a burstable performance instance type.
 


dedicatedHostsSupported
Boolean dedicatedHostsSupported

 Indicates whether Dedicated Hosts are supported on the instance type.
 


autoRecoverySupported
Boolean autoRecoverySupported

 Indicates whether auto recovery is supported.
 








Class com.amazonaws.services.ec2.model.InstanceTypeOffering extends Object implements Serializable


Serialized Fields


instanceType
String instanceType

 The instance type. For more information, see Instance Types in the
 Amazon Elastic Compute Cloud User Guide.
 


locationType
String locationType

 The location type.
 


location
String location

 The identifier for the location. This depends on the location type. For example, if the location type is
 region, the location is the Region code (for example, us-east-2.)
 








Class com.amazonaws.services.ec2.model.InstanceUsage extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The ID of the AWS account that is making use of the Capacity Reservation.
 


usedInstanceCount
Integer usedInstanceCount

 The number of instances the AWS account currently has in the Capacity Reservation.
 








Class com.amazonaws.services.ec2.model.InternetGateway extends Object implements Serializable


Serialized Fields


attachments
SdkInternalList<T> attachments

 Any VPCs attached to the internet gateway.
 


internetGatewayId
String internetGatewayId

 The ID of the internet gateway.
 


ownerId
String ownerId

 The ID of the AWS account that owns the internet gateway.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the internet gateway.
 








Class com.amazonaws.services.ec2.model.InternetGatewayAttachment extends Object implements Serializable


Serialized Fields


state
String state

 The current state of the attachment. For an internet gateway, the state is available when attached
 to a VPC; otherwise, this value is not returned.
 


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.IpPermission extends Object implements Serializable


Serialized Fields


fromPort
Integer fromPort

 The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1
 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
 


ipProtocol
String ipProtocol

 The IP protocol name (tcp, udp, icmp, icmpv6) or number (see
 Protocol Numbers).
 
 
 [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying
 -1 or a protocol number other than tcp, udp, icmp, or
 icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp,
 udp, and icmp, you must specify a port range. For icmpv6, the port range
 is optional; if you omit the port range, traffic for all types and codes is allowed.
 


ipv6Ranges
SdkInternalList<T> ipv6Ranges

 [VPC only] The IPv6 ranges.
 


prefixListIds
SdkInternalList<T> prefixListIds

 [VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS service 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/ICMPv6 code. A value of -1 indicates
 all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
 


userIdGroupPairs
SdkInternalList<T> userIdGroupPairs

 The security group and AWS account ID pairs.
 


ipv4Ranges
SdkInternalList<T> ipv4Ranges

 The IPv4 ranges.
 








Class com.amazonaws.services.ec2.model.IpRange extends Object implements Serializable


Serialized Fields


cidrIp
String cidrIp

 The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a
 single IPv4 address, use the /32 prefix length.
 


description
String description

 A description for the security group rule that references this IPv4 address range.
 
 
 Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and
 ._-:/()#,@[]+=&;{}!$*
 








Class com.amazonaws.services.ec2.model.Ipv6CidrAssociation extends Object implements Serializable


Serialized Fields


ipv6Cidr
String ipv6Cidr

 The IPv6 CIDR block.
 


associatedResource
String associatedResource

 The resource that's associated with the IPv6 CIDR block.
 








Class com.amazonaws.services.ec2.model.Ipv6CidrBlock extends Object implements Serializable


Serialized Fields


ipv6CidrBlock
String ipv6CidrBlock

 The IPv6 CIDR block.
 








Class com.amazonaws.services.ec2.model.Ipv6Pool extends Object implements Serializable


Serialized Fields


poolId
String poolId

 The ID of the address pool.
 


description
String description

 The description for the address pool.
 


poolCidrBlocks
SdkInternalList<T> poolCidrBlocks

 The CIDR blocks for the address pool.
 


tags
SdkInternalList<T> tags

 Any tags for the address pool.
 








Class com.amazonaws.services.ec2.model.Ipv6Range extends Object implements Serializable


Serialized Fields


cidrIpv6
String cidrIpv6

 The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a
 single IPv6 address, use the /128 prefix length.
 


description
String description

 A description for the security group rule that references this IPv6 address range.
 
 
 Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and
 ._-:/()#,@[]+=&;{}!$*
 








Class com.amazonaws.services.ec2.model.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.
 


keyPairId
String keyPairId

 The ID of the key pair.
 








Class com.amazonaws.services.ec2.model.KeyPairInfo extends Object implements Serializable


Serialized Fields


keyPairId
String keyPairId

 The ID of the key pair.
 


keyFingerprint
String keyFingerprint

 If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key.
 If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as
 specified in section 4 of RFC4716.
 


keyName
String keyName

 The name of the key pair.
 


tags
SdkInternalList<T> tags

 Any tags applied to the key pair.
 








Class com.amazonaws.services.ec2.model.LastError extends Object implements Serializable


Serialized Fields


message
String message

 The error message for the VPC endpoint error.
 


code
String code

 The error code for the VPC endpoint error.
 








Class com.amazonaws.services.ec2.model.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 extends Object implements Serializable


Serialized Fields


add
SdkInternalList<T> add

 The AWS account ID to add to the list of launch permissions for the AMI.
 


remove
SdkInternalList<T> remove

 The AWS account ID to remove from the list of launch permissions for the AMI.
 








Class com.amazonaws.services.ec2.model.LaunchSpecification extends Object implements Serializable


Serialized Fields


userData
String userData

 The Base64-encoded user data for the instance.
 


addressingType
String addressingType

 Deprecated.
 


blockDeviceMappings
SdkInternalList<T> blockDeviceMappings

 One or more block device mapping entries.
 


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.
 


networkInterfaces
SdkInternalList<T> networkInterfaces

 One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security
 group IDs using the network interface.
 


placement
SpotPlacement placement

 The placement information for the instance.
 


ramdiskId
String ramdiskId

 The ID of the RAM disk.
 


subnetId
String subnetId

 The ID of the subnet in which to launch the instance.
 


allSecurityGroups
SdkInternalList<T> allSecurityGroups

 One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups.
 When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
 


monitoringEnabled
Boolean monitoringEnabled


securityGroups
SdkInternalList<T> securityGroups

 One or more security group names.
 








Class com.amazonaws.services.ec2.model.LaunchTemplate extends Object implements Serializable


Serialized Fields


launchTemplateId
String launchTemplateId

 The ID of the launch template.
 


launchTemplateName
String launchTemplateName

 The name of the launch template.
 


createTime
Date createTime

 The time launch template was created.
 


createdBy
String createdBy

 The principal that created the launch template.
 


defaultVersionNumber
Long defaultVersionNumber

 The version number of the default version of the launch template.
 


latestVersionNumber
Long latestVersionNumber

 The version number of the latest version of the launch template.
 


tags
SdkInternalList<T> tags

 The tags for the launch template.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateAndOverridesResponse extends Object implements Serializable


Serialized Fields


launchTemplateSpecification
FleetLaunchTemplateSpecification launchTemplateSpecification

 The launch template.
 


overrides
FleetLaunchTemplateOverrides overrides

 Any parameters that you specify override the same parameters in the launch template.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateBlockDeviceMapping extends Object implements Serializable


Serialized Fields


deviceName
String deviceName

 The device name.
 


virtualName
String virtualName

 The virtual device name (ephemeralN).
 


ebs
LaunchTemplateEbsBlockDevice ebs

 Information about the block device for an EBS volume.
 


noDevice
String noDevice

 Suppresses the specified device included in the block device mapping of the AMI.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateBlockDeviceMappingRequest extends Object implements Serializable


Serialized Fields


deviceName
String deviceName

 The device name (for example, /dev/sdh or xvdh).
 


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.
 


ebs
LaunchTemplateEbsBlockDeviceRequest ebs

 Parameters used to automatically set up EBS volumes when the instance is launched.
 


noDevice
String noDevice

 Suppresses the specified device included in the block device mapping of the AMI.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateCapacityReservationSpecificationRequest extends Object implements Serializable


Serialized Fields


capacityReservationPreference
String capacityReservationPreference

 Indicates the instance's Capacity Reservation preferences. Possible preferences include:
 
 
 
 
 open - The instance can run in any open Capacity Reservation that has matching
 attributes (instance type, platform, Availability Zone).
 
 
 
 
 none - The instance avoids running in a Capacity Reservation even if one is available. The instance
 runs in On-Demand capacity.
 
 
 


capacityReservationTarget
CapacityReservationTarget capacityReservationTarget

 Information about the target Capacity Reservation.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateCapacityReservationSpecificationResponse extends Object implements Serializable


Serialized Fields


capacityReservationPreference
String capacityReservationPreference

 Indicates the instance's Capacity Reservation preferences. Possible preferences include:
 
 
 
 
 open - The instance can run in any open Capacity Reservation that has matching
 attributes (instance type, platform, Availability Zone).
 
 
 
 
 none - The instance avoids running in a Capacity Reservation even if one is available. The instance
 runs in On-Demand capacity.
 
 
 


capacityReservationTarget
CapacityReservationTargetResponse capacityReservationTarget

 Information about the target Capacity Reservation.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateConfig extends Object implements Serializable


Serialized Fields


launchTemplateSpecification
FleetLaunchTemplateSpecification launchTemplateSpecification

 The launch template.
 


overrides
SdkInternalList<T> overrides

 Any parameters that you specify override the same parameters in the launch template.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateCpuOptions extends Object implements Serializable


Serialized Fields


coreCount
Integer coreCount

 The number of CPU cores for the instance.
 


threadsPerCore
Integer threadsPerCore

 The number of threads per CPU core.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateCpuOptionsRequest extends Object implements Serializable


Serialized Fields


coreCount
Integer coreCount

 The number of CPU cores for the instance.
 


threadsPerCore
Integer threadsPerCore

 The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise,
 specify the default value of 2.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateEbsBlockDevice extends Object implements Serializable


Serialized Fields


encrypted
Boolean encrypted

 Indicates whether the EBS volume is encrypted.
 


deleteOnTermination
Boolean deleteOnTermination

 Indicates whether the EBS volume is deleted on instance termination.
 


iops
Integer iops

 The number of I/O operations per second (IOPS) that the volume supports.
 


kmsKeyId
String kmsKeyId

 The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
 


snapshotId
String snapshotId

 The ID of the snapshot.
 


volumeSize
Integer volumeSize

 The size of the volume, in GiB.
 


volumeType
String volumeType

 The volume type.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateEbsBlockDeviceRequest extends Object implements Serializable


Serialized Fields


encrypted
Boolean encrypted

 Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support
 Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
 


deleteOnTermination
Boolean deleteOnTermination

 Indicates whether the EBS volume is deleted on instance termination.
 


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 about General Purpose SSD
 baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the
 Amazon Elastic Compute Cloud User Guide.
 
 
 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 ARN of the symmetric AWS Key Management Service (AWS KMS) CMK used for encryption.
 


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.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateElasticInferenceAccelerator extends Object implements Serializable


Serialized Fields


type
String type

 The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
 


count
Integer count

 The number of elastic inference accelerators to attach to the instance.
 
 
 Default: 1
 








Class com.amazonaws.services.ec2.model.LaunchTemplateElasticInferenceAcceleratorResponse extends Object implements Serializable


Serialized Fields


type
String type

 The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.
 


count
Integer count

 The number of elastic inference accelerators to attach to the instance.
 
 
 Default: 1
 








Class com.amazonaws.services.ec2.model.LaunchTemplateHibernationOptions extends Object implements Serializable


Serialized Fields


configured
Boolean configured

 If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not
 enabled for hibernation.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateHibernationOptionsRequest extends Object implements Serializable


Serialized Fields


configured
Boolean configured

 If you set this parameter to true, the instance is enabled for hibernation.
 
 
 Default: false
 








Class com.amazonaws.services.ec2.model.LaunchTemplateIamInstanceProfileSpecification 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.LaunchTemplateIamInstanceProfileSpecificationRequest 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.LaunchTemplateInstanceMarketOptions extends Object implements Serializable


Serialized Fields


marketType
String marketType

 The market type.
 


spotOptions
LaunchTemplateSpotMarketOptions spotOptions

 The options for Spot Instances.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateInstanceMarketOptionsRequest extends Object implements Serializable


Serialized Fields


marketType
String marketType

 The market type.
 


spotOptions
LaunchTemplateSpotMarketOptionsRequest spotOptions

 The options for Spot Instances.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateInstanceMetadataOptions extends Object implements Serializable


Serialized Fields


state
String state

 The state of the metadata option changes.
 
 
 pending - The metadata options are being updated and the instance is not ready to process metadata
 traffic with the new selection.
 
 
 applied - The metadata options have been successfully applied on the instance.
 


httpTokens
String httpTokens

 The state of token usage for your instance metadata requests. If the parameter is not specified in the request,
 the default state is optional.
 
 
 If the state is optional, you can choose to retrieve instance metadata with or without a signed
 token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
 credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0
 role credentials are returned.
 
 
 If the state is required, you must send a signed token header with any instance metadata retrieval
 requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the
 version 1.0 credentials are not available.
 


httpPutResponseHopLimit
Integer httpPutResponseHopLimit

 The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further
 instance metadata requests can travel.
 
 
 Default: 1
 
 
 Possible values: Integers from 1 to 64
 


httpEndpoint
String httpEndpoint

 This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not
 specified, the default state is enabled.
 
 
 
 If you specify a value of disabled, you will not be able to access your instance metadata.
 
 








Class com.amazonaws.services.ec2.model.LaunchTemplateInstanceMetadataOptionsRequest extends Object implements Serializable


Serialized Fields


httpTokens
String httpTokens

 The state of token usage for your instance metadata requests. If the parameter is not specified in the request,
 the default state is optional.
 
 
 If the state is optional, you can choose to retrieve instance metadata with or without a signed
 token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
 credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0
 role credentials are returned.
 
 
 If the state is required, you must send a signed token header with any instance metadata retrieval
 requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the
 version 1.0 credentials are not available.
 


httpPutResponseHopLimit
Integer httpPutResponseHopLimit

 The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further
 instance metadata requests can travel.
 
 
 Default: 1
 
 
 Possible values: Integers from 1 to 64
 


httpEndpoint
String httpEndpoint

 This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not
 specified, the default state is enabled.
 
 
 
 If you specify a value of disabled, you will not be able to access your instance metadata.
 
 








Class com.amazonaws.services.ec2.model.LaunchTemplateInstanceNetworkInterfaceSpecification extends Object implements Serializable


Serialized Fields


associatePublicIpAddress
Boolean associatePublicIpAddress

 Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
 


deleteOnTermination
Boolean deleteOnTermination

 Indicates whether the network interface is deleted when the instance is terminated.
 


description
String description

 A description for the network interface.
 


deviceIndex
Integer deviceIndex

 The device index for the network interface attachment.
 


groups
SdkInternalList<T> groups

 The IDs of one or more security groups.
 


interfaceType
String interfaceType

 The type of network interface.
 


ipv6AddressCount
Integer ipv6AddressCount

 The number of IPv6 addresses for the network interface.
 


ipv6Addresses
SdkInternalList<T> ipv6Addresses

 The IPv6 addresses for the network interface.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


privateIpAddress
String privateIpAddress

 The primary private IPv4 address of the network interface.
 


privateIpAddresses
SdkInternalList<T> privateIpAddresses

 One or more private IPv4 addresses.
 


secondaryPrivateIpAddressCount
Integer secondaryPrivateIpAddressCount

 The number of secondary private IPv4 addresses for the network interface.
 


subnetId
String subnetId

 The ID of the subnet for the network interface.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateInstanceNetworkInterfaceSpecificationRequest extends Object implements Serializable


Serialized Fields


associatePublicIpAddress
Boolean associatePublicIpAddress

 Associates a public IPv4 address with eth0 for a new network interface.
 


deleteOnTermination
Boolean deleteOnTermination

 Indicates whether the network interface is deleted when the instance is terminated.
 


description
String description

 A description for the network interface.
 


deviceIndex
Integer deviceIndex

 The device index for the network interface attachment.
 


groups
SdkInternalList<T> groups

 The IDs of one or more security groups.
 


interfaceType
String interfaceType

 The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more
 information, see Elastic Fabric
 Adapter in the Amazon Elastic Compute Cloud User Guide.
 
 
 If you are not creating an EFA, specify interface or omit this parameter.
 
 
 Valid values: interface | efa
 


ipv6AddressCount
Integer ipv6AddressCount

 The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6
 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
 


ipv6Addresses
SdkInternalList<T> ipv6Addresses

 One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if
 you're specifying a number of IPv6 addresses.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


privateIpAddress
String privateIpAddress

 The primary private IPv4 address of the network interface.
 


privateIpAddresses
SdkInternalList<T> privateIpAddresses

 One or more private IPv4 addresses.
 


secondaryPrivateIpAddressCount
Integer secondaryPrivateIpAddressCount

 The number of secondary private IPv4 addresses to assign to a network interface.
 


subnetId
String subnetId

 The ID of the subnet for the network interface.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateLicenseConfiguration extends Object implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

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








Class com.amazonaws.services.ec2.model.LaunchTemplateLicenseConfigurationRequest extends Object implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

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








Class com.amazonaws.services.ec2.model.LaunchTemplateOverrides extends Object implements Serializable


Serialized Fields


instanceType
String instanceType

 The instance type.
 


spotPrice
String spotPrice

 The maximum price per unit hour that you are willing to pay for a Spot Instance.
 


subnetId
String subnetId

 The ID of the subnet in which to launch the instances.
 


availabilityZone
String availabilityZone

 The Availability Zone in which to launch the instances.
 


weightedCapacity
Double weightedCapacity

 The number of units provided by the specified instance type.
 


priority
Double priority

 The priority for the launch template override. If OnDemandAllocationStrategy is set to
 prioritized, Spot Fleet uses priority to determine which launch template override to use first in
 fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at
 0. The lower the number, the higher the priority. If no number is set, the launch template override
 has the lowest priority.
 








Class com.amazonaws.services.ec2.model.LaunchTemplatePlacement extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone of the instance.
 


affinity
String affinity

 The affinity setting for the instance on the Dedicated Host.
 


groupName
String groupName

 The name of the placement group for the instance.
 


hostId
String hostId

 The ID of the Dedicated Host for the instance.
 


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.
 


spreadDomain
String spreadDomain

 Reserved for future use.
 


hostResourceGroupArn
String hostResourceGroupArn

 The ARN of the host resource group in which to launch the instances.
 


partitionNumber
Integer partitionNumber

 The number of the partition the instance should launch in. Valid only if the placement group strategy is set to
 partition.
 








Class com.amazonaws.services.ec2.model.LaunchTemplatePlacementRequest extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone for the instance.
 


affinity
String affinity

 The affinity setting for an instance on a Dedicated Host.
 


groupName
String groupName

 The name of the placement group for the instance.
 


hostId
String hostId

 The ID of the Dedicated Host for the instance.
 


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.
 


spreadDomain
String spreadDomain

 Reserved for future use.
 


hostResourceGroupArn
String hostResourceGroupArn

 The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN,
 omit the Tenancy parameter or set it to host.
 


partitionNumber
Integer partitionNumber

 The number of the partition the instance should launch in. Valid only if the placement group strategy is set to
 partition.
 








Class com.amazonaws.services.ec2.model.LaunchTemplatesMonitoring extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
 








Class com.amazonaws.services.ec2.model.LaunchTemplatesMonitoringRequest extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateSpecification extends Object implements Serializable


Serialized Fields


launchTemplateId
String launchTemplateId

 The ID of the launch template.
 


launchTemplateName
String launchTemplateName

 The name of the launch template.
 


version
String version

 The version number of the launch template.
 
 
 Default: The default version for the launch template.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateSpotMarketOptions extends Object implements Serializable


Serialized Fields


maxPrice
String maxPrice

 The maximum hourly price you're willing to pay for the Spot Instances.
 


spotInstanceType
String spotInstanceType

 The Spot Instance request type.
 


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


validUntil
Date validUntil

 The end date of the request. For 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.
 


instanceInterruptionBehavior
String instanceInterruptionBehavior

 The behavior when a Spot Instance is interrupted.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateSpotMarketOptionsRequest extends Object implements Serializable


Serialized Fields


maxPrice
String maxPrice

 The maximum hourly price you're willing to pay for the Spot Instances.
 


spotInstanceType
String spotInstanceType

 The Spot Instance request type.
 


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


validUntil
Date validUntil

 The end date of the request. For 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. The default end date is 7 days from the current date.
 


instanceInterruptionBehavior
String instanceInterruptionBehavior

 The behavior when a Spot Instance is interrupted. The default is terminate.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateTagSpecification extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of resource.
 


tags
SdkInternalList<T> tags

 The tags for the resource.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateTagSpecificationRequest extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of resource to tag. Currently, the resource types that support tagging on creation are
 instance and volume. To tag a resource after it has been created, see CreateTags.
 


tags
SdkInternalList<T> tags

 The tags to apply to the resource.
 








Class com.amazonaws.services.ec2.model.LaunchTemplateVersion extends Object implements Serializable


Serialized Fields


launchTemplateId
String launchTemplateId

 The ID of the launch template.
 


launchTemplateName
String launchTemplateName

 The name of the launch template.
 


versionNumber
Long versionNumber

 The version number.
 


versionDescription
String versionDescription

 The description for the version.
 


createTime
Date createTime

 The time the version was created.
 


createdBy
String createdBy

 The principal that created the version.
 


defaultVersion
Boolean defaultVersion

 Indicates whether the version is the default version.
 


launchTemplateData
ResponseLaunchTemplateData launchTemplateData

 Information about the launch template.
 








Class com.amazonaws.services.ec2.model.LicenseConfiguration extends Object implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

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








Class com.amazonaws.services.ec2.model.LicenseConfigurationRequest extends Object implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

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








Class com.amazonaws.services.ec2.model.LoadBalancersConfig extends Object implements Serializable


Serialized Fields


classicLoadBalancersConfig
ClassicLoadBalancersConfig classicLoadBalancersConfig

 The Classic Load Balancers.
 


targetGroupsConfig
TargetGroupsConfig targetGroupsConfig

 The target groups.
 








Class com.amazonaws.services.ec2.model.LoadPermission extends Object implements Serializable


Serialized Fields


userId
String userId

 The AWS account ID.
 


group
String group

 The name of the group.
 








Class com.amazonaws.services.ec2.model.LoadPermissionModifications extends Object implements Serializable


Serialized Fields


add
SdkInternalList<T> add

 The load permissions to add.
 


remove
SdkInternalList<T> remove

 The load permissions to remove.
 








Class com.amazonaws.services.ec2.model.LoadPermissionRequest 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.LocalGateway extends Object implements Serializable


Serialized Fields


localGatewayId
String localGatewayId

 The ID of the local gateway.
 


outpostArn
String outpostArn

 The Amazon Resource Name (ARN) of the Outpost.
 


ownerId
String ownerId

 The ID of the AWS account ID that owns the local gateway.
 


state
String state

 The state of the local gateway.
 


tags
SdkInternalList<T> tags

 The tags assigned to the local gateway.
 








Class com.amazonaws.services.ec2.model.LocalGatewayRoute extends Object implements Serializable


Serialized Fields


destinationCidrBlock
String destinationCidrBlock

 The CIDR block used for destination matches.
 


localGatewayVirtualInterfaceGroupId
String localGatewayVirtualInterfaceGroupId

 The ID of the virtual interface group.
 


type
String type

 The route type.
 


state
String state

 The state of the route.
 


localGatewayRouteTableId
String localGatewayRouteTableId

 The ID of the local gateway route table.
 








Class com.amazonaws.services.ec2.model.LocalGatewayRouteTable extends Object implements Serializable


Serialized Fields


localGatewayRouteTableId
String localGatewayRouteTableId

 The ID of the local gateway route table.
 


localGatewayId
String localGatewayId

 The ID of the local gateway.
 


outpostArn
String outpostArn

 The Amazon Resource Name (ARN) of the Outpost.
 


state
String state

 The state of the local gateway route table.
 


tags
SdkInternalList<T> tags

 The tags assigned to the local gateway route table.
 








Class com.amazonaws.services.ec2.model.LocalGatewayRouteTableVirtualInterfaceGroupAssociation extends Object implements Serializable


Serialized Fields


localGatewayRouteTableVirtualInterfaceGroupAssociationId
String localGatewayRouteTableVirtualInterfaceGroupAssociationId

 The ID of the association.
 


localGatewayVirtualInterfaceGroupId
String localGatewayVirtualInterfaceGroupId

 The ID of the virtual interface group.
 


localGatewayId
String localGatewayId

 The ID of the local gateway.
 


localGatewayRouteTableId
String localGatewayRouteTableId

 The ID of the local gateway route table.
 


state
String state

 The state of the association.
 


tags
SdkInternalList<T> tags

 The tags assigned to the association.
 








Class com.amazonaws.services.ec2.model.LocalGatewayRouteTableVpcAssociation extends Object implements Serializable


Serialized Fields


localGatewayRouteTableVpcAssociationId
String localGatewayRouteTableVpcAssociationId

 The ID of the association.
 


localGatewayRouteTableId
String localGatewayRouteTableId

 The ID of the local gateway route table.
 


localGatewayId
String localGatewayId

 The ID of the local gateway.
 


vpcId
String vpcId

 The ID of the VPC.
 


state
String state

 The state of the association.
 


tags
SdkInternalList<T> tags

 The tags assigned to the association.
 








Class com.amazonaws.services.ec2.model.LocalGatewayVirtualInterface extends Object implements Serializable


Serialized Fields


localGatewayVirtualInterfaceId
String localGatewayVirtualInterfaceId

 The ID of the virtual interface.
 


localGatewayId
String localGatewayId

 The ID of the local gateway.
 


vlan
Integer vlan

 The ID of the VLAN.
 


localAddress
String localAddress

 The local address.
 


peerAddress
String peerAddress

 The peer address.
 


localBgpAsn
Integer localBgpAsn

 The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
 


peerBgpAsn
Integer peerBgpAsn

 The peer BGP ASN.
 


tags
SdkInternalList<T> tags

 The tags assigned to the virtual interface.
 








Class com.amazonaws.services.ec2.model.LocalGatewayVirtualInterfaceGroup extends Object implements Serializable


Serialized Fields


localGatewayVirtualInterfaceGroupId
String localGatewayVirtualInterfaceGroupId

 The ID of the virtual interface group.
 


localGatewayVirtualInterfaceIds
SdkInternalList<T> localGatewayVirtualInterfaceIds

 The IDs of the virtual interfaces.
 


localGatewayId
String localGatewayId

 The ID of the local gateway.
 


tags
SdkInternalList<T> tags

 The tags assigned to the virtual interface group.
 








Class com.amazonaws.services.ec2.model.MemoryInfo extends Object implements Serializable


Serialized Fields


sizeInMiB
Long sizeInMiB

 Size of the memory, in MiB.
 








Class com.amazonaws.services.ec2.model.ModifyCapacityReservationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


capacityReservationId
String capacityReservationId

 The ID of the Capacity Reservation.
 


instanceCount
Integer instanceCount

 The number of instances for which to reserve capacity.
 


endDate
Date endDate

 The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved
 capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to
 expired when it reaches its end date and time.
 
 
 The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify
 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
 
 
 You must provide an EndDate value if EndDateType is limited. Omit
 EndDate if EndDateType is unlimited.
 


endDateType
String endDateType

 Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following
 end types:
 
 
 
 
 unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide
 an EndDate value if EndDateType is unlimited.
 
 
 
 
 limited - The Capacity Reservation expires automatically at a specified date and time. You must
 provide an EndDate value if EndDateType is limited.
 
 
 








Class com.amazonaws.services.ec2.model.ModifyCapacityReservationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.ModifyClientVpnEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint to modify.
 


serverCertificateArn
String serverCertificateArn

 The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate
 Manager (ACM).
 


connectionLogOptions
ConnectionLogOptions connectionLogOptions

 Information about the client connection logging options.
 
 
 If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream.
 The following information is logged:
 
 
 
 
 Client connection requests
 
 
 
 
 Client connection results (successful and unsuccessful)
 
 
 
 
 Reasons for unsuccessful client connection requests
 
 
 
 
 Client connection termination time
 
 
 


dnsServers
DnsServersOptionsModifyStructure dnsServers

 Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two
 DNS servers.
 


vpnPort
Integer vpnPort

 The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
 
 
 Valid Values: 443 | 1194
 
 
 Default Value: 443
 


description
String description

 A brief description of the Client VPN endpoint.
 


splitTunnel
Boolean splitTunnel

 Indicates whether the VPN is split-tunnel.
 
 
 For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN
 Endpoint in the AWS Client VPN Administrator Guide.
 








Class com.amazonaws.services.ec2.model.ModifyClientVpnEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.ModifyDefaultCreditSpecificationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceFamily
String instanceFamily

 The instance family.
 


cpuCredits
String cpuCredits

 The credit option for CPU usage of the instance family.
 
 
 Valid Values: standard | unlimited
 








Class com.amazonaws.services.ec2.model.ModifyDefaultCreditSpecificationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceFamilyCreditSpecification
InstanceFamilyCreditSpecification instanceFamilyCreditSpecification

 The default credit option for CPU usage of the instance family.
 








Class com.amazonaws.services.ec2.model.ModifyEbsDefaultKmsKeyIdRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


kmsKeyId
String kmsKeyId

 The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS
 encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is
 specified, the encrypted state must be true.
 
 
 You can specify the CMK using any of the following:
 
 
 
 
 Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
 
 
 
 
 Key alias. For example, alias/ExampleAlias.
 
 
 
 
 Key ARN. For example,
 arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
 
 
 
 
 Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
 
 
 
 
 AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the
 action can appear to complete, but eventually fails.
 
 
 Amazon EBS does not support asymmetric CMKs.
 








Class com.amazonaws.services.ec2.model.ModifyEbsDefaultKmsKeyIdResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


kmsKeyId
String kmsKeyId

 The Amazon Resource Name (ARN) of the default CMK for encryption by default.
 








Class com.amazonaws.services.ec2.model.ModifyFleetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


excessCapacityTerminationPolicy
String excessCapacityTerminationPolicy

 Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is
 decreased below the current size of the EC2 Fleet.
 


fleetId
String fleetId

 The ID of the EC2 Fleet.
 


targetCapacitySpecification
TargetCapacitySpecificationRequest targetCapacitySpecification

 The size of the EC2 Fleet.
 








Class com.amazonaws.services.ec2.model.ModifyFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Is true if the request succeeds, and an error otherwise.
 








Class com.amazonaws.services.ec2.model.ModifyFpgaImageAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fpgaImageId
String fpgaImageId

 The ID of the AFI.
 


attribute
String attribute

 The name of the attribute.
 


operationType
String operationType

 The operation type.
 


userIds
SdkInternalList<T> userIds

 The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.
 


userGroups
SdkInternalList<T> userGroups

 The user groups. This parameter is valid only when modifying the loadPermission attribute.
 


productCodes
SdkInternalList<T> productCodes

 The product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when
 modifying the productCodes attribute.
 


loadPermission
LoadPermissionModifications loadPermission

 The load permission for the AFI.
 


description
String description

 A description for the AFI.
 


name
String name

 A name for the AFI.
 








Class com.amazonaws.services.ec2.model.ModifyFpgaImageAttributeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fpgaImageAttribute
FpgaImageAttribute fpgaImageAttribute

 Information about the attribute.
 








Class com.amazonaws.services.ec2.model.ModifyHostsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


autoPlacement
String autoPlacement

 Specify whether to enable or disable auto-placement.
 


hostIds
SdkInternalList<T> hostIds

 The IDs of the Dedicated Hosts to modify.
 


hostRecovery
String hostRecovery

 Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see  Host Recovery in
 the Amazon Elastic Compute Cloud User Guide.
 


instanceType
String instanceType

 Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated
 Host to support only a specific instance type.
 
 
 If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit
 this parameter and specify InstanceFamily instead. You cannot specify InstanceType and
 InstanceFamily in the same request.
 


instanceFamily
String instanceFamily

 Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated
 Host to support multiple instance types within its current instance family.
 
 
 If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify
 InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same
 request.
 








Class com.amazonaws.services.ec2.model.ModifyHostsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successful
SdkInternalList<T> successful

 The IDs of the Dedicated Hosts that were successfully modified.
 


unsuccessful
SdkInternalList<T> unsuccessful

 The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.
 








Class com.amazonaws.services.ec2.model.ModifyIdentityIdFormatRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


principalArn
String principalArn

 The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to
 modify the ID format for all IAM users, IAM roles, and the root user of the account.
 


resource
String resource

 The type of resource: bundle | conversion-task | customer-gateway |
 dhcp-options | elastic-ip-allocation | elastic-ip-association |
 export-task | flow-log | image | import-task |
 internet-gateway | network-acl | network-acl-association |
 network-interface | network-interface-attachment | prefix-list |
 route-table | route-table-association | security-group |
 subnet | subnet-cidr-block-association | vpc |
 vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
 vpn-connection | vpn-gateway.
 
 
 Alternatively, use the all-current option to include all resource types that are currently within
 their opt-in period for longer IDs.
 


useLongIds
Boolean useLongIds

 Indicates whether the resource should use longer IDs (17-character IDs)
 








Class com.amazonaws.services.ec2.model.ModifyIdentityIdFormatResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ModifyIdFormatRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resource
String resource

 The type of resource: bundle | conversion-task | customer-gateway |
 dhcp-options | elastic-ip-allocation | elastic-ip-association |
 export-task | flow-log | image | import-task |
 internet-gateway | network-acl | network-acl-association |
 network-interface | network-interface-attachment | prefix-list |
 route-table | route-table-association | security-group |
 subnet | subnet-cidr-block-association | vpc |
 vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection |
 vpn-connection | vpn-gateway.
 
 
 Alternatively, use the all-current option to include all resource types that are currently within
 their opt-in period for longer IDs.
 


useLongIds
Boolean useLongIds

 Indicate whether the resource should use longer IDs (17-character IDs).
 








Class com.amazonaws.services.ec2.model.ModifyIdFormatResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ModifyImageAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


attribute
String attribute

 The name of the attribute to modify. The valid values are description, launchPermission
 , and productCodes.
 


description
String description

 A new description for the AMI.
 


imageId
String imageId

 The ID of the AMI.
 


launchPermission
LaunchPermissionModifications launchPermission

 A new launch permission for the AMI.
 


operationType
String operationType

 The operation type. This parameter can be used only when the Attribute parameter is
 launchPermission.
 


productCodes
SdkInternalList<T> productCodes

 The DevPay product codes. After you add a product code to an AMI, it can't be removed.
 


userGroups
SdkInternalList<T> userGroups

 The user groups. This parameter can be used only when the Attribute parameter is
 launchPermission.
 


userIds
SdkInternalList<T> userIds

 The AWS account IDs. This parameter can be used only when the Attribute parameter is
 launchPermission.
 


value
String value

 The value of the attribute being modified. This parameter can be used only when the Attribute
 parameter is description or productCodes.
 








Class com.amazonaws.services.ec2.model.ModifyImageAttributeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ModifyInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceDestCheck
Boolean sourceDestCheck

 Specifies whether source/destination checking is enabled. A value of true means that checking is
 enabled, and false means that checking is disabled. This value must be false for a NAT
 instance to perform NAT.
 


attribute
String attribute

 The name of the attribute.
 


blockDeviceMappings
SdkInternalList<T> blockDeviceMappings

 Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must
 be owned by the caller. If no value is specified for DeleteOnTermination, the default is
 true and the volume is deleted when the instance is terminated.
 
 
 To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance.
 For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User
 Guide.
 


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 parameter for Spot Instances.
 


ebsOptimized
Boolean ebsOptimized

 Specifies whether the instance is optimized for Amazon 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.
 


enaSupport
Boolean enaSupport

 Set to true to enable enhanced networking with ENA for the instance.
 
 
 This option is supported only for HVM instances. Specifying this option with a PV instance can make it
 unreachable.
 


groups
SdkInternalList<T> groups

 [EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's
 just the default security group for the VPC. You must specify the security group ID, not the security group name.
 


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.
 


sriovNetSupport
String sriovNetSupport

 Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the
 instance.
 
 
 There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface 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 value. If you are using an AWS SDK or command line tool,
 base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide
 base64-encoded text.
 


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ModifyInstanceCapacityReservationAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance to be modified.
 


capacityReservationSpecification
CapacityReservationSpecification capacityReservationSpecification

 Information about the Capacity Reservation targeting option.
 








Class com.amazonaws.services.ec2.model.ModifyInstanceCapacityReservationAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.ModifyInstanceCreditSpecificationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientToken
String clientToken

 A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more
 information, see Ensuring
 Idempotency.
 


instanceCreditSpecifications
SdkInternalList<T> instanceCreditSpecifications

 Information about the credit option for CPU usage.
 








Class com.amazonaws.services.ec2.model.ModifyInstanceCreditSpecificationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successfulInstanceCreditSpecifications
SdkInternalList<T> successfulInstanceCreditSpecifications

 Information about the instances whose credit option for CPU usage was successfully modified.
 


unsuccessfulInstanceCreditSpecifications
SdkInternalList<T> unsuccessfulInstanceCreditSpecifications

 Information about the instances whose credit option for CPU usage was not modified.
 








Class com.amazonaws.services.ec2.model.ModifyInstanceEventStartTimeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance with the scheduled event.
 


instanceEventId
String instanceEventId

 The ID of the event whose date and time you are modifying.
 


notBefore
Date notBefore

 The new date and time when the event will take place.
 








Class com.amazonaws.services.ec2.model.ModifyInstanceEventStartTimeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


event
InstanceStatusEvent event








Class com.amazonaws.services.ec2.model.ModifyInstanceMetadataOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 


httpTokens
String httpTokens

 The state of token usage for your instance metadata requests. If the parameter is not specified in the request,
 the default state is optional.
 
 
 If the state is optional, you can choose to retrieve instance metadata with or without a signed
 token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role
 credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0
 role credentials are returned.
 
 
 If the state is required, you must send a signed token header with any instance metadata retrieval
 requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials; the
 version 1.0 credentials are not available.
 


httpPutResponseHopLimit
Integer httpPutResponseHopLimit

 The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further
 instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
 
 
 Possible values: Integers from 1 to 64
 


httpEndpoint
String httpEndpoint

 This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not
 specified, the existing state is maintained.
 
 
 
 If you specify a value of disabled, you will not be able to access your instance metadata.
 
 








Class com.amazonaws.services.ec2.model.ModifyInstanceMetadataOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 


instanceMetadataOptions
InstanceMetadataOptionsResponse instanceMetadataOptions

 The metadata options for the instance.
 








Class com.amazonaws.services.ec2.model.ModifyInstancePlacementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


affinity
String affinity

 The affinity setting for the instance.
 


groupName
String groupName

 The name of the placement group in which to place the instance. For spread placement groups, the instance must
 have a tenancy of default. For cluster and partition placement groups, the instance must have a
 tenancy of default or dedicated.
 
 
 To remove an instance from a placement group, specify an empty string ("").
 


hostId
String hostId

 The ID of the Dedicated Host with which to associate the instance.
 


instanceId
String instanceId

 The ID of the instance that you are modifying.
 


tenancy
String tenancy

 The tenancy for the instance.
 


partitionNumber
Integer partitionNumber

 Reserved for future use.
 


hostResourceGroupArn
String hostResourceGroupArn

 The ARN of the host resource group in which to place the instance.
 








Class com.amazonaws.services.ec2.model.ModifyInstancePlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Is true if the request succeeds, and an error otherwise.
 








Class com.amazonaws.services.ec2.model.ModifyLaunchTemplateRequest 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
 Ensuring
 Idempotency.
 
 
 Constraint: Maximum 128 ASCII characters.
 


launchTemplateId
String launchTemplateId

 The ID of the launch template. You must specify either the launch template ID or launch template name in the
 request.
 


launchTemplateName
String launchTemplateName

 The name of the launch template. You must specify either the launch template ID or launch template name in the
 request.
 


defaultVersion
String defaultVersion

 The version number of the launch template to set as the default version.
 








Class com.amazonaws.services.ec2.model.ModifyLaunchTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


launchTemplate
LaunchTemplate launchTemplate

 Information about the launch template.
 








Class com.amazonaws.services.ec2.model.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
SdkInternalList<T> groups

 Changes the security groups for the network interface. The new set of groups you specify replaces the current
 set. You must specify at least one group, even if it's just the default security group in the VPC. You must
 specify the ID of the security group, not the name.
 


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ModifyReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reservedInstancesIds
SdkInternalList<T> reservedInstancesIds

 The IDs of the Reserved Instances to modify.
 


clientToken
String clientToken

 A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more
 information, see Ensuring
 Idempotency.
 


targetConfigurations
SdkInternalList<T> targetConfigurations

 The configuration settings for the Reserved Instances to modify.
 








Class com.amazonaws.services.ec2.model.ModifyReservedInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservedInstancesModificationId
String reservedInstancesModificationId

 The ID for the modification.
 








Class com.amazonaws.services.ec2.model.ModifySnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


attribute
String attribute

 The snapshot attribute to modify. Only volume creation permissions can be modified.
 


createVolumePermission
CreateVolumePermissionModifications createVolumePermission

 A JSON representation of the snapshot attribute modification.
 


groupNames
SdkInternalList<T> 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
SdkInternalList<T> userIds

 The account ID to modify for the snapshot.
 








Class com.amazonaws.services.ec2.model.ModifySnapshotAttributeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.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.
 


onDemandTargetCapacity
Integer onDemandTargetCapacity

 The number of On-Demand Instances in the fleet.
 








Class com.amazonaws.services.ec2.model.ModifySpotFleetRequestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Is true if the request succeeds, and an error otherwise.
 








Class com.amazonaws.services.ec2.model.ModifySubnetAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assignIpv6AddressOnCreation
Boolean assignIpv6AddressOnCreation

 Specify true to indicate that network interfaces created in the specified subnet should be assigned
 an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the
 instance therefore receives an IPv6 address).
 
 
 If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an
 IPv6 address if it's created using version 2016-11-15 or later of the Amazon EC2 API.
 


mapPublicIpOnLaunch
Boolean mapPublicIpOnLaunch

 Specify true to indicate that ENIs attached to instances created in the specified subnet should be
 assigned a public IPv4 address.
 


subnetId
String subnetId

 The ID of the subnet.
 








Class com.amazonaws.services.ec2.model.ModifySubnetAttributeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ModifyTrafficMirrorFilterNetworkServicesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trafficMirrorFilterId
String trafficMirrorFilterId

 The ID of the Traffic Mirror filter.
 


addNetworkServices
SdkInternalList<T> addNetworkServices

 The network service, for example Amazon DNS, that you want to mirror.
 


removeNetworkServices
SdkInternalList<T> removeNetworkServices

 The network service, for example Amazon DNS, that you no longer want to mirror.
 








Class com.amazonaws.services.ec2.model.ModifyTrafficMirrorFilterNetworkServicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorFilter
TrafficMirrorFilter trafficMirrorFilter

 The Traffic Mirror filter that the network service is associated with.
 








Class com.amazonaws.services.ec2.model.ModifyTrafficMirrorFilterRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trafficMirrorFilterRuleId
String trafficMirrorFilterRuleId

 The ID of the Traffic Mirror rule.
 


trafficDirection
String trafficDirection

 The type of traffic (ingress | egress) to assign to the rule.
 


ruleNumber
Integer ruleNumber

 The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given
 direction. The rules are processed in ascending order by rule number.
 


ruleAction
String ruleAction

 The action to assign to the rule.
 


destinationPortRange
TrafficMirrorPortRangeRequest destinationPortRange

 The destination ports that are associated with the Traffic Mirror rule.
 


sourcePortRange
TrafficMirrorPortRangeRequest sourcePortRange

 The port range to assign to the Traffic Mirror rule.
 


protocol
Integer protocol

 The protocol, for example TCP, to assign to the Traffic Mirror rule.
 


destinationCidrBlock
String destinationCidrBlock

 The destination CIDR block to assign to the Traffic Mirror rule.
 


sourceCidrBlock
String sourceCidrBlock

 The source CIDR block to assign to the Traffic Mirror rule.
 


description
String description

 The description to assign to the Traffic Mirror rule.
 


removeFields
SdkInternalList<T> removeFields

 The properties that you want to remove from the Traffic Mirror filter rule.
 
 
 When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
 








Class com.amazonaws.services.ec2.model.ModifyTrafficMirrorFilterRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorFilterRule
TrafficMirrorFilterRule trafficMirrorFilterRule

 Modifies a Traffic Mirror rule.
 








Class com.amazonaws.services.ec2.model.ModifyTrafficMirrorSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


trafficMirrorSessionId
String trafficMirrorSessionId

 The ID of the Traffic Mirror session.
 


trafficMirrorTargetId
String trafficMirrorTargetId

 The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection
 with the source.
 


trafficMirrorFilterId
String trafficMirrorFilterId

 The ID of the Traffic Mirror filter.
 


packetLength
Integer packetLength

 The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set
 this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that
 meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the
 entire packet.
 


sessionNumber
Integer sessionNumber

 The session number determines the order in which sessions are evaluated when an interface is used by multiple
 sessions. The first session with a matching filter is the one that mirrors the packets.
 
 
 Valid values are 1-32766.
 


virtualNetworkId
Integer virtualNetworkId

 The virtual network ID of the Traffic Mirror session.
 


description
String description

 The description to assign to the Traffic Mirror session.
 


removeFields
SdkInternalList<T> removeFields

 The properties that you want to remove from the Traffic Mirror session.
 
 
 When you remove a property from a Traffic Mirror session, the property is set to the default.
 








Class com.amazonaws.services.ec2.model.ModifyTrafficMirrorSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trafficMirrorSession
TrafficMirrorSession trafficMirrorSession

 Information about the Traffic Mirror session.
 








Class com.amazonaws.services.ec2.model.ModifyTransitGatewayVpcAttachmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 


addSubnetIds
SdkInternalList<T> addSubnetIds

 The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
 


removeSubnetIds
SdkInternalList<T> removeSubnetIds

 The IDs of one or more subnets to remove.
 


options
ModifyTransitGatewayVpcAttachmentRequestOptions options

 The new VPC attachment options.
 
 
 
 You cannot modify the IPv6 options.
 
 








Class com.amazonaws.services.ec2.model.ModifyTransitGatewayVpcAttachmentRequestOptions extends Object implements Serializable


Serialized Fields


dnsSupport
String dnsSupport

 Enable or disable DNS support. The default is enable.
 


ipv6Support
String ipv6Support

 Enable or disable IPv6 support. The default is enable.
 








Class com.amazonaws.services.ec2.model.ModifyTransitGatewayVpcAttachmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayVpcAttachment
TransitGatewayVpcAttachment transitGatewayVpcAttachment

 Information about the modified attachment.
 








Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ModifyVolumeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


volumeId
String volumeId

 The ID of the volume.
 


size
Integer size

 The target size of the volume, in GiB. The target volume size must be greater than or equal to than the existing
 size of the volume. For information about available EBS volume sizes, see Amazon EBS Volume Types.
 
 
 Default: If no size is specified, the existing size is retained.
 


volumeType
String volumeType

 The target EBS volume type of the volume.
 
 
 Default: If no type is specified, the existing type is retained.
 


iops
Integer iops

 The target IOPS rate of the volume.
 
 
 This is only valid for Provisioned IOPS SSD (io1) volumes. For more information, see Provisioned
 IOPS SSD (io1) Volumes.
 
 
 Default: If no IOPS value is specified, the existing value is retained.
 








Class com.amazonaws.services.ec2.model.ModifyVolumeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


volumeModification
VolumeModification volumeModification

 Information about the volume modification.
 








Class com.amazonaws.services.ec2.model.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" 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ModifyVpcEndpointConnectionNotificationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectionNotificationId
String connectionNotificationId

 The ID of the notification.
 


connectionNotificationArn
String connectionNotificationArn

 The ARN for the SNS topic for the notification.
 


connectionEvents
SdkInternalList<T> connectionEvents

 One or more events for the endpoint. Valid values are Accept, Connect,
 Delete, and Reject.
 








Class com.amazonaws.services.ec2.model.ModifyVpcEndpointConnectionNotificationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.ModifyVpcEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcEndpointId
String vpcEndpointId

 The ID of the endpoint.
 


resetPolicy
Boolean resetPolicy

 (Gateway endpoint) Specify true to reset the policy document to the default policy. The default
 policy allows full access to the service.
 


policyDocument
String policyDocument

 A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.
 


addRouteTableIds
SdkInternalList<T> addRouteTableIds

 (Gateway endpoint) One or more route tables IDs to associate with the endpoint.
 


removeRouteTableIds
SdkInternalList<T> removeRouteTableIds

 (Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
 


addSubnetIds
SdkInternalList<T> addSubnetIds

 (Interface endpoint) One or more subnet IDs in which to serve the endpoint.
 


removeSubnetIds
SdkInternalList<T> removeSubnetIds

 (Interface endpoint) One or more subnets IDs in which to remove the endpoint.
 


addSecurityGroupIds
SdkInternalList<T> addSecurityGroupIds

 (Interface endpoint) One or more security group IDs to associate with the network interface.
 


removeSecurityGroupIds
SdkInternalList<T> removeSecurityGroupIds

 (Interface endpoint) One or more security group IDs to disassociate from the network interface.
 


privateDnsEnabled
Boolean privateDnsEnabled

 (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
 








Class com.amazonaws.services.ec2.model.ModifyVpcEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.ModifyVpcEndpointServiceConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceId
String serviceId

 The ID of the service.
 


privateDnsName
String privateDnsName

 The private DNS name to assign to the endpoint service.
 


removePrivateDnsName
Boolean removePrivateDnsName

 Removes the private DNS name of the endpoint service.
 


acceptanceRequired
Boolean acceptanceRequired

 Indicates whether requests to create an endpoint to your service must be accepted.
 


addNetworkLoadBalancerArns
SdkInternalList<T> addNetworkLoadBalancerArns

 The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
 


removeNetworkLoadBalancerArns
SdkInternalList<T> removeNetworkLoadBalancerArns

 The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
 








Class com.amazonaws.services.ec2.model.ModifyVpcEndpointServiceConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.ModifyVpcEndpointServicePermissionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceId
String serviceId

 The ID of the service.
 


addAllowedPrincipals
SdkInternalList<T> addAllowedPrincipals

 The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this
 list. To grant permissions to all principals, specify an asterisk (*).
 


removeAllowedPrincipals
SdkInternalList<T> removeAllowedPrincipals

 The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.
 








Class com.amazonaws.services.ec2.model.ModifyVpcEndpointServicePermissionsResult extends AmazonWebServiceResult<ResponseMetadata> 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 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 extends AmazonWebServiceResult<ResponseMetadata> 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.ModifyVpcTenancyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcId
String vpcId

 The ID of the VPC.
 


instanceTenancy
String instanceTenancy

 The instance tenancy attribute for the VPC.
 








Class com.amazonaws.services.ec2.model.ModifyVpcTenancyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, returns an error.
 








Class com.amazonaws.services.ec2.model.ModifyVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpnConnectionId
String vpnConnectionId

 The ID of the VPN connection.
 


transitGatewayId
String transitGatewayId

 The ID of the transit gateway.
 


customerGatewayId
String customerGatewayId

 The ID of the customer gateway at your end 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.ModifyVpnConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpnConnection
VpnConnection vpnConnection








Class com.amazonaws.services.ec2.model.ModifyVpnTunnelCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpnConnectionId
String vpnConnectionId

 The ID of the AWS Site-to-Site VPN connection.
 


vpnTunnelOutsideIpAddress
String vpnTunnelOutsideIpAddress

 The external IP address of the VPN tunnel.
 








Class com.amazonaws.services.ec2.model.ModifyVpnTunnelCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpnConnection
VpnConnection vpnConnection








Class com.amazonaws.services.ec2.model.ModifyVpnTunnelOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpnConnectionId
String vpnConnectionId

 The ID of the AWS Site-to-Site VPN connection.
 


vpnTunnelOutsideIpAddress
String vpnTunnelOutsideIpAddress

 The external IP address of the VPN tunnel.
 


tunnelOptions
ModifyVpnTunnelOptionsSpecification tunnelOptions

 The tunnel options to modify.
 








Class com.amazonaws.services.ec2.model.ModifyVpnTunnelOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpnConnection
VpnConnection vpnConnection








Class com.amazonaws.services.ec2.model.ModifyVpnTunnelOptionsSpecification extends Object implements Serializable


Serialized Fields


tunnelInsideCidr
String tunnelInsideCidr

 The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN
 connections that use the same virtual private gateway.
 
 
 Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are
 reserved and cannot be used:
 
 
 
 
 169.254.0.0/30
 
 
 
 
 169.254.1.0/30
 
 
 
 
 169.254.2.0/30
 
 
 
 
 169.254.3.0/30
 
 
 
 
 169.254.4.0/30
 
 
 
 
 169.254.5.0/30
 
 
 
 
 169.254.169.252/30
 
 
 


preSharedKey
String preSharedKey

 The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer
 gateway.
 
 
 Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8
 and 64 characters in length and cannot start with zero (0).
 


phase1LifetimeSeconds
Integer phase1LifetimeSeconds

 The lifetime for phase 1 of the IKE negotiation, in seconds.
 
 
 Constraints: A value between 900 and 28,800.
 
 
 Default: 28800
 


phase2LifetimeSeconds
Integer phase2LifetimeSeconds

 The lifetime for phase 2 of the IKE negotiation, in seconds.
 
 
 Constraints: A value between 900 and 3,600. The value must be less than the value for
 Phase1LifetimeSeconds.
 
 
 Default: 3600
 


rekeyMarginTimeSeconds
Integer rekeyMarginTimeSeconds

 The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection
 performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for
 RekeyFuzzPercentage.
 
 
 Constraints: A value between 60 and half of Phase2LifetimeSeconds.
 
 
 Default: 540
 


rekeyFuzzPercentage
Integer rekeyFuzzPercentage

 The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey
 time is randomly selected.
 
 
 Constraints: A value between 0 and 100.
 
 
 Default: 100
 


replayWindowSize
Integer replayWindowSize

 The number of packets in an IKE replay window.
 
 
 Constraints: A value between 64 and 2048.
 
 
 Default: 1024
 


dPDTimeoutSeconds
Integer dPDTimeoutSeconds

 The number of seconds after which a DPD timeout occurs.
 
 
 Constraints: A value between 0 and 30.
 
 
 Default: 30
 


phase1EncryptionAlgorithms
SdkInternalList<T> phase1EncryptionAlgorithms

 One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
 
 
 Valid values: AES128 | AES256
 


phase2EncryptionAlgorithms
SdkInternalList<T> phase2EncryptionAlgorithms

 One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
 
 
 Valid values: AES128 | AES256
 


phase1IntegrityAlgorithms
SdkInternalList<T> phase1IntegrityAlgorithms

 One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
 
 
 Valid values: SHA1 | SHA2-256
 


phase2IntegrityAlgorithms
SdkInternalList<T> phase2IntegrityAlgorithms

 One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
 
 
 Valid values: SHA1 | SHA2-256
 


phase1DHGroupNumbers
SdkInternalList<T> phase1DHGroupNumbers

 One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
 
 
 Valid values: 2 | 14 | 15 | 16 | 17 |
 18 | 22 | 23 | 24
 


phase2DHGroupNumbers
SdkInternalList<T> phase2DHGroupNumbers

 One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
 
 
 Valid values: 2 | 5 | 14 | 15 | 16 |
 17 | 18 | 22 | 23 | 24
 


iKEVersions
SdkInternalList<T> iKEVersions

 The IKE versions that are permitted for the VPN tunnel.
 
 
 Valid values: ikev1 | ikev2
 








Class com.amazonaws.services.ec2.model.Monitoring extends Object implements Serializable


Serialized Fields


state
String state

 Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
 








Class com.amazonaws.services.ec2.model.MonitorInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceIds
SdkInternalList<T> instanceIds

 The IDs of the instances.
 








Class com.amazonaws.services.ec2.model.MonitorInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceMonitorings
SdkInternalList<T> instanceMonitorings

 The monitoring information.
 








Class com.amazonaws.services.ec2.model.MoveAddressToVpcRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


publicIp
String publicIp

 The Elastic IP address.
 








Class com.amazonaws.services.ec2.model.MoveAddressToVpcResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


allocationId
String allocationId

 The allocation ID for the Elastic IP address.
 


status
String status

 The status of the move of the IP address.
 








Class com.amazonaws.services.ec2.model.MovingAddressStatus extends Object implements Serializable


Serialized Fields


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 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
SdkInternalList<T> natGatewayAddresses

 Information about the IP addresses and network interface associated with the NAT gateway.
 


natGatewayId
String natGatewayId

 The ID of the NAT gateway.
 


provisionedBandwidth
ProvisionedBandwidth provisionedBandwidth

 Reserved. If you need to sustain traffic greater than the documented limits, contact us
 through the Support Center.
 


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.
 


tags
SdkInternalList<T> tags

 The tags for the NAT gateway.
 








Class com.amazonaws.services.ec2.model.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 extends Object implements Serializable


Serialized Fields


associations
SdkInternalList<T> associations

 Any associations between the network ACL and one or more subnets
 


entries
SdkInternalList<T> 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
SdkInternalList<T> tags

 Any tags assigned to the network ACL.
 


vpcId
String vpcId

 The ID of the VPC for the network ACL.
 


ownerId
String ownerId

 The ID of the AWS account that owns the network ACL.
 








Class com.amazonaws.services.ec2.model.NetworkAclAssociation extends Object implements Serializable


Serialized Fields


networkAclAssociationId
String networkAclAssociationId

 The ID of the association between a network ACL and a subnet.
 


networkAclId
String networkAclId

 The ID of the network ACL.
 


subnetId
String subnetId

 The ID of the subnet.
 








Class com.amazonaws.services.ec2.model.NetworkAclEntry extends Object implements Serializable


Serialized Fields


cidrBlock
String cidrBlock

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


ipv6CidrBlock
String ipv6CidrBlock

 The IPv6 network range to allow or deny, in CIDR notation.
 


portRange
PortRange portRange

 TCP or UDP protocols: The range of ports the rule applies to.
 


protocol
String protocol

 The protocol number. 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.NetworkInfo extends Object implements Serializable


Serialized Fields


networkPerformance
String networkPerformance

 Describes the network performance.
 


maximumNetworkInterfaces
Integer maximumNetworkInterfaces

 The maximum number of network interfaces for the instance type.
 


ipv4AddressesPerInterface
Integer ipv4AddressesPerInterface

 The maximum number of IPv4 addresses per network interface.
 


ipv6AddressesPerInterface
Integer ipv6AddressesPerInterface

 The maximum number of IPv6 addresses per network interface.
 


ipv6Supported
Boolean ipv6Supported

 Indicates whether IPv6 is supported.
 


enaSupport
String enaSupport

 Indicates whether Elastic Network Adapter (ENA) is supported.
 








Class com.amazonaws.services.ec2.model.NetworkInterface extends Object implements Serializable


Serialized Fields


association
NetworkInterfaceAssociation association

 The association information for an Elastic IP address (IPv4) associated with the network interface.
 


attachment
NetworkInterfaceAttachment attachment

 The network interface attachment.
 


availabilityZone
String availabilityZone

 The Availability Zone.
 


description
String description

 A description.
 


groups
SdkInternalList<T> groups

 Any security groups for the network interface.
 


interfaceType
String interfaceType

 The type of network interface.
 


ipv6Addresses
SdkInternalList<T> ipv6Addresses

 The IPv6 addresses associated with the network interface.
 


macAddress
String macAddress

 The MAC address.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


outpostArn
String outpostArn

 The Amazon Resource Name (ARN) of the Outpost.
 


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 IPv4 address of the network interface within the subnet.
 


privateIpAddresses
SdkInternalList<T> privateIpAddresses

 The private IPv4 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
SdkInternalList<T> tagSet

 Any tags assigned to the network interface.
 


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.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 extends Object implements Serializable


Serialized Fields


attachTime
Date attachTime

 The timestamp indicating when the attachment initiated.
 


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.
 


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 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.NetworkInterfaceIpv6Address extends Object implements Serializable


Serialized Fields


ipv6Address
String ipv6Address

 The IPv6 address.
 








Class com.amazonaws.services.ec2.model.NetworkInterfacePermission extends Object implements Serializable


Serialized Fields


networkInterfacePermissionId
String networkInterfacePermissionId

 The ID of the network interface permission.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


awsAccountId
String awsAccountId

 The AWS account ID.
 


awsService
String awsService

 The AWS service.
 


permission
String permission

 The type of permission.
 


permissionState
NetworkInterfacePermissionState permissionState

 Information about the state of the permission.
 








Class com.amazonaws.services.ec2.model.NetworkInterfacePermissionState extends Object implements Serializable


Serialized Fields


state
String state

 The state of the permission.
 


statusMessage
String statusMessage

 A status message, if applicable.
 








Class com.amazonaws.services.ec2.model.NetworkInterfacePrivateIpAddress extends Object implements Serializable


Serialized Fields


association
NetworkInterfaceAssociation association

 The association information for an Elastic IP address (IPv4) associated with the network interface.
 


primary
Boolean primary

 Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.
 


privateDnsName
String privateDnsName

 The private DNS name.
 


privateIpAddress
String privateIpAddress

 The private IPv4 address.
 








Class com.amazonaws.services.ec2.model.OnDemandOptions extends Object implements Serializable


Serialized Fields


allocationStrategy
String allocationStrategy

 The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify
 lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you
 specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override,
 launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to
 lowest-price.
 


capacityReservationOptions
CapacityReservationOptions capacityReservationOptions

 The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets
 of type instant.
 


singleInstanceType
Boolean singleInstanceType

 Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. Supported
 only for fleets of type instant.
 


singleAvailabilityZone
Boolean singleAvailabilityZone

 Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for
 fleets of type instant.
 


minTargetCapacity
Integer minTargetCapacity

 The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached,
 the fleet launches no instances.
 


maxTotalPrice
String maxTotalPrice

 The maximum amount per hour for On-Demand Instances that you're willing to pay.
 








Class com.amazonaws.services.ec2.model.OnDemandOptionsRequest extends Object implements Serializable


Serialized Fields


allocationStrategy
String allocationStrategy

 The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify
 lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you
 specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override,
 launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to
 lowest-price.
 


capacityReservationOptions
CapacityReservationOptionsRequest capacityReservationOptions

 The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity. Supported only for fleets
 of type instant.
 


singleInstanceType
Boolean singleInstanceType

 Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet. Supported
 only for fleets of type instant.
 


singleAvailabilityZone
Boolean singleAvailabilityZone

 Indicates that the fleet launches all On-Demand Instances into a single Availability Zone. Supported only for
 fleets of type instant.
 


minTargetCapacity
Integer minTargetCapacity

 The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached,
 the fleet launches no instances.
 


maxTotalPrice
String maxTotalPrice

 The maximum amount per hour for On-Demand Instances that you're willing to pay.
 








Class com.amazonaws.services.ec2.model.PciId extends Object implements Serializable


Serialized Fields


deviceId
String deviceId

 The ID of the device.
 


vendorId
String vendorId

 The ID of the vendor.
 


subsystemId
String subsystemId

 The ID of the subsystem.
 


subsystemVendorId
String subsystemVendorId

 The ID of the vendor for the subsystem.
 








Class com.amazonaws.services.ec2.model.PeeringAttachmentStatus extends Object implements Serializable


Serialized Fields


code
String code

 The status code.
 


message
String message

 The status message, if applicable.
 








Class com.amazonaws.services.ec2.model.PeeringConnectionOptions extends Object implements Serializable


Serialized Fields


allowDnsResolutionFromRemoteVpc
Boolean allowDnsResolutionFromRemoteVpc

 If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried
 from instances in the peer VPC.
 


allowEgressFromLocalClassicLinkToRemoteVpc
Boolean allowEgressFromLocalClassicLinkToRemoteVpc

 If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using
 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 using ClassicLink.
 








Class com.amazonaws.services.ec2.model.PeeringConnectionOptionsRequest extends Object implements Serializable


Serialized Fields


allowDnsResolutionFromRemoteVpc
Boolean allowDnsResolutionFromRemoteVpc

 If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances
 in the peer VPC.
 


allowEgressFromLocalClassicLinkToRemoteVpc
Boolean allowEgressFromLocalClassicLinkToRemoteVpc

 If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using
 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 using ClassicLink.
 








Class com.amazonaws.services.ec2.model.PeeringTgwInfo extends Object implements Serializable


Serialized Fields


transitGatewayId
String transitGatewayId

 The ID of the transit gateway.
 


ownerId
String ownerId

 The AWS account ID of the owner of the transit gateway.
 


region
String region

 The Region of the transit gateway.
 








Class com.amazonaws.services.ec2.model.Phase1DHGroupNumbersListValue extends Object implements Serializable


Serialized Fields


value
Integer value

 The Diffie-Hellmann group number.
 








Class com.amazonaws.services.ec2.model.Phase1DHGroupNumbersRequestListValue extends Object implements Serializable


Serialized Fields


value
Integer value

 The Diffie-Hellmann group number.
 








Class com.amazonaws.services.ec2.model.Phase1EncryptionAlgorithmsListValue extends Object implements Serializable


Serialized Fields


value
String value

 The value for the encryption algorithm.
 








Class com.amazonaws.services.ec2.model.Phase1EncryptionAlgorithmsRequestListValue extends Object implements Serializable


Serialized Fields


value
String value

 The value for the encryption algorithm.
 








Class com.amazonaws.services.ec2.model.Phase1IntegrityAlgorithmsListValue extends Object implements Serializable


Serialized Fields


value
String value

 The value for the integrity algorithm.
 








Class com.amazonaws.services.ec2.model.Phase1IntegrityAlgorithmsRequestListValue extends Object implements Serializable


Serialized Fields


value
String value

 The value for the integrity algorithm.
 








Class com.amazonaws.services.ec2.model.Phase2DHGroupNumbersListValue extends Object implements Serializable


Serialized Fields


value
Integer value

 The Diffie-Hellmann group number.
 








Class com.amazonaws.services.ec2.model.Phase2DHGroupNumbersRequestListValue extends Object implements Serializable


Serialized Fields


value
Integer value

 The Diffie-Hellmann group number.
 








Class com.amazonaws.services.ec2.model.Phase2EncryptionAlgorithmsListValue extends Object implements Serializable


Serialized Fields


value
String value

 The encryption algorithm.
 








Class com.amazonaws.services.ec2.model.Phase2EncryptionAlgorithmsRequestListValue extends Object implements Serializable


Serialized Fields


value
String value

 The encryption algorithm.
 








Class com.amazonaws.services.ec2.model.Phase2IntegrityAlgorithmsListValue extends Object implements Serializable


Serialized Fields


value
String value

 The integrity algorithm.
 








Class com.amazonaws.services.ec2.model.Phase2IntegrityAlgorithmsRequestListValue extends Object implements Serializable


Serialized Fields


value
String value

 The integrity algorithm.
 








Class com.amazonaws.services.ec2.model.Placement extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone of the instance.
 
 
 If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria
 for the Region.
 


affinity
String affinity

 The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the
 ImportInstance command.
 


groupName
String groupName

 The name of the placement group the instance is in.
 


partitionNumber
Integer partitionNumber

 The number of the partition the instance is in. Valid only if the placement group strategy is set to
 partition.
 


hostId
String hostId

 The ID of the Dedicated Host on which the instance resides. This parameter is not supported 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.
 


spreadDomain
String spreadDomain

 Reserved for future use.
 


hostResourceGroupArn
String hostResourceGroupArn

 The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN,
 omit the Tenancy parameter or set it to host.
 








Class com.amazonaws.services.ec2.model.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.
 


partitionCount
Integer partitionCount

 The number of partitions. Valid only if strategy is set to partition.
 


groupId
String groupId

 The ID of the placement group.
 


tags
SdkInternalList<T> tags

 Any tags applied to the placement group.
 








Class com.amazonaws.services.ec2.model.PlacementGroupInfo extends Object implements Serializable


Serialized Fields


supportedStrategies
SdkInternalList<T> supportedStrategies

 A list of supported placement groups types.
 








Class com.amazonaws.services.ec2.model.PlacementResponse extends Object implements Serializable


Serialized Fields


groupName
String groupName

 The name of the placement group that the instance is in.
 








Class com.amazonaws.services.ec2.model.PoolCidrBlock extends Object implements Serializable


Serialized Fields


cidr
String cidr

 The CIDR block.
 








Class com.amazonaws.services.ec2.model.PortRange extends Object implements Serializable


Serialized Fields


from
Integer from

 The first port in the range.
 


to
Integer to

 The last port in the range.
 








Class com.amazonaws.services.ec2.model.PrefixList extends Object implements Serializable


Serialized Fields


cidrs
SdkInternalList<T> 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 extends Object implements Serializable


Serialized Fields


description
String description

 A description for the security group rule that references this prefix list ID.
 
 
 Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and
 ._-:/()#,@[]+=;{}!$*
 


prefixListId
String prefixListId

 The ID of the prefix.
 








Class com.amazonaws.services.ec2.model.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 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 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.PrincipalIdFormat extends Object implements Serializable


Serialized Fields


arn
String arn

 PrincipalIdFormatARN description
 


statuses
SdkInternalList<T> statuses

 PrincipalIdFormatStatuses description
 








Class com.amazonaws.services.ec2.model.PrivateDnsNameConfiguration extends Object implements Serializable


Serialized Fields


state
String state

 The verification state of the VPC endpoint service.
 
 
 >Consumers of the endpoint service can use the private name only when the state is verified.
 


type
String type

 The endpoint service verification type, for example TXT.
 


value
String value

 The value the service provider adds to the private DNS name domain record before verification.
 


name
String name

 The name of the record subdomain the service provider needs to create. The service provider adds the
 value text to the name.
 








Class com.amazonaws.services.ec2.model.PrivateIpAddressSpecification extends Object implements Serializable


Serialized Fields


primary
Boolean primary

 Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be
 designated as primary.
 


privateIpAddress
String privateIpAddress

 The private IPv4 addresses.
 








Class com.amazonaws.services.ec2.model.ProcessorInfo extends Object implements Serializable


Serialized Fields


supportedArchitectures
SdkInternalList<T> supportedArchitectures

 A list of architectures supported by the instance type.
 


sustainedClockSpeedInGhz
Double sustainedClockSpeedInGhz

 The speed of the processor, in GHz.
 








Class com.amazonaws.services.ec2.model.ProductCode extends Object implements Serializable


Serialized Fields


productCodeId
String productCodeId

 The product code.
 


productCodeType
String productCodeType

 The type of product code.
 








Class com.amazonaws.services.ec2.model.PropagatingVgw extends Object implements Serializable


Serialized Fields


gatewayId
String gatewayId

 The ID of the virtual private gateway.
 








Class com.amazonaws.services.ec2.model.ProvisionByoipCidrRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cidr
String cidr

 The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is
 /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address
 range that you've brought to this or another Region.
 


cidrAuthorizationContext
CidrAuthorizationContext cidrAuthorizationContext

 A signed document that proves that you are authorized to bring the specified IP address range to Amazon using
 BYOIP.
 


publiclyAdvertisable
Boolean publiclyAdvertisable

 (IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
 
 
 Default: true
 


description
String description

 A description for the address range and the address pool.
 








Class com.amazonaws.services.ec2.model.ProvisionByoipCidrResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


byoipCidr
ByoipCidr byoipCidr

 Information about the address range.
 








Class com.amazonaws.services.ec2.model.ProvisionedBandwidth extends Object implements Serializable


Serialized Fields


provisionTime
Date provisionTime

 Reserved. If you need to sustain traffic greater than the documented limits, contact us
 through the Support Center.
 


provisioned
String provisioned

 Reserved. If you need to sustain traffic greater than the documented limits, contact us
 through the Support Center.
 


requestTime
Date requestTime

 Reserved. If you need to sustain traffic greater than the documented limits, contact us
 through the Support Center.
 


requested
String requested

 Reserved. If you need to sustain traffic greater than the documented limits, contact us
 through the Support Center.
 


status
String status

 Reserved. If you need to sustain traffic greater than the documented limits, contact us
 through the Support Center.
 








Class com.amazonaws.services.ec2.model.PublicIpv4Pool extends Object implements Serializable


Serialized Fields


poolId
String poolId

 The ID of the address pool.
 


description
String description

 A description of the address pool.
 


poolAddressRanges
SdkInternalList<T> poolAddressRanges

 The address ranges.
 


totalAddressCount
Integer totalAddressCount

 The total number of addresses.
 


totalAvailableAddressCount
Integer totalAvailableAddressCount

 The total number of available addresses.
 








Class com.amazonaws.services.ec2.model.PublicIpv4PoolRange extends Object implements Serializable


Serialized Fields


firstAddress
String firstAddress

 The first IP address in the range.
 


lastAddress
String lastAddress

 The last IP address in the range.
 


addressCount
Integer addressCount

 The number of addresses in the range.
 


availableAddressCount
Integer availableAddressCount

 The number of available addresses in the range.
 








Class com.amazonaws.services.ec2.model.Purchase extends Object implements Serializable


Serialized Fields


currencyCode
String currencyCode

 The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this
 time, the only supported currency is USD.
 


duration
Integer duration

 The duration of the reservation's term in seconds.
 


hostIdSet
SdkInternalList<T> hostIdSet

 The IDs of the Dedicated Hosts associated with the reservation.
 


hostReservationId
String hostReservationId

 The ID of the reservation.
 


hourlyPrice
String hourlyPrice

 The hourly price of the reservation per hour.
 


instanceFamily
String instanceFamily

 The instance family on the Dedicated Host that the reservation can be associated with.
 


paymentOption
String paymentOption

 The payment option for the reservation.
 


upfrontPrice
String upfrontPrice

 The upfront price of the reservation.
 








Class com.amazonaws.services.ec2.model.PurchaseHostReservationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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.
 


currencyCode
String currencyCode

 The currency in which the totalUpfrontPrice, LimitPrice, and
 totalHourlyPrice amounts are specified. At this time, the only supported currency is
 USD.
 


hostIdSet
SdkInternalList<T> hostIdSet

 The IDs of the Dedicated Hosts with which the reservation will be associated.
 


limitPrice
String limitPrice

 The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's
 upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit,
 the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the
 purchase. At this time, the only supported currency is USD. For example, to indicate a limit price
 of USD 100, specify 100.00.
 


offeringId
String offeringId

 The ID of the offering.
 








Class com.amazonaws.services.ec2.model.PurchaseHostReservationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


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.
 


currencyCode
String currencyCode

 The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified.
 At this time, the only supported currency is USD.
 


purchase
SdkInternalList<T> purchase

 Describes the details of the purchase.
 


totalHourlyPrice
String totalHourlyPrice

 The total hourly price of the reservation calculated per hour.
 


totalUpfrontPrice
String totalUpfrontPrice

 The total amount charged to your account when you purchase the reservation.
 








Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceCount
Integer instanceCount

 The number of Reserved Instances to purchase.
 


reservedInstancesOfferingId
String reservedInstancesOfferingId

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


purchaseTime
Date purchaseTime

 The time at which to purchase the Reserved Instance, in UTC format (for example,
 YYYY-MM-DDTHH:MM:SSZ).
 








Class com.amazonaws.services.ec2.model.PurchaseReservedInstancesOfferingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservedInstancesId
String reservedInstancesId

 The IDs of the purchased Reserved Instances.
 








Class com.amazonaws.services.ec2.model.PurchaseScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientToken
String clientToken

 Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring
 Idempotency.
 


purchaseRequests
SdkInternalList<T> purchaseRequests

 The purchase requests.
 








Class com.amazonaws.services.ec2.model.PurchaseScheduledInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


scheduledInstanceSet
SdkInternalList<T> scheduledInstanceSet

 Information about the Scheduled Instances.
 








Class com.amazonaws.services.ec2.model.RebootInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceIds
SdkInternalList<T> instanceIds

 The instance IDs.
 








Class com.amazonaws.services.ec2.model.RebootInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.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 extends Object implements Serializable


Serialized Fields


endpoint
String endpoint

 The Region service endpoint.
 


regionName
String regionName

 The name of the Region.
 


optInStatus
String optInStatus

 The Region opt-in status. The possible values are opt-in-not-required, opted-in, and
 not-opted-in.
 








Class com.amazonaws.services.ec2.model.RegisterImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageLocation
String imageLocation

 The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the
 aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For
 more information, see Canned ACLs in the
 Amazon S3 Service Developer Guide.
 


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
SdkInternalList<T> blockDeviceMappings

 The block device mapping entries.
 


description
String description

 A description for your AMI.
 


enaSupport
Boolean enaSupport

 Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch
 from the AMI.
 
 
 This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from
 the AMI unreachable.
 


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(_)
 


billingProducts
SdkInternalList<T> billingProducts

 The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can
 use the AWS Marketplace to bill for the use of an AMI.
 


ramdiskId
String ramdiskId

 The ID of the RAM disk.
 


rootDeviceName
String rootDeviceName

 The device name of the root device volume (for example, /dev/sda1).
 


sriovNetSupport
String sriovNetSupport

 Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the
 AMI and any instances that you launch from the AMI.
 
 
 There is no way to disable sriovNetSupport 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 (hvm | paravirtual).
 
 
 Default: paravirtual
 








Class com.amazonaws.services.ec2.model.RegisterImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


imageId
String imageId

 The ID of the newly registered AMI.
 








Class com.amazonaws.services.ec2.model.RegisterTransitGatewayMulticastGroupMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


groupIpAddress
String groupIpAddress

 The IP address assigned to the transit gateway multicast group.
 


networkInterfaceIds
SdkInternalList<T> networkInterfaceIds

 The group members' network interface IDs to register with the transit gateway multicast group.
 








Class com.amazonaws.services.ec2.model.RegisterTransitGatewayMulticastGroupMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registeredMulticastGroupMembers
TransitGatewayMulticastRegisteredGroupMembers registeredMulticastGroupMembers

 Information about the registered transit gateway multicast group members.
 








Class com.amazonaws.services.ec2.model.RegisterTransitGatewayMulticastGroupSourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


groupIpAddress
String groupIpAddress

 The IP address assigned to the transit gateway multicast group.
 


networkInterfaceIds
SdkInternalList<T> networkInterfaceIds

 The group sources' network interface IDs to register with the transit gateway multicast group.
 








Class com.amazonaws.services.ec2.model.RegisterTransitGatewayMulticastGroupSourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registeredMulticastGroupSources
TransitGatewayMulticastRegisteredGroupSources registeredMulticastGroupSources

 Information about the transit gateway multicast group sources.
 








Class com.amazonaws.services.ec2.model.RejectTransitGatewayPeeringAttachmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the transit gateway peering attachment.
 








Class com.amazonaws.services.ec2.model.RejectTransitGatewayPeeringAttachmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayPeeringAttachment
TransitGatewayPeeringAttachment transitGatewayPeeringAttachment

 The transit gateway peering attachment.
 








Class com.amazonaws.services.ec2.model.RejectTransitGatewayVpcAttachmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 








Class com.amazonaws.services.ec2.model.RejectTransitGatewayVpcAttachmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayVpcAttachment
TransitGatewayVpcAttachment transitGatewayVpcAttachment

 Information about the attachment.
 








Class com.amazonaws.services.ec2.model.RejectVpcEndpointConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceId
String serviceId

 The ID of the service.
 


vpcEndpointIds
SdkInternalList<T> vpcEndpointIds

 The IDs of one or more VPC endpoints.
 








Class com.amazonaws.services.ec2.model.RejectVpcEndpointConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unsuccessful
SdkInternalList<T> unsuccessful

 Information about the endpoints that were not rejected, if applicable.
 








Class com.amazonaws.services.ec2.model.RejectVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vpcPeeringConnectionId
String vpcPeeringConnectionId

 The ID of the VPC peering connection.
 








Class com.amazonaws.services.ec2.model.RejectVpcPeeringConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.ReleaseAddressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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.
 


networkBorderGroup
String networkBorderGroup

 The location that the IP address is released from.
 
 
 If you provide an incorrect network border group, you will receive an InvalidAddress.NotFound error.
 For more information, see Error Codes.
 
 
 
 You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will
 receive an InvalidParameterCombination error. For more information, see Error Codes.
 
 








Class com.amazonaws.services.ec2.model.ReleaseAddressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ReleaseHostsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hostIds
SdkInternalList<T> hostIds

 The IDs of the Dedicated Hosts to release.
 








Class com.amazonaws.services.ec2.model.ReleaseHostsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successful
SdkInternalList<T> successful

 The IDs of the Dedicated Hosts that were successfully released.
 


unsuccessful
SdkInternalList<T> unsuccessful

 The IDs of the Dedicated Hosts that could not be released, including an error message.
 








Class com.amazonaws.services.ec2.model.ReplaceIamInstanceProfileAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


iamInstanceProfile
IamInstanceProfileSpecification iamInstanceProfile

 The IAM instance profile.
 


associationId
String associationId

 The ID of the existing IAM instance profile association.
 








Class com.amazonaws.services.ec2.model.ReplaceIamInstanceProfileAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


iamInstanceProfileAssociation
IamInstanceProfileAssociation iamInstanceProfileAssociation

 Information about the IAM instance profile association.
 








Class com.amazonaws.services.ec2.model.ReplaceNetworkAclAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationId
String associationId

 The ID of the current association between the original network ACL and the subnet.
 


networkAclId
String networkAclId

 The ID of the new network ACL to associate with the subnet.
 








Class com.amazonaws.services.ec2.model.ReplaceNetworkAclAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


newAssociationId
String newAssociationId

 The ID of the new association.
 








Class com.amazonaws.services.ec2.model.ReplaceNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cidrBlock
String cidrBlock

 The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).
 


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 or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6)
 with an IPv6 CIDR block.
 


ipv6CidrBlock
String ipv6CidrBlock

 The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64).
 


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 protocol 6 (TCP) or 17
 (UDP).
 


protocol
String protocol

 The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6"
 (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes
 that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP
 types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an
 IPv6 CIDR block, you must specify an ICMP type and code.
 


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ReplaceRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationCidrBlock
String destinationCidrBlock

 The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an
 existing route in the table.
 


destinationIpv6CidrBlock
String destinationIpv6CidrBlock

 The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an
 existing route in the table.
 


egressOnlyInternetGatewayId
String egressOnlyInternetGatewayId

 [IPv6 traffic only] The ID of an egress-only internet gateway.
 


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.
 


localTarget
Boolean localTarget

 Specifies whether to reset the local route to its default target (local).
 


natGatewayId
String natGatewayId

 [IPv4 traffic only] The ID of a NAT gateway.
 


transitGatewayId
String transitGatewayId

 The ID of a transit gateway.
 


localGatewayId
String localGatewayId

 The ID of the local 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ReplaceRouteTableAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associationId
String associationId

 The association ID.
 


routeTableId
String routeTableId

 The ID of the new route table to associate with the subnet.
 








Class com.amazonaws.services.ec2.model.ReplaceRouteTableAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


newAssociationId
String newAssociationId

 The ID of the new association.
 


associationState
RouteTableAssociationState associationState

 The state of the association.
 








Class com.amazonaws.services.ec2.model.ReplaceTransitGatewayRouteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationCidrBlock
String destinationCidrBlock

 The CIDR range used for the destination match. Routing decisions are based on the most specific match.
 


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the route table.
 


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 


blackhole
Boolean blackhole

 Indicates whether traffic matching this route is to be dropped.
 








Class com.amazonaws.services.ec2.model.ReplaceTransitGatewayRouteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


route
TransitGatewayRoute route

 Information about the modified route.
 








Class com.amazonaws.services.ec2.model.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
SdkInternalList<T> instances

 The instances.
 


reasonCodes
SdkInternalList<T> reasonCodes

 The reason codes that describe 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 that I believe are network
 related.
 
 
 
 
 performance-instance-store: My instance is experiencing performance problems that I believe are
 related to the instance stores.
 
 
 
 
 performance-ebs-volume: My instance is experiencing performance problems that 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.RequestLaunchTemplateData extends Object implements Serializable


Serialized Fields


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 User Provided Kernels in
 the Amazon Elastic Compute Cloud User Guide.
 
 


ebsOptimized
Boolean ebsOptimized

 Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput
 to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This
 optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized
 instance.
 


iamInstanceProfile
LaunchTemplateIamInstanceProfileSpecificationRequest iamInstanceProfile

 The IAM instance profile.
 


blockDeviceMappings
SdkInternalList<T> blockDeviceMappings

 The block device mapping.
 


networkInterfaces
SdkInternalList<T> networkInterfaces

 One or more network interfaces. If you specify a network interface, you must specify any security groups and
 subnets as part of the network interface.
 


imageId
String imageId

 The ID of the AMI.
 


instanceType
String instanceType

 The instance type. For more information, see Instance Types 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.
 
 


monitoring
LaunchTemplatesMonitoringRequest monitoring

 The monitoring for the instance.
 


placement
LaunchTemplatePlacementRequest placement

 The placement for the instance.
 


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 User Provided Kernels in
 the Amazon Elastic Compute Cloud User Guide.
 
 


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. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to
 terminate, you can terminate the instance by running the shutdown command from 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).
 
 
 Default: stop
 


userData
String userData

 The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance
 at Launch (Linux) and Adding User Data (Windows).
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified
 tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been
 created, see CreateTags.
 


elasticGpuSpecifications
SdkInternalList<T> elasticGpuSpecifications

 An elastic GPU to associate with the instance.
 


elasticInferenceAccelerators
SdkInternalList<T> elasticInferenceAccelerators

 The elastic inference accelerator for the instance.
 


securityGroupIds
SdkInternalList<T> securityGroupIds

 One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.
 


securityGroups
SdkInternalList<T> securityGroups

 [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group
 IDs instead. You cannot specify both a security group ID and security name in the same request.
 


instanceMarketOptions
LaunchTemplateInstanceMarketOptionsRequest instanceMarketOptions

 The market (purchasing) option for the instances.
 


creditSpecification
CreditSpecificationRequest creditSpecification

 The credit option for CPU usage of the instance. Valid for T2 or T3 instances only.
 


cpuOptions
LaunchTemplateCpuOptionsRequest cpuOptions

 The CPU options for the instance. For more information, see Optimizing CPU Options
 in the Amazon Elastic Compute Cloud User Guide.
 


capacityReservationSpecification
LaunchTemplateCapacityReservationSpecificationRequest capacityReservationSpecification

 The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity
 Reservation preference defaults to open, which enables it to run in any open Capacity Reservation
 that has matching attributes (instance type, platform, Availability Zone).
 


licenseSpecifications
SdkInternalList<T> licenseSpecifications

 The license configurations.
 


hibernationOptions
LaunchTemplateHibernationOptionsRequest hibernationOptions

 Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the
 hibernation
 prerequisites. For more information, see Hibernate Your Instance in the
 Amazon Elastic Compute Cloud User Guide.
 


metadataOptions
LaunchTemplateInstanceMetadataOptionsRequest metadataOptions

 The metadata options for the instance. For more information, see Instance Metadata and User
 Data in the Amazon Elastic Compute Cloud User Guide.
 








Class com.amazonaws.services.ec2.model.RequestSpotFleetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


spotFleetRequestConfig
SpotFleetRequestConfigData spotFleetRequestConfig

 The configuration for the Spot Fleet request.
 








Class com.amazonaws.services.ec2.model.RequestSpotFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


spotFleetRequestId
String spotFleetRequestId

 The ID of the Spot Fleet request.
 








Class com.amazonaws.services.ec2.model.RequestSpotInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZoneGroup
String availabilityZoneGroup

 The user-specified name for a logical grouping of requests.
 
 
 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 requests 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 request is expired, or the maximum price you specified falls below
 current Spot price), 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.
 
 
 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 EC2 User Guide for Linux Instances.
 


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

 The launch specification.
 


spotPrice
String spotPrice

 The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
 


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.
 
 
 The specified start date and time cannot be equal to the current date and time. You must specify a start date and
 time that occurs after the current date and time.
 


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 is reached. The default end date is 7 days from the current date.
 


instanceInterruptionBehavior
String instanceInterruptionBehavior

 The behavior when a Spot Instance is interrupted. The default is terminate.
 








Class com.amazonaws.services.ec2.model.RequestSpotInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


spotInstanceRequests
SdkInternalList<T> spotInstanceRequests

 One or more Spot Instance requests.
 








Class com.amazonaws.services.ec2.model.Reservation extends Object implements Serializable


Serialized Fields


groups
SdkInternalList<T> groups

 [EC2-Classic only] The security groups.
 


instances
SdkInternalList<T> instances

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


groupNames
SdkInternalList<T> groupNames

 One or more security group names.
 








Class com.amazonaws.services.ec2.model.ReservationValue extends Object implements Serializable


Serialized Fields


hourlyPrice
String hourlyPrice

 The hourly rate of the reservation.
 


remainingTotalValue
String remainingTotalValue

 The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
 


remainingUpfrontValue
String remainingUpfrontValue

 The remaining upfront cost of the reservation.
 








Class com.amazonaws.services.ec2.model.ReservedInstanceLimitPrice extends Object implements Serializable


Serialized Fields


amount
Double amount

 Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount *
 price).
 


currencyCode
String currencyCode

 The currency in which the limitPrice amount is specified. At this time, the only supported currency
 is USD.
 








Class com.amazonaws.services.ec2.model.ReservedInstanceReservationValue extends Object implements Serializable


Serialized Fields


reservationValue
ReservationValue reservationValue

 The total value of the Convertible Reserved Instance that you are exchanging.
 


reservedInstanceId
String reservedInstanceId

 The ID of the Convertible Reserved Instance that you are exchanging.
 








Class com.amazonaws.services.ec2.model.ReservedInstances extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone in which the Reserved Instance can be used.
 


duration
Long duration

 The duration of the Reserved Instance, in seconds.
 


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.
 


instanceType
String instanceType

 The instance type on which the Reserved Instance can be used.
 


productDescription
String productDescription

 The Reserved Instance product platform description.
 


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.
 


usagePrice
Float usagePrice

 The usage price of the Reserved Instance, per hour.
 


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.
 


instanceTenancy
String instanceTenancy

 The tenancy of the instance.
 


offeringClass
String offeringClass

 The offering class of the Reserved Instance.
 


offeringType
String offeringType

 The Reserved Instance offering type.
 


recurringCharges
SdkInternalList<T> recurringCharges

 The recurring charge tag assigned to the resource.
 


scope
String scope

 The scope of the Reserved Instance.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the resource.
 








Class com.amazonaws.services.ec2.model.ReservedInstancesConfiguration extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone for the modified Reserved Instances.
 


instanceCount
Integer instanceCount

 The number of modified Reserved Instances.
 
 
 
 This is a required field for a request.
 
 


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.
 


scope
String scope

 Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
 








Class com.amazonaws.services.ec2.model.ReservedInstancesId extends Object implements Serializable


Serialized Fields


reservedInstancesId
String reservedInstancesId

 The ID of the Reserved Instance.
 








Class com.amazonaws.services.ec2.model.ReservedInstancesListing extends Object implements Serializable


Serialized Fields


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
SdkInternalList<T> instanceCounts

 The number of instances in this state.
 


priceSchedules
SdkInternalList<T> 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
SdkInternalList<T> tags

 Any tags assigned to the resource.
 


updateDate
Date updateDate

 The last modified timestamp of the listing.
 








Class com.amazonaws.services.ec2.model.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
SdkInternalList<T> modificationResults

 Contains target configurations along with their corresponding new Reserved Instance IDs.
 


reservedInstancesIds
SdkInternalList<T> 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 extends Object implements Serializable


Serialized Fields


reservedInstancesId
String reservedInstancesId

 The ID for the Reserved Instances that were created as part of the modification request. This field is only
 available when the modification is fulfilled.
 


targetConfiguration
ReservedInstancesConfiguration targetConfiguration

 The target Reserved Instances configurations supplied as part of the modification request.
 








Class com.amazonaws.services.ec2.model.ReservedInstancesOffering extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone in which the Reserved Instance can be used.
 


duration
Long duration

 The duration of the Reserved Instance, in seconds.
 


fixedPrice
Float fixedPrice

 The purchase price of the Reserved Instance.
 


instanceType
String instanceType

 The instance type on which the Reserved Instance can be used.
 


productDescription
String productDescription

 The Reserved Instance product platform description.
 


reservedInstancesOfferingId
String reservedInstancesOfferingId

 The ID of the Reserved Instance offering. This is the offering ID used in
 GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
 


usagePrice
Float usagePrice

 The usage price of the Reserved Instance, per hour.
 


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.
 


instanceTenancy
String instanceTenancy

 The tenancy of the instance.
 


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.
 


offeringClass
String offeringClass

 If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with
 different configurations. If standard, it is not possible to perform an exchange.
 


offeringType
String offeringType

 The Reserved Instance offering type.
 


pricingDetails
SdkInternalList<T> pricingDetails

 The pricing details of the Reserved Instance offering.
 


recurringCharges
SdkInternalList<T> recurringCharges

 The recurring charge tag assigned to the resource.
 


scope
String scope

 Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
 








Class com.amazonaws.services.ec2.model.ResetEbsDefaultKmsKeyIdRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.ec2.model.ResetEbsDefaultKmsKeyIdResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


kmsKeyId
String kmsKeyId

 The Amazon Resource Name (ARN) of the default CMK for EBS encryption by default.
 








Class com.amazonaws.services.ec2.model.ResetFpgaImageAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fpgaImageId
String fpgaImageId

 The ID of the AFI.
 


attribute
String attribute

 The attribute.
 








Class com.amazonaws.services.ec2.model.ResetFpgaImageAttributeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Is true if the request succeeds, and an error otherwise.
 








Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ResetNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


sourceDestCheck
String sourceDestCheck

 The source/destination checking attribute. Resets the value to true.
 








Class com.amazonaws.services.ec2.model.ResetNetworkInterfaceAttributeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ResponseError extends Object implements Serializable


Serialized Fields


code
String code

 The error code.
 


message
String message

 The error message, if applicable.
 








Class com.amazonaws.services.ec2.model.ResponseLaunchTemplateData extends Object implements Serializable


Serialized Fields


kernelId
String kernelId

 The ID of the kernel, if applicable.
 


ebsOptimized
Boolean ebsOptimized

 Indicates whether the instance is optimized for Amazon EBS I/O.
 


iamInstanceProfile
LaunchTemplateIamInstanceProfileSpecification iamInstanceProfile

 The IAM instance profile.
 


blockDeviceMappings
SdkInternalList<T> blockDeviceMappings

 The block device mappings.
 


networkInterfaces
SdkInternalList<T> networkInterfaces

 The network interfaces.
 


imageId
String imageId

 The ID of the AMI that was used to launch the instance.
 


instanceType
String instanceType

 The instance type.
 


keyName
String keyName

 The name of the key pair.
 


monitoring
LaunchTemplatesMonitoring monitoring

 The monitoring for the instance.
 


placement
LaunchTemplatePlacement placement

 The placement of the instance.
 


ramDiskId
String ramDiskId

 The ID of the RAM disk, if applicable.
 


disableApiTermination
Boolean disableApiTermination

 If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console,
 command line tool, or API.
 


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


userData
String userData

 The user data for the instance.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags.
 


elasticGpuSpecifications
SdkInternalList<T> elasticGpuSpecifications

 The elastic GPU specification.
 


elasticInferenceAccelerators
SdkInternalList<T> elasticInferenceAccelerators

 The elastic inference accelerator for the instance.
 


securityGroupIds
SdkInternalList<T> securityGroupIds

 The security group IDs.
 


securityGroups
SdkInternalList<T> securityGroups

 The security group names.
 


instanceMarketOptions
LaunchTemplateInstanceMarketOptions instanceMarketOptions

 The market (purchasing) option for the instances.
 


creditSpecification
CreditSpecification creditSpecification

 The credit option for CPU usage of the instance.
 


cpuOptions
LaunchTemplateCpuOptions cpuOptions

 The CPU options for the instance. For more information, see Optimizing CPU Options
 in the Amazon Elastic Compute Cloud User Guide.
 


capacityReservationSpecification
LaunchTemplateCapacityReservationSpecificationResponse capacityReservationSpecification

 Information about the Capacity Reservation targeting option.
 


licenseSpecifications
SdkInternalList<T> licenseSpecifications

 The license configurations.
 


hibernationOptions
LaunchTemplateHibernationOptions hibernationOptions

 Indicates whether an instance is configured for hibernation. For more information, see Hibernate Your Instance in the
 Amazon Elastic Compute Cloud User Guide.
 


metadataOptions
LaunchTemplateInstanceMetadataOptions metadataOptions

 The metadata options for the instance. For more information, see Instance Metadata and User
 Data in the Amazon Elastic Compute Cloud User Guide.
 








Class com.amazonaws.services.ec2.model.RestoreAddressToClassicRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


publicIp
String publicIp

 The Elastic IP address.
 








Class com.amazonaws.services.ec2.model.RestoreAddressToClassicResult extends AmazonWebServiceResult<ResponseMetadata> 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.RevokeClientVpnIngressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint with which the authorization rule is associated.
 


targetNetworkCidr
String targetNetworkCidr

 The IPv4 address range, in CIDR notation, of the network for which access is being removed.
 


accessGroupId
String accessGroupId

 The ID of the Active Directory group for which to revoke access.
 


revokeAllGroups
Boolean revokeAllGroups

 Indicates whether access should be revoked for all clients.
 








Class com.amazonaws.services.ec2.model.RevokeClientVpnIngressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
ClientVpnAuthorizationRuleStatus status

 The current state of the authorization rule.
 








Class com.amazonaws.services.ec2.model.RevokeSecurityGroupEgressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId

 The ID of the security group.
 


ipPermissions
SdkInternalList<T> ipPermissions

 The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the
 same set of permissions.
 


cidrIp
String cidrIp

 Not supported. Use a set of IP permissions to specify the CIDR.
 


fromPort
Integer fromPort

 Not supported. Use a set of IP permissions to specify the port.
 


ipProtocol
String ipProtocol

 Not supported. Use a set of IP permissions to specify the protocol name or number.
 


toPort
Integer toPort

 Not supported. Use a set of IP permissions to specify the port.
 


sourceSecurityGroupName
String sourceSecurityGroupName

 Not supported. Use a set of IP permissions to specify a destination security group.
 


sourceSecurityGroupOwnerId
String sourceSecurityGroupOwnerId

 Not supported. Use a set of IP permissions to specify a destination security group.
 








Class com.amazonaws.services.ec2.model.RevokeSecurityGroupEgressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.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. You must specify either the security group ID or the security group name in the
 request. For security groups in a nondefault VPC, you must specify the security group ID.
 


groupName
String groupName

 [EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the
 security group name in the request.
 


ipPermissions
SdkInternalList<T> ipPermissions

 The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set
 of permissions.
 


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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.Route extends Object implements Serializable


Serialized Fields


destinationCidrBlock
String destinationCidrBlock

 The IPv4 CIDR block used for the destination match.
 


destinationIpv6CidrBlock
String destinationIpv6CidrBlock

 The IPv6 CIDR block used for the destination match.
 


destinationPrefixListId
String destinationPrefixListId

 The prefix of the AWS service.
 


egressOnlyInternetGatewayId
String egressOnlyInternetGatewayId

 The ID of the egress-only internet gateway.
 


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.
 


transitGatewayId
String transitGatewayId

 The ID of a transit gateway.
 


localGatewayId
String localGatewayId

 The ID of the local 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 a VPC peering connection.
 








Class com.amazonaws.services.ec2.model.RouteTable extends Object implements Serializable


Serialized Fields


associations
SdkInternalList<T> associations

 The associations between the route table and one or more subnets or a gateway.
 


propagatingVgws
SdkInternalList<T> propagatingVgws

 Any virtual private gateway (VGW) propagating routes.
 


routeTableId
String routeTableId

 The ID of the route table.
 


routes
SdkInternalList<T> routes

 The routes in the route table.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the route table.
 


vpcId
String vpcId

 The ID of the VPC.
 


ownerId
String ownerId

 The ID of the AWS account that owns the route table.
 








Class com.amazonaws.services.ec2.model.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.
 


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.
 


gatewayId
String gatewayId

 The ID of the internet gateway or virtual private gateway.
 


associationState
RouteTableAssociationState associationState

 The state of the association.
 








Class com.amazonaws.services.ec2.model.RouteTableAssociationState extends Object implements Serializable


Serialized Fields


state
String state

 The state of the association.
 


statusMessage
String statusMessage

 The status message, if applicable.
 








Class com.amazonaws.services.ec2.model.RunInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


blockDeviceMappings
SdkInternalList<T> blockDeviceMappings

 The block device mapping entries.
 


imageId
String imageId

 The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch
 template.
 


instanceType
String instanceType

 The instance type. For more information, see Instance Types in the
 Amazon Elastic Compute Cloud User Guide.
 
 
 Default: m1.small
 


ipv6AddressCount
Integer ipv6AddressCount

 [EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the
 IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific
 IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances
 to launch.
 
 
 You cannot specify this option and the network interfaces option in the same request.
 


ipv6Addresses
SdkInternalList<T> ipv6Addresses

 [EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You
 cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot
 specify this option if you've specified a minimum number of instances to launch.
 
 
 You cannot specify this option and the network interfaces option in the same request.
 


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

 Specifies whether detailed monitoring is enabled for the instance.
 


placement
Placement placement

 The placement for the instance.
 


ramdiskId
String ramdiskId

 The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel
 requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the
 AWS Resource Center and search for the kernel ID.
 
 
 
 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
SdkInternalList<T> securityGroupIds

 The IDs of the security groups. You can create a security group using CreateSecurityGroup.
 
 
 If you specify a network interface, you must specify any security groups as part of the network interface.
 


securityGroups
SdkInternalList<T> securityGroups

 [EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group
 IDs instead.
 
 
 If you specify a network interface, you must specify any security groups as part of the network interface.
 
 
 Default: Amazon EC2 uses the default security group.
 


subnetId
String subnetId

 [EC2-VPC] The ID of the subnet to launch the instance into.
 
 
 If you specify a network interface, you must specify any subnets as part of the network interface.
 


userData
String userData

 The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance
 at Launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and
 you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16
 KB.
 


additionalInfo
String additionalInfo

 Reserved.
 


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. To change this attribute after launch, use 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 Amazon EBS I/O. This optimization provides dedicated throughput
 to Amazon EBS and an optimized configuration stack to provide optimal Amazon 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.
 


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
 


networkInterfaces
SdkInternalList<T> networkInterfaces

 The network interfaces to associate with the instance. If you specify a network interface, you must specify any
 security groups and subnets as part of the network interface.
 


privateIpAddress
String privateIpAddress

 [EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
 
 
 Only one private IP address can be designated as primary. You can't specify this option if you've specified the
 option to designate a private IP address as the primary IP address in a network interface specification. You
 cannot specify this option if you're launching more than one instance in the request.
 
 
 You cannot specify this option and the network interfaces option in the same request.
 


elasticGpuSpecification
SdkInternalList<T> elasticGpuSpecification

 An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your
 Windows instance to accelerate the graphics performance of your applications. For more information, see  Amazon EC2 Elastic GPUs
 in the Amazon Elastic Compute Cloud User Guide.
 


elasticInferenceAccelerators
SdkInternalList<T> elasticInferenceAccelerators

 An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource
 you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified
 tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been
 created, see CreateTags.
 


launchTemplate
LaunchTemplateSpecification launchTemplate

 The launch template to use to launch the instances. Any parameters that you specify in RunInstances
 override the same parameters in the launch template. You can specify either the name or ID of a launch template,
 but not both.
 


instanceMarketOptions
InstanceMarketOptionsRequest instanceMarketOptions

 The market (purchasing) option for the instances.
 
 
 For RunInstances, persistent Spot Instance requests are only supported when
 InstanceInterruptionBehavior is set to either hibernate or stop.
 


creditSpecification
CreditSpecificationRequest creditSpecification

 The credit option for CPU usage of the burstable performance instance. Valid values are standard and
 unlimited. To change this attribute after launch, use 
 ModifyInstanceCreditSpecification. For more information, see Burstable
 Performance Instances in the Amazon Elastic Compute Cloud User Guide.
 
 
 Default: standard (T2 instances) or unlimited (T3/T3a instances)
 


cpuOptions
CpuOptionsRequest cpuOptions

 The CPU options for the instance. For more information, see Optimizing CPU Options
 in the Amazon Elastic Compute Cloud User Guide.
 


capacityReservationSpecification
CapacityReservationSpecification capacityReservationSpecification

 Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's
 Capacity Reservation preference defaults to open, which enables it to run in any open Capacity
 Reservation that has matching attributes (instance type, platform, Availability Zone).
 


hibernationOptions
HibernationOptionsRequest hibernationOptions

 Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance in the
 Amazon Elastic Compute Cloud User Guide.
 


licenseSpecifications
SdkInternalList<T> licenseSpecifications

 The license configurations.
 


metadataOptions
InstanceMetadataOptionsRequest metadataOptions

 The metadata options for the instance. For more information, see Instance Metadata and User
 Data.
 








Class com.amazonaws.services.ec2.model.RunInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservation
Reservation reservation

 Describes a reservation.
 








Class com.amazonaws.services.ec2.model.RunScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientToken
String clientToken

 Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring
 Idempotency.
 


instanceCount
Integer instanceCount

 The number of instances.
 
 
 Default: 1
 


launchSpecification
ScheduledInstancesLaunchSpecification launchSpecification

 The launch specification. You must match the instance type, Availability Zone, network, and platform of the
 schedule that you purchased.
 


scheduledInstanceId
String scheduledInstanceId

 The Scheduled Instance ID.
 








Class com.amazonaws.services.ec2.model.RunScheduledInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceIdSet
SdkInternalList<T> instanceIdSet

 The IDs of the newly launched instances.
 








Class com.amazonaws.services.ec2.model.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

 An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
 


uploadPolicySignature
String uploadPolicySignature

 The signature of the JSON document.
 








Class com.amazonaws.services.ec2.model.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 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 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
SdkInternalList<T> occurrenceDaySet

 The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is
 one or more days of the week (1-7, where 1 is Sunday).
 


occurrenceRelativeToEnd
Boolean occurrenceRelativeToEnd

 Indicates whether the occurrence is relative to the end of the specified week or month.
 


occurrenceUnit
String occurrenceUnit

 The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).
 








Class com.amazonaws.services.ec2.model.ScheduledInstanceRecurrenceRequest extends Object implements Serializable


Serialized Fields


frequency
String frequency

 The frequency (Daily, Weekly, or Monthly).
 


interval
Integer interval

 The interval quantity. The interval unit depends on the value of Frequency. For example, every 2
 weeks or every 2 months.
 


occurrenceDays
SdkInternalList<T> occurrenceDays

 The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is
 one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the
 occurrence is relative to the end of the month, you can specify only a single day.
 


occurrenceRelativeToEnd
Boolean occurrenceRelativeToEnd

 Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this
 value with a daily schedule.
 


occurrenceUnit
String occurrenceUnit

 The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is
 required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't
 specify this value with a daily schedule.
 








Class com.amazonaws.services.ec2.model.ScheduledInstancesBlockDeviceMapping extends Object implements Serializable


Serialized Fields


deviceName
String deviceName

 The device name (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 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: gp2
 








Class com.amazonaws.services.ec2.model.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.ScheduledInstancesIpv6Address extends Object implements Serializable


Serialized Fields


ipv6Address
String ipv6Address

 The IPv6 address.
 








Class com.amazonaws.services.ec2.model.ScheduledInstancesLaunchSpecification extends Object implements Serializable


Serialized Fields


blockDeviceMappings
SdkInternalList<T> blockDeviceMappings

 The 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
SdkInternalList<T> networkInterfaces

 The network interfaces.
 


placement
ScheduledInstancesPlacement placement

 The placement information.
 


ramdiskId
String ramdiskId

 The ID of the RAM disk.
 


securityGroupIds
SdkInternalList<T> securityGroupIds

 The IDs of the 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 extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Indicates whether monitoring is enabled.
 








Class com.amazonaws.services.ec2.model.ScheduledInstancesNetworkInterface extends Object implements Serializable


Serialized Fields


associatePublicIpAddress
Boolean associatePublicIpAddress

 Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 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
SdkInternalList<T> groups

 The IDs of the security groups.
 


ipv6AddressCount
Integer ipv6AddressCount

 The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected
 from the subnet range.
 


ipv6Addresses
SdkInternalList<T> ipv6Addresses

 The specific IPv6 addresses from the subnet range.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


privateIpAddress
String privateIpAddress

 The IPv4 address of the network interface within the subnet.
 


privateIpAddressConfigs
SdkInternalList<T> privateIpAddressConfigs

 The private IPv4 addresses.
 


secondaryPrivateIpAddressCount
Integer secondaryPrivateIpAddressCount

 The number of secondary private IPv4 addresses.
 


subnetId
String subnetId

 The ID of the subnet.
 








Class com.amazonaws.services.ec2.model.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 extends Object implements Serializable


Serialized Fields


primary
Boolean primary

 Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary IPv4 address.
 


privateIpAddress
String privateIpAddress

 The IPv4 address.
 








Class com.amazonaws.services.ec2.model.SearchLocalGatewayRoutesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


localGatewayRouteTableId
String localGatewayRouteTableId

 The ID of the local gateway route table.
 


filters
SdkInternalList<T> filters

 One or more filters.
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.SearchLocalGatewayRoutesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


routes
SdkInternalList<T> routes

 Information about the routes.
 


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.SearchTransitGatewayMulticastGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 group-ip-address - The IP address of the transit gateway multicast group.
 
 
 
 
 is-group-member - The resource is a group member. Valid values are true |
 false.
 
 
 
 
 is-group-source - The resource is a group source. Valid values are true |
 false.
 
 
 
 
 member-type - The member type. Valid values are igmp | static.
 
 
 
 
 resource-id - The ID of the resource.
 
 
 
 
 resource-type - The type of resource. Valid values are vpc | vpn |
 direct-connect-gateway | tgw-peering.
 
 
 
 
 source-type - The source type. Valid values are igmp | static.
 
 
 
 
 state - The state of the subnet association. Valid values are associated |
 associated | disassociated | disassociating.
 
 
 
 
 subnet-id - The ID of the subnet.
 
 
 
 
 transit-gateway-attachment-id - The id of the transit gateway attachment.
 
 
 


maxResults
Integer maxResults

 The maximum number of results to return with a single call. To retrieve the remaining results, make another call
 with the returned nextToken value.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.ec2.model.SearchTransitGatewayMulticastGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


multicastGroups
SdkInternalList<T> multicastGroups

 Information about the transit gateway multicast group.
 


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.SearchTransitGatewayRoutesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the transit gateway route table.
 


filters
SdkInternalList<T> filters

 One or more filters. The possible values are:
 
 
 
 
 attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
 
 
 
 
 attachment.resource-id - The resource id of the transit gateway attachment.
 
 
 
 
 attachment.resource-type - The attachment resource type (vpc | vpn).
 
 
 
 
 route-search.exact-match - The exact match of the specified filter.
 
 
 
 
 route-search.longest-prefix-match - The longest prefix that matches the route.
 
 
 
 
 route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
 
 
 
 
 route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example,
 if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as
 10.0.1.0/30, then the result returns 10.0.1.0/29.
 
 
 
 
 state - The state of the route (active | blackhole).
 
 
 
 
 type - The type of route (propagated | static).
 
 
 


maxResults
Integer maxResults

 The maximum number of routes to return.
 








Class com.amazonaws.services.ec2.model.SearchTransitGatewayRoutesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


routes
SdkInternalList<T> routes

 Information about the routes.
 


additionalRoutesAvailable
Boolean additionalRoutesAvailable

 Indicates whether there are additional routes available.
 








Class com.amazonaws.services.ec2.model.SecurityGroup extends Object implements Serializable


Serialized Fields


description
String description

 A description of the security group.
 


groupName
String groupName

 The name of the security group.
 


ipPermissions
SdkInternalList<T> ipPermissions

 The inbound rules associated with the security group.
 


ownerId
String ownerId

 The AWS account ID of the owner of the security group.
 


groupId
String groupId

 The ID of the security group.
 


ipPermissionsEgress
SdkInternalList<T> ipPermissionsEgress

 [VPC only] The outbound rules associated with the security group.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the security group.
 


vpcId
String vpcId

 [VPC only] The ID of the VPC for the security group.
 








Class com.amazonaws.services.ec2.model.SecurityGroupIdentifier 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.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.SendDiagnosticInterruptRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 








Class com.amazonaws.services.ec2.model.SendDiagnosticInterruptResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.ServiceConfiguration extends Object implements Serializable


Serialized Fields


serviceType
SdkInternalList<T> serviceType

 The type of service.
 


serviceId
String serviceId

 The ID of the service.
 


serviceName
String serviceName

 The name of the service.
 


serviceState
String serviceState

 The service state.
 


availabilityZones
SdkInternalList<T> availabilityZones

 The Availability Zones in which the service is available.
 


acceptanceRequired
Boolean acceptanceRequired

 Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.
 


managesVpcEndpoints
Boolean managesVpcEndpoints

 Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC
 endpoint API is restricted.
 


networkLoadBalancerArns
SdkInternalList<T> networkLoadBalancerArns

 The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
 


baseEndpointDnsNames
SdkInternalList<T> baseEndpointDnsNames

 The DNS names for the service.
 


privateDnsName
String privateDnsName

 The private DNS name for the service.
 


privateDnsNameConfiguration
PrivateDnsNameConfiguration privateDnsNameConfiguration

 Information about the endpoint service private DNS name configuration.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the service.
 








Class com.amazonaws.services.ec2.model.ServiceDetail extends Object implements Serializable


Serialized Fields


serviceName
String serviceName

 The Amazon Resource Name (ARN) of the service.
 


serviceId
String serviceId

 The ID of the endpoint service.
 


serviceType
SdkInternalList<T> serviceType

 The type of service.
 


availabilityZones
SdkInternalList<T> availabilityZones

 The Availability Zones in which the service is available.
 


owner
String owner

 The AWS account ID of the service owner.
 


baseEndpointDnsNames
SdkInternalList<T> baseEndpointDnsNames

 The DNS names for the service.
 


privateDnsName
String privateDnsName

 The private DNS name for the service.
 


vpcEndpointPolicySupported
Boolean vpcEndpointPolicySupported

 Indicates whether the service supports endpoint policies.
 


acceptanceRequired
Boolean acceptanceRequired

 Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
 


managesVpcEndpoints
Boolean managesVpcEndpoints

 Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC
 endpoint API is restricted.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the service.
 


privateDnsNameVerificationState
String privateDnsNameVerificationState

 The verification state of the VPC endpoint service.
 
 
 Consumers of the endpoint service cannot use the private name when the state is not verified.
 








Class com.amazonaws.services.ec2.model.ServiceTypeDetail extends Object implements Serializable


Serialized Fields


serviceType
String serviceType

 The type of service.
 








Class com.amazonaws.services.ec2.model.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 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 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
 DescribeSnapshots.
 


description
String description

 The description for the snapshot.
 


encrypted
Boolean encrypted

 Indicates whether the snapshot is encrypted.
 


kmsKeyId
String kmsKeyId

 The Amazon Resource Name (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.
 


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


volumeId
String volumeId

 The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action
 have an arbitrary volume ID that should not be used for any purpose.
 


volumeSize
Integer volumeSize

 The size of the volume, in GiB.
 


ownerAlias
String ownerAlias

 Value from an Amazon-maintained list (amazon | self | all |
 aws-marketplace | microsoft) of snapshot owners. Not to be confused with the
 user-configured AWS account alias, which is set from the IAM console.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the snapshot.
 








Class com.amazonaws.services.ec2.model.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 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: VHD | VMDK
 


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.SnapshotInfo extends Object implements Serializable


Serialized Fields


description
String description

 Description specified by the CreateSnapshotRequest that has been applied to all snapshots.
 


tags
SdkInternalList<T> tags

 Tags associated with this snapshot.
 


encrypted
Boolean encrypted

 Indicates whether the snapshot is encrypted.
 


volumeId
String volumeId

 Source volume from which this snapshot was created.
 


state
String state

 Current state of the snapshot.
 


volumeSize
Integer volumeSize

 Size of the volume from which this snapshot was created.
 


startTime
Date startTime

 Time this snapshot was started. This is the same for all snapshots initiated by the same request.
 


progress
String progress

 Progress this snapshot has made towards completing.
 


ownerId
String ownerId

 Account id used when creating this snapshot.
 


snapshotId
String snapshotId

 Snapshot id that can be used to describe this snapshot.
 








Class com.amazonaws.services.ec2.model.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.
 


encrypted
Boolean encrypted

 Indicates whether the snapshot is encrypted.
 


format
String format

 The format of the disk image from which the snapshot is created.
 


kmsKeyId
String kmsKeyId

 The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the
 encrypted snapshot.
 


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 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 extends Object implements Serializable


Serialized Fields


securityGroups
SdkInternalList<T> 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.
 


addressingType
String addressingType

 Deprecated.
 


blockDeviceMappings
SdkInternalList<T> blockDeviceMappings

 One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an
 encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for
 a volume, it is not blank and its encryption status is used for the volume encryption status.
 


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
SdkInternalList<T> networkInterfaces

 One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security
 group IDs using the network interface.
 


placement
SpotPlacement placement

 The placement information.
 


ramdiskId
String ramdiskId

 The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for
 information about whether you need to specify a RAM disk. To find kernel requirements, refer to the AWS Resource
 Center and search for the kernel ID.
 


spotPrice
String spotPrice

 The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified,
 the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot
 price by the value of WeightedCapacity.
 


subnetId
String subnetId

 The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas;
 for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".
 


userData
String userData

 The Base64-encoded user data that instances use when starting up.
 


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 of 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, Amazon EC2 rounds the number of instances to
 the next whole number. If this value is not specified, the default is 1.
 


tagSpecifications
SdkInternalList<T> tagSpecifications

 The tags to apply during creation.
 








Class com.amazonaws.services.ec2.model.SpotFleetMonitoring extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Enables monitoring for the instance.
 
 
 Default: false
 








Class com.amazonaws.services.ec2.model.SpotFleetRequestConfig extends Object implements Serializable


Serialized Fields


activityStatus
String activityStatus

 The progress of the Spot Fleet request. If there is an error, the status is error. After all
 requests are placed, the status is pending_fulfillment. If the size of the fleet is equal to or
 greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased,
 the status is pending_termination while Spot Instances are terminating.
 


createTime
Date createTime

 The creation date and time of the request.
 


spotFleetRequestConfig
SpotFleetRequestConfigData spotFleetRequestConfig

 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 extends Object implements Serializable


Serialized Fields


allocationStrategy
String allocationStrategy

 Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot
 Fleet request.
 
 
 If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance
 pools with the lowest price. This is the default allocation strategy.
 
 
 If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance
 pools that you specify.
 
 
 If the allocation strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance
 pools with optimal capacity for the number of instances that are launching.
 


onDemandAllocationStrategy
String onDemandAllocationStrategy

 The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify
 lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you
 specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template
 override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to
 lowestPrice.
 


clientToken
String clientToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to
 avoid duplicate listings. For more information, see Ensuring
 Idempotency.
 


excessCapacityTerminationPolicy
String excessCapacityTerminationPolicy

 Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot
 Fleet request below the current size of the Spot Fleet.
 


fulfilledCapacity
Double fulfilledCapacity

 The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
 


onDemandFulfilledCapacity
Double onDemandFulfilledCapacity

 The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
 


iamFleetRole
String iamFleetRole

 The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the
 permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot
 Fleet Prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can 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
SdkInternalList<T> launchSpecifications

 The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't
 specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use
 LaunchTemplateConfigs.
 


launchTemplateConfigs
SdkInternalList<T> launchTemplateConfigs

 The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify
 LaunchSpecifications. If you include On-Demand capacity in your request, you must use
 LaunchTemplateConfigs.
 


spotPrice
String spotPrice

 The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand
 price.
 


targetCapacity
Integer targetCapacity

 The number of units to request for the Spot Fleet. 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. If the request type is maintain, you can specify a target capacity of 0 and add capacity
 later.
 


onDemandTargetCapacity
Integer onDemandTargetCapacity

 The number of On-Demand 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. If the
 request type is maintain, you can specify a target capacity of 0 and add capacity later.
 


onDemandMaxTotalPrice
String onDemandMaxTotalPrice

 The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the
 onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to
 ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand
 Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum
 amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching
 instances even if it hasn’t met the target capacity.
 


spotMaxTotalPrice
String spotMaxTotalPrice

 The maximum amount per hour for Spot Instances that you're willing to pay. You can use the
 spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters
 to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand
 Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum
 amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching
 instances even if it hasn’t met the target capacity.
 


terminateInstancesWithExpiration
Boolean terminateInstancesWithExpiration

 Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
 


type
String type

 The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to
 maintain it. When this value is request, the Spot Fleet only places the required requests. It does
 not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative
 Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the
 target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any
 interrupted instances. Default: maintain. instant is listed but is not used by Spot
 Fleet.
 


validFrom
Date validFrom

 The start date and time of the request, in UTC format
 (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the
 request immediately.
 


validUntil
Date validUntil

 The end date and time of the request, in UTC format
 (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot
 Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request
 remains until you cancel it.
 


replaceUnhealthyInstances
Boolean replaceUnhealthyInstances

 Indicates whether Spot Fleet should replace unhealthy instances.
 


instanceInterruptionBehavior
String instanceInterruptionBehavior

 The behavior when a Spot Instance is interrupted. The default is terminate.
 


loadBalancersConfig
LoadBalancersConfig loadBalancersConfig

 One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers
 the running Spot Instances with the specified Classic Load Balancers and target groups.
 
 
 With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1,
 CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
 


instancePoolsToUseCount
Integer instancePoolsToUseCount

 The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot
 AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and
 evenly allocates your target Spot capacity across the number of Spot pools that you specify.
 








Class com.amazonaws.services.ec2.model.SpotFleetTagSpecification extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of resource. Currently, the only resource type that is supported is instance.
 


tags
SdkInternalList<T> tags

 The tags.
 








Class com.amazonaws.services.ec2.model.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.
 


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.
 


launchedAvailabilityZone
String launchedAvailabilityZone

 The Availability Zone in which the request is launched.
 


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 price per hour that you are willing to pay for a Spot Instance.
 


state
String state

 The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more
 information, see Spot
 Status in the Amazon EC2 User Guide for Linux Instances.
 


status
SpotInstanceStatus status

 The status code and status message describing the Spot Instance request.
 


tags
SdkInternalList<T> 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. The default end date is 7 days from the current
 date.
 


instanceInterruptionBehavior
String instanceInterruptionBehavior

 The behavior when a Spot Instance is interrupted.
 








Class com.amazonaws.services.ec2.model.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 extends Object implements Serializable


Serialized Fields


code
String code

 The status code. For a list of status codes, see Spot Status Codes in the Amazon EC2 User Guide for Linux Instances.
 


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.SpotMarketOptions extends Object implements Serializable


Serialized Fields


maxPrice
String maxPrice

 The maximum hourly price you're willing to pay for the Spot Instances. The default is the On-Demand price.
 


spotInstanceType
String spotInstanceType

 The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported
 when InstanceInterruptionBehavior is set to either hibernate or stop.
 


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


validUntil
Date validUntil

 The end date of the request. For 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. The default end date is 7 days from the current date.
 


instanceInterruptionBehavior
String instanceInterruptionBehavior

 The behavior when a Spot Instance is interrupted. The default is terminate.
 








Class com.amazonaws.services.ec2.model.SpotOptions extends Object implements Serializable


Serialized Fields


allocationStrategy
String allocationStrategy

 Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2
 Fleet.
 
 
 If the allocation strategy is lowest-price, EC2 Fleet launches instances from the Spot Instance
 pools with the lowest price. This is the default allocation strategy.
 
 
 If the allocation strategy is diversified, EC2 Fleet launches instances from all of the Spot
 Instance pools that you specify.
 
 
 If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance
 pools with optimal capacity for the number of instances that are launching.
 


instanceInterruptionBehavior
String instanceInterruptionBehavior

 The behavior when a Spot Instance is interrupted. The default is terminate.
 


instancePoolsToUseCount
Integer instancePoolsToUseCount

 The number of Spot pools across which to allocate your target Spot capacity. Valid only when
 AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and
 evenly allocates your target Spot capacity across the number of Spot pools that you specify.
 


singleInstanceType
Boolean singleInstanceType

 Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only
 for fleets of type instant.
 


singleAvailabilityZone
Boolean singleAvailabilityZone

 Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets
 of type instant.
 


minTargetCapacity
Integer minTargetCapacity

 The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the
 fleet launches no instances.
 


maxTotalPrice
String maxTotalPrice

 The maximum amount per hour for Spot Instances that you're willing to pay.
 








Class com.amazonaws.services.ec2.model.SpotOptionsRequest extends Object implements Serializable


Serialized Fields


allocationStrategy
String allocationStrategy

 Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2
 Fleet.
 
 
 If the allocation strategy is lowest-price, EC2 Fleet launches instances from the Spot Instance
 pools with the lowest price. This is the default allocation strategy.
 
 
 If the allocation strategy is diversified, EC2 Fleet launches instances from all of the Spot
 Instance pools that you specify.
 
 
 If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance
 pools with optimal capacity for the number of instances that are launching.
 


instanceInterruptionBehavior
String instanceInterruptionBehavior

 The behavior when a Spot Instance is interrupted. The default is terminate.
 


instancePoolsToUseCount
Integer instancePoolsToUseCount

 The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot
 AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and
 evenly allocates your target Spot capacity across the number of Spot pools that you specify.
 


singleInstanceType
Boolean singleInstanceType

 Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet. Supported only
 for fleets of type instant.
 


singleAvailabilityZone
Boolean singleAvailabilityZone

 Indicates that the fleet launches all Spot Instances into a single Availability Zone. Supported only for fleets
 of type instant.
 


minTargetCapacity
Integer minTargetCapacity

 The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the
 fleet launches no instances.
 


maxTotalPrice
String maxTotalPrice

 The maximum amount per hour for Spot Instances that you're willing to pay.
 








Class com.amazonaws.services.ec2.model.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.
 


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








Class com.amazonaws.services.ec2.model.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 per hour 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 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
SdkInternalList<T> ipRanges

 The IP ranges. Not applicable for stale security group rules.
 


prefixListIds
SdkInternalList<T> prefixListIds

 The 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
SdkInternalList<T> userIdGroupPairs

 The 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 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
SdkInternalList<T> staleIpPermissions

 Information about the stale inbound rules in the security group.
 


staleIpPermissionsEgress
SdkInternalList<T> 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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceIds
SdkInternalList<T> instanceIds

 The IDs of the instances.
 


additionalInfo
String additionalInfo

 Reserved.
 








Class com.amazonaws.services.ec2.model.StartInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


startingInstances
SdkInternalList<T> startingInstances

 Information about the started instances.
 








Class com.amazonaws.services.ec2.model.StartVpcEndpointServicePrivateDnsVerificationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serviceId
String serviceId

 The ID of the endpoint service.
 








Class com.amazonaws.services.ec2.model.StartVpcEndpointServicePrivateDnsVerificationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, it returns an error.
 








Class com.amazonaws.services.ec2.model.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.InsufficientInstanceCapacity: There was insufficient capacity available to satisfy the launch
 request.
 
 
 
 
 Server.InternalError: An internal error caused the instance to terminate during launch.
 
 
 
 
 Server.ScheduledStop: The instance was stopped due to a scheduled retirement.
 
 
 
 
 Server.SpotInstanceShutdown: The instance was stopped because the number of Spot requests with a
 maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the
 Spot price.
 
 
 
 
 Server.SpotInstanceTermination: The instance was terminated because the number of Spot requests with
 a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in
 the Spot price.
 
 
 
 
 Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h
 command from the instance.
 
 
 
 
 Client.InstanceTerminated: The instance was terminated or rebooted during AMI creation.
 
 
 
 
 Client.InternalError: A client error caused the instance to terminate during launch.
 
 
 
 
 Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
 
 
 
 
 Client.UserInitiatedHibernate: Hibernation was initiated on 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 account limits.
 
 
 








Class com.amazonaws.services.ec2.model.StopInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceIds
SdkInternalList<T> instanceIds

 The IDs of the instances.
 


hibernate
Boolean hibernate

 Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate
 successfully, a normal shutdown occurs. For more information, see Hibernate Your Instance in the
 Amazon Elastic Compute Cloud User Guide.
 
 
 Default: false
 


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
 








Class com.amazonaws.services.ec2.model.StopInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stoppingInstances
SdkInternalList<T> stoppingInstances

 Information about the stopped instances.
 








Class com.amazonaws.services.ec2.model.Storage extends Object implements Serializable


Serialized Fields


s3
S3Storage s3

 An Amazon S3 storage location.
 








Class com.amazonaws.services.ec2.model.StorageLocation extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The name of the S3 bucket.
 


key
String key

 The key.
 








Class com.amazonaws.services.ec2.model.Subnet extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone of the subnet.
 


availabilityZoneId
String availabilityZoneId

 The AZ ID of the subnet.
 


availableIpAddressCount
Integer availableIpAddressCount

 The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are
 considered unavailable.
 


cidrBlock
String cidrBlock

 The IPv4 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 IPv4 address.
 


state
String state

 The current state of the subnet.
 


subnetId
String subnetId

 The ID of the subnet.
 


vpcId
String vpcId

 The ID of the VPC the subnet is in.
 


ownerId
String ownerId

 The ID of the AWS account that owns the subnet.
 


assignIpv6AddressOnCreation
Boolean assignIpv6AddressOnCreation

 Indicates whether a network interface created in this subnet (including a network interface created by
 RunInstances) receives an IPv6 address.
 


ipv6CidrBlockAssociationSet
SdkInternalList<T> ipv6CidrBlockAssociationSet

 Information about the IPv6 CIDR blocks associated with the subnet.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the subnet.
 


subnetArn
String subnetArn

 The Amazon Resource Name (ARN) of the subnet.
 


outpostArn
String outpostArn

 The Amazon Resource Name (ARN) of the Outpost.
 








Class com.amazonaws.services.ec2.model.SubnetAssociation extends Object implements Serializable


Serialized Fields


subnetId
String subnetId

 The ID of the subnet.
 


state
String state

 The state of the subnet association.
 








Class com.amazonaws.services.ec2.model.SubnetCidrBlockState extends Object implements Serializable


Serialized Fields


state
String state

 The state of a CIDR block.
 


statusMessage
String statusMessage

 A message about the status of the CIDR block, if applicable.
 








Class com.amazonaws.services.ec2.model.SubnetIpv6CidrBlockAssociation extends Object implements Serializable


Serialized Fields


associationId
String associationId

 The association ID for the CIDR block.
 


ipv6CidrBlock
String ipv6CidrBlock

 The IPv6 CIDR block.
 


ipv6CidrBlockState
SubnetCidrBlockState ipv6CidrBlockState

 Information about the state of the CIDR block.
 








Class com.amazonaws.services.ec2.model.SuccessfulInstanceCreditSpecificationItem extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 








Class com.amazonaws.services.ec2.model.SuccessfulQueuedPurchaseDeletion extends Object implements Serializable


Serialized Fields


reservedInstancesId
String reservedInstancesId

 The ID of the Reserved Instance.
 








Class com.amazonaws.services.ec2.model.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 extends Object implements Serializable


Serialized Fields


key
String key

 The tag key.
 


resourceId
String resourceId

 The ID of the resource.
 


resourceType
String resourceType

 The resource type.
 


value
String value

 The tag value.
 








Class com.amazonaws.services.ec2.model.TagSpecification extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of resource to tag. Currently, the resource types that support tagging on creation are:
 capacity-reservation | client-vpn-endpoint | dedicated-host |
 fleet | fpga-image | instance | key-pair |
 launch-template | placement-group | snapshot |
 traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target |
 transit-gateway | transit-gateway-attachment | transit-gateway-route-table
 | volume.
 
 
 To tag a resource after it has been created, see CreateTags.
 


tags
SdkInternalList<T> tags

 The tags to apply to the resource.
 








Class com.amazonaws.services.ec2.model.TargetCapacitySpecification extends Object implements Serializable


Serialized Fields


totalTargetCapacity
Integer totalTargetCapacity

 The number of units to request, filled using DefaultTargetCapacityType.
 


onDemandTargetCapacity
Integer onDemandTargetCapacity

 The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a
 target capacity for On-Demand units.
 


spotTargetCapacity
Integer spotTargetCapacity

 The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot
 specify a target capacity for Spot units.
 


defaultTargetCapacityType
String defaultTargetCapacityType

 The default TotalTargetCapacity, which is either Spot or On-Demand.
 








Class com.amazonaws.services.ec2.model.TargetCapacitySpecificationRequest extends Object implements Serializable


Serialized Fields


totalTargetCapacity
Integer totalTargetCapacity

 The number of units to request, filled using DefaultTargetCapacityType.
 


onDemandTargetCapacity
Integer onDemandTargetCapacity

 The number of On-Demand units to request.
 


spotTargetCapacity
Integer spotTargetCapacity

 The number of Spot units to request.
 


defaultTargetCapacityType
String defaultTargetCapacityType

 The default TotalTargetCapacity, which is either Spot or On-Demand.
 








Class com.amazonaws.services.ec2.model.TargetConfiguration extends Object implements Serializable


Serialized Fields


instanceCount
Integer instanceCount

 The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved
 and cannot be specified in a request
 


offeringId
String offeringId

 The ID of the Convertible Reserved Instance offering.
 








Class com.amazonaws.services.ec2.model.TargetConfigurationRequest extends Object implements Serializable


Serialized Fields


instanceCount
Integer instanceCount

 The number of instances the Covertible Reserved Instance offering can be applied to. This parameter is reserved
 and cannot be specified in a request
 


offeringId
String offeringId

 The Convertible Reserved Instance offering ID.
 








Class com.amazonaws.services.ec2.model.TargetGroup extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the target group.
 








Class com.amazonaws.services.ec2.model.TargetGroupsConfig extends Object implements Serializable


Serialized Fields


targetGroups
SdkInternalList<T> targetGroups

 One or more target groups.
 








Class com.amazonaws.services.ec2.model.TargetNetwork extends Object implements Serializable


Serialized Fields


associationId
String associationId

 The ID of the association.
 


vpcId
String vpcId

 The ID of the VPC in which the target network (subnet) is located.
 


targetNetworkId
String targetNetworkId

 The ID of the subnet specified as the target network.
 


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint with which the target network is associated.
 


status
AssociationStatus status

 The current state of the target network association.
 


securityGroups
SdkInternalList<T> securityGroups

 The IDs of the security groups applied to the target network association.
 








Class com.amazonaws.services.ec2.model.TargetReservationValue extends Object implements Serializable


Serialized Fields


reservationValue
ReservationValue reservationValue

 The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list
 value, remaining upfront price, and additional upfront cost of the exchange.
 


targetConfiguration
TargetConfiguration targetConfiguration

 The configuration of the Convertible Reserved Instances that make up the exchange.
 








Class com.amazonaws.services.ec2.model.TerminateClientVpnConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint to which the client is connected.
 


connectionId
String connectionId

 The ID of the client connection to be terminated.
 


username
String username

 The name of the user who initiated the connection. Use this option to terminate all active connections for the
 specified user. This option can only be used if the user has established up to five connections.
 








Class com.amazonaws.services.ec2.model.TerminateClientVpnConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientVpnEndpointId
String clientVpnEndpointId

 The ID of the Client VPN endpoint.
 


username
String username

 The user who established the terminated client connections.
 


connectionStatuses
SdkInternalList<T> connectionStatuses

 The current state of the client connections.
 








Class com.amazonaws.services.ec2.model.TerminateConnectionStatus extends Object implements Serializable


Serialized Fields


connectionId
String connectionId

 The ID of the client connection.
 


previousStatus
ClientVpnConnectionStatus previousStatus

 The state of the client connection.
 


currentStatus
ClientVpnConnectionStatus currentStatus

 A message about the status of the client connection, if applicable.
 








Class com.amazonaws.services.ec2.model.TerminateInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceIds
SdkInternalList<T> instanceIds

 The IDs of the instances.
 
 
 Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
 








Class com.amazonaws.services.ec2.model.TerminateInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


terminatingInstances
SdkInternalList<T> terminatingInstances

 Information about the terminated instances.
 








Class com.amazonaws.services.ec2.model.TrafficMirrorFilter extends Object implements Serializable


Serialized Fields


trafficMirrorFilterId
String trafficMirrorFilterId

 The ID of the Traffic Mirror filter.
 


ingressFilterRules
SdkInternalList<T> ingressFilterRules

 Information about the ingress rules that are associated with the Traffic Mirror filter.
 


egressFilterRules
SdkInternalList<T> egressFilterRules

 Information about the egress rules that are associated with the Traffic Mirror filter.
 


networkServices
SdkInternalList<T> networkServices

 The network service traffic that is associated with the Traffic Mirror filter.
 


description
String description

 The description of the Traffic Mirror filter.
 


tags
SdkInternalList<T> tags

 The tags assigned to the Traffic Mirror filter.
 








Class com.amazonaws.services.ec2.model.TrafficMirrorFilterRule extends Object implements Serializable


Serialized Fields


trafficMirrorFilterRuleId
String trafficMirrorFilterRuleId

 The ID of the Traffic Mirror rule.
 


trafficMirrorFilterId
String trafficMirrorFilterId

 The ID of the Traffic Mirror filter that the rule is associated with.
 


trafficDirection
String trafficDirection

 The traffic direction assigned to the Traffic Mirror rule.
 


ruleNumber
Integer ruleNumber

 The rule number of the Traffic Mirror rule.
 


ruleAction
String ruleAction

 The action assigned to the Traffic Mirror rule.
 


protocol
Integer protocol

 The protocol assigned to the Traffic Mirror rule.
 


destinationPortRange
TrafficMirrorPortRange destinationPortRange

 The destination port range assigned to the Traffic Mirror rule.
 


sourcePortRange
TrafficMirrorPortRange sourcePortRange

 The source port range assigned to the Traffic Mirror rule.
 


destinationCidrBlock
String destinationCidrBlock

 The destination CIDR block assigned to the Traffic Mirror rule.
 


sourceCidrBlock
String sourceCidrBlock

 The source CIDR block assigned to the Traffic Mirror rule.
 


description
String description

 The description of the Traffic Mirror rule.
 








Class com.amazonaws.services.ec2.model.TrafficMirrorPortRange extends Object implements Serializable


Serialized Fields


fromPort
Integer fromPort

 The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
 


toPort
Integer toPort

 The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
 








Class com.amazonaws.services.ec2.model.TrafficMirrorPortRangeRequest extends Object implements Serializable


Serialized Fields


fromPort
Integer fromPort

 The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
 


toPort
Integer toPort

 The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
 








Class com.amazonaws.services.ec2.model.TrafficMirrorSession extends Object implements Serializable


Serialized Fields


trafficMirrorSessionId
String trafficMirrorSessionId

 The ID for the Traffic Mirror session.
 


trafficMirrorTargetId
String trafficMirrorTargetId

 The ID of the Traffic Mirror target.
 


trafficMirrorFilterId
String trafficMirrorFilterId

 The ID of the Traffic Mirror filter.
 


networkInterfaceId
String networkInterfaceId

 The ID of the Traffic Mirror session's network interface.
 


ownerId
String ownerId

 The ID of the account that owns the Traffic Mirror session.
 


packetLength
Integer packetLength

 The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set
 this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that
 meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the
 entire packet
 


sessionNumber
Integer sessionNumber

 The session number determines the order in which sessions are evaluated when an interface is used by multiple
 sessions. The first session with a matching filter is the one that mirrors the packets.
 
 
 Valid values are 1-32766.
 


virtualNetworkId
Integer virtualNetworkId

 The virtual network ID associated with the Traffic Mirror session.
 


description
String description

 The description of the Traffic Mirror session.
 


tags
SdkInternalList<T> tags

 The tags assigned to the Traffic Mirror session.
 








Class com.amazonaws.services.ec2.model.TrafficMirrorTarget extends Object implements Serializable


Serialized Fields


trafficMirrorTargetId
String trafficMirrorTargetId

 The ID of the Traffic Mirror target.
 


networkInterfaceId
String networkInterfaceId

 The network interface ID that is attached to the target.
 


networkLoadBalancerArn
String networkLoadBalancerArn

 The Amazon Resource Name (ARN) of the Network Load Balancer.
 


type
String type

 The type of Traffic Mirror target.
 


description
String description

 Information about the Traffic Mirror target.
 


ownerId
String ownerId

 The ID of the account that owns the Traffic Mirror target.
 


tags
SdkInternalList<T> tags

 The tags assigned to the Traffic Mirror target.
 








Class com.amazonaws.services.ec2.model.TransitGateway extends Object implements Serializable


Serialized Fields


transitGatewayId
String transitGatewayId

 The ID of the transit gateway.
 


transitGatewayArn
String transitGatewayArn

 The Amazon Resource Name (ARN) of the transit gateway.
 


state
String state

 The state of the transit gateway.
 


ownerId
String ownerId

 The ID of the AWS account ID that owns the transit gateway.
 


description
String description

 The description of the transit gateway.
 


creationTime
Date creationTime

 The creation time.
 


options
TransitGatewayOptions options

 The transit gateway options.
 


tags
SdkInternalList<T> tags

 The tags for the transit gateway.
 








Class com.amazonaws.services.ec2.model.TransitGatewayAssociation extends Object implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the transit gateway route table.
 


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 


resourceId
String resourceId

 The ID of the resource.
 


resourceType
String resourceType

 The resource type.
 


state
String state

 The state of the association.
 








Class com.amazonaws.services.ec2.model.TransitGatewayAttachment extends Object implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 


transitGatewayId
String transitGatewayId

 The ID of the transit gateway.
 


transitGatewayOwnerId
String transitGatewayOwnerId

 The ID of the AWS account that owns the transit gateway.
 


resourceOwnerId
String resourceOwnerId

 The ID of the AWS account that owns the resource.
 


resourceType
String resourceType

 The resource type.
 


resourceId
String resourceId

 The ID of the resource.
 


state
String state

 The attachment state.
 


association
TransitGatewayAttachmentAssociation association

 The association.
 


creationTime
Date creationTime

 The creation time.
 


tags
SdkInternalList<T> tags

 The tags for the attachment.
 








Class com.amazonaws.services.ec2.model.TransitGatewayAttachmentAssociation extends Object implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the route table for the transit gateway.
 


state
String state

 The state of the association.
 








Class com.amazonaws.services.ec2.model.TransitGatewayAttachmentPropagation extends Object implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the propagation route table.
 


state
String state

 The state of the propagation route table.
 








Class com.amazonaws.services.ec2.model.TransitGatewayMulticastDeregisteredGroupMembers extends Object implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


deregisteredNetworkInterfaceIds
SdkInternalList<T> deregisteredNetworkInterfaceIds

 The network interface IDs of the deregistered members.
 


groupIpAddress
String groupIpAddress

 The IP address assigned to the transit gateway multicast group.
 








Class com.amazonaws.services.ec2.model.TransitGatewayMulticastDeregisteredGroupSources extends Object implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


deregisteredNetworkInterfaceIds
SdkInternalList<T> deregisteredNetworkInterfaceIds

 The network interface IDs of the non-registered members.
 


groupIpAddress
String groupIpAddress

 The IP address assigned to the transit gateway multicast group.
 








Class com.amazonaws.services.ec2.model.TransitGatewayMulticastDomain extends Object implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


transitGatewayId
String transitGatewayId

 The ID of the transit gateway.
 


state
String state

 The state of the transit gateway multicast domain.
 


creationTime
Date creationTime

 The time the transit gateway multicast domain was created.
 


tags
SdkInternalList<T> tags

 The tags for the transit gateway multicast domain.
 








Class com.amazonaws.services.ec2.model.TransitGatewayMulticastDomainAssociation extends Object implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the transit gateway attachment.
 


resourceId
String resourceId

 The ID of the resource.
 


resourceType
String resourceType

 The type of resource, for example a VPC attachment.
 


subnet
SubnetAssociation subnet

 The subnet associated with the transit gateway multicast domain.
 








Class com.amazonaws.services.ec2.model.TransitGatewayMulticastDomainAssociations extends Object implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the transit gateway attachment.
 


resourceId
String resourceId

 The ID of the resource.
 


resourceType
String resourceType

 The type of resource, for example a VPC attachment.
 


subnets
SdkInternalList<T> subnets

 The subnets associated with the multicast domain.
 








Class com.amazonaws.services.ec2.model.TransitGatewayMulticastGroup extends Object implements Serializable


Serialized Fields


groupIpAddress
String groupIpAddress

 The IP address assigned to the transit gateway multicast group.
 


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the transit gateway attachment.
 


subnetId
String subnetId

 The ID of the subnet.
 


resourceId
String resourceId

 The ID of the resource.
 


resourceType
String resourceType

 The type of resource, for example a VPC attachment.
 


networkInterfaceId
String networkInterfaceId

 The ID of the transit gateway attachment.
 


groupMember
Boolean groupMember

 Indicates that the resource is a transit gateway multicast group member.
 


groupSource
Boolean groupSource

 Indicates that the resource is a transit gateway multicast group member.
 


memberType
String memberType

 The member type (for example, static).
 


sourceType
String sourceType

 The source type.
 








Class com.amazonaws.services.ec2.model.TransitGatewayMulticastRegisteredGroupMembers extends Object implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


registeredNetworkInterfaceIds
SdkInternalList<T> registeredNetworkInterfaceIds

 The ID of the registered network interfaces.
 


groupIpAddress
String groupIpAddress

 The IP address assigned to the transit gateway multicast group.
 








Class com.amazonaws.services.ec2.model.TransitGatewayMulticastRegisteredGroupSources extends Object implements Serializable


Serialized Fields


transitGatewayMulticastDomainId
String transitGatewayMulticastDomainId

 The ID of the transit gateway multicast domain.
 


registeredNetworkInterfaceIds
SdkInternalList<T> registeredNetworkInterfaceIds

 The IDs of the network interfaces members registered with the transit gateway multicast group.
 


groupIpAddress
String groupIpAddress

 The IP address assigned to the transit gateway multicast group.
 








Class com.amazonaws.services.ec2.model.TransitGatewayOptions extends Object implements Serializable


Serialized Fields


amazonSideAsn
Long amazonSideAsn

 A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for
 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
 


autoAcceptSharedAttachments
String autoAcceptSharedAttachments

 Indicates whether attachment requests are automatically accepted.
 


defaultRouteTableAssociation
String defaultRouteTableAssociation

 Indicates whether resource attachments are automatically associated with the default association route table.
 


associationDefaultRouteTableId
String associationDefaultRouteTableId

 The ID of the default association route table.
 


defaultRouteTablePropagation
String defaultRouteTablePropagation

 Indicates whether resource attachments automatically propagate routes to the default propagation route table.
 


propagationDefaultRouteTableId
String propagationDefaultRouteTableId

 The ID of the default propagation route table.
 


vpnEcmpSupport
String vpnEcmpSupport

 Indicates whether Equal Cost Multipath Protocol support is enabled.
 


dnsSupport
String dnsSupport

 Indicates whether DNS support is enabled.
 


multicastSupport
String multicastSupport

 Indicates whether multicast is enabled on the transit gateway
 








Class com.amazonaws.services.ec2.model.TransitGatewayPeeringAttachment extends Object implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the transit gateway peering attachment.
 


requesterTgwInfo
PeeringTgwInfo requesterTgwInfo

 Information about the requester transit gateway.
 


accepterTgwInfo
PeeringTgwInfo accepterTgwInfo

 Information about the accepter transit gateway.
 


status
PeeringAttachmentStatus status

 The status of the transit gateway peering attachment.
 


state
String state

 The state of the transit gateway peering attachment.
 


creationTime
Date creationTime

 The time the transit gateway peering attachment was created.
 


tags
SdkInternalList<T> tags

 The tags for the transit gateway peering attachment.
 








Class com.amazonaws.services.ec2.model.TransitGatewayPropagation extends Object implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 


resourceId
String resourceId

 The ID of the resource.
 


resourceType
String resourceType

 The resource type.
 


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the transit gateway route table.
 


state
String state

 The state.
 








Class com.amazonaws.services.ec2.model.TransitGatewayRequestOptions extends Object implements Serializable


Serialized Fields


amazonSideAsn
Long amazonSideAsn

 A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for
 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
 


autoAcceptSharedAttachments
String autoAcceptSharedAttachments

 Enable or disable automatic acceptance of attachment requests. The default is disable.
 


defaultRouteTableAssociation
String defaultRouteTableAssociation

 Enable or disable automatic association with the default association route table. The default is
 enable.
 


defaultRouteTablePropagation
String defaultRouteTablePropagation

 Enable or disable automatic propagation of routes to the default propagation route table. The default is
 enable.
 


vpnEcmpSupport
String vpnEcmpSupport

 Enable or disable Equal Cost Multipath Protocol support.
 


dnsSupport
String dnsSupport

 Enable or disable DNS support.
 


multicastSupport
String multicastSupport

 Indicates whether multicast is enabled on the transit gateway
 








Class com.amazonaws.services.ec2.model.TransitGatewayRoute extends Object implements Serializable


Serialized Fields


destinationCidrBlock
String destinationCidrBlock

 The CIDR block used for destination matches.
 


transitGatewayAttachments
SdkInternalList<T> transitGatewayAttachments

 The attachments.
 


type
String type

 The route type.
 


state
String state

 The state of the route.
 








Class com.amazonaws.services.ec2.model.TransitGatewayRouteAttachment extends Object implements Serializable


Serialized Fields


resourceId
String resourceId

 The ID of the resource.
 


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 


resourceType
String resourceType

 The resource type.
 








Class com.amazonaws.services.ec2.model.TransitGatewayRouteTable extends Object implements Serializable


Serialized Fields


transitGatewayRouteTableId
String transitGatewayRouteTableId

 The ID of the transit gateway route table.
 


transitGatewayId
String transitGatewayId

 The ID of the transit gateway.
 


state
String state

 The state of the transit gateway route table.
 


defaultAssociationRouteTable
Boolean defaultAssociationRouteTable

 Indicates whether this is the default association route table for the transit gateway.
 


defaultPropagationRouteTable
Boolean defaultPropagationRouteTable

 Indicates whether this is the default propagation route table for the transit gateway.
 


creationTime
Date creationTime

 The creation time.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the route table.
 








Class com.amazonaws.services.ec2.model.TransitGatewayRouteTableAssociation extends Object implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 


resourceId
String resourceId

 The ID of the resource.
 


resourceType
String resourceType

 The resource type.
 


state
String state

 The state of the association.
 








Class com.amazonaws.services.ec2.model.TransitGatewayRouteTablePropagation extends Object implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 


resourceId
String resourceId

 The ID of the resource.
 


resourceType
String resourceType

 The type of resource.
 


state
String state

 The state of the resource.
 








Class com.amazonaws.services.ec2.model.TransitGatewayVpcAttachment extends Object implements Serializable


Serialized Fields


transitGatewayAttachmentId
String transitGatewayAttachmentId

 The ID of the attachment.
 


transitGatewayId
String transitGatewayId

 The ID of the transit gateway.
 


vpcId
String vpcId

 The ID of the VPC.
 


vpcOwnerId
String vpcOwnerId

 The ID of the AWS account that owns the VPC.
 


state
String state

 The state of the VPC attachment.
 


subnetIds
SdkInternalList<T> subnetIds

 The IDs of the subnets.
 


creationTime
Date creationTime

 The creation time.
 


options
TransitGatewayVpcAttachmentOptions options

 The VPC attachment options.
 


tags
SdkInternalList<T> tags

 The tags for the VPC attachment.
 








Class com.amazonaws.services.ec2.model.TransitGatewayVpcAttachmentOptions extends Object implements Serializable


Serialized Fields


dnsSupport
String dnsSupport

 Indicates whether DNS support is enabled.
 


ipv6Support
String ipv6Support

 Indicates whether IPv6 support is enabled.
 








Class com.amazonaws.services.ec2.model.TunnelOption extends Object implements Serializable


Serialized Fields


outsideIpAddress
String outsideIpAddress

 The external IP address of the VPN tunnel.
 


tunnelInsideCidr
String tunnelInsideCidr

 The range of inside IP addresses for the tunnel.
 


preSharedKey
String preSharedKey

 The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer
 gateway.
 


phase1LifetimeSeconds
Integer phase1LifetimeSeconds

 The lifetime for phase 1 of the IKE negotiation, in seconds.
 


phase2LifetimeSeconds
Integer phase2LifetimeSeconds

 The lifetime for phase 2 of the IKE negotiation, in seconds.
 


rekeyMarginTimeSeconds
Integer rekeyMarginTimeSeconds

 The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection
 performs an IKE rekey.
 


rekeyFuzzPercentage
Integer rekeyFuzzPercentage

 The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time
 is randomly selected.
 


replayWindowSize
Integer replayWindowSize

 The number of packets in an IKE replay window.
 


dpdTimeoutSeconds
Integer dpdTimeoutSeconds

 The number of seconds after which a DPD timeout occurs.
 


phase1EncryptionAlgorithms
SdkInternalList<T> phase1EncryptionAlgorithms

 The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
 


phase2EncryptionAlgorithms
SdkInternalList<T> phase2EncryptionAlgorithms

 The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
 


phase1IntegrityAlgorithms
SdkInternalList<T> phase1IntegrityAlgorithms

 The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
 


phase2IntegrityAlgorithms
SdkInternalList<T> phase2IntegrityAlgorithms

 The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
 


phase1DHGroupNumbers
SdkInternalList<T> phase1DHGroupNumbers

 The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
 


phase2DHGroupNumbers
SdkInternalList<T> phase2DHGroupNumbers

 The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
 


ikeVersions
SdkInternalList<T> ikeVersions

 The IKE versions that are permitted for the VPN tunnel.
 








Class com.amazonaws.services.ec2.model.UnassignIpv6AddressesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ipv6Addresses
SdkInternalList<T> ipv6Addresses

 The IPv6 addresses to unassign from the network interface.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 








Class com.amazonaws.services.ec2.model.UnassignIpv6AddressesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


unassignedIpv6Addresses
SdkInternalList<T> unassignedIpv6Addresses

 The IPv6 addresses that have been unassigned from the network interface.
 








Class com.amazonaws.services.ec2.model.UnassignPrivateIpAddressesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


privateIpAddresses
SdkInternalList<T> 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ec2.model.UnmonitorInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceIds
SdkInternalList<T> instanceIds

 The IDs of the instances.
 








Class com.amazonaws.services.ec2.model.UnmonitorInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceMonitorings
SdkInternalList<T> instanceMonitorings

 The monitoring information.
 








Class com.amazonaws.services.ec2.model.UnsuccessfulInstanceCreditSpecificationItem extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 


error
UnsuccessfulInstanceCreditSpecificationItemError error

 The applicable error for the burstable performance instance whose credit option for CPU usage was not modified.
 








Class com.amazonaws.services.ec2.model.UnsuccessfulInstanceCreditSpecificationItemError extends Object implements Serializable


Serialized Fields


code
String code

 The error code.
 


message
String message

 The applicable error message.
 








Class com.amazonaws.services.ec2.model.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 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.UpdateSecurityGroupRuleDescriptionsEgressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId

 The ID of the security group. You must specify either the security group ID or the security group name in the
 request. For security groups in a nondefault VPC, you must specify the security group ID.
 


groupName
String groupName

 [Default VPC] The name of the security group. You must specify either the security group ID or the security group
 name in the request.
 


ipPermissions
SdkInternalList<T> ipPermissions

 The IP permissions for the security group rule.
 








Class com.amazonaws.services.ec2.model.UpdateSecurityGroupRuleDescriptionsEgressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, returns an error.
 








Class com.amazonaws.services.ec2.model.UpdateSecurityGroupRuleDescriptionsIngressRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId

 The ID of the security group. You must specify either the security group ID or the security group name in the
 request. For security groups in a nondefault VPC, you must specify the security group ID.
 


groupName
String groupName

 [EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the
 security group name in the request.
 


ipPermissions
SdkInternalList<T> ipPermissions

 The IP permissions for the security group rule.
 








Class com.amazonaws.services.ec2.model.UpdateSecurityGroupRuleDescriptionsIngressResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


returnValue
Boolean returnValue

 Returns true if the request succeeds; otherwise, returns an error.
 








Class com.amazonaws.services.ec2.model.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 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 extends Object implements Serializable


Serialized Fields


data
String data

 The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you
 can load the text from a file. Otherwise, you must provide Base64-encoded text.
 








Class com.amazonaws.services.ec2.model.UserIdGroupPair extends Object implements Serializable


Serialized Fields


description
String description

 A description for the security group rule that references this user ID group pair.
 
 
 Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and
 ._-:/()#,@[]+=;{}!$*
 


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.
 
 
 For a referenced security group in another VPC, this value is not returned if the referenced security group is
 deleted.
 


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 in
 the response. If the referenced security group is deleted, this value is not 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.VCpuInfo extends Object implements Serializable


Serialized Fields


defaultVCpus
Integer defaultVCpus

 The default number of vCPUs for the instance type.
 


defaultCores
Integer defaultCores

 The default number of cores for the instance type.
 


defaultThreadsPerCore
Integer defaultThreadsPerCore

 The default number of threads per core for the instance type.
 


validCores
SdkInternalList<T> validCores

 List of the valid number of cores that can be configured for the instance type.
 


validThreadsPerCore
SdkInternalList<T> validThreadsPerCore

 List of the valid number of threads per core that can be configured for the instance type.
 








Class com.amazonaws.services.ec2.model.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.
 


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
 








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


Serialized Fields


attachments
SdkInternalList<T> 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 is encrypted.
 


kmsKeyId
String kmsKeyId

 The Amazon Resource Name (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.
 


outpostArn
String outpostArn

 The Amazon Resource Name (ARN) of the Outpost.
 


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.
 


volumeId
String volumeId

 The ID of the volume.
 


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, see Amazon EBS Volume Types in the
 Amazon Elastic Compute Cloud User Guide.
 
 
 Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1
 volumes, in most Regions. The maximum IOPS for io1 of 64,000 is guaranteed only on Nitro-based
 instances. Other instance families guarantee performance up to 32,000 IOPS.
 
 
 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.
 


tags
SdkInternalList<T> tags

 Any tags assigned to 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.
 


fastRestored
Boolean fastRestored

 Indicates whether the volume was created using fast snapshot restore.
 








Class com.amazonaws.services.ec2.model.VolumeAttachment extends Object implements Serializable


Serialized Fields


attachTime
Date attachTime

 The time stamp when the attachment initiated.
 


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.
 


deleteOnTermination
Boolean deleteOnTermination

 Indicates whether the EBS volume is deleted on instance termination.
 








Class com.amazonaws.services.ec2.model.VolumeDetail extends Object implements Serializable


Serialized Fields


size
Long size

 The size of the volume, in GiB.
 








Class com.amazonaws.services.ec2.model.VolumeModification extends Object implements Serializable


Serialized Fields


volumeId
String volumeId

 The ID of the volume.
 


modificationState
String modificationState

 The current modification state. The modification state is null for unmodified volumes.
 


statusMessage
String statusMessage

 A status message about the modification progress or failure.
 


targetSize
Integer targetSize

 The target size of the volume, in GiB.
 


targetIops
Integer targetIops

 The target IOPS rate of the volume.
 


targetVolumeType
String targetVolumeType

 The target EBS volume type of the volume.
 


originalSize
Integer originalSize

 The original size of the volume.
 


originalIops
Integer originalIops

 The original IOPS rate of the volume.
 


originalVolumeType
String originalVolumeType

 The original EBS volume type of the volume.
 


progress
Long progress

 The modification progress, from 0 to 100 percent complete.
 


startTime
Date startTime

 The modification start time.
 


endTime
Date endTime

 The modification completion or failure time.
 








Class com.amazonaws.services.ec2.model.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 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 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 extends Object implements Serializable


Serialized Fields


details
SdkInternalList<T> details

 The details of the volume status.
 


status
String status

 The status of the volume.
 








Class com.amazonaws.services.ec2.model.VolumeStatusItem extends Object implements Serializable


Serialized Fields


actions
SdkInternalList<T> actions

 The details of the operation.
 


availabilityZone
String availabilityZone

 The Availability Zone of the volume.
 


outpostArn
String outpostArn

 The Amazon Resource Name (ARN) of the Outpost.
 


events
SdkInternalList<T> 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 extends Object implements Serializable


Serialized Fields


cidrBlock
String cidrBlock

 The primary IPv4 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).
 


state
String state

 The current state of the VPC.
 


vpcId
String vpcId

 The ID of the VPC.
 


ownerId
String ownerId

 The ID of the AWS account that owns the VPC.
 


instanceTenancy
String instanceTenancy

 The allowed tenancy of instances launched into the VPC.
 


ipv6CidrBlockAssociationSet
SdkInternalList<T> ipv6CidrBlockAssociationSet

 Information about the IPv6 CIDR blocks associated with the VPC.
 


cidrBlockAssociationSet
SdkInternalList<T> cidrBlockAssociationSet

 Information about the IPv4 CIDR blocks associated with the VPC.
 


isDefault
Boolean isDefault

 Indicates whether the VPC is the default VPC.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the VPC.
 








Class com.amazonaws.services.ec2.model.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.VpcCidrBlockAssociation extends Object implements Serializable


Serialized Fields


associationId
String associationId

 The association ID for the IPv4 CIDR block.
 


cidrBlock
String cidrBlock

 The IPv4 CIDR block.
 


cidrBlockState
VpcCidrBlockState cidrBlockState

 Information about the state of the CIDR block.
 








Class com.amazonaws.services.ec2.model.VpcCidrBlockState extends Object implements Serializable


Serialized Fields


state
String state

 The state of the CIDR block.
 


statusMessage
String statusMessage

 A message about the status of the CIDR block, if applicable.
 








Class com.amazonaws.services.ec2.model.VpcClassicLink extends Object implements Serializable


Serialized Fields


classicLinkEnabled
Boolean classicLinkEnabled

 Indicates whether the VPC is enabled for ClassicLink.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the VPC.
 


vpcId
String vpcId

 The ID of the VPC.
 








Class com.amazonaws.services.ec2.model.VpcEndpoint extends Object implements Serializable


Serialized Fields


vpcEndpointId
String vpcEndpointId

 The ID of the VPC endpoint.
 


vpcEndpointType
String vpcEndpointType

 The type of endpoint.
 


vpcId
String vpcId

 The ID of the VPC to which the endpoint is associated.
 


serviceName
String serviceName

 The name of the service to which the endpoint is associated.
 


state
String state

 The state of the VPC endpoint.
 


policyDocument
String policyDocument

 The policy document associated with the endpoint, if applicable.
 


routeTableIds
SdkInternalList<T> routeTableIds

 (Gateway endpoint) One or more route tables associated with the endpoint.
 


subnetIds
SdkInternalList<T> subnetIds

 (Interface endpoint) One or more subnets in which the endpoint is located.
 


groups
SdkInternalList<T> groups

 (Interface endpoint) Information about the security groups that are associated with the network interface.
 


privateDnsEnabled
Boolean privateDnsEnabled

 (Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.
 


requesterManaged
Boolean requesterManaged

 Indicates whether the VPC endpoint is being managed by its service.
 


networkInterfaceIds
SdkInternalList<T> networkInterfaceIds

 (Interface endpoint) One or more network interfaces for the endpoint.
 


dnsEntries
SdkInternalList<T> dnsEntries

 (Interface endpoint) The DNS entries for the endpoint.
 


creationTimestamp
Date creationTimestamp

 The date and time that the VPC endpoint was created.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the VPC endpoint.
 


ownerId
String ownerId

 The ID of the AWS account that owns the VPC endpoint.
 


lastError
LastError lastError

 The last error that occurred for VPC endpoint.
 








Class com.amazonaws.services.ec2.model.VpcEndpointConnection extends Object implements Serializable


Serialized Fields


serviceId
String serviceId

 The ID of the service to which the endpoint is connected.
 


vpcEndpointId
String vpcEndpointId

 The ID of the VPC endpoint.
 


vpcEndpointOwner
String vpcEndpointOwner

 The AWS account ID of the owner of the VPC endpoint.
 


vpcEndpointState
String vpcEndpointState

 The state of the VPC endpoint.
 


creationTimestamp
Date creationTimestamp

 The date and time that the VPC endpoint was created.
 


dnsEntries
SdkInternalList<T> dnsEntries

 The DNS entries for the VPC endpoint.
 


networkLoadBalancerArns
SdkInternalList<T> networkLoadBalancerArns

 The Amazon Resource Names (ARNs) of the network load balancers for the service.
 








Class com.amazonaws.services.ec2.model.VpcIpv6CidrBlockAssociation extends Object implements Serializable


Serialized Fields


associationId
String associationId

 The association ID for the IPv6 CIDR block.
 


ipv6CidrBlock
String ipv6CidrBlock

 The IPv6 CIDR block.
 


ipv6CidrBlockState
VpcCidrBlockState ipv6CidrBlockState

 Information about the state of the CIDR block.
 


ipv6Pool
String ipv6Pool

 The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
 


networkBorderGroup
String networkBorderGroup

 The name of the location from which we advertise the IPV6 CIDR block.
 








Class com.amazonaws.services.ec2.model.VpcPeeringConnection extends Object implements Serializable


Serialized Fields


accepterVpcInfo
VpcPeeringConnectionVpcInfo accepterVpcInfo

 Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering
 connection.
 


expirationTime
Date expirationTime

 The time that an unaccepted VPC peering connection will expire.
 


requesterVpcInfo
VpcPeeringConnectionVpcInfo requesterVpcInfo

 Information about the requester VPC. CIDR block information is only returned when describing an active VPC
 peering connection.
 


status
VpcPeeringConnectionStateReason status

 The status of the VPC peering connection.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the resource.
 


vpcPeeringConnectionId
String vpcPeeringConnectionId

 The ID of the VPC peering connection.
 








Class com.amazonaws.services.ec2.model.VpcPeeringConnectionOptionsDescription extends Object implements Serializable


Serialized Fields


allowDnsResolutionFromRemoteVpc
Boolean allowDnsResolutionFromRemoteVpc

 Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from
 instances in a peer VPC.
 


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 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 extends Object implements Serializable


Serialized Fields


cidrBlock
String cidrBlock

 The IPv4 CIDR block for the VPC.
 


ipv6CidrBlockSet
SdkInternalList<T> ipv6CidrBlockSet

 The IPv6 CIDR block for the VPC.
 


cidrBlockSet
SdkInternalList<T> cidrBlockSet

 Information about the IPv4 CIDR blocks 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.
 


region
String region

 The Region in which the VPC is located.
 








Class com.amazonaws.services.ec2.model.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.
 


category
String category

 The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of
 VPN-Classic indicates an AWS Classic VPN connection.
 


state
String state

 The current state of the VPN connection.
 


type
String type

 The type of VPN connection.
 


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.
 


transitGatewayId
String transitGatewayId

 The ID of the transit gateway associated with the VPN connection.
 


options
VpnConnectionOptions options

 The VPN connection options.
 


routes
SdkInternalList<T> routes

 The static routes associated with the VPN connection.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the VPN connection.
 


vgwTelemetry
SdkInternalList<T> vgwTelemetry

 Information about the VPN tunnel.
 








Class com.amazonaws.services.ec2.model.VpnConnectionOptions extends Object implements Serializable


Serialized Fields


enableAcceleration
Boolean enableAcceleration

 Indicates whether acceleration is enabled for the VPN connection.
 


staticRoutesOnly
Boolean staticRoutesOnly

 Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't
 support BGP.
 


tunnelOptions
SdkInternalList<T> tunnelOptions

 Indicates the VPN tunnel options.
 








Class com.amazonaws.services.ec2.model.VpnConnectionOptionsSpecification extends Object implements Serializable


Serialized Fields


enableAcceleration
Boolean enableAcceleration

 Indicate whether to enable acceleration for the VPN connection.
 
 
 Default: false
 


staticRoutesOnly
Boolean staticRoutesOnly

 Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device
 that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a
 static route.
 
 
 Default: false
 


tunnelOptions
SdkInternalList<T> tunnelOptions

 The tunnel options for the VPN connection.
 








Class com.amazonaws.services.ec2.model.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.
 


type
String type

 The type of VPN connection the virtual private gateway supports.
 


vpcAttachments
SdkInternalList<T> vpcAttachments

 Any VPCs attached to the virtual private gateway.
 


vpnGatewayId
String vpnGatewayId

 The ID of the virtual private gateway.
 


amazonSideAsn
Long amazonSideAsn

 The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
 


tags
SdkInternalList<T> tags

 Any tags assigned to the virtual private gateway.
 








Class com.amazonaws.services.ec2.model.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.
 








Class com.amazonaws.services.ec2.model.VpnTunnelOptionsSpecification extends Object implements Serializable


Serialized Fields


tunnelInsideCidr
String tunnelInsideCidr

 The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN
 connections that use the same virtual private gateway.
 
 
 Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are
 reserved and cannot be used:
 
 
 
 
 169.254.0.0/30
 
 
 
 
 169.254.1.0/30
 
 
 
 
 169.254.2.0/30
 
 
 
 
 169.254.3.0/30
 
 
 
 
 169.254.4.0/30
 
 
 
 
 169.254.5.0/30
 
 
 
 
 169.254.169.252/30
 
 
 


preSharedKey
String preSharedKey

 The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer
 gateway.
 
 
 Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8
 and 64 characters in length and cannot start with zero (0).
 


phase1LifetimeSeconds
Integer phase1LifetimeSeconds

 The lifetime for phase 1 of the IKE negotiation, in seconds.
 
 
 Constraints: A value between 900 and 28,800.
 
 
 Default: 28800
 


phase2LifetimeSeconds
Integer phase2LifetimeSeconds

 The lifetime for phase 2 of the IKE negotiation, in seconds.
 
 
 Constraints: A value between 900 and 3,600. The value must be less than the value for
 Phase1LifetimeSeconds.
 
 
 Default: 3600
 


rekeyMarginTimeSeconds
Integer rekeyMarginTimeSeconds

 The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection
 performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for
 RekeyFuzzPercentage.
 
 
 Constraints: A value between 60 and half of Phase2LifetimeSeconds.
 
 
 Default: 540
 


rekeyFuzzPercentage
Integer rekeyFuzzPercentage

 The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey
 time is randomly selected.
 
 
 Constraints: A value between 0 and 100.
 
 
 Default: 100
 


replayWindowSize
Integer replayWindowSize

 The number of packets in an IKE replay window.
 
 
 Constraints: A value between 64 and 2048.
 
 
 Default: 1024
 


dPDTimeoutSeconds
Integer dPDTimeoutSeconds

 The number of seconds after which a DPD timeout occurs.
 
 
 Constraints: A value between 0 and 30.
 
 
 Default: 30
 


phase1EncryptionAlgorithms
SdkInternalList<T> phase1EncryptionAlgorithms

 One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
 
 
 Valid values: AES128 | AES256
 


phase2EncryptionAlgorithms
SdkInternalList<T> phase2EncryptionAlgorithms

 One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
 
 
 Valid values: AES128 | AES256
 


phase1IntegrityAlgorithms
SdkInternalList<T> phase1IntegrityAlgorithms

 One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
 
 
 Valid values: SHA1 | SHA2-256
 


phase2IntegrityAlgorithms
SdkInternalList<T> phase2IntegrityAlgorithms

 One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
 
 
 Valid values: SHA1 | SHA2-256
 


phase1DHGroupNumbers
SdkInternalList<T> phase1DHGroupNumbers

 One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
 
 
 Valid values: 2 | 14 | 15 | 16 | 17 |
 18 | 22 | 23 | 24
 


phase2DHGroupNumbers
SdkInternalList<T> phase2DHGroupNumbers

 One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
 
 
 Valid values: 2 | 5 | 14 | 15 | 16 |
 17 | 18 | 22 | 23 | 24
 


iKEVersions
SdkInternalList<T> iKEVersions

 The IKE versions that are permitted for the VPN tunnel.
 
 
 Valid values: ikev1 | ikev2
 








Class com.amazonaws.services.ec2.model.WithdrawByoipCidrRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cidr
String cidr

 The address range, in CIDR notation.
 








Class com.amazonaws.services.ec2.model.WithdrawByoipCidrResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


byoipCidr
ByoipCidr byoipCidr

 Information about the address pool.
 








Package com.amazonaws.services.ec2instanceconnect.model




Class com.amazonaws.services.ec2instanceconnect.model.AuthException extends AWSEC2InstanceConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ec2instanceconnect.model.AWSEC2InstanceConnectException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ec2instanceconnect.model.EC2InstanceNotFoundException extends AWSEC2InstanceConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ec2instanceconnect.model.InvalidArgsException extends AWSEC2InstanceConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ec2instanceconnect.model.SendSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The EC2 instance you wish to publish the SSH key to.
 


instanceOSUser
String instanceOSUser

 The OS user on the EC2 instance whom the key may be used to authenticate as.
 


sSHPublicKey
String sSHPublicKey

 The public key to be published to the instance. To use it after publication you must have the matching private
 key.
 


availabilityZone
String availabilityZone

 The availability zone the EC2 instance was launched in.
 








Class com.amazonaws.services.ec2instanceconnect.model.SendSSHPublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID as logged by EC2 Connect. Please provide this when contacting AWS Support.
 


success
Boolean success

 Indicates request success.
 








Class com.amazonaws.services.ec2instanceconnect.model.ServiceException extends AWSEC2InstanceConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ec2instanceconnect.model.ThrottlingException extends AWSEC2InstanceConnectException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.ecr.model




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

serialVersionUID:
1L





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


Serialized Fields


key
String key

 The attribute key.
 


value
String value

 The value assigned to the attribute key.
 








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


Serialized Fields


authorizationToken
String authorizationToken

 A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string
 is decoded, it is presented in the format user:password for private registry authentication using
 docker login.
 


expiresAt
Date expiresAt

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


proxyEndpoint
String proxyEndpoint

 The registry URL to use for this authorization token in a docker login command. The Amazon ECR
 registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com. For example,
 https://012345678910.dkr.ecr.us-east-1.amazonaws.com..
 








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


Serialized Fields


registryId
String registryId

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


repositoryName
String repositoryName

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


layerDigests
List<E> layerDigests

 The digests of the image layers to check.
 








Class com.amazonaws.services.ecr.model.BatchCheckLayerAvailabilityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


layers
List<E> layers

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


failures
List<E> failures

 Any failures associated with the call.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the image to delete. If you do not specify a
 registry, the default registry is assumed.
 


repositoryName
String repositoryName

 The repository that contains the image to delete.
 


imageIds
List<E> imageIds

 A list of image ID references that correspond to images to delete. The format of the imageIds
 reference is imageTag=tag or imageDigest=digest.
 








Class com.amazonaws.services.ecr.model.BatchDeleteImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


imageIds
List<E> imageIds

 The image IDs of the deleted images.
 


failures
List<E> failures

 Any failures associated with the call.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the images to describe. If you do not specify a
 registry, the default registry is assumed.
 


repositoryName
String repositoryName

 The repository that contains the images to describe.
 


imageIds
List<E> imageIds

 A list of image ID references that correspond to images to describe. The format of the imageIds
 reference is imageTag=tag or imageDigest=digest.
 


acceptedMediaTypes
List<E> acceptedMediaTypes

 The accepted media types for the request.
 
 
 Valid values: application/vnd.docker.distribution.manifest.v1+json |
 application/vnd.docker.distribution.manifest.v2+json |
 application/vnd.oci.image.manifest.v1+json
 








Class com.amazonaws.services.ecr.model.BatchGetImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


images
List<E> images

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


failures
List<E> failures

 Any failures associated with the call.
 








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


Serialized Fields


registryId
String registryId

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


repositoryName
String repositoryName

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


uploadId
String uploadId

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


layerDigests
List<E> layerDigests

 The sha256 digest of the image layer.
 








Class com.amazonaws.services.ecr.model.CompleteLayerUploadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


uploadId
String uploadId

 The upload ID associated with the layer.
 


layerDigest
String layerDigest

 The sha256 digest of the image layer.
 








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


Serialized Fields


repositoryName
String repositoryName

 The name to use for the repository. The repository name may be specified on its own (such as
 nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such
 as project-a/nginx-web-app).
 


tags
List<E> tags

 The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a
 key and an optional value, both of which you define. Tag keys can have a maximum character length of 128
 characters, and tag values can have a maximum length of 256 characters.
 


imageTagMutability
String imageTagMutability

 The tag mutability setting for the repository. If this parameter is omitted, the default setting of
 MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is
 specified, all image tags within the repository will be immutable which will prevent them from being overwritten.
 


imageScanningConfiguration
ImageScanningConfiguration imageScanningConfiguration

 The image scanning configuration for the repository. This setting determines whether images are scanned for known
 vulnerabilities after being pushed to the repository.
 








Class com.amazonaws.services.ecr.model.CreateRepositoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repository
Repository repository

 The repository that was created.
 








Class com.amazonaws.services.ecr.model.DeleteLifecyclePolicyRequest 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.
 








Class com.amazonaws.services.ecr.model.DeleteLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


lifecyclePolicyText
String lifecyclePolicyText

 The JSON lifecycle policy text.
 


lastEvaluatedAt
Date lastEvaluatedAt

 The time stamp of the last time that the lifecycle policy was run.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository policy to delete. If you do not
 specify a registry, the default registry is assumed.
 


repositoryName
String repositoryName

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








Class com.amazonaws.services.ecr.model.DeleteRepositoryPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


policyText
String policyText

 The JSON repository policy that was deleted from the repository.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a
 registry, the default registry is assumed.
 


repositoryName
String repositoryName

 The name of the repository to delete.
 


force
Boolean force

 If a repository contains images, forces the deletion.
 








Class com.amazonaws.services.ecr.model.DeleteRepositoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repository
Repository repository

 The repository that was deleted.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository in which to describe the image scan
 findings for. If you do not specify a registry, the default registry is assumed.
 


repositoryName
String repositoryName

 The repository for the image for which to describe the scan findings.
 


imageId
ImageIdentifier imageId


nextToken
String nextToken

 The nextToken value returned from a previous paginated DescribeImageScanFindings
 request where maxResults was used and the results exceeded the value of that parameter. Pagination
 continues from the end of the previous results that returned the nextToken value. This value is null
 when there are no more results to return.
 


maxResults
Integer maxResults

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








Class com.amazonaws.services.ecr.model.DescribeImageScanFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


imageId
ImageIdentifier imageId


imageScanStatus
ImageScanStatus imageScanStatus

 The current state of the scan.
 


imageScanFindings
ImageScanFindings imageScanFindings

 The information contained in the image scan findings.
 


nextToken
String nextToken

 The nextToken value to include in a future DescribeImageScanFindings request. When the
 results of a DescribeImageScanFindings 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.DescribeImagesFilter extends Object implements Serializable


Serialized Fields


tagStatus
String tagStatus

 The tag status with which to filter your DescribeImages results. You can filter results based on whether
 they are TAGGED or UNTAGGED.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository in which to describe images. If you
 do not specify a registry, the default registry is assumed.
 


repositoryName
String repositoryName

 The repository that contains the images to describe.
 


imageIds
List<E> imageIds

 The list of image IDs for the requested repository.
 


nextToken
String nextToken

 The nextToken value returned from a previous paginated DescribeImages 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 option cannot be used when you specify images with
 imageIds.
 


maxResults
Integer maxResults

 The maximum number of repository results returned by DescribeImages in paginated output. When this
 parameter is used, DescribeImages 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 DescribeImages request with the returned nextToken value. This value
 can be between 1 and 1000. If this parameter is not used, then DescribeImages returns up to 100
 results and a nextToken value, if applicable. This option cannot be used when you specify images
 with imageIds.
 


filter
DescribeImagesFilter filter

 The filter key and value with which to filter your DescribeImages results.
 








Class com.amazonaws.services.ecr.model.DescribeImagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


imageDetails
List<E> imageDetails

 A list of ImageDetail objects that contain data about the image.
 


nextToken
String nextToken

 The nextToken value to include in a future DescribeImages request. When the results of
 a DescribeImages 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.DescribeRepositoriesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repositories to be described. If you do not
 specify a registry, the default registry is assumed.
 


repositoryNames
List<E> repositoryNames

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


nextToken
String nextToken

 The nextToken value returned from a previous paginated DescribeRepositories request
 where maxResults was used and the results exceeded the value of that parameter. Pagination continues
 from the end of the previous results that returned the nextToken value. This value is
 null when there are no more results to return. This option cannot be used when you specify
 repositories with repositoryNames.
 
 
 
 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.
 
 


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 1000. If this parameter is not used, then
 DescribeRepositories returns up to 100 results and a nextToken value, if applicable.
 This option cannot be used when you specify repositories with repositoryNames.
 








Class com.amazonaws.services.ecr.model.DescribeRepositoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


repositories
List<E> repositories

 A list of repository objects corresponding to valid repositories.
 


nextToken
String nextToken

 The nextToken value to include in a future DescribeRepositories request. When the
 results of a DescribeRepositories request exceed maxResults, this value can be used to
 retrieve the next page of results. This value is null when there are no more results to return.
 








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

serialVersionUID:
1L





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


Serialized Fields


registryIds
List<E> registryIds

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








Class com.amazonaws.services.ecr.model.GetAuthorizationTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


authorizationData
List<E> authorizationData

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








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the image layer to download. If you do not specify
 a registry, the default registry is assumed.
 


repositoryName
String repositoryName

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


layerDigest
String layerDigest

 The digest of the image layer to download.
 








Class com.amazonaws.services.ecr.model.GetDownloadUrlForLayerResult extends AmazonWebServiceResult<ResponseMetadata> 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.GetLifecyclePolicyPreviewRequest 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.
 


imageIds
List<E> imageIds

 The list of imageIDs to be included.
 


nextToken
String nextToken

 The nextToken value returned from a previous paginated 
 GetLifecyclePolicyPreviewRequest 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 option cannot be used when you specify images with imageIds.
 


maxResults
Integer maxResults

 The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in 
 paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest 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
 GetLifecyclePolicyPreviewRequest request with the returned nextToken  value.
 This value can be between 1 and 1000. If this  parameter is not used, then
 GetLifecyclePolicyPreviewRequest returns up to  100 results and a nextToken
 value, if  applicable. This option cannot be used when you specify images with imageIds.
 


filter
LifecyclePolicyPreviewFilter filter

 An optional parameter that filters results based on image tag status and all tags, if tagged.
 








Class com.amazonaws.services.ecr.model.GetLifecyclePolicyPreviewResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


lifecyclePolicyText
String lifecyclePolicyText

 The JSON lifecycle policy text.
 


status
String status

 The status of the lifecycle policy preview request.
 


nextToken
String nextToken

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


previewResults
List<E> previewResults

 The results of the lifecycle policy preview request.
 


summary
LifecyclePolicyPreviewSummary summary

 The list of images that is returned as a result of the action.
 








Class com.amazonaws.services.ecr.model.GetLifecyclePolicyRequest 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.
 








Class com.amazonaws.services.ecr.model.GetLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


lifecyclePolicyText
String lifecyclePolicyText

 The JSON lifecycle policy text.
 


lastEvaluatedAt
Date lastEvaluatedAt

 The time stamp of the last time that the lifecycle policy was run.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository. If you do not specify a registry,
 the default registry is assumed.
 


repositoryName
String repositoryName

 The name of the repository with the policy to retrieve.
 








Class com.amazonaws.services.ecr.model.GetRepositoryPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


policyText
String policyText

 The JSON repository policy text associated with the repository.
 








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


Serialized Fields


registryId
String registryId

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


repositoryName
String repositoryName

 The name of the repository associated with the image.
 


imageId
ImageIdentifier imageId

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


imageManifest
String imageManifest

 The image manifest associated with the image.
 








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

serialVersionUID:
1L





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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry to which this image belongs.
 


repositoryName
String repositoryName

 The name of the repository to which this image belongs.
 


imageDigest
String imageDigest

 The sha256 digest of the image manifest.
 


imageTags
List<E> imageTags

 The list of tags associated with this image.
 


imageSizeInBytes
Long imageSizeInBytes

 The size, in bytes, of the image in the repository.
 
 
 
 Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker
 registry. The output of the docker images command shows the uncompressed image size, so it may
 return a larger image size than the image sizes returned by DescribeImages.
 
 


imagePushedAt
Date imagePushedAt

 The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the
 repository.
 


imageScanStatus
ImageScanStatus imageScanStatus

 The current state of the scan.
 


imageScanFindingsSummary
ImageScanFindingsSummary imageScanFindingsSummary

 A summary of the last completed image scan.
 








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


Serialized Fields


imageId
ImageIdentifier imageId

 The image ID associated with the failure.
 


failureCode
String failureCode

 The code associated with the failure.
 


failureReason
String failureReason

 The reason for the failure.
 








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


Serialized Fields


imageDigest
String imageDigest

 The sha256 digest of the image manifest.
 


imageTag
String imageTag

 The tag used for the image.
 








Class com.amazonaws.services.ecr.model.ImageNotFoundException extends AmazonECRException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


name
String name

 The name associated with the finding, usually a CVE number.
 


description
String description

 The description of the finding.
 


uri
String uri

 A link containing additional details about the security vulnerability.
 


severity
String severity

 The finding severity.
 


attributes
List<E> attributes

 A collection of attributes of the host from which the finding is generated.
 








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


Serialized Fields


imageScanCompletedAt
Date imageScanCompletedAt

 The time of the last completed image scan.
 


vulnerabilitySourceUpdatedAt
Date vulnerabilitySourceUpdatedAt

 The time when the vulnerability data was last scanned.
 


findings
List<E> findings

 The findings from the image scan.
 


findingSeverityCounts
Map<K,V> findingSeverityCounts

 The image vulnerability counts, sorted by severity.
 








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


Serialized Fields


imageScanCompletedAt
Date imageScanCompletedAt

 The time of the last completed image scan.
 


vulnerabilitySourceUpdatedAt
Date vulnerabilitySourceUpdatedAt

 The time when the vulnerability data was last scanned.
 


findingSeverityCounts
Map<K,V> findingSeverityCounts

 The image vulnerability counts, sorted by severity.
 








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


Serialized Fields


scanOnPush
Boolean scanOnPush

 The setting that determines whether images are scanned after being pushed to a repository. If set to
 true, images will be scanned after being pushed. If this parameter is not specified, it will default
 to false and images will not be scanned unless a scan is manually started with the
 StartImageScan API.
 








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


Serialized Fields


status
String status

 The current state of an image scan.
 


description
String description

 The description of the image scan status.
 








Class com.amazonaws.services.ecr.model.ImageTagAlreadyExistsException extends AmazonECRException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


registryId
String registryId

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


repositoryName
String repositoryName

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








Class com.amazonaws.services.ecr.model.InitiateLayerUploadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uploadId
String uploadId

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


partSize
Long partSize

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








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

serialVersionUID:
1L





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

serialVersionUID:
1L



Serialized Fields


registryId
String registryId

 The registry ID associated with the exception.
 


repositoryName
String repositoryName

 The repository name associated with the exception.
 


uploadId
String uploadId

 The upload ID associated with the exception.
 


lastValidByteReceived
Long lastValidByteReceived

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








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

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.InvalidTagParameterException extends AmazonECRException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


layerDigest
String layerDigest

 The sha256 digest of the image layer.
 


layerAvailability
String layerAvailability

 The availability status of the image layer.
 


layerSize
Long layerSize

 The size, in bytes, of the image layer.
 


mediaType
String mediaType

 The media type of the layer, such as application/vnd.docker.image.rootfs.diff.tar.gzip or
 application/vnd.oci.image.layer.v1.tar+gzip.
 








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

serialVersionUID:
1L





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


Serialized Fields


layerDigest
String layerDigest

 The layer digest associated with the failure.
 


failureCode
String failureCode

 The failure code associated with the failure.
 


failureReason
String failureReason

 The reason for the failure.
 








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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.LifecyclePolicyNotFoundException extends AmazonECRException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


tagStatus
String tagStatus

 The tag status of the image.
 








Class com.amazonaws.services.ecr.model.LifecyclePolicyPreviewInProgressException extends AmazonECRException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.LifecyclePolicyPreviewNotFoundException extends AmazonECRException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


imageTags
List<E> imageTags

 The list of tags associated with this image.
 


imageDigest
String imageDigest

 The sha256 digest of the image manifest.
 


imagePushedAt
Date imagePushedAt

 The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the
 repository.
 


action
LifecyclePolicyRuleAction action

 The type of action to be taken.
 


appliedRulePriority
Integer appliedRulePriority

 The priority of the applied rule.
 








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


Serialized Fields


expiringImageTotalCount
Integer expiringImageTotalCount

 The number of expiring images.
 








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


Serialized Fields


type
String type

 The type of action to be taken.
 








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

serialVersionUID:
1L





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


Serialized Fields


tagStatus
String tagStatus

 The tag status with which to filter your ListImages results. You can filter results based on whether they
 are TAGGED or UNTAGGED.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository in which to list images. If you do
 not specify a registry, the default registry is assumed.
 


repositoryName
String repositoryName

 The repository with image IDs to be listed.
 


nextToken
String nextToken

 The nextToken value returned from a previous paginated ListImages request where
 maxResults was used and the results exceeded the value of that parameter. Pagination continues from
 the end of the previous results that returned the nextToken value. This value is null
 when there are no more results to return.
 
 
 
 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.
 
 


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 1000. If this parameter is not used, then ListImages returns up to 100 results and a
 nextToken value, if applicable.
 


filter
ListImagesFilter filter

 The filter key and value with which to filter your ListImages results.
 








Class com.amazonaws.services.ecr.model.ListImagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


imageIds
List<E> imageIds

 The list of image IDs for the requested repository.
 


nextToken
String nextToken

 The nextToken value to include in a future ListImages request. When the results of a
 ListImages request exceed maxResults, this value can be used to retrieve the next page
 of results. This value is null when there are no more results to return.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the only
 supported resource is an Amazon ECR repository.
 








Class com.amazonaws.services.ecr.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The tags for the resource.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository in which to put the image. If you do
 not specify a registry, the default registry is assumed.
 


repositoryName
String repositoryName

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


imageManifest
String imageManifest

 The image manifest corresponding to the image to be uploaded.
 


imageTag
String imageTag

 The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2
 Schema 2 or OCI formats.
 








Class com.amazonaws.services.ecr.model.PutImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


image
Image image

 Details of the image uploaded.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository in which to update the image
 scanning configuration setting. If you do not specify a registry, the default registry is assumed.
 


repositoryName
String repositoryName

 The name of the repository in which to update the image scanning configuration setting.
 


imageScanningConfiguration
ImageScanningConfiguration imageScanningConfiguration

 The image scanning configuration for the repository. This setting determines whether images are scanned for known
 vulnerabilities after being pushed to the repository.
 








Class com.amazonaws.services.ecr.model.PutImageScanningConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


imageScanningConfiguration
ImageScanningConfiguration imageScanningConfiguration

 The image scanning configuration setting for the repository.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository in which to update the image tag
 mutability settings. If you do not specify a registry, the default registry is assumed.
 


repositoryName
String repositoryName

 The name of the repository in which to update the image tag mutability settings.
 


imageTagMutability
String imageTagMutability

 The tag mutability setting for the repository. If MUTABLE is specified, image tags can be
 overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which
 will prevent them from being overwritten.
 








Class com.amazonaws.services.ecr.model.PutImageTagMutabilityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


imageTagMutability
String imageTagMutability

 The image tag mutability setting for the repository.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository. If you do  not specify a
 registry, the default registry is assumed.
 


repositoryName
String repositoryName

 The name of the repository to receive the policy.
 


lifecyclePolicyText
String lifecyclePolicyText

 The JSON repository policy text to apply to the repository.
 








Class com.amazonaws.services.ecr.model.PutLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


lifecyclePolicyText
String lifecyclePolicyText

 The JSON repository policy text.
 








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


Serialized Fields


repositoryArn
String repositoryArn

 The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr
 namespace, followed by the region of the repository, AWS account ID of the repository owner, repository
 namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test.
 


registryId
String registryId

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


repositoryName
String repositoryName

 The name of the repository.
 


repositoryUri
String repositoryUri

 The URI for the repository. You can use this URI for Docker push or pull operations.
 


createdAt
Date createdAt

 The date and time, in JavaScript date format, when the repository was created.
 


imageTagMutability
String imageTagMutability

 The tag mutability setting for the repository.
 


imageScanningConfiguration
ImageScanningConfiguration imageScanningConfiguration








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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.ScanNotFoundException extends AmazonECRException implements Serializable

serialVersionUID:
1L





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

serialVersionUID:
1L





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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository. If you do not specify a registry,
 the default registry is assumed.
 


repositoryName
String repositoryName

 The name of the repository to receive the policy.
 


policyText
String policyText

 The JSON repository policy text to apply to the repository. For more information, see Amazon ECR Repository
 Policy Examples in the Amazon Elastic Container Registry User Guide.
 


force
Boolean force

 If the policy you are attempting to set on a repository policy would prevent you from setting another policy in
 the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental
 repository lock outs.
 








Class com.amazonaws.services.ecr.model.SetRepositoryPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


policyText
String policyText

 The JSON repository policy text applied to the repository.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository in which to start an image scan
 request. If you do not specify a registry, the default registry is assumed.
 


repositoryName
String repositoryName

 The name of the repository that contains the images to scan.
 


imageId
ImageIdentifier imageId








Class com.amazonaws.services.ecr.model.StartImageScanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


imageId
ImageIdentifier imageId


imageScanStatus
ImageScanStatus imageScanStatus

 The current state of the scan.
 








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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that contains the repository. If you do not specify a registry,
 the default registry is assumed.
 


repositoryName
String repositoryName

 The name of the repository to be evaluated.
 


lifecyclePolicyText
String lifecyclePolicyText

 The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is
 used.
 








Class com.amazonaws.services.ecr.model.StartLifecyclePolicyPreviewResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


lifecyclePolicyText
String lifecyclePolicyText

 The JSON repository policy text.
 


status
String status

 The status of the lifecycle policy preview request.
 








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


Serialized Fields


key
String key

 One part of a key-value pair that make up a tag. A key is a general label that acts like a category
 for more specific tag values.
 


value
String value

 The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag
 category (key).
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource
 is an Amazon ECR repository.
 


tags
List<E> tags

 The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character
 length of 128 characters, and tag values can have a maximum length of 256 characters.
 








Class com.amazonaws.services.ecr.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ecr.model.TooManyTagsException extends AmazonECRException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource
 is an Amazon ECR repository.
 


tagKeys
List<E> tagKeys

 The keys of the tags to be removed.
 








Class com.amazonaws.services.ecr.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry to which you are uploading layer parts. If you do not specify a
 registry, the default registry is assumed.
 


repositoryName
String repositoryName

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


uploadId
String uploadId

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


partFirstByte
Long partFirstByte

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


partLastByte
Long partLastByte

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


layerPartBlob
ByteBuffer layerPartBlob

 The base64-encoded layer part payload.
 








Class com.amazonaws.services.ecr.model.UploadLayerPartResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


uploadId
String uploadId

 The upload ID associated with the request.
 


lastByteReceived
Long lastByteReceived

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








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

serialVersionUID:
1L





Package com.amazonaws.services.ecs.model




Class com.amazonaws.services.ecs.model.AccessDeniedException extends AmazonECSException implements Serializable

serialVersionUID:
1L





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

serialVersionUID:
1L





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


Serialized Fields


id
String id

 The unique identifier for the attachment.
 


type
String type

 The type of the attachment, such as ElasticNetworkInterface.
 


status
String status

 The status of the attachment. Valid values are PRECREATED, CREATED,
 ATTACHING, ATTACHED, DETACHING, DETACHED, and
 DELETED.
 


details
SdkInternalList<T> details

 Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC
 address, the subnet ID, and the private IPv4 address.
 








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


Serialized Fields


attachmentArn
String attachmentArn

 The Amazon Resource Name (ARN) of the attachment.
 


status
String status

 The status of the attachment.
 








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


Serialized Fields


name
String name

 The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and
 periods are allowed.
 


value
String value

 The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods,
 at signs (@), forward slashes, colons, and spaces are allowed.
 


targetType
String targetType

 The type of the target with which to attach the attribute. This parameter is required if you use the short form
 ID for a resource instead of the full ARN.
 


targetId
String targetId

 The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
 








Class com.amazonaws.services.ecs.model.AttributeLimitExceededException extends AmazonECSException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


autoScalingGroupArn
String autoScalingGroupArn

 The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
 


managedScaling
ManagedScaling managedScaling

 The managed scaling settings for the Auto Scaling group capacity provider.
 


managedTerminationProtection
String managedTerminationProtection

 The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines
 whether the Auto Scaling group has managed termination protection.
 
 
 
 When using managed termination protection, managed scaling must also be used otherwise managed termination
 protection will not work.
 
 
 
 When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling
 group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance
 in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more
 information, see Instance Protection in the AWS Auto Scaling User Guide.
 
 
 When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination
 when the Auto Scaling group scales in.
 








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


Serialized Fields


subnets
SdkInternalList<T> subnets

 The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per
 AwsVpcConfiguration.
 
 
 
 All specified subnets must be from the same VPC.
 
 


securityGroups
SdkInternalList<T> securityGroups

 The security groups associated with the task or service. If you do not specify a security group, the default
 security group for the VPC is used. There is a limit of 5 security groups that can be specified per
 AwsVpcConfiguration.
 
 
 
 All specified security groups must be from the same VPC.
 
 


assignPublicIp
String assignPublicIp

 Whether the task's elastic network interface receives a public IP address. The default value is
 DISABLED.
 








Class com.amazonaws.services.ecs.model.BlockedException extends AmazonECSException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


capacityProviderArn
String capacityProviderArn

 The Amazon Resource Name (ARN) that identifies the capacity provider.
 


name
String name

 The name of the capacity provider.
 


status
String status

 The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used
 in a cluster.
 


autoScalingGroupProvider
AutoScalingGroupProvider autoScalingGroupProvider

 The Auto Scaling group settings for the capacity provider.
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of
 a key and an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 








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


Serialized Fields


capacityProvider
String capacityProvider

 The short name or full Amazon Resource Name (ARN) of the capacity provider.
 


weight
Integer weight

 The weight value designates the relative percentage of the total number of tasks launched that should use
 the specified capacity provider.
 
 
 For example, if you have a strategy that contains two capacity providers and both have a weight of 1
 , then when the base is satisfied, the tasks will be split evenly across the two capacity providers.
 Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of
 4 for capacityProviderB, then for every one task that is run using capacityProviderA,
 four tasks would use capacityProviderB.
 


base
Integer base

 The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only
 one capacity provider in a capacity provider strategy can have a base defined.
 








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

serialVersionUID:
1L





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


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs
 namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the
 cluster namespace, and then the cluster name. For example,
 arn:aws:ecs:region:012345678910:cluster/test.
 


clusterName
String clusterName

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


status
String status

 The status of the cluster. The following are the possible states that will be returned.
 
 
 ACTIVE
 
 
 The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
 
 
 PROVISIONING
 
 
 The cluster has capacity providers associated with it and the resources needed for the capacity provider are
 being created.
 
 
 DEPROVISIONING
 
 
 The cluster has capacity providers associated with it and the resources needed for the capacity provider are
 being deleted.
 
 
 FAILED
 
 
 The cluster has capacity providers associated with it and the resources needed for the capacity provider have
 failed to create.
 
 
 INACTIVE
 
 
 The cluster has been deleted. Clusters with an INACTIVE status may remain discoverable in your
 account for a period of time. However, this behavior is subject to change in the future, so you should not rely
 on INACTIVE clusters persisting.
 
 
 


registeredContainerInstancesCount
Integer registeredContainerInstancesCount

 The number of container instances registered into the cluster. This includes container instances in both
 ACTIVE and DRAINING status.
 


runningTasksCount
Integer runningTasksCount

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


pendingTasksCount
Integer pendingTasksCount

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


activeServicesCount
Integer activeServicesCount

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


statistics
SdkInternalList<T> statistics

 Additional information about your clusters that are separated by launch type, including:
 
 
 
 
 runningEC2TasksCount
 
 
 
 
 RunningFargateTasksCount
 
 
 
 
 pendingEC2TasksCount
 
 
 
 
 pendingFargateTasksCount
 
 
 
 
 activeEC2ServiceCount
 
 
 
 
 activeFargateServiceCount
 
 
 
 
 drainingEC2ServiceCount
 
 
 
 
 drainingFargateServiceCount
 
 
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key
 and an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 


settings
SdkInternalList<T> settings

 The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or
 disabled for a cluster.
 


capacityProviders
SdkInternalList<T> capacityProviders

 The capacity providers associated with the cluster.
 


defaultCapacityProviderStrategy
SdkInternalList<T> defaultCapacityProviderStrategy

 The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no
 launch type or capacity provider strategy specified, the default capacity provider strategy is used.
 


attachments
SdkInternalList<T> attachments

 The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is
 created will be returned as a cluster attachment.
 


attachmentsStatus
String attachmentsStatus

 The status of the capacity providers associated with the cluster. The following are the states that will be
 returned:
 
 
 UPDATE_IN_PROGRESS
 
 
 The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is
 provisioning or deprovisioning.
 
 
 UPDATE_COMPLETE
 
 
 The capacity providers have successfully updated.
 
 
 UPDATE_FAILED
 
 
 The capacity provider updates failed.
 
 
 








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

serialVersionUID:
1L





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

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.ClusterContainsTasksException extends AmazonECSException implements Serializable

serialVersionUID:
1L





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

serialVersionUID:
1L





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


Serialized Fields


name
String name

 The name of the cluster setting. The only supported value is containerInsights.
 


value
String value

 The value to set for the cluster setting. The supported values are enabled and disabled
 . If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise
 it will be disabled unless the containerInsights account setting is enabled. If a cluster value is
 specified, it will override the containerInsights value set with PutAccountSetting or
 PutAccountSettingDefault.
 








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


Serialized Fields


containerArn
String containerArn

 The Amazon Resource Name (ARN) of the container.
 


taskArn
String taskArn

 The ARN of the task.
 


name
String name

 The name of the container.
 


image
String image

 The image used for the container.
 


imageDigest
String imageDigest

 The container image manifest digest.
 
 
 
 The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise
 it is omitted.
 
 


runtimeId
String runtimeId

 The ID of the Docker container.
 


lastStatus
String lastStatus

 The last known status of the container.
 


exitCode
Integer exitCode

 The exit code returned from the container.
 


reason
String reason

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


networkBindings
SdkInternalList<T> networkBindings

 The network bindings associated with the container.
 


networkInterfaces
SdkInternalList<T> networkInterfaces

 The network interfaces associated with the container.
 


healthStatus
String healthStatus

 The health status of the container. If health checks are not configured for this container in its task
 definition, then it reports the health status as UNKNOWN.
 


cpu
String cpu

 The number of CPU units set for the container. The value will be 0 if no value was specified in the
 container definition when the task definition was registered.
 


memory
String memory

 The hard limit (in MiB) of memory set for the container.
 


memoryReservation
String memoryReservation

 The soft limit (in MiB) of memory set for the container.
 


gpuIds
SdkInternalList<T> gpuIds

 The IDs of each GPU assigned to the container.
 








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


Serialized Fields


name
String name

 The name of a container. If you are linking multiple containers together in a task definition, the
 name of one container can be entered in the links of another container to connect the
 containers. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This parameter maps to
 name in the Create a
 container section of the Docker Remote API and the
 --name option to docker run.
 


image
String image

 The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker
 Hub registry are available by default. Other repositories are specified with either
  repository-url/image:tag  or
  repository-url/image@digest . 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.
 
 
 
 
 When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag
 for the container to use. However, subsequent updates to a repository image are not propagated to already running
 tasks.
 
 
 
 
 Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag
 or registry/repository@digest. For example,
 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or
 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
 .
 
 
 
 
 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).
 
 
 


repositoryCredentials
RepositoryCredentials repositoryCredentials

 The private repository authentication credentials to use.
 


cpu
Integer cpu

 The number of cpu units reserved for the container. This parameter maps to CpuShares in
 the Create a container section
 of the Docker Remote API and the
 --cpu-shares option to docker run.
 
 
 This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount
 of CPU reserved for all containers within a task be lower than the task-level cpu value.
 
 
 
 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.
 
 
 
 Linux containers share unallocated CPU units with other containers on the container instance with the same ratio
 as their allocated amount. For example, if you run a single-container task on a single-core instance type with
 512 CPU units specified for that container, and that is the only task running on the container instance, that
 container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the
 same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and
 each container could float to higher CPU usage if the other container was not using it, but if both tasks were
 100% active all of the time, they would be limited to 512 CPU units.
 
 
 On Linux container instances, 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 two 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.
 
 
 
 
 On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers
 only have access to the specified amount of CPU that is described in the task definition.
 


memory
Integer memory

 The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory
 specified here, the container is killed. The total amount of memory reserved for all containers within a task
 must be lower than the task memory value, if one is specified. This parameter maps to
 Memory in the Create a
 container section of the Docker Remote API and the
 --memory option to docker run.
 
 
 If using the Fargate launch type, this parameter is optional.
 
 
 If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory
 value. If you specify both a container-level memory and memoryReservation value,
 memory must be greater than memoryReservation. If you specify
 memoryReservation, then that value is subtracted from the available memory resources for the
 container instance on which the container is placed. Otherwise, the value of memory is used.
 
 
 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.
 


memoryReservation
Integer memoryReservation

 The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention,
 Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory
 when it needs to, up to either the hard limit specified with the memory parameter (if applicable),
 or all of the available memory on the container instance, whichever comes first. This parameter maps to
 MemoryReservation in the Create a container section of the
 Docker Remote API and the
 --memory-reservation option to docker
 run.
 
 
 If a task-level memory value is not specified, you must specify a non-zero integer for one or both of
 memory or memoryReservation in a container definition. If you specify both,
 memory must be greater than memoryReservation. If you specify
 memoryReservation, then that value is subtracted from the available memory resources for the
 container instance on which the container is placed. Otherwise, the value of memory is used.
 
 
 For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for
 short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard
 limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the
 remaining resources on the container instance, but also allow the container to consume more memory resources when
 needed.
 
 
 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.
 


links
SdkInternalList<T> links

 The links parameter allows containers to communicate with each other without the need for port
 mappings. This parameter is only supported if the network mode of a task definition is bridge. The
 name:internalName construct is analogous to name:alias in Docker links. Up to 255
 letters (uppercase and lowercase), numbers, and hyphens are allowed. For more information about linking Docker
 containers, go to Legacy container links in the Docker
 documentation. This parameter maps to Links in the Create a container section of the
 Docker Remote API and the --link option to
 docker run.
 
 
 
 This parameter is not supported for Windows containers.
 
  
 
 Containers that are collocated on a single container instance may be able to communicate with each other without
 requiring links or host port mappings. Network isolation is achieved on the container instance using security
 groups and VPC settings.
 
 


portMappings
SdkInternalList<T> portMappings

 The list of port mappings for the container. Port mappings allow containers to access ports on the host container
 instance to send or receive traffic.
 
 
 For task definitions that use the awsvpc network mode, you should only specify the
 containerPort. The hostPort can be left blank or it must be the same value as the
 containerPort.
 
 
 Port mappings on Windows use the NetNAT gateway address rather than localhost. There is
 no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.
 
 
 This parameter maps to PortBindings in the Create a container section of the
 Docker Remote API and the --publish option
 to docker run. If the network mode of a task
 definition is set to none, then you can't specify port mappings. If the network mode of a task
 definition is set to host, then host ports must either be undefined or they must match the container
 port in the port mapping.
 
 
 
 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 for a selected task in the Amazon
 ECS console. The assignments are also visible in the networkBindings section DescribeTasks
 responses.
 
 


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 Elastic Container Service Developer Guide.
 


entryPoint
SdkInternalList<T> entryPoint

 
 Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If
 you have problems using entryPoint, update your container agent or enter your commands and arguments
 as command array items instead.
 
 
 
 The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the
 Docker Remote API and the --entrypoint
 option to docker run. For more information, see https://docs.docker.com/engine/reference/builder
 /#entrypoint.
 


command
SdkInternalList<T> command

 The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the
 Docker Remote API and the COMMAND parameter
 to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should
 be a separated string in the array.
 


environment
SdkInternalList<T> environment

 The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the
 Docker Remote API and the --env option to docker run.
 
 
 
 We do not recommend using plaintext environment variables for sensitive information, such as credential data.
 
 


mountPoints
SdkInternalList<T> mountPoints

 The mount points for data volumes in your container.
 
 
 This parameter maps to Volumes in the Create a container section of the
 Docker Remote API and the --volume option to
 docker run.
 
 
 Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows
 containers cannot mount directories on a different drive, and mount point cannot be across drives.
 


volumesFrom
SdkInternalList<T> volumesFrom

 Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the
 Docker Remote API and the --volumes-from
 option to docker run.
 


linuxParameters
LinuxParameters linuxParameters

 Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more
 information see KernelCapabilities.
 
 
 
 This parameter is not supported for Windows containers.
 
 


secrets
SdkInternalList<T> secrets

 The secrets to pass to the container. For more information, see Specifying
 Sensitive Data in the Amazon Elastic Container Service Developer Guide.
 


dependsOn
SdkInternalList<T> dependsOn

 The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When
 a dependency is defined for container startup, for container shutdown it is reversed.
 
 
 For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container
 agent to enable container dependencies. However, we recommend using the latest container agent version. For
 information about checking your agent version and updating to the latest version, see Updating the Amazon ECS
 Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon
 ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If
 your container instances are launched from version 20190301 or later, then they contain the required
 versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized
 Linux AMI in the Amazon Elastic Container Service Developer Guide.
 
 
 For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or
 later.
 


startTimeout
Integer startTimeout

 Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you
 specify two containers in a task definition with containerA having a dependency on containerB reaching a
 COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value
 is specified for containerB and it does not reach the desired status within that time then containerA will give
 up and not start. This results in the task transitioning to a STOPPED state.
 
 
 For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container
 agent to enable a container start timeout value. However, we recommend using the latest container agent version.
 For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS
 Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon
 ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If
 your container instances are launched from version 20190301 or later, then they contain the required
 versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized
 Linux AMI in the Amazon Elastic Container Service Developer Guide.
 
 
 For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or
 later.
 


stopTimeout
Integer stopTimeout

 Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its
 own.
 
 
 For tasks using the Fargate launch type, the max stopTimeout value is 2 minutes and the task or
 service requires platform version 1.3.0 or later.
 
 
 For tasks using the EC2 launch type, the stop timeout value for the container takes precedence over the
 ECS_CONTAINER_STOP_TIMEOUT container agent configuration parameter, if used. Container instances
 require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we
 recommend using the latest container agent version. For information about checking your agent version and
 updating to the latest version, see Updating the Amazon ECS
 Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon
 ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If
 your container instances are launched from version 20190301 or later, then they contain the required
 versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized
 Linux AMI in the Amazon Elastic Container Service Developer Guide.
 


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.
 
 
 
 The hostname parameter is not supported if you are using the awsvpc network mode.
 
 


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.
 
 
 You can use the following formats. If specifying a UID or GID, you must specify it as a positive integer.
 
 
 
 
 user
 
 
 
 
 user:group
 
 
 
 
 uid
 
 
 
 
 uid:gid
 
 
 
 
 user:gid
 
 
 
 
 uid:group
 
 
 
 
 
 This parameter is not supported for Windows containers.
 
 


workingDirectory
String workingDirectory

 The working directory in which to run commands inside the container. This parameter maps to
 WorkingDir in the Create a container section of the
 Docker Remote API and the --workdir option
 to docker run.
 


disableNetworking
Boolean disableNetworking

 When this parameter is true, networking is disabled within the container. This parameter maps to
 NetworkDisabled in the Create a container section of the
 Docker Remote API.
 
 
 
 This parameter is not supported for Windows containers.
 
 


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.
 
 
 
 This parameter is not supported for Windows containers or tasks using the Fargate launch type.
 
 


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.
 
 
 
 This parameter is not supported for Windows containers.
 
 


dnsServers
SdkInternalList<T> dnsServers

 A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the
 Docker Remote API and the --dns option to docker run.
 
 
 
 This parameter is not supported for Windows containers.
 
 


dnsSearchDomains
SdkInternalList<T> dnsSearchDomains

 A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch
 in the Create a container
 section of the Docker Remote API and the
 --dns-search option to docker run.
 
 
 
 This parameter is not supported for Windows containers.
 
 


extraHosts
SdkInternalList<T> extraHosts

 A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This
 parameter maps to ExtraHosts in the Create a container section of the
 Docker Remote API and the --add-host option
 to docker run.
 
 
 
 This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
 
 


dockerSecurityOptions
SdkInternalList<T> dockerSecurityOptions

 A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is
 not valid for containers in tasks using the Fargate launch type.
 
 
 With Windows containers, this parameter can be used to reference a credential spec file when configuring a
 container for Active Directory authentication. For more information, see Using gMSAs for Windows
 Containers in the Amazon Elastic Container Service Developer Guide.
 
 
 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 Elastic Container Service Developer Guide.
 
 


interactive
Boolean interactive

 When this parameter is true, this allows you to deploy containerized applications that require
 stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the
 Docker Remote API and the --interactive
 option to docker run.
 


pseudoTerminal
Boolean pseudoTerminal

 When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the
 Docker Remote API and the --tty option to docker run.
 


dockerLabels
Map<K,V> dockerLabels

 A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the
 Docker Remote API and the --label option to
 docker run. This parameter requires version 1.18 of
 the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your
 container instance, log in to your container instance and run the following command:
 sudo docker version --format '{{.Server.APIVersion}}'
 


ulimits
SdkInternalList<T> ulimits

 A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the
 Docker Remote API and the --ulimit option to
 docker run. Valid naming values are displayed in the
 Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your
 container instance. To check the Docker Remote API version on your container instance, log in to your container
 instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
 
 
 
 This parameter is not supported for Windows containers.
 
 


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). Additional 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 in to your container instance and run the following
 command: sudo docker version --format '{{.Server.APIVersion}}'
 
 
 
 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 Elastic Container Service Developer Guide.
 
 


healthCheck
HealthCheck healthCheck

 The health check command and associated configuration parameters for the container. This parameter maps to
 HealthCheck in the Create a container section of the
 Docker Remote API and the HEALTHCHECK
 parameter of docker run.
 


systemControls
SdkInternalList<T> systemControls

 A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in
 the Create a container section
 of the Docker Remote API and the --sysctl
 option to docker run.
 
 
 
 It is not recommended that you specify network-related systemControls parameters for multiple
 containers in a single task that also uses either the awsvpc or host network modes. For
 tasks that use the awsvpc network mode, the container that is started last determines which
 systemControls parameters take effect. For tasks that use the host network mode, it
 changes the container instance's namespaced kernel parameters as well as the containers.
 
 


resourceRequirements
SdkInternalList<T> resourceRequirements

 The type and amount of a resource to assign to a container. The only supported resource is a GPU.
 


firelensConfiguration
FirelensConfiguration firelensConfiguration

 The FireLens configuration for the container. This is used to specify and configure a log router for container
 logs. For more information, see Custom Log Routing in
 the Amazon Elastic Container Service Developer Guide.
 








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


Serialized Fields


containerName
String containerName

 The name of a container.
 


condition
String condition

 The dependency condition of the container. The following are the available conditions and their behavior:
 
 
 
 
 START - This condition emulates the behavior of links and volumes today. It validates that a
 dependent container is started before permitting other containers to start.
 
 
 
 
 COMPLETE - This condition validates that a dependent container runs to completion (exits) before
 permitting other containers to start. This can be useful for nonessential containers that run a script and then
 exit.
 
 
 
 
 SUCCESS - This condition is the same as COMPLETE, but it also requires that the
 container exits with a zero status.
 
 
 
 
 HEALTHY - This condition validates that the dependent container passes its Docker health check
 before permitting other containers to start. This requires that the dependent container has health checks
 configured. This condition is confirmed only at task startup.
 
 
 








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


Serialized Fields


containerInstanceArn
String containerInstanceArn

 The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs
 namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner,
 the container-instance namespace, and then the container instance ID. For example,
 arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
 


ec2InstanceId
String ec2InstanceId

 The EC2 instance ID of the container instance.
 


capacityProviderName
String capacityProviderName

 The capacity provider associated with the container instance.
 


version
Long version

 The version counter for the container instance. Every time a container instance experiences a change that
 triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container
 instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon
 ECS APIs with the version reported in CloudWatch Events for the container instance (inside the
 detail object) to verify that the version in your event stream is current.
 


versionInfo
VersionInfo versionInfo

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


remainingResources
SdkInternalList<T> remainingResources

 For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already
 been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter
 describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any
 task containers that have reserved port mappings on the host (with the host or bridge
 network mode). Any port that is not specified here is available for new tasks.
 


registeredResources
SdkInternalList<T> registeredResources

 For CPU and memory resource types, this parameter describes the amount of each resource that was available on the
 container instance when the container agent registered it with Amazon ECS. This value represents the total amount
 of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this
 parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the
 container instance with Amazon ECS.
 


status
String status

 The status of the container instance. The valid values are REGISTERING,
 REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or
 DRAINING.
 
 
 If your account has opted in to the awsvpcTrunking account setting, then any newly registered
 container instance will transition to a REGISTERING status while the trunk elastic network interface
 is provisioned for the instance. If the registration fails, the instance will transition to a
 REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure
 in the statusReason parameter. Once the container instance is terminated, the instance transitions
 to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance
 then transitions to an INACTIVE status.
 
 
 The ACTIVE status indicates that the container instance can accept tasks. The DRAINING
 indicates that new tasks are not placed on the container instance and any service tasks running on the container
 instance are removed if possible. For more information, see Container
 Instance Draining in the Amazon Elastic Container Service Developer Guide.
 


statusReason
String statusReason

 The reason that the container instance reached its current status.
 


agentConnected
Boolean agentConnected

 This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an
 agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept
 placement requests.
 


runningTasksCount
Integer runningTasksCount

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


pendingTasksCount
Integer pendingTasksCount

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


agentUpdateStatus
String agentUpdateStatus

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


attributes
SdkInternalList<T> attributes

 The attributes set for the container instance, either by the Amazon ECS container agent at instance registration
 or manually with the PutAttributes operation.
 


registeredAt
Date registeredAt

 The Unix timestamp for when the container instance was registered.
 


attachments
SdkInternalList<T> attachments

 The resources attached to a container instance, such as elastic network interfaces.
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists
 of a key and an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 








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


Serialized Fields


name
String name

 The name of the container that receives the override. This parameter is required if any override is specified.
 


command
SdkInternalList<T> command

 The command to send to the container that overrides the default command from the Docker image or the task
 definition. You must also specify a container name.
 


environment
SdkInternalList<T> environment

 The environment variables to send to the container. You can add new environment variables, which are added to the
 container at launch, or you can override the existing environment variables from the Docker image or the task
 definition. You must also specify a container name.
 


cpu
Integer cpu

 The number of cpu units reserved for the container, instead of the default value from the task
 definition. You must also specify a container name.
 


memory
Integer memory

 The hard limit (in MiB) of memory to present to the container, instead of the default value from the task
 definition. If your container attempts to exceed the memory specified here, the container is killed. You must
 also specify a container name.
 


memoryReservation
Integer memoryReservation

 The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task
 definition. You must also specify a container name.
 


resourceRequirements
SdkInternalList<T> resourceRequirements

 The type and amount of a resource to assign to a container, instead of the default value from the task
 definition. The only supported resource is a GPU.
 








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


Serialized Fields


containerName
String containerName

 The name of the container.
 


imageDigest
String imageDigest

 The container image SHA 256 digest.
 


runtimeId
String runtimeId

 The ID of the Docker container.
 


exitCode
Integer exitCode

 The exit code for the container, if the state change is a result of the container exiting.
 


networkBindings
SdkInternalList<T> networkBindings

 Any network bindings associated with the container.
 


reason
String reason

 The reason for the state change.
 


status
String status

 The status of the container.
 








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


Serialized Fields


name
String name

 The name of the capacity provider. Up to 255 characters are allowed, including letters (upper and lowercase),
 numbers, underscores, and hyphens. The name cannot be prefixed with "aws", "ecs", or "
 fargate".
 


autoScalingGroupProvider
AutoScalingGroupProvider autoScalingGroupProvider

 The details of the Auto Scaling group for the capacity provider.
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the capacity provider to help you categorize and organize them. Each tag consists
 of a key and an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 








Class com.amazonaws.services.ecs.model.CreateCapacityProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


capacityProvider
CapacityProvider capacityProvider

 The full description of the new capacity provider.
 








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


Serialized Fields


clusterName
String clusterName

 The name of your cluster. If you do not specify a name for your cluster, you create a cluster named
 default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key
 and an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 


settings
SdkInternalList<T> settings

 The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a
 cluster. If this value is specified, it will override the containerInsights value set with
 PutAccountSetting or PutAccountSettingDefault.
 


capacityProviders
SdkInternalList<T> capacityProviders

 The short name or full Amazon Resource Name (ARN) of one or more capacity providers to associate with the
 cluster.
 
 
 If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created
 and not already associated with another cluster. New capacity providers can be created with the
 CreateCapacityProvider API operation.
 
 
 To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
 capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be
 associated with a cluster to be used.
 
 
 The PutClusterCapacityProviders API operation is used to update the list of available capacity providers
 for a cluster after the cluster is created.
 


defaultCapacityProviderStrategy
SdkInternalList<T> defaultCapacityProviderStrategy

 The capacity provider strategy to use by default for the cluster.
 
 
 When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then
 the default capacity provider strategy for the cluster is used.
 
 
 A capacity provider strategy consists of one or more capacity providers along with the base and
 weight to assign to them. A capacity provider must be associated with the cluster to be used in a
 capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider
 with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
 
 
 If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created.
 New capacity providers can be created with the CreateCapacityProvider API operation.
 
 
 To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
 capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be
 associated with a cluster to be used.
 
 
 If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later
 with the PutClusterCapacityProviders API operation.
 








Class com.amazonaws.services.ecs.model.CreateClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 The full description of your new cluster.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not
 specify a cluster, the default cluster is assumed.
 


serviceName
String serviceName

 The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens 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 ARN of the task
 definition to run in your service. If a revision is not specified, the latest ACTIVE
 revision is used.
 
 
 A task definition must be specified if the service is using the ECS deployment controller.
 


loadBalancers
SdkInternalList<T> loadBalancers

 A load balancer object representing the load balancers to use with your service. For more information, see Service Load
 Balancing in the Amazon Elastic Container Service Developer Guide.
 
 
 If the service is using the rolling update (ECS) deployment controller and using either an
 Application Load Balancer or Network Load Balancer, you can specify multiple target groups to attach to the
 service. The service-linked role is required for services that make use of multiple target groups. For more
 information, see Using
 Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
 
 
 If the service is using the CODE_DEPLOY deployment controller, the service is required to use either
 an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you
 specify two target groups (referred to as a targetGroupPair). During a deployment, AWS CodeDeploy
 determines which task set in your service has the status PRIMARY and associates one target group
 with it, and then associates the other target group with the replacement task set. The load balancer can also
 have up to two listeners: a required listener for production traffic and an optional listener that allows you
 perform validation tests with Lambda functions before routing production traffic to it.
 
 
 After you create a service using the ECS deployment controller, the load balancer name or target
 group ARN, container name, and container port specified in the service definition are immutable. If you are using
 the CODE_DEPLOY deployment controller, these values can be changed when updating the service.
 
 
 For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target
 group ARN, the container name (as it appears in a container definition), and the container port to access from
 the load balancer. When a task from this service is placed on a container instance, the container instance and
 port combination is registered as a target in the target group specified here.
 
 
 For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in
 a container definition), and the container port to access from the load balancer. When a task from this service
 is placed on a container instance, the container instance is registered with the load balancer specified here.
 
 
 Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch
 type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not
 supported. Also, when you create any target groups for these services, you must choose ip as the
 target type, not instance, because tasks that use the awsvpc network mode are
 associated with an elastic network interface, not an Amazon EC2 instance.
 


serviceRegistries
SdkInternalList<T> serviceRegistries

 The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
 
 
 
 Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more
 information, see AWS
 Fargate Platform Versions.
 
 


desiredCount
Integer desiredCount

 The number of instantiations of the specified task definition to place and keep running on your cluster.
 
 
 This is required if schedulingStrategy is REPLICA or is not specified. If
 schedulingStrategy is DAEMON then this is not required.
 


clientToken
String clientToken

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


launchType
String launchType

 The launch type on which to run your service. For more information, see Amazon ECS Launch Types
 in the Amazon Elastic Container Service Developer Guide.
 
 
 If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
 


capacityProviderStrategy
SdkInternalList<T> capacityProviderStrategy

 The capacity provider strategy to use for the service.
 
 
 A capacity provider strategy consists of one or more capacity providers along with the base and
 weight to assign to them. A capacity provider must be associated with the cluster to be used in a
 capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider
 with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
 
 
 If a capacityProviderStrategy is specified, the launchType parameter must be omitted.
 If no capacityProviderStrategy or launchType is specified, the
 defaultCapacityProviderStrategy for the cluster is used.
 
 
 If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created.
 New capacity providers can be created with the CreateCapacityProvider API operation.
 
 
 To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
 capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be
 associated with a cluster to be used.
 
 
 The PutClusterCapacityProviders API operation is used to update the list of available capacity providers
 for a cluster after the cluster is created.
 


platformVersion
String platformVersion

 The platform version that your tasks in the service are running on. A platform version is specified only for
 tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by
 default. For more information, see AWS Fargate Platform
 Versions in the Amazon Elastic Container Service Developer Guide.
 


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 only permitted if you are using a load balancer with your service and
 your task definition does not use the awsvpc network mode. If you specify the role
 parameter, you must also specify a load balancer object with the loadBalancers parameter.
 
 
 
 If your account has already created the Amazon ECS service-linked role, that role is used by default for your
 service unless you specify a role here. The service-linked role is required if your task definition uses the
 awsvpc network mode or if the service is configured to use service discovery, an external deployment
 controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role
 here. For more information, see Using
 Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
 
 
 
 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.
 


deploymentConfiguration
DeploymentConfiguration deploymentConfiguration

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


placementConstraints
SdkInternalList<T> placementConstraints

 An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10
 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
 


placementStrategy
SdkInternalList<T> placementStrategy

 The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules
 per service.
 


networkConfiguration
NetworkConfiguration networkConfiguration

 The network configuration for the service. This parameter is required for task definitions that use the
 awsvpc network mode to receive their own elastic network interface, and it is not supported for
 other network modes. For more information, see Task Networking in
 the Amazon Elastic Container Service Developer Guide.
 


healthCheckGracePeriodSeconds
Integer healthCheckGracePeriodSeconds

 The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load
 Balancing target health checks after a task has first started. This is only valid if your service is configured
 to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing
 health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the
 ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from
 marking tasks as unhealthy and stopping them before they have time to come up.
 


schedulingStrategy
String schedulingStrategy

 The scheduling strategy to use for the service. For more information, see Services.
 
 
 There are two service scheduler strategies available:
 
 
 
 
 REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your
 cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement
 strategies and constraints to customize task placement decisions. This scheduler strategy is required if the
 service is using the CODE_DEPLOY or EXTERNAL deployment controller types.
 
 
 
 
 DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance
 that meets all of the task placement constraints that you specify in your cluster. When you're using this
 strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto
 Scaling policies.
 
 
 
 Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment
 controller types don't support the DAEMON scheduling strategy.
 
 
 


deploymentController
DeploymentController deploymentController

 The deployment controller to use for the service.
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key
 and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 


enableECSManagedTags
Boolean enableECSManagedTags

 Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see
 Tagging Your Amazon ECS
 Resources in the Amazon Elastic Container Service Developer Guide.
 


propagateTags
String propagateTags

 Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If
 no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service
 during service creation. To add tags to a task after service creation, use the TagResource API action.
 








Class com.amazonaws.services.ecs.model.CreateServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


service
Service service

 The full description of your service following the create call.
 
 
 If a service is using the ECS deployment controller, the deploymentController and
 taskSets parameters will not be returned.
 
 
 If the service is using the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the
 deployments parameter will be an empty list.
 








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


Serialized Fields


service
String service

 The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
 


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set
 in.
 


externalId
String externalId

 An optional non-unique tag that identifies this task set in external systems. If the task set is associated with
 a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS
 Cloud Map attribute set to the provided value.
 


taskDefinition
String taskDefinition

 The task definition for the tasks in the task set to use.
 


networkConfiguration
NetworkConfiguration networkConfiguration


loadBalancers
SdkInternalList<T> loadBalancers

 A load balancer object representing the load balancer to use with the task set. The supported load balancer types
 are either an Application Load Balancer or a Network Load Balancer.
 


serviceRegistries
SdkInternalList<T> serviceRegistries

 The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
 


launchType
String launchType

 The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types
 in the Amazon Elastic Container Service Developer Guide.
 
 
 If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
 


capacityProviderStrategy
SdkInternalList<T> capacityProviderStrategy

 The capacity provider strategy to use for the task set.
 
 
 A capacity provider strategy consists of one or more capacity providers along with the base and
 weight to assign to them. A capacity provider must be associated with the cluster to be used in a
 capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider
 with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
 
 
 If a capacityProviderStrategy is specified, the launchType parameter must be omitted.
 If no capacityProviderStrategy or launchType is specified, the
 defaultCapacityProviderStrategy for the cluster is used.
 
 
 If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created.
 New capacity providers can be created with the CreateCapacityProvider API operation.
 
 
 To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
 capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be
 associated with a cluster to be used.
 
 
 The PutClusterCapacityProviders API operation is used to update the list of available capacity providers
 for a cluster after the cluster is created.
 


platformVersion
String platformVersion

 The platform version that the tasks in the task set should use. A platform version is specified only for tasks
 using the Fargate launch type. If one isn't specified, the LATEST platform version is used by
 default.
 


scale
Scale scale


clientToken
String clientToken

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


tags
SdkInternalList<T> tags

 The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key
 and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 








Class com.amazonaws.services.ecs.model.CreateTaskSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskSet
TaskSet taskSet








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


Serialized Fields


name
String name

 The resource name for which to disable the account setting. If serviceLongArnFormat is specified,
 the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and
 resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified,
 the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is
 specified, the ENI limit for your Amazon ECS container instances is affected.
 


principalArn
String principalArn

 The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it
 disables the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or
 role explicitly overrides these settings. If this field is omitted, the setting is changed only for the
 authenticated user.
 








Class com.amazonaws.services.ecs.model.DeleteAccountSettingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


setting
Setting setting

 The account setting for the specified principal ARN.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes.
 If you do not specify a cluster, the default cluster is assumed.
 


attributes
SdkInternalList<T> attributes

 The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom
 attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID
 using the short form, you must also specify the target type.
 








Class com.amazonaws.services.ecs.model.DeleteAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
SdkInternalList<T> attributes

 A list of attribute objects that were successfully deleted from your resource.
 








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


Serialized Fields


cluster
String cluster

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








Class com.amazonaws.services.ecs.model.DeleteClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 The full description of the deleted cluster.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) 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.
 


force
Boolean force

 If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is
 only necessary to use this if the service is using the REPLICA scheduling strategy.
 








Class com.amazonaws.services.ecs.model.DeleteServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


service
Service service

 The full description of the deleted service.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists
 in to delete.
 


service
String service

 The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.
 


taskSet
String taskSet

 The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
 


force
Boolean force

 If true, this allows you to delete a task set even if it hasn't been scaled down to zero.
 








Class com.amazonaws.services.ecs.model.DeleteTaskSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskSet
TaskSet taskSet








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


Serialized Fields


id
String id

 The ID of the deployment.
 


status
String status

 The status of the deployment. The following describes each state:
 
 
 PRIMARY
 
 
 The most recent deployment of a service.
 
 
 ACTIVE
 
 
 A service deployment that still has running tasks, but are in the process of being replaced with a new
 PRIMARY deployment.
 
 
 INACTIVE
 
 
 A deployment that has been completely replaced.
 
 
 


taskDefinition
String taskDefinition

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


desiredCount
Integer desiredCount

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


pendingCount
Integer pendingCount

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


runningCount
Integer runningCount

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


createdAt
Date createdAt

 The Unix timestamp for when the service deployment was created.
 


updatedAt
Date updatedAt

 The Unix timestamp for when the service deployment was last updated.
 


capacityProviderStrategy
SdkInternalList<T> capacityProviderStrategy

 The capacity provider strategy that the deployment is using.
 


launchType
String launchType

 The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types
 in the Amazon Elastic Container Service Developer Guide.
 


platformVersion
String platformVersion

 The platform version on which your tasks in the service are running. A platform version is only specified for
 tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by
 default. For more information, see AWS Fargate Platform
 Versions in the Amazon Elastic Container Service Developer Guide.
 


networkConfiguration
NetworkConfiguration networkConfiguration

 The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
 using the awsvpc networking mode.
 








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


Serialized Fields


maximumPercent
Integer maximumPercent

 If a service is using the rolling update (ECS) deployment type, the maximum percent parameter
 represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or
 PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to
 the nearest integer), and while any container instances are in the DRAINING state if the service
 contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For
 example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler
 may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do
 this are available). The default value for maximum percent is 200%.
 
 
 If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and
 tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to
 define the upper limit on the number of the tasks in the service that remain in the RUNNING state
 while the container instances are in the DRAINING state. If the tasks in the service use the Fargate
 launch type, the maximum percent value is not used, although it is returned when describing your service.
 


minimumHealthyPercent
Integer minimumHealthyPercent

 If a service is using the rolling update (ECS) deployment type, the minimum healthy percent
 represents a lower limit on the number of tasks in a service that must remain in the RUNNING state
 during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and
 while any container instances are in the DRAINING state if the service contains tasks using the EC2
 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your
 service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two
 existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not
 use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that
 do use a load balancer are considered healthy if they are in the RUNNING state and they are
 reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
 
 
 If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and
 tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is
 used to define the lower limit on the number of the tasks in the service that remain in the RUNNING
 state while the container instances are in the DRAINING state. If the tasks in the service use the
 Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your
 service.
 








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


Serialized Fields


type
String type

 The deployment controller type to use.
 
 
 There are three deployment controller types available:
 
 
 ECS
 
 
 The rolling update (ECS) deployment type involves replacing the current running version of the
 container with the latest version. The number of containers Amazon ECS adds or removes from the service during a
 rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a
 service deployment, as specified in the DeploymentConfiguration.
 
 
 CODE_DEPLOY
 
 
 The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by AWS
 CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.
 
 
 EXTERNAL
 
 
 The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for
 full control over the deployment process for an Amazon ECS service.
 
 
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister.
 If you do not specify a cluster, the default cluster is assumed.
 


containerInstance
String containerInstance

 The container instance ID or full 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 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.
 
 
 Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load
 Balancer target group are deregistered. They begin connection draining according to the settings on the load
 balancer or target group.
 








Class com.amazonaws.services.ecs.model.DeregisterContainerInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


containerInstance
ContainerInstance containerInstance

 The container instance that was deregistered.
 








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


Serialized Fields


taskDefinition
String taskDefinition

 The family and revision (family:revision) or full Amazon Resource Name
 (ARN) of the task definition to deregister. You must specify a revision.
 








Class com.amazonaws.services.ecs.model.DeregisterTaskDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskDefinition
TaskDefinition taskDefinition

 The full description of the deregistered task.
 








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


Serialized Fields


capacityProviders
SdkInternalList<T> capacityProviders

 The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100
 capacity providers can be described in an action.
 


include
SdkInternalList<T> include

 Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS is
 specified, the tags are included in the response. If this field is omitted, tags are not included in the
 response.
 


maxResults
Integer maxResults

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


nextToken
String nextToken

 The nextToken value returned from a previous paginated DescribeCapacityProviders
 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 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.DescribeCapacityProvidersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


capacityProviders
SdkInternalList<T> capacityProviders

 The list of capacity providers.
 


failures
SdkInternalList<T> failures

 Any failures associated with the call.
 


nextToken
String nextToken

 The nextToken value to include in a future DescribeCapacityProviders request. When the
 results of a DescribeCapacityProviders 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.DescribeClustersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusters
SdkInternalList<T> clusters

 A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a
 cluster, the default cluster is assumed.
 


include
SdkInternalList<T> include

 Whether to include additional information about your clusters in the response. If this field is omitted, the
 attachments, statistics, and tags are not included.
 
 
 If ATTACHMENTS is specified, the attachments for the container instances or tasks within the cluster
 are included.
 
 
 If SETTINGS is specified, the settings for the cluster are included.
 
 
 If STATISTICS is specified, the following additional information, separated by launch type, is
 included:
 
 
 
 
 runningEC2TasksCount
 
 
 
 
 runningFargateTasksCount
 
 
 
 
 pendingEC2TasksCount
 
 
 
 
 pendingFargateTasksCount
 
 
 
 
 activeEC2ServiceCount
 
 
 
 
 activeFargateServiceCount
 
 
 
 
 drainingEC2ServiceCount
 
 
 
 
 drainingFargateServiceCount
 
 
 
 
 If TAGS is specified, the metadata tags associated with the cluster are included.
 








Class com.amazonaws.services.ecs.model.DescribeClustersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusters
SdkInternalList<T> clusters

 The list of clusters.
 


failures
SdkInternalList<T> failures

 Any failures associated with the call.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe.
 If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container
 instance or container instances you are describing were launched in any cluster other than the default cluster.
 


containerInstances
SdkInternalList<T> containerInstances

 A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
 


include
SdkInternalList<T> include

 Specifies whether you want to see the resource tags for the container instance. If TAGS is
 specified, the tags are included in the response. If this field is omitted, tags are not included in the
 response.
 








Class com.amazonaws.services.ecs.model.DescribeContainerInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


containerInstances
SdkInternalList<T> containerInstances

 The list of container instances.
 


failures
SdkInternalList<T> failures

 Any failures associated with the call.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not
 specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are
 describing were launched in any cluster other than the default cluster.
 


services
SdkInternalList<T> services

 A list of services to describe. You may specify up to 10 services to describe in a single operation.
 


include
SdkInternalList<T> include

 Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags
 are included in the response. If this field is omitted, tags are not included in the response.
 








Class com.amazonaws.services.ecs.model.DescribeServicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


services
SdkInternalList<T> services

 The list of services described.
 


failures
SdkInternalList<T> failures

 Any failures associated with the call.
 








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


Serialized Fields


taskDefinition
String taskDefinition

 The family for the latest ACTIVE revision, family and
 revision (family:revision) for a specific revision in the family, or full Amazon
 Resource Name (ARN) of the task definition to describe.
 


include
SdkInternalList<T> include

 Specifies whether to see the resource tags for the task definition. If TAGS is specified, the tags
 are included in the response. If this field is omitted, tags are not included in the response.
 








Class com.amazonaws.services.ecs.model.DescribeTaskDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskDefinition
TaskDefinition taskDefinition

 The full task definition description.
 


tags
SdkInternalList<T> tags

 The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists
 of a key and an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 








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


Serialized Fields


cluster
String cluster

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


service
String service

 The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.
 


taskSets
SdkInternalList<T> taskSets

 The ID or full Amazon Resource Name (ARN) of task sets to describe.
 


include
SdkInternalList<T> include

 Specifies whether to see the resource tags for the task set. If TAGS is specified, the tags are
 included in the response. If this field is omitted, tags are not included in the response.
 








Class com.amazonaws.services.ecs.model.DescribeTaskSetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskSets
SdkInternalList<T> taskSets

 The list of task sets described.
 


failures
SdkInternalList<T> failures

 Any failures associated with the call.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you
 do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are
 describing were launched in any cluster other than the default cluster.
 


tasks
SdkInternalList<T> tasks

 A list of up to 100 task IDs or full ARN entries.
 


include
SdkInternalList<T> include

 Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are
 included in the response. If this field is omitted, tags are not included in the response.
 








Class com.amazonaws.services.ecs.model.DescribeTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tasks
SdkInternalList<T> tasks

 The list of tasks.
 


failures
SdkInternalList<T> failures

 Any failures associated with the call.
 








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


Serialized Fields


hostPath
String hostPath

 The path for the device on the host container instance.
 


containerPath
String containerPath

 The path inside the container at which to expose the host device.
 


permissions
SdkInternalList<T> permissions

 The explicit permissions to provide to the container for the device. By default, the container has permissions
 for read, write, and mknod for the device.
 








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


Serialized Fields


containerInstance
String containerInstance

 The container instance ID or full ARN of the container instance. The ARN contains the arn:aws:ecs
 namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner,
 the container-instance namespace, and then the container instance ID. For example,
 arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.
 


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs.
 








Class com.amazonaws.services.ecs.model.DiscoverPollEndpointResult extends AmazonWebServiceResult<ResponseMetadata> 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.DockerVolumeConfiguration extends Object implements Serializable


Serialized Fields


scope
String scope

 The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
 task are automatically provisioned when the task starts and destroyed when the task stops. Docker
 volumes that are scoped as shared persist after the task stops.
 


autoprovision
Boolean autoprovision

 If this value is true, the Docker volume is created if it does not already exist.
 
 
 
 This field is only used if the scope is shared.
 
 


driver
String driver

 The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is
 used for task placement. If the driver was installed using the Docker plugin CLI, use
 docker plugin ls to retrieve the driver name from your container instance. If the driver was
 installed using another method, use Docker plugin discovery to retrieve the driver name. For more information,
 see Docker plugin discovery.
 This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.
 


driverOpts
Map<K,V> driverOpts

 A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.
 


labels
Map<K,V> labels

 Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.
 








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


Serialized Fields


fileSystemId
String fileSystemId

 The Amazon EFS file system ID to use.
 


rootDirectory
String rootDirectory

 The directory within the Amazon EFS file system to mount as the root directory inside the host.
 








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


Serialized Fields


arn
String arn

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


reason
String reason

 The reason for the failure.
 


detail
String detail

 The details of the failure.
 








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


Serialized Fields


type
String type

 The log router to use. The valid values are fluentd or fluentbit.
 


options
Map<K,V> options

 The options to use when configuring the log router. This field is optional and can be used to specify a custom
 configuration file or to add additional metadata, such as the task, task definition, cluster, and container
 instance details to the log event. If specified, the syntax to use is
 "options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}
 . For more information, see Creating
 a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer
 Guide.
 








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


Serialized Fields


command
SdkInternalList<T> command

 A string array representing the command that the container runs to determine if it is healthy. The string array
 must start with CMD to execute the command arguments directly, or CMD-SHELL to run the
 command with the container's default shell. For example:
 
 
 [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
 
 
 An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see
 HealthCheck in the Create a container section of the
 Docker Remote API.
 


interval
Integer interval

 The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The
 default value is 30 seconds.
 


timeout
Integer timeout

 The time period in seconds to wait for a health check to succeed before it is considered a failure. You may
 specify between 2 and 60 seconds. The default value is 5.
 


retries
Integer retries

 The number of times to retry a failed health check before the container is considered unhealthy. You may specify
 between 1 and 10 retries. The default value is 3.
 


startPeriod
Integer startPeriod

 The optional grace period within which to provide containers time to bootstrap before failed health checks count
 towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is
 disabled by default.
 
 
 
 If a health check succeeds within the startPeriod, then the container is considered healthy and any
 subsequent failures count toward the maximum number of retries.
 
 








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


Serialized Fields


hostname
String hostname

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


ipAddress
String ipAddress

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








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


Serialized Fields


sourcePath
String sourcePath

 When the host parameter is used, specify a sourcePath to declare 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.
 
 
 If you are using the Fargate launch type, the sourcePath parameter is not supported.
 








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


Serialized Fields


deviceName
String deviceName

 The Elastic Inference accelerator device name. The deviceName must also be referenced in a container
 definition as a ResourceRequirement.
 


deviceType
String deviceType

 The Elastic Inference accelerator type to use.
 








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


Serialized Fields


deviceName
String deviceName

 The Elastic Inference accelerator device name to override for the task. This parameter must match a
 deviceName specified in the task definition.
 


deviceType
String deviceType

 The Elastic Inference accelerator type to use.
 








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

serialVersionUID:
1L





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


Serialized Fields


add
SdkInternalList<T> add

 The Linux capabilities for the container that have been added to the default configuration provided by Docker.
 This parameter maps to CapAdd in the Create a container section of the
 Docker Remote API and the --cap-add option
 to docker run.
 
 
 
 If you are using tasks that use the Fargate launch type, the add parameter is not supported.
 
 
 
 Valid values:
 "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
 


drop
SdkInternalList<T> drop

 The Linux capabilities for the container that have been removed from the default configuration provided by
 Docker. This parameter maps to CapDrop in the Create a container section of the
 Docker Remote API and the --cap-drop option
 to docker run.
 
 
 Valid values:
 "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
 








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


Serialized Fields


name
String name

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


value
String value

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








Class com.amazonaws.services.ecs.model.LimitExceededException extends AmazonECSException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


capabilities
KernelCapabilities capabilities

 The Linux capabilities for the container that are added to or dropped from the default configuration provided by
 Docker.
 
 
 
 If you are using tasks that use the Fargate launch type, capabilities is supported but the
 add parameter is not supported.
 
 


devices
SdkInternalList<T> devices

 Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the
 Docker Remote API and the --device option to
 docker run.
 
 
 
 If you are using tasks that use the Fargate launch type, the devices parameter is not supported.
 
 


initProcessEnabled
Boolean initProcessEnabled

 Run an init process inside the container that forwards signals and reaps processes. This parameter
 maps to the --init option to docker run.
 This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the
 Docker Remote API version on your container instance, log in to your container instance and run the following
 command: sudo docker version --format '{{.Server.APIVersion}}'
 


sharedMemorySize
Integer sharedMemorySize

 The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the
 --shm-size option to docker run.
 
 
 
 If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not
 supported.
 
 


tmpfs
SdkInternalList<T> tmpfs

 The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
 --tmpfs option to docker run.
 
 
 
 If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.
 
 


maxSwap
Integer maxSwap

 The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
 --memory-swap option to docker run where
 the value would be the sum of the container memory plus the maxSwap value.
 
 
 If a maxSwap value of 0 is specified, the container will not use swap. Accepted values
 are 0 or any positive integer. If the maxSwap parameter is omitted, the container will
 use the swap configuration for the container instance it is running on. A maxSwap value must be set
 for the swappiness parameter to be used.
 
 
 
 If you are using tasks that use the Fargate launch type, the maxSwap parameter is not supported.
 
 


swappiness
Integer swappiness

 This allows you to tune a container's memory swappiness behavior. A swappiness value of
 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of
 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between
 0 and 100. If the swappiness parameter is not specified, a default value
 of 60 is used. If a value is not specified for maxSwap then this parameter is ignored.
 This parameter maps to the --memory-swappiness option to docker run.
 
 
 
 If you are using tasks that use the Fargate launch type, the swappiness parameter is not supported.
 
 








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


Serialized Fields


name
String name

 The resource name you want to list the account settings for.
 


value
String value

 The value of the account settings with which to filter results. You must also specify an account setting name to
 use this parameter.
 


principalArn
String principalArn

 The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the
 account settings are listed only for the authenticated user.
 


effectiveSettings
Boolean effectiveSettings

 Specifies whether to return the effective settings. If true, the account settings for the root user
 or the default setting for the principalArn are returned. If false, the account
 settings for the principalArn are returned if they are set. Otherwise, no account settings are
 returned.
 


nextToken
String nextToken

 The nextToken value returned from a ListAccountSettings request indicating that more
 results are available to fulfill the request and further calls will be needed. If maxResults was
 provided, it is possible the number of results to be fewer than maxResults.
 
 
 
 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.
 
 


maxResults
Integer maxResults

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








Class com.amazonaws.services.ecs.model.ListAccountSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


settings
SdkInternalList<T> settings

 The account settings for the resource.
 


nextToken
String nextToken

 The nextToken value to include in a future ListAccountSettings request. When the
 results of a ListAccountSettings 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.ListAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a
 cluster, the default cluster is assumed.
 


targetType
String targetType

 The type of the target with which to list attributes.
 


attributeName
String attributeName

 The name of the attribute with which to filter the results.
 


attributeValue
String attributeValue

 The value of the attribute with which to filter results. You must also specify an attribute name to use this
 parameter.
 


nextToken
String nextToken

 The nextToken value returned from a ListAttributes request indicating that more results
 are available to fulfill the request and further calls will be needed. If maxResults was provided,
 it is possible the number of results to be fewer than maxResults.
 
 
 
 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.
 
 


maxResults
Integer maxResults

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








Class com.amazonaws.services.ecs.model.ListAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
SdkInternalList<T> attributes

 A list of attribute objects that meet the criteria of the request.
 


nextToken
String nextToken

 The nextToken value to include in a future ListAttributes request. When the results of
 a ListAttributes 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.ListClustersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The nextToken value returned from a ListClusters request indicating that more results
 are available to fulfill the request and further calls will be needed. If maxResults was provided,
 it is possible the number of results to be fewer than maxResults.
 
 
 
 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.
 
 


maxResults
Integer maxResults

 The maximum number of cluster results returned by ListClusters in paginated output. When this
 parameter is used, ListClusters only returns maxResults results in a single page along
 with a nextToken response element. The remaining results of the initial request can be seen by
 sending another ListClusters request with the returned nextToken value. This value can
 be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and
 a nextToken value if applicable.
 








Class com.amazonaws.services.ecs.model.ListClustersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterArns
SdkInternalList<T> clusterArns

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


nextToken
String nextToken

 The nextToken value to include in a future ListClusters request. When the results of a
 ListClusters request exceed maxResults, this value can be used to retrieve the next
 page of results. This value is null when there are no more results to return.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If
 you do not specify a cluster, the default cluster is assumed.
 


filter
String filter

 You can filter the results of a ListContainerInstances operation with cluster query language
 statements. For more information, see Cluster Query
 Language in the Amazon Elastic Container Service Developer Guide.
 


nextToken
String nextToken

 The nextToken value returned from a ListContainerInstances request indicating that more
 results are available to fulfill the request and further calls will be needed. If maxResults was
 provided, it is possible the number of results to be fewer than maxResults.
 
 
 
 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.
 
 


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.
 


status
String status

 Filters the container instances by status. For example, if you specify the DRAINING status, the
 results include only container instances that have been set to DRAINING using
 UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container
 instances set to all states other than INACTIVE.
 








Class com.amazonaws.services.ecs.model.ListContainerInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


containerInstanceArns
SdkInternalList<T> containerInstanceArns

 The list of container instances with full ARN entries for each container instance associated with the specified
 cluster.
 


nextToken
String nextToken

 The nextToken value to include in a future ListContainerInstances request. When the
 results of a ListContainerInstances request exceed maxResults, this value can be used
 to retrieve the next page of results. This value is null when there are no more results to return.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not
 specify a cluster, the default cluster is assumed.
 


nextToken
String nextToken

 The nextToken value returned from a ListServices request indicating that more results
 are available to fulfill the request and further calls will be needed. If maxResults was provided,
 it is possible the number of results to be fewer than maxResults.
 
 
 
 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.
 
 


maxResults
Integer maxResults

 The maximum number of service 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 100. If this parameter is not used, then ListServices returns up to 10 results and
 a nextToken value if applicable.
 


launchType
String launchType

 The launch type for the services to list.
 


schedulingStrategy
String schedulingStrategy

 The scheduling strategy for services to list.
 








Class com.amazonaws.services.ecs.model.ListServicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serviceArns
SdkInternalList<T> serviceArns

 The list of full ARN entries for each service associated with the specified cluster.
 


nextToken
String nextToken

 The nextToken value to include in a future ListServices request. When the results of a
 ListServices request exceed maxResults, this value can be used to retrieve the next
 page of results. This value is null when there are no more results to return.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported
 resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
 








Class com.amazonaws.services.ecs.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 The tags for the resource.
 








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


Serialized Fields


familyPrefix
String familyPrefix

 The familyPrefix is a string that is used to filter the results of
 ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family
 names that begin with the familyPrefix string are returned.
 


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.
 


nextToken
String nextToken

 The nextToken value returned from a ListTaskDefinitionFamilies request indicating that
 more results are available to fulfill the request and further calls will be needed. If maxResults
 was provided, it is possible the number of results to be fewer than maxResults.
 
 
 
 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.
 
 


maxResults
Integer maxResults

 The maximum number of task definition family results returned by ListTaskDefinitionFamilies in
 paginated output. When this parameter is used, ListTaskDefinitions only returns
 maxResults results in a single page along with a nextToken response element. The
 remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies
 request with the returned nextToken value. This value can be between 1 and 100. If this parameter is
 not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken
 value if applicable.
 








Class com.amazonaws.services.ecs.model.ListTaskDefinitionFamiliesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


families
SdkInternalList<T> families

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


nextToken
String nextToken

 The nextToken value to include in a future ListTaskDefinitionFamilies request. When the
 results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be
 used to retrieve the next page of results. This value is null when there are no more results to
 return.
 








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


Serialized Fields


familyPrefix
String familyPrefix

 The full family name with which to filter the ListTaskDefinitions results. Specifying a
 familyPrefix limits the listed task definitions to task definition revisions that belong to that
 family.
 


status
String status

 The task definition status with which to filter the ListTaskDefinitions results. By default, only
 ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view
 task definitions that are INACTIVE as long as an active task or service still references them. If
 you paginate the resulting output, be sure to keep the status value constant in each subsequent
 request.
 


sort
String sort

 The order in which to sort the results. Valid values are ASC and DESC. By default (
 ASC), task definitions are listed lexicographically by family name and in ascending numerical order
 by revision so that the newest task definitions in a family are listed last. Setting this parameter to
 DESC reverses the sort order on family name and revision so that the newest task definitions in a
 family are listed first.
 


nextToken
String nextToken

 The nextToken value returned from a ListTaskDefinitions request indicating that more
 results are available to fulfill the request and further calls will be needed. If maxResults was
 provided, it is possible the number of results to be fewer than maxResults.
 
 
 
 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.
 
 


maxResults
Integer maxResults

 The maximum number of task definition results returned by ListTaskDefinitions in paginated output.
 When this parameter is used, ListTaskDefinitions only returns maxResults results in a
 single page along with a nextToken response element. The remaining results of the initial request
 can be seen by sending another ListTaskDefinitions request with the returned nextToken
 value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions
 returns up to 100 results and a nextToken value if applicable.
 








Class com.amazonaws.services.ecs.model.ListTaskDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskDefinitionArns
SdkInternalList<T> taskDefinitionArns

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


nextToken
String nextToken

 The nextToken value to include in a future ListTaskDefinitions request. When the
 results of a ListTaskDefinitions request exceed maxResults, this value can be used to
 retrieve the next page of results. This value is null when there are no more results to return.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not
 specify a cluster, the default cluster is assumed.
 


containerInstance
String containerInstance

 The container instance ID or full ARN of the container instance with which to filter the ListTasks
 results. Specifying a containerInstance limits the results to tasks that belong to that container
 instance.
 


family
String family

 The name of the family with which to filter the ListTasks results. Specifying a family
 limits the results to tasks that belong to that family.
 


nextToken
String nextToken

 The nextToken value returned from a ListTasks request indicating that more results are
 available to fulfill the request and further calls will be needed. If maxResults was provided, it is
 possible the number of results to be fewer than maxResults.
 
 
 
 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.
 
 


maxResults
Integer maxResults

 The maximum number of task results returned by ListTasks in paginated output. When this parameter is
 used, ListTasks only returns maxResults results in a single page along with a
 nextToken response element. The remaining results of the initial request can be seen by sending
 another ListTasks request with the returned nextToken value. This value can be between
 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a
 nextToken value if applicable.
 


startedBy
String startedBy

 The startedBy value with which to filter the task results. Specifying a startedBy value
 limits the results to tasks that were started with that value.
 


serviceName
String serviceName

 The name of the service with which to filter the ListTasks results. Specifying a
 serviceName limits the results to tasks that belong to that service.
 


desiredStatus
String desiredStatus

 The task desired status with which to filter the ListTasks results. Specifying a
 desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the
 desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or
 have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has
 set the desired status to RUNNING.
 
 
 
 Although you can filter results based on a desired status of PENDING, this does not return any
 results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus
 may have a value of PENDING).
 
 


launchType
String launchType

 The launch type for services to list.
 








Class com.amazonaws.services.ecs.model.ListTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskArns
SdkInternalList<T> taskArns

 The list of task ARN entries for the ListTasks request.
 


nextToken
String nextToken

 The nextToken value to include in a future ListTasks request. When the results of a
 ListTasks request exceed maxResults, this value can be used to retrieve the next page
 of results. This value is null when there are no more results to return.
 








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


Serialized Fields


targetGroupArn
String targetGroupArn

 The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a
 service or task set.
 
 
 A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are
 using a Classic Load Balancer this should be omitted.
 
 
 For services using the ECS deployment controller, you can specify one or multiple target groups. For
 more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer
 Guide.
 
 
 For services using the CODE_DEPLOY deployment controller, you are required to define two target
 groups for the load balancer. For more information, see Blue/Green
 Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.
 
 
 
 If your service's task definition uses the awsvpc network mode (which is required for the Fargate
 launch type), you must choose ip as the target type, not instance, when creating your
 target groups because tasks that use the awsvpc network mode are associated with an elastic network
 interface, not an Amazon EC2 instance.
 
 


loadBalancerName
String loadBalancerName

 The name of the load balancer to associate with the Amazon ECS service or task set.
 
 
 A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load
 Balancer or a Network Load Balancer this should be omitted.
 


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 task definition the tasks in the service are using. For tasks that use the EC2
 launch type, the container instance they are launched on must allow ingress traffic on the hostPort
 of the port mapping.
 








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


Serialized Fields


logDriver
String logDriver

 The log driver to use for the container. The valid values listed earlier are log drivers that the Amazon ECS
 container agent can communicate with by default.
 
 
 For tasks using the Fargate launch type, the supported log drivers are awslogs, splunk,
 and awsfirelens.
 
 
 For tasks using the EC2 launch type, the supported log drivers are awslogs, fluentd,
 gelf, json-file, journald, logentries,syslog,
 splunk, and awsfirelens.
 
 
 For more information about using the awslogs log driver, see Using the awslogs Log
 Driver in the Amazon Elastic Container Service Developer Guide.
 
 
 For more information about using the awsfirelens log driver, see Custom Log Routing in
 the Amazon Elastic Container Service Developer Guide.
 
 
 
 If you have a custom driver that is not listed, 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, we do not
 currently provide support for running modified copies of this software.
 
 


options
Map<K,V> options

 The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote
 API or greater on your container instance. To check the Docker Remote API version on your container instance, log
 in to your container instance and run the following command:
 sudo docker version --format '{{.Server.APIVersion}}'
 


secretOptions
SdkInternalList<T> secretOptions

 The secrets to pass to the log configuration. For more information, see Specifying
 Sensitive Data in the Amazon Elastic Container Service Developer Guide.
 








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


Serialized Fields


status
String status

 Whether or not to enable managed scaling for the capacity provider.
 


targetCapacity
Integer targetCapacity

 The target capacity value for the capacity provider. The specified value must be greater than 0 and
 less than or equal to 100. A value of 100 will result in the Amazon EC2 instances in
 your Auto Scaling group being completely utilized.
 


minimumScalingStepSize
Integer minimumScalingStepSize

 The minimum number of container instances that Amazon ECS will scale in or scale out at one time. If this
 parameter is omitted, the default value of 1 is used.
 


maximumScalingStepSize
Integer maximumScalingStepSize

 The maximum number of container instances that Amazon ECS will scale in or scale out at one time. If this
 parameter is omitted, the default value of 10000 is used.
 








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

serialVersionUID:
1L





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


Serialized Fields


sourceVolume
String sourceVolume

 The name of the volume to mount. Must be a volume name referenced in the name parameter of task
 definition volume.
 


containerPath
String containerPath

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


readOnly
Boolean readOnly

 If this value is true, the container has read-only access to the volume. If this value is
 false, then the container can write to the volume. The default value is false.
 








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


Serialized Fields


bindIP
String bindIP

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


containerPort
Integer containerPort

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


hostPort
Integer hostPort

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


protocol
String protocol

 The protocol used for the network binding.
 








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


Serialized Fields


awsvpcConfiguration
AwsVpcConfiguration awsvpcConfiguration

 The VPC subnets and security groups associated with a task.
 
 
 
 All specified subnets and security groups must be from the same VPC.
 
 








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


Serialized Fields


attachmentId
String attachmentId

 The attachment ID for the network interface.
 


privateIpv4Address
String privateIpv4Address

 The private IPv4 address for the network interface.
 


ipv6Address
String ipv6Address

 The private IPv6 address for the network interface.
 








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

serialVersionUID:
1L





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


Serialized Fields


type
String type

 The type of constraint. Use distinctInstance to ensure that each task in a particular group is
 running on a different container instance. Use memberOf to restrict the selection to a group of
 valid candidates.
 


expression
String expression

 A cluster query language expression to apply to the constraint. You cannot specify an expression if the
 constraint type is distinctInstance. For more information, see Cluster Query
 Language in the Amazon Elastic Container Service Developer Guide.
 








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


Serialized Fields


type
String type

 The type of placement strategy. The random placement strategy randomly places tasks on available
 candidates. The spread placement strategy spreads placement across available candidates evenly based
 on the field parameter. The binpack strategy places tasks on available candidates that
 have the least available amount of the resource that is specified with the field parameter. For
 example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory
 (but still enough to run the task).
 


field
String field

 The field to apply the placement strategy against. For the spread placement strategy, valid values
 are instanceId (or host, which has the same effect), or any platform or custom
 attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the
 binpack placement strategy, valid values are cpu and memory. For the
 random placement strategy, this field is not used.
 








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


Serialized Fields


id
String id

 The ID for the GPU(s) on the container instance. The available GPU IDs can also be obtained on the container
 instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.
 


type
String type

 The type of device that is available on the container instance. The only supported value is GPU.
 








Class com.amazonaws.services.ecs.model.PlatformTaskDefinitionIncompatibilityException extends AmazonECSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.PlatformUnknownException extends AmazonECSException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


containerPort
Integer containerPort

 The port number on the container that is bound to the user-specified or automatically assigned host port.
 
 
 If you are using containers in a task with the awsvpc or host network mode, exposed
 ports should be specified using containerPort.
 
 
 If you are using containers in a task with the bridge network mode and 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.
 
 
 
 You cannot expose the same container port for multiple protocols. An error will be returned if this is attempted.
 
 


hostPort
Integer hostPort

 The port number on the container instance to reserve for your container.
 
 
 If you are using containers in a task with the awsvpc or host network mode, the
 hostPort can either be left blank or set to the same value as the containerPort.
 
 
 If you are using containers in a task with the bridge network mode, 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 for Docker version 1.6.0 and later is listed on the instance under
 /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default
 ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral
 port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the
 ephemeral port range.
 
 
 
 The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
 
 
 
 The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent
 ports 51678-51680. 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. A container instance can have up to
 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't 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.ProxyConfiguration extends Object implements Serializable


Serialized Fields


type
String type

 The proxy type. The only supported value is APPMESH.
 


containerName
String containerName

 The name of the container that will serve as the App Mesh proxy.
 


properties
SdkInternalList<T> properties

 The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as
 key-value pairs.
 
 
 
 
 IgnoredUID - (Required) The user ID (UID) of the proxy container as defined by the user
 parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If
 IgnoredGID is specified, this field can be empty.
 
 
 
 
 IgnoredGID - (Required) The group ID (GID) of the proxy container as defined by the
 user parameter in a container definition. This is used to ensure the proxy ignores its own traffic.
 If IgnoredUID is specified, this field can be empty.
 
 
 
 
 AppPorts - (Required) The list of ports that the application uses. Network traffic to these ports is
 forwarded to the ProxyIngressPort and ProxyEgressPort.
 
 
 
 
 ProxyIngressPort - (Required) Specifies the port that incoming traffic to the AppPorts
 is directed to.
 
 
 
 
 ProxyEgressPort - (Required) Specifies the port that outgoing traffic from the AppPorts
 is directed to.
 
 
 
 
 EgressIgnoredPorts - (Required) The egress traffic going to the specified ports is ignored and not
 redirected to the ProxyEgressPort. It can be an empty list.
 
 
 
 
 EgressIgnoredIPs - (Required) The egress traffic going to the specified IP addresses is ignored and
 not redirected to the ProxyEgressPort. It can be an empty list.
 
 
 








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


Serialized Fields


name
String name

 The resource name for which to modify the account setting. If serviceLongArnFormat is specified, the
 ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and
 resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified,
 the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is
 specified, the ENI limit for your Amazon ECS container instances is affected. If containerInsights
 is specified, the default setting for CloudWatch Container Insights for your clusters is affected.
 


value
String value

 The account setting value for the specified principal ARN. Accepted values are enabled and
 disabled.
 








Class com.amazonaws.services.ecs.model.PutAccountSettingDefaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


setting
Setting setting








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


Serialized Fields


name
String name

 The Amazon ECS resource name for which to modify the account setting. If serviceLongArnFormat is
 specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the
 ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is
 specified, the ARN and resource ID for your Amazon ECS container instances is affected. If
 awsvpcTrunking is specified, the elastic network interface (ENI) limit for your Amazon ECS container
 instances is affected. If containerInsights is specified, the default setting for CloudWatch
 Container Insights for your clusters is affected.
 


value
String value

 The account setting value for the specified principal ARN. Accepted values are enabled and
 disabled.
 


principalArn
String principalArn

 The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it
 modifies the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or
 role explicitly overrides these settings. If this field is omitted, the setting is changed only for the
 authenticated user.
 








Class com.amazonaws.services.ecs.model.PutAccountSettingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


setting
Setting setting

 The current account setting for a resource.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes.
 If you do not specify a cluster, the default cluster is assumed.
 


attributes
SdkInternalList<T> attributes

 The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can
 specify up to 10 attributes in a single call.
 








Class com.amazonaws.services.ecs.model.PutAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
SdkInternalList<T> attributes

 The attributes applied to your resource.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If
 you do not specify a cluster, the default cluster is assumed.
 


capacityProviders
SdkInternalList<T> capacityProviders

 The name of one or more capacity providers to associate with the cluster.
 
 
 If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created.
 New capacity providers can be created with the CreateCapacityProvider API operation.
 
 
 To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
 capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be
 associated with a cluster to be used.
 


defaultCapacityProviderStrategy
SdkInternalList<T> defaultCapacityProviderStrategy

 The capacity provider strategy to use by default for the cluster.
 
 
 When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then
 the default capacity provider strategy for the cluster is used.
 
 
 A capacity provider strategy consists of one or more capacity providers along with the base and
 weight to assign to them. A capacity provider must be associated with the cluster to be used in a
 capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider
 with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
 
 
 If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created.
 New capacity providers can be created with the CreateCapacityProvider API operation.
 
 
 To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
 capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be
 associated with a cluster to be used.
 








Class com.amazonaws.services.ecs.model.PutClusterCapacityProvidersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance.
 If you do not specify a cluster, the default cluster is assumed.
 


instanceIdentityDocument
String instanceIdentityDocument

 The instance identity document for the EC2 instance to register. This document can be found by running the
 following command from the instance:
 curl http://169.254.169.254/latest/dynamic/instance-identity/document/
 


instanceIdentityDocumentSignature
String instanceIdentityDocumentSignature

 The instance identity document signature for the EC2 instance to register. This signature can be found by running
 the following command from the instance:
 curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
 


totalResources
SdkInternalList<T> totalResources

 The resources available on the instance.
 


versionInfo
VersionInfo versionInfo

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


containerInstanceArn
String containerInstanceArn

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


attributes
SdkInternalList<T> attributes

 The container instance attributes that this container instance supports.
 


platformDevices
SdkInternalList<T> platformDevices

 The devices that are available on the container instance. The only supported device type is a GPU.
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists
 of a key and an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 








Class com.amazonaws.services.ecs.model.RegisterContainerInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


containerInstance
ContainerInstance containerInstance

 The container instance that was registered.
 








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


Serialized Fields


family
String family

 You must specify a family for a task definition, which allows you to track multiple versions of the
 same task definition. The family is used as a name for your task definition. Up to 255 letters
 (uppercase and lowercase), numbers, and hyphens are allowed.
 


taskRoleArn
String taskRoleArn

 The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All
 containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in
 the Amazon Elastic Container Service Developer Guide.
 


executionRoleArn
String executionRoleArn

 The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker
 daemon can assume.
 


networkMode
String networkMode

 The Docker networking mode to use for the containers in the task. The valid values are none,
 bridge, awsvpc, and host. The default Docker network mode is
 bridge. If you are using the Fargate launch type, the awsvpc network mode is required.
 If you are using the EC2 launch type, any network mode can be used. If the network mode is set to
 none, you cannot specify port mappings in your container definitions, and the tasks containers do
 not have external connectivity. The host and awsvpc network modes offer the highest
 networking performance for containers because they use the EC2 network stack instead of the virtualized network
 stack provided by the bridge mode.
 
 
 With the host and awsvpc network modes, exposed container ports are mapped directly to
 the corresponding host port (for the host network mode) or the attached elastic network interface
 port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
 
 
 If the network mode is awsvpc, the task is allocated an elastic network interface, and you must
 specify a NetworkConfiguration value when you create a service or run a task with the task definition. For
 more information, see Task Networking in
 the Amazon Elastic Container Service Developer Guide.
 
 
 
 Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or
 AWS Fargate infrastructure support the awsvpc network mode.
 
 
 
 If the network mode is host, you cannot run multiple instantiations of the same task on a single
 container instance when port mappings are used.
 
 
 Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with
 Windows containers, you must not specify a network mode. If you use the console to register a task definition
 with Windows containers, you must choose the <default> network mode object.
 
 
 For more information, see Network
 settings in the Docker run reference.
 


containerDefinitions
SdkInternalList<T> containerDefinitions

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


volumes
SdkInternalList<T> volumes

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


placementConstraints
SdkInternalList<T> placementConstraints

 An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per
 task (this limit includes constraints in the task definition and those specified at runtime).
 


requiresCompatibilities
SdkInternalList<T> requiresCompatibilities

 The launch type required by the task. If no value is specified, it defaults to EC2.
 


cpu
String cpu

 The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example
 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task
 definition. String values are converted to an integer indicating the CPU units when the task definition is
 registered.
 
 
 
 Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level
 resources for Windows containers.
 
 
 
 If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU
 units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
 
 
 If you are using the Fargate launch type, this field is required and you must use one of the following values,
 which determines your range of supported values for the memory parameter:
 
 
 
 
 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
 
 
 
 
 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
 
 
 
 
 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
 GB), 7168 (7 GB), 8192 (8 GB)
 
 
 
 
 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024
 (1 GB)
 
 
 
 
 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024
 (1 GB)
 
 
 


memory
String memory

 The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example
 1024, or as a string using GB, for example 1GB or 1 GB, in a task
 definition. String values are converted to an integer indicating the MiB when the task definition is registered.
 
 
 
 Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level
 resources for Windows containers.
 
 
 
 If using the EC2 launch type, this field is optional.
 
 
 If using the Fargate launch type, this field is required and you must use one of the following values, which
 determines your range of supported values for the cpu parameter:
 
 
 
 
 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
 
 
 
 
 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
 
 
 
 
 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
 cpu values: 1024 (1 vCPU)
 
 
 
 
 Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2
 vCPU)
 
 
 
 
 Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4
 vCPU)
 
 
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of
 a key and an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 


pidMode
String pidMode

 The process namespace to use for the containers in the task. The valid values are host or
 task. If host is specified, then all containers within the tasks that specified the
 host PID mode on the same container instance share the same process namespace with the host Amazon
 EC2 instance. If task is specified, all containers within the specified task share the same process
 namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run
 reference.
 
 
 If the host PID mode is used, be aware that there is a heightened risk of undesired process
 namespace expose. For more information, see Docker
 security.
 
 
 
 This parameter is not supported for Windows containers or tasks using the Fargate launch type.
 
 


ipcMode
String ipcMode

 The IPC resource namespace to use for the containers in the task. The valid values are host,
 task, or none. If host is specified, then all containers within the tasks
 that specified the host IPC mode on the same container instance share the same IPC resources with
 the host Amazon EC2 instance. If task is specified, all containers within the specified task share
 the same IPC resources. If none is specified, then IPC resources within the containers of a task are
 private and not shared with other containers in a task or on the container instance. If no value is specified,
 then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more
 information, see IPC settings in
 the Docker run reference.
 
 
 If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace
 expose. For more information, see Docker
 security.
 
 
 If you are setting namespaced kernel parameters using systemControls for the containers in the task,
 the following will apply to your IPC resource namespace. For more information, see System
 Controls in the Amazon Elastic Container Service Developer Guide.
 
 
 
 
 For tasks that use the host IPC mode, IPC namespace related systemControls are not
 supported.
 
 
 
 
 For tasks that use the task IPC mode, IPC namespace related systemControls will apply
 to all containers within a task.
 
 
 
 
 
 This parameter is not supported for Windows containers or tasks using the Fargate launch type.
 
 


proxyConfiguration
ProxyConfiguration proxyConfiguration


inferenceAccelerators
SdkInternalList<T> inferenceAccelerators

 The Elastic Inference accelerators to use for the containers in the task.
 








Class com.amazonaws.services.ecs.model.RegisterTaskDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskDefinition
TaskDefinition taskDefinition

 The full description of the registered task definition.
 


tags
SdkInternalList<T> tags

 The list of tags associated with the task definition.
 








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


Serialized Fields


credentialsParameter
String credentialsParameter

 The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
 
 
 
 When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task
 that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS
 Management Console, you must specify the full ARN of the secret.
 
 








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


Serialized Fields


name
String name

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


type
String type

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


doubleValue
Double doubleValue

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


longValue
Long longValue

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


integerValue
Integer integerValue

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


stringSetValue
SdkInternalList<T> stringSetValue

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








Class com.amazonaws.services.ecs.model.ResourceInUseException extends AmazonECSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.ResourceNotFoundException extends AmazonECSException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


value
String value

 The value for the specified resource type.
 
 
 If the GPU type is used, the value is the number of physical GPUs the Amazon ECS
 container agent will reserve for the container. The number of GPUs reserved for all containers in a task should
 not exceed the number of available GPUs on the container instance the task is launched on.
 
 
 If the InferenceAccelerator type is used, the value should match the
 deviceName for an InferenceAccelerator specified in a task definition.
 


type
String type

 The type of resource to assign to a container. The supported values are GPU or
 InferenceAccelerator.
 








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


Serialized Fields


capacityProviderStrategy
SdkInternalList<T> capacityProviderStrategy

 The capacity provider strategy to use for the task.
 
 
 A capacity provider strategy consists of one or more capacity providers along with the base and
 weight to assign to them. A capacity provider must be associated with the cluster to be used in a
 capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider
 with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
 
 
 If a capacityProviderStrategy is specified, the launchType parameter must be omitted.
 If no capacityProviderStrategy or launchType is specified, the
 defaultCapacityProviderStrategy for the cluster is used.
 
 
 If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created.
 New capacity providers can be created with the CreateCapacityProvider API operation.
 
 
 To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT
 capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be
 associated with a cluster to be used.
 
 
 The PutClusterCapacityProviders API operation is used to update the list of available capacity providers
 for a cluster after the cluster is created.
 


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. You can specify up to 10 tasks per
 call.
 


enableECSManagedTags
Boolean enableECSManagedTags

 Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS
 Resources in the Amazon Elastic Container Service Developer Guide.
 


group
String group

 The name of the task group to associate with the task. The default value is the family name of the task
 definition (for example, family:my-family-name).
 


launchType
String launchType

 The launch type on which to run your task. For more information, see Amazon ECS Launch Types
 in the Amazon Elastic Container Service Developer Guide.
 
 
 If a launchType is specified, the capacityProviderStrategy parameter must be omitted.
 


networkConfiguration
NetworkConfiguration networkConfiguration

 The network configuration for the task. This parameter is required for task definitions that use the
 awsvpc network mode to receive their own elastic network interface, and it is not supported for
 other network modes. For more information, see Task Networking in
 the Amazon Elastic Container Service Developer Guide.
 


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.
 
 


placementConstraints
SdkInternalList<T> placementConstraints

 An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task
 (including constraints in the task definition and those specified at runtime).
 


placementStrategy
SdkInternalList<T> placementStrategy

 The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
 


platformVersion
String platformVersion

 The platform version the task should run. A platform version is only specified for tasks using the Fargate launch
 type. If one is not specified, the LATEST platform version is used by default. For more information,
 see AWS Fargate
 Platform Versions in the Amazon Elastic Container Service Developer Guide.
 


propagateTags
String propagateTags

 Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags
 are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after
 task creation, use the TagResource API action.
 
 
 
 An error will be received if you specify the SERVICE option when running a task.
 
 


referenceId
String referenceId

 The reference ID to use for the task.
 


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.
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and
 an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 


taskDefinition
String taskDefinition

 The family and revision (family:revision) or full 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tasks
SdkInternalList<T> tasks

 A full description of the tasks that were run. The tasks that were successfully placed on your cluster are
 described here.
 


failures
SdkInternalList<T> failures

 Any failures associated with the call.
 








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


Serialized Fields


value
Double value

 The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted
 values are numbers between 0 and 100.
 


unit
String unit

 The unit of measure for the scale value.
 








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


Serialized Fields


name
String name

 The name of the secret.
 


valueFrom
String valueFrom

 The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager
 secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
 
 
 
 If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching,
 then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region,
 then the full ARN must be specified.
 
 








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

serialVersionUID:
1L





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


Serialized Fields


serviceArn
String serviceArn

 The 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, and hyphens are allowed. Service
 names must be unique within a cluster, but you can have similarly named services in multiple clusters within a
 Region or across multiple Regions.
 


clusterArn
String clusterArn

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


loadBalancers
SdkInternalList<T> loadBalancers

 A list of Elastic Load Balancing 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.
 


serviceRegistries
SdkInternalList<T> serviceRegistries

 The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
 


status
String status

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


desiredCount
Integer desiredCount

 The desired number of instantiations of the task definition to keep running on the service. This value is
 specified when the service is created with CreateService, and it can be modified with
 UpdateService.
 


runningCount
Integer runningCount

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


pendingCount
Integer pendingCount

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


launchType
String launchType

 The launch type on which your service is running. If no value is specified, it will default to EC2.
 Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types
 in the Amazon Elastic Container Service Developer Guide.
 


capacityProviderStrategy
SdkInternalList<T> capacityProviderStrategy

 The capacity provider strategy associated with the service.
 


platformVersion
String platformVersion

 The platform version on which to run your service. A platform version is only specified for tasks using the
 Fargate launch type. If one is not specified, the LATEST platform version is used by default. For
 more information, see AWS Fargate Platform
 Versions in the Amazon Elastic Container Service Developer Guide.
 


taskDefinition
String taskDefinition

 The task definition to use for tasks in the service. This value is specified when the service is created with
 CreateService, and it can be modified with UpdateService.
 


deploymentConfiguration
DeploymentConfiguration deploymentConfiguration

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


taskSets
SdkInternalList<T> taskSets

 Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment.
 An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and
 whether the task set serves production traffic.
 


deployments
SdkInternalList<T> deployments

 The current state of deployments for the service.
 


roleArn
String roleArn

 The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register
 container instances with an Elastic Load Balancing load balancer.
 


events
SdkInternalList<T> events

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


createdAt
Date createdAt

 The Unix timestamp for when the service was created.
 


placementConstraints
SdkInternalList<T> placementConstraints

 The placement constraints for the tasks in the service.
 


placementStrategy
SdkInternalList<T> placementStrategy

 The placement strategy that determines how tasks for the service are placed.
 


networkConfiguration
NetworkConfiguration networkConfiguration

 The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
 using the awsvpc networking mode.
 


healthCheckGracePeriodSeconds
Integer healthCheckGracePeriodSeconds

 The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing
 target health checks after a task has first started.
 


schedulingStrategy
String schedulingStrategy

 The scheduling strategy to use for the service. For more information, see Services.
 
 
 There are two service scheduler strategies available:
 
 
 
 
 REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your
 cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement
 strategies and constraints to customize task placement decisions.
 
 
 
 
 DAEMON-The daemon scheduling strategy deploys exactly one task on each container instance in your
 cluster. When you are using this strategy, do not specify a desired number of tasks or any task placement
 strategies.
 
 
 
 Fargate tasks do not support the DAEMON scheduling strategy.
 
 
 


deploymentController
DeploymentController deploymentController

 The deployment controller type the service is using. When using the DescribeServices API, this field is omitted
 if the service is using the ECS deployment controller type.
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key
 and an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 


createdBy
String createdBy

 The principal that created the service.
 


enableECSManagedTags
Boolean enableECSManagedTags

 Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS
 Resources in the Amazon Elastic Container Service Developer Guide.
 


propagateTags
String propagateTags

 Specifies whether to propagate the tags from the task definition or the service to the task. If no value is
 specified, the tags are not propagated.
 








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


Serialized Fields


id
String id

 The ID string of the event.
 


createdAt
Date createdAt

 The Unix timestamp for when the event was triggered.
 


message
String message

 The event message.
 








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

serialVersionUID:
1L





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

serialVersionUID:
1L





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


Serialized Fields


registryArn
String registryArn

 The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud
 Map. For more information, see CreateService.
 


port
Integer port

 The port value used if your service discovery service specified an SRV record. This field may be used if both the
 awsvpc network mode and SRV records are used.
 


containerName
String containerName

 The container name value, already specified in the task definition, to be used for your service discovery
 service. If the task definition that your service task specifies uses the bridge or
 host network mode, you must specify a containerName and containerPort
 combination from the task definition. If the task definition that your service task specifies uses the
 awsvpc network mode and a type SRV DNS record is used, you must specify either a
 containerName and containerPort combination or a port value, but not both.
 


containerPort
Integer containerPort

 The port value, already specified in the task definition, to be used for your service discovery service. If the
 task definition your service task specifies uses the bridge or host network mode, you
 must specify a containerName and containerPort combination from the task definition. If
 the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS
 record is used, you must specify either a containerName and containerPort combination
 or a port value, but not both.
 








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


Serialized Fields


name
String name

 The Amazon ECS resource name.
 


value
String value

 Whether the account setting is enabled or disabled for the specified resource.
 


principalArn
String principalArn

 The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the
 authenticated user is assumed.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not
 specify a cluster, the default cluster is assumed.
 


containerInstances
SdkInternalList<T> containerInstances

 The container instance IDs or full ARN entries for the container instances on which you would like to place your
 task. You can specify up to 10 container instances.
 


enableECSManagedTags
Boolean enableECSManagedTags

 Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS
 Resources in the Amazon Elastic Container Service Developer Guide.
 


group
String group

 The name of the task group to associate with the task. The default value is the family name of the task
 definition (for example, family:my-family-name).
 


networkConfiguration
NetworkConfiguration networkConfiguration

 The VPC subnet and security group configuration for tasks that receive their own elastic network interface by
 using the awsvpc networking mode.
 


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.
 
 


propagateTags
String propagateTags

 Specifies whether to propagate the tags from the task definition or the service to the task. If no value is
 specified, the tags are not propagated.
 


referenceId
String referenceId

 The reference ID to use for the task.
 


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.
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and
 an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 


taskDefinition
String taskDefinition

 The family and revision (family:revision) or full 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tasks
SdkInternalList<T> tasks

 A full description of the tasks that were started. Each task that was successfully placed on your container
 instances is described.
 


failures
SdkInternalList<T> failures

 Any failures associated with the call.
 








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not
 specify a cluster, the default cluster is assumed.
 


task
String task

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


reason
String reason

 An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can
 use this parameter to specify the reason for stopping the task here, and the message appears in subsequent
 DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
 








Class com.amazonaws.services.ecs.model.StopTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


task
Task task

 The task that was stopped.
 








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


Serialized Fields


cluster
String cluster

 The short name or full ARN of the cluster that hosts the container instance the attachment belongs to.
 


attachments
SdkInternalList<T> attachments

 Any attachments associated with the state change request.
 








Class com.amazonaws.services.ecs.model.SubmitAttachmentStateChangesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


acknowledgment
String acknowledgment

 Acknowledgement of the state change.
 








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


Serialized Fields


cluster
String cluster

 The short name or full ARN of the cluster that hosts the container.
 


task
String task

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


containerName
String containerName

 The name of the container.
 


runtimeId
String runtimeId

 The ID of the Docker container.
 


status
String status

 The status of the state change request.
 


exitCode
Integer exitCode

 The exit code returned for the state change request.
 


reason
String reason

 The reason for the state change request.
 


networkBindings
SdkInternalList<T> networkBindings

 The network bindings of the container.
 








Class com.amazonaws.services.ecs.model.SubmitContainerStateChangeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


acknowledgment
String acknowledgment

 Acknowledgement of the state change.
 








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


Serialized Fields


cluster
String cluster

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


task
String task

 The task ID or full ARN of the task in the state change request.
 


status
String status

 The status of the state change request.
 


reason
String reason

 The reason for the state change request.
 


containers
SdkInternalList<T> containers

 Any containers associated with the state change request.
 


attachments
SdkInternalList<T> attachments

 Any attachments associated with the state change request.
 


pullStartedAt
Date pullStartedAt

 The Unix timestamp for when the container image pull began.
 


pullStoppedAt
Date pullStoppedAt

 The Unix timestamp for when the container image pull completed.
 


executionStoppedAt
Date executionStoppedAt

 The Unix timestamp for when the task execution stopped.
 








Class com.amazonaws.services.ecs.model.SubmitTaskStateChangeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


acknowledgment
String acknowledgment

 Acknowledgement of the state change.
 








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


Serialized Fields


namespace
String namespace

 The namespaced kernel parameter for which to set a value.
 


value
String value

 The value for the namespaced kernel parameter specified in namespace.
 








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


Serialized Fields


key
String key

 One part of a key-value pair that make up a tag. A key is a general label that acts like a category
 for more specific tag values.
 


value
String value

 The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag
 category (key).
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are
 Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
 


tags
SdkInternalList<T> tags

 The tags to add to the resource. A tag is an array of key-value pairs.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 








Class com.amazonaws.services.ecs.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.ecs.model.TargetNotFoundException extends AmazonECSException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


attachments
SdkInternalList<T> attachments

 The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.
 


attributes
SdkInternalList<T> attributes

 The attributes of the task
 


availabilityZone
String availabilityZone

 The availability zone of the task.
 


capacityProviderName
String capacityProviderName

 The capacity provider associated with the task.
 


clusterArn
String clusterArn

 The ARN of the cluster that hosts the task.
 


connectivity
String connectivity

 The connectivity status of a task.
 


connectivityAt
Date connectivityAt

 The Unix timestamp for when the task last went into CONNECTED status.
 


containerInstanceArn
String containerInstanceArn

 The ARN of the container instances that host the task.
 


containers
SdkInternalList<T> containers

 The containers associated with the task.
 


cpu
String cpu

 The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer
 using CPU units, for example 1024. It can also be expressed as a string using vCPUs, for example
 1 vCPU or 1 vcpu. String values are converted to an integer indicating the CPU units
 when the task definition is registered.
 
 
 If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU
 units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).
 
 
 If you are using the Fargate launch type, this field is required and you must use one of the following values,
 which determines your range of supported values for the memory parameter:
 
 
 
 
 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
 
 
 
 
 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
 
 
 
 
 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
 GB), 7168 (7 GB), 8192 (8 GB)
 
 
 
 
 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024
 (1 GB)
 
 
 
 
 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024
 (1 GB)
 
 
 


createdAt
Date createdAt

 The Unix timestamp for when the task was created (the task entered the PENDING state).
 


desiredStatus
String desiredStatus

 The desired status of the task. For more information, see Task Lifecycle.
 


executionStoppedAt
Date executionStoppedAt

 The Unix timestamp for when the task execution stopped.
 


group
String group

 The name of the task group associated with the task.
 


healthStatus
String healthStatus

 The health status for the task, which is determined by the health of the essential containers in the task. If all
 essential containers in the task are reporting as HEALTHY, then the task status also reports as
 HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or
 UNKNOWN, then the task status also reports as UNHEALTHY or UNKNOWN,
 accordingly.
 
 
 
 The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a
 container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in
 the container definition. Health check parameters that are specified in a container definition override any
 Docker health checks that exist in the container image.
 
 


inferenceAccelerators
SdkInternalList<T> inferenceAccelerators

 The Elastic Inference accelerator associated with the task.
 


lastStatus
String lastStatus

 The last known status of the task. For more information, see Task Lifecycle.
 


launchType
String launchType

 The launch type on which your task is running. For more information, see Amazon ECS Launch Types
 in the Amazon Elastic Container Service Developer Guide.
 


memory
String memory

 The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an
 integer using MiB, for example 1024. It can also be expressed as a string using GB, for example
 1GB or 1 GB. String values are converted to an integer indicating the MiB when the task
 definition is registered.
 
 
 If you are using the EC2 launch type, this field is optional.
 
 
 If you are using the Fargate launch type, this field is required and you must use one of the following values,
 which determines your range of supported values for the cpu parameter:
 
 
 
 
 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
 
 
 
 
 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
 
 
 
 
 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
 cpu values: 1024 (1 vCPU)
 
 
 
 
 Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2
 vCPU)
 
 
 
 
 Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4
 vCPU)
 
 
 


overrides
TaskOverride overrides

 One or more container overrides.
 


platformVersion
String platformVersion

 The platform version on which your task is running. A platform version is only specified for tasks using the
 Fargate launch type. If one is not specified, the LATEST platform version is used by default. For
 more information, see AWS Fargate Platform
 Versions in the Amazon Elastic Container Service Developer Guide.
 


pullStartedAt
Date pullStartedAt

 The Unix timestamp for when the container image pull began.
 


pullStoppedAt
Date pullStoppedAt

 The Unix timestamp for when the container image pull completed.
 


startedAt
Date startedAt

 The Unix timestamp for when the task 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.
 


stopCode
String stopCode

 The stop code indicating why a task was stopped. The stoppedReason may contain additional details.
 


stoppedAt
Date stoppedAt

 The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to
 the STOPPED state).
 


stoppedReason
String stoppedReason

 The reason that the task was stopped.
 


stoppingAt
Date stoppingAt

 The Unix timestamp for when the task stops (transitions from the RUNNING state to
 STOPPED).
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and
 an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 


taskArn
String taskArn

 The Amazon Resource Name (ARN) of the task.
 


taskDefinitionArn
String taskDefinitionArn

 The ARN of the task definition that creates the task.
 


version
Long version

 The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the
 version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can
 compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch
 Events for the task (inside the detail object) to verify that the version in your event stream is
 current.
 








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


Serialized Fields


taskDefinitionArn
String taskDefinitionArn

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


containerDefinitions
SdkInternalList<T> containerDefinitions

 A list of container definitions in JSON format that describe the different containers that make up your task. For
 more information about container definition parameters and defaults, see Amazon ECS Task
 Definitions in the Amazon Elastic Container Service Developer Guide.
 


family
String family

 The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase),
 numbers, hyphens, and underscores are allowed.
 
 
 A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you
 registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task
 definition that you add.
 


taskRoleArn
String taskRoleArn

 The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that
 grants containers in the task permission to call AWS APIs on your behalf. For more information, see Amazon ECS Task Role in
 the Amazon Elastic Container Service Developer Guide.
 
 
 IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the
 Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take
 advantage of the feature. For more information, see Windows IAM Roles
 for Tasks in the Amazon Elastic Container Service Developer Guide.
 


executionRoleArn
String executionRoleArn

 The Amazon Resource Name (ARN) of the task execution role that containers in this task can assume. All containers
 in this task are granted the permissions that are specified in this role.
 


networkMode
String networkMode

 The Docker networking mode to use for the containers in the task. The valid values are none,
 bridge, awsvpc, and host. The default Docker network mode is
 bridge. If you are using the Fargate launch type, the awsvpc network mode is required.
 If you are using the EC2 launch type, any network mode can be used. If the network mode is set to
 none, you cannot specify port mappings in your container definitions, and the tasks containers do
 not have external connectivity. The host and awsvpc network modes offer the highest
 networking performance for containers because they use the EC2 network stack instead of the virtualized network
 stack provided by the bridge mode.
 
 
 With the host and awsvpc network modes, exposed container ports are mapped directly to
 the corresponding host port (for the host network mode) or the attached elastic network interface
 port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.
 
 
 If the network mode is awsvpc, the task is allocated an elastic network interface, and you must
 specify a NetworkConfiguration value when you create a service or run a task with the task definition. For
 more information, see Task Networking in
 the Amazon Elastic Container Service Developer Guide.
 
 
 
 Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or
 AWS Fargate infrastructure support the awsvpc network mode.
 
 
 
 If the network mode is host, you cannot run multiple instantiations of the same task on a single
 container instance when port mappings are used.
 
 
 Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with
 Windows containers, you must not specify a network mode. If you use the console to register a task definition
 with Windows containers, you must choose the <default> network mode object.
 
 
 For more information, see Network
 settings in the Docker run reference.
 


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 that
 you register a new revision of a task definition in the same family, the revision value always increases by one,
 even if you have deregistered previous revisions in this family.
 


volumes
SdkInternalList<T> volumes

 The list of volume definitions for the task.
 
 
 If your tasks are using the Fargate launch type, the host and sourcePath parameters are
 not supported.
 
 
 For more information about volume definition parameters and defaults, see Amazon ECS Task
 Definitions in the Amazon Elastic Container Service Developer Guide.
 


status
String status

 The status of the task definition.
 


requiresAttributes
SdkInternalList<T> requiresAttributes

 The container instance attributes required by your task. This field is not valid if you are using the Fargate
 launch type for your task.
 


placementConstraints
SdkInternalList<T> placementConstraints

 An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate
 launch type for your task.
 


compatibilities
SdkInternalList<T> compatibilities

 The launch type to use with your task. For more information, see Amazon ECS Launch Types
 in the Amazon Elastic Container Service Developer Guide.
 


requiresCompatibilities
SdkInternalList<T> requiresCompatibilities

 The launch type the task requires. If no value is specified, it will default to EC2. Valid values
 include EC2 and FARGATE.
 


cpu
String cpu

 The number of cpu units used by the task. If you are using the EC2 launch type, this field is
 optional and any value can be used. If you are using the Fargate launch type, this field is required and you must
 use one of the following values, which determines your range of valid values for the memory
 parameter:
 
 
 
 
 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
 
 
 
 
 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
 
 
 
 
 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6
 GB), 7168 (7 GB), 8192 (8 GB)
 
 
 
 
 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024
 (1 GB)
 
 
 
 
 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024
 (1 GB)
 
 
 


memory
String memory

 The amount (in MiB) of memory used by the task.
 
 
 If using the EC2 launch type, this field is optional and any value can be used. If a task-level memory value is
 specified then the container-level memory value is optional.
 
 
 If using the Fargate launch type, this field is required and you must use one of the following values, which
 determines your range of valid values for the cpu parameter:
 
 
 
 
 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
 
 
 
 
 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
 
 
 
 
 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
 cpu values: 1024 (1 vCPU)
 
 
 
 
 Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2
 vCPU)
 
 
 
 
 Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4
 vCPU)
 
 
 


inferenceAccelerators
SdkInternalList<T> inferenceAccelerators

 The Elastic Inference accelerator associated with the task.
 


pidMode
String pidMode

 The process namespace to use for the containers in the task. The valid values are host or
 task. If host is specified, then all containers within the tasks that specified the
 host PID mode on the same container instance share the same process namespace with the host Amazon
 EC2 instance. If task is specified, all containers within the specified task share the same process
 namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run
 reference.
 
 
 If the host PID mode is used, be aware that there is a heightened risk of undesired process
 namespace expose. For more information, see Docker
 security.
 
 
 
 This parameter is not supported for Windows containers or tasks using the Fargate launch type.
 
 


ipcMode
String ipcMode

 The IPC resource namespace to use for the containers in the task. The valid values are host,
 task, or none. If host is specified, then all containers within the tasks
 that specified the host IPC mode on the same container instance share the same IPC resources with
 the host Amazon EC2 instance. If task is specified, all containers within the specified task share
 the same IPC resources. If none is specified, then IPC resources within the containers of a task are
 private and not shared with other containers in a task or on the container instance. If no value is specified,
 then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more
 information, see IPC settings in
 the Docker run reference.
 
 
 If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace
 expose. For more information, see Docker
 security.
 
 
 If you are setting namespaced kernel parameters using systemControls for the containers in the task,
 the following will apply to your IPC resource namespace. For more information, see System
 Controls in the Amazon Elastic Container Service Developer Guide.
 
 
 
 
 For tasks that use the host IPC mode, IPC namespace related systemControls are not
 supported.
 
 
 
 
 For tasks that use the task IPC mode, IPC namespace related systemControls will apply
 to all containers within a task.
 
 
 
 
 
 This parameter is not supported for Windows containers or tasks using the Fargate launch type.
 
 


proxyConfiguration
ProxyConfiguration proxyConfiguration

 The configuration details for the App Mesh proxy.
 
 
 Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version
 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are
 launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required
 versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized
 Linux AMI in the Amazon Elastic Container Service Developer Guide.
 








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


Serialized Fields


type
String type

 The type of constraint. The MemberOf constraint restricts selection to be from a group of valid
 candidates.
 


expression
String expression

 A cluster query language expression to apply to the constraint. For more information, see Cluster Query
 Language in the Amazon Elastic Container Service Developer Guide.
 








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


Serialized Fields


containerOverrides
SdkInternalList<T> containerOverrides

 One or more container overrides sent to a task.
 


cpu
String cpu

 The cpu override for the task.
 


inferenceAcceleratorOverrides
SdkInternalList<T> inferenceAcceleratorOverrides

 The Elastic Inference accelerator override for the task.
 


executionRoleArn
String executionRoleArn

 The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker
 daemon can assume.
 


memory
String memory

 The memory override for the task.
 


taskRoleArn
String taskRoleArn

 The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this
 task are granted the permissions that are specified in this role.
 








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


Serialized Fields


id
String id

 The ID of the task set.
 


taskSetArn
String taskSetArn

 The Amazon Resource Name (ARN) of the task set.
 


serviceArn
String serviceArn

 The Amazon Resource Name (ARN) of the service the task set exists in.
 


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.
 


startedBy
String startedBy

 The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the
 startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment,
 the startedBy field isn't used.
 


externalId
String externalId

 The external ID associated with the task set.
 
 
 If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS
 CodeDeploy deployment ID.
 
 
 If a task set is created for an external deployment and is associated with a service discovery registry, the
 externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.
 


status
String status

 The status of the task set. The following describes each state:
 
 
 PRIMARY
 
 
 The task set is serving production traffic.
 
 
 ACTIVE
 
 
 The task set is not serving production traffic.
 
 
 DRAINING
 
 
 The tasks in the task set are being stopped and their corresponding targets are being deregistered from their
 target group.
 
 
 


taskDefinition
String taskDefinition

 The task definition the task set is using.
 


computedDesiredCount
Integer computedDesiredCount

 The computed desired count for the task set. This is calculated by multiplying the service's
 desiredCount by the task set's scale percentage. The result is always rounded up. For
 example, if the computed desired count is 1.2, it rounds up to 2 tasks.
 


pendingCount
Integer pendingCount

 The number of tasks in the task set that are in the PENDING status during a deployment. A task in
 the PENDING state is preparing to enter the RUNNING state. A task set enters the
 PENDING status when it launches for the first time or when it is restarted after being in the
 STOPPED state.
 


runningCount
Integer runningCount

 The number of tasks in the task set that are in the RUNNING status during a deployment. A task in
 the RUNNING state is running and ready for use.
 


createdAt
Date createdAt

 The Unix timestamp for when the task set was created.
 


updatedAt
Date updatedAt

 The Unix timestamp for when the task set was last updated.
 


launchType
String launchType

 The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types
 in the Amazon Elastic Container Service Developer Guide.
 


capacityProviderStrategy
SdkInternalList<T> capacityProviderStrategy

 The capacity provider strategy associated with the task set.
 


platformVersion
String platformVersion

 The platform version on which the tasks in the task set are running. A platform version is only specified for
 tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by
 default. For more information, see AWS Fargate Platform
 Versions in the Amazon Elastic Container Service Developer Guide.
 


networkConfiguration
NetworkConfiguration networkConfiguration

 The network configuration for the task set.
 


loadBalancers
SdkInternalList<T> loadBalancers

 Details on a load balancer that is used with a task set.
 


serviceRegistries
SdkInternalList<T> serviceRegistries

 The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
 


scale
Scale scale

 A floating-point percentage of the desired number of tasks to place and keep running in the task set.
 


stabilityStatus
String stabilityStatus

 The stability status, which indicates whether the task set has reached a steady state. If the following
 conditions are met, the task set will be in STEADY_STATE:
 
 
 
 
 The task runningCount is equal to the computedDesiredCount.
 
 
 
 
 The pendingCount is 0.
 
 
 
 
 There are no tasks running on container instances in the DRAINING status.
 
 
 
 
 All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.
 
 
 
 
 If any of those conditions are not met, the stability status returns STABILIZING.
 


stabilityStatusAt
Date stabilityStatusAt

 The Unix timestamp for when the task set stability status was retrieved.
 


tags
SdkInternalList<T> tags

 The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key
 and an optional value, both of which you define.
 
 
 The following basic restrictions apply to tags:
 
 
 
 
 Maximum number of tags per resource - 50
 
 
 
 
 For each resource, each tag key must be unique, and each tag key can have only one value.
 
 
 
 
 Maximum key length - 128 Unicode characters in UTF-8
 
 
 
 
 Maximum value length - 256 Unicode characters in UTF-8
 
 
 
 
 If your tagging schema is used across multiple services and resources, remember that other services may have
 restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable
 in UTF-8, and the following characters: + - = . _ : / @.
 
 
 
 
 Tag keys and values are case-sensitive.
 
 
 
 
 Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for
 either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this
 prefix. Tags with this prefix do not count against your tags per resource limit.
 
 
 








Class com.amazonaws.services.ecs.model.TaskSetNotFoundException extends AmazonECSException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


containerPath
String containerPath

 The absolute file path where the tmpfs volume is to be mounted.
 


size
Integer size

 The size (in MiB) of the tmpfs volume.
 


mountOptions
SdkInternalList<T> mountOptions

 The list of tmpfs volume mount options.
 
 
 Valid values:
 "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
 








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


Serialized Fields


name
String name

 The type of the ulimit.
 


softLimit
Integer softLimit

 The soft limit for the ulimit type.
 


hardLimit
Integer hardLimit

 The hard limit for the ulimit type.
 








Class com.amazonaws.services.ecs.model.UnsupportedFeatureException extends AmazonECSException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are
 Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
 


tagKeys
SdkInternalList<T> tagKeys

 The keys of the tags to be removed.
 








Class com.amazonaws.services.ecs.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


cluster
String cluster

 The name of the cluster to modify the settings for.
 


settings
SdkInternalList<T> settings

 The setting to use by default for a cluster. This parameter is used to enable CloudWatch Container Insights for a
 cluster. If this value is specified, it will override the containerInsights value set with
 PutAccountSetting or PutAccountSettingDefault.
 








Class com.amazonaws.services.ecs.model.UpdateClusterSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If
 you do not specify a cluster, the default cluster is assumed.
 


containerInstance
String containerInstance

 The container instance ID or full ARN entries for the container instance on which you would like to update the
 Amazon ECS container agent.
 








Class com.amazonaws.services.ecs.model.UpdateContainerAgentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


containerInstance
ContainerInstance containerInstance

 The container instance for which the container agent was updated.
 








Class com.amazonaws.services.ecs.model.UpdateContainerInstancesStateRequest 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 update. If
 you do not specify a cluster, the default cluster is assumed.
 


containerInstances
SdkInternalList<T> containerInstances

 A list of container instance IDs or full ARN entries.
 


status
String status

 The container instance state with which to update the container instance. The only valid values for this action
 are ACTIVE and DRAINING. A container instance can only be updated to
 DRAINING status once it has reached an ACTIVE state. If a container instance is in
 REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe
 the container instance but will be unable to update the container instance state.
 








Class com.amazonaws.services.ecs.model.UpdateContainerInstancesStateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


containerInstances
SdkInternalList<T> containerInstances

 The list of container instances.
 


failures
SdkInternalList<T> failures

 Any failures associated with the call.
 








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

serialVersionUID:
1L





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


Serialized Fields


cluster
String cluster

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


service
String service

 The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
 


primaryTaskSet
String primaryTaskSet

 The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the
 deployment.
 








Class com.amazonaws.services.ecs.model.UpdateServicePrimaryTaskSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskSet
TaskSet taskSet








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


Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not
 specify a cluster, the default cluster is assumed.
 


service
String service

 The name of the service to update.
 


desiredCount
Integer desiredCount

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


taskDefinition
String taskDefinition

 The family and revision (family:revision) or full 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.
 


capacityProviderStrategy
SdkInternalList<T> capacityProviderStrategy

 The capacity provider strategy to update the service to use.
 
 
 If the service is using the default capacity provider strategy for the cluster, the service can be updated to use
 one or more capacity providers. However, when a service is using a non-default capacity provider strategy, the
 service cannot be updated to use the cluster's default capacity provider strategy.
 
 


deploymentConfiguration
DeploymentConfiguration deploymentConfiguration

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


networkConfiguration
NetworkConfiguration networkConfiguration


platformVersion
String platformVersion

 The platform version on which your tasks in the service are running. A platform version is only specified for
 tasks using the Fargate launch type. If a platform version is not specified, the LATEST platform
 version is used by default. For more information, see AWS Fargate Platform
 Versions in the Amazon Elastic Container Service Developer Guide.
 


forceNewDeployment
Boolean forceNewDeployment

 Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option
 to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to
 use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate
 tasks onto a newer platform version.
 


healthCheckGracePeriodSeconds
Integer healthCheckGracePeriodSeconds

 The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load
 Balancing target health checks after a task has first started. This is only valid if your service is configured
 to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing
 health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the
 Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can
 prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come
 up.
 








Class com.amazonaws.services.ecs.model.UpdateServiceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


service
Service service

 The full description of your service following the update call.
 








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


Serialized Fields


cluster
String cluster

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


service
String service

 The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
 


taskSet
String taskSet

 The short name or full Amazon Resource Name (ARN) of the task set to update.
 


scale
Scale scale








Class com.amazonaws.services.ecs.model.UpdateTaskSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskSet
TaskSet taskSet








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


Serialized Fields


agentVersion
String agentVersion

 The version number of the Amazon ECS container agent.
 


agentHash
String agentHash

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


dockerVersion
String dockerVersion

 The Docker version running on the container instance.
 








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


Serialized Fields


name
String name

 The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This name
 is referenced in the sourceVolume parameter of container definition mountPoints.
 


host
HostVolumeProperties host

 This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported
 when you are using either the EC2 or Fargate launch types. The contents of the host parameter
 determine whether your bind mount host 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.
 However, the data is not guaranteed to persist after the containers associated with it stop running.
 
 
 Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows
 containers cannot mount directories on a different drive, and mount point cannot be across drives. For example,
 you can mount C:\my\path:C:\my\path and D:\:D:\, but not
 D:\my\path:C:\my\path or D:\:C:\my\path.
 


dockerVolumeConfiguration
DockerVolumeConfiguration dockerVolumeConfiguration

 This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are
 using the EC2 launch type. Windows containers only support the use of the local driver. To use bind
 mounts, specify the host parameter instead.
 


efsVolumeConfiguration
EFSVolumeConfiguration efsVolumeConfiguration

 This parameter is specified when you are using an Amazon Elastic File System (Amazon EFS) file storage. Amazon
 EFS file systems are only supported when you are using the EC2 launch type.
 
 
 
 EFSVolumeConfiguration remains in preview and is a Beta Service as defined by and subject to the
 Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms ("Beta Terms"). These Beta
 Terms apply to your participation in this preview of EFSVolumeConfiguration.
 
 








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


Serialized Fields


sourceContainer
String sourceContainer

 The name of another container within the same task definition from which to mount volumes.
 


readOnly
Boolean readOnly

 If this value is true, the container has read-only access to the volume. If this value is
 false, then the container can write to the volume. The default value is false.
 








Package com.amazonaws.services.eks.model




Class com.amazonaws.services.eks.model.AmazonEKSException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eks.model.AutoScalingGroup extends Object implements Serializable


Serialized Fields


name
String name

 The name of the Auto Scaling group associated with an Amazon EKS managed node group.
 








Class com.amazonaws.services.eks.model.BadRequestException extends AmazonEKSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eks.model.Certificate extends Object implements Serializable


Serialized Fields


data
String data

 The Base64-encoded certificate data required to communicate with your cluster. Add this to the
 certificate-authority-data section of the kubeconfig file for your cluster.
 








Class com.amazonaws.services.eks.model.ClientException extends AmazonEKSException implements Serializable

serialVersionUID:
1L



Serialized Fields


clusterName
String clusterName

 The Amazon EKS cluster associated with the exception.
 


nodegroupName
String nodegroupName

 The Amazon EKS managed node group associated with the exception.
 








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


Serialized Fields


name
String name

 The name of the cluster.
 


arn
String arn

 The Amazon Resource Name (ARN) of the cluster.
 


createdAt
Date createdAt

 The Unix epoch timestamp in seconds for when the cluster was created.
 


version
String version

 The Kubernetes server version for the cluster.
 


endpoint
String endpoint

 The endpoint for your Kubernetes API server.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make
 calls to AWS API operations on your behalf.
 


resourcesVpcConfig
VpcConfigResponse resourcesVpcConfig

 The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to
 work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group
 Considerations in the Amazon EKS User Guide.
 


logging
Logging logging

 The logging configuration for your cluster.
 


identity
Identity identity

 The identity provider information for the cluster.
 


status
String status

 The current status of the cluster.
 


certificateAuthority
Certificate certificateAuthority

 The certificate-authority-data for your cluster.
 


clientRequestToken
String clientRequestToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 


platformVersion
String platformVersion

 The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the 
 Amazon EKS User Guide .
 


tags
Map<K,V> tags

 The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a
 key and an optional value, both of which you define. Cluster tags do not propagate to any other resources
 associated with the cluster.
 








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


Serialized Fields


name
String name

 The unique name to give to your cluster.
 


version
String version

 The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available
 in Amazon EKS is used.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role that provides permissions for Amazon EKS to make calls to other
 AWS API operations on your behalf. For more information, see Amazon EKS Service IAM Role in
 the  Amazon EKS User Guide .
 


resourcesVpcConfig
VpcConfigRequest resourcesVpcConfig

 The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to
 work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group
 Considerations in the Amazon EKS User Guide. You must specify at least two subnets. You can specify up
 to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.
 


logging
Logging logging

 Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default,
 cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane
 Logs in the  Amazon EKS User Guide .
 
 
 
 CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For
 more information, see Amazon CloudWatch Pricing.
 
 


clientRequestToken
String clientRequestToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 


tags
Map<K,V> tags

 The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key
 and an optional value, both of which you define.
 








Class com.amazonaws.services.eks.model.CreateClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 The full description of your new cluster.
 








Class com.amazonaws.services.eks.model.CreateFargateProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fargateProfileName
String fargateProfileName

 The name of the Fargate profile.
 


clusterName
String clusterName

 The name of the Amazon EKS cluster to apply the Fargate profile to.
 


podExecutionRoleArn
String podExecutionRoleArn

 The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate
 profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it
 provides read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the
 Amazon EKS User Guide.
 


subnets
List<E> subnets

 The IDs of subnets to launch your pods into. At this time, pods running on Fargate are not assigned public IP
 addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.
 


selectors
List<E> selectors

 The selectors to match for pods to use this Fargate profile. Each selector must have an associated namespace.
 Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a Fargate
 profile.
 


clientRequestToken
String clientRequestToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 


tags
Map<K,V> tags

 The metadata to apply to the Fargate profile to assist with categorization and organization. Each tag consists of
 a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other
 resources associated with the Fargate profile, such as the pods that are scheduled with it.
 








Class com.amazonaws.services.eks.model.CreateFargateProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fargateProfile
FargateProfile fargateProfile

 The full description of your new Fargate profile.
 








Class com.amazonaws.services.eks.model.CreateNodegroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the cluster to create the node group in.
 


nodegroupName
String nodegroupName

 The unique name to give your node group.
 


scalingConfig
NodegroupScalingConfig scalingConfig

 The scaling configuration details for the Auto Scaling group that is created for your node group.
 


diskSize
Integer diskSize

 The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB.
 


subnets
List<E> subnets

 The subnets to use for the Auto Scaling group that is created for your node group. These subnets must have the
 tag key kubernetes.io/cluster/CLUSTER_NAME with a value of shared, where
 CLUSTER_NAME is replaced with the name of your cluster.
 


instanceTypes
List<E> instanceTypes

 The instance type to use for your node group. Currently, you can specify a single instance type for a node group.
 The default value for this parameter is t3.medium. If you choose a GPU instance type, be sure to
 specify the AL2_x86_64_GPU with the amiType parameter.
 


amiType
String amiType

 The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU AMI type, which
 uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the
 AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI.
 


remoteAccess
RemoteAccessConfig remoteAccess

 The remote access (SSH) configuration to use with your node group.
 


nodeRole
String nodeRole

 The IAM role associated with your node group. The Amazon EKS worker node kubelet daemon makes calls
 to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile
 and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an
 IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM
 Role in the  Amazon EKS User Guide .
 


labels
Map<K,V> labels

 The Kubernetes labels to be applied to the nodes in the node group when they are created.
 


tags
Map<K,V> tags

 The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a
 key and an optional value, both of which you define. Node group tags do not propagate to any other resources
 associated with the node group, such as the Amazon EC2 instances or subnets.
 


clientRequestToken
String clientRequestToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 


version
String version

 The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used,
 and this is the only accepted specified value.
 


releaseVersion
String releaseVersion

 The AMI version of the Amazon EKS-optimized AMI to use with your node group. By default, the latest available AMI
 version for the node group's current Kubernetes version is used. For more information, see Amazon EKS-Optimized Linux
 AMI Versions in the Amazon EKS User Guide.
 








Class com.amazonaws.services.eks.model.CreateNodegroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nodegroup
Nodegroup nodegroup

 The full description of your new node group.
 








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


Serialized Fields


name
String name

 The name of the cluster to delete.
 








Class com.amazonaws.services.eks.model.DeleteClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 The full description of the cluster to delete.
 








Class com.amazonaws.services.eks.model.DeleteFargateProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the Amazon EKS cluster associated with the Fargate profile to delete.
 


fargateProfileName
String fargateProfileName

 The name of the Fargate profile to delete.
 








Class com.amazonaws.services.eks.model.DeleteFargateProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fargateProfile
FargateProfile fargateProfile

 The deleted Fargate profile.
 








Class com.amazonaws.services.eks.model.DeleteNodegroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the Amazon EKS cluster that is associated with your node group.
 


nodegroupName
String nodegroupName

 The name of the node group to delete.
 








Class com.amazonaws.services.eks.model.DeleteNodegroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nodegroup
Nodegroup nodegroup

 The full description of your deleted node group.
 








Class com.amazonaws.services.eks.model.DescribeClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the cluster to describe.
 








Class com.amazonaws.services.eks.model.DescribeClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 The full description of your specified cluster.
 








Class com.amazonaws.services.eks.model.DescribeFargateProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the Amazon EKS cluster associated with the Fargate profile.
 


fargateProfileName
String fargateProfileName

 The name of the Fargate profile to describe.
 








Class com.amazonaws.services.eks.model.DescribeFargateProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fargateProfile
FargateProfile fargateProfile

 The full description of your Fargate profile.
 








Class com.amazonaws.services.eks.model.DescribeNodegroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the Amazon EKS cluster associated with the node group.
 


nodegroupName
String nodegroupName

 The name of the node group to describe.
 








Class com.amazonaws.services.eks.model.DescribeNodegroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nodegroup
Nodegroup nodegroup

 The full description of your node group.
 








Class com.amazonaws.services.eks.model.DescribeUpdateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the Amazon EKS cluster associated with the update.
 


updateId
String updateId

 The ID of the update to describe.
 


nodegroupName
String nodegroupName

 The name of the Amazon EKS node group associated with the update.
 








Class com.amazonaws.services.eks.model.DescribeUpdateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


update
Update update

 The full description of the specified update.
 








Class com.amazonaws.services.eks.model.ErrorDetail extends Object implements Serializable


Serialized Fields


errorCode
String errorCode

 A brief description of the error.
 
 
 
 
 SubnetNotFound: We couldn't find one of the subnets associated with the cluster.
 
 
 
 
 SecurityGroupNotFound: We couldn't find one of the security groups associated with the cluster.
 
 
 
 
 EniLimitReached: You have reached the elastic network interface limit for your account.
 
 
 
 
 IpNotAvailable: A subnet associated with the cluster doesn't have any free IP addresses.
 
 
 
 
 AccessDenied: You don't have permissions to perform the specified operation.
 
 
 
 
 OperationNotPermitted: The service role associated with the cluster doesn't have the required access
 permissions for Amazon EKS.
 
 
 
 
 VpcIdNotFound: We couldn't find the VPC associated with the cluster.
 
 
 


errorMessage
String errorMessage

 A more complete description of the error.
 


resourceIds
List<E> resourceIds

 An optional field that contains the resource IDs associated with the error.
 








Class com.amazonaws.services.eks.model.FargateProfile extends Object implements Serializable


Serialized Fields


fargateProfileName
String fargateProfileName

 The name of the Fargate profile.
 


fargateProfileArn
String fargateProfileArn

 The full Amazon Resource Name (ARN) of the Fargate profile.
 


clusterName
String clusterName

 The name of the Amazon EKS cluster that the Fargate profile belongs to.
 


createdAt
Date createdAt

 The Unix epoch timestamp in seconds for when the Fargate profile was created.
 


podExecutionRoleArn
String podExecutionRoleArn

 The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate
 profile. For more information, see Pod Execution Role in the
 Amazon EKS User Guide.
 


subnets
List<E> subnets

 The IDs of subnets to launch pods into.
 


selectors
List<E> selectors

 The selectors to match for pods to use this Fargate profile.
 


status
String status

 The current status of the Fargate profile.
 


tags
Map<K,V> tags

 The metadata applied to the Fargate profile to assist with categorization and organization. Each tag consists of
 a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other
 resources associated with the Fargate profile, such as the pods that are scheduled with it.
 








Class com.amazonaws.services.eks.model.FargateProfileSelector extends Object implements Serializable


Serialized Fields


namespace
String namespace

 The Kubernetes namespace that the selector should match.
 


labels
Map<K,V> labels

 The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in
 the selector for it to be considered a match.
 








Class com.amazonaws.services.eks.model.Identity extends Object implements Serializable


Serialized Fields


oidc
OIDC oidc

 The OpenID Connect identity provider information for the cluster.
 








Class com.amazonaws.services.eks.model.InvalidParameterException extends AmazonEKSException implements Serializable

serialVersionUID:
1L



Serialized Fields


clusterName
String clusterName

 The Amazon EKS cluster associated with the exception.
 


nodegroupName
String nodegroupName

 The Amazon EKS managed node group associated with the exception.
 


fargateProfileName
String fargateProfileName

 The Fargate profile associated with the exception.
 








Class com.amazonaws.services.eks.model.InvalidRequestException extends AmazonEKSException implements Serializable

serialVersionUID:
1L



Serialized Fields


clusterName
String clusterName

 The Amazon EKS cluster associated with the exception.
 


nodegroupName
String nodegroupName

 The Amazon EKS managed node group associated with the exception.
 








Class com.amazonaws.services.eks.model.Issue extends Object implements Serializable


Serialized Fields


code
String code

 A brief description of the error.
 
 
 
 
 AutoScalingGroupNotFound: We couldn't find the Auto Scaling group associated with the managed node group.
 You may be able to recreate an Auto Scaling group with the same settings to recover.
 
 
 
 
 Ec2SecurityGroupNotFound: We couldn't find the cluster security group for the cluster. You must recreate
 your cluster.
 
 
 
 
 Ec2SecurityGroupDeletionFailure: We could not delete the remote access security group for your managed
 node group. Remove any dependencies from the security group.
 
 
 
 
 Ec2LaunchTemplateNotFound: We couldn't find the Amazon EC2 launch template for your managed node group.
 You may be able to recreate a launch template with the same settings to recover.
 
 
 
 
 Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does
 not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created
 to recover.
 
 
 
 
 IamInstanceProfileNotFound: We couldn't find the IAM instance profile for your managed node group. You may
 be able to recreate an instance profile with the same settings to recover.
 
 
 
 
 IamNodeRoleNotFound: We couldn't find the IAM role for your managed node group. You may be able to
 recreate an IAM role with the same settings to recover.
 
 
 
 
 AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch
 instances.
 
 
 
 
 NodeCreationFailure: Your launched instances are unable to register with your Amazon EKS cluster. Common
 causes of this failure are insufficient worker node IAM role
 permissions or lack of outbound internet access for the nodes.
 
 
 
 
 InstanceLimitExceeded: Your AWS account is unable to launch any more instances of the specified instance
 type. You may be able to request an Amazon EC2 instance limit increase to recover.
 
 
 
 
 InsufficientFreeAddresses: One or more of the subnets associated with your managed node group does not
 have enough available IP addresses for new nodes.
 
 
 
 
 AccessDenied: Amazon EKS or one or more of your managed nodes is unable to communicate with your cluster
 API server.
 
 
 
 
 InternalFailure: These errors are usually caused by an Amazon EKS server-side issue.
 
 
 


message
String message

 The error message associated with the issue.
 


resourceIds
List<E> resourceIds

 The AWS resources that are afflicted by this issue.
 








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


Serialized Fields


maxResults
Integer maxResults

 The maximum number of cluster results returned by ListClusters in paginated output. When you use
 this parameter, ListClusters returns only maxResults results in a single page along
 with a nextToken response element. You can see the remaining results of the initial request by
 sending another ListClusters request with the returned nextToken value. This value can
 be between 1 and 100. If you don't use this parameter, 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 token should be treated as an opaque identifier that is used only to retrieve the next items in a list and
 not for other programmatic purposes.
 
 








Class com.amazonaws.services.eks.model.ListClustersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusters
List<E> clusters

 A list of all of the clusters for your account in the specified Region.
 


nextToken
String nextToken

 The nextToken value to include in a future ListClusters request. When the results of a
 ListClusters request exceed maxResults, you can use this value to retrieve the next
 page of results. This value is null when there are no more results to return.
 








Class com.amazonaws.services.eks.model.ListFargateProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the Amazon EKS cluster that you would like to listFargate profiles in.
 


maxResults
Integer maxResults

 The maximum number of Fargate profile results returned by ListFargateProfiles in paginated output.
 When you use this parameter, ListFargateProfiles returns only maxResults results in a
 single page along with a nextToken response element. You can see the remaining results of the
 initial request by sending another ListFargateProfiles request with the returned
 nextToken value. This value can be between 1 and 100. If you don't use this parameter,
 ListFargateProfiles returns up to 100 results and a nextToken value if applicable.
 


nextToken
String nextToken

 The nextToken value returned from a previous paginated ListFargateProfiles 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.
 








Class com.amazonaws.services.eks.model.ListFargateProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fargateProfileNames
List<E> fargateProfileNames

 A list of all of the Fargate profiles associated with the specified cluster.
 


nextToken
String nextToken

 The nextToken value to include in a future ListFargateProfiles request. When the
 results of a ListFargateProfiles request exceed maxResults, you can use this value to
 retrieve the next page of results. This value is null when there are no more results to return.
 








Class com.amazonaws.services.eks.model.ListNodegroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the Amazon EKS cluster that you would like to list node groups in.
 


maxResults
Integer maxResults

 The maximum number of node group results returned by ListNodegroups in paginated output. When you
 use this parameter, ListNodegroups returns only maxResults results in a single page
 along with a nextToken response element. You can see the remaining results of the initial request by
 sending another ListNodegroups request with the returned nextToken value. This value
 can be between 1 and 100. If you don't use this parameter, ListNodegroups returns up to 100 results
 and a nextToken value if applicable.
 


nextToken
String nextToken

 The nextToken value returned from a previous paginated ListNodegroups 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.
 








Class com.amazonaws.services.eks.model.ListNodegroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nodegroups
List<E> nodegroups

 A list of all of the node groups associated with the specified cluster.
 


nextToken
String nextToken

 The nextToken value to include in a future ListNodegroups request. When the results of
 a ListNodegroups request exceed maxResults, you can use this value to retrieve the next
 page of results. This value is null when there are no more results to return.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported
 resources are Amazon EKS clusters and managed node groups.
 








Class com.amazonaws.services.eks.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The tags for the resource.
 








Class com.amazonaws.services.eks.model.ListUpdatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the Amazon EKS cluster to list updates for.
 


nodegroupName
String nodegroupName

 The name of the Amazon EKS managed node group to list updates for.
 


nextToken
String nextToken

 The nextToken value returned from a previous paginated ListUpdates 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.
 


maxResults
Integer maxResults

 The maximum number of update results returned by ListUpdates in paginated output. When you use this
 parameter, ListUpdates returns only maxResults results in a single page along with a
 nextToken response element. You can see the remaining results of the initial request by sending
 another ListUpdates request with the returned nextToken value. This value can be
 between 1 and 100. If you don't use this parameter, ListUpdates returns up to 100 results and a
 nextToken value if applicable.
 








Class com.amazonaws.services.eks.model.ListUpdatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


updateIds
List<E> updateIds

 A list of all the updates for the specified cluster and Region.
 


nextToken
String nextToken

 The nextToken value to include in a future ListUpdates request. When the results of a
 ListUpdates request exceed maxResults, you can use this value to retrieve the next page
 of results. This value is null when there are no more results to return.
 








Class com.amazonaws.services.eks.model.Logging extends Object implements Serializable


Serialized Fields


clusterLogging
List<E> clusterLogging

 The cluster control plane logging configuration for your cluster.
 








Class com.amazonaws.services.eks.model.LogSetup extends Object implements Serializable


Serialized Fields


types
List<E> types

 The available cluster control plane log types.
 


enabled
Boolean enabled

 If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't
 enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled
 independently.
 








Class com.amazonaws.services.eks.model.Nodegroup extends Object implements Serializable


Serialized Fields


nodegroupName
String nodegroupName

 The name associated with an Amazon EKS managed node group.
 


nodegroupArn
String nodegroupArn

 The Amazon Resource Name (ARN) associated with the managed node group.
 


clusterName
String clusterName

 The name of the cluster that the managed node group resides in.
 


version
String version

 The Kubernetes version of the managed node group.
 


releaseVersion
String releaseVersion

 The AMI version of the managed node group. For more information, see Amazon EKS-Optimized Linux
 AMI Versions  in the Amazon EKS User Guide.
 


createdAt
Date createdAt

 The Unix epoch timestamp in seconds for when the managed node group was created.
 


modifiedAt
Date modifiedAt

 The Unix epoch timestamp in seconds for when the managed node group was last modified.
 


status
String status

 The current status of the managed node group.
 


scalingConfig
NodegroupScalingConfig scalingConfig

 The scaling configuration details for the Auto Scaling group that is associated with your node group.
 


instanceTypes
List<E> instanceTypes

 The instance types associated with your node group.
 


subnets
List<E> subnets

 The subnets allowed for the Auto Scaling group that is associated with your node group. These subnets must have
 the following tag: kubernetes.io/cluster/CLUSTER_NAME, where CLUSTER_NAME is replaced
 with the name of your cluster.
 


remoteAccess
RemoteAccessConfig remoteAccess

 The remote access (SSH) configuration that is associated with the node group.
 


amiType
String amiType

 The AMI type associated with your node group. GPU instance types should use the AL2_x86_64_GPU AMI
 type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the
 AL2_x86_64 AMI type, which uses the Amazon EKS-optimized Linux AMI.
 


nodeRole
String nodeRole

 The IAM role associated with your node group. The Amazon EKS worker node kubelet daemon makes calls
 to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile
 and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an
 IAM role for those worker nodes to use when they are launched. For more information, see Amazon EKS Worker Node IAM
 Role in the  Amazon EKS User Guide .
 


labels
Map<K,V> labels

 The Kubernetes labels applied to the nodes in the node group.
 
 
 
 Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied
 to the nodes in this group.
 
 


resources
NodegroupResources resources

 The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
 


diskSize
Integer diskSize

 The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB.
 


health
NodegroupHealth health

 The health status of the node group. If there are issues with your node group's health, they are listed here.
 


tags
Map<K,V> tags

 The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key
 and an optional value, both of which you define. Node group tags do not propagate to any other resources
 associated with the node group, such as the Amazon EC2 instances or subnets.
 








Class com.amazonaws.services.eks.model.NodegroupHealth extends Object implements Serializable


Serialized Fields


issues
List<E> issues

 Any issues that are associated with the node group.
 








Class com.amazonaws.services.eks.model.NodegroupResources extends Object implements Serializable


Serialized Fields


autoScalingGroups
List<E> autoScalingGroups

 The Auto Scaling groups associated with the node group.
 


remoteAccessSecurityGroup
String remoteAccessSecurityGroup

 The remote access security group associated with the node group. This security group controls SSH access to the
 worker nodes.
 








Class com.amazonaws.services.eks.model.NodegroupScalingConfig extends Object implements Serializable


Serialized Fields


minSize
Integer minSize

 The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than
 zero.
 


maxSize
Integer maxSize

 The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support
 up to 100 nodes by default.
 


desiredSize
Integer desiredSize

 The current number of worker nodes that the managed node group should maintain.
 








Class com.amazonaws.services.eks.model.NotFoundException extends AmazonEKSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eks.model.OIDC extends Object implements Serializable


Serialized Fields


issuer
String issuer

 The issuer URL for the OpenID Connect identity provider.
 








Class com.amazonaws.services.eks.model.RemoteAccessConfig extends Object implements Serializable


Serialized Fields


ec2SshKey
String ec2SshKey

 The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node
 group. For more information, see Amazon EC2 Key Pairs in the
 Amazon Elastic Compute Cloud User Guide for Linux Instances.
 


sourceSecurityGroups
List<E> sourceSecurityGroups

 The security groups that are allowed SSH access (port 22) to the worker nodes. If you specify an Amazon EC2 SSH
 key but do not specify a source security group when you create a managed node group, then port 22 on the worker
 nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC
 in the Amazon Virtual Private Cloud User Guide.
 








Class com.amazonaws.services.eks.model.ResourceInUseException extends AmazonEKSException implements Serializable

serialVersionUID:
1L



Serialized Fields


clusterName
String clusterName

 The Amazon EKS cluster associated with the exception.
 


nodegroupName
String nodegroupName

 The Amazon EKS managed node group associated with the exception.
 








Class com.amazonaws.services.eks.model.ResourceLimitExceededException extends AmazonEKSException implements Serializable

serialVersionUID:
1L



Serialized Fields


clusterName
String clusterName

 The Amazon EKS cluster associated with the exception.
 


nodegroupName
String nodegroupName

 The Amazon EKS managed node group associated with the exception.
 








Class com.amazonaws.services.eks.model.ResourceNotFoundException extends AmazonEKSException implements Serializable

serialVersionUID:
1L



Serialized Fields


clusterName
String clusterName

 The Amazon EKS cluster associated with the exception.
 


nodegroupName
String nodegroupName

 The Amazon EKS managed node group associated with the exception.
 


fargateProfileName
String fargateProfileName

 The Fargate profile associated with the exception.
 








Class com.amazonaws.services.eks.model.ServerException extends AmazonEKSException implements Serializable

serialVersionUID:
1L



Serialized Fields


clusterName
String clusterName

 The Amazon EKS cluster associated with the exception.
 


nodegroupName
String nodegroupName

 The Amazon EKS managed node group associated with the exception.
 








Class com.amazonaws.services.eks.model.ServiceUnavailableException extends AmazonEKSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eks.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are
 Amazon EKS clusters and managed node groups.
 


tags
Map<K,V> tags

 The tags to add to the resource. A tag is an array of key-value pairs.
 








Class com.amazonaws.services.eks.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.eks.model.UnsupportedAvailabilityZoneException extends AmazonEKSException implements Serializable

serialVersionUID:
1L



Serialized Fields


clusterName
String clusterName

 The Amazon EKS cluster associated with the exception.
 


nodegroupName
String nodegroupName

 The Amazon EKS managed node group associated with the exception.
 


validZones
List<E> validZones

 The supported Availability Zones for your account. Choose subnets in these Availability Zones for your cluster.
 








Class com.amazonaws.services.eks.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are
 Amazon EKS clusters and managed node groups.
 


tagKeys
List<E> tagKeys

 The keys of the tags to be removed.
 








Class com.amazonaws.services.eks.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.eks.model.Update extends Object implements Serializable


Serialized Fields


id
String id

 A UUID that is used to track the update.
 


status
String status

 The current status of the update.
 


type
String type

 The type of the update.
 


params
List<E> params

 A key-value map that contains the parameters associated with the update.
 


createdAt
Date createdAt

 The Unix epoch timestamp in seconds for when the update was created.
 


errors
List<E> errors

 Any errors associated with a Failed update.
 








Class com.amazonaws.services.eks.model.UpdateClusterConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the Amazon EKS cluster to update.
 


resourcesVpcConfig
VpcConfigRequest resourcesVpcConfig


logging
Logging logging

 Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default,
 cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane
 Logs in the  Amazon EKS User Guide .
 
 
 
 CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For
 more information, see Amazon CloudWatch Pricing.
 
 


clientRequestToken
String clientRequestToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 








Class com.amazonaws.services.eks.model.UpdateClusterConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


update
Update update








Class com.amazonaws.services.eks.model.UpdateClusterVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the Amazon EKS cluster to update.
 


version
String version

 The desired Kubernetes version following a successful update.
 


clientRequestToken
String clientRequestToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 








Class com.amazonaws.services.eks.model.UpdateClusterVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


update
Update update

 The full description of the specified update
 








Class com.amazonaws.services.eks.model.UpdateLabelsPayload extends Object implements Serializable


Serialized Fields


addOrUpdateLabels
Map<K,V> addOrUpdateLabels

 Kubernetes labels to be added or updated.
 


removeLabels
List<E> removeLabels

 Kubernetes labels to be removed.
 








Class com.amazonaws.services.eks.model.UpdateNodegroupConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the Amazon EKS cluster that the managed node group resides in.
 


nodegroupName
String nodegroupName

 The name of the managed node group to update.
 


labels
UpdateLabelsPayload labels

 The Kubernetes labels to be applied to the nodes in the node group after the update.
 


scalingConfig
NodegroupScalingConfig scalingConfig

 The scaling configuration details for the Auto Scaling group after the update.
 


clientRequestToken
String clientRequestToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 








Class com.amazonaws.services.eks.model.UpdateNodegroupConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


update
Update update








Class com.amazonaws.services.eks.model.UpdateNodegroupVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterName
String clusterName

 The name of the Amazon EKS cluster that is associated with the managed node group to update.
 


nodegroupName
String nodegroupName

 The name of the managed node group to update.
 


version
String version

 The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group
 does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI
 version of the cluster's Kubernetes version.
 


releaseVersion
String releaseVersion

 The AMI version of the Amazon EKS-optimized AMI to use for the update. By default, the latest available AMI
 version for the node group's Kubernetes version is used. For more information, see Amazon EKS-Optimized Linux
 AMI Versions  in the Amazon EKS User Guide.
 


force
Boolean force

 Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
 If an update fails because pods could not be drained, you can force the update after it fails to terminate the
 old node whether or not any pods are running on the node.
 


clientRequestToken
String clientRequestToken

 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
 








Class com.amazonaws.services.eks.model.UpdateNodegroupVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


update
Update update








Class com.amazonaws.services.eks.model.UpdateParam extends Object implements Serializable


Serialized Fields


type
String type

 The keys associated with an update request.
 


value
String value

 The value of the keys submitted as part of an update request.
 








Class com.amazonaws.services.eks.model.VpcConfigRequest extends Object implements Serializable


Serialized Fields


subnetIds
List<E> subnetIds

 Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in
 these subnets to allow communication between your worker nodes and the Kubernetes control plane.
 


securityGroupIds
List<E> securityGroupIds

 Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to
 use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a
 security group, the default security group for your VPC is used.
 


endpointPublicAccess
Boolean endpointPublicAccess

 Set this value to false to disable public access to your cluster's Kubernetes API server endpoint.
 If you disable public access, your cluster's Kubernetes API server can only receive requests from within the
 cluster VPC. The default value for this parameter is true, which enables public access for your
 Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access
 Control in the  Amazon EKS User Guide .
 


endpointPrivateAccess
Boolean endpointPrivateAccess

 Set this value to true to enable private access for your cluster's Kubernetes API server endpoint.
 If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC
 endpoint. The default value for this parameter is false, which disables private access for your
 Kubernetes API server. If you disable private access and you have worker nodes or AWS Fargate pods in the
 cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication
 with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access
 Control in the  Amazon EKS User Guide .
 


publicAccessCidrs
List<E> publicAccessCidrs

 The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to
 the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is
 0.0.0.0/0. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods
 in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see Amazon EKS Cluster Endpoint Access
 Control in the  Amazon EKS User Guide .
 








Class com.amazonaws.services.eks.model.VpcConfigResponse extends Object implements Serializable


Serialized Fields


subnetIds
List<E> subnetIds

 The subnets associated with your cluster.
 


securityGroupIds
List<E> securityGroupIds

 The security groups associated with the cross-account elastic network interfaces that are used to allow
 communication between your worker nodes and the Kubernetes control plane.
 


clusterSecurityGroupId
String clusterSecurityGroupId

 The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security
 group for control-plane-to-data-plane communication.
 


vpcId
String vpcId

 The VPC associated with your cluster.
 


endpointPublicAccess
Boolean endpointPublicAccess

 This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public
 API server endpoint is disabled, your cluster's Kubernetes API server can only receive requests that originate
 from within the cluster VPC.
 


endpointPrivateAccess
Boolean endpointPrivateAccess

 This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private
 API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the
 private VPC endpoint instead of traversing the internet. If this value is disabled and you have worker nodes or
 AWS Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR
 blocks for communication with the worker nodes or Fargate pods. For more information, see Amazon EKS Cluster Endpoint Access
 Control in the  Amazon EKS User Guide .
 


publicAccessCidrs
List<E> publicAccessCidrs

 The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to
 the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is
 0.0.0.0/0. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods
 in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS Cluster Endpoint Access
 Control in the  Amazon EKS User Guide .
 








Package com.amazonaws.services.elasticache.model




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


Serialized Fields


resourceName
String resourceName

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


tags
SdkInternalList<T> tags

 A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be
 accompanied by a tag value.
 








Class com.amazonaws.services.elasticache.model.AddTagsToResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagList
SdkInternalList<T> tagList

 A list of cost allocation tags as key-value pairs.
 








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

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.APICallRateForCustomerExceededException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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


Serialized Fields


cacheSecurityGroupName
String cacheSecurityGroupName

 The cache security group that allows network ingress.
 


eC2SecurityGroupName
String eC2SecurityGroupName

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


eC2SecurityGroupOwnerId
String eC2SecurityGroupOwnerId

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








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


Serialized Fields


name
String name

 The name of the Availability Zone.
 








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


Serialized Fields


replicationGroupIds
SdkInternalList<T> replicationGroupIds

 The replication group IDs
 


cacheClusterIds
SdkInternalList<T> cacheClusterIds

 The cache cluster IDs
 


serviceUpdateName
String serviceUpdateName

 The unique ID of the service update
 








Class com.amazonaws.services.elasticache.model.BatchApplyUpdateActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


processedUpdateActions
SdkInternalList<T> processedUpdateActions

 Update actions that have been processed successfully
 


unprocessedUpdateActions
SdkInternalList<T> unprocessedUpdateActions

 Update actions that haven't been processed successfully
 








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


Serialized Fields


replicationGroupIds
SdkInternalList<T> replicationGroupIds

 The replication group IDs
 


cacheClusterIds
SdkInternalList<T> cacheClusterIds

 The cache cluster IDs
 


serviceUpdateName
String serviceUpdateName

 The unique ID of the service update
 








Class com.amazonaws.services.elasticache.model.BatchStopUpdateActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


processedUpdateActions
SdkInternalList<T> processedUpdateActions

 Update actions that have been processed successfully
 


unprocessedUpdateActions
SdkInternalList<T> unprocessedUpdateActions

 Update actions that haven't been processed successfully
 








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


Serialized Fields


cacheClusterId
String cacheClusterId

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


configurationEndpoint
Endpoint configurationEndpoint

 Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by
 an application to connect to any node in the cluster. The configuration endpoint will always have
 .cfg in it.
 
 
 Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211
 


clientDownloadLandingPage
String clientDownloadLandingPage

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


cacheNodeType
String cacheNodeType

 The name of the compute and memory capacity node type for the cluster.
 
 
 The following node types are supported by ElastiCache. Generally speaking, the current generation types provide
 more memory and computational power at lower cost when compared to their equivalent previous generation
 counterparts.
 
 
 
 
 General purpose:
 
 
 
 
 Current generation:
 
 
 M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
 cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
 
 
 M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
 cache.m4.4xlarge, cache.m4.10xlarge
 
 
 T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
 
 
 
 
 Previous generation: (not recommended)
 
 
 T1 node types: cache.t1.micro
 
 
 M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
 cache.m1.xlarge
 
 
 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
 cache.m3.2xlarge
 
 
 
 
 
 
 Compute optimized:
 
 
 
 
 Previous generation: (not recommended)
 
 
 C1 node types: cache.c1.xlarge
 
 
 
 
 
 
 Memory optimized:
 
 
 
 
 Current generation:
 
 
 R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
 cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
 
 
 R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
 cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
 
 
 
 
 Previous generation: (not recommended)
 
 
 M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
 
 
 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
 cache.r3.4xlarge, cache.r3.8xlarge
 
 
 
 
 
 
 Additional node type info
 
 
 
 
 All current generation instance types are created in Amazon VPC by default.
 
 
 
 
 Redis append-only files (AOF) are not supported for T1 or T2 instances.
 
 
 
 
 Redis Multi-AZ with automatic failover is not supported on T1 instances.
 
 
 
 
 Redis configuration variables appendonly and appendfsync are not supported on Redis
 version 2.8.22 and later.
 
 
 


engine
String engine

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


engineVersion
String engineVersion

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


cacheClusterStatus
String cacheClusterStatus

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


numCacheNodes
Integer numCacheNodes

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


preferredAvailabilityZone
String preferredAvailabilityZone

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


cacheClusterCreateTime
Date cacheClusterCreateTime

 The date and time when the cluster was created.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 Specifies the weekly time range during which maintenance on the 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:23:00-mon:01:30
 


pendingModifiedValues
PendingModifiedValues pendingModifiedValues


notificationConfiguration
NotificationConfiguration notificationConfiguration

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


cacheSecurityGroups
SdkInternalList<T> cacheSecurityGroups

 A list of cache security group elements, composed of name and status sub-elements.
 


cacheParameterGroup
CacheParameterGroupStatus cacheParameterGroup

 Status of the cache parameter group.
 


cacheSubnetGroupName
String cacheSubnetGroupName

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


cacheNodes
SdkInternalList<T> cacheNodes

 A list of cache nodes that are members of the cluster.
 


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 This parameter is currently disabled.
 


securityGroups
SdkInternalList<T> securityGroups

 A list of VPC Security Groups associated with the cluster.
 


replicationGroupId
String replicationGroupId

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


snapshotRetentionLimit
Integer snapshotRetentionLimit

 The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example,
 if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days
 before being deleted.
 
 
 
 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 begins taking a daily snapshot of your cluster.
 
 
 Example: 05:00-09:00
 


authTokenEnabled
Boolean authTokenEnabled

 A flag that enables using an AuthToken (password) when issuing Redis commands.
 
 
 Default: false
 


authTokenLastModifiedDate
Date authTokenLastModifiedDate

 The date the auth token was last modified
 


transitEncryptionEnabled
Boolean transitEncryptionEnabled

 A flag that enables in-transit encryption when set to true.
 
 
 You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable
 in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when
 you create a cluster.
 
 
 Required: Only available when creating a replication group in an Amazon VPC using redis version
 3.2.6, 4.x or later.
 
 
 Default: false
 


atRestEncryptionEnabled
Boolean atRestEncryptionEnabled

 A flag that enables encryption at-rest when set to true.
 
 
 You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable
 at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you
 create a cluster.
 
 
 Required: Only available when creating a replication group in an Amazon VPC using redis version
 3.2.6, 4.x or later.
 
 
 Default: false
 








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

serialVersionUID:
1L





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

serialVersionUID:
1L





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


Serialized Fields


engine
String engine

 The name of the cache engine.
 


engineVersion
String engineVersion

 The version number of the cache engine.
 


cacheParameterGroupFamily
String cacheParameterGroupFamily

 The name of the cache parameter group family associated with this cache engine.
 
 
 Valid values are: memcached1.4 | memcached1.5 | redis2.6 |
 redis2.8 | redis3.2 | redis4.0 | redis5.0 |
 


cacheEngineDescription
String cacheEngineDescription

 The description of the cache engine.
 


cacheEngineVersionDescription
String cacheEngineVersionDescription

 The description of the cache engine version.
 








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


Serialized Fields


cacheNodeId
String cacheNodeId

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


cacheNodeStatus
String cacheNodeStatus

 The current state of this cache node.
 


cacheNodeCreateTime
Date cacheNodeCreateTime

 The date and time when the cache node was created.
 


endpoint
Endpoint endpoint

 The hostname for connecting to this cache node.
 


parameterGroupStatus
String parameterGroupStatus

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


sourceCacheNodeId
String sourceCacheNodeId

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


customerAvailabilityZone
String customerAvailabilityZone

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








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


Serialized Fields


parameterName
String parameterName

 The name of the parameter.
 


description
String description

 A description of the parameter.
 


source
String source

 The source of the parameter value.
 


dataType
String dataType

 The valid data type for the parameter.
 


allowedValues
String allowedValues

 The valid range of values for the parameter.
 


isModifiable
Boolean isModifiable

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


minimumEngineVersion
String minimumEngineVersion

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


cacheNodeTypeSpecificValues
SdkInternalList<T> cacheNodeTypeSpecificValues

 A list of cache node types and their corresponding values for this parameter.
 


changeType
String changeType

 Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be
 applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a
 Cluster.
 








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


Serialized Fields


cacheNodeType
String cacheNodeType

 The cache node type for which this value applies.
 


value
String value

 The value for the cache node type.
 








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


Serialized Fields


cacheNodeId
String cacheNodeId

 The node ID of the cache cluster
 


nodeUpdateStatus
String nodeUpdateStatus

 The update status of the node
 


nodeDeletionDate
Date nodeDeletionDate

 The deletion date of the node
 


nodeUpdateStartDate
Date nodeUpdateStartDate

 The start date of the update for a node
 


nodeUpdateEndDate
Date nodeUpdateEndDate

 The end date of the update for a node
 


nodeUpdateInitiatedBy
String nodeUpdateInitiatedBy

 Reflects whether the update was initiated by the customer or automatically applied
 


nodeUpdateInitiatedDate
Date nodeUpdateInitiatedDate

 The date when the update is triggered
 


nodeUpdateStatusModifiedDate
Date nodeUpdateStatusModifiedDate

 The date when the NodeUpdateStatus was last modified>
 








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


Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName

 The name of the cache parameter group.
 


cacheParameterGroupFamily
String cacheParameterGroupFamily

 The name of the cache parameter group family that this cache parameter group is compatible with.
 
 
 Valid values are: memcached1.4 | memcached1.5 | redis2.6 |
 redis2.8 | redis3.2 | redis4.0 | redis5.0 |
 


description
String description

 The description for this cache parameter group.
 








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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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


Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName

 The name of the cache parameter group.
 


parameterApplyStatus
String parameterApplyStatus

 The status of parameter updates.
 


cacheNodeIdsToReboot
SdkInternalList<T> cacheNodeIdsToReboot

 A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a
 numeric identifier (0001, 0002, etc.).
 








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


Serialized Fields


ownerId
String ownerId

 The AWS account ID of the cache security group owner.
 


cacheSecurityGroupName
String cacheSecurityGroupName

 The name of the cache security group.
 


description
String description

 The description of the cache security group.
 


eC2SecurityGroups
SdkInternalList<T> eC2SecurityGroups

 A list of Amazon EC2 security groups that are associated with this cache security group.
 








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

serialVersionUID:
1L





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


Serialized Fields


cacheSecurityGroupName
String cacheSecurityGroupName

 The name of the cache security group.
 


status
String status

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








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

serialVersionUID:
1L





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

serialVersionUID:
1L





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


Serialized Fields


cacheSubnetGroupName
String cacheSubnetGroupName

 The name of the cache subnet group.
 


cacheSubnetGroupDescription
String cacheSubnetGroupDescription

 The description of the cache subnet group.
 


vpcId
String vpcId

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


subnets
SdkInternalList<T> subnets

 A list of subnets associated with the cache subnet group.
 








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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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


Serialized Fields


replicationGroupId
String replicationGroupId

 The ID of the replication group to which data is being migrated.
 


force
Boolean force

 Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to
 abort the migration and not recommended when application wants to continue migration to ElastiCache.
 








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


Serialized Fields


nodeGroupId
String nodeGroupId

 The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the
 node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.
 


newReplicaCount
Integer newReplicaCount

 The number of replicas you want in this node group at the end of this operation. The maximum value for
 NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are
 working with.
 
 
 The minimum number of replicas in a shard or replication group is:
 
 
 
 
 Redis (cluster mode disabled)
 
 
 
 
 If Multi-AZ with Automatic Failover is enabled: 1
 
 
 
 
 If Multi-AZ with Automatic Failover is not enable: 0
 
 
 
 
 
 
 Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
 
 
 


preferredAvailabilityZones
SdkInternalList<T> preferredAvailabilityZones

 A list of PreferredAvailabilityZone strings that specify which availability zones the replication
 group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of
 NewReplicaCount plus 1 to account for the primary node. If this member of
 ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the
 replicas.
 








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


Serialized Fields


sourceSnapshotName
String sourceSnapshotName

 The name of an existing snapshot from which to make a copy.
 


targetSnapshotName
String targetSnapshotName

 A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be
 unique within its context - ElastiCache or an Amazon S3 bucket if exporting.
 


targetBucket
String targetBucket

 The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for
 external access.
 
 
 When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3
 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.
 
 
 For more information, see Exporting a
 Snapshot in the Amazon ElastiCache User Guide.
 


kmsKeyId
String kmsKeyId

 The ID of the KMS key used to encrypt the target snapshot.
 








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


Serialized Fields


cacheClusterId
String cacheClusterId

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


replicationGroupId
String replicationGroupId

 The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster
 is added to the specified replication group as a read replica; otherwise, the cluster is 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 cluster is
 created in Availability Zones that provide the best spread of read replicas across Availability Zones.
 
 
 
 This parameter is only valid if the Engine parameter is redis.
 
 


aZMode
String aZMode

 Specifies whether the nodes in this Memcached cluster 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 clusters.
 
 
 If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes
 single-az mode.
 


preferredAvailabilityZone
String preferredAvailabilityZone

 The EC2 Availability Zone in which the cluster is created.
 
 
 All nodes belonging to this Memcached 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
SdkInternalList<T> preferredAvailabilityZones

 A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not
 important.
 
 
 This option is only supported on Memcached.
 
 
 
 If you are creating your 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.
 


numCacheNodes
Integer numCacheNodes

 The initial number of cache nodes that the cluster has.
 
 
 For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1
 and 20.
 
 
 If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request
 form at http://aws.amazon.com/contact-us
 /elasticache-node-limit-request/.
 


cacheNodeType
String cacheNodeType

 The compute and memory capacity of the nodes in the node group (shard).
 
 
 The following node types are supported by ElastiCache. Generally speaking, the current generation types provide
 more memory and computational power at lower cost when compared to their equivalent previous generation
 counterparts.
 
 
 
 
 General purpose:
 
 
 
 
 Current generation:
 
 
 M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
 cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
 
 
 M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
 cache.m4.4xlarge, cache.m4.10xlarge
 
 
 T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
 
 
 
 
 Previous generation: (not recommended)
 
 
 T1 node types: cache.t1.micro
 
 
 M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
 cache.m1.xlarge
 
 
 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
 cache.m3.2xlarge
 
 
 
 
 
 
 Compute optimized:
 
 
 
 
 Previous generation: (not recommended)
 
 
 C1 node types: cache.c1.xlarge
 
 
 
 
 
 
 Memory optimized:
 
 
 
 
 Current generation:
 
 
 R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
 cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
 
 
 R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
 cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
 
 
 
 
 Previous generation: (not recommended)
 
 
 M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
 
 
 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
 cache.r3.4xlarge, cache.r3.8xlarge
 
 
 
 
 
 
 Additional node type info
 
 
 
 
 All current generation instance types are created in Amazon VPC by default.
 
 
 
 
 Redis append-only files (AOF) are not supported for T1 or T2 instances.
 
 
 
 
 Redis Multi-AZ with automatic failover is not supported on T1 instances.
 
 
 
 
 Redis configuration variables appendonly and appendfsync are not supported on Redis
 version 2.8.22 and later.
 
 
 


engine
String engine

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


engineVersion
String engineVersion

 The version number of the cache engine to be used for this cluster. To view the supported cache engine versions,
 use the DescribeCacheEngineVersions operation.
 
 
 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 cluster or replication group and create it anew with the
 earlier engine version.
 


cacheParameterGroupName
String cacheParameterGroupName

 The name of the parameter group to associate with this cluster. If this argument is omitted, the default
 parameter group for the specified engine is used. You cannot use any parameter group which has
 cluster-enabled='yes' when creating a cluster.
 


cacheSubnetGroupName
String cacheSubnetGroupName

 The name of the subnet group to be used for the cluster.
 
 
 Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
 
 
 
 If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start
 creating a cluster. For more information, see Subnets and Subnet
 Groups.
 
 


cacheSecurityGroupNames
SdkInternalList<T> cacheSecurityGroupNames

 A list of security group names to associate with this cluster.
 
 
 Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).
 


securityGroupIds
SdkInternalList<T> securityGroupIds

 One or more VPC security groups associated with the cluster.
 
 
 Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).
 


tags
SdkInternalList<T> tags

 A list of cost allocation tags to be added to this resource.
 


snapshotArns
SdkInternalList<T> snapshotArns

 A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB
 snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3
 object name in the ARN cannot contain any commas.
 
 
 
 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 Redis snapshot from which to restore data into the new node group (shard). The snapshot status
 changes to restoring while the new node group (shard) is being created.
 
 
 
 This parameter is only valid if the Engine parameter is redis.
 
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 Specifies the weekly time range during which maintenance on the 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:
 
 
 Specifies the weekly time range during which maintenance on the 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:23:00-mon:01:30
 


port
Integer port

 The port number on which each of the cache nodes accepts connections.
 


notificationTopicArn
String notificationTopicArn

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


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 This parameter is currently disabled.
 


snapshotRetentionLimit
Integer snapshotRetentionLimit

 The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you
 set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.
 
 
 
 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 begins taking a daily snapshot of your node group (shard).
 
 
 Example: 05:00-09:00
 
 
 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
 
 
 
 This parameter is only valid if the Engine parameter is redis.
 
 


authToken
String authToken

 Reserved parameter. The password used to access a password protected server.
 
 
 Password constraints:
 
 
 
 
 Must be only printable ASCII characters.
 
 
 
 
 Must be at least 16 characters and no more than 128 characters in length.
 
 
 
 
 The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special
 characters cannot be used in the AUTH token.
 
 
 
 
 For more information, see AUTH password at
 http://redis.io/commands/AUTH.
 








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


Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName

 A user-specified name for the cache parameter group.
 


cacheParameterGroupFamily
String cacheParameterGroupFamily

 The name of the cache parameter group family that the cache parameter group can be used with.
 
 
 Valid values are: memcached1.4 | memcached1.5 | redis2.6 |
 redis2.8 | redis3.2 | redis4.0 | redis5.0 |
 


description
String description

 A user-specified description for the cache parameter group.
 








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


Serialized Fields


cacheSecurityGroupName
String cacheSecurityGroupName

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


description
String description

 A description for the cache security group.
 








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


Serialized Fields


cacheSubnetGroupName
String cacheSubnetGroupName

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


cacheSubnetGroupDescription
String cacheSubnetGroupDescription

 A description for the cache subnet group.
 


subnetIds
SdkInternalList<T> subnetIds

 A list of VPC subnet IDs for the cache subnet group.
 








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


Serialized Fields


replicationGroupId
String replicationGroupId

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


replicationGroupDescription
String replicationGroupDescription

 A user-created description for the replication group.
 


primaryClusterId
String primaryClusterId

 The identifier of the cluster that serves as the primary for this replication group. This cluster must already
 exist and have a status of available.
 
 
 This parameter is not required if NumCacheClusters, NumNodeGroups, or
 ReplicasPerNodeGroup is specified.
 


automaticFailoverEnabled
Boolean automaticFailoverEnabled

 Specifies whether a read-only replica is 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.
 
 
 AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.
 
 
 Default: false
 
 
 Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
 
 
 
 
 Redis versions earlier than 2.8.6.
 
 
 
 
 Redis (cluster mode disabled): T1 node types.
 
 
 
 
 Redis (cluster mode enabled): T1 node types.
 
 
 


numCacheClusters
Integer numCacheClusters

 The number of clusters this replication group initially has.
 
 
 This parameter is not used if there is more than one node group (shard). You should use
 ReplicasPerNodeGroup instead.
 
 
 If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If
 AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1),
 or you can explicitly set it to a value between 2 and 6.
 
 
 The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).
 


preferredCacheClusterAZs
SdkInternalList<T> preferredCacheClusterAZs

 A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the
 Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in
 the first AZ in the list.
 
 
 This parameter is not used if there is more than one node group (shard). You should use
 NodeGroupConfiguration instead.
 
 
 
 If you are creating your replication group in an Amazon VPC (recommended), you can only locate 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.
 


numNodeGroups
Integer numNodeGroups

 An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled)
 replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.
 
 
 Default: 1
 


replicasPerNodeGroup
Integer replicasPerNodeGroup

 An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0
 to 5.
 


nodeGroupConfiguration
SdkInternalList<T> nodeGroupConfiguration

 A list of node group (shard) configuration options. Each node group (shard) configuration has the following
 members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount,
 and Slots.
 
 
 If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can
 use this parameter to individually configure each node group (shard), or you can omit this parameter. However,
 when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file, you must configure each node group
 (shard) using this parameter because you must specify the slots for each node group.
 


cacheNodeType
String cacheNodeType

 The compute and memory capacity of the nodes in the node group (shard).
 
 
 The following node types are supported by ElastiCache. Generally speaking, the current generation types provide
 more memory and computational power at lower cost when compared to their equivalent previous generation
 counterparts.
 
 
 
 
 General purpose:
 
 
 
 
 Current generation:
 
 
 M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
 cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
 
 
 M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
 cache.m4.4xlarge, cache.m4.10xlarge
 
 
 T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
 
 
 
 
 Previous generation: (not recommended)
 
 
 T1 node types: cache.t1.micro
 
 
 M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
 cache.m1.xlarge
 
 
 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
 cache.m3.2xlarge
 
 
 
 
 
 
 Compute optimized:
 
 
 
 
 Previous generation: (not recommended)
 
 
 C1 node types: cache.c1.xlarge
 
 
 
 
 
 
 Memory optimized:
 
 
 
 
 Current generation:
 
 
 R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
 cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
 
 
 R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
 cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
 
 
 
 
 Previous generation: (not recommended)
 
 
 M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
 
 
 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
 cache.r3.4xlarge, cache.r3.8xlarge
 
 
 
 
 
 
 Additional node type info
 
 
 
 
 All current generation instance types are created in Amazon VPC by default.
 
 
 
 
 Redis append-only files (AOF) are not supported for T1 or T2 instances.
 
 
 
 
 Redis Multi-AZ with automatic failover is not supported on T1 instances.
 
 
 
 
 Redis configuration variables appendonly and appendfsync are not supported on Redis
 version 2.8.22 and later.
 
 
 


engine
String engine

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


engineVersion
String engineVersion

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


cacheParameterGroupName
String cacheParameterGroupName

 The name of the parameter group to associate with this replication group. If this argument is omitted, the
 default cache parameter group for the specified engine is used.
 
 
 
 If you are restoring to an engine version that is different than the original, you must specify the default
 version of that version. For example, CacheParameterGroupName=default.redis4.0.
 
 
 
 If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter
 group, we recommend that you specify the parameter group by name.
 
 
 
 
 To create a Redis (cluster mode disabled) replication group, use
 CacheParameterGroupName=default.redis3.2.
 
 
 
 
 To create a Redis (cluster mode enabled) replication group, use
 CacheParameterGroupName=default.redis3.2.cluster.on.
 
 
 


cacheSubnetGroupName
String cacheSubnetGroupName

 The name of the cache subnet group to be used for the replication group.
 
 
 
 If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start
 creating a cluster. For more information, see Subnets and Subnet
 Groups.
 
 


cacheSecurityGroupNames
SdkInternalList<T> cacheSecurityGroupNames

 A list of cache security group names to associate with this replication group.
 


securityGroupIds
SdkInternalList<T> securityGroupIds

 One or more Amazon VPC security groups associated with this replication group.
 
 
 Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon
 VPC).
 


tags
SdkInternalList<T> tags

 A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=
 myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=
 myKey, Value=myKeyValue Key=mySecondKey, Value=
 mySecondKeyValue.
 


snapshotArns
SdkInternalList<T> snapshotArns

 A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3.
 The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot
 contain any commas. The new replication group will have the number of node groups (console: shards) specified by
 the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration
 regardless of the number of ARNs specified here.
 
 
 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 replication group. The snapshot status changes to
 restoring while the new replication group is being created.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 Specifies the weekly time range during which maintenance on the 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:
 
 
 Specifies the weekly time range during which maintenance on the 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:23:00-mon:01:30
 


port
Integer port

 The port number on which each member of the replication group accepts connections.
 


notificationTopicArn
String notificationTopicArn

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


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 This parameter is currently disabled.
 


snapshotRetentionLimit
Integer snapshotRetentionLimit

 The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you
 set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being
 deleted.
 
 
 Default: 0 (i.e., automatic backups are disabled for this cluster).
 


snapshotWindow
String snapshotWindow

 The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
 
 
 Example: 05:00-09:00
 
 
 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
 


authToken
String authToken

 Reserved parameter. The password used to access a password protected server.
 
 
 AuthToken can be specified only on replication groups where TransitEncryptionEnabled is
 true.
 
 
 
 For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an
 AuthToken, and a CacheSubnetGroup.
 
 
 
 Password constraints:
 
 
 
 
 Must be only printable ASCII characters.
 
 
 
 
 Must be at least 16 characters and no more than 128 characters in length.
 
 
 
 
 The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special
 characters cannot be used in the AUTH token.
 
 
 
 
 For more information, see AUTH password at
 http://redis.io/commands/AUTH.
 


transitEncryptionEnabled
Boolean transitEncryptionEnabled

 A flag that enables in-transit encryption when set to true.
 
 
 You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable
 in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when
 you create a cluster.
 
 
 This parameter is valid only if the Engine parameter is redis, the
 EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being
 created in an Amazon VPC.
 
 
 If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.
 
 
 Required: Only available when creating a replication group in an Amazon VPC using redis version
 3.2.6, 4.x or later.
 
 
 Default: false
 
 
 
 For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an
 AuthToken, and a CacheSubnetGroup.
 
 


atRestEncryptionEnabled
Boolean atRestEncryptionEnabled

 A flag that enables encryption at rest when set to true.
 
 
 You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To
 enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to
 true when you create the replication group.
 
 
 Required: Only available when creating a replication group in an Amazon VPC using redis version
 3.2.6, 4.x or later.
 
 
 Default: false
 


kmsKeyId
String kmsKeyId

 The ID of the KMS key used to encrypt the disk on the cluster.
 








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


Serialized Fields


replicationGroupId
String replicationGroupId

 The identifier of an existing replication group. The snapshot is created from this replication group.
 


cacheClusterId
String cacheClusterId

 The identifier of an existing cluster. The snapshot is created from this cluster.
 


snapshotName
String snapshotName

 A name for the snapshot being created.
 


kmsKeyId
String kmsKeyId

 The ID of the KMS key used to encrypt the snapshot.
 








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


Serialized Fields


address
String address

 The address of the node endpoint
 


port
Integer port

 The port of the node endpoint
 








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


Serialized Fields


replicationGroupId
String replicationGroupId

 The id of the replication group from which you want to remove replica nodes.
 


newReplicaCount
Integer newReplicaCount

 The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled)
 replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode
 enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
 
 
 The minimum number of replicas in a shard or replication group is:
 
 
 
 
 Redis (cluster mode disabled)
 
 
 
 
 If Multi-AZ with Automatic Failover is enabled: 1
 
 
 
 
 If Multi-AZ with Automatic Failover is not enabled: 0
 
 
 
 
 
 
 Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)
 
 
 


replicaConfiguration
SdkInternalList<T> replicaConfiguration

 A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode
 enabled) replication group. The ConfigureShard has three members: NewReplicaCount,
 NodeGroupId, and PreferredAvailabilityZones.
 


replicasToRemove
SdkInternalList<T> replicasToRemove

 A list of the node ids to remove from the replication group or node group (shard).
 


applyImmediately
Boolean applyImmediately

 If True, the number of replica nodes is decreased immediately. ApplyImmediately=False
 is not currently supported.
 








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


Serialized Fields


cacheClusterId
String cacheClusterId

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


finalSnapshotIdentifier
String finalSnapshotIdentifier

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








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


Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName

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








Class com.amazonaws.services.elasticache.model.DeleteCacheParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


cacheSecurityGroupName
String cacheSecurityGroupName

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








Class com.amazonaws.services.elasticache.model.DeleteCacheSecurityGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


cacheSubnetGroupName
String cacheSubnetGroupName

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








Class com.amazonaws.services.elasticache.model.DeleteCacheSubnetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


replicationGroupId
String replicationGroupId

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


retainPrimaryCluster
Boolean retainPrimaryCluster

 If set to true, all of the read replicas are deleted, but the primary node is retained.
 


finalSnapshotIdentifier
String finalSnapshotIdentifier

 The name of a final node group (shard) 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 replication group is immediately deleted.
 








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


Serialized Fields


snapshotName
String snapshotName

 The name of the snapshot to be deleted.
 








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


Serialized Fields


cacheClusterId
String cacheClusterId

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


maxRecords
Integer maxRecords

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


marker
String marker

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


showCacheNodeInfo
Boolean showCacheNodeInfo

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


showCacheClustersNotInReplicationGroups
Boolean showCacheClustersNotInReplicationGroups

 An optional flag that can be included in the DescribeCacheCluster request to show only nodes
 (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node
 Redis clusters.
 








Class com.amazonaws.services.elasticache.model.DescribeCacheClustersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 Provides an identifier to allow retrieval of paginated results.
 


cacheClusters
SdkInternalList<T> cacheClusters

 A list of clusters. Each item in the list contains detailed information about one cluster.
 








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


Serialized Fields


engine
String engine

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


engineVersion
String engineVersion

 The cache engine version to return.
 
 
 Example: 1.4.14
 


cacheParameterGroupFamily
String cacheParameterGroupFamily

 The name of a specific cache parameter group family to return details for.
 
 
 Valid values are: memcached1.4 | memcached1.5 | redis2.6 |
 redis2.8 | redis3.2 | redis4.0 | redis5.0 |
 
 
 Constraints:
 
 
 
 
 Must be 1 to 255 alphanumeric characters
 
 
 
 
 First character must be a letter
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens
 
 
 


maxRecords
Integer maxRecords

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


marker
String marker

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


defaultOnly
Boolean defaultOnly

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








Class com.amazonaws.services.elasticache.model.DescribeCacheEngineVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 Provides an identifier to allow retrieval of paginated results.
 


cacheEngineVersions
SdkInternalList<T> cacheEngineVersions

 A list of cache engine version details. Each element in the list contains detailed information about one cache
 engine version.
 








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


Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName

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


maxRecords
Integer maxRecords

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


marker
String marker

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








Class com.amazonaws.services.elasticache.model.DescribeCacheParameterGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 Provides an identifier to allow retrieval of paginated results.
 


cacheParameterGroups
SdkInternalList<T> cacheParameterGroups

 A list of cache parameter groups. Each element in the list contains detailed information about one cache
 parameter group.
 








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


Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName

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


source
String source

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


maxRecords
Integer maxRecords

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


marker
String marker

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








Class com.amazonaws.services.elasticache.model.DescribeCacheParametersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 Provides an identifier to allow retrieval of paginated results.
 


parameters
SdkInternalList<T> parameters

 A list of Parameter instances.
 


cacheNodeTypeSpecificParameters
SdkInternalList<T> cacheNodeTypeSpecificParameters

 A list of parameters specific to a particular cache node type. Each element in the list contains detailed
 information about one parameter.
 








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


Serialized Fields


cacheSecurityGroupName
String cacheSecurityGroupName

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


maxRecords
Integer maxRecords

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


marker
String marker

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








Class com.amazonaws.services.elasticache.model.DescribeCacheSecurityGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 Provides an identifier to allow retrieval of paginated results.
 


cacheSecurityGroups
SdkInternalList<T> cacheSecurityGroups

 A list of cache security groups. Each element in the list contains detailed information about one group.
 








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


Serialized Fields


cacheSubnetGroupName
String cacheSubnetGroupName

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


maxRecords
Integer maxRecords

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


marker
String marker

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








Class com.amazonaws.services.elasticache.model.DescribeCacheSubnetGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 Provides an identifier to allow retrieval of paginated results.
 


cacheSubnetGroups
SdkInternalList<T> cacheSubnetGroups

 A list of cache subnet groups. Each element in the list contains detailed information about one group.
 








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


Serialized Fields


cacheParameterGroupFamily
String cacheParameterGroupFamily

 The name of the cache parameter group family.
 
 
 Valid values are: memcached1.4 | memcached1.5 | redis2.6 |
 redis2.8 | redis3.2 | redis4.0 | redis5.0 |
 


maxRecords
Integer maxRecords

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


marker
String marker

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








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


Serialized Fields


sourceIdentifier
String sourceIdentifier

 The identifier of the event source for which events are returned. If not specified, 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.
 


startTime
Date startTime

 The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
 
 
 Example: 2017-03-30T07:03:49.555Z
 


endTime
Date endTime

 The end of the time interval for which to retrieve events, specified in ISO 8601 format.
 
 
 Example: 2017-03-30T07:03:49.555Z
 


duration
Integer duration

 The number of minutes worth of events to retrieve.
 


maxRecords
Integer maxRecords

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


marker
String marker

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








Class com.amazonaws.services.elasticache.model.DescribeEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 Provides an identifier to allow retrieval of paginated results.
 


events
SdkInternalList<T> events

 A list of events. Each element in the list contains detailed information about one event.
 








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


Serialized Fields


replicationGroupId
String replicationGroupId

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


maxRecords
Integer maxRecords

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


marker
String marker

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








Class com.amazonaws.services.elasticache.model.DescribeReplicationGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 Provides an identifier to allow retrieval of paginated results.
 


replicationGroups
SdkInternalList<T> replicationGroups

 A list of replication groups. Each item in the list contains detailed information about one replication group.
 








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


Serialized Fields


reservedCacheNodesOfferingId
String reservedCacheNodesOfferingId

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


cacheNodeType
String cacheNodeType

 The cache node type filter value. Use this parameter to show only the available offerings matching the specified
 cache node type.
 
 
 The following node types are supported by ElastiCache. Generally speaking, the current generation types provide
 more memory and computational power at lower cost when compared to their equivalent previous generation
 counterparts.
 
 
 
 
 General purpose:
 
 
 
 
 Current generation:
 
 
 M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
 cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
 
 
 M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
 cache.m4.4xlarge, cache.m4.10xlarge
 
 
 T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
 
 
 
 
 Previous generation: (not recommended)
 
 
 T1 node types: cache.t1.micro
 
 
 M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
 cache.m1.xlarge
 
 
 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
 cache.m3.2xlarge
 
 
 
 
 
 
 Compute optimized:
 
 
 
 
 Previous generation: (not recommended)
 
 
 C1 node types: cache.c1.xlarge
 
 
 
 
 
 
 Memory optimized:
 
 
 
 
 Current generation:
 
 
 R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
 cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
 
 
 R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
 cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
 
 
 
 
 Previous generation: (not recommended)
 
 
 M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
 
 
 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
 cache.r3.4xlarge, cache.r3.8xlarge
 
 
 
 
 
 
 Additional node type info
 
 
 
 
 All current generation instance types are created in Amazon VPC by default.
 
 
 
 
 Redis append-only files (AOF) are not supported for T1 or T2 instances.
 
 
 
 
 Redis Multi-AZ with automatic failover is not supported on T1 instances.
 
 
 
 
 Redis configuration variables appendonly and appendfsync are not supported on Redis
 version 2.8.22 and later.
 
 
 


duration
String duration

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


productDescription
String productDescription

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


offeringType
String offeringType

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


maxRecords
Integer maxRecords

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


marker
String marker

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








Class com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesOfferingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 Provides an identifier to allow retrieval of paginated results.
 


reservedCacheNodesOfferings
SdkInternalList<T> reservedCacheNodesOfferings

 A list of reserved cache node offerings. Each element in the list contains detailed information about one
 offering.
 








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


Serialized Fields


reservedCacheNodeId
String reservedCacheNodeId

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


reservedCacheNodesOfferingId
String reservedCacheNodesOfferingId

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


cacheNodeType
String cacheNodeType

 The cache node type filter value. Use this parameter to show only those reservations matching the specified cache
 node type.
 
 
 The following node types are supported by ElastiCache. Generally speaking, the current generation types provide
 more memory and computational power at lower cost when compared to their equivalent previous generation
 counterparts.
 
 
 
 
 General purpose:
 
 
 
 
 Current generation:
 
 
 M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
 cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
 
 
 M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
 cache.m4.4xlarge, cache.m4.10xlarge
 
 
 T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
 
 
 
 
 Previous generation: (not recommended)
 
 
 T1 node types: cache.t1.micro
 
 
 M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
 cache.m1.xlarge
 
 
 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
 cache.m3.2xlarge
 
 
 
 
 
 
 Compute optimized:
 
 
 
 
 Previous generation: (not recommended)
 
 
 C1 node types: cache.c1.xlarge
 
 
 
 
 
 
 Memory optimized:
 
 
 
 
 Current generation:
 
 
 R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
 cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
 
 
 R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
 cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
 
 
 
 
 Previous generation: (not recommended)
 
 
 M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
 
 
 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
 cache.r3.4xlarge, cache.r3.8xlarge
 
 
 
 
 
 
 Additional node type info
 
 
 
 
 All current generation instance types are created in Amazon VPC by default.
 
 
 
 
 Redis append-only files (AOF) are not supported for T1 or T2 instances.
 
 
 
 
 Redis Multi-AZ with automatic failover is not supported on T1 instances.
 
 
 
 
 Redis configuration variables appendonly and appendfsync are not supported on Redis
 version 2.8.22 and later.
 
 
 


duration
String duration

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


productDescription
String productDescription

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


offeringType
String offeringType

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


maxRecords
Integer maxRecords

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


marker
String marker

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








Class com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 Provides an identifier to allow retrieval of paginated results.
 


reservedCacheNodes
SdkInternalList<T> reservedCacheNodes

 A list of reserved cache nodes. Each element in the list contains detailed information about one node.
 








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


Serialized Fields


serviceUpdateName
String serviceUpdateName

 The unique ID of the service update
 


serviceUpdateStatus
SdkInternalList<T> serviceUpdateStatus

 The status of the service update
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response
 


marker
String marker

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








Class com.amazonaws.services.elasticache.model.DescribeServiceUpdatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

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


serviceUpdates
SdkInternalList<T> serviceUpdates

 A list of service updates
 








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


Serialized Fields


replicationGroupId
String replicationGroupId

 A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that
 specific replication group are described.
 


cacheClusterId
String cacheClusterId

 A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific
 cluster are described.
 


snapshotName
String snapshotName

 A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
 


snapshotSource
String snapshotSource

 If set to system, the output shows snapshots that were automatically created by ElastiCache. If set
 to user the output shows snapshots that were manually created. If omitted, the output shows both
 automatically and manually created snapshots.
 


marker
String marker

 An optional marker returned from a prior request. Use this marker for pagination of results from this operation.
 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.
 


showNodeGroupConfig
Boolean showNodeGroupConfig

 A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
 








Class com.amazonaws.services.elasticache.model.DescribeSnapshotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

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


snapshots
SdkInternalList<T> snapshots

 A list of snapshots. Each item in the list contains detailed information about one snapshot.
 








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


Serialized Fields


serviceUpdateName
String serviceUpdateName

 The unique ID of the service update
 


replicationGroupIds
SdkInternalList<T> replicationGroupIds

 The replication group IDs
 


cacheClusterIds
SdkInternalList<T> cacheClusterIds

 The cache cluster IDs
 


engine
String engine

 The Elasticache engine to which the update applies. Either Redis or Memcached
 


serviceUpdateStatus
SdkInternalList<T> serviceUpdateStatus

 The status of the service update
 


serviceUpdateTimeRange
TimeRangeFilter serviceUpdateTimeRange

 The range of time specified to search for service updates that are in available status
 


updateActionStatus
SdkInternalList<T> updateActionStatus

 The status of the update action.
 


showNodeLevelUpdateStatus
Boolean showNodeLevelUpdateStatus

 Dictates whether to include node level update status in the response
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response
 


marker
String marker

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








Class com.amazonaws.services.elasticache.model.DescribeUpdateActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

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


updateActions
SdkInternalList<T> updateActions

 Returns a list of update actions
 








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


Serialized Fields


status
String status

 The status of the Amazon EC2 security group.
 


eC2SecurityGroupName
String eC2SecurityGroupName

 The name of the Amazon EC2 security group.
 


eC2SecurityGroupOwnerId
String eC2SecurityGroupOwnerId

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








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


Serialized Fields


address
String address

 The DNS hostname of the cache node.
 


port
Integer port

 The port number that the cache engine is listening on.
 








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


Serialized Fields


cacheParameterGroupFamily
String cacheParameterGroupFamily

 Specifies the name of the cache parameter group family to which the engine default parameters apply.
 
 
 Valid values are: memcached1.4 | memcached1.5 | redis2.6 |
 redis2.8 | redis3.2 | redis4.0 | redis5.0 |
 


marker
String marker

 Provides an identifier to allow retrieval of paginated results.
 


parameters
SdkInternalList<T> parameters

 Contains a list of engine default parameters.
 


cacheNodeTypeSpecificParameters
SdkInternalList<T> cacheNodeTypeSpecificParameters

 A list of parameters specific to a particular cache node type. Each element in the list contains detailed
 information about one parameter.
 








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


Serialized Fields


sourceIdentifier
String sourceIdentifier

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


sourceType
String sourceType

 Specifies the origin of this event - a cluster, a parameter group, a security group, etc.
 


message
String message

 The text of the event.
 


date
Date date

 The date and time when the event occurred.
 








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


Serialized Fields


replicationGroupId
String replicationGroupId

 The id of the replication group to which you want to add replica nodes.
 


newReplicaCount
Integer newReplicaCount

 The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled)
 replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode
 enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.
 


replicaConfiguration
SdkInternalList<T> replicaConfiguration

 A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode
 enabled) replication group. The ConfigureShard has three members: NewReplicaCount,
 NodeGroupId, and PreferredAvailabilityZones.
 


applyImmediately
Boolean applyImmediately

 If True, the number of replica nodes is increased immediately. ApplyImmediately=False
 is not currently supported.
 








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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.InvalidKMSKeyException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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

serialVersionUID:
1L





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


Serialized Fields


cacheClusterId
String cacheClusterId

 The name of the 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 create a list of node types you can scale up to.
 
 
 
 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.
 
 
 
 You must provide a value for either the CacheClusterId or the ReplicationGroupId.
 
 








Class com.amazonaws.services.elasticache.model.ListAllowedNodeTypeModificationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


scaleUpModifications
SdkInternalList<T> scaleUpModifications

 A string list, each element of which specifies a cache node type which you can use to scale your 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.
 


scaleDownModifications
SdkInternalList<T> scaleDownModifications

 A string list, each element of which specifies a cache node type which you can use to scale your cluster or
 replication group.
 
 
 When scaling down on a Redis cluster or replication group using ModifyCacheCluster or
 ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.
 








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


Serialized Fields


resourceName
String resourceName

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








Class com.amazonaws.services.elasticache.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagList
SdkInternalList<T> tagList

 A list of cost allocation tags as key-value pairs.
 








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


Serialized Fields


cacheClusterId
String cacheClusterId

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


numCacheNodes
Integer numCacheNodes

 The number of cache nodes that the 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), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If
 the value is equal to the number of current cache nodes, 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.
 
 
 
 Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see
 ApplyImmediately).
 
 
 A pending operation 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 operations to modify the number of
 cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation
 to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation 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
 operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly
 cancel the pending request and retry the new request. To cancel pending operations 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 cluster.
 
 


cacheNodeIdsToRemove
SdkInternalList<T> cacheNodeIdsToRemove

 A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is
 only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache
 node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the
 cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.
 
 
 For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this
 ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.
 


aZMode
String aZMode

 Specifies whether the new nodes in this Memcached 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 clusters.
 
 
 
 You cannot specify single-az if the Memcached 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 are located in different Availability Zones.
 
 


newAvailabilityZones
SdkInternalList<T> newAvailabilityZones

 The list of Availability Zones where the new Memcached cache nodes are 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 operations. Specify NumCacheNodes=3 to cancel all
 pending operations.
 
 
 
 
 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.
 
 
 
 
 


cacheSecurityGroupNames
SdkInternalList<T> cacheSecurityGroupNames

 A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon
 as possible.
 
 
 You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon
 VPC).
 
 
 Constraints: Must contain no more than 255 alphanumeric characters. Must not be "Default".
 


securityGroupIds
SdkInternalList<T> securityGroupIds

 Specifies the VPC Security Groups associated with the cluster.
 
 
 This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 Specifies the weekly time range during which maintenance on the 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:23:00-mon:01:30
 


notificationTopicArn
String notificationTopicArn

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


cacheParameterGroupName
String cacheParameterGroupName

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


notificationTopicStatus
String notificationTopicStatus

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


applyImmediately
Boolean applyImmediately

 If true, this parameter causes the modifications in this request and any pending modifications to be
 applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow
 setting for the cluster.
 
 
 If false, changes to the cluster are applied on the next maintenance reboot, or the next failure
 reboot, whichever occurs first.
 
 
 
 If you perform a ModifyCacheCluster before a pending modification is applied, the pending
 modification is replaced by the newer modification.
 
 
 
 Valid values: true | false
 
 
 Default: false
 


engineVersion
String engineVersion

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


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 This parameter is currently disabled.
 


snapshotRetentionLimit
Integer snapshotRetentionLimit

 The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example,
 if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days
 before being deleted.
 
 
 
 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 begins taking a daily snapshot of your cluster.
 


cacheNodeType
String cacheNodeType

 A valid cache node type that you want to scale this cluster up to.
 


authToken
String authToken

 Reserved parameter. The password used to access a password protected server. This parameter must be specified
 with the auth-token-update parameter. Password constraints:
 
 
 
 
 Must be only printable ASCII characters
 
 
 
 
 Must be at least 16 characters and no more than 128 characters in length
 
 
 
 
 Cannot contain any of the following characters: '/', '"', or '@', '%'
 
 
 
 
 For more information, see AUTH password at AUTH.
 


authTokenUpdateStrategy
String authTokenUpdateStrategy

 Specifies the strategy to use to update the AUTH token. This parameter must be specified with the
 auth-token parameter. Possible values:
 
 
 
 
 Rotate
 
 
 
 
 Set
 
 
 
 
 For more information, see Authenticating Users with Redis
 AUTH
 








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


Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName

 The name of the cache parameter group to modify.
 


parameterNameValues
SdkInternalList<T> parameterNameValues

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








Class com.amazonaws.services.elasticache.model.ModifyCacheParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName

 The name of the cache parameter group.
 








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


Serialized Fields


cacheSubnetGroupName
String cacheSubnetGroupName

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


cacheSubnetGroupDescription
String cacheSubnetGroupDescription

 A description of the cache subnet group.
 


subnetIds
SdkInternalList<T> subnetIds

 The EC2 subnet IDs for the cache subnet group.
 








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


Serialized Fields


replicationGroupId
String replicationGroupId

 The identifier of the replication group to modify.
 


replicationGroupDescription
String replicationGroupDescription

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


primaryClusterId
String primaryClusterId

 For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified
 cluster in the specified replication group to the primary role. The nodes of all other clusters in the
 replication group are read replicas.
 


snapshottingClusterId
String snapshottingClusterId

 The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set
 for Redis (cluster mode enabled) replication groups.
 


automaticFailoverEnabled
Boolean automaticFailoverEnabled

 Determines whether a read replica is automatically promoted to read/write primary if the existing primary
 encounters a failure.
 
 
 Valid values: true | false
 
 
 Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
 
 
 
 
 Redis versions earlier than 2.8.6.
 
 
 
 
 Redis (cluster mode disabled): T1 node types.
 
 
 
 
 Redis (cluster mode enabled): T1 node types.
 
 
 


nodeGroupId
String nodeGroupId
Deprecated. 

 Deprecated. This parameter is not used.
 


cacheSecurityGroupNames
SdkInternalList<T> cacheSecurityGroupNames

 A list of cache security group names to authorize for the clusters in this replication group. This change is
 asynchronously applied as soon as possible.
 
 
 This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual
 Private Cloud (Amazon VPC).
 
 
 Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.
 


securityGroupIds
SdkInternalList<T> securityGroupIds

 Specifies the VPC Security Groups associated with the clusters in the replication group.
 
 
 This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private
 Cloud (Amazon VPC).
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 Specifies the weekly time range during which maintenance on the 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:23:00-mon:01:30
 


notificationTopicArn
String notificationTopicArn

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


cacheParameterGroupName
String cacheParameterGroupName

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


notificationTopicStatus
String notificationTopicStatus

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


applyImmediately
Boolean applyImmediately

 If true, this parameter causes the modifications in this request and any pending modifications to be
 applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow
 setting for the replication group.
 
 
 If false, changes to the nodes in the replication group are applied on the next maintenance reboot,
 or the next failure reboot, whichever occurs first.
 
 
 Valid values: true | false
 
 
 Default: false
 


engineVersion
String engineVersion

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


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 This parameter is currently disabled.
 


snapshotRetentionLimit
Integer snapshotRetentionLimit

 The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For
 example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is 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 begins taking a daily snapshot of the node group (shard)
 specified by SnapshottingClusterId.
 
 
 Example: 05:00-09:00
 
 
 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
 


cacheNodeType
String cacheNodeType

 A valid cache node type that you want to scale this replication group to.
 


authToken
String authToken

 Reserved parameter. The password used to access a password protected server. This parameter must be specified
 with the auth-token-update-strategy  parameter. Password constraints:
 
 
 
 
 Must be only printable ASCII characters
 
 
 
 
 Must be at least 16 characters and no more than 128 characters in length
 
 
 
 
 Cannot contain any of the following characters: '/', '"', or '@', '%'
 
 
 
 
 For more information, see AUTH password at AUTH.
 


authTokenUpdateStrategy
String authTokenUpdateStrategy

 Specifies the strategy to use to update the AUTH token. This parameter must be specified with the
 auth-token parameter. Possible values:
 
 
 
 
 Rotate
 
 
 
 
 Set
 
 
 
 
 For more information, see Authenticating Users with Redis
 AUTH
 








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


Serialized Fields


replicationGroupId
String replicationGroupId

 The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be
 configured.
 


nodeGroupCount
Integer nodeGroupCount

 The number of node groups (shards) that results from the modification of the shard configuration.
 


applyImmediately
Boolean applyImmediately

 Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for
 this parameter is true.
 
 
 Value: true
 


reshardingConfiguration
SdkInternalList<T> reshardingConfiguration

 Specifies the preferred availability zones for each node group in the cluster. If the value of
 NodeGroupCount is greater than the current number of node groups (shards), you can use this
 parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter
 ElastiCache selects availability zones for you.
 
 
 You can specify this parameter only if the value of NodeGroupCount is greater than the current
 number of node groups (shards).
 


nodeGroupsToRemove
SdkInternalList<T> nodeGroupsToRemove

 If the value of NodeGroupCount is less than the current number of node groups (shards), then either
 NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove
 is a list of NodeGroupIds to remove from the cluster.
 
 
 ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the
 cluster.
 


nodeGroupsToRetain
SdkInternalList<T> nodeGroupsToRetain

 If the value of NodeGroupCount is less than the current number of node groups (shards), then either
 NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain
 is a list of NodeGroupIds to retain in the cluster.
 
 
 ElastiCache for Redis will attempt to remove all node groups except those listed by
 NodeGroupsToRetain from the cluster.
 








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


Serialized Fields


nodeGroupId
String nodeGroupId

 The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node
 group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90
 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.
 


status
String status

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


primaryEndpoint
Endpoint primaryEndpoint

 The endpoint of the primary node in this node group (shard).
 


readerEndpoint
Endpoint readerEndpoint

 The endpoint of the replica nodes in this node group (shard).
 


slots
String slots

 The keyspace for this node group (shard).
 


nodeGroupMembers
SdkInternalList<T> nodeGroupMembers

 A list containing information about individual nodes within the node group (shard).
 








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


Serialized Fields


nodeGroupId
String nodeGroupId

 Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration
 values apply to.
 


slots
String slots

 A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is
 in the format startkey-endkey.
 
 
 Example: "0-3999"
 


replicaCount
Integer replicaCount

 The number of read replica nodes in this node group (shard).
 


primaryAvailabilityZone
String primaryAvailabilityZone

 The Availability Zone where the primary node of this node group (shard) is launched.
 


replicaAvailabilityZones
SdkInternalList<T> replicaAvailabilityZones

 A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must
 match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.
 








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


Serialized Fields


cacheClusterId
String cacheClusterId

 The ID of the cluster to which the node belongs.
 


cacheNodeId
String cacheNodeId

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


readEndpoint
Endpoint readEndpoint

 The information required for client programs to connect to a node for read operations. The read endpoint is only
 applicable on Redis (cluster mode disabled) clusters.
 


preferredAvailabilityZone
String preferredAvailabilityZone

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


currentRole
String currentRole

 The role that is currently assigned to the node - primary or replica. This member is
 only applicable for Redis (cluster mode disabled) replication groups.
 








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


Serialized Fields


cacheClusterId
String cacheClusterId

 The cache cluster ID
 


cacheNodeId
String cacheNodeId

 The node ID of the cache cluster
 


nodeUpdateStatus
String nodeUpdateStatus

 The update status of the node
 


nodeDeletionDate
Date nodeDeletionDate

 The deletion date of the node
 


nodeUpdateStartDate
Date nodeUpdateStartDate

 The start date of the update for a node
 


nodeUpdateEndDate
Date nodeUpdateEndDate

 The end date of the update for a node
 


nodeUpdateInitiatedBy
String nodeUpdateInitiatedBy

 Reflects whether the update was initiated by the customer or automatically applied
 


nodeUpdateInitiatedDate
Date nodeUpdateInitiatedDate

 The date when the update is triggered
 


nodeUpdateStatusModifiedDate
Date nodeUpdateStatusModifiedDate

 The date when the NodeUpdateStatus was last modified
 








Class com.amazonaws.services.elasticache.model.NodeGroupNotFoundException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.NodeGroupsPerReplicationGroupQuotaExceededException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


nodeGroupId
String nodeGroupId

 The ID of the node group
 


nodeGroupMemberUpdateStatus
SdkInternalList<T> nodeGroupMemberUpdateStatus

 The status of the service update on the node group member
 








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

serialVersionUID:
1L





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

serialVersionUID:
1L





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


Serialized Fields


cacheClusterId
String cacheClusterId

 A unique identifier for the source cluster.
 


nodeGroupId
String nodeGroupId

 A unique identifier for the source node group (shard).
 


cacheNodeId
String cacheNodeId

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


nodeGroupConfiguration
NodeGroupConfiguration nodeGroupConfiguration

 The configuration for the source node group (shard).
 


cacheSize
String cacheSize

 The size of the cache on the source cache node.
 


cacheNodeCreateTime
Date cacheNodeCreateTime

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


snapshotCreateTime
Date snapshotCreateTime

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








Class com.amazonaws.services.elasticache.model.NoOperationException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


topicArn
String topicArn

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


topicStatus
String topicStatus

 The current state of the topic.
 








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


Serialized Fields


parameterName
String parameterName

 The name of the parameter.
 


parameterValue
String parameterValue

 The value of the parameter.
 


description
String description

 A description of the parameter.
 


source
String source

 The source of the parameter.
 


dataType
String dataType

 The valid data type for the parameter.
 


allowedValues
String allowedValues

 The valid range of values for the parameter.
 


isModifiable
Boolean isModifiable

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


minimumEngineVersion
String minimumEngineVersion

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


changeType
String changeType

 Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be
 applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a
 Cluster.
 








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


Serialized Fields


parameterName
String parameterName

 The name of the parameter.
 


parameterValue
String parameterValue

 The value of the parameter.
 








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


Serialized Fields


numCacheNodes
Integer numCacheNodes

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


cacheNodeIdsToRemove
SdkInternalList<T> cacheNodeIdsToRemove

 A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit
 numeric identifier (0001, 0002, etc.).
 


engineVersion
String engineVersion

 The new cache engine version that the cluster runs.
 


cacheNodeType
String cacheNodeType

 The cache node type that this cluster or replication group is scaled to.
 


authTokenStatus
String authTokenStatus

 The auth token status
 








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


Serialized Fields


replicationGroupId
String replicationGroupId

 The ID of the replication group
 


cacheClusterId
String cacheClusterId

 The ID of the cache cluster
 


serviceUpdateName
String serviceUpdateName

 The unique ID of the service update
 


updateActionStatus
String updateActionStatus

 The status of the update action on the Redis cluster
 








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


Serialized Fields


reservedCacheNodesOfferingId
String reservedCacheNodesOfferingId

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


reservedCacheNodeId
String reservedCacheNodeId

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


cacheNodeCount
Integer cacheNodeCount

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








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


Serialized Fields


cacheClusterId
String cacheClusterId

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


cacheNodeIdsToReboot
SdkInternalList<T> cacheNodeIdsToReboot

 A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire
 cluster, specify all of the cache node IDs.
 








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


Serialized Fields


recurringChargeAmount
Double recurringChargeAmount

 The monetary amount of the recurring charge.
 


recurringChargeFrequency
String recurringChargeFrequency

 The frequency of the recurring charge.
 








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


Serialized Fields


resourceName
String resourceName

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


tagKeys
SdkInternalList<T> tagKeys

 A list of TagKeys identifying the tags you want removed from the named resource.
 








Class com.amazonaws.services.elasticache.model.RemoveTagsFromResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagList
SdkInternalList<T> tagList

 A list of cost allocation tags as key-value pairs.
 








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


Serialized Fields


replicationGroupId
String replicationGroupId

 The identifier for the replication group.
 


description
String description

 The user supplied description of the replication group.
 


status
String status

 The current state of this replication group - creating, available,
 modifying, deleting, create-failed, snapshotting.
 


pendingModifiedValues
ReplicationGroupPendingModifiedValues pendingModifiedValues

 A group of settings to be applied to the replication group, either immediately or during the next maintenance
 window.
 


memberClusters
SdkInternalList<T> memberClusters

 The names of all the cache clusters that are part of this replication group.
 


nodeGroups
SdkInternalList<T> nodeGroups

 A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a
 single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each
 node group (shard).
 


snapshottingClusterId
String snapshottingClusterId

 The cluster ID that is used as the daily snapshot source for the replication group.
 


automaticFailover
String automaticFailover

 Indicates the status of Multi-AZ with automatic failover for this Redis replication group.
 
 
 Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
 
 
 
 
 Redis versions earlier than 2.8.6.
 
 
 
 
 Redis (cluster mode disabled): T1 node types.
 
 
 
 
 Redis (cluster mode enabled): T1 node types.
 
 
 


configurationEndpoint
Endpoint configurationEndpoint

 The configuration endpoint for this replication group. Use the configuration endpoint to connect to this
 replication group.
 


snapshotRetentionLimit
Integer snapshotRetentionLimit

 The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example,
 if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days
 before being deleted.
 
 
 
 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 begins taking a daily snapshot of your node group (shard).
 
 
 Example: 05:00-09:00
 
 
 If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
 
 
 
 This parameter is only valid if the Engine parameter is redis.
 
 


clusterEnabled
Boolean clusterEnabled

 A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be
 partitioned across multiple shards (API/CLI: node groups).
 
 
 Valid values: true | false
 


cacheNodeType
String cacheNodeType

 The name of the compute and memory capacity node type for each node in the replication group.
 


authTokenEnabled
Boolean authTokenEnabled

 A flag that enables using an AuthToken (password) when issuing Redis commands.
 
 
 Default: false
 


authTokenLastModifiedDate
Date authTokenLastModifiedDate

 The date the auth token was last modified
 


transitEncryptionEnabled
Boolean transitEncryptionEnabled

 A flag that enables in-transit encryption when set to true.
 
 
 You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable
 in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when
 you create a cluster.
 
 
 Required: Only available when creating a replication group in an Amazon VPC using redis version
 3.2.6, 4.x or later.
 
 
 Default: false
 


atRestEncryptionEnabled
Boolean atRestEncryptionEnabled

 A flag that enables encryption at-rest when set to true.
 
 
 You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable
 encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you
 create a cluster.
 
 
 Required: Only available when creating a replication group in an Amazon VPC using redis version
 3.2.6, 4.x or later.
 
 
 Default: false
 


kmsKeyId
String kmsKeyId

 The ID of the KMS key used to encrypt the disk in the cluster.
 








Class com.amazonaws.services.elasticache.model.ReplicationGroupAlreadyExistsException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ReplicationGroupAlreadyUnderMigrationException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ReplicationGroupNotFoundException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ReplicationGroupNotUnderMigrationException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


primaryClusterId
String primaryClusterId

 The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during
 the next maintenance window.
 


automaticFailoverStatus
String automaticFailoverStatus

 Indicates the status of Multi-AZ with automatic failover for this Redis replication group.
 
 
 Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
 
 
 
 
 Redis versions earlier than 2.8.6.
 
 
 
 
 Redis (cluster mode disabled): T1 node types.
 
 
 
 
 Redis (cluster mode enabled): T1 node types.
 
 
 


resharding
ReshardingStatus resharding

 The status of an online resharding operation.
 


authTokenStatus
String authTokenStatus

 The auth token status
 








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


Serialized Fields


reservedCacheNodeId
String reservedCacheNodeId

 The unique identifier for the reservation.
 


reservedCacheNodesOfferingId
String reservedCacheNodesOfferingId

 The offering identifier.
 


cacheNodeType
String cacheNodeType

 The cache node type for the reserved cache nodes.
 
 
 The following node types are supported by ElastiCache. Generally speaking, the current generation types provide
 more memory and computational power at lower cost when compared to their equivalent previous generation
 counterparts.
 
 
 
 
 General purpose:
 
 
 
 
 Current generation:
 
 
 M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
 cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
 
 
 M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
 cache.m4.4xlarge, cache.m4.10xlarge
 
 
 T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
 
 
 
 
 Previous generation: (not recommended)
 
 
 T1 node types: cache.t1.micro
 
 
 M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
 cache.m1.xlarge
 
 
 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
 cache.m3.2xlarge
 
 
 
 
 
 
 Compute optimized:
 
 
 
 
 Previous generation: (not recommended)
 
 
 C1 node types: cache.c1.xlarge
 
 
 
 
 
 
 Memory optimized:
 
 
 
 
 Current generation:
 
 
 R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
 cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
 
 
 R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
 cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
 
 
 
 
 Previous generation: (not recommended)
 
 
 M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
 
 
 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
 cache.r3.4xlarge, cache.r3.8xlarge
 
 
 
 
 
 
 Additional node type info
 
 
 
 
 All current generation instance types are created in Amazon VPC by default.
 
 
 
 
 Redis append-only files (AOF) are not supported for T1 or T2 instances.
 
 
 
 
 Redis Multi-AZ with automatic failover is not supported on T1 instances.
 
 
 
 
 Redis configuration variables appendonly and appendfsync are not supported on Redis
 version 2.8.22 and later.
 
 
 


startTime
Date startTime

 The time the reservation started.
 


duration
Integer duration

 The duration of the reservation in seconds.
 


fixedPrice
Double fixedPrice

 The fixed price charged for this reserved cache node.
 


usagePrice
Double usagePrice

 The hourly price charged for this reserved cache node.
 


cacheNodeCount
Integer cacheNodeCount

 The number of cache nodes that have been reserved.
 


productDescription
String productDescription

 The description of the reserved cache node.
 


offeringType
String offeringType

 The offering type of this reserved cache node.
 


state
String state

 The state of the reserved cache node.
 


recurringCharges
SdkInternalList<T> recurringCharges

 The recurring price charged to run this reserved cache node.
 


reservationARN
String reservationARN

 The Amazon Resource Name (ARN) of the reserved cache node.
 
 
 Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582
 








Class com.amazonaws.services.elasticache.model.ReservedCacheNodeAlreadyExistsException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ReservedCacheNodeNotFoundException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ReservedCacheNodeQuotaExceededException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


reservedCacheNodesOfferingId
String reservedCacheNodesOfferingId

 A unique identifier for the reserved cache node offering.
 


cacheNodeType
String cacheNodeType

 The cache node type for the reserved cache node.
 
 
 The following node types are supported by ElastiCache. Generally speaking, the current generation types provide
 more memory and computational power at lower cost when compared to their equivalent previous generation
 counterparts.
 
 
 
 
 General purpose:
 
 
 
 
 Current generation:
 
 
 M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
 cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
 
 
 M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
 cache.m4.4xlarge, cache.m4.10xlarge
 
 
 T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
 
 
 
 
 Previous generation: (not recommended)
 
 
 T1 node types: cache.t1.micro
 
 
 M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
 cache.m1.xlarge
 
 
 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
 cache.m3.2xlarge
 
 
 
 
 
 
 Compute optimized:
 
 
 
 
 Previous generation: (not recommended)
 
 
 C1 node types: cache.c1.xlarge
 
 
 
 
 
 
 Memory optimized:
 
 
 
 
 Current generation:
 
 
 R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
 cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
 
 
 R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
 cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
 
 
 
 
 Previous generation: (not recommended)
 
 
 M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
 
 
 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
 cache.r3.4xlarge, cache.r3.8xlarge
 
 
 
 
 
 
 Additional node type info
 
 
 
 
 All current generation instance types are created in Amazon VPC by default.
 
 
 
 
 Redis append-only files (AOF) are not supported for T1 or T2 instances.
 
 
 
 
 Redis Multi-AZ with automatic failover is not supported on T1 instances.
 
 
 
 
 Redis configuration variables appendonly and appendfsync are not supported on Redis
 version 2.8.22 and later.
 
 
 


duration
Integer duration

 The duration of the offering. in seconds.
 


fixedPrice
Double fixedPrice

 The fixed price charged for this offering.
 


usagePrice
Double usagePrice

 The hourly price charged for this offering.
 


productDescription
String productDescription

 The cache engine used by the offering.
 


offeringType
String offeringType

 The offering type.
 


recurringCharges
SdkInternalList<T> recurringCharges

 The recurring price charged to run this reserved cache node.
 








Class com.amazonaws.services.elasticache.model.ReservedCacheNodesOfferingNotFoundException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName

 The name of the cache parameter group to reset.
 


resetAllParameters
Boolean resetAllParameters

 If true, all parameters in the cache parameter group are reset to their default values. If
 false, only the parameters listed by ParameterNameValues are reset to their default
 values.
 
 
 Valid values: true | false
 


parameterNameValues
SdkInternalList<T> parameterNameValues

 An array of parameter names to reset to their default values. If ResetAllParameters is
 true, do not use ParameterNameValues. If ResetAllParameters is
 false, you must specify the name of at least one parameter to reset.
 








Class com.amazonaws.services.elasticache.model.ResetCacheParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName

 The name of the cache parameter group.
 








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


Serialized Fields


nodeGroupId
String nodeGroupId

 Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration
 values apply to.
 


preferredAvailabilityZones
SdkInternalList<T> preferredAvailabilityZones

 A list of preferred availability zones for the nodes in this cluster.
 








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


Serialized Fields


slotMigration
SlotMigration slotMigration

 Represents the progress of an online resharding operation.
 








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


Serialized Fields


cacheSecurityGroupName
String cacheSecurityGroupName

 The name of the cache security group to revoke ingress from.
 


eC2SecurityGroupName
String eC2SecurityGroupName

 The name of the Amazon EC2 security group to revoke access from.
 


eC2SecurityGroupOwnerId
String eC2SecurityGroupOwnerId

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








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


Serialized Fields


securityGroupId
String securityGroupId

 The identifier of the cache security group.
 


status
String status

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








Class com.amazonaws.services.elasticache.model.ServiceLinkedRoleNotFoundException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


serviceUpdateName
String serviceUpdateName

 The unique ID of the service update
 


serviceUpdateReleaseDate
Date serviceUpdateReleaseDate

 The date when the service update is initially available
 


serviceUpdateEndDate
Date serviceUpdateEndDate

 The date after which the service update is no longer available
 


serviceUpdateSeverity
String serviceUpdateSeverity

 The severity of the service update
 


serviceUpdateRecommendedApplyByDate
Date serviceUpdateRecommendedApplyByDate

 The recommendend date to apply the service update in order to ensure compliance. For information on compliance,
 see Self-Service Security Updates for Compliance.
 


serviceUpdateStatus
String serviceUpdateStatus

 The status of the service update
 


serviceUpdateDescription
String serviceUpdateDescription

 Provides details of the service update
 


serviceUpdateType
String serviceUpdateType

 Reflects the nature of the service update
 


engine
String engine

 The Elasticache engine to which the update applies. Either Redis or Memcached
 


engineVersion
String engineVersion

 The Elasticache engine version to which the update applies. Either Redis or Memcached engine version
 


autoUpdateAfterRecommendedApplyByDate
Boolean autoUpdateAfterRecommendedApplyByDate

 Indicates whether the service update will be automatically applied once the recommended apply-by date has
 expired.
 


estimatedUpdateTime
String estimatedUpdateTime

 The estimated length of time the service update will take
 








Class com.amazonaws.services.elasticache.model.ServiceUpdateNotFoundException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


progressPercentage
Double progressPercentage

 The percentage of the slot migration that is complete.
 








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


Serialized Fields


snapshotName
String snapshotName

 The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is
 the user-provided name.
 


replicationGroupId
String replicationGroupId

 The unique identifier of the source replication group.
 


replicationGroupDescription
String replicationGroupDescription

 A description of the source replication group.
 


cacheClusterId
String cacheClusterId

 The user-supplied identifier of the source cluster.
 


snapshotStatus
String snapshotStatus

 The status of the snapshot. Valid values: creating | available | restoring
 | copying | deleting.
 


snapshotSource
String snapshotSource

 Indicates whether the snapshot is from an automatic backup (automated) or was created manually (
 manual).
 


cacheNodeType
String cacheNodeType

 The name of the compute and memory capacity node type for the source cluster.
 
 
 The following node types are supported by ElastiCache. Generally speaking, the current generation types provide
 more memory and computational power at lower cost when compared to their equivalent previous generation
 counterparts.
 
 
 
 
 General purpose:
 
 
 
 
 Current generation:
 
 
 M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge,
 cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge
 
 
 M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge,
 cache.m4.4xlarge, cache.m4.10xlarge
 
 
 T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium
 
 
 
 
 Previous generation: (not recommended)
 
 
 T1 node types: cache.t1.micro
 
 
 M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large,
 cache.m1.xlarge
 
 
 M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge,
 cache.m3.2xlarge
 
 
 
 
 
 
 Compute optimized:
 
 
 
 
 Previous generation: (not recommended)
 
 
 C1 node types: cache.c1.xlarge
 
 
 
 
 
 
 Memory optimized:
 
 
 
 
 Current generation:
 
 
 R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge,
 cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge
 
 
 R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge,
 cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge
 
 
 
 
 Previous generation: (not recommended)
 
 
 M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge
 
 
 R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge,
 cache.r3.4xlarge, cache.r3.8xlarge
 
 
 
 
 
 
 Additional node type info
 
 
 
 
 All current generation instance types are created in Amazon VPC by default.
 
 
 
 
 Redis append-only files (AOF) are not supported for T1 or T2 instances.
 
 
 
 
 Redis Multi-AZ with automatic failover is not supported on T1 instances.
 
 
 
 
 Redis configuration variables appendonly and appendfsync are not supported on Redis
 version 2.8.22 and later.
 
 
 


engine
String engine

 The name of the cache engine (memcached or redis) used by the source cluster.
 


engineVersion
String engineVersion

 The version of the cache engine version that is used by the source cluster.
 


numCacheNodes
Integer numCacheNodes

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


preferredAvailabilityZone
String preferredAvailabilityZone

 The name of the Availability Zone in which the source cluster is located.
 


cacheClusterCreateTime
Date cacheClusterCreateTime

 The date and time when the source cluster was created.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 Specifies the weekly time range during which maintenance on the 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:23:00-mon:01:30
 


topicArn
String topicArn

 The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.
 


port
Integer port

 The port number used by each cache nodes in the source cluster.
 


cacheParameterGroupName
String cacheParameterGroupName

 The cache parameter group that is associated with the source cluster.
 


cacheSubnetGroupName
String cacheSubnetGroupName

 The name of the cache subnet group associated with the source cluster.
 


vpcId
String vpcId

 The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.
 


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 This parameter is currently disabled.
 


snapshotRetentionLimit
Integer snapshotRetentionLimit

 For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.
 
 
 For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the
 snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted
 using the DeleteSnapshot operation.
 
 
 Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
 


snapshotWindow
String snapshotWindow

 The daily time range during which ElastiCache takes daily snapshots of the source cluster.
 


numNodeGroups
Integer numNodeGroups

 The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups
 (shards) in the snapshot and in the restored replication group must be the same.
 


automaticFailover
String automaticFailover

 Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.
 
 
 Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:
 
 
 
 
 Redis versions earlier than 2.8.6.
 
 
 
 
 Redis (cluster mode disabled): T1 node types.
 
 
 
 
 Redis (cluster mode enabled): T1 node types.
 
 
 


nodeSnapshots
SdkInternalList<T> nodeSnapshots

 A list of the cache nodes in the source cluster.
 


kmsKeyId
String kmsKeyId

 The ID of the KMS key used to encrypt the snapshot.
 








Class com.amazonaws.services.elasticache.model.SnapshotAlreadyExistsException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.SnapshotFeatureNotSupportedException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.SnapshotNotFoundException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.SnapshotQuotaExceededException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


replicationGroupId
String replicationGroupId

 The ID of the replication group to which data should be migrated.
 


customerNodeEndpointList
SdkInternalList<T> customerNodeEndpointList

 List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only
 one element.
 








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


Serialized Fields


subnetIdentifier
String subnetIdentifier

 The unique identifier for the subnet.
 


subnetAvailabilityZone
AvailabilityZone subnetAvailabilityZone

 The Availability Zone associated with the subnet.
 








Class com.amazonaws.services.elasticache.model.SubnetInUseException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


key
String key

 The key for the tag. May not be null.
 


value
String value

 The tag's value. May be null.
 








Class com.amazonaws.services.elasticache.model.TagNotFoundException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.TagQuotaPerResourceExceededException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.TestFailoverNotAvailableException extends AmazonElastiCacheException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


replicationGroupId
String replicationGroupId

 The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.
 


nodeGroupId
String nodeGroupId

 The name of the node group (called shard in the console) in this replication group on which automatic failover is
 to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.
 








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


Serialized Fields


startTime
Date startTime

 The start time of the time range filter
 


endTime
Date endTime

 The end time of the time range filter
 








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


Serialized Fields


replicationGroupId
String replicationGroupId

 The replication group ID
 


cacheClusterId
String cacheClusterId

 The ID of the cache cluster
 


serviceUpdateName
String serviceUpdateName

 The unique ID of the service update
 


errorType
String errorType

 The error type for requests that are not processed
 


errorMessage
String errorMessage

 The error message that describes the reason the request was not processed
 








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


Serialized Fields


replicationGroupId
String replicationGroupId

 The ID of the replication group
 


cacheClusterId
String cacheClusterId

 The ID of the cache cluster
 


serviceUpdateName
String serviceUpdateName

 The unique ID of the service update
 


serviceUpdateReleaseDate
Date serviceUpdateReleaseDate

 The date the update is first available
 


serviceUpdateSeverity
String serviceUpdateSeverity

 The severity of the service update
 


serviceUpdateStatus
String serviceUpdateStatus

 The status of the service update
 


serviceUpdateRecommendedApplyByDate
Date serviceUpdateRecommendedApplyByDate

 The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.
 


serviceUpdateType
String serviceUpdateType

 Reflects the nature of the service update
 


updateActionAvailableDate
Date updateActionAvailableDate

 The date that the service update is available to a replication group
 


updateActionStatus
String updateActionStatus

 The status of the update action
 


nodesUpdated
String nodesUpdated

 The progress of the service update on the replication group
 


updateActionStatusModifiedDate
Date updateActionStatusModifiedDate

 The date when the UpdateActionStatus was last modified
 


slaMet
String slaMet

 If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least
 one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication
 group was created after the recommended apply-by date.
 


nodeGroupUpdateStatus
SdkInternalList<T> nodeGroupUpdateStatus

 The status of the service update on the node group
 


cacheNodeUpdateStatus
SdkInternalList<T> cacheNodeUpdateStatus

 The status of the service update on the cache node
 


estimatedUpdateTime
String estimatedUpdateTime

 The estimated length of time for the update to complete
 


engine
String engine

 The Elasticache engine to which the update applies. Either Redis or Memcached
 








Package com.amazonaws.services.elasticbeanstalk.model




Class com.amazonaws.services.elasticbeanstalk.model.AbortEnvironmentUpdateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 This specifies the ID of the environment with the in-progress update that you want to cancel.
 


environmentName
String environmentName

 This specifies the name of the environment with the in-progress update that you want to cancel.
 








Class com.amazonaws.services.elasticbeanstalk.model.AbortEnvironmentUpdateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.ApplicationDescription extends Object implements Serializable


Serialized Fields


applicationArn
String applicationArn

 The Amazon Resource Name (ARN) of the application.
 


applicationName
String applicationName

 The name of the application.
 


description
String description

 User-defined description of the application.
 


dateCreated
Date dateCreated

 The date when the application was created.
 


dateUpdated
Date dateUpdated

 The date when the application was last modified.
 


versions
SdkInternalList<T> versions

 The names of the versions for this application.
 


configurationTemplates
SdkInternalList<T> configurationTemplates

 The names of the configuration templates associated with this application.
 


resourceLifecycleConfig
ApplicationResourceLifecycleConfig resourceLifecycleConfig

 The lifecycle settings for the application.
 








Class com.amazonaws.services.elasticbeanstalk.model.ApplicationMetrics extends Object implements Serializable


Serialized Fields


duration
Integer duration

 The amount of time that the metrics cover (usually 10 seconds). For example, you might have 5 requests (
 request_count) within the most recent time slice of 10 seconds (duration).
 


requestCount
Integer requestCount

 Average number of requests handled by the web server per second over the last 10 seconds.
 


statusCodes
StatusCodes statusCodes

 Represents the percentage of requests over the last 10 seconds that resulted in each type of status code
 response.
 


latency
Latency latency

 Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in
 seconds with one millisecond resolution.
 








Class com.amazonaws.services.elasticbeanstalk.model.ApplicationResourceLifecycleConfig extends Object implements Serializable


Serialized Fields


serviceRole
String serviceRole

 The ARN of an IAM service role that Elastic Beanstalk has permission to assume.
 
 
 The ServiceRole property is required the first time that you provide a
 VersionLifecycleConfig for the application in one of the supporting calls (
 CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in
 either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to
 specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify
 it in subsequent calls to change the Service Role to another value.
 


versionLifecycleConfig
ApplicationVersionLifecycleConfig versionLifecycleConfig

 The application version lifecycle configuration.
 








Class com.amazonaws.services.elasticbeanstalk.model.ApplicationVersionDescription extends Object implements Serializable


Serialized Fields


applicationVersionArn
String applicationVersionArn

 The Amazon Resource Name (ARN) of the application version.
 


applicationName
String applicationName

 The name of the application to which the application version belongs.
 


description
String description

 The description of the application version.
 


versionLabel
String versionLabel

 A unique identifier for the application version.
 


sourceBuildInformation
SourceBuildInformation sourceBuildInformation

 If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the
 application version.
 


buildArn
String buildArn

 Reference to the artifact from the AWS CodeBuild build.
 


sourceBundle
S3Location sourceBundle

 The storage location of the application version's source bundle in Amazon S3.
 


dateCreated
Date dateCreated

 The creation date of the application version.
 


dateUpdated
Date dateUpdated

 The last modified date of the application version.
 


status
String status

 The processing status of the application version. Reflects the state of the application version during its
 creation. Many of the values are only applicable if you specified True for the Process
 parameter of the CreateApplicationVersion action. The following list describes the possible values.
 
 
 
 
 Unprocessed – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate
 configuration files during deployment of the application version to an environment.
 
 
 
 
 Processing – Elastic Beanstalk is currently processing the application version.
 
 
 
 
 Building – Application version is currently undergoing an AWS CodeBuild build.
 
 
 
 
 Processed – Elastic Beanstalk was successfully pre-processed and validated.
 
 
 
 
 Failed – Either the AWS CodeBuild build failed or configuration files didn't pass validation. This
 application version isn't usable.
 
 
 








Class com.amazonaws.services.elasticbeanstalk.model.ApplicationVersionLifecycleConfig extends Object implements Serializable


Serialized Fields


maxCountRule
MaxCountRule maxCountRule

 Specify a max count rule to restrict the number of application versions that are retained for an application.
 


maxAgeRule
MaxAgeRule maxAgeRule

 Specify a max age rule to restrict the length of time that application versions are retained for an application.
 








Class com.amazonaws.services.elasticbeanstalk.model.ApplyEnvironmentManagedActionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentName
String environmentName

 The name of the target environment.
 


environmentId
String environmentId

 The environment ID of the target environment.
 


actionId
String actionId

 The action ID of the scheduled managed action to execute.
 








Class com.amazonaws.services.elasticbeanstalk.model.ApplyEnvironmentManagedActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


actionId
String actionId

 The action ID of the managed action.
 


actionDescription
String actionDescription

 A description of the managed action.
 


actionType
String actionType

 The type of managed action.
 


status
String status

 The status of the managed action.
 








Class com.amazonaws.services.elasticbeanstalk.model.AutoScalingGroup extends Object implements Serializable


Serialized Fields


name
String name

 The name of the AutoScalingGroup .
 








Class com.amazonaws.services.elasticbeanstalk.model.AWSElasticBeanstalkException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.BuildConfiguration extends Object implements Serializable


Serialized Fields


artifactName
String artifactName

 The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the
 S3 location
 S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact
 -name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location
 S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.
 


codeBuildServiceRole
String codeBuildServiceRole

 The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to
 interact with dependent AWS services on behalf of the AWS account.
 


computeType
String computeType

 Information about the compute resources the build project will use.
 
 
 
 
 BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds
 
 
 
 
 BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds
 
 
 
 
 BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds
 
 
 


image
String image

 The ID of the Docker image to use for this build project.
 


timeoutInMinutes
Integer timeoutInMinutes

 How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that
 does not get marked as completed. The default is 60 minutes.
 








Class com.amazonaws.services.elasticbeanstalk.model.Builder extends Object implements Serializable


Serialized Fields


aRN
String aRN

 The ARN of the builder.
 








Class com.amazonaws.services.elasticbeanstalk.model.CheckDNSAvailabilityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cNAMEPrefix
String cNAMEPrefix

 The prefix used when this CNAME is reserved.
 








Class com.amazonaws.services.elasticbeanstalk.model.CheckDNSAvailabilityResult extends AmazonWebServiceResult<ResponseMetadata> 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.CodeBuildNotInServiceRegionException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.ComposeEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application to which the specified source bundles belong.
 


groupName
String groupName

 The name of the group to which the target environments belong. Specify a group name only if the environment name
 defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest
 (env.yaml) for details.
 


versionLabels
SdkInternalList<T> versionLabels

 A list of version labels, specifying one or more application source bundles that belong to the target
 application. Each source bundle must include an environment manifest that specifies the name of the environment
 and the name of the solution stack to use, and optionally can specify environment links to create.
 








Class com.amazonaws.services.elasticbeanstalk.model.ComposeEnvironmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


environments
SdkInternalList<T> environments

 Returns an EnvironmentDescription list.
 


nextToken
String nextToken

 In a paginated request, the token that you can pass in a subsequent request to get the next response page.
 








Class com.amazonaws.services.elasticbeanstalk.model.ConfigurationOptionDescription extends Object implements Serializable


Serialized Fields


namespace
String namespace

 A unique namespace identifying the option's associated AWS resource.
 


name
String name

 The name of the configuration option.
 


defaultValue
String defaultValue

 The default value for this configuration option.
 


changeSeverity
String changeSeverity

 An indication of which action is required if the value for this configuration option changes:
 
 
 
 
 NoInterruption : There is no interruption to the environment or application availability.
 
 
 
 
 RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and
 recreated, and the environment is unavailable during the process.
 
 
 
 
 RestartApplicationServer : The environment is available the entire time. However, a short
 application outage occurs when the application servers on the running Amazon EC2 instances are restarted.
 
 
 


userDefined
Boolean userDefined

 An indication of whether the user defined this configuration option:
 
 
 
 
 true : This configuration option was defined by the user. It is a valid choice for specifying if
 this as an Option to Remove when updating configuration settings.
 
 
 
 
 false : This configuration was not defined by the user.
 
 
 
 
 Constraint: You can remove only UserDefined options from a configuration.
 
 
 Valid Values: true | false
 


valueType
String valueType

 An indication of which type of values this option has and whether it is allowable to select one or more than one
 of the possible values:
 
 
 
 
 Scalar : Values for this option are a single selection from the possible values, or an unformatted
 string, or numeric value governed by the MIN/MAX/Regex constraints.
 
 
 
 
 List : Values for this option are multiple selections from the possible values.
 
 
 
 
 Boolean : Values for this option are either true or false .
 
 
 
 
 Json : Values for this option are a JSON representation of a ConfigDocument.
 
 
 


valueOptions
SdkInternalList<T> valueOptions

 If specified, values for the configuration option are selected from this list.
 


minValue
Integer minValue

 If specified, the configuration option must be a numeric value greater than this value.
 


maxValue
Integer maxValue

 If specified, the configuration option must be a numeric value less than this value.
 


maxLength
Integer maxLength

 If specified, the configuration option must be a string value no longer than this value.
 


regex
OptionRestrictionRegex regex

 If specified, the configuration option must be a string value that satisfies this regular expression.
 








Class com.amazonaws.services.elasticbeanstalk.model.ConfigurationOptionSetting extends Object implements Serializable


Serialized Fields


resourceName
String resourceName

 A unique resource name for a time-based scaling configuration option.
 


namespace
String namespace

 A unique namespace identifying the option's associated AWS resource.
 


optionName
String optionName

 The name of the configuration option.
 


value
String value

 The current value for the configuration option.
 








Class com.amazonaws.services.elasticbeanstalk.model.ConfigurationSettingsDescription extends Object implements Serializable


Serialized Fields


solutionStackName
String solutionStackName

 The name of the solution stack this configuration set uses.
 


platformArn
String platformArn

 The ARN of the platform.
 


applicationName
String applicationName

 The name of the application associated with this configuration set.
 


templateName
String templateName

 If not null, the name of the configuration template for this configuration set.
 


description
String description

 Describes this configuration set.
 


environmentName
String environmentName

 If not null, the name of the environment for this configuration set.
 


deploymentStatus
String deploymentStatus

 If this configuration set is associated with an environment, the DeploymentStatus parameter
 indicates the deployment status of this configuration set:
 
 
 
 
 null: This configuration is not associated with a running environment.
 
 
 
 
 pending: This is a draft configuration that is not deployed to the associated environment but is in
 the process of deploying.
 
 
 
 
 deployed: This is the configuration that is currently deployed to the associated running
 environment.
 
 
 
 
 failed: This is a draft configuration that failed to successfully deploy.
 
 
 


dateCreated
Date dateCreated

 The date (in UTC time) when this configuration set was created.
 


dateUpdated
Date dateUpdated

 The date (in UTC time) when this configuration set was last modified.
 


optionSettings
SdkInternalList<T> optionSettings

 A list of the configuration options and their values in this configuration set.
 








Class com.amazonaws.services.elasticbeanstalk.model.CPUUtilization extends Object implements Serializable


Serialized Fields


user
Double user

 Percentage of time that the CPU has spent in the User state over the last 10 seconds.
 


nice
Double nice

 Available on Linux environments only.
 
 
 Percentage of time that the CPU has spent in the Nice state over the last 10 seconds.
 


system
Double system

 Available on Linux environments only.
 
 
 Percentage of time that the CPU has spent in the System state over the last 10 seconds.
 


idle
Double idle

 Percentage of time that the CPU has spent in the Idle state over the last 10 seconds.
 


iOWait
Double iOWait

 Available on Linux environments only.
 
 
 Percentage of time that the CPU has spent in the I/O Wait state over the last 10 seconds.
 


iRQ
Double iRQ

 Available on Linux environments only.
 
 
 Percentage of time that the CPU has spent in the IRQ state over the last 10 seconds.
 


softIRQ
Double softIRQ

 Available on Linux environments only.
 
 
 Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 seconds.
 


privileged
Double privileged

 Available on Windows environments only.
 
 
 Percentage of time that the CPU has spent in the Privileged state over the last 10 seconds.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application.
 
 
 Constraint: This name must be unique within your account. If the specified name already exists, the action
 returns an InvalidParameterValue error.
 


description
String description

 Describes the application.
 


resourceLifecycleConfig
ApplicationResourceLifecycleConfig resourceLifecycleConfig

 Specify an application resource lifecycle configuration to prevent your application from accumulating too many
 versions.
 


tags
SdkInternalList<T> tags

 Specifies the tags applied to the application.
 
 
 Elastic Beanstalk applies these tags only to the application. Environments that you create in the application
 don't inherit the tags.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


application
ApplicationDescription application

 The ApplicationDescription of the application.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application. If no application is found with this name, and AutoCreateApplication is
 false, returns an InvalidParameterValue error.
 


versionLabel
String versionLabel

 A label identifying this version.
 
 
 Constraint: Must be unique per application. If an application version already exists with this label for the
 specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.
 


description
String description

 Describes this version.
 


sourceBuildInformation
SourceBuildInformation sourceBuildInformation

 Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.
 


sourceBundle
S3Location sourceBundle

 The Amazon S3 bucket and key that identify the location of the source bundle for this version.
 
 
 
 The Amazon S3 bucket must be in the same region as the environment.
 
 
 
 Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with
 SourceBuildInformation), but not both. If neither SourceBundle nor
 SourceBuildInformation are provided, Elastic Beanstalk uses a sample application.
 


buildConfiguration
BuildConfiguration buildConfiguration

 Settings for an AWS CodeBuild build.
 


autoCreateApplication
Boolean autoCreateApplication

 Set to true to create an application with the specified name if it doesn't already exist.
 


process
Boolean process

 Pre-processes and validates the environment manifest (env.yaml) and configuration files (
 *.config files in the .ebextensions folder) in the source bundle. Validating
 configuration files can identify issues prior to deploying the application version to an environment.
 
 
 You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For
 application versions built from a source bundle in Amazon S3, processing is optional.
 
 
 
 The Process option validates Elastic Beanstalk configuration files. It doesn't validate your
 application's configuration files, like proxy server or Docker configuration.
 
 


tags
SdkInternalList<T> tags

 Specifies the tags applied to the application version.
 
 
 Elastic Beanstalk applies these tags only to the application version. Environments that use the application
 version don't inherit the tags.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationVersion
ApplicationVersionDescription applicationVersion

 The ApplicationVersionDescription of the application version.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateConfigurationTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application to associate with this configuration template. If no application is found with this
 name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
 


templateName
String templateName

 The name of the configuration template.
 
 
 Constraint: This name must be unique per application.
 
 
 Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an
 InvalidParameterValue error.
 


solutionStackName
String solutionStackName

 The name of the solution stack used by this configuration. The solution stack specifies the operating system,
 architecture, and application server for a configuration template. It determines the set of configuration options
 as well as the possible and default values.
 
 
 Use ListAvailableSolutionStacks to obtain a list of available solution stacks.
 
 
 A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk
 returns an InvalidParameterValue error.
 
 
 If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic
 Beanstalk uses the same solution stack as the source configuration template.
 


platformArn
String platformArn

 The ARN of the custom platform.
 


sourceConfiguration
SourceConfiguration sourceConfiguration

 If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to
 create a new configuration.
 
 
 Values specified in the OptionSettings parameter of this call overrides any values obtained from the
 SourceConfiguration.
 
 
 If no configuration template is found, returns an InvalidParameterValue error.
 
 
 Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the
 solution stack of the source configuration template must match the specified solution stack name or else AWS
 Elastic Beanstalk returns an InvalidParameterCombination error.
 


environmentId
String environmentId

 The ID of the environment used with this configuration template.
 


description
String description

 Describes this configuration.
 


optionSettings
SdkInternalList<T> optionSettings

 If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value
 overrides the value obtained from the solution stack or the source configuration template.
 


tags
SdkInternalList<T> tags

 Specifies the tags applied to the configuration template.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateConfigurationTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


solutionStackName
String solutionStackName

 The name of the solution stack this configuration set uses.
 


platformArn
String platformArn

 The ARN of the platform.
 


applicationName
String applicationName

 The name of the application associated with this configuration set.
 


templateName
String templateName

 If not null, the name of the configuration template for this configuration set.
 


description
String description

 Describes this configuration set.
 


environmentName
String environmentName

 If not null, the name of the environment for this configuration set.
 


deploymentStatus
String deploymentStatus

 If this configuration set is associated with an environment, the DeploymentStatus parameter
 indicates the deployment status of this configuration set:
 
 
 
 
 null: This configuration is not associated with a running environment.
 
 
 
 
 pending: This is a draft configuration that is not deployed to the associated environment but is in
 the process of deploying.
 
 
 
 
 deployed: This is the configuration that is currently deployed to the associated running
 environment.
 
 
 
 
 failed: This is a draft configuration that failed to successfully deploy.
 
 
 


dateCreated
Date dateCreated

 The date (in UTC time) when this configuration set was created.
 


dateUpdated
Date dateUpdated

 The date (in UTC time) when this configuration set was last modified.
 


optionSettings
SdkInternalList<T> optionSettings

 A list of the configuration options and their values in this configuration set.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application that contains the version to be deployed.
 
 
 If no application is found with this name, CreateEnvironment returns an
 InvalidParameterValue error.
 


environmentName
String environmentName

 A unique name for the deployment environment. Used in the application URL.
 
 
 Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens.
 It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified
 name already exists in the region, AWS Elastic Beanstalk returns an InvalidParameterValue error.
 
 
 Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore
 part of the visible URL for your application.
 


groupName
String groupName

 The name of the group to which the target environment belongs. Specify a group name only if the environment's
 name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest
 (env.yaml) for details.
 


description
String description

 Describes this environment.
 


cNAMEPrefix
String cNAMEPrefix

 If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME
 is generated automatically by appending a random alphanumeric string to the environment name.
 


tier
EnvironmentTier tier

 This specifies the tier to use for creating this environment.
 


tags
SdkInternalList<T> tags

 Specifies the tags applied to resources in the environment.
 


versionLabel
String versionLabel

 The name of the application version to deploy.
 
 
 If the specified application has no associated application versions, AWS Elastic Beanstalk
 UpdateEnvironment returns an InvalidParameterValue error.
 
 
 Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.
 


templateName
String templateName

 The name of the configuration template to use in deployment. If no configuration template is found with this
 name, AWS Elastic Beanstalk returns an InvalidParameterValue error.
 


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.
 
 
 For a list of current solution stacks, see Elastic Beanstalk Supported
 Platforms.
 


platformArn
String platformArn

 The ARN of the platform.
 


optionSettings
SdkInternalList<T> optionSettings

 If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the
 configuration set for the new environment. These override the values obtained from the solution stack or the
 configuration template.
 


optionsToRemove
SdkInternalList<T> optionsToRemove

 A list of custom user-defined configuration options to remove from the configuration set for this new
 environment.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


environmentName
String environmentName

 The name of this environment.
 


environmentId
String environmentId

 The ID of this environment.
 


applicationName
String applicationName

 The name of the application associated with this environment.
 


versionLabel
String versionLabel

 The application version deployed in this environment.
 


solutionStackName
String solutionStackName

 The name of the SolutionStack deployed with this environment.
 


platformArn
String platformArn

 The ARN of the platform.
 


templateName
String templateName

 The name of the configuration template used to originally launch this environment.
 


description
String description

 Describes this environment.
 


endpointURL
String endpointURL

 For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the
 IP address of the instance.
 


cNAME
String cNAME

 The URL to the CNAME for this environment.
 


dateCreated
Date dateCreated

 The creation date for this environment.
 


dateUpdated
Date dateUpdated

 The last modified date for this environment.
 


status
String status

 The current operational status of the environment:
 
 
 
 
 Launching: Environment is in the process of initial deployment.
 
 
 
 
 Updating: Environment is in the process of updating its configuration settings or application
 version.
 
 
 
 
 Ready: Environment is available to have an action performed on it, such as update or terminate.
 
 
 
 
 Terminating: Environment is in the shut-down process.
 
 
 
 
 Terminated: Environment is not running.
 
 
 


abortableOperationInProgress
Boolean abortableOperationInProgress

 Indicates if there is an in-progress environment configuration update or application version deployment that you
 can cancel.
 
 
 true: There is an update in progress.
 
 
 false: There are no updates currently in progress.
 


health
String health

 Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running
 environment:
 
 
 
 
 Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures
 occur for an environment.
 
 
 
 
 Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an
 environment.
 
 
 
 
 Green: Indicates the environment is healthy and fully functional.
 
 
 
 
 Grey: Default health for a new environment. The environment is not fully launched and health checks
 have not started or health checks are suspended during an UpdateEnvironment or
 RestartEnvironment request.
 
 
 
 
 Default: Grey
 


healthStatus
String healthStatus

 Returns the health status of the application running in your environment. For more information, see Health Colors and
 Statuses.
 


resources
EnvironmentResourcesDescription resources

 The description of the AWS resources used by this environment.
 


tier
EnvironmentTier tier

 Describes the current tier of this environment.
 


environmentLinks
SdkInternalList<T> environmentLinks

 A list of links to other environments in the same group.
 


environmentArn
String environmentArn

 The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreatePlatformVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


platformName
String platformName

 The name of your custom platform.
 


platformVersion
String platformVersion

 The number, such as 1.0.2, for the new platform version.
 


platformDefinitionBundle
S3Location platformDefinitionBundle

 The location of the platform definition archive in Amazon S3.
 


environmentName
String environmentName

 The name of the builder environment.
 


optionSettings
SdkInternalList<T> optionSettings

 The configuration option settings to apply to the builder environment.
 


tags
SdkInternalList<T> tags

 Specifies the tags applied to the new platform version.
 
 
 Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the
 platform version don't inherit the tags.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreatePlatformVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


platformSummary
PlatformSummary platformSummary

 Detailed information about the new version of the custom platform.
 


builder
Builder builder

 The builder used to create the custom platform.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateStorageLocationRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.CreateStorageLocationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


s3Bucket
String s3Bucket

 The name of the Amazon S3 bucket created.
 








Class com.amazonaws.services.elasticbeanstalk.model.CustomAmi extends Object implements Serializable


Serialized Fields


virtualizationType
String virtualizationType

 The type of virtualization used to create the custom AMI.
 


imageId
String imageId

 THe ID of the image used to create the custom AMI.
 








Class com.amazonaws.services.elasticbeanstalk.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application to delete.
 


terminateEnvByForce
Boolean terminateEnvByForce

 When set to true, running environments will be terminated before deleting the application.
 








Class com.amazonaws.services.elasticbeanstalk.model.DeleteApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.DeleteApplicationVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application to which the version belongs.
 


versionLabel
String versionLabel

 The label of the version to delete.
 


deleteSourceBundle
Boolean deleteSourceBundle

 Set to true to delete the source bundle from your storage bucket. Otherwise, the application version
 is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.
 








Class com.amazonaws.services.elasticbeanstalk.model.DeleteApplicationVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.DeleteConfigurationTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application to delete the configuration template from.
 


templateName
String templateName

 The name of the configuration template to delete.
 








Class com.amazonaws.services.elasticbeanstalk.model.DeleteConfigurationTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.DeleteEnvironmentConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application the environment is associated with.
 


environmentName
String environmentName

 The name of the environment to delete the draft configuration from.
 








Class com.amazonaws.services.elasticbeanstalk.model.DeleteEnvironmentConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.DeletePlatformVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


platformArn
String platformArn

 The ARN of the version of the custom platform.
 








Class com.amazonaws.services.elasticbeanstalk.model.DeletePlatformVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


platformSummary
PlatformSummary platformSummary

 Detailed information about the version of the custom platform.
 








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


Serialized Fields


versionLabel
String versionLabel

 The version label of the application version in the deployment.
 


deploymentId
Long deploymentId

 The ID of the deployment. This number increases by one each time that you deploy source code or change instance
 configuration settings.
 


status
String status

 The status of the deployment:
 
 
 
 
 In Progress : The deployment is in progress.
 
 
 
 
 Deployed : The deployment succeeded.
 
 
 
 
 Failed : The deployment failed.
 
 
 


deploymentTime
Date deploymentTime

 For in-progress deployments, the time that the deployment started.
 
 
 For completed deployments, the time that the deployment ended.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.DescribeAccountAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceQuotas
ResourceQuotas resourceQuotas

 The Elastic Beanstalk resource quotas associated with the calling AWS account.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationNames
SdkInternalList<T> applicationNames

 If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified
 names.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applications
SdkInternalList<T> applications

 This parameter contains a list of ApplicationDescription.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Specify an application name to show only application versions for that application.
 


versionLabels
SdkInternalList<T> versionLabels

 Specify a version label to show a specific application version.
 


maxRecords
Integer maxRecords

 For a paginated request. Specify a maximum number of application versions to include in each response.
 
 
 If no MaxRecords is specified, all available application versions are retrieved in a single
 response.
 


nextToken
String nextToken

 For a paginated request. Specify a token from a previous response page to retrieve the next response page. All
 other parameter values must be identical to the ones specified in the initial request.
 
 
 If no NextToken is specified, the first page is retrieved.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationVersions
SdkInternalList<T> applicationVersions

 List of ApplicationVersionDescription objects sorted in order of creation.
 


nextToken
String nextToken

 In a paginated request, the token that you can pass in a subsequent request to get the next response page.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application associated with the configuration template or environment. Only needed if you want to
 describe the configuration options associated with either the configuration template or environment.
 


templateName
String templateName

 The name of the configuration template whose configuration options you want to describe.
 


environmentName
String environmentName

 The name of the environment whose configuration options you want to describe.
 


solutionStackName
String solutionStackName

 The name of the solution stack whose configuration options you want to describe.
 


platformArn
String platformArn

 The ARN of the custom platform.
 


options
SdkInternalList<T> options

 If specified, restricts the descriptions to only the specified options.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


solutionStackName
String solutionStackName

 The name of the solution stack these configuration options belong to.
 


platformArn
String platformArn

 The ARN of the platform.
 


options
SdkInternalList<T> options

 A list of ConfigurationOptionDescription.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The application for the environment or configuration template.
 


templateName
String templateName

 The name of the configuration template to describe.
 
 
 Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS
 Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS
 Elastic Beanstalk returns a MissingRequiredParameter error.
 


environmentName
String environmentName

 The name of the environment to describe.
 
 
 Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic
 Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurationSettings
SdkInternalList<T> configurationSettings

 A list of ConfigurationSettingsDescription.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentHealthRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentName
String environmentName

 Specify the environment by name.
 
 
 You must specify either this or an EnvironmentName, or both.
 


environmentId
String environmentId

 Specify the environment by ID.
 
 
 You must specify either this or an EnvironmentName, or both.
 


attributeNames
SdkInternalList<T> attributeNames

 Specify the response elements to return. To retrieve all attributes, set to All. If no attribute
 names are specified, returns the name of the environment.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentHealthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


environmentName
String environmentName

 The environment's name.
 


healthStatus
String healthStatus

 The health
 status of the environment. For example, Ok.
 


status
String status

 The environment's operational status. Ready, Launching, Updating,
 Terminating, or Terminated.
 


color
String color

 The health color
 of the environment.
 


causes
SdkInternalList<T> causes

 Descriptions of the data that contributed to the environment's current health status.
 


applicationMetrics
ApplicationMetrics applicationMetrics

 Application request metrics for the environment.
 


instancesHealth
InstanceHealthSummary instancesHealth

 Summary health information for the instances in the environment.
 


refreshedAt
Date refreshedAt

 The date and time that the health information was retrieved.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The environment ID of the target environment.
 


environmentName
String environmentName

 The name of the target environment.
 


nextToken
String nextToken

 The pagination token returned by a previous request.
 


maxItems
Integer maxItems

 The maximum number of items to return for a single request.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


managedActionHistoryItems
SdkInternalList<T> managedActionHistoryItems

 A list of completed and failed managed actions.
 


nextToken
String nextToken

 A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of
 results.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentName
String environmentName

 The name of the target environment.
 


environmentId
String environmentId

 The environment ID of the target environment.
 


status
String status

 To show only actions with a particular status, specify a status.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


managedActions
SdkInternalList<T> managedActions

 A list of upcoming and in-progress managed actions.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the environment to retrieve AWS resource usage data.
 
 
 Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 


environmentName
String environmentName

 The name of the environment to retrieve AWS resource usage data.
 
 
 Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


environmentResources
EnvironmentResourceDescription environmentResources

 A list of EnvironmentResourceDescription.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated
 with this application.
 


versionLabel
String versionLabel

 If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated
 with this application version.
 


environmentIds
SdkInternalList<T> environmentIds

 If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the
 specified IDs.
 


environmentNames
SdkInternalList<T> environmentNames

 If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the
 specified names.
 


includeDeleted
Boolean includeDeleted

 Indicates whether to include deleted environments:
 
 
 true: Environments that have been deleted after IncludedDeletedBackTo are displayed.
 
 
 false: Do not include deleted environments.
 


includedDeletedBackTo
Date includedDeletedBackTo

 If specified when IncludeDeleted is set to true, then environments deleted after this
 date are displayed.
 


maxRecords
Integer maxRecords

 For a paginated request. Specify a maximum number of environments to include in each response.
 
 
 If no MaxRecords is specified, all available environments are retrieved in a single response.
 


nextToken
String nextToken

 For a paginated request. Specify a token from a previous response page to retrieve the next response page. All
 other parameter values must be identical to the ones specified in the initial request.
 
 
 If no NextToken is specified, the first page is retrieved.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


environments
SdkInternalList<T> environments

 Returns an EnvironmentDescription list.
 


nextToken
String nextToken

 In a paginated request, the token that you can pass in a subsequent request to get the next response page.
 








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


Serialized Fields


applicationName
String applicationName

 If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with
 this application.
 


versionLabel
String versionLabel

 If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application
 version.
 


templateName
String templateName

 If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this
 environment configuration.
 


environmentId
String environmentId

 If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this
 environment.
 


environmentName
String environmentName

 If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this
 environment.
 


platformArn
String platformArn

 The ARN of the version of the custom platform.
 


requestId
String requestId

 If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this
 request ID.
 


severity
String severity

 If specified, limits the events returned from this call to include only those with the specified severity or
 higher.
 


startTime
Date startTime

 If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this
 time.
 


endTime
Date endTime

 If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not
 including, the EndTime.
 


maxRecords
Integer maxRecords

 Specifies the maximum number of events that can be returned, beginning with the most recent event.
 


nextToken
String nextToken

 Pagination token. If specified, the events return the next batch of results.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


events
SdkInternalList<T> events

 A list of EventDescription.
 


nextToken
String nextToken

 If returned, this indicates that there are more results to obtain. Use this token in the next
 DescribeEvents call to get the next batch of events.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeInstancesHealthRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentName
String environmentName

 Specify the AWS Elastic Beanstalk environment by name.
 


environmentId
String environmentId

 Specify the AWS Elastic Beanstalk environment by ID.
 


attributeNames
SdkInternalList<T> attributeNames

 Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no
 attribute names are specified, returns a list of instances.
 


nextToken
String nextToken

 Specify the pagination token returned by a previous call.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeInstancesHealthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceHealthList
SdkInternalList<T> instanceHealthList

 Detailed health information about each instance.
 
 
 The output differs slightly between Linux and Windows environments. There is a difference in the members that are
 supported under the <CPUUtilization> type.
 


refreshedAt
Date refreshedAt

 The date and time that the health information was retrieved.
 


nextToken
String nextToken

 Pagination token for the next page of results, if available.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribePlatformVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


platformArn
String platformArn

 The ARN of the version of the platform.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribePlatformVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


platformDescription
PlatformDescription platformDescription

 Detailed information about the version of the platform.
 








Class com.amazonaws.services.elasticbeanstalk.model.ElasticBeanstalkServiceException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription extends Object implements Serializable


Serialized Fields


environmentName
String environmentName

 The name of this environment.
 


environmentId
String environmentId

 The ID of this environment.
 


applicationName
String applicationName

 The name of the application associated with this environment.
 


versionLabel
String versionLabel

 The application version deployed in this environment.
 


solutionStackName
String solutionStackName

 The name of the SolutionStack deployed with this environment.
 


platformArn
String platformArn

 The ARN of the platform.
 


templateName
String templateName

 The name of the configuration template used to originally launch this environment.
 


description
String description

 Describes this environment.
 


endpointURL
String endpointURL

 For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the
 IP address of the instance.
 


cNAME
String cNAME

 The URL to the CNAME for this environment.
 


dateCreated
Date dateCreated

 The creation date for this environment.
 


dateUpdated
Date dateUpdated

 The last modified date for this environment.
 


status
String status

 The current operational status of the environment:
 
 
 
 
 Launching: Environment is in the process of initial deployment.
 
 
 
 
 Updating: Environment is in the process of updating its configuration settings or application
 version.
 
 
 
 
 Ready: Environment is available to have an action performed on it, such as update or terminate.
 
 
 
 
 Terminating: Environment is in the shut-down process.
 
 
 
 
 Terminated: Environment is not running.
 
 
 


abortableOperationInProgress
Boolean abortableOperationInProgress

 Indicates if there is an in-progress environment configuration update or application version deployment that you
 can cancel.
 
 
 true: There is an update in progress.
 
 
 false: There are no updates currently in progress.
 


health
String health

 Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running
 environment:
 
 
 
 
 Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures
 occur for an environment.
 
 
 
 
 Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an
 environment.
 
 
 
 
 Green: Indicates the environment is healthy and fully functional.
 
 
 
 
 Grey: Default health for a new environment. The environment is not fully launched and health checks
 have not started or health checks are suspended during an UpdateEnvironment or
 RestartEnvironment request.
 
 
 
 
 Default: Grey
 


healthStatus
String healthStatus

 Returns the health status of the application running in your environment. For more information, see Health Colors and
 Statuses.
 


resources
EnvironmentResourcesDescription resources

 The description of the AWS resources used by this environment.
 


tier
EnvironmentTier tier

 Describes the current tier of this environment.
 


environmentLinks
SdkInternalList<T> environmentLinks

 A list of links to other environments in the same group.
 


environmentArn
String environmentArn

 The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
 








Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentInfoDescription extends Object implements Serializable


Serialized Fields


infoType
String infoType

 The type of information retrieved.
 


ec2InstanceId
String ec2InstanceId

 The Amazon EC2 Instance ID for this information.
 


sampleTimestamp
Date sampleTimestamp

 The time stamp when this information was retrieved.
 


message
String message

 The retrieved information. Currently contains a presigned Amazon S3 URL. The files are deleted after 15 minutes.
 
 
 Anyone in possession of this URL can access the files before they are deleted. Make the URL available only to
 trusted parties.
 








Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentLink extends Object implements Serializable


Serialized Fields


linkName
String linkName

 The name of the link.
 


environmentName
String environmentName

 The name of the linked environment (the dependency).
 








Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentResourceDescription extends Object implements Serializable


Serialized Fields


environmentName
String environmentName

 The name of the environment.
 


autoScalingGroups
SdkInternalList<T> autoScalingGroups

 The AutoScalingGroups used by this environment.
 


instances
SdkInternalList<T> instances

 The Amazon EC2 instances used by this environment.
 


launchConfigurations
SdkInternalList<T> launchConfigurations

 The Auto Scaling launch configurations in use by this environment.
 


launchTemplates
SdkInternalList<T> launchTemplates

 The Amazon EC2 launch templates in use by this environment.
 


loadBalancers
SdkInternalList<T> loadBalancers

 The LoadBalancers in use by this environment.
 


triggers
SdkInternalList<T> triggers

 The AutoScaling triggers in use by this environment.
 


queues
SdkInternalList<T> queues

 The queues used by this environment.
 








Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentResourcesDescription extends Object implements Serializable


Serialized Fields


loadBalancer
LoadBalancerDescription loadBalancer

 Describes the LoadBalancer.
 








Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentTier extends Object implements Serializable


Serialized Fields


name
String name

 The name of this environment tier.
 
 
 Valid values:
 
 
 
 
 For Web server tier – WebServer
 
 
 
 
 For Worker tier – Worker
 
 
 


type
String type

 The type of this environment tier.
 
 
 Valid values:
 
 
 
 
 For Web server tier – Standard
 
 
 
 
 For Worker tier – SQS/HTTP
 
 
 


version
String version

 The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest
 compatible worker tier version.
 
 
 
 This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it
 unspecified.
 
 








Class com.amazonaws.services.elasticbeanstalk.model.EventDescription extends Object implements Serializable


Serialized Fields


eventDate
Date eventDate

 The date when the event occurred.
 


message
String message

 The event message.
 


applicationName
String applicationName

 The application associated with the event.
 


versionLabel
String versionLabel

 The release label for the application version associated with this event.
 


templateName
String templateName

 The name of the configuration associated with this event.
 


environmentName
String environmentName

 The name of the environment associated with this event.
 


platformArn
String platformArn

 The ARN of the platform.
 


requestId
String requestId

 The web service request ID for the activity of this event.
 


severity
String severity

 The severity level of this event.
 








Class com.amazonaws.services.elasticbeanstalk.model.Instance extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the Amazon EC2 instance.
 








Class com.amazonaws.services.elasticbeanstalk.model.InstanceHealthSummary extends Object implements Serializable


Serialized Fields


noData
Integer noData

 Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.
 


unknown
Integer unknown

 Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an
 instance.
 


pending
Integer pending

 Grey. An operation is in progress on an instance within the command timeout.
 


ok
Integer ok

 Green. An instance is passing health checks and the health agent is not reporting any problems.
 


info
Integer info

 Green. An operation is in progress on an instance.
 


warning
Integer warning

 Yellow. The health agent is reporting a moderate number of request failures or other issues for an
 instance or environment.
 


degraded
Integer degraded

 Red. The health agent is reporting a high number of request failures or other issues for an instance or
 environment.
 


severe
Integer severe

 Red. The health agent is reporting a very high number of request failures or other issues for an instance
 or environment.
 








Class com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.InvalidRequestException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.Latency extends Object implements Serializable


Serialized Fields


p999
Double p999

 The average latency for the slowest 0.1 percent of requests over the last 10 seconds.
 


p99
Double p99

 The average latency for the slowest 1 percent of requests over the last 10 seconds.
 


p95
Double p95

 The average latency for the slowest 5 percent of requests over the last 10 seconds.
 


p90
Double p90

 The average latency for the slowest 10 percent of requests over the last 10 seconds.
 


p85
Double p85

 The average latency for the slowest 15 percent of requests over the last 10 seconds.
 


p75
Double p75

 The average latency for the slowest 25 percent of requests over the last 10 seconds.
 


p50
Double p50

 The average latency for the slowest 50 percent of requests over the last 10 seconds.
 


p10
Double p10

 The average latency for the slowest 90 percent of requests over the last 10 seconds.
 








Class com.amazonaws.services.elasticbeanstalk.model.LaunchConfiguration extends Object implements Serializable


Serialized Fields


name
String name

 The name of the launch configuration.
 








Class com.amazonaws.services.elasticbeanstalk.model.LaunchTemplate extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the launch template.
 








Class com.amazonaws.services.elasticbeanstalk.model.ListAvailableSolutionStacksRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.ListAvailableSolutionStacksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


solutionStacks
SdkInternalList<T> solutionStacks

 A list of available solution stacks.
 


solutionStackDetails
SdkInternalList<T> solutionStackDetails

 A list of available solution stacks and their SolutionStackDescription.
 








Class com.amazonaws.services.elasticbeanstalk.model.Listener extends Object implements Serializable


Serialized Fields


protocol
String protocol

 The protocol that is used by the Listener.
 


port
Integer port

 The port that is used by the Listener.
 








Class com.amazonaws.services.elasticbeanstalk.model.ListPlatformVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
SdkInternalList<T> filters

 List only the platforms where the platform member value relates to one of the supplied values.
 


maxRecords
Integer maxRecords

 The maximum number of platform values returned in one call.
 


nextToken
String nextToken

 The starting index into the remaining list of platforms. Use the NextToken value from a previous
 ListPlatformVersion call.
 








Class com.amazonaws.services.elasticbeanstalk.model.ListPlatformVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


platformSummaryList
SdkInternalList<T> platformSummaryList

 Detailed information about the platforms.
 


nextToken
String nextToken

 The starting index into the remaining list of platforms. if this value is not null, you can use it
 in a subsequent ListPlatformVersion call.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.
 
 
 Must be the ARN of an Elastic Beanstalk environment.
 








Class com.amazonaws.services.elasticbeanstalk.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resouce for which a tag list was requested.
 


resourceTags
SdkInternalList<T> resourceTags

 A list of tag key-value pairs.
 








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


Serialized Fields


name
String name

 The name of the LoadBalancer.
 








Class com.amazonaws.services.elasticbeanstalk.model.LoadBalancerDescription extends Object implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the LoadBalancer.
 


domain
String domain

 The domain name of the LoadBalancer.
 


listeners
SdkInternalList<T> listeners

 A list of Listeners used by the LoadBalancer.
 








Class com.amazonaws.services.elasticbeanstalk.model.ManagedAction extends Object implements Serializable


Serialized Fields


actionId
String actionId

 A unique identifier for the managed action.
 


actionDescription
String actionDescription

 A description of the managed action.
 


actionType
String actionType

 The type of managed action.
 


status
String status

 The status of the managed action. If the action is Scheduled, you can apply it immediately with
 ApplyEnvironmentManagedAction.
 


windowStartTime
Date windowStartTime

 The start time of the maintenance window in which the managed action will execute.
 








Class com.amazonaws.services.elasticbeanstalk.model.ManagedActionHistoryItem extends Object implements Serializable


Serialized Fields


actionId
String actionId

 A unique identifier for the managed action.
 


actionType
String actionType

 The type of the managed action.
 


actionDescription
String actionDescription

 A description of the managed action.
 


failureType
String failureType

 If the action failed, the type of failure.
 


status
String status

 The status of the action.
 


failureDescription
String failureDescription

 If the action failed, a description of the failure.
 


executedTime
Date executedTime

 The date and time that the action started executing.
 


finishedTime
Date finishedTime

 The date and time that the action finished executing.
 








Class com.amazonaws.services.elasticbeanstalk.model.ManagedActionInvalidStateException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.MaxAgeRule extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specify true to apply the rule, or false to disable it.
 


maxAgeInDays
Integer maxAgeInDays

 Specify the number of days to retain an application versions.
 


deleteSourceFromS3
Boolean deleteSourceFromS3

 Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the
 application version.
 








Class com.amazonaws.services.elasticbeanstalk.model.MaxCountRule extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specify true to apply the rule, or false to disable it.
 


maxCount
Integer maxCount

 Specify the maximum number of application versions to retain.
 


deleteSourceFromS3
Boolean deleteSourceFromS3

 Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the
 application version.
 








Class com.amazonaws.services.elasticbeanstalk.model.OperationInProgressException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.OptionRestrictionRegex extends Object implements Serializable


Serialized Fields


pattern
String pattern

 The regular expression pattern that a string configuration option value with this restriction must match.
 


label
String label

 A unique name representing this regular expression.
 








Class com.amazonaws.services.elasticbeanstalk.model.OptionSpecification extends Object implements Serializable


Serialized Fields


resourceName
String resourceName

 A unique resource name for a time-based scaling configuration option.
 


namespace
String namespace

 A unique namespace identifying the option's associated AWS resource.
 


optionName
String optionName

 The name of the configuration option.
 








Class com.amazonaws.services.elasticbeanstalk.model.PlatformDescription extends Object implements Serializable


Serialized Fields


platformArn
String platformArn

 The ARN of the platform.
 


platformOwner
String platformOwner

 The AWS account ID of the person who created the platform.
 


platformName
String platformName

 The name of the platform.
 


platformVersion
String platformVersion

 The version of the platform.
 


solutionStackName
String solutionStackName

 The name of the solution stack used by the platform.
 


platformStatus
String platformStatus

 The status of the platform.
 


dateCreated
Date dateCreated

 The date when the platform was created.
 


dateUpdated
Date dateUpdated

 The date when the platform was last updated.
 


platformCategory
String platformCategory

 The category of the platform.
 


description
String description

 The description of the platform.
 


maintainer
String maintainer

 Information about the maintainer of the platform.
 


operatingSystemName
String operatingSystemName

 The operating system used by the platform.
 


operatingSystemVersion
String operatingSystemVersion

 The version of the operating system used by the platform.
 


programmingLanguages
SdkInternalList<T> programmingLanguages

 The programming languages supported by the platform.
 


frameworks
SdkInternalList<T> frameworks

 The frameworks supported by the platform.
 


customAmiList
SdkInternalList<T> customAmiList

 The custom AMIs supported by the platform.
 


supportedTierList
SdkInternalList<T> supportedTierList

 The tiers supported by the platform.
 


supportedAddonList
SdkInternalList<T> supportedAddonList

 The additions supported by the platform.
 








Class com.amazonaws.services.elasticbeanstalk.model.PlatformFilter extends Object implements Serializable


Serialized Fields


type
String type

 The custom platform attribute to which the filter values are applied.
 
 
 Valid Values: PlatformName | PlatformVersion | PlatformStatus |
 PlatformOwner
 


operator
String operator

 The operator to apply to the Type with each of the Values.
 
 
 Valid Values: = (equal to) | != (not equal to) | < (less than) |
 <= (less than or equal to) | > (greater than) | >= (greater than
 or equal to) | contains | begins_with | ends_with
 


values
SdkInternalList<T> values

 The list of values applied to the custom platform attribute.
 








Class com.amazonaws.services.elasticbeanstalk.model.PlatformFramework extends Object implements Serializable


Serialized Fields


name
String name

 The name of the framework.
 


version
String version

 The version of the framework.
 








Class com.amazonaws.services.elasticbeanstalk.model.PlatformProgrammingLanguage extends Object implements Serializable


Serialized Fields


name
String name

 The name of the programming language.
 


version
String version

 The version of the programming language.
 








Class com.amazonaws.services.elasticbeanstalk.model.PlatformSummary extends Object implements Serializable


Serialized Fields


platformArn
String platformArn

 The ARN of the platform.
 


platformOwner
String platformOwner

 The AWS account ID of the person who created the platform.
 


platformStatus
String platformStatus

 The status of the platform. You can create an environment from the platform once it is ready.
 


platformCategory
String platformCategory

 The category of platform.
 


operatingSystemName
String operatingSystemName

 The operating system used by the platform.
 


operatingSystemVersion
String operatingSystemVersion

 The version of the operating system used by the platform.
 


supportedTierList
SdkInternalList<T> supportedTierList

 The tiers in which the platform runs.
 


supportedAddonList
SdkInternalList<T> supportedAddonList

 The additions associated with the platform.
 








Class com.amazonaws.services.elasticbeanstalk.model.PlatformVersionStillReferencedException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.Queue extends Object implements Serializable


Serialized Fields


name
String name

 The name of the queue.
 


uRL
String uRL

 The URL of the queue.
 








Class com.amazonaws.services.elasticbeanstalk.model.RebuildEnvironmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the environment to rebuild.
 
 
 Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 


environmentName
String environmentName

 The name of the environment to rebuild.
 
 
 Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 








Class com.amazonaws.services.elasticbeanstalk.model.RebuildEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.RequestEnvironmentInfoRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the environment of the requested data.
 
 
 If no such environment is found, RequestEnvironmentInfo returns an
 InvalidParameterValue error.
 
 
 Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 


environmentName
String environmentName

 The name of the environment of the requested data.
 
 
 If no such environment is found, RequestEnvironmentInfo returns an
 InvalidParameterValue error.
 
 
 Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 


infoType
String infoType

 The type of information to request.
 








Class com.amazonaws.services.elasticbeanstalk.model.RequestEnvironmentInfoResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.ResourceNotFoundException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.ResourceQuota extends Object implements Serializable


Serialized Fields


maximum
Integer maximum

 The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.
 








Class com.amazonaws.services.elasticbeanstalk.model.ResourceQuotas extends Object implements Serializable


Serialized Fields


applicationQuota
ResourceQuota applicationQuota

 The quota for applications in the AWS account.
 


applicationVersionQuota
ResourceQuota applicationVersionQuota

 The quota for application versions in the AWS account.
 


environmentQuota
ResourceQuota environmentQuota

 The quota for environments in the AWS account.
 


configurationTemplateQuota
ResourceQuota configurationTemplateQuota

 The quota for configuration templates in the AWS account.
 


customPlatformQuota
ResourceQuota customPlatformQuota

 The quota for custom platforms in the AWS account.
 








Class com.amazonaws.services.elasticbeanstalk.model.ResourceTypeNotSupportedException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.RestartAppServerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the environment to restart the server for.
 
 
 Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 


environmentName
String environmentName

 The name of the environment to restart the server for.
 
 
 Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 








Class com.amazonaws.services.elasticbeanstalk.model.RestartAppServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.RetrieveEnvironmentInfoRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the data's environment.
 
 
 If no such environment is found, returns an InvalidParameterValue error.
 
 
 Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 


environmentName
String environmentName

 The name of the data's environment.
 
 
 If no such environment is found, returns an InvalidParameterValue error.
 
 
 Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 


infoType
String infoType

 The type of information to retrieve.
 








Class com.amazonaws.services.elasticbeanstalk.model.RetrieveEnvironmentInfoResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


environmentInfo
SdkInternalList<T> environmentInfo

 The EnvironmentInfoDescription of the environment.
 








Class com.amazonaws.services.elasticbeanstalk.model.S3Location extends Object implements Serializable


Serialized Fields


s3Bucket
String s3Bucket

 The Amazon S3 bucket where the data is located.
 


s3Key
String s3Key

 The Amazon S3 key where the data is located.
 








Class com.amazonaws.services.elasticbeanstalk.model.S3LocationNotInServiceRegionException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.S3SubscriptionRequiredException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.SingleInstanceHealth extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the Amazon EC2 instance.
 


healthStatus
String healthStatus

 Returns the health status of the specified instance. For more information, see Health Colors and
 Statuses.
 


color
String color

 Represents the color indicator that gives you information about the health of the EC2 instance. For more
 information, see Health Colors and
 Statuses.
 


causes
SdkInternalList<T> causes

 Represents the causes, which provide more information about the current health status.
 


launchedAt
Date launchedAt

 The time at which the EC2 instance was launched.
 


applicationMetrics
ApplicationMetrics applicationMetrics

 Request metrics from your application.
 


system
SystemStatus system

 Operating system metrics from the instance.
 


deployment
Deployment deployment

 Information about the most recent deployment to an instance.
 


availabilityZone
String availabilityZone

 The availability zone in which the instance runs.
 


instanceType
String instanceType

 The instance's type.
 








Class com.amazonaws.services.elasticbeanstalk.model.SolutionStackDescription extends Object implements Serializable


Serialized Fields


solutionStackName
String solutionStackName

 The name of the solution stack.
 


permittedFileTypes
SdkInternalList<T> permittedFileTypes

 The permitted file types allowed for a solution stack.
 








Class com.amazonaws.services.elasticbeanstalk.model.SourceBuildInformation extends Object implements Serializable


Serialized Fields


sourceType
String sourceType

 The type of repository.
 
 
 
 
 Git
 
 
 
 
 Zip
 
 
 


sourceRepository
String sourceRepository

 Location where the repository is stored.
 
 
 
 
 CodeCommit
 
 
 
 
 S3
 
 
 


sourceLocation
String sourceLocation

 The location of the source code, as a formatted string, depending on the value of SourceRepository
 
 
 
 
 For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For
 example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.
 
 
 
 
 For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example,
 my-s3-bucket/Folders/my-source-file.
 
 
 








Class com.amazonaws.services.elasticbeanstalk.model.SourceBundleDeletionException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.SourceConfiguration extends Object implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application associated with the configuration.
 


templateName
String templateName

 The name of the configuration template.
 








Class com.amazonaws.services.elasticbeanstalk.model.StatusCodes extends Object implements Serializable


Serialized Fields


status2xx
Integer status2xx

 The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.
 


status3xx
Integer status3xx

 The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.
 


status4xx
Integer status4xx

 The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.
 


status5xx
Integer status5xx

 The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.
 








Class com.amazonaws.services.elasticbeanstalk.model.SwapEnvironmentCNAMEsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceEnvironmentId
String sourceEnvironmentId

 The ID of the source environment.
 
 
 Condition: You must specify at least the SourceEnvironmentID or the
 SourceEnvironmentName. You may also specify both. If you specify the
 SourceEnvironmentId, you must specify the DestinationEnvironmentId.
 


sourceEnvironmentName
String sourceEnvironmentName

 The name of the source environment.
 
 
 Condition: You must specify at least the SourceEnvironmentID or the
 SourceEnvironmentName. You may also specify both. If you specify the
 SourceEnvironmentName, you must specify the DestinationEnvironmentName.
 


destinationEnvironmentId
String destinationEnvironmentId

 The ID of the destination environment.
 
 
 Condition: You must specify at least the DestinationEnvironmentID or the
 DestinationEnvironmentName. You may also specify both. You must specify the
 SourceEnvironmentId with the DestinationEnvironmentId.
 


destinationEnvironmentName
String destinationEnvironmentName

 The name of the destination environment.
 
 
 Condition: You must specify at least the DestinationEnvironmentID or the
 DestinationEnvironmentName. You may also specify both. You must specify the
 SourceEnvironmentName with the DestinationEnvironmentName.
 








Class com.amazonaws.services.elasticbeanstalk.model.SwapEnvironmentCNAMEsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.SystemStatus extends Object implements Serializable


Serialized Fields


cPUUtilization
CPUUtilization cPUUtilization

 CPU utilization metrics for the instance.
 


loadAverage
SdkInternalList<T> loadAverage

 Load average in the last 1-minute, 5-minute, and 15-minute periods. For more information, see Operating System Metrics.
 








Class com.amazonaws.services.elasticbeanstalk.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key of the tag.
 


value
String value

 The value of the tag.
 








Class com.amazonaws.services.elasticbeanstalk.model.TerminateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


environmentId
String environmentId

 The ID of the environment to terminate.
 
 
 Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 


environmentName
String environmentName

 The name of the environment to terminate.
 
 
 Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 


terminateResources
Boolean terminateResources

 Indicates whether the associated AWS resources should shut down when the environment is terminated:
 
 
 
 
 true: The specified environment as well as the associated AWS resources, such as Auto Scaling group
 and LoadBalancer, are terminated.
 
 
 
 
 false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS
 resources continue to operate.
 
 
 
 
 For more information, see the  AWS Elastic
 Beanstalk User Guide. 
 
 
 Default: true
 
 
 Valid Values: true | false
 


forceTerminate
Boolean forceTerminate

 Terminates the target environment even if another environment in the same group is dependent on it.
 








Class com.amazonaws.services.elasticbeanstalk.model.TerminateEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


environmentName
String environmentName

 The name of this environment.
 


environmentId
String environmentId

 The ID of this environment.
 


applicationName
String applicationName

 The name of the application associated with this environment.
 


versionLabel
String versionLabel

 The application version deployed in this environment.
 


solutionStackName
String solutionStackName

 The name of the SolutionStack deployed with this environment.
 


platformArn
String platformArn

 The ARN of the platform.
 


templateName
String templateName

 The name of the configuration template used to originally launch this environment.
 


description
String description

 Describes this environment.
 


endpointURL
String endpointURL

 For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the
 IP address of the instance.
 


cNAME
String cNAME

 The URL to the CNAME for this environment.
 


dateCreated
Date dateCreated

 The creation date for this environment.
 


dateUpdated
Date dateUpdated

 The last modified date for this environment.
 


status
String status

 The current operational status of the environment:
 
 
 
 
 Launching: Environment is in the process of initial deployment.
 
 
 
 
 Updating: Environment is in the process of updating its configuration settings or application
 version.
 
 
 
 
 Ready: Environment is available to have an action performed on it, such as update or terminate.
 
 
 
 
 Terminating: Environment is in the shut-down process.
 
 
 
 
 Terminated: Environment is not running.
 
 
 


abortableOperationInProgress
Boolean abortableOperationInProgress

 Indicates if there is an in-progress environment configuration update or application version deployment that you
 can cancel.
 
 
 true: There is an update in progress.
 
 
 false: There are no updates currently in progress.
 


health
String health

 Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running
 environment:
 
 
 
 
 Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures
 occur for an environment.
 
 
 
 
 Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an
 environment.
 
 
 
 
 Green: Indicates the environment is healthy and fully functional.
 
 
 
 
 Grey: Default health for a new environment. The environment is not fully launched and health checks
 have not started or health checks are suspended during an UpdateEnvironment or
 RestartEnvironment request.
 
 
 
 
 Default: Grey
 


healthStatus
String healthStatus

 Returns the health status of the application running in your environment. For more information, see Health Colors and
 Statuses.
 


resources
EnvironmentResourcesDescription resources

 The description of the AWS resources used by this environment.
 


tier
EnvironmentTier tier

 Describes the current tier of this environment.
 


environmentLinks
SdkInternalList<T> environmentLinks

 A list of links to other environments in the same group.
 


environmentArn
String environmentArn

 The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
 








Class com.amazonaws.services.elasticbeanstalk.model.TooManyApplicationsException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.TooManyApplicationVersionsException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.TooManyBucketsException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.TooManyConfigurationTemplatesException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.TooManyEnvironmentsException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.TooManyPlatformsException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.TooManyTagsException extends AWSElasticBeanstalkException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.Trigger extends Object implements Serializable


Serialized Fields


name
String name

 The name of the trigger.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application to update. If no such application is found, UpdateApplication returns an
 InvalidParameterValue error.
 


description
String description

 A new description for the application.
 
 
 Default: If not specified, AWS Elastic Beanstalk does not update the description.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationResourceLifecycleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application.
 


resourceLifecycleConfig
ApplicationResourceLifecycleConfig resourceLifecycleConfig

 The lifecycle configuration.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationResourceLifecycleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application.
 


resourceLifecycleConfig
ApplicationResourceLifecycleConfig resourceLifecycleConfig

 The lifecycle configuration.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


application
ApplicationDescription application

 The ApplicationDescription of the application.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application associated with this version.
 
 
 If no application is found with this name, UpdateApplication returns an
 InvalidParameterValue error.
 


versionLabel
String versionLabel

 The name of the version to update.
 
 
 If no application version is found with this label, UpdateApplication returns an
 InvalidParameterValue error.
 


description
String description

 A new description for this version.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationVersion
ApplicationVersionDescription applicationVersion

 The ApplicationVersionDescription of the application version.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateConfigurationTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application associated with the configuration template to update.
 
 
 If no application is found with this name, UpdateConfigurationTemplate returns an
 InvalidParameterValue error.
 


templateName
String templateName

 The name of the configuration template to update.
 
 
 If no configuration template is found with this name, UpdateConfigurationTemplate returns an
 InvalidParameterValue error.
 


description
String description

 A new description for the configuration.
 


optionSettings
SdkInternalList<T> optionSettings

 A list of configuration option settings to update with the new specified option value.
 


optionsToRemove
SdkInternalList<T> optionsToRemove

 A list of configuration options to remove from the configuration set.
 
 
 Constraint: You can remove only UserDefined configuration options.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateConfigurationTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


solutionStackName
String solutionStackName

 The name of the solution stack this configuration set uses.
 


platformArn
String platformArn

 The ARN of the platform.
 


applicationName
String applicationName

 The name of the application associated with this configuration set.
 


templateName
String templateName

 If not null, the name of the configuration template for this configuration set.
 


description
String description

 Describes this configuration set.
 


environmentName
String environmentName

 If not null, the name of the environment for this configuration set.
 


deploymentStatus
String deploymentStatus

 If this configuration set is associated with an environment, the DeploymentStatus parameter
 indicates the deployment status of this configuration set:
 
 
 
 
 null: This configuration is not associated with a running environment.
 
 
 
 
 pending: This is a draft configuration that is not deployed to the associated environment but is in
 the process of deploying.
 
 
 
 
 deployed: This is the configuration that is currently deployed to the associated running
 environment.
 
 
 
 
 failed: This is a draft configuration that failed to successfully deploy.
 
 
 


dateCreated
Date dateCreated

 The date (in UTC time) when this configuration set was created.
 


dateUpdated
Date dateUpdated

 The date (in UTC time) when this configuration set was last modified.
 


optionSettings
SdkInternalList<T> optionSettings

 A list of the configuration options and their values in this configuration set.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application with which the environment is associated.
 


environmentId
String environmentId

 The ID of the environment to update.
 
 
 If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.
 
 
 Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 


environmentName
String environmentName

 The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an
 InvalidParameterValue error.
 
 
 Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic
 Beanstalk returns MissingRequiredParameter error.
 


groupName
String groupName

 The name of the group to which the target environment belongs. Specify a group name only if the environment's
 name is specified in an environment manifest and not with the environment name or environment ID parameters. See
 Environment
 Manifest (env.yaml) for details.
 


description
String description

 If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.
 


tier
EnvironmentTier tier

 This specifies the tier to use to update the environment.
 
 
 Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns
 InvalidParameterValue error.
 


versionLabel
String versionLabel

 If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment.
 If no such application version is found, returns an InvalidParameterValue error.
 


templateName
String templateName

 If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If
 no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue
 error.
 


solutionStackName
String solutionStackName

 This specifies the platform version that the environment will run after the environment is updated.
 


platformArn
String platformArn

 The ARN of the platform, if used.
 


optionSettings
SdkInternalList<T> optionSettings

 If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and
 sets the specified configuration options to the requested value.
 


optionsToRemove
SdkInternalList<T> optionsToRemove

 A list of custom user-defined configuration options to remove from the configuration set for this environment.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


environmentName
String environmentName

 The name of this environment.
 


environmentId
String environmentId

 The ID of this environment.
 


applicationName
String applicationName

 The name of the application associated with this environment.
 


versionLabel
String versionLabel

 The application version deployed in this environment.
 


solutionStackName
String solutionStackName

 The name of the SolutionStack deployed with this environment.
 


platformArn
String platformArn

 The ARN of the platform.
 


templateName
String templateName

 The name of the configuration template used to originally launch this environment.
 


description
String description

 Describes this environment.
 


endpointURL
String endpointURL

 For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the
 IP address of the instance.
 


cNAME
String cNAME

 The URL to the CNAME for this environment.
 


dateCreated
Date dateCreated

 The creation date for this environment.
 


dateUpdated
Date dateUpdated

 The last modified date for this environment.
 


status
String status

 The current operational status of the environment:
 
 
 
 
 Launching: Environment is in the process of initial deployment.
 
 
 
 
 Updating: Environment is in the process of updating its configuration settings or application
 version.
 
 
 
 
 Ready: Environment is available to have an action performed on it, such as update or terminate.
 
 
 
 
 Terminating: Environment is in the shut-down process.
 
 
 
 
 Terminated: Environment is not running.
 
 
 


abortableOperationInProgress
Boolean abortableOperationInProgress

 Indicates if there is an in-progress environment configuration update or application version deployment that you
 can cancel.
 
 
 true: There is an update in progress.
 
 
 false: There are no updates currently in progress.
 


health
String health

 Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running
 environment:
 
 
 
 
 Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures
 occur for an environment.
 
 
 
 
 Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an
 environment.
 
 
 
 
 Green: Indicates the environment is healthy and fully functional.
 
 
 
 
 Grey: Default health for a new environment. The environment is not fully launched and health checks
 have not started or health checks are suspended during an UpdateEnvironment or
 RestartEnvironment request.
 
 
 
 
 Default: Grey
 


healthStatus
String healthStatus

 Returns the health status of the application running in your environment. For more information, see Health Colors and
 Statuses.
 


resources
EnvironmentResourcesDescription resources

 The description of the AWS resources used by this environment.
 


tier
EnvironmentTier tier

 Describes the current tier of this environment.
 


environmentLinks
SdkInternalList<T> environmentLinks

 A list of links to other environments in the same group.
 


environmentArn
String environmentArn

 The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resouce to be updated.
 
 
 Must be the ARN of an Elastic Beanstalk environment.
 


tagsToAdd
SdkInternalList<T> tagsToAdd

 A list of tags to add or update.
 
 
 If a key of an existing tag is added, the tag's value is updated.
 


tagsToRemove
SdkInternalList<T> tagsToRemove

 A list of tag keys to remove.
 
 
 If a tag key doesn't exist, it is silently ignored.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.ValidateConfigurationSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application that the configuration template or environment belongs to.
 


templateName
String templateName

 The name of the configuration template to validate the settings against.
 
 
 Condition: You cannot specify both this and an environment name.
 


environmentName
String environmentName

 The name of the environment to validate the settings against.
 
 
 Condition: You cannot specify both this and a configuration template name.
 


optionSettings
SdkInternalList<T> optionSettings

 A list of the options and desired values to evaluate.
 








Class com.amazonaws.services.elasticbeanstalk.model.ValidateConfigurationSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


messages
SdkInternalList<T> messages

 A list of ValidationMessage.
 








Class com.amazonaws.services.elasticbeanstalk.model.ValidationMessage extends Object implements Serializable


Serialized Fields


message
String message

 A message describing the error or warning.
 


severity
String severity

 An indication of the severity of this message:
 
 
 
 
 error: This message indicates that this is not a valid setting for an option.
 
 
 
 
 warning: This message is providing information you should take into account.
 
 
 


namespace
String namespace

 The namespace to which the option belongs.
 


optionName
String optionName

 The name of the option.
 








Package com.amazonaws.services.elasticfilesystem.model




Class com.amazonaws.services.elasticfilesystem.model.AccessPointAlreadyExistsException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode


accessPointId
String accessPointId








Class com.amazonaws.services.elasticfilesystem.model.AccessPointDescription extends Object implements Serializable


Serialized Fields


clientToken
String clientToken

 The opaque string specified in the request to ensure idempotent creation.
 


name
String name

 The name of the access point. This is the value of the Name tag.
 


tags
SdkInternalList<T> tags

 The tags associated with the access point, presented as an array of Tag objects.
 


accessPointId
String accessPointId

 The ID of the access point, assigned by Amazon EFS.
 


accessPointArn
String accessPointArn

 The unique Amazon Resource Name (ARN) associated with the access point.
 


fileSystemId
String fileSystemId

 The ID of the EFS file system that the access point applies to.
 


posixUser
PosixUser posixUser

 The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is
 used for all file operations by NFS clients using the access point.
 


rootDirectory
RootDirectory rootDirectory

 The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients
 using the access point.
 


ownerId
String ownerId

 Identified the AWS account that owns the access point resource.
 


lifeCycleState
String lifeCycleState

 Identifies the lifecycle phase of the access point.
 








Class com.amazonaws.services.elasticfilesystem.model.AccessPointLimitExceededException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.AccessPointNotFoundException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.AmazonElasticFileSystemException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticfilesystem.model.BadRequestException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.CreateAccessPointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientToken
String clientToken

 A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.
 


tags
SdkInternalList<T> tags

 Creates tags associated with the access point. Each tag is a key-value pair.
 


fileSystemId
String fileSystemId

 The ID of the EFS file system that the access point provides access to.
 


posixUser
PosixUser posixUser

 The operating system user and group applied to all file system requests made using the access point.
 


rootDirectory
RootDirectory rootDirectory

 Specifies the directory on the Amazon EFS file system that the access point exposes as the root directory of your
 file system to NFS clients using the access point. The clients using the access point can only access the root
 directory and below. If the RootDirectory > Path specified does not exist, EFS
 creates it and applies the CreationInfo settings when a client connects to an access point. When
 specifying a RootDirectory, you need to provide the Path, and the
 CreationInfo is optional.
 








Class com.amazonaws.services.elasticfilesystem.model.CreateAccessPointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clientToken
String clientToken

 The opaque string specified in the request to ensure idempotent creation.
 


name
String name

 The name of the access point. This is the value of the Name tag.
 


tags
SdkInternalList<T> tags

 The tags associated with the access point, presented as an array of Tag objects.
 


accessPointId
String accessPointId

 The ID of the access point, assigned by Amazon EFS.
 


accessPointArn
String accessPointArn

 The unique Amazon Resource Name (ARN) associated with the access point.
 


fileSystemId
String fileSystemId

 The ID of the EFS file system that the access point applies to.
 


posixUser
PosixUser posixUser

 The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point that is
 used for all file operations by NFS clients using the access point.
 


rootDirectory
RootDirectory rootDirectory

 The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients
 using the access point.
 


ownerId
String ownerId

 Identified the AWS account that owns the access point resource.
 


lifeCycleState
String lifeCycleState

 Identifies the lifecycle phase of the access point.
 








Class com.amazonaws.services.elasticfilesystem.model.CreateFileSystemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


creationToken
String creationToken

 A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.
 


performanceMode
String performanceMode

 The performance mode of the file system. We recommend generalPurpose performance mode for most file
 systems. File systems using the maxIO performance mode can scale to higher levels of aggregate
 throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The
 performance mode can't be changed after the file system has been created.
 


encrypted
Boolean encrypted

 A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have
 the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS
 KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS,
 /aws/elasticfilesystem, is used to protect the encrypted file system.
 


kmsKeyId
String kmsKeyId

 The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you
 want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID
 can be in one of the following formats:
 
 
 
 
 Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.
 
 
 
 
 ARN - An Amazon Resource Name (ARN) for the key, for example
 arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
 
 
 
 
 Key alias - A previously created display name for a key, for example alias/projectKey1.
 
 
 
 
 Key alias ARN - An ARN for a key alias, for example
 arn:aws:kms:us-west-2:444455556666:alias/projectKey1.
 
 
 
 
 If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to
 true.
 


throughputMode
String throughputMode

 The throughput mode for the file system to be created. There are two throughput modes to choose from for your
 file system: bursting and provisioned. If you set ThroughputMode to
 provisioned, you must also set a value for ProvisionedThroughPutInMibps. You can
 decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as
 long as it’s been more than 24 hours since the last decrease or throughput mode change. For more, see Specifying Throughput
 with Provisioned Mode in the Amazon EFS User Guide.
 


provisionedThroughputInMibps
Double provisionedThroughputInMibps

 The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid
 values are 1-1024. Required if ThroughputMode is set to provisioned. The upper limit
 for throughput is 1024 MiB/s. You can get this limit increased by contacting AWS Support. For more information,
 see Amazon EFS Limits That You Can
 Increase in the Amazon EFS User Guide.
 


tags
SdkInternalList<T> tags

 A value that specifies to create one or more tags associated with the file system. Each tag is a user-defined
 key-value pair. Name your file system on creation by including a "Key":"Name","Value":"{value}"
 key-value pair.
 








Class com.amazonaws.services.elasticfilesystem.model.CreateFileSystemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerId
String ownerId

 The AWS account that created the file system. If the file system was created by an IAM user, the parent account
 to which the user belongs is the owner.
 


creationToken
String creationToken

 The opaque string specified in the request.
 


fileSystemId
String fileSystemId

 The ID of the file system, assigned by Amazon EFS.
 


creationTime
Date creationTime

 The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
 


lifeCycleState
String lifeCycleState

 The lifecycle phase of the file system.
 


name
String name

 You can add tags to a file system, including a Name tag. For more information, see
 CreateFileSystem. 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 that the file system has. For more information, see CreateMountTarget.
 


sizeInBytes
FileSystemSize sizeInBytes

 The latest known metered size (in bytes) of data stored in the file system, 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. The SizeInBytes value doesn't 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, SizeInBytes represents 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 that the file system was
 at any point in time.
 


performanceMode
String performanceMode

 The performance mode of the file system.
 


encrypted
Boolean encrypted

 A Boolean value that, if true, indicates that the file system is encrypted.
 


kmsKeyId
String kmsKeyId

 The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the
 encrypted file system.
 


throughputMode
String throughputMode

 The throughput mode for a file system. There are two throughput modes to choose from for your file system:
 bursting and provisioned. If you set ThroughputMode to
 provisioned, you must also set a value for ProvisionedThroughPutInMibps. You can
 decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as
 long as it’s been more than 24 hours since the last decrease or throughput mode change.
 


provisionedThroughputInMibps
Double provisionedThroughputInMibps

 The throughput, measured in MiB/s, that you want to provision for a file system. Valid values are 1-1024.
 Required if ThroughputMode is set to provisioned. The limit on throughput is 1024
 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can
 Increase in the Amazon EFS User Guide.
 


tags
SdkInternalList<T> tags

 The tags associated with the file system, presented as an array of Tag objects.
 








Class com.amazonaws.services.elasticfilesystem.model.CreateMountTargetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 The ID of the file system for which to create the mount target.
 


subnetId
String subnetId

 The ID of the subnet to add the mount target in.
 


ipAddress
String ipAddress

 Valid IPv4 address within the address range of the specified subnet.
 


securityGroups
SdkInternalList<T> securityGroups

 Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet
 specified.
 








Class com.amazonaws.services.elasticfilesystem.model.CreateMountTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerId
String ownerId

 AWS account ID that owns the resource.
 


mountTargetId
String mountTargetId

 System-assigned mount target ID.
 


fileSystemId
String fileSystemId

 The ID of the file system for which the mount target is intended.
 


subnetId
String subnetId

 The ID of the mount target's subnet.
 


lifeCycleState
String lifeCycleState

 Lifecycle state of the mount target.
 


ipAddress
String ipAddress

 Address at which the file system can be mounted by using the mount target.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface that Amazon EFS created when it created the mount target.
 


availabilityZoneId
String availabilityZoneId

 The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in. For example,
 use1-az1 is an AZ ID for the us-east-1 Region and it has the same location in every AWS account.
 


availabilityZoneName
String availabilityZoneName

 The name of the Availability Zone (AZ) that the mount target resides in. AZs are independently mapped to names
 for each AWS account. For example, the Availability Zone us-east-1a for your AWS account might not
 be the same location as us-east-1a for another AWS account.
 








Class com.amazonaws.services.elasticfilesystem.model.CreateTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the
 file system.
 


tags
SdkInternalList<T> tags

 An array of Tag objects to add. Each Tag object is a key-value pair.
 








Class com.amazonaws.services.elasticfilesystem.model.CreateTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticfilesystem.model.CreationInfo extends Object implements Serializable


Serialized Fields


ownerUid
Long ownerUid

 Specifies the POSIX user ID to apply to the RootDirectory. Accepts values from 0 to 2^32
 (4294967295).
 


ownerGid
Long ownerGid

 Specifies the POSIX group ID to apply to the RootDirectory. Accepts values from 0 to 2^32
 (4294967295).
 


permissions
String permissions

 Specifies the POSIX permissions to apply to the RootDirectory, in the format of an octal number
 representing the file's mode bits.
 








Class com.amazonaws.services.elasticfilesystem.model.DeleteAccessPointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessPointId
String accessPointId

 The ID of the access point that you want to delete.
 








Class com.amazonaws.services.elasticfilesystem.model.DeleteAccessPointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticfilesystem.model.DeleteFileSystemPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 Specifies the EFS file system for which to delete the FileSystemPolicy.
 








Class com.amazonaws.services.elasticfilesystem.model.DeleteFileSystemPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticfilesystem.model.DeleteFileSystemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 The ID of the file system you want to delete.
 








Class com.amazonaws.services.elasticfilesystem.model.DeleteFileSystemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticfilesystem.model.DeleteMountTargetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mountTargetId
String mountTargetId

 The ID of the mount target to delete (String).
 








Class com.amazonaws.services.elasticfilesystem.model.DeleteMountTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticfilesystem.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 The ID of the file system whose tags you want to delete (String).
 


tagKeys
SdkInternalList<T> tagKeys

 A list of tag keys to delete.
 








Class com.amazonaws.services.elasticfilesystem.model.DeleteTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticfilesystem.model.DependencyTimeoutException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.DescribeAccessPointsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 (Optional) When retrieving all access points for a file system, you can optionally specify the
 MaxItems parameter to limit the number of objects returned in a response. The default value is 100.
 


nextToken
String nextToken

 NextToken is present if the response is paginated. You can use NextMarker in the
 subsequent request to fetch the next page of access point descriptions.
 


accessPointId
String accessPointId

 (Optional) Specifies an EFS access point to describe in the response; mutually exclusive with
 FileSystemId.
 


fileSystemId
String fileSystemId

 (Optional) If you provide a FileSystemId, EFS returns all access points for that file system;
 mutually exclusive with AccessPointId.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeAccessPointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accessPoints
SdkInternalList<T> accessPoints

 An array of access point descriptions.
 


nextToken
String nextToken

 Present if there are more access points than returned in the response. You can use the NextMarker in the
 subsequent request to fetch the additional descriptions.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeFileSystemPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 Specifies which EFS file system to retrieve the FileSystemPolicy for.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeFileSystemPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 Specifies the EFS file system to which the FileSystemPolicy applies.
 


policy
String policy

 The JSON formatted FileSystemPolicy for the EFS file system.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeFileSystemsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxItems
Integer maxItems

 (Optional) Specifies the maximum number of file systems to return in the response (integer). This number is
 automatically set to 100. The response is paginated at 100 per page if you have more than 100 file systems.
 


marker
String marker

 (Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String).
 If present, specifies to continue the list from where the returning call had left off.
 


creationToken
String creationToken

 (Optional) Restricts the list to the file system with this creation token (String). You specify a creation token
 when you create an Amazon EFS file system.
 


fileSystemId
String fileSystemId

 (Optional) ID of the file system whose description you want to retrieve (String).
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeFileSystemsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 Present if provided by caller in the request (String).
 


fileSystems
SdkInternalList<T> fileSystems

 An array of file system descriptions.
 


nextMarker
String nextMarker

 Present if there are more file systems than returned in the response (String). You can use the
 NextMarker in the subsequent request to fetch the descriptions.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeLifecycleConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 The ID of the file system whose LifecycleConfiguration object you want to retrieve (String).
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeLifecycleConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


lifecyclePolicies
SdkInternalList<T> lifecyclePolicies

 An array of lifecycle management policies. Currently, EFS supports a maximum of one policy per file system.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeMountTargetSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mountTargetId
String mountTargetId

 The ID of the mount target whose security groups you want to retrieve.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeMountTargetSecurityGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityGroups
SdkInternalList<T> securityGroups

 An array of security groups.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeMountTargetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxItems
Integer maxItems

 (Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set
 to 10, and other values are ignored. The response is paginated at 100 per page if you have more than 100 mount
 targets.
 


marker
String marker

 (Optional) Opaque pagination token returned from a previous DescribeMountTargets operation (String).
 If present, it specifies to continue the list from where the previous returning call left off.
 


fileSystemId
String fileSystemId

 (Optional) ID of the file system whose mount targets you want to list (String). It must be included in your
 request if an AccessPointId or MountTargetId is not included. Accepts either a file
 system ID or ARN as input.
 


mountTargetId
String mountTargetId

 (Optional) ID of the mount target that you want to have described (String). It must be included in your request
 if FileSystemId is not included. Accepts either a mount target ID or ARN as input.
 


accessPointId
String accessPointId

 (Optional) The ID of the access point whose mount targets that you want to list. It must be included in your
 request if a FileSystemId or MountTargetId is not included in your request. Accepts
 either an access point ID or ARN as input.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeMountTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 If the request included the Marker, the response returns that value in this field.
 


mountTargets
SdkInternalList<T> mountTargets

 Returns the file system's mount targets as an array of MountTargetDescription objects.
 


nextMarker
String nextMarker

 If a value is present, there are more mount targets to return. In a subsequent request, you can provide
 Marker in your request with this value to retrieve the next set of mount targets.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxItems
Integer maxItems

 (Optional) The maximum number of file system tags to return in the response. Currently, this number is
 automatically set to 100, and other values are ignored. The response is paginated at 100 per page if you have
 more than 100 tags.
 


marker
String marker

 (Optional) An opaque pagination token returned from a previous DescribeTags operation (String). If
 present, it specifies to continue the list from where the previous call left off.
 


fileSystemId
String fileSystemId

 The ID of the file system whose tag set you want to retrieve.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 If the request included a Marker, the response returns that value in this field.
 


tags
SdkInternalList<T> tags

 Returns tags associated with the file system as an array of Tag objects.
 


nextMarker
String nextMarker

 If a value is present, there are more tags to return. In a subsequent request, you can provide the value of
 NextMarker as the value of the Marker parameter in your next request to retrieve the
 next set of tags.
 








Class com.amazonaws.services.elasticfilesystem.model.FileSystemAlreadyExistsException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode


fileSystemId
String fileSystemId








Class com.amazonaws.services.elasticfilesystem.model.FileSystemDescription extends Object implements Serializable


Serialized Fields


ownerId
String ownerId

 The AWS account that created the file system. If the file system was created by an IAM user, the parent account
 to which the user belongs is the owner.
 


creationToken
String creationToken

 The opaque string specified in the request.
 


fileSystemId
String fileSystemId

 The ID of the file system, assigned by Amazon EFS.
 


creationTime
Date creationTime

 The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
 


lifeCycleState
String lifeCycleState

 The lifecycle phase of the file system.
 


name
String name

 You can add tags to a file system, including a Name tag. For more information, see
 CreateFileSystem. 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 that the file system has. For more information, see CreateMountTarget.
 


sizeInBytes
FileSystemSize sizeInBytes

 The latest known metered size (in bytes) of data stored in the file system, 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. The SizeInBytes value doesn't 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, SizeInBytes represents 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 that the file system was
 at any point in time.
 


performanceMode
String performanceMode

 The performance mode of the file system.
 


encrypted
Boolean encrypted

 A Boolean value that, if true, indicates that the file system is encrypted.
 


kmsKeyId
String kmsKeyId

 The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the
 encrypted file system.
 


throughputMode
String throughputMode

 The throughput mode for a file system. There are two throughput modes to choose from for your file system:
 bursting and provisioned. If you set ThroughputMode to
 provisioned, you must also set a value for ProvisionedThroughPutInMibps. You can
 decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as
 long as it’s been more than 24 hours since the last decrease or throughput mode change.
 


provisionedThroughputInMibps
Double provisionedThroughputInMibps

 The throughput, measured in MiB/s, that you want to provision for a file system. Valid values are 1-1024.
 Required if ThroughputMode is set to provisioned. The limit on throughput is 1024
 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can
 Increase in the Amazon EFS User Guide.
 


tags
SdkInternalList<T> tags

 The tags associated with the file system, presented as an array of Tag objects.
 








Class com.amazonaws.services.elasticfilesystem.model.FileSystemInUseException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.FileSystemLimitExceededException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.FileSystemNotFoundException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.FileSystemSize extends Object implements Serializable


Serialized Fields


value
Long value

 The latest known metered size (in bytes) of data stored in the file system.
 


timestamp
Date timestamp

 The time at which the size of data, returned in the Value field, was determined. The value is the
 integer number of seconds since 1970-01-01T00:00:00Z.
 


valueInIA
Long valueInIA

 The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.
 


valueInStandard
Long valueInStandard

 The latest known metered size (in bytes) of data stored in the Standard storage class.
 








Class com.amazonaws.services.elasticfilesystem.model.IncorrectFileSystemLifeCycleStateException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.IncorrectMountTargetStateException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.InsufficientThroughputCapacityException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.InvalidPolicyException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.IpAddressInUseException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.LifecyclePolicy extends Object implements Serializable


Serialized Fields


transitionToIA
String transitionToIA

 A value that describes the period of time that a file is not accessed, after which it transitions to the IA
 storage class. Metadata operations such as listing the contents of a directory don't count as file access events.
 








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


Serialized Fields


resourceId
String resourceId

 Specifies the EFS resource you want to retrieve tags for. You can retrieve tags for EFS file systems and access
 points using this API endpoint.
 


maxResults
Integer maxResults

 (Optional) Specifies the maximum number of tag objects to return in the response. The default value is 100.
 


nextToken
String nextToken

 You can use NextToken in a subsequent request to fetch the next page of access point descriptions if
 the response payload was paginated.
 








Class com.amazonaws.services.elasticfilesystem.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 An array of the tags for the specified EFS resource.
 


nextToken
String nextToken

 NextToken is present if the response payload is paginated. You can use NextToken in a
 subsequent request to fetch the next page of access point descriptions.
 








Class com.amazonaws.services.elasticfilesystem.model.ModifyMountTargetSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mountTargetId
String mountTargetId

 The ID of the mount target whose security groups you want to modify.
 


securityGroups
SdkInternalList<T> securityGroups

 An array of up to five VPC security group IDs.
 








Class com.amazonaws.services.elasticfilesystem.model.ModifyMountTargetSecurityGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticfilesystem.model.MountTargetConflictException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.MountTargetDescription extends Object implements Serializable


Serialized Fields


ownerId
String ownerId

 AWS account ID that owns the resource.
 


mountTargetId
String mountTargetId

 System-assigned mount target ID.
 


fileSystemId
String fileSystemId

 The ID of the file system for which the mount target is intended.
 


subnetId
String subnetId

 The ID of the mount target's subnet.
 


lifeCycleState
String lifeCycleState

 Lifecycle state of the mount target.
 


ipAddress
String ipAddress

 Address at which the file system can be mounted by using the mount target.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface that Amazon EFS created when it created the mount target.
 


availabilityZoneId
String availabilityZoneId

 The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in. For example,
 use1-az1 is an AZ ID for the us-east-1 Region and it has the same location in every AWS account.
 


availabilityZoneName
String availabilityZoneName

 The name of the Availability Zone (AZ) that the mount target resides in. AZs are independently mapped to names
 for each AWS account. For example, the Availability Zone us-east-1a for your AWS account might not
 be the same location as us-east-1a for another AWS account.
 








Class com.amazonaws.services.elasticfilesystem.model.MountTargetNotFoundException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.NetworkInterfaceLimitExceededException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.NoFreeAddressesInSubnetException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.PolicyNotFoundException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.PosixUser extends Object implements Serializable


Serialized Fields


uid
Long uid

 The POSIX user ID used for all file system operations using this access point.
 


gid
Long gid

 The POSIX group ID used for all file system operations using this access point.
 


secondaryGids
SdkInternalList<T> secondaryGids

 Secondary POSIX group IDs used for all file system operations using this access point.
 








Class com.amazonaws.services.elasticfilesystem.model.PutFileSystemPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 The ID of the EFS file system that you want to create or update the FileSystemPolicy for.
 


policy
String policy

 The FileSystemPolicy that you're creating. Accepts a JSON formatted policy definition. To find out
 more about the elements that make up a file system policy, see EFS Resource-based Policies.
 


bypassPolicyLockoutSafetyCheck
Boolean bypassPolicyLockoutSafetyCheck

 (Optional) A flag to indicate whether to bypass the FileSystemPolicy lockout safety check. The
 policy lockout safety check determines whether the policy in the request will prevent the principal making the
 request will be locked out from making future PutFileSystemPolicy requests on the file system. Set
 BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the principal
 that is making the request from making a subsequent PutFileSystemPolicy request on the file system.
 The default value is False.
 








Class com.amazonaws.services.elasticfilesystem.model.PutFileSystemPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 Specifies the EFS file system to which the FileSystemPolicy applies.
 


policy
String policy

 The JSON formatted FileSystemPolicy for the EFS file system.
 








Class com.amazonaws.services.elasticfilesystem.model.PutLifecycleConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 The ID of the file system for which you are creating the LifecycleConfiguration object (String).
 


lifecyclePolicies
SdkInternalList<T> lifecyclePolicies

 An array of LifecyclePolicy objects that define the file system's
 LifecycleConfiguration object. A LifecycleConfiguration object tells lifecycle
 management when to transition files from the Standard storage class to the Infrequent Access storage class.
 








Class com.amazonaws.services.elasticfilesystem.model.PutLifecycleConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


lifecyclePolicies
SdkInternalList<T> lifecyclePolicies

 An array of lifecycle management policies. Currently, EFS supports a maximum of one policy per file system.
 








Class com.amazonaws.services.elasticfilesystem.model.RootDirectory extends Object implements Serializable


Serialized Fields


path
String path

 Specifies the path on the EFS file system to expose as the root directory to NFS clients using the access point
 to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist,
 you are required to provide the CreationInfo.
 


creationInfo
CreationInfo creationInfo

 (Optional) Specifies the POSIX IDs and permissions to apply to the access point's RootDirectory. If
 the RootDirectory > Path specified does not exist, EFS creates the root directory
 using the CreationInfo settings when a client connects to an access point. When specifying the
 CreationInfo, you must provide values for all properties.
 
 
 
 If you do not provide CreationInfo and the specified RootDirectory >
 Path does not exist, attempts to mount the file system using the access point will fail.
 
 








Class com.amazonaws.services.elasticfilesystem.model.SecurityGroupLimitExceededException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.SecurityGroupNotFoundException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.SubnetNotFoundException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The tag key (String). The key can't start with aws:.
 


value
String value

 The value of the tag key.
 








Class com.amazonaws.services.elasticfilesystem.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceId
String resourceId

 The ID specifying the EFS resource that you want to create a tag for.
 


tags
SdkInternalList<T> tags









Class com.amazonaws.services.elasticfilesystem.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticfilesystem.model.ThroughputLimitExceededException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.TooManyRequestsException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.UnsupportedAvailabilityZoneException extends AmazonElasticFileSystemException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceId
String resourceId

 Specifies the EFS resource that you want to remove tags from.
 


tagKeys
SdkInternalList<T> tagKeys

 The keys of the key:value tag pairs that you want to remove from the specified EFS resource.
 








Class com.amazonaws.services.elasticfilesystem.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticfilesystem.model.UpdateFileSystemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 The ID of the file system that you want to update.
 


throughputMode
String throughputMode

 (Optional) The throughput mode that you want your file system to use. If you're not updating your throughput
 mode, you don't need to provide this value in your request. If you are changing the ThroughputMode
 to provisioned, you must also set a value for ProvisionedThroughputInMibps.
 


provisionedThroughputInMibps
Double provisionedThroughputInMibps

 (Optional) The amount of throughput, in MiB/s, that you want to provision for your file system. Valid values are
 1-1024. Required if ThroughputMode is changed to provisioned on update. If you're not
 updating the amount of provisioned throughput for your file system, you don't need to provide this value in your
 request.
 








Class com.amazonaws.services.elasticfilesystem.model.UpdateFileSystemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ownerId
String ownerId

 The AWS account that created the file system. If the file system was created by an IAM user, the parent account
 to which the user belongs is the owner.
 


creationToken
String creationToken

 The opaque string specified in the request.
 


fileSystemId
String fileSystemId

 The ID of the file system, assigned by Amazon EFS.
 


creationTime
Date creationTime

 The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).
 


lifeCycleState
String lifeCycleState

 The lifecycle phase of the file system.
 


name
String name

 You can add tags to a file system, including a Name tag. For more information, see
 CreateFileSystem. 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 that the file system has. For more information, see CreateMountTarget.
 


sizeInBytes
FileSystemSize sizeInBytes

 The latest known metered size (in bytes) of data stored in the file system, 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. The SizeInBytes value doesn't 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, SizeInBytes represents 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 that the file system was
 at any point in time.
 


performanceMode
String performanceMode

 The performance mode of the file system.
 


encrypted
Boolean encrypted

 A Boolean value that, if true, indicates that the file system is encrypted.
 


kmsKeyId
String kmsKeyId

 The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the
 encrypted file system.
 


throughputMode
String throughputMode

 The throughput mode for a file system. There are two throughput modes to choose from for your file system:
 bursting and provisioned. If you set ThroughputMode to
 provisioned, you must also set a value for ProvisionedThroughPutInMibps. You can
 decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as
 long as it’s been more than 24 hours since the last decrease or throughput mode change.
 


provisionedThroughputInMibps
Double provisionedThroughputInMibps

 The throughput, measured in MiB/s, that you want to provision for a file system. Valid values are 1-1024.
 Required if ThroughputMode is set to provisioned. The limit on throughput is 1024
 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can
 Increase in the Amazon EFS User Guide.
 


tags
SdkInternalList<T> tags

 The tags associated with the file system, presented as an array of Tag objects.
 








Package com.amazonaws.services.elasticinference.model




Class com.amazonaws.services.elasticinference.model.AmazonElasticInferenceException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticinference.model.BadRequestException extends AmazonElasticInferenceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticinference.model.InternalServerException extends AmazonElasticInferenceException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


resourceArn
String resourceArn
The ARN of the Elastic Inference Accelerator to list the tags for.








Class com.amazonaws.services.elasticinference.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags
The tags of the Elastic Inference Accelerator.








Class com.amazonaws.services.elasticinference.model.ResourceNotFoundException extends AmazonElasticInferenceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticinference.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn
The ARN of the Elastic Inference Accelerator to tag.


tags
Map<K,V> tags
The tags to add to the Elastic Inference Accelerator.








Class com.amazonaws.services.elasticinference.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticinference.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn
The ARN of the Elastic Inference Accelerator to untag.


tagKeys
List<E> tagKeys
The list of tags to remove from the Elastic Inference Accelerator.








Class com.amazonaws.services.elasticinference.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.elasticloadbalancing.model




Class com.amazonaws.services.elasticloadbalancing.model.AccessLog extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specifies whether access logs are enabled for the load balancer.
 


s3BucketName
String s3BucketName

 The name of the Amazon S3 bucket where the access logs are stored.
 


emitInterval
Integer emitInterval

 The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.
 
 
 Default: 60 minutes
 


s3BucketPrefix
String s3BucketPrefix

 The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If
 the prefix is not provided, the log is placed at the root level of the bucket.
 








Class com.amazonaws.services.elasticloadbalancing.model.AdditionalAttribute extends Object implements Serializable


Serialized Fields


key
String key

 This parameter is reserved.
 


value
String value

 This parameter is reserved.
 








Class com.amazonaws.services.elasticloadbalancing.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerNames
SdkInternalList<T> loadBalancerNames

 The name of the load balancer. You can specify one load balancer only.
 


tags
SdkInternalList<T> tags

 The tags.
 








Class com.amazonaws.services.elasticloadbalancing.model.AddTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.AmazonElasticLoadBalancingException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.AppCookieStickinessPolicy extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The mnemonic name for the policy being created. The name must be unique within a set of policies for this load
 balancer.
 


cookieName
String cookieName

 The name of the application cookie used for stickiness.
 








Class com.amazonaws.services.elasticloadbalancing.model.ApplySecurityGroupsToLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


securityGroups
SdkInternalList<T> securityGroups

 The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the
 security group.
 








Class com.amazonaws.services.elasticloadbalancing.model.ApplySecurityGroupsToLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityGroups
SdkInternalList<T> securityGroups

 The IDs of the security groups associated with the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.AttachLoadBalancerToSubnetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


subnets
SdkInternalList<T> subnets

 The IDs of the subnets to add. You can add only one subnet per Availability Zone.
 








Class com.amazonaws.services.elasticloadbalancing.model.AttachLoadBalancerToSubnetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


subnets
SdkInternalList<T> subnets

 The IDs of the subnets attached to the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.BackendServerDescription extends Object implements Serializable


Serialized Fields


instancePort
Integer instancePort

 The port on which the EC2 instance is listening.
 


policyNames
SdkInternalList<T> policyNames

 The names of the policies enabled for the EC2 instance.
 








Class com.amazonaws.services.elasticloadbalancing.model.CertificateNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.ConfigureHealthCheckRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


healthCheck
HealthCheck healthCheck

 The configuration information.
 








Class com.amazonaws.services.elasticloadbalancing.model.ConfigureHealthCheckResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


healthCheck
HealthCheck healthCheck

 The updated health check.
 








Class com.amazonaws.services.elasticloadbalancing.model.ConnectionDraining extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specifies whether connection draining is enabled for the load balancer.
 


timeout
Integer timeout

 The maximum time, in seconds, to keep the existing connections open before deregistering the instances.
 








Class com.amazonaws.services.elasticloadbalancing.model.ConnectionSettings extends Object implements Serializable


Serialized Fields


idleTimeout
Integer idleTimeout

 The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection)
 before it is closed by the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.CreateAppCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


policyName
String policyName

 The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This
 name must be unique within the set of policies for this load balancer.
 


cookieName
String cookieName

 The name of the application cookie used for stickiness.
 








Class com.amazonaws.services.elasticloadbalancing.model.CreateAppCookieStickinessPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.CreateLBCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


policyName
String policyName

 The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This
 name must be unique within the set of policies for this load balancer.
 


cookieExpirationPeriod
Long cookieExpirationPeriod

 The time period, in seconds, after which the cookie should be considered stale. If you do not specify this
 parameter, the default value is 0, which indicates that the sticky session should last for the duration of the
 browser session.
 








Class com.amazonaws.services.elasticloadbalancing.model.CreateLBCookieStickinessPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerListenersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


listeners
SdkInternalList<T> listeners

 The listeners.
 








Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerListenersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


policyName
String policyName

 The name of the load balancer policy to be created. This name must be unique within the set of policies for this
 load balancer.
 


policyTypeName
String policyTypeName

 The name of the base policy type. To get the list of policy types, use DescribeLoadBalancerPolicyTypes.
 


policyAttributes
SdkInternalList<T> policyAttributes

 The policy attributes.
 








Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 
 
 This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters,
 must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.
 


listeners
SdkInternalList<T> listeners

 The listeners.
 
 
 For more information, see Listeners for Your
 Classic Load Balancer in the Classic Load Balancers Guide.
 


availabilityZones
SdkInternalList<T> availabilityZones

 One or more Availability Zones from the same region as the load balancer.
 
 
 You must specify at least one Availability Zone.
 
 
 You can add more Availability Zones after you create the load balancer using
 EnableAvailabilityZonesForLoadBalancer.
 


subnets
SdkInternalList<T> subnets

 The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone
 specified in AvailabilityZones.
 


securityGroups
SdkInternalList<T> securityGroups

 The IDs of the security groups to assign to the load balancer.
 


scheme
String scheme

 The type of a load balancer. Valid only for load balancers in a VPC.
 
 
 By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to
 public IP addresses. For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide.
 
 
 Specify internal to create a load balancer with a DNS name that resolves to private IP addresses.
 


tags
SdkInternalList<T> tags

 A list of tags to assign to the load balancer.
 
 
 For more information about tagging your load balancer, see Tag Your Classic Load
 Balancer in the Classic Load Balancers Guide.
 








Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dNSName
String dNSName

 The DNS name of the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.CrossZoneLoadBalancing extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specifies whether cross-zone load balancing is enabled for the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerListenersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


loadBalancerPorts
SdkInternalList<T> loadBalancerPorts

 The client port numbers of the listeners.
 








Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerListenersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


policyName
String policyName

 The name of the policy.
 








Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.DependencyThrottleException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


instances
SdkInternalList<T> instances

 The IDs of the instances.
 








Class com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instances
SdkInternalList<T> instances

 The remaining instances registered with the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeAccountLimitsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeAccountLimitsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


limits
SdkInternalList<T> limits

 Information about the limits.
 


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.DescribeInstanceHealthRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


instances
SdkInternalList<T> instances

 The IDs of the instances.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeInstanceHealthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceStates
SdkInternalList<T> instanceStates

 Information about the health of the instances.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loadBalancerAttributes
LoadBalancerAttributes loadBalancerAttributes

 Information about the load balancer attributes.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


policyNames
SdkInternalList<T> policyNames

 The names of the policies.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyDescriptions
SdkInternalList<T> policyDescriptions

 Information about the policies.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPolicyTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyTypeNames
SdkInternalList<T> policyTypeNames

 The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load
 Balancing.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPolicyTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyTypeDescriptions
SdkInternalList<T> policyTypeDescriptions

 Information about the policy types.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerNames
SdkInternalList<T> loadBalancerNames

 The names of the load balancers.
 


marker
String marker

 The marker for the next set of results. (You received this marker from a previous call.)
 


pageSize
Integer pageSize

 The maximum number of results to return with this call (a number from 1 to 400). The default is 400.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loadBalancerDescriptions
SdkInternalList<T> loadBalancerDescriptions

 Information about the load balancers.
 


nextMarker
String nextMarker

 The marker to use when requesting the next set of results. If there are no additional results, the string is
 empty.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerNames
SdkInternalList<T> loadBalancerNames

 The names of the load balancers.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagDescriptions
SdkInternalList<T> tagDescriptions

 Information about the tags.
 








Class com.amazonaws.services.elasticloadbalancing.model.DetachLoadBalancerFromSubnetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


subnets
SdkInternalList<T> subnets

 The IDs of the subnets.
 








Class com.amazonaws.services.elasticloadbalancing.model.DetachLoadBalancerFromSubnetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


subnets
SdkInternalList<T> subnets

 The IDs of the remaining subnets for the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.DisableAvailabilityZonesForLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


availabilityZones
SdkInternalList<T> availabilityZones

 The Availability Zones.
 








Class com.amazonaws.services.elasticloadbalancing.model.DisableAvailabilityZonesForLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


availabilityZones
SdkInternalList<T> availabilityZones

 The remaining Availability Zones for the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.DuplicateListenerException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.DuplicateLoadBalancerNameException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.DuplicatePolicyNameException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.DuplicateTagKeysException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.EnableAvailabilityZonesForLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


availabilityZones
SdkInternalList<T> availabilityZones

 The Availability Zones. These must be in the same region as the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.EnableAvailabilityZonesForLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


availabilityZones
SdkInternalList<T> availabilityZones

 The updated list of Availability Zones for the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.HealthCheck extends Object implements Serializable


Serialized Fields


target
String target

 The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1)
 through 65535.
 
 
 TCP is the default, specified as a TCP: port pair, for example "TCP:5000". In this case, a health check simply
 attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured
 timeout is considered unhealthy.
 
 
 SSL is also specified as SSL: port pair, for example, SSL:5000.
 
 
 For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing;
 grouping, for example "HTTP:80/weather/us/wa/seattle". In this case, a HTTP GET request is issued to the instance
 on the given port and path. Any answer other than "200 OK" within the timeout period is considered unhealthy.
 
 
 The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.
 


interval
Integer interval

 The approximate interval, in seconds, between health checks of an individual instance.
 


timeout
Integer timeout

 The amount of time, in seconds, during which no response means a failed health check.
 
 
 This value must be less than the Interval value.
 


unhealthyThreshold
Integer unhealthyThreshold

 The number of consecutive health check failures required before moving the instance to the Unhealthy
 state.
 


healthyThreshold
Integer healthyThreshold

 The number of consecutive health checks successes required before moving the instance to the Healthy
 state.
 








Class com.amazonaws.services.elasticloadbalancing.model.Instance extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.elasticloadbalancing.model.InstanceState extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 


state
String state

 The current state of the instance.
 
 
 Valid values: InService | OutOfService | Unknown
 


reasonCode
String reasonCode

 Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic
 Load Balancing or the instance.
 
 
 Valid values: ELB | Instance | N/A
 


description
String description

 A description of the instance state. This string can contain one or more of the following messages.
 
 
 
 
 N/A
 
 
 
 
 A transient error occurred. Please try again later.
 
 
 
 
 Instance has failed at least the UnhealthyThreshold number of health checks consecutively.
 
 
 
 
 Instance has not passed the configured HealthyThreshold number of health checks consecutively.
 
 
 
 
 Instance registration is still in progress.
 
 
 
 
 Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.
 
 
 
 
 Instance is not currently registered with the LoadBalancer.
 
 
 
 
 Instance deregistration currently in progress.
 
 
 
 
 Disable Availability Zone is currently in progress.
 
 
 
 
 Instance is in pending state.
 
 
 
 
 Instance is in stopped state.
 
 
 
 
 Instance is in terminated state.
 
 
 








Class com.amazonaws.services.elasticloadbalancing.model.InvalidConfigurationRequestException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.InvalidInstanceException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.InvalidSchemeException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.InvalidSecurityGroupException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.InvalidSubnetException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.LBCookieStickinessPolicy extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The name of the policy. This name must be unique within the set of policies for this load balancer.
 


cookieExpirationPeriod
Long cookieExpirationPeriod

 The time period, in seconds, after which the cookie should be considered stale. If this parameter is not
 specified, the stickiness session lasts for the duration of the browser session.
 








Class com.amazonaws.services.elasticloadbalancing.model.Limit extends Object implements Serializable


Serialized Fields


name
String name

 The name of the limit. The possible values are:
 
 
 
 
 classic-listeners
 
 
 
 
 classic-load-balancers
 
 
 
 
 classic-registered-instances
 
 
 


max
String max

 The maximum value of the limit.
 








Class com.amazonaws.services.elasticloadbalancing.model.Listener extends Object implements Serializable


Serialized Fields


protocol
String protocol

 The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
 


loadBalancerPort
Integer loadBalancerPort

 The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On
 EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
 


instanceProtocol
String instanceProtocol

 The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.
 
 
 If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must be at the same
 protocol.
 
 
 If there is another listener with the same InstancePort whose InstanceProtocol is
 secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.
 
 
 If there is another listener with the same InstancePort whose InstanceProtocol is HTTP
 or TCP, the listener's InstanceProtocol must be HTTP or TCP.
 


instancePort
Integer instancePort

 The port on which the instance is listening.
 


sSLCertificateId
String sSLCertificateId

 The Amazon Resource Name (ARN) of the server certificate.
 








Class com.amazonaws.services.elasticloadbalancing.model.ListenerDescription extends Object implements Serializable


Serialized Fields


listener
Listener listener

 The listener.
 


policyNames
SdkInternalList<T> policyNames

 The policies. If there are no policies enabled, the list is empty.
 








Class com.amazonaws.services.elasticloadbalancing.model.ListenerNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerAttributeNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerAttributes extends Object implements Serializable


Serialized Fields


crossZoneLoadBalancing
CrossZoneLoadBalancing crossZoneLoadBalancing

 If enabled, the load balancer routes the request traffic evenly across all instances regardless of the
 Availability Zones.
 
 
 For more information, see Configure
 Cross-Zone Load Balancing in the Classic Load Balancers Guide.
 


accessLog
AccessLog accessLog

 If enabled, the load balancer captures detailed information of all requests and delivers the information to the
 Amazon S3 bucket that you specify.
 
 
 For more information, see Enable Access
 Logs in the Classic Load Balancers Guide.
 


connectionDraining
ConnectionDraining connectionDraining

 If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away
 from a deregistered or unhealthy instance.
 
 
 For more information, see Configure Connection
 Draining in the Classic Load Balancers 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 Classic Load Balancers Guide.
 


additionalAttributes
SdkInternalList<T> additionalAttributes

 This parameter is reserved.
 








Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerDescription extends Object implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


dNSName
String dNSName

 The DNS name of the load balancer.
 


canonicalHostedZoneName
String canonicalHostedZoneName

 The DNS name of the load balancer.
 
 
 For more information, see Configure
 a Custom Domain Name in the Classic Load Balancers Guide.
 


canonicalHostedZoneNameID
String canonicalHostedZoneNameID

 The ID of the Amazon Route 53 hosted zone for the load balancer.
 


listenerDescriptions
SdkInternalList<T> listenerDescriptions

 The listeners for the load balancer.
 


policies
Policies policies

 The policies defined for the load balancer.
 


backendServerDescriptions
SdkInternalList<T> backendServerDescriptions

 Information about your EC2 instances.
 


availabilityZones
SdkInternalList<T> availabilityZones

 The Availability Zones for the load balancer.
 


subnets
SdkInternalList<T> subnets

 The IDs of the subnets for the load balancer.
 


vPCId
String vPCId

 The ID of the VPC for the load balancer.
 


instances
SdkInternalList<T> instances

 The IDs of the instances for the load balancer.
 


healthCheck
HealthCheck healthCheck

 Information about the health checks conducted on the load balancer.
 


sourceSecurityGroup
SourceSecurityGroup sourceSecurityGroup

 The security group for the load balancer, which you can use as part of your inbound rules for your registered
 instances. To only allow traffic from load balancers, add a security group rule that specifies this source
 security group as the inbound source.
 


securityGroups
SdkInternalList<T> securityGroups

 The security groups for the load balancer. Valid only for load balancers in a VPC.
 


createdTime
Date createdTime

 The date and time the load balancer was created.
 


scheme
String scheme

 The type of load balancer. Valid only for load balancers in a VPC.
 
 
 If Scheme is internet-facing, the load balancer has a public DNS name that resolves to
 a public IP address.
 
 
 If Scheme is internal, the load balancer has a public DNS name that resolves to a
 private IP address.
 








Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.ModifyLoadBalancerAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


loadBalancerAttributes
LoadBalancerAttributes loadBalancerAttributes

 The attributes for the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.ModifyLoadBalancerAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


loadBalancerAttributes
LoadBalancerAttributes loadBalancerAttributes

 Information about the load balancer attributes.
 








Class com.amazonaws.services.elasticloadbalancing.model.OperationNotPermittedException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.Policies extends Object implements Serializable


Serialized Fields


appCookieStickinessPolicies
SdkInternalList<T> appCookieStickinessPolicies

 The stickiness policies created using CreateAppCookieStickinessPolicy.
 


lBCookieStickinessPolicies
SdkInternalList<T> lBCookieStickinessPolicies

 The stickiness policies created using CreateLBCookieStickinessPolicy.
 


otherPolicies
SdkInternalList<T> otherPolicies

 The policies other than the stickiness policies.
 








Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttribute extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 The name of the attribute.
 


attributeValue
String attributeValue

 The value of the attribute.
 








Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttributeDescription extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 The name of the attribute.
 


attributeValue
String attributeValue

 The value of the attribute.
 








Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttributeTypeDescription extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 The name of the attribute.
 


attributeType
String attributeType

 The type of the attribute. For example, Boolean or Integer.
 


description
String description

 A description of the attribute.
 


defaultValue
String defaultValue

 The default value of the attribute, if applicable.
 


cardinality
String cardinality

 The cardinality of the attribute.
 
 
 Valid values:
 
 
 
 
 ONE(1) : Single value required
 
 
 
 
 ZERO_OR_ONE(0..1) : Up to one value is allowed
 
 
 
 
 ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed
 
 
 
 
 ONE_OR_MORE(1..*0) : Required. Multiple values are allowed
 
 
 








Class com.amazonaws.services.elasticloadbalancing.model.PolicyDescription extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The name of the policy.
 


policyTypeName
String policyTypeName

 The name of the policy type.
 


policyAttributeDescriptions
SdkInternalList<T> policyAttributeDescriptions

 The policy attributes.
 








Class com.amazonaws.services.elasticloadbalancing.model.PolicyNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.PolicyTypeDescription extends Object implements Serializable


Serialized Fields


policyTypeName
String policyTypeName

 The name of the policy type.
 


description
String description

 A description of the policy type.
 


policyAttributeTypeDescriptions
SdkInternalList<T> policyAttributeTypeDescriptions

 The description of the policy attributes associated with the policies defined by Elastic Load Balancing.
 








Class com.amazonaws.services.elasticloadbalancing.model.PolicyTypeNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.RegisterInstancesWithLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


instances
SdkInternalList<T> instances

 The IDs of the instances.
 








Class com.amazonaws.services.elasticloadbalancing.model.RegisterInstancesWithLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instances
SdkInternalList<T> instances

 The updated list of instances for the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerNames
SdkInternalList<T> loadBalancerNames

 The name of the load balancer. You can specify a maximum of one load balancer name.
 


tags
SdkInternalList<T> tags

 The list of tag keys to remove.
 








Class com.amazonaws.services.elasticloadbalancing.model.RemoveTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerListenerSSLCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


loadBalancerPort
Integer loadBalancerPort

 The port that uses the specified SSL certificate.
 


sSLCertificateId
String sSLCertificateId

 The Amazon Resource Name (ARN) of the SSL certificate.
 








Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerListenerSSLCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesForBackendServerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


instancePort
Integer instancePort

 The port number associated with the EC2 instance.
 


policyNames
SdkInternalList<T> policyNames

 The names of the policies. If the list is empty, then all current polices are removed from the EC2 instance.
 








Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesForBackendServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesOfListenerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


loadBalancerPort
Integer loadBalancerPort

 The external port of the load balancer.
 


policyNames
SdkInternalList<T> policyNames

 The names of the policies. This list must include all policies to be enabled. If you omit a policy that is
 currently enabled, it is disabled. If the list is empty, all current policies are disabled.
 








Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesOfListenerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.SourceSecurityGroup extends Object implements Serializable


Serialized Fields


ownerAlias
String ownerAlias

 The owner of the security group.
 


groupName
String groupName

 The name of the security group.
 








Class com.amazonaws.services.elasticloadbalancing.model.SubnetNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key of the tag.
 


value
String value

 The value of the tag.
 








Class com.amazonaws.services.elasticloadbalancing.model.TagDescription extends Object implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


tags
SdkInternalList<T> tags

 The tags.
 








Class com.amazonaws.services.elasticloadbalancing.model.TagKeyOnly extends Object implements Serializable


Serialized Fields


key
String key

 The name of the key.
 








Class com.amazonaws.services.elasticloadbalancing.model.TooManyLoadBalancersException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.TooManyPoliciesException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.TooManyTagsException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.UnsupportedProtocolException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.elasticloadbalancingv2.model




Class com.amazonaws.services.elasticloadbalancingv2.model.Action extends Object implements Serializable


Serialized Fields


type
String type

 The type of action.
 


targetGroupArn
String targetGroupArn

 The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward
 and you want to route to a single target group. To route to one or more target groups, use
 ForwardConfig instead.
 


authenticateOidcConfig
AuthenticateOidcActionConfig authenticateOidcConfig

 [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify
 only when Type is authenticate-oidc.
 


authenticateCognitoConfig
AuthenticateCognitoActionConfig authenticateCognitoConfig

 [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type
 is authenticate-cognito.
 


order
Integer order

 The order for the action. This value is required for rules with multiple actions. The action with the lowest
 value for order is performed first. The last action to be performed must be one of the following types of
 actions: a forward, fixed-response, or redirect.
 


redirectConfig
RedirectActionConfig redirectConfig

 [Application Load Balancer] Information for creating a redirect action. Specify only when Type is
 redirect.
 


fixedResponseConfig
FixedResponseActionConfig fixedResponseConfig

 [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only
 when Type is fixed-response.
 


forwardConfig
ForwardActionConfig forwardConfig

 Information for creating an action that distributes requests among one or more target groups. For Network Load
 Balancers, you can specify a single target group. Specify only when Type is forward. If
 you specify both ForwardConfig and TargetGroupArn, you can specify only one target
 group using ForwardConfig and it must be the same target group specified in
 TargetGroupArn.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.AddListenerCertificatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener.
 


certificates
List<E> certificates

 The certificate to add. You can specify one certificate per call. Set CertificateArn to the
 certificate ARN but do not set IsDefault.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.AddListenerCertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificates
List<E> certificates

 Information about the certificates in the certificate list.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArns
List<E> resourceArns

 The Amazon Resource Name (ARN) of the resource.
 


tags
List<E> tags

 The tags. Each resource can have a maximum of 10 tags.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.AddTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancingv2.model.AllocationIdNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.AmazonElasticLoadBalancingException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.AuthenticateCognitoActionConfig extends Object implements Serializable


Serialized Fields


userPoolArn
String userPoolArn

 The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
 


userPoolClientId
String userPoolClientId

 The ID of the Amazon Cognito user pool client.
 


userPoolDomain
String userPoolDomain

 The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.
 


sessionCookieName
String sessionCookieName

 The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
 


scope
String scope

 The set of user claims to be requested from the IdP. The default is openid.
 
 
 To verify which scope values your IdP supports and how to separate multiple values, see the documentation for
 your IdP.
 


sessionTimeout
Long sessionTimeout

 The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
 


authenticationRequestExtraParams
Map<K,V> authenticationRequestExtraParams

 The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
 


onUnauthenticatedRequest
String onUnauthenticatedRequest

 The behavior if the user is not authenticated. The following are possible values:
 
 
 
 
 deny - Return an HTTP 401 Unauthorized error.
 

 

 
 
 allow - Allow the request to be forwarded to the target.
 

 

 
 
 authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.
 

 

 









Class com.amazonaws.services.elasticloadbalancingv2.model.AuthenticateOidcActionConfig extends Object implements Serializable


Serialized Fields


issuer
String issuer

 The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the
 path.
 


authorizationEndpoint
String authorizationEndpoint

 The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the
 path.
 


tokenEndpoint
String tokenEndpoint

 The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
 


userInfoEndpoint
String userInfoEndpoint

 The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the
 path.
 


clientId
String clientId

 The OAuth 2.0 client identifier.
 


clientSecret
String clientSecret

 The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule,
 you can omit this parameter if you set UseExistingClientSecret to true.
 


sessionCookieName
String sessionCookieName

 The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
 


scope
String scope

 The set of user claims to be requested from the IdP. The default is openid.
 
 
 To verify which scope values your IdP supports and how to separate multiple values, see the documentation for
 your IdP.
 


sessionTimeout
Long sessionTimeout

 The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
 


authenticationRequestExtraParams
Map<K,V> authenticationRequestExtraParams

 The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
 


onUnauthenticatedRequest
String onUnauthenticatedRequest

 The behavior if the user is not authenticated. The following are possible values:
 
 
 
 
 deny - Return an HTTP 401 Unauthorized error.
 

 

 
 
 allow - Allow the request to be forwarded to the target.
 

 

 
 
 authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.
 

 

 



useExistingClientSecret
Boolean useExistingClientSecret

 Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can
 omit this parameter or set it to false.
 








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


Serialized Fields


zoneName
String zoneName

 The name of the Availability Zone.
 


subnetId
String subnetId

 The ID of the subnet. You can specify one subnet per Availability Zone.
 


loadBalancerAddresses
List<E> loadBalancerAddresses

 [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP
 address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you
 can specify a private IP address from the IPv4 range of the subnet.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.AvailabilityZoneNotSupportedException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.Certificate extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) of the certificate.
 


isDefault
Boolean isDefault

 Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate
 as an input. This value is not included in the output when describing a listener, but is included when describing
 listener certificates.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.CertificateNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.Cipher extends Object implements Serializable


Serialized Fields


name
String name

 The name of the cipher.
 


priority
Integer priority

 The priority of the cipher.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.CreateListenerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerArn
String loadBalancerArn

 The Amazon Resource Name (ARN) of the load balancer.
 


protocol
String protocol

 The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported
 protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP.
 


port
Integer port

 The port on which the load balancer is listening.
 


sslPolicy
String sslPolicy

 [HTTPS and TLS listeners] The security policy that defines which ciphers and protocols are supported. The default
 is the current predefined security policy.
 


certificates
List<E> certificates

 [HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set
 CertificateArn to the certificate ARN but do not set IsDefault.
 
 
 To create a certificate list for the listener, use AddListenerCertificates.
 


defaultActions
List<E> defaultActions

 The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.
 
 
 If the action type is forward, you specify one or more target groups. The protocol of the target
 group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS,
 UDP, or TCP_UDP for a Network Load Balancer.
 
 
 [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
 identity provider that is OpenID Connect (OIDC) compliant.
 
 
 [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the
 user pools supported by Amazon Cognito.
 
 
 [Application Load Balancer] If the action type is redirect, you redirect specified client requests
 from one URL to another.
 
 
 [Application Load Balancer] If the action type is fixed-response, you drop specified client requests
 and return a custom HTTP response.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.CreateListenerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


listeners
List<E> listeners

 Information about the listener.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.CreateLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the load balancer.
 
 
 This name must be unique per region per account, can have a maximum of 32 characters, must contain only
 alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with "internal-".
 


subnets
List<E> subnets

 The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either
 subnets or subnet mappings.
 
 
 [Application Load Balancers] You must specify subnets from at least two Availability Zones.
 
 
 [Network Load Balancers] You can specify subnets from one or more Availability Zones.
 


subnetMappings
List<E> subnetMappings

 The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either
 subnets or subnet mappings.
 
 
 [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify
 Elastic IP addresses for your subnets.
 
 
 [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic
 IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load
 balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet.
 


securityGroups
List<E> securityGroups

 [Application Load Balancers] The IDs of the security groups for the load balancer.
 


scheme
String scheme

 The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load
 balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load
 balancers can route requests from clients over the internet.
 
 
 The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer
 is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route
 requests only from clients with access to the VPC for the load balancer.
 
 
 The default is an Internet-facing load balancer.
 


tags
List<E> tags

 One or more tags to assign to the load balancer.
 


type
String type

 The type of load balancer. The default is application.
 


ipAddressType
String ipAddressType

 [Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible
 values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
 Internal load balancers must use ipv4.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.CreateLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loadBalancers
List<E> loadBalancers

 Information about the load balancer.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.CreateRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener.
 


conditions
List<E> conditions

 The conditions. Each rule can include zero or one of the following conditions: http-request-method,
 host-header, path-pattern, and source-ip, and zero or more of the
 following conditions: http-header and query-string.
 


priority
Integer priority

 The rule priority. A listener can't have multiple rules with the same priority.
 


actions
List<E> actions

 The actions. Each rule must include exactly one of the following types of actions: forward,
 fixed-response, or redirect, and it must be the last action to be performed.
 
 
 If the action type is forward, you specify one or more target groups. The protocol of the target
 group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS,
 UDP, or TCP_UDP for a Network Load Balancer.
 
 
 [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
 identity provider that is OpenID Connect (OIDC) compliant.
 
 
 [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the
 user pools supported by Amazon Cognito.
 
 
 [Application Load Balancer] If the action type is redirect, you redirect specified client requests
 from one URL to another.
 
 
 [Application Load Balancer] If the action type is fixed-response, you drop specified client requests
 and return a custom HTTP response.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.CreateRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rules
List<E> rules

 Information about the rule.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.CreateTargetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the target group.
 
 
 This name must be unique per region per account, can have a maximum of 32 characters, must contain only
 alphanumeric characters or hyphens, and must not begin or end with a hyphen.
 


protocol
String protocol

 The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols
 are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. A TCP_UDP
 listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does
 not apply.
 


port
Integer port

 The port on which the targets receive traffic. This port is used unless you specify a port override when
 registering the target. If the target is a Lambda function, this parameter does not apply.
 


vpcId
String vpcId

 The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not
 apply. Otherwise, this parameter is required.
 


healthCheckProtocol
String healthCheckProtocol

 The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the
 default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks
 only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are
 not supported for health checks.
 


healthCheckPort
String healthCheckPort

 The port the load balancer uses when performing health checks on targets. The default is
 traffic-port, which is the port on which each target receives traffic from the load balancer.
 


healthCheckEnabled
Boolean healthCheckEnabled

 Indicates whether health checks are enabled. If the target type is lambda, health checks are
 disabled by default but can be enabled. If the target type is instance or ip, health
 checks are always enabled and cannot be disabled.
 


healthCheckPath
String healthCheckPath

 [HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is
 /.
 


healthCheckIntervalSeconds
Integer healthCheckIntervalSeconds

 The approximate amount of time, in seconds, between health checks of an individual target. For HTTP and HTTPS
 health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If
 the target type is instance or ip, the default is 30 seconds. If the target type is
 lambda, the default is 35 seconds.
 


healthCheckTimeoutSeconds
Integer healthCheckTimeoutSeconds

 The amount of time, in seconds, during which no response from a target means a failed health check. For target
 groups with a protocol of HTTP or HTTPS, the default is 5 seconds. For target groups with a protocol of TCP or
 TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the
 target type is lambda, the default is 30 seconds.
 


healthyThresholdCount
Integer healthyThresholdCount

 The number of consecutive health checks successes required before considering an unhealthy target healthy. For
 target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP or
 TLS, the default is 3. If the target type is lambda, the default is 5.
 


unhealthyThresholdCount
Integer unhealthyThresholdCount

 The number of consecutive health check failures required before considering a target unhealthy. For target groups
 with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value
 must be the same as the healthy threshold count. If the target type is lambda, the default is 2.
 


matcher
Matcher matcher

 [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
 


targetType
String targetType

 The type of target that you must specify when registering targets with this target group. You can't specify
 targets for a target group using more than one target type.
 
 
 
 
 instance - Targets are specified by instance ID. This is the default value. If the target group
 protocol is UDP or TCP_UDP, the target type must be instance.
 
 
 
 
 ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the
 virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and
 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
 
 
 
 
 lambda - The target groups contains a single Lambda function.
 
 
 








Class com.amazonaws.services.elasticloadbalancingv2.model.CreateTargetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


targetGroups
List<E> targetGroups

 Information about the target group.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DeleteListenerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DeleteListenerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancingv2.model.DeleteLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerArn
String loadBalancerArn

 The Amazon Resource Name (ARN) of the load balancer.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DeleteLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancingv2.model.DeleteRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleArn
String ruleArn

 The Amazon Resource Name (ARN) of the rule.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DeleteRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancingv2.model.DeleteTargetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetGroupArn
String targetGroupArn

 The Amazon Resource Name (ARN) of the target group.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DeleteTargetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancingv2.model.DeregisterTargetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetGroupArn
String targetGroupArn

 The Amazon Resource Name (ARN) of the target group.
 


targets
List<E> targets

 The targets. If you specified a port override when you registered a target, you must specify both the target ID
 and the port when you deregister it.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DeregisterTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeAccountLimitsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeAccountLimitsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


limits
List<E> limits

 Information about the limits.
 


nextMarker
String nextMarker

 If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeListenerCertificatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Names (ARN) of the listener.
 


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.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeListenerCertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificates
List<E> certificates

 Information about the certificates.
 


nextMarker
String nextMarker

 If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeListenersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerArn
String loadBalancerArn

 The Amazon Resource Name (ARN) of the load balancer.
 


listenerArns
List<E> listenerArns

 The Amazon Resource Names (ARN) of the listeners.
 


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.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeListenersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


listeners
List<E> listeners

 Information about the listeners.
 


nextMarker
String nextMarker

 If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeLoadBalancerAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerArn
String loadBalancerArn

 The Amazon Resource Name (ARN) of the load balancer.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeLoadBalancerAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
List<E> attributes

 Information about the load balancer attributes.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerArns
List<E> loadBalancerArns

 The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.
 


names
List<E> names

 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.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeLoadBalancersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loadBalancers
List<E> loadBalancers

 Information about the load balancers.
 


nextMarker
String nextMarker

 If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener.
 


ruleArns
List<E> ruleArns

 The Amazon Resource Names (ARN) of the rules.
 


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.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rules
List<E> rules

 Information about the rules.
 


nextMarker
String nextMarker

 If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeSSLPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


names
List<E> names

 The names of the policies.
 


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.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeSSLPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sslPolicies
List<E> sslPolicies

 Information about the policies.
 


nextMarker
String nextMarker

 If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArns
List<E> resourceArns

 The Amazon Resource Names (ARN) of the resources.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagDescriptions
List<E> tagDescriptions

 Information about the tags.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeTargetGroupAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetGroupArn
String targetGroupArn

 The Amazon Resource Name (ARN) of the target group.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeTargetGroupAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
List<E> attributes

 Information about the target group attributes
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeTargetGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerArn
String loadBalancerArn

 The Amazon Resource Name (ARN) of the load balancer.
 


targetGroupArns
List<E> targetGroupArns

 The Amazon Resource Names (ARN) of the target groups.
 


names
List<E> names

 The names of the target groups.
 


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.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeTargetGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


targetGroups
List<E> targetGroups

 Information about the target groups.
 


nextMarker
String nextMarker

 If there are additional results, this is the marker for the next set of results. Otherwise, this is null.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeTargetHealthRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetGroupArn
String targetGroupArn

 The Amazon Resource Name (ARN) of the target group.
 


targets
List<E> targets

 The targets.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DescribeTargetHealthResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


targetHealthDescriptions
List<E> targetHealthDescriptions

 Information about the health of the targets.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.DuplicateListenerException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.DuplicateLoadBalancerNameException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.DuplicateTagKeysException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.DuplicateTargetGroupNameException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.FixedResponseActionConfig extends Object implements Serializable


Serialized Fields


messageBody
String messageBody

 The message.
 


statusCode
String statusCode

 The HTTP response code (2XX, 4XX, or 5XX).
 


contentType
String contentType

 The content type.
 
 
 Valid Values: text/plain | text/css | text/html | application/javascript | application/json
 








Class com.amazonaws.services.elasticloadbalancingv2.model.ForwardActionConfig extends Object implements Serializable


Serialized Fields


targetGroups
List<E> targetGroups

 One or more target groups. For Network Load Balancers, you can specify a single target group.
 


targetGroupStickinessConfig
TargetGroupStickinessConfig targetGroupStickinessConfig

 The target group stickiness for the rule.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.HealthUnavailableException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.HostHeaderConditionConfig extends Object implements Serializable


Serialized Fields


values
List<E> values

 One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The
 following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1
 character).
 
 
 If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.HttpHeaderConditionConfig extends Object implements Serializable


Serialized Fields


httpHeaderName
String httpHeaderName

 The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The
 allowed characters are specified by RFC 7230. Wildcards are not supported.
 
 
 You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to
 specify a host header condition.
 


values
List<E> values

 One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128
 characters. The comparison strings are case insensitive. The following wildcard characters are supported: *
 (matches 0 or more characters) and ? (matches exactly 1 character).
 
 
 If the same header appears multiple times in the request, we search them in order until a match is found.
 
 
 If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP
 header. To require that all of the strings are a match, create one condition per string.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.HttpRequestMethodConditionConfig extends Object implements Serializable


Serialized Fields


values
List<E> values

 The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-),
 and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name
 must be an exact match.
 
 
 If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request
 method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request
 may be cached.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.IncompatibleProtocolsException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.InvalidConfigurationRequestException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.InvalidLoadBalancerActionException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.InvalidSchemeException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.InvalidSecurityGroupException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.InvalidSubnetException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.InvalidTargetException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.Limit extends Object implements Serializable


Serialized Fields


name
String name

 The name of the limit. The possible values are:
 
 
 
 
 application-load-balancers
 
 
 
 
 listeners-per-application-load-balancer
 
 
 
 
 listeners-per-network-load-balancer
 
 
 
 
 network-load-balancers
 
 
 
 
 rules-per-application-load-balancer
 
 
 
 
 target-groups
 
 
 
 
 target-groups-per-action-on-application-load-balancer
 
 
 
 
 target-groups-per-action-on-network-load-balancer
 
 
 
 
 target-groups-per-application-load-balancer
 
 
 
 
 targets-per-application-load-balancer
 
 
 
 
 targets-per-availability-zone-per-network-load-balancer
 
 
 
 
 targets-per-network-load-balancer
 
 
 


max
String max

 The maximum value of the limit.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.Listener extends Object implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener.
 


loadBalancerArn
String loadBalancerArn

 The Amazon Resource Name (ARN) of the load balancer.
 


port
Integer port

 The port on which the load balancer is listening.
 


protocol
String protocol

 The protocol for connections from clients to the load balancer.
 


certificates
List<E> certificates

 [HTTPS or TLS listener] The default certificate for the listener.
 


sslPolicy
String sslPolicy

 [HTTPS or TLS listener] The security policy that defines which ciphers and protocols are supported. The default
 is the current predefined security policy.
 


defaultActions
List<E> defaultActions

 The default actions for the listener.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.ListenerNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


loadBalancerArn
String loadBalancerArn

 The Amazon Resource Name (ARN) of the load balancer.
 


dNSName
String dNSName

 The public DNS name of the load balancer.
 


canonicalHostedZoneId
String canonicalHostedZoneId

 The ID of the Amazon Route 53 hosted zone associated with the load balancer.
 


createdTime
Date createdTime

 The date and time the load balancer was created.
 


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


scheme
String scheme

 The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load
 balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load
 balancers can route requests from clients over the internet.
 
 
 The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer
 is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route
 requests only from clients with access to the VPC for the load balancer.
 


vpcId
String vpcId

 The ID of the VPC for the load balancer.
 


state
LoadBalancerState state

 The state of the load balancer.
 


type
String type

 The type of load balancer.
 


availabilityZones
List<E> availabilityZones

 The Availability Zones for the load balancer.
 


securityGroups
List<E> securityGroups

 The IDs of the security groups for the load balancer.
 


ipAddressType
String ipAddressType

 The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4
 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
 








Class com.amazonaws.services.elasticloadbalancingv2.model.LoadBalancerAddress extends Object implements Serializable


Serialized Fields


ipAddress
String ipAddress

 The static IP address.
 


allocationId
String allocationId

 [Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.
 


privateIPv4Address
String privateIPv4Address

 [Network Load Balancers] The private IPv4 address for an internal load balancer.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.LoadBalancerAttribute extends Object implements Serializable


Serialized Fields


key
String key

 The name of the attribute.
 
 
 The following attributes are supported by both Application Load Balancers and Network Load Balancers:
 
 
 
 
 access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true
 or false. The default is false.
 
 
 
 
 access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if
 access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy
 that grants Elastic Load Balancing permissions to write to the bucket.
 
 
 
 
 access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs.
 
 
 
 
 deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is
 true or false. The default is false.
 
 
 
 
 The following attributes are supported by only Application Load Balancers:
 
 
 
 
 idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000
 seconds. The default is 60 seconds.
 
 
 
 
 routing.http.drop_invalid_header_fields.enabled - Indicates whether HTTP headers with invalid header
 fields are removed by the load balancer (true) or routed to targets (false). The
 default is false.
 
 
 
 
 routing.http2.enabled - Indicates whether HTTP/2 is enabled. The value is true or
 false. The default is true.
 
 
 
 
 The following attributes are supported by only Network Load Balancers:
 
 
 
 
 load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The
 value is true or false. The default is false.
 
 
 


value
String value

 The value of the attribute.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.LoadBalancerNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.LoadBalancerState extends Object implements Serializable


Serialized Fields


code
String code

 The state code. The initial state of the load balancer is provisioning. After the load balancer is
 fully set up and ready to route traffic, its state is active. If the load balancer could not be set
 up, its state is failed.
 


reason
String reason

 A description of the state.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.Matcher extends Object implements Serializable


Serialized Fields


httpCode
String httpCode

 The HTTP codes.
 
 
 For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can
 specify multiple values (for example, "200,202") or a range of values (for example, "200-299").
 
 
 For Network Load Balancers, this is 200–399.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.ModifyListenerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener.
 


port
Integer port

 The port for connections from clients to the load balancer.
 


protocol
String protocol

 The protocol for connections from clients to the load balancer. Application Load Balancers support the HTTP and
 HTTPS protocols. Network Load Balancers support the TCP, TLS, UDP, and TCP_UDP protocols.
 


sslPolicy
String sslPolicy

 [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more
 information, see Security Policies in the Application Load Balancers Guide.
 


certificates
List<E> certificates

 [HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set
 CertificateArn to the certificate ARN but do not set IsDefault.
 
 
 To create a certificate list, use AddListenerCertificates.
 


defaultActions
List<E> defaultActions

 The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.
 
 
 If the action type is forward, you specify one or more target groups. The protocol of the target
 group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS,
 UDP, or TCP_UDP for a Network Load Balancer.
 
 
 [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
 identity provider that is OpenID Connect (OIDC) compliant.
 
 
 [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the
 user pools supported by Amazon Cognito.
 
 
 [Application Load Balancer] If the action type is redirect, you redirect specified client requests
 from one URL to another.
 
 
 [Application Load Balancer] If the action type is fixed-response, you drop specified client requests
 and return a custom HTTP response.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.ModifyListenerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


listeners
List<E> listeners

 Information about the modified listener.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.ModifyLoadBalancerAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerArn
String loadBalancerArn

 The Amazon Resource Name (ARN) of the load balancer.
 


attributes
List<E> attributes

 The load balancer attributes.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.ModifyLoadBalancerAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
List<E> attributes

 Information about the load balancer attributes.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.ModifyRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleArn
String ruleArn

 The Amazon Resource Name (ARN) of the rule.
 


conditions
List<E> conditions

 The conditions. Each rule can include zero or one of the following conditions: http-request-method,
 host-header, path-pattern, and source-ip, and zero or more of the
 following conditions: http-header and query-string.
 


actions
List<E> actions

 The actions. Each rule must include exactly one of the following types of actions: forward,
 fixed-response, or redirect, and it must be the last action to be performed.
 
 
 If the action type is forward, you specify one or more target groups. The protocol of the target
 group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS,
 UDP, or TCP_UDP for a Network Load Balancer.
 
 
 [HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an
 identity provider that is OpenID Connect (OIDC) compliant.
 
 
 [HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the
 user pools supported by Amazon Cognito.
 
 
 [Application Load Balancer] If the action type is redirect, you redirect specified client requests
 from one URL to another.
 
 
 [Application Load Balancer] If the action type is fixed-response, you drop specified client requests
 and return a custom HTTP response.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.ModifyRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rules
List<E> rules

 Information about the modified rule.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.ModifyTargetGroupAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetGroupArn
String targetGroupArn

 The Amazon Resource Name (ARN) of the target group.
 


attributes
List<E> attributes

 The attributes.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.ModifyTargetGroupAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
List<E> attributes

 Information about the attributes.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.ModifyTargetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetGroupArn
String targetGroupArn

 The Amazon Resource Name (ARN) of the target group.
 


healthCheckProtocol
String healthCheckProtocol

 The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported for
 health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP
 protocols are not supported for health checks.
 
 
 With Network Load Balancers, you can't modify this setting.
 


healthCheckPort
String healthCheckPort

 The port the load balancer uses when performing health checks on targets.
 


healthCheckPath
String healthCheckPath

 [HTTP/HTTPS health checks] The ping path that is the destination for the health check request.
 


healthCheckEnabled
Boolean healthCheckEnabled

 Indicates whether health checks are enabled.
 


healthCheckIntervalSeconds
Integer healthCheckIntervalSeconds

 The approximate amount of time, in seconds, between health checks of an individual target. For Application Load
 Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds.
 
 
 With Network Load Balancers, you can't modify this setting.
 


healthCheckTimeoutSeconds
Integer healthCheckTimeoutSeconds

 [HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.
 
 
 With Network Load Balancers, you can't modify this setting.
 


healthyThresholdCount
Integer healthyThresholdCount

 The number of consecutive health checks successes required before considering an unhealthy target healthy.
 


unhealthyThresholdCount
Integer unhealthyThresholdCount

 The number of consecutive health check failures required before considering the target unhealthy. For Network
 Load Balancers, this value must be the same as the healthy threshold count.
 


matcher
Matcher matcher

 [HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.
 
 
 With Network Load Balancers, you can't modify this setting.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.ModifyTargetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


targetGroups
List<E> targetGroups

 Information about the modified target group.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.OperationNotPermittedException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.PathPatternConditionConfig extends Object implements Serializable


Serialized Fields


values
List<E> values

 One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters.
 The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more
 characters) and ? (matches exactly 1 character).
 
 
 If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path
 pattern is compared only to the path of the URL, not to its query string. To compare against the query string,
 use QueryStringConditionConfig.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.PriorityInUseException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.QueryStringConditionConfig extends Object implements Serializable


Serialized Fields


values
List<E> values

 One or more key/value pairs or values to find in the query string. The maximum size of each string is 128
 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or
 more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query
 string, you must escape these characters in Values using a '\' character.
 
 
 If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the
 query string.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.QueryStringKeyValuePair extends Object implements Serializable


Serialized Fields


key
String key

 The key. You can omit the key.
 


value
String value

 The value.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.RedirectActionConfig extends Object implements Serializable


Serialized Fields


protocol
String protocol

 The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and
 HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
 


port
String port

 The port. You can specify a value from 1 to 65535 or #{port}.
 


host
String host

 The hostname. This component is not percent-encoded. The hostname can contain #{host}.
 


path
String path

 The absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain
 #{host}, #{path}, and #{port}.
 


query
String query

 The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading "?", as it
 is automatically added. You can specify any of the reserved keywords.
 


statusCode
String statusCode

 The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
 








Class com.amazonaws.services.elasticloadbalancingv2.model.RegisterTargetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetGroupArn
String targetGroupArn

 The Amazon Resource Name (ARN) of the target group.
 


targets
List<E> targets

 The targets.
 
 
 To register a target by instance ID, specify the instance ID. To register a target by IP address, specify the IP
 address. To register a Lambda function, specify the ARN of the Lambda function.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.RegisterTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancingv2.model.RemoveListenerCertificatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener.
 


certificates
List<E> certificates

 The certificate to remove. You can specify one certificate per call. Set CertificateArn to the
 certificate ARN but do not set IsDefault.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.RemoveListenerCertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancingv2.model.RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArns
List<E> resourceArns

 The Amazon Resource Name (ARN) of the resource.
 


tagKeys
List<E> tagKeys

 The tag keys for the tags to remove.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.RemoveTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticloadbalancingv2.model.ResourceInUseException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.Rule extends Object implements Serializable


Serialized Fields


ruleArn
String ruleArn

 The Amazon Resource Name (ARN) of the rule.
 


priority
String priority

 The priority.
 


conditions
List<E> conditions

 The conditions. Each rule can include zero or one of the following conditions: http-request-method,
 host-header, path-pattern, and source-ip, and zero or more of the
 following conditions: http-header and query-string.
 


actions
List<E> actions

 The actions. Each rule must include exactly one of the following types of actions: forward,
 redirect, or fixed-response, and it must be the last action to be performed.
 


isDefault
Boolean isDefault

 Indicates whether this is the default rule.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.RuleCondition extends Object implements Serializable


Serialized Fields


field
String field

 The field in the HTTP request. The following are the possible values:
 
 
 
 
 http-header
 
 
 
 
 http-request-method
 
 
 
 
 host-header
 
 
 
 
 path-pattern
 
 
 
 
 query-string
 
 
 
 
 source-ip
 
 
 


values
List<E> values

 The condition value. You can use Values if the rule contains only host-header and
 path-pattern conditions. Otherwise, you can use HostHeaderConfig for
 host-header conditions and PathPatternConfig for path-pattern conditions.
 
 
 If Field is host-header, you can specify a single host name (for example,
 my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of
 the following characters.
 
 
 
 
 A-Z, a-z, 0-9
 
 
 
 
 - .
 
 
 
 
 * (matches 0 or more characters)
 
 
 
 
 ? (matches exactly 1 character)
 
 
 
 
 If Field is path-pattern, you can specify a single path pattern (for example, /img/*).
 A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following
 characters.
 
 
 
 
 A-Z, a-z, 0-9
 
 
 
 
 _ - . $ / ~ " ' @ : +
 
 
 
 
 & (using &amp;)
 
 
 
 
 * (matches 0 or more characters)
 
 
 
 
 ? (matches exactly 1 character)
 
 
 


hostHeaderConfig
HostHeaderConditionConfig hostHeaderConfig

 Information for a host header condition. Specify only when Field is host-header.
 


pathPatternConfig
PathPatternConditionConfig pathPatternConfig

 Information for a path pattern condition. Specify only when Field is path-pattern.
 


httpHeaderConfig
HttpHeaderConditionConfig httpHeaderConfig

 Information for an HTTP header condition. Specify only when Field is http-header.
 


queryStringConfig
QueryStringConditionConfig queryStringConfig

 Information for a query string condition. Specify only when Field is query-string.
 


httpRequestMethodConfig
HttpRequestMethodConditionConfig httpRequestMethodConfig

 Information for an HTTP method condition. Specify only when Field is
 http-request-method.
 


sourceIpConfig
SourceIpConditionConfig sourceIpConfig

 Information for a source IP condition. Specify only when Field is source-ip.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.RuleNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.RulePriorityPair extends Object implements Serializable


Serialized Fields


ruleArn
String ruleArn

 The Amazon Resource Name (ARN) of the rule.
 


priority
Integer priority

 The rule priority.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.SetIpAddressTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerArn
String loadBalancerArn

 The Amazon Resource Name (ARN) of the load balancer.
 


ipAddressType
String ipAddressType

 The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack
 (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4. Network Load Balancers must
 use ipv4.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.SetIpAddressTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ipAddressType
String ipAddressType

 The IP address type.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.SetRulePrioritiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rulePriorities
List<E> rulePriorities

 The rule priorities.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.SetRulePrioritiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rules
List<E> rules

 Information about the rules.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.SetSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerArn
String loadBalancerArn

 The Amazon Resource Name (ARN) of the load balancer.
 


securityGroups
List<E> securityGroups

 The IDs of the security groups.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.SetSecurityGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityGroupIds
List<E> securityGroupIds

 The IDs of the security groups associated with the load balancer.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.SetSubnetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerArn
String loadBalancerArn

 The Amazon Resource Name (ARN) of the load balancer.
 


subnets
List<E> subnets

 The IDs of the public subnets. You must specify subnets from at least two Availability Zones. You can specify
 only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
 


subnetMappings
List<E> subnetMappings

 The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either
 subnets or subnet mappings.
 
 
 [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify
 Elastic IP addresses for your subnets.
 
 
 [Network Load Balancers] You can specify subnets from one or more Availability Zones. If you need static IP
 addresses for your internet-facing load balancer, you can specify one Elastic IP address per subnet. For internal
 load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.SetSubnetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


availabilityZones
List<E> availabilityZones

 Information about the subnet and Availability Zone.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.SourceIpConditionConfig extends Object implements Serializable


Serialized Fields


values
List<E> values

 One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not
 supported.
 
 
 If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one
 of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for
 addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.SslPolicy extends Object implements Serializable


Serialized Fields


sslProtocols
List<E> sslProtocols

 The protocols.
 


ciphers
List<E> ciphers

 The ciphers.
 


name
String name

 The name of the policy.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.SSLPolicyNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.SubnetMapping extends Object implements Serializable


Serialized Fields


subnetId
String subnetId

 The ID of the subnet.
 


allocationId
String allocationId

 [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
 


privateIPv4Address
String privateIPv4Address

 [Network Load Balancers] The private IPv4 address for an internal load balancer.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.SubnetNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key of the tag.
 


value
String value

 The value of the tag.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.TagDescription extends Object implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 


tags
List<E> tags

 Information about the tags.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.TargetDescription extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the target. If the target type of the target group is instance, specify an instance ID. If
 the target type is ip, specify an IP address. If the target type is lambda, specify the
 ARN of the Lambda function.
 


port
Integer port

 The port on which the target is listening. Not used if the target is a Lambda function.
 


availabilityZone
String availabilityZone

 An Availability Zone or all. This determines whether the target receives traffic from the load
 balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
 
 
 This parameter is not supported if the target type of the target group is instance.
 
 
 If the target type is ip and the IP address is in a subnet of the VPC for the target group, the
 Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC,
 this parameter is required.
 
 
 With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC
 for the target group, the only supported value is all.
 
 
 If the target type is lambda, this parameter is optional and the only supported value is
 all.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.TargetGroup extends Object implements Serializable


Serialized Fields


targetGroupArn
String targetGroupArn

 The Amazon Resource Name (ARN) of the target group.
 


targetGroupName
String targetGroupName

 The name of the target group.
 


protocol
String protocol

 The protocol to use for routing traffic to the targets.
 


port
Integer port

 The port on which the targets are listening. Not used if the target is a Lambda function.
 


vpcId
String vpcId

 The ID of the VPC for the targets.
 


healthCheckProtocol
String healthCheckProtocol

 The protocol to use to connect with the target.
 


healthCheckPort
String healthCheckPort

 The port to use to connect with the target.
 


healthCheckEnabled
Boolean healthCheckEnabled

 Indicates whether health checks are enabled.
 


healthCheckIntervalSeconds
Integer healthCheckIntervalSeconds

 The approximate amount of time, in seconds, between health checks of an individual target.
 


healthCheckTimeoutSeconds
Integer healthCheckTimeoutSeconds

 The amount of time, in seconds, during which no response means a failed health check.
 


healthyThresholdCount
Integer healthyThresholdCount

 The number of consecutive health checks successes required before considering an unhealthy target healthy.
 


unhealthyThresholdCount
Integer unhealthyThresholdCount

 The number of consecutive health check failures required before considering the target unhealthy.
 


healthCheckPath
String healthCheckPath

 The destination for the health check request.
 


matcher
Matcher matcher

 The HTTP codes to use when checking for a successful response from a target.
 


loadBalancerArns
List<E> loadBalancerArns

 The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.
 


targetType
String targetType

 The type of target that you must specify when registering targets with this target group. The possible values are
 instance (targets are specified by instance ID) or ip (targets are specified by IP
 address).
 








Class com.amazonaws.services.elasticloadbalancingv2.model.TargetGroupAssociationLimitException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.TargetGroupAttribute extends Object implements Serializable


Serialized Fields


key
String key

 The name of the attribute.
 
 
 The following attribute is supported by both Application Load Balancers and Network Load Balancers:
 
 
 
 
 deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to
 wait before changing the state of a deregistering target from draining to unused. The
 range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is
 not supported.
 
 
 
 
 The following attributes are supported by Application Load Balancers if the target is not a Lambda function:
 
 
 
 
 load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer
 selects targets when routing requests. The value is round_robin or
 least_outstanding_requests. The default is round_robin.
 
 
 
 
 slow_start.duration_seconds - The time period, in seconds, during which a newly registered target
 receives a linearly increasing share of the traffic to the target group. After this time period ends, the target
 receives its full share of traffic. The range is 30-900 seconds (15 minutes). Slow start mode is disabled by
 default.
 
 
 
 
 stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true
 or false. The default is false.
 
 
 
 
 stickiness.type - The type of sticky sessions. The possible value is lb_cookie.
 
 
 
 
 stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a
 client should be routed to the same target. After this time period expires, the load balancer-generated cookie is
 considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).
 
 
 
 
 The following attribute is supported only if the target is a Lambda function.
 
 
 
 
 lambda.multi_value_headers.enabled - Indicates whether the request and response headers exchanged
 between the load balancer and the Lambda function include arrays of values or strings. The value is
 true or false. The default is false. If the value is false
 and the request contains a duplicate header field name or query parameter key, the load balancer uses the last
 value sent by the client.
 
 
 
 
 The following attribute is supported only by Network Load Balancers:
 
 
 
 
 proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is
 true or false. The default is false.
 
 
 


value
String value

 The value of the attribute.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.TargetGroupNotFoundException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.TargetGroupStickinessConfig extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Indicates whether target group stickiness is enabled.
 


durationSeconds
Integer durationSeconds

 The time period, in seconds, during which requests from a client should be routed to the same target group. The
 range is 1-604800 seconds (7 days).
 








Class com.amazonaws.services.elasticloadbalancingv2.model.TargetGroupTuple extends Object implements Serializable


Serialized Fields


targetGroupArn
String targetGroupArn

 The Amazon Resource Name (ARN) of the target group.
 


weight
Integer weight

 The weight. The range is 0 to 999.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.TargetHealth extends Object implements Serializable


Serialized Fields


state
String state

 The state of the target.
 


reason
String reason

 The reason code.
 
 
 If the target state is healthy, a reason code is not provided.
 
 
 If the target state is initial, the reason code can be one of the following values:
 
 
 
 
 Elb.RegistrationInProgress - The target is in the process of being registered with the load
 balancer.
 
 
 
 
 Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of
 health checks required to determine its health status.
 
 
 
 
 If the target state is unhealthy, the reason code can be one of the following values:
 
 
 
 
 Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Applies only
 to Application Load Balancers.
 
 
 
 
 Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers.
 
 
 
 
 Target.FailedHealthChecks - The load balancer received an error while establishing a connection to
 the target or the target response was malformed.
 
 
 
 
 Elb.InternalError - The health checks failed due to an internal error. Applies only to Application
 Load Balancers.
 
 
 
 
 If the target state is unused, the reason code can be one of the following values:
 
 
 
 
 Target.NotRegistered - The target is not registered with the target group.
 
 
 
 
 Target.NotInUse - The target group is not used by any load balancer or the target is in an
 Availability Zone that is not enabled for its load balancer.
 
 
 
 
 Target.InvalidState - The target is in the stopped or terminated state.
 
 
 
 
 Target.IpUnusable - The target IP address is reserved for use by a load balancer.
 
 
 
 
 If the target state is draining, the reason code can be the following value:
 
 
 
 
 Target.DeregistrationInProgress - The target is in the process of being deregistered and the
 deregistration delay period has not expired.
 
 
 
 
 If the target state is unavailable, the reason code can be the following value:
 
 
 
 
 Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to
 Application Load Balancers.
 
 
 
 
 Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network
 Load Balancers.
 
 
 


description
String description

 A description of the target health that provides additional details. If the state is healthy, a
 description is not provided.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.TargetHealthDescription extends Object implements Serializable


Serialized Fields


target
TargetDescription target

 The description of the target.
 


healthCheckPort
String healthCheckPort

 The port to use to connect with the target.
 


targetHealth
TargetHealth targetHealth

 The health information for the target.
 








Class com.amazonaws.services.elasticloadbalancingv2.model.TooManyActionsException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.TooManyCertificatesException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.TooManyListenersException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.TooManyLoadBalancersException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.TooManyRegistrationsForTargetIdException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.TooManyRulesException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.TooManyTagsException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.TooManyTargetGroupsException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.TooManyTargetsException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.TooManyUniqueTargetGroupsPerLoadBalancerException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancingv2.model.UnsupportedProtocolException extends AmazonElasticLoadBalancingException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.elasticmapreduce.model




Class com.amazonaws.services.elasticmapreduce.model.AddInstanceFleetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The unique identifier of the cluster.
 


instanceFleet
InstanceFleetConfig instanceFleet

 Specifies the configuration of the instance fleet.
 








Class com.amazonaws.services.elasticmapreduce.model.AddInstanceFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterId
String clusterId

 The unique identifier of the cluster.
 


instanceFleetId
String instanceFleetId

 The unique identifier of the instance fleet.
 


clusterArn
String clusterArn

 The Amazon Resource Name of the cluster.
 








Class com.amazonaws.services.elasticmapreduce.model.AddInstanceGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceGroups
SdkInternalList<T> instanceGroups

 Instance groups to add.
 


jobFlowId
String jobFlowId

 Job flow in which to add the instance groups.
 








Class com.amazonaws.services.elasticmapreduce.model.AddInstanceGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobFlowId
String jobFlowId

 The job flow ID in which the instance groups are added.
 


instanceGroupIds
SdkInternalList<T> instanceGroupIds

 Instance group IDs of the newly created instance groups.
 


clusterArn
String clusterArn

 The Amazon Resource Name of the cluster.
 








Class com.amazonaws.services.elasticmapreduce.model.AddJobFlowStepsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobFlowId
String jobFlowId

 A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be
 obtained from ListClusters.
 


steps
SdkInternalList<T> steps

 A list of StepConfig to be executed by the job flow.
 








Class com.amazonaws.services.elasticmapreduce.model.AddJobFlowStepsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stepIds
SdkInternalList<T> stepIds

 The identifiers of the list of steps added to the job flow.
 








Class com.amazonaws.services.elasticmapreduce.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceId
String resourceId

 The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier.
 


tags
SdkInternalList<T> tags

 A list of tags to associate with a cluster and propagate to EC2 instances. Tags are user-defined key/value pairs
 that consist of a required key string with a maximum of 128 characters, and an optional value string with a
 maximum of 256 characters.
 








Class com.amazonaws.services.elasticmapreduce.model.AddTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.AmazonElasticMapReduceException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticmapreduce.model.Application extends Object implements Serializable


Serialized Fields


name
String name

 The name of the application.
 


version
String version

 The version of the application.
 


args
SdkInternalList<T> args

 Arguments for Amazon EMR to pass to the application.
 


additionalInfo
SdkInternalMap<K,V> additionalInfo

 This option is for advanced users only. This is meta information about third-party applications that third-party
 vendors use for testing purposes.
 








Class com.amazonaws.services.elasticmapreduce.model.AutoScalingPolicy extends Object implements Serializable


Serialized Fields


constraints
ScalingConstraints constraints

 The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not
 cause an instance group to grow above or below these limits.
 


rules
SdkInternalList<T> rules

 The scale-in and scale-out rules that comprise the automatic scaling policy.
 








Class com.amazonaws.services.elasticmapreduce.model.AutoScalingPolicyDescription extends Object implements Serializable


Serialized Fields


status
AutoScalingPolicyStatus status

 The status of an automatic scaling policy.
 


constraints
ScalingConstraints constraints

 The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not
 cause an instance group to grow above or below these limits.
 


rules
SdkInternalList<T> rules

 The scale-in and scale-out rules that comprise the automatic scaling policy.
 








Class com.amazonaws.services.elasticmapreduce.model.AutoScalingPolicyStateChangeReason extends Object implements Serializable


Serialized Fields


code
String code

 The code indicating the reason for the change in status.USER_REQUEST indicates that the scaling
 policy status was changed by a user. PROVISION_FAILURE indicates that the status change was because
 the policy failed to provision. CLEANUP_FAILURE indicates an error.
 


message
String message

 A friendly, more verbose message that accompanies an automatic scaling policy state change.
 








Class com.amazonaws.services.elasticmapreduce.model.AutoScalingPolicyStatus extends Object implements Serializable


Serialized Fields


state
String state

 Indicates the status of the automatic scaling policy.
 


stateChangeReason
AutoScalingPolicyStateChangeReason stateChangeReason

 The reason for a change in status.
 








Class com.amazonaws.services.elasticmapreduce.model.BlockPublicAccessConfiguration extends Object implements Serializable


Serialized Fields


blockPublicSecurityGroupRules
Boolean blockPublicSecurityGroupRules

 Indicates whether EMR block public access is enabled (true) or disabled (false). By
 default, the value is false for accounts that have created EMR clusters before July 2019. For
 accounts created after this, the default is true.
 


permittedPublicSecurityGroupRuleRanges
SdkInternalList<T> permittedPublicSecurityGroupRuleRanges

 Specifies ports and port ranges that are permitted to have security group rules that allow inbound traffic from
 all public sources. For example, if Port 23 (Telnet) is specified for
 PermittedPublicSecurityGroupRuleRanges, Amazon EMR allows cluster creation if a security group
 associated with the cluster has a rule that allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port
 ::/0 as the source.
 
 
 By default, Port 22, which is used for SSH access to the cluster EC2 instances, is in the list of
 PermittedPublicSecurityGroupRuleRanges.
 








Class com.amazonaws.services.elasticmapreduce.model.BlockPublicAccessConfigurationMetadata extends Object implements Serializable


Serialized Fields


creationDateTime
Date creationDateTime

 The date and time that the configuration was created.
 


createdByArn
String createdByArn

 The Amazon Resource Name that created or last modified the configuration.
 








Class com.amazonaws.services.elasticmapreduce.model.BootstrapActionConfig extends Object implements Serializable


Serialized Fields


name
String name

 The name of the bootstrap action.
 


scriptBootstrapAction
ScriptBootstrapActionConfig scriptBootstrapAction

 The script run by the bootstrap action.
 








Class com.amazonaws.services.elasticmapreduce.model.BootstrapActionDetail extends Object implements Serializable


Serialized Fields


bootstrapActionConfig
BootstrapActionConfig bootstrapActionConfig

 A description of the bootstrap action.
 








Class com.amazonaws.services.elasticmapreduce.model.CancelStepsInfo extends Object implements Serializable


Serialized Fields


stepId
String stepId

 The encrypted StepId of a step.
 


status
String status

 The status of a CancelSteps Request. The value may be SUBMITTED or FAILED.
 


reason
String reason

 The reason for the failure if the CancelSteps request fails.
 








Class com.amazonaws.services.elasticmapreduce.model.CancelStepsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The ClusterID for which specified steps will be canceled. Use RunJobFlow and
 ListClusters to get ClusterIDs.
 


stepIds
SdkInternalList<T> stepIds

 The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified
 cluster.
 


stepCancellationOption
String stepCancellationOption

 The option to choose for cancelling RUNNING steps. By default, the value is
 SEND_INTERRUPT.
 








Class com.amazonaws.services.elasticmapreduce.model.CancelStepsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cancelStepsInfoList
SdkInternalList<T> cancelStepsInfoList

 A list of CancelStepsInfo, which shows the status of specified cancel requests for each
 StepID specified.
 








Class com.amazonaws.services.elasticmapreduce.model.CloudWatchAlarmDefinition extends Object implements Serializable


Serialized Fields


comparisonOperator
String comparisonOperator

 Determines how the metric specified by MetricName is compared to the value specified by
 Threshold.
 


evaluationPeriods
Integer evaluationPeriods

 The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm
 triggers automatic scaling activity. The default value is 1.
 


metricName
String metricName

 The name of the CloudWatch metric that is watched to determine an alarm condition.
 


namespace
String namespace

 The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.
 


period
Integer period

 The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five
 minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.
 


statistic
String statistic

 The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
 


threshold
Double threshold

 The value against which the specified statistic is compared.
 


unit
String unit

 The unit of measure associated with the CloudWatch metric being watched. The value specified for
 Unit must correspond to the units specified in the CloudWatch metric.
 


dimensions
SdkInternalList<T> dimensions

 A CloudWatch metric dimension.
 








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


Serialized Fields


id
String id

 The unique identifier for the cluster.
 


name
String name

 The name of the cluster.
 


status
ClusterStatus status

 The current status details about the cluster.
 


ec2InstanceAttributes
Ec2InstanceAttributes ec2InstanceAttributes

 Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID,
 IAM instance profile, and so on.
 


instanceCollectionType
String instanceCollectionType

 
 The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x
 versions.
 
 
 
 The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform
 instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.
 


logUri
String logUri

 The path to the Amazon S3 location where logs for this cluster are stored.
 


requestedAmiVersion
String requestedAmiVersion

 The AMI version requested for this cluster.
 


runningAmiVersion
String runningAmiVersion

 The AMI version running on this cluster.
 


releaseLabel
String releaseLabel

 The Amazon EMR release label, which determines the version of open-source application packages installed on the
 cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such
 as emr-5.14.0. For more information about Amazon EMR release versions and included application
 versions and features, see https://docs.aws.amazon.
 com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later.
 Earlier versions use AmiVersion.
 


autoTerminate
Boolean autoTerminate

 Specifies whether the cluster should terminate after completing all steps.
 


terminationProtected
Boolean terminationProtected

 Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API
 call or user intervention, or in the event of a cluster error.
 


visibleToAllUsers
Boolean visibleToAllUsers

 Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. The
 default value, true, indicates that all IAM users in the AWS account can perform cluster actions if
 they have the proper IAM policy permissions. If this value is false, only the IAM user that created
 the cluster can perform actions. This value can be changed on a running cluster by using the
 SetVisibleToAllUsers action. You can override the default value of true when you create a
 cluster by using the VisibleToAllUsers parameter of the RunJobFlow action.
 


applications
SdkInternalList<T> applications

 The applications installed on this cluster.
 


tags
SdkInternalList<T> tags

 A list of tags associated with a cluster.
 


serviceRole
String serviceRole

 The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
 


normalizedInstanceHours
Integer normalizedInstanceHours

 An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time
 for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly
 four times more expensive would result in the normalized instance hours being incremented by four. This result is
 only an approximation and does not reflect the actual billing rate.
 


masterPublicDnsName
String masterPublicDnsName

 The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public
 subnet, this is the public DNS name.
 


configurations
SdkInternalList<T> configurations

 Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.
 


securityConfiguration
String securityConfiguration

 The name of the security configuration applied to the cluster.
 


autoScalingRole
String autoScalingRole

 An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM
 role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an
 instance group.
 


scaleDownBehavior
String scaleDownBehavior

 The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance
 group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the
 instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is
 only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version.
 TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before
 terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR
 removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption.
 TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 and later, and is the
 default for versions of Amazon EMR earlier than 5.1.0.
 


customAmiId
String customAmiId

 Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the
 cluster uses a custom AMI.
 


ebsRootVolumeSize
Integer ebsRootVolumeSize

 The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in
 Amazon EMR version 4.x and later.
 


repoUpgradeOnBoot
String repoUpgradeOnBoot

 Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the
 Amazon Linux AMI package repositories when an instance boots using the AMI.
 


kerberosAttributes
KerberosAttributes kerberosAttributes

 Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For
 more information see Use
 Kerberos Authentication in the EMR Management Guide.
 


clusterArn
String clusterArn

 The Amazon Resource Name of the cluster.
 


stepConcurrencyLevel
Integer stepConcurrencyLevel

 Specifies the number of steps that can be executed concurrently.
 


outpostArn
String outpostArn

 The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
 








Class com.amazonaws.services.elasticmapreduce.model.ClusterStateChangeReason extends Object implements Serializable


Serialized Fields


code
String code

 The programmatic code for the state change reason.
 


message
String message

 The descriptive message for the state change reason.
 








Class com.amazonaws.services.elasticmapreduce.model.ClusterStatus extends Object implements Serializable


Serialized Fields


state
String state

 The current state of the cluster.
 


stateChangeReason
ClusterStateChangeReason stateChangeReason

 The reason for the cluster status change.
 


timeline
ClusterTimeline timeline

 A timeline that represents the status of a cluster over the lifetime of the cluster.
 








Class com.amazonaws.services.elasticmapreduce.model.ClusterSummary extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier for the cluster.
 


name
String name

 The name of the cluster.
 


status
ClusterStatus status

 The details about the current status of the cluster.
 


normalizedInstanceHours
Integer normalizedInstanceHours

 An approximation of the cost of the cluster, 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.
 


clusterArn
String clusterArn

 The Amazon Resource Name of the cluster.
 


outpostArn
String outpostArn

 The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.
 








Class com.amazonaws.services.elasticmapreduce.model.ClusterTimeline extends Object implements Serializable


Serialized Fields


creationDateTime
Date creationDateTime

 The creation date and time of the cluster.
 


readyDateTime
Date readyDateTime

 The date and time when the cluster was ready to execute steps.
 


endDateTime
Date endDateTime

 The date and time when the cluster was terminated.
 








Class com.amazonaws.services.elasticmapreduce.model.Command extends Object implements Serializable


Serialized Fields


name
String name

 The name of the command.
 


scriptPath
String scriptPath

 The Amazon S3 location of the command script.
 


args
SdkInternalList<T> args

 Arguments for Amazon EMR to pass to the command for execution.
 








Class com.amazonaws.services.elasticmapreduce.model.Configuration extends Object implements Serializable


Serialized Fields


classification
String classification

 The classification within a configuration.
 


configurations
SdkInternalList<T> configurations

 A list of additional configurations to apply within a configuration object.
 


properties
SdkInternalMap<K,V> properties

 A set of properties specified within a configuration classification.
 








Class com.amazonaws.services.elasticmapreduce.model.CreateSecurityConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the security configuration.
 


securityConfiguration
String securityConfiguration

 The security configuration details in JSON format. For JSON parameters and examples, see Use Security
 Configurations to Set Up Cluster Security in the Amazon EMR Management Guide.
 








Class com.amazonaws.services.elasticmapreduce.model.CreateSecurityConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the security configuration.
 


creationDateTime
Date creationDateTime

 The date and time the security configuration was created.
 








Class com.amazonaws.services.elasticmapreduce.model.DeleteSecurityConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the security configuration.
 








Class com.amazonaws.services.elasticmapreduce.model.DeleteSecurityConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.DescribeClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The identifier of the cluster to describe.
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cluster
Cluster cluster

 This output contains the details for the requested cluster.
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeJobFlowsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


createdAfter
Date createdAfter

 Return only job flows created after this date and time.
 


createdBefore
Date createdBefore

 Return only job flows created before this date and time.
 


jobFlowIds
SdkInternalList<T> jobFlowIds

 Return only job flows whose job flow ID is contained in this list.
 


jobFlowStates
SdkInternalList<T> jobFlowStates

 Return only job flows whose state is contained in this list.
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeJobFlowsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobFlows
SdkInternalList<T> jobFlows

 A list of job flows matching the parameters supplied.
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeSecurityConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the security configuration.
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeSecurityConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the security configuration.
 


securityConfiguration
String securityConfiguration

 The security configuration details in JSON format.
 


creationDateTime
Date creationDateTime

 The date and time the security configuration was created
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeStepRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The identifier of the cluster with steps to describe.
 


stepId
String stepId

 The identifier of the step to describe.
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeStepResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


step
Step step

 The step details for the requested step identifier.
 








Class com.amazonaws.services.elasticmapreduce.model.EbsBlockDevice extends Object implements Serializable


Serialized Fields


volumeSpecification
VolumeSpecification volumeSpecification

 EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume
 attached to an EC2 instance in the cluster.
 


device
String device

 The device name that is exposed to the instance, such as /dev/sdh.
 








Class com.amazonaws.services.elasticmapreduce.model.EbsBlockDeviceConfig extends Object implements Serializable


Serialized Fields


volumeSpecification
VolumeSpecification volumeSpecification

 EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume
 attached to an EC2 instance in the cluster.
 


volumesPerInstance
Integer volumesPerInstance

 Number of EBS volumes with a specific volume configuration that will be associated with every instance in the
 instance group
 








Class com.amazonaws.services.elasticmapreduce.model.EbsConfiguration extends Object implements Serializable


Serialized Fields


ebsBlockDeviceConfigs
SdkInternalList<T> ebsBlockDeviceConfigs

 An array of Amazon EBS volume specifications attached to a cluster instance.
 


ebsOptimized
Boolean ebsOptimized

 Indicates whether an Amazon EBS volume is EBS-optimized.
 








Class com.amazonaws.services.elasticmapreduce.model.EbsVolume extends Object implements Serializable


Serialized Fields


device
String device

 The device name that is exposed to the instance, such as /dev/sdh.
 


volumeId
String volumeId

 The volume identifier of the EBS volume.
 








Class com.amazonaws.services.elasticmapreduce.model.Ec2InstanceAttributes extends Object implements Serializable


Serialized Fields


ec2KeyName
String ec2KeyName

 The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named
 "hadoop".
 


ec2SubnetId
String ec2SubnetId

 Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not
 specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.
 


requestedEc2SubnetIds
SdkInternalList<T> requestedEc2SubnetIds

 Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more
 Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR
 chooses the EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, and then
 launches all cluster instances within that Subnet. If this value is not specified, and the account and Region
 support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses
 RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no
 Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and
 RequestedEc2AvailabilityZones cannot be specified together.
 


ec2AvailabilityZone
String ec2AvailabilityZone

 The Availability Zone in which the cluster will run.
 


requestedEc2AvailabilityZones
SdkInternalList<T> requestedEc2AvailabilityZones

 Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which
 to launch EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the
 Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones, and then
 launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR
 chooses the Availability Zone for you. RequestedEc2SubnetIDs and
 RequestedEc2AvailabilityZones cannot be specified together.
 


iamInstanceProfile
String iamInstanceProfile

 The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role.
 


emrManagedMasterSecurityGroup
String emrManagedMasterSecurityGroup

 The identifier of the Amazon EC2 security group for the master node.
 


emrManagedSlaveSecurityGroup
String emrManagedSlaveSecurityGroup

 The identifier of the Amazon EC2 security group for the core and task nodes.
 


serviceAccessSecurityGroup
String serviceAccessSecurityGroup

 The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private
 subnets.
 


additionalMasterSecurityGroups
SdkInternalList<T> additionalMasterSecurityGroups

 A list of additional Amazon EC2 security group IDs for the master node.
 


additionalSlaveSecurityGroups
SdkInternalList<T> additionalSlaveSecurityGroups

 A list of additional Amazon EC2 security group IDs for the core and task nodes.
 








Class com.amazonaws.services.elasticmapreduce.model.FailureDetails extends Object implements Serializable


Serialized Fields


reason
String reason

 The reason for the step failure. In the case where the service cannot successfully determine the root cause of
 the failure, it returns "Unknown Error" as a reason.
 


message
String message

 The descriptive message including the error the EMR service has identified as the cause of step failure. This is
 text from an error log that describes the root cause of the failure.
 


logFile
String logFile

 The path to the log file where the step failure root cause was originally recorded.
 








Class com.amazonaws.services.elasticmapreduce.model.GetBlockPublicAccessConfigurationRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.GetBlockPublicAccessConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


blockPublicAccessConfiguration
BlockPublicAccessConfiguration blockPublicAccessConfiguration

 A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your
 account for the current Region. The configuration specifies whether block public access is enabled. If block
 public access is enabled, security groups associated with the cluster cannot have rules that allow inbound
 traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using
 PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By
 default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by
 updating the block public access configuration to remove the exception.
 


blockPublicAccessConfigurationMetadata
BlockPublicAccessConfigurationMetadata blockPublicAccessConfigurationMetadata

 Properties that describe the AWS principal that created the BlockPublicAccessConfiguration using the
 PutBlockPublicAccessConfiguration action as well as the date and time that the configuration was
 created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.
 








Class com.amazonaws.services.elasticmapreduce.model.HadoopJarStepConfig extends Object implements Serializable


Serialized Fields


properties
SdkInternalList<T> properties

 A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs
 to your main function.
 


jar
String jar

 A path to a JAR file run during the step.
 


mainClass
String mainClass

 The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class
 in its manifest file.
 


args
SdkInternalList<T> args

 A list of command line arguments passed to the JAR file's main function when executed.
 








Class com.amazonaws.services.elasticmapreduce.model.HadoopStepConfig extends Object implements Serializable


Serialized Fields


jar
String jar

 The path to the JAR file that runs during the step.
 


properties
SdkInternalMap<K,V> properties

 The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs
 to your main function.
 


mainClass
String mainClass

 The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class
 in its manifest file.
 


args
SdkInternalList<T> args

 The list of command line arguments to pass to the JAR file's main function for execution.
 








Class com.amazonaws.services.elasticmapreduce.model.Instance extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier for the instance in Amazon EMR.
 


ec2InstanceId
String ec2InstanceId

 The unique identifier of the instance in Amazon EC2.
 


publicDnsName
String publicDnsName

 The public DNS name of the instance.
 


publicIpAddress
String publicIpAddress

 The public IP address of the instance.
 


privateDnsName
String privateDnsName

 The private DNS name of the instance.
 


privateIpAddress
String privateIpAddress

 The private IP address of the instance.
 


status
InstanceStatus status

 The current status of the instance.
 


instanceGroupId
String instanceGroupId

 The identifier of the instance group to which this instance belongs.
 


instanceFleetId
String instanceFleetId

 The unique identifier of the instance fleet to which an EC2 instance belongs.
 


market
String market

 The instance purchasing option. Valid values are ON_DEMAND or SPOT.
 


instanceType
String instanceType

 The EC2 instance type, for example m3.xlarge.
 


ebsVolumes
SdkInternalList<T> ebsVolumes

 The list of EBS volumes that are attached to this instance.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceFleet extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier of the instance fleet.
 


name
String name

 A friendly name for the instance fleet.
 


status
InstanceFleetStatus status

 The current status of the instance fleet.
 


instanceFleetType
String instanceFleetType

 The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.
 


targetOnDemandCapacity
Integer targetOnDemandCapacity

 The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to
 provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by
 InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an
 On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity.
 Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an
 overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an
 instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is
 exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity
 units that have been provisioned for the instance fleet.
 
 
 
 If not specified or set to 0, only Spot instances are provisioned for the instance fleet using
 TargetSpotCapacity. At least one of TargetSpotCapacity and
 TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of
 TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be
 1.
 
 


targetSpotCapacity
Integer targetSpotCapacity

 The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision.
 When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by
 InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot
 instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR
 provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For
 example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a
 WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3
 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have
 been provisioned for the instance fleet.
 
 
 
 If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of
 TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master
 instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be
 specified, and its value must be 1.
 
 


provisionedOnDemandCapacity
Integer provisionedOnDemandCapacity

 The number of On-Demand units that have been provisioned for the instance fleet to fulfill
 TargetOnDemandCapacity. This provisioned capacity might be less than or greater than
 TargetOnDemandCapacity.
 


provisionedSpotCapacity
Integer provisionedSpotCapacity

 The number of Spot units that have been provisioned for this instance fleet to fulfill
 TargetSpotCapacity. This provisioned capacity might be less than or greater than
 TargetSpotCapacity.
 


instanceTypeSpecifications
SdkInternalList<T> instanceTypeSpecifications

 The specification for the instance types that comprise an instance fleet. Up to five unique instance
 specifications may be defined for each instance fleet.
 


launchSpecifications
InstanceFleetProvisioningSpecifications launchSpecifications

 Describes the launch specification for an instance fleet.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceFleetConfig extends Object implements Serializable


Serialized Fields


name
String name

 The friendly name of the instance fleet.
 


instanceFleetType
String instanceFleetType

 The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK.
 


targetOnDemandCapacity
Integer targetOnDemandCapacity

 The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to
 provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by
 InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an
 On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity.
 Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an
 overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an
 instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is
 exceeded by 3 units.
 
 
 
 If not specified or set to 0, only Spot instances are provisioned for the instance fleet using
 TargetSpotCapacity. At least one of TargetSpotCapacity and
 TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of
 TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be
 1.
 
 


targetSpotCapacity
Integer targetSpotCapacity

 The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision.
 When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by
 InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot
 instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR
 provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For
 example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a
 WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3
 units.
 
 
 
 If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of
 TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master
 instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be
 specified, and its value must be 1.
 
 


instanceTypeConfigs
SdkInternalList<T> instanceTypeConfigs

 The instance type configurations that define the EC2 instances in the instance fleet.
 


launchSpecifications
InstanceFleetProvisioningSpecifications launchSpecifications

 The launch specification for the instance fleet.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceFleetModifyConfig extends Object implements Serializable


Serialized Fields


instanceFleetId
String instanceFleetId

 A unique identifier for the instance fleet.
 


targetOnDemandCapacity
Integer targetOnDemandCapacity

 The target capacity of On-Demand units for the instance fleet. For more information see
 InstanceFleetConfig$TargetOnDemandCapacity.
 


targetSpotCapacity
Integer targetSpotCapacity

 The target capacity of Spot units for the instance fleet. For more information, see
 InstanceFleetConfig$TargetSpotCapacity.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceFleetProvisioningSpecifications extends Object implements Serializable


Serialized Fields


spotSpecification
SpotProvisioningSpecification spotSpecification

 The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning
 timeout behavior.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceFleetStateChangeReason extends Object implements Serializable


Serialized Fields


code
String code

 A code corresponding to the reason the state change occurred.
 


message
String message

 An explanatory message.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceFleetStatus extends Object implements Serializable


Serialized Fields


state
String state

 A code representing the instance fleet status.
 
 
 
 
 PROVISIONING—The instance fleet is provisioning EC2 resources and is not yet ready to run jobs.
 
 
 
 
 BOOTSTRAPPING—EC2 instances and other resources have been provisioned and the bootstrap actions
 specified for the instances are underway.
 
 
 
 
 RUNNING—EC2 instances and other resources are running. They are either executing jobs or waiting to
 execute jobs.
 
 
 
 
 RESIZING—A resize operation is underway. EC2 instances are either being added or removed.
 
 
 
 
 SUSPENDED—A resize operation could not complete. Existing EC2 instances are running, but instances
 can't be added or removed.
 
 
 
 
 TERMINATING—The instance fleet is terminating EC2 instances.
 
 
 
 
 TERMINATED—The instance fleet is no longer active, and all EC2 instances have been terminated.
 
 
 


stateChangeReason
InstanceFleetStateChangeReason stateChangeReason

 Provides status change reason details for the instance fleet.
 


timeline
InstanceFleetTimeline timeline

 Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready
 to run jobs, and the time of termination.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceFleetTimeline extends Object implements Serializable


Serialized Fields


creationDateTime
Date creationDateTime

 The time and date the instance fleet was created.
 


readyDateTime
Date readyDateTime

 The time and date the instance fleet was ready to run jobs.
 


endDateTime
Date endDateTime

 The time and date the instance fleet terminated.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroup extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the instance group.
 


name
String name

 The name of the instance group.
 


market
String market

 The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
 


instanceGroupType
String instanceGroupType

 The type of the instance group. Valid values are MASTER, CORE or TASK.
 


bidPrice
String bidPrice

 The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If
 neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided,
 BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
 


instanceType
String instanceType

 The EC2 instance type for all instances in the instance group.
 


requestedInstanceCount
Integer requestedInstanceCount

 The target number of instances for the instance group.
 


runningInstanceCount
Integer runningInstanceCount

 The number of instances currently running in this instance group.
 


status
InstanceGroupStatus status

 The current status of the instance group.
 


configurations
SdkInternalList<T> configurations

 
 Amazon EMR releases 4.x or later.
 
 
 
 The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration
 for each instance group (master, core, and task).
 


configurationsVersion
Long configurationsVersion

 The version number of the requested configuration specification for this instance group.
 


lastSuccessfullyAppliedConfigurations
SdkInternalList<T> lastSuccessfullyAppliedConfigurations

 A list of configurations that were successfully applied for an instance group last time.
 


lastSuccessfullyAppliedConfigurationsVersion
Long lastSuccessfullyAppliedConfigurationsVersion

 The version number of a configuration specification that was successfully applied for an instance group last
 time.
 


ebsBlockDevices
SdkInternalList<T> ebsBlockDevices

 The EBS block devices that are mapped to this instance group.
 


ebsOptimized
Boolean ebsOptimized

 If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack
 and provides additional, dedicated capacity for Amazon EBS I/O.
 


shrinkPolicy
ShrinkPolicy shrinkPolicy

 Policy for customizing shrink operations.
 


autoScalingPolicy
AutoScalingPolicyDescription autoScalingPolicy

 An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The
 automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response
 to the value of a CloudWatch metric. See PutAutoScalingPolicy.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupConfig extends Object implements Serializable


Serialized Fields


name
String name

 Friendly name given to the instance group.
 


market
String market

 Market type of the EC2 instances used to create a cluster node.
 


instanceRole
String instanceRole

 The role of the instance group in the cluster.
 


bidPrice
String bidPrice

 The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If
 neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided,
 BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
 


instanceType
String instanceType

 The EC2 instance type for all instances in the instance group.
 


instanceCount
Integer instanceCount

 Target number of instances for the instance group.
 


configurations
SdkInternalList<T> configurations

 
 Amazon EMR releases 4.x or later.
 
 
 
 The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration
 for each instance group (master, core, and task).
 


ebsConfiguration
EbsConfiguration ebsConfiguration

 EBS configurations that will be attached to each EC2 instance in the instance group.
 


autoScalingPolicy
AutoScalingPolicy autoScalingPolicy

 An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The
 automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response
 to the value of a CloudWatch metric. See PutAutoScalingPolicy.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupDetail extends Object implements Serializable


Serialized Fields


instanceGroupId
String instanceGroupId

 Unique identifier for the instance group.
 


name
String name

 Friendly name for the instance group.
 


market
String market

 Market type of the EC2 instances used to create a cluster node.
 


instanceRole
String instanceRole

 Instance group role in the cluster
 


bidPrice
String bidPrice

 The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If
 neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided,
 BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
 


instanceType
String instanceType

 EC2 instance type.
 


instanceRequestCount
Integer instanceRequestCount

 Target number of instances to run in the instance group.
 


instanceRunningCount
Integer instanceRunningCount

 Actual count of running instances.
 


state
String state

 State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.
 


lastStateChangeReason
String lastStateChangeReason

 Details regarding the state of the instance group.
 


creationDateTime
Date creationDateTime

 The date/time the instance group was created.
 


startDateTime
Date startDateTime

 The date/time the instance group was started.
 


readyDateTime
Date readyDateTime

 The date/time the instance group was available to the cluster.
 


endDateTime
Date endDateTime

 The date/time the instance group was terminated.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupModifyConfig extends Object implements Serializable


Serialized Fields


instanceGroupId
String instanceGroupId

 Unique ID of the instance group to expand or shrink.
 


instanceCount
Integer instanceCount

 Target size for the instance group.
 


eC2InstanceIdsToTerminate
SdkInternalList<T> eC2InstanceIdsToTerminate

 The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its
 original requested size.
 


shrinkPolicy
ShrinkPolicy shrinkPolicy

 Policy for customizing shrink operations.
 


configurations
SdkInternalList<T> configurations

 A list of new or modified configurations to apply for an instance group.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupStateChangeReason extends Object implements Serializable


Serialized Fields


code
String code

 The programmable code for the state change reason.
 


message
String message

 The status change reason description.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupStatus extends Object implements Serializable


Serialized Fields


state
String state

 The current state of the instance group.
 


stateChangeReason
InstanceGroupStateChangeReason stateChangeReason

 The status change reason details for the instance group.
 


timeline
InstanceGroupTimeline timeline

 The timeline of the instance group status over time.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupTimeline extends Object implements Serializable


Serialized Fields


creationDateTime
Date creationDateTime

 The creation date and time of the instance group.
 


readyDateTime
Date readyDateTime

 The date and time when the instance group became ready to perform tasks.
 


endDateTime
Date endDateTime

 The date and time when the instance group terminated.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceResizePolicy extends Object implements Serializable


Serialized Fields


instancesToTerminate
SdkInternalList<T> instancesToTerminate

 Specific list of instances to be terminated when shrinking an instance group.
 


instancesToProtect
SdkInternalList<T> instancesToProtect

 Specific list of instances to be protected 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 extends Object implements Serializable


Serialized Fields


code
String code

 The programmable code for the state change reason.
 


message
String message

 The status change reason description.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceStatus extends Object implements Serializable


Serialized Fields


state
String state

 The current state of the instance.
 


stateChangeReason
InstanceStateChangeReason stateChangeReason

 The details of the status change reason for the instance.
 


timeline
InstanceTimeline timeline

 The timeline of the instance status over time.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceTimeline extends Object implements Serializable


Serialized Fields


creationDateTime
Date creationDateTime

 The creation date and time of the instance.
 


readyDateTime
Date readyDateTime

 The date and time when the instance was ready to perform tasks.
 


endDateTime
Date endDateTime

 The date and time when the instance was terminated.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceTypeConfig extends Object implements Serializable


Serialized Fields


instanceType
String instanceType

 An EC2 instance type, such as m3.xlarge.
 


weightedCapacity
Integer weightedCapacity

 The number of units that a provisioned instance of this type provides toward fulfilling the target capacities
 defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for
 core and task instance fleets. Defaults to 1 if not specified.
 


bidPrice
String bidPrice

 The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If
 neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided,
 BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
 


bidPriceAsPercentageOfOnDemandPrice
Double bidPriceAsPercentageOfOnDemandPrice

 The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by
 InstanceType. Expressed as a number (for example, 20 specifies 20%). If neither
 BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided,
 BidPriceAsPercentageOfOnDemandPrice defaults to 100%.
 


ebsConfiguration
EbsConfiguration ebsConfiguration

 The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by
 InstanceType.
 


configurations
SdkInternalList<T> configurations

 A configuration classification that applies when provisioning cluster instances, which can include configurations
 for applications and software that run on the cluster.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceTypeSpecification extends Object implements Serializable


Serialized Fields


instanceType
String instanceType

 The EC2 instance type, for example m3.xlarge.
 


weightedCapacity
Integer weightedCapacity

 The number of units that a provisioned instance of this type provides toward fulfilling the target capacities
 defined in InstanceFleetConfig. Capacity values represent performance characteristics such as vCPUs,
 memory, or I/O. If not specified, the default value is 1.
 


bidPrice
String bidPrice

 The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD.
 


bidPriceAsPercentageOfOnDemandPrice
Double bidPriceAsPercentageOfOnDemandPrice

 The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by
 InstanceType. Expressed as a number (for example, 20 specifies 20%).
 


configurations
SdkInternalList<T> configurations

 A configuration classification that applies when provisioning cluster instances, which can include configurations
 for applications and software bundled with Amazon EMR.
 


ebsBlockDevices
SdkInternalList<T> ebsBlockDevices

 The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by
 InstanceType.
 


ebsOptimized
Boolean ebsOptimized

 Evaluates to TRUE when the specified InstanceType is EBS-optimized.
 








Class com.amazonaws.services.elasticmapreduce.model.InternalServerErrorException extends AmazonElasticMapReduceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticmapreduce.model.InternalServerException extends AmazonElasticMapReduceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticmapreduce.model.InvalidRequestException extends AmazonElasticMapReduceException implements Serializable

serialVersionUID:
1L



Serialized Fields


emrErrorCode
String emrErrorCode

 The error code associated with the exception.
 








Class com.amazonaws.services.elasticmapreduce.model.JobFlowDetail extends Object implements Serializable


Serialized Fields


jobFlowId
String jobFlowId

 The job flow identifier.
 


name
String name

 The name of the job flow.
 


logUri
String logUri

 The location in Amazon S3 where log files for the job are stored.
 


amiVersion
String amiVersion

 Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later,
 ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.
 


executionStatusDetail
JobFlowExecutionStatusDetail executionStatusDetail

 Describes the execution status of the job flow.
 


instances
JobFlowInstancesDetail instances

 Describes the Amazon EC2 instances of the job flow.
 


steps
SdkInternalList<T> steps

 A list of steps run by the job flow.
 


bootstrapActions
SdkInternalList<T> bootstrapActions

 A list of the bootstrap actions run by the job flow.
 


supportedProducts
SdkInternalList<T> supportedProducts

 A list of strings set by third party software when the job flow is launched. If you are not using third party
 software to manage the job flow this value is empty.
 


visibleToAllUsers
Boolean visibleToAllUsers

 Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. The
 default value, true, indicates that all IAM users in the AWS account can perform cluster actions if
 they have the proper IAM policy permissions. If this value is false, only the IAM user that created
 the cluster can perform actions. This value can be changed on a running cluster by using the
 SetVisibleToAllUsers action. You can override the default value of true when you create a
 cluster by using the VisibleToAllUsers parameter of the RunJobFlow action.
 


jobFlowRole
String jobFlowRole

 The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this
 role.
 


serviceRole
String serviceRole

 The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
 


autoScalingRole
String autoScalingRole

 An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM
 role provides a way for the automatic scaling feature to get the required permissions it needs to launch and
 terminate EC2 instances in an instance group.
 


scaleDownBehavior
String scaleDownBehavior

 The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance
 group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the
 instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is
 only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version.
 TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before
 terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR
 removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption.
 TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the
 default for versions of Amazon EMR earlier than 5.1.0.
 








Class com.amazonaws.services.elasticmapreduce.model.JobFlowExecutionStatusDetail extends Object implements Serializable


Serialized Fields


state
String state

 The state of the job flow.
 


creationDateTime
Date creationDateTime

 The creation date and time of the job flow.
 


startDateTime
Date startDateTime

 The start date and time of the job flow.
 


readyDateTime
Date readyDateTime

 The date and time when the job flow was ready to start running bootstrap actions.
 


endDateTime
Date endDateTime

 The completion date and time of the job flow.
 


lastStateChangeReason
String lastStateChangeReason

 Description of the job flow last changed state.
 








Class com.amazonaws.services.elasticmapreduce.model.JobFlowInstancesConfig extends Object implements Serializable


Serialized Fields


masterInstanceType
String masterInstanceType

 The EC2 instance type of the master node.
 


slaveInstanceType
String slaveInstanceType

 The EC2 instance type of the core and task nodes.
 


instanceCount
Integer instanceCount

 The number of EC2 instances in the cluster.
 


instanceGroups
SdkInternalList<T> instanceGroups

 Configuration for the instance groups in a cluster.
 


instanceFleets
SdkInternalList<T> instanceFleets

 
 The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x
 versions.
 
 
 
 Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.
 


ec2KeyName
String ec2KeyName

 The name of the EC2 key pair that can be used to ssh to the master node as the user called "hadoop."
 


placement
PlacementType placement

 The Availability Zone in which the cluster runs.
 


keepJobFlowAliveWhenNoSteps
Boolean keepJobFlowAliveWhenNoSteps

 Specifies whether the cluster should remain available after completing all steps.
 


terminationProtected
Boolean terminationProtected

 Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user
 intervention, or in the event of a job-flow error.
 


hadoopVersion
String hadoopVersion

 Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs
 are "0.18" (deprecated), "0.20" (deprecated), "0.20.205" (deprecated), "1.0.3", "2.2.0", or "2.4.0". If you do
 not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the
 RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.
 


ec2SubnetId
String ec2SubnetId

 Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual
 Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the
 cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches
 in EC2-Classic.
 


ec2SubnetIds
SdkInternalList<T> ec2SubnetIds

 Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon
 EMR evaluates them and launches instances in the optimal subnet.
 
 
 
 The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x
 versions.
 
 


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 core and task nodes.
 


serviceAccessSecurityGroup
String serviceAccessSecurityGroup

 The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private
 subnets.
 


additionalMasterSecurityGroups
SdkInternalList<T> additionalMasterSecurityGroups

 A list of additional Amazon EC2 security group IDs for the master node.
 


additionalSlaveSecurityGroups
SdkInternalList<T> additionalSlaveSecurityGroups

 A list of additional Amazon EC2 security group IDs for the core and task nodes.
 








Class com.amazonaws.services.elasticmapreduce.model.JobFlowInstancesDetail extends Object implements Serializable


Serialized Fields


masterInstanceType
String masterInstanceType

 The Amazon EC2 master node instance type.
 


masterPublicDnsName
String masterPublicDnsName

 The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public
 subnet, this is the public DNS name.
 


masterInstanceId
String masterInstanceId

 The Amazon EC2 instance identifier of the master node.
 


slaveInstanceType
String slaveInstanceType

 The Amazon EC2 core and task node instance type.
 


instanceCount
Integer instanceCount

 The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master
 and core and task node. If the value is greater than 1, one instance is the master node and all others are core
 and task nodes.
 


instanceGroups
SdkInternalList<T> instanceGroups

 Details about the instance groups in a cluster.
 


normalizedInstanceHours
Integer normalizedInstanceHours

 An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time
 for every hour that an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is
 roughly four times more expensive would result in the normalized instance hours being incremented by four. This
 result is only an approximation and does not reflect the actual billing rate.
 


ec2KeyName
String ec2KeyName

 The name of an Amazon EC2 key pair that can be used to ssh to the master node.
 


ec2SubnetId
String ec2SubnetId

 For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster
 was launched.
 


placement
PlacementType placement

 The Amazon EC2 Availability Zone for the cluster.
 


keepJobFlowAliveWhenNoSteps
Boolean keepJobFlowAliveWhenNoSteps

 Specifies whether the cluster should remain available after completing all steps.
 


terminationProtected
Boolean terminationProtected

 Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user
 intervention, or in the event of a job-flow error.
 


hadoopVersion
String hadoopVersion

 The Hadoop version for the cluster.
 








Class com.amazonaws.services.elasticmapreduce.model.KerberosAttributes extends Object implements Serializable


Serialized Fields


realm
String realm

 The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL.
 


kdcAdminPassword
String kdcAdminPassword

 The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains
 Kerberos principals, password policies, and keytabs for the cluster.
 


crossRealmTrustPrincipalPassword
String crossRealmTrustPrincipalPassword

 Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal
 password, which must be identical across realms.
 


aDDomainJoinUser
String aDDomainJoinUser

 Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient
 privileges to join resources to the domain.
 


aDDomainJoinPassword
String aDDomainJoinPassword

 The Active Directory password for ADDomainJoinUser.
 








Class com.amazonaws.services.elasticmapreduce.model.KeyValue extends Object implements Serializable


Serialized Fields


key
String key

 The unique identifier of a key value pair.
 


value
String value

 The value part of the identified key.
 








Class com.amazonaws.services.elasticmapreduce.model.ListBootstrapActionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The cluster identifier for the bootstrap actions to list.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListBootstrapActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bootstrapActions
SdkInternalList<T> bootstrapActions

 The bootstrap actions associated with the cluster.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








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


Serialized Fields


createdAfter
Date createdAfter

 The creation date and time beginning value filter for listing clusters.
 


createdBefore
Date createdBefore

 The creation date and time end value filter for listing clusters.
 


clusterStates
SdkInternalList<T> clusterStates

 The cluster state filters to apply when listing clusters.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListClustersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusters
SdkInternalList<T> clusters

 The list of clusters for the account based on the given filters.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListInstanceFleetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The unique identifier of the cluster.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListInstanceFleetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceFleets
SdkInternalList<T> instanceFleets

 The list of instance fleets 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.ListInstanceGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The identifier of the cluster for which to list the instance groups.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListInstanceGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceGroups
SdkInternalList<T> instanceGroups

 The list of instance groups for the cluster and given filters.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The identifier of the cluster for which to list the instances.
 


instanceGroupId
String instanceGroupId

 The identifier of the instance group for which to list the instances.
 


instanceGroupTypes
SdkInternalList<T> instanceGroupTypes

 The type of instance group for which to list the instances.
 


instanceFleetId
String instanceFleetId

 The unique identifier of the instance fleet.
 


instanceFleetType
String instanceFleetType

 The node type of the instance fleet. For example MASTER, CORE, or TASK.
 


instanceStates
SdkInternalList<T> 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instances
SdkInternalList<T> instances

 The list of instances for the cluster and given filters.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListSecurityConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


marker
String marker

 The pagination token that indicates the set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListSecurityConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityConfigurations
SdkInternalList<T> securityConfigurations

 The creation date and time, and name, of each security configuration.
 


marker
String marker

 A pagination token that indicates the next set of results to retrieve. Include the marker in the next
 ListSecurityConfiguration call to retrieve the next page of results, if required.
 








Class com.amazonaws.services.elasticmapreduce.model.ListStepsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The identifier of the cluster for which to list the steps.
 


stepStates
SdkInternalList<T> stepStates

 The filter to limit the step list based on certain states.
 


stepIds
SdkInternalList<T> stepIds

 The filter to limit the step list based on the identifier of the steps. You can specify a maximum of ten Step
 IDs. The character constraint applies to the overall length of the array.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListStepsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


steps
SdkInternalList<T> steps

 The filtered list of steps for the cluster.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.MetricDimension extends Object implements Serializable


Serialized Fields


key
String key

 The dimension name.
 


value
String value

 The dimension value.
 








Class com.amazonaws.services.elasticmapreduce.model.ModifyClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The unique identifier of the cluster.
 


stepConcurrencyLevel
Integer stepConcurrencyLevel

 The number of steps that can be executed concurrently. You can specify a maximum of 256 steps.
 








Class com.amazonaws.services.elasticmapreduce.model.ModifyClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stepConcurrencyLevel
Integer stepConcurrencyLevel

 The number of steps that can be executed concurrently.
 








Class com.amazonaws.services.elasticmapreduce.model.ModifyInstanceFleetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The unique identifier of the cluster.
 


instanceFleet
InstanceFleetModifyConfig instanceFleet

 The unique identifier of the instance fleet.
 








Class com.amazonaws.services.elasticmapreduce.model.ModifyInstanceFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.ModifyInstanceGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 The ID of the cluster to which the instance group belongs.
 


instanceGroups
SdkInternalList<T> instanceGroups

 Instance groups to change.
 








Class com.amazonaws.services.elasticmapreduce.model.ModifyInstanceGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.PlacementType extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instance
 groups, while AvailabilityZones (plural) is used for instance fleets.
 


availabilityZones
SdkInternalList<T> availabilityZones

 When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal
 Availability Zone. AvailabilityZones is used for instance fleets, while
 AvailabilityZone (singular) is used for uniform instance groups.
 
 
 
 The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x
 versions.
 
 








Class com.amazonaws.services.elasticmapreduce.model.PortRange extends Object implements Serializable


Serialized Fields


minRange
Integer minRange

 The smallest port number in a specified range of port numbers.
 


maxRange
Integer maxRange

 The smallest port number in a specified range of port numbers.
 








Class com.amazonaws.services.elasticmapreduce.model.PutAutoScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this
 cluster.
 


instanceGroupId
String instanceGroupId

 Specifies the ID of the instance group to which the automatic scaling policy is applied.
 


autoScalingPolicy
AutoScalingPolicy autoScalingPolicy

 Specifies the definition of the automatic scaling policy.
 








Class com.amazonaws.services.elasticmapreduce.model.PutAutoScalingPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterId
String clusterId

 Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this
 cluster.
 


instanceGroupId
String instanceGroupId

 Specifies the ID of the instance group to which the scaling policy is applied.
 


autoScalingPolicy
AutoScalingPolicyDescription autoScalingPolicy

 The automatic scaling policy definition.
 


clusterArn
String clusterArn

 The Amazon Resource Name of the cluster.
 








Class com.amazonaws.services.elasticmapreduce.model.PutBlockPublicAccessConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


blockPublicAccessConfiguration
BlockPublicAccessConfiguration blockPublicAccessConfiguration

 A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your
 account for the current Region. The configuration specifies whether block public access is enabled. If block
 public access is enabled, security groups associated with the cluster cannot have rules that allow inbound
 traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using
 PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By
 default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by
 updating BlockPublicSecurityGroupRules to remove the exception.
 








Class com.amazonaws.services.elasticmapreduce.model.PutBlockPublicAccessConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.RemoveAutoScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterId
String clusterId

 Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this
 cluster.
 


instanceGroupId
String instanceGroupId

 Specifies the ID of the instance group to which the scaling policy is applied.
 








Class com.amazonaws.services.elasticmapreduce.model.RemoveAutoScalingPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceId
String resourceId

 The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier.
 


tagKeys
SdkInternalList<T> tagKeys

 A list of tag keys to remove from a resource.
 








Class com.amazonaws.services.elasticmapreduce.model.RemoveTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.RunJobFlowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the job flow.
 


logUri
String logUri

 The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not
 created.
 


additionalInfo
String additionalInfo

 A JSON string for selecting additional features.
 


amiVersion
String amiVersion

 Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later,
 ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.
 


releaseLabel
String releaseLabel

 The Amazon EMR release label, which determines the version of open-source application packages installed on the
 cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such
 as emr-5.14.0. For more information about Amazon EMR release versions and included application
 versions and features, see https://docs.aws.amazon.
 com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later.
 Earlier versions use AmiVersion.
 


instances
JobFlowInstancesConfig instances

 A specification of the number and type of Amazon EC2 instances.
 


steps
SdkInternalList<T> steps

 A list of steps to run.
 


bootstrapActions
SdkInternalList<T> bootstrapActions

 A list of bootstrap actions to run before Hadoop starts on the cluster nodes.
 


supportedProducts
SdkInternalList<T> supportedProducts

 
 For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.
 
 
 
 A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently
 supported values are:
 
 
 
 
 "mapr-m3" - launch the job flow using MapR M3 Edition.
 
 
 
 
 "mapr-m5" - launch the job flow using MapR M5 Edition.
 
 
 


newSupportedProducts
SdkInternalList<T> newSupportedProducts

 
 For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, 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" in the Amazon EMR Developer Guide. Supported
 values are:
 
 
 
 
 "mapr-m3" - launch the cluster using MapR M3 Edition.
 
 
 
 
 "mapr-m5" - launch the cluster using MapR M5 Edition.
 
 
 
 
 "mapr" with the user arguments specifying "--edition,m3" or "--edition,m5" - launch the job flow using MapR M3 or
 M5 Edition respectively.
 
 
 
 
 "mapr-m7" - launch the cluster using MapR M7 Edition.
 
 
 
 
 "hunk" - launch the cluster with the Hunk Big Data Analtics Platform.
 
 
 
 
 "hue"- launch the cluster with Hue installed.
 
 
 
 
 "spark" - launch the cluster with Apache Spark installed.
 
 
 
 
 "ganglia" - launch the cluster with the Ganglia Monitoring System installed.
 
 
 


applications
SdkInternalList<T> applications

 Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install
 and configure when launching the cluster. For a list of applications available for each Amazon EMR release
 version, see the Amazon EMR Release Guide.
 


configurations
SdkInternalList<T> configurations

 For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.
 


visibleToAllUsers
Boolean visibleToAllUsers

 A value of true indicates that all IAM users in the AWS account can perform cluster actions if they
 have the proper IAM policy permissions. This is the default. A value of false indicates that only
 the IAM user who created the cluster can perform actions.
 


jobFlowRole
String jobFlowRole

 Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster
 assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you
 must have already created it using the CLI or console.
 


serviceRole
String serviceRole

 The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
 


tags
SdkInternalList<T> tags

 A list of tags to associate with a cluster and propagate to Amazon EC2 instances.
 


securityConfiguration
String securityConfiguration

 The name of a security configuration to apply to the cluster.
 


autoScalingRole
String autoScalingRole

 An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM
 role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an
 instance group.
 


scaleDownBehavior
String scaleDownBehavior

 Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an
 instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at
 the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option
 is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version.
 TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before
 terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR
 removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption.
 TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the
 default for versions of Amazon EMR earlier than 5.1.0.
 


customAmiId
String customAmiId

 Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If
 specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. For more information about custom
 AMIs in Amazon EMR, see Using a Custom AMI in the
 Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the
 ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use AmiVersion instead.
 
 
 For information about creating a custom AMI, see Creating an Amazon EBS-Backed
 Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about
 finding an AMI ID, see Finding
 a Linux AMI.
 


ebsRootVolumeSize
Integer ebsRootVolumeSize

 The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in
 Amazon EMR version 4.x and later.
 


repoUpgradeOnBoot
String repoUpgradeOnBoot

 Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package
 repositories to apply automatically when the instance boots using the AMI. If omitted, the default is
 SECURITY, which indicates that only security updates are applied. If NONE is specified,
 no updates are applied, and all updates must be applied manually.
 


kerberosAttributes
KerberosAttributes kerberosAttributes

 Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For
 more information see Use
 Kerberos Authentication in the EMR Management Guide.
 


stepConcurrencyLevel
Integer stepConcurrencyLevel

 Specifies the number of steps that can be executed concurrently. The default value is 1. The maximum
 value is 256.
 








Class com.amazonaws.services.elasticmapreduce.model.RunJobFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobFlowId
String jobFlowId

 An unique identifier for the job flow.
 


clusterArn
String clusterArn

 The Amazon Resource Name of the cluster.
 








Class com.amazonaws.services.elasticmapreduce.model.ScalingAction extends Object implements Serializable


Serialized Fields


market
String market

 Not available for instance groups. Instance groups use the market type specified for the group.
 


simpleScalingPolicyConfiguration
SimpleScalingPolicyConfiguration simpleScalingPolicyConfiguration

 The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the
 adjustment.
 








Class com.amazonaws.services.elasticmapreduce.model.ScalingConstraints extends Object implements Serializable


Serialized Fields


minCapacity
Integer minCapacity

 The lower boundary of EC2 instances in an instance group below which scaling activities are not allowed to
 shrink. Scale-in activities will not terminate instances below this boundary.
 


maxCapacity
Integer maxCapacity

 The upper boundary of EC2 instances in an instance group beyond which scaling activities are not allowed to grow.
 Scale-out activities will not add instances beyond this boundary.
 








Class com.amazonaws.services.elasticmapreduce.model.ScalingRule extends Object implements Serializable


Serialized Fields


name
String name

 The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.
 


description
String description

 A friendly, more verbose description of the automatic scaling rule.
 


action
ScalingAction action

 The conditions that trigger an automatic scaling activity.
 


trigger
ScalingTrigger trigger

 The CloudWatch alarm definition that determines when automatic scaling activity is triggered.
 








Class com.amazonaws.services.elasticmapreduce.model.ScalingTrigger extends Object implements Serializable


Serialized Fields


cloudWatchAlarmDefinition
CloudWatchAlarmDefinition cloudWatchAlarmDefinition

 The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger
 parameters, scaling activity begins.
 








Class com.amazonaws.services.elasticmapreduce.model.ScriptBootstrapActionConfig extends Object implements Serializable


Serialized Fields


path
String path

 Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file
 system.
 


args
SdkInternalList<T> args

 A list of command line arguments to pass to the bootstrap action script.
 








Class com.amazonaws.services.elasticmapreduce.model.SecurityConfigurationSummary extends Object implements Serializable


Serialized Fields


name
String name

 The name of the security configuration.
 


creationDateTime
Date creationDateTime

 The date and time the security configuration was created.
 








Class com.amazonaws.services.elasticmapreduce.model.SetTerminationProtectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobFlowIds
SdkInternalList<T> jobFlowIds

 A list of strings that uniquely identify the clusters 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 cluster 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.SetVisibleToAllUsersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobFlowIds
SdkInternalList<T> jobFlowIds

 The unique identifier of the job flow (cluster).
 


visibleToAllUsers
Boolean visibleToAllUsers

 A value of true indicates that all IAM users in the AWS account can perform cluster actions if they
 have the proper IAM policy permissions. This is the default. A value of false indicates that only
 the IAM user who created the cluster can perform actions.
 








Class com.amazonaws.services.elasticmapreduce.model.SetVisibleToAllUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.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.SimpleScalingPolicyConfiguration extends Object implements Serializable


Serialized Fields


adjustmentType
String adjustmentType

 The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated
 (if ScalingAdjustment is a negative number) each time the scaling activity is triggered.
 CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance
 count increments or decrements by ScalingAdjustment, which should be expressed as an integer.
 PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage
 specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates
 an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity
 results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which
 should be expressed as a positive integer.
 


scalingAdjustment
Integer scalingAdjustment

 The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive
 value adds to the instance group's EC2 instance count while a negative number removes instances. If
 AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer.
 If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the
 percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.
 


coolDown
Integer coolDown

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








Class com.amazonaws.services.elasticmapreduce.model.SpotProvisioningSpecification extends Object implements Serializable


Serialized Fields


timeoutDurationMinutes
Integer timeoutDurationMinutes

 The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period,
 the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only
 during initial provisioning, when the cluster is first created.
 


timeoutAction
String timeoutAction

 The action to take when TargetSpotCapacity has not been fulfilled when the
 TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within
 the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and
 SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available,
 On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.
 


blockDurationMinutes
Integer blockDurationMinutes

 The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance
 does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies.
 Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives
 its instance ID. At the end of the duration, 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.
 








Class com.amazonaws.services.elasticmapreduce.model.Step extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the cluster step.
 


name
String name

 The name of the cluster step.
 


config
HadoopStepConfig config

 The Hadoop job configuration of the cluster step.
 


actionOnFailure
String actionOnFailure

 The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and
 CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER
 instead.
 


status
StepStatus status

 The current execution status details of the cluster step.
 








Class com.amazonaws.services.elasticmapreduce.model.StepConfig extends Object implements Serializable


Serialized Fields


name
String name

 The name of the step.
 


actionOnFailure
String actionOnFailure

 The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and
 CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER
 instead.
 


hadoopJarStep
HadoopJarStepConfig hadoopJarStep

 The JAR file used for the step.
 








Class com.amazonaws.services.elasticmapreduce.model.StepDetail extends Object implements Serializable


Serialized Fields


stepConfig
StepConfig stepConfig

 The step configuration.
 


executionStatusDetail
StepExecutionStatusDetail executionStatusDetail

 The description of the step status.
 








Class com.amazonaws.services.elasticmapreduce.model.StepExecutionStatusDetail extends Object implements Serializable


Serialized Fields


state
String state

 The state of the step.
 


creationDateTime
Date creationDateTime

 The creation date and time of the step.
 


startDateTime
Date startDateTime

 The start date and time of the step.
 


endDateTime
Date endDateTime

 The completion date and time of the step.
 


lastStateChangeReason
String lastStateChangeReason

 A description of the step's current state.
 








Class com.amazonaws.services.elasticmapreduce.model.StepStateChangeReason extends Object implements Serializable


Serialized Fields


code
String code

 The programmable code for the state change reason. Note: Currently, the service provides no code for the state
 change.
 


message
String message

 The descriptive message for the state change reason.
 








Class com.amazonaws.services.elasticmapreduce.model.StepStatus extends Object implements Serializable


Serialized Fields


state
String state

 The execution state of the cluster step.
 


stateChangeReason
StepStateChangeReason stateChangeReason

 The reason for the step execution status change.
 


failureDetails
FailureDetails failureDetails

 The details for the step failure including reason, message, and log file path where the root cause was
 identified.
 


timeline
StepTimeline timeline

 The timeline of the cluster step status over time.
 








Class com.amazonaws.services.elasticmapreduce.model.StepSummary extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the cluster step.
 


name
String name

 The name of the cluster step.
 


config
HadoopStepConfig config

 The Hadoop job configuration of the cluster step.
 


actionOnFailure
String actionOnFailure

 The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and
 CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility. We recommend using TERMINATE_CLUSTER
 instead.
 


status
StepStatus status

 The current execution status details of the cluster step.
 








Class com.amazonaws.services.elasticmapreduce.model.StepTimeline extends Object implements Serializable


Serialized Fields


creationDateTime
Date creationDateTime

 The date and time when the cluster step was created.
 


startDateTime
Date startDateTime

 The date and time when the cluster step execution started.
 


endDateTime
Date endDateTime

 The date and time when the cluster step execution completed or failed.
 








Class com.amazonaws.services.elasticmapreduce.model.SupportedProductConfig extends Object implements Serializable


Serialized Fields


name
String name

 The name of the product configuration.
 


args
SdkInternalList<T> args

 The list of user-supplied arguments.
 








Class com.amazonaws.services.elasticmapreduce.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag .
 


value
String value

 A user-defined value, which is optional in a tag. For more information, see Tag Clusters.
 








Class com.amazonaws.services.elasticmapreduce.model.TerminateJobFlowsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobFlowIds
SdkInternalList<T> jobFlowIds

 A list of job flows to be shutdown.
 








Class com.amazonaws.services.elasticmapreduce.model.TerminateJobFlowsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.VolumeSpecification extends Object implements Serializable


Serialized Fields


volumeType
String volumeType

 The volume type. Volume types supported are gp2, io1, standard.
 


iops
Integer iops

 The number of I/O operations per second (IOPS) that the volume supports.
 


sizeInGB
Integer sizeInGB

 The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the
 minimum value is 10.
 








Package com.amazonaws.services.elasticmapreduce.spi.security




Class com.amazonaws.services.elasticmapreduce.spi.security.EncryptionMaterials extends Object implements Serializable


Serialized Fields


symmetricKey
SecretKey symmetricKey


description
Map<K,V> description








Package com.amazonaws.services.elasticsearch.model




Class com.amazonaws.services.elasticsearch.model.AccessPoliciesStatus extends Object implements Serializable


Serialized Fields


options
String options

 The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or
 IAM-based. See  Configuring Access Policiesfor more information.
 


status
OptionStatus status

 The status of the access policy for the Elasticsearch domain. See OptionStatus for the status
 information that's included.
 








Class com.amazonaws.services.elasticsearch.model.AdditionalLimit extends Object implements Serializable


Serialized Fields


limitName
String limitName

 Name of Additional Limit is specific to a given InstanceType and for each of it's
  InstanceRole  etc. 

 Attributes and their details: 

 

 MaximumNumberOfDataNodesSupported This attribute will be present in Master node only to specify how much
 data nodes upto which given  ESPartitionInstanceType  can support as master node.
 MaximumNumberOfDataNodesWithoutMasterNode This attribute will be present in Data node only to specify
 how much data nodes of given  ESPartitionInstanceType  upto which you don't need any master
 nodes to govern them.
 
 


limitValues
List<E> limitValues

 Value for given  AdditionalLimit$LimitName  .
 








Class com.amazonaws.services.elasticsearch.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


aRN
String aRN

 Specify the ARN for which you want to add the tags.
 


tagList
List<E> tagList

 List of Tag that need to be added for the Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.AddTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticsearch.model.AdvancedOptionsStatus extends Object implements Serializable


Serialized Fields


options
Map<K,V> options

 Specifies the status of advanced options for the specified Elasticsearch domain.
 


status
OptionStatus status

 Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.AWSElasticsearchException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.BaseException extends AWSElasticsearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.CancelElasticsearchServiceSoftwareUpdateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the domain that you want to stop the latest service software update on.
 








Class com.amazonaws.services.elasticsearch.model.CancelElasticsearchServiceSoftwareUpdateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serviceSoftwareOptions
ServiceSoftwareOptions serviceSoftwareOptions

 The current status of the Elasticsearch service software update.
 








Class com.amazonaws.services.elasticsearch.model.CognitoOptions extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specifies the option to enable Cognito for Kibana authentication.
 


userPoolId
String userPoolId

 Specifies the Cognito user pool ID for Kibana authentication.
 


identityPoolId
String identityPoolId

 Specifies the Cognito identity pool ID for Kibana authentication.
 


roleArn
String roleArn

 Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
 








Class com.amazonaws.services.elasticsearch.model.CognitoOptionsStatus extends Object implements Serializable


Serialized Fields


options
CognitoOptions options

 Specifies the Cognito options for the specified Elasticsearch domain.
 


status
OptionStatus status

 Specifies the status of the Cognito options for the specified Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.CompatibleVersionsMap extends Object implements Serializable


Serialized Fields


sourceVersion
String sourceVersion

 The current version of Elasticsearch on which a domain is.
 


targetVersions
List<E> targetVersions








Class com.amazonaws.services.elasticsearch.model.CreateElasticsearchDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by
 an account within an AWS region. Domain names must start with a lowercase letter and can contain the following
 characters: a-z (lowercase), 0-9, and - (hyphen).
 


elasticsearchVersion
String elasticsearchVersion

 String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information,
 see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
 


elasticsearchClusterConfig
ElasticsearchClusterConfig elasticsearchClusterConfig

 Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the
 domain cluster.
 


eBSOptions
EBSOptions eBSOptions

 Options to enable, disable and specify the type and size of EBS storage volumes.
 


accessPolicies
String accessPolicies

 IAM access policy as a JSON-formatted string.
 


snapshotOptions
SnapshotOptions snapshotOptions

 Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
 


vPCOptions
VPCOptions vPCOptions

 Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains
 


cognitoOptions
CognitoOptions cognitoOptions

 Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
 


encryptionAtRestOptions
EncryptionAtRestOptions encryptionAtRestOptions

 Specifies the Encryption At Rest Options.
 


nodeToNodeEncryptionOptions
NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions

 Specifies the NodeToNodeEncryptionOptions.
 


advancedOptions
Map<K,V> advancedOptions

 Option to allow references to indices in an HTTP request body. Must be false when configuring access
 to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
 


logPublishingOptions
Map<K,V> logPublishingOptions

 Map of LogType and LogPublishingOption, each containing options to publish a given type
 of Elasticsearch log.
 


domainEndpointOptions
DomainEndpointOptions domainEndpointOptions

 Options to specify configuration that will be applied to the domain endpoint.
 








Class com.amazonaws.services.elasticsearch.model.CreateElasticsearchDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainStatus
ElasticsearchDomainStatus domainStatus

 The status of the newly created Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.DeleteElasticsearchDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the Elasticsearch domain that you want to permanently delete.
 








Class com.amazonaws.services.elasticsearch.model.DeleteElasticsearchDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainStatus
ElasticsearchDomainStatus domainStatus

 The status of the Elasticsearch domain being deleted.
 








Class com.amazonaws.services.elasticsearch.model.DeleteElasticsearchServiceRoleRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.elasticsearch.model.DeleteElasticsearchServiceRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The Elasticsearch domain that you want to get information about.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainConfig
ElasticsearchDomainConfig domainConfig

 The configuration information of the domain requested in the DescribeElasticsearchDomainConfig
 request.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the Elasticsearch domain for which you want information.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainStatus
ElasticsearchDomainStatus domainStatus

 The current status of the Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainNames
List<E> domainNames

 The Elasticsearch domains for which you want information.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainStatusList
List<E> domainStatusList

 The status of the domains requested in the DescribeElasticsearchDomains request.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchInstanceTypeLimitsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are
 querying for Elasticsearch  Limits  for existing domain.
 


instanceType
String instanceType

 The instance type for an Elasticsearch cluster for which Elasticsearch  Limits  are needed.
 


elasticsearchVersion
String elasticsearchVersion

 Version of Elasticsearch for which  Limits  are needed.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchInstanceTypeLimitsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


limitsByRole
Map<K,V> limitsByRole








Class com.amazonaws.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reservedElasticsearchInstanceOfferingId
String reservedElasticsearchInstanceOfferingId

 The offering identifier filter value. Use this parameter to show only the available offering that matches the
 specified reservation identifier.
 


maxResults
Integer maxResults

 Set this value to limit the number of results returned. If not specified, defaults to 100.
 


nextToken
String nextToken

 NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for
 pagination.
 








Class com.amazonaws.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 Provides an identifier to allow retrieval of paginated results.
 


reservedElasticsearchInstanceOfferings
List<E> reservedElasticsearchInstanceOfferings

 List of reserved Elasticsearch instance offerings
 








Class com.amazonaws.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reservedElasticsearchInstanceId
String reservedElasticsearchInstanceId

 The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the
 specified reserved Elasticsearch instance ID.
 


maxResults
Integer maxResults

 Set this value to limit the number of results returned. If not specified, defaults to 100.
 


nextToken
String nextToken

 NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for
 pagination.
 








Class com.amazonaws.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 Provides an identifier to allow retrieval of paginated results.
 


reservedElasticsearchInstances
List<E> reservedElasticsearchInstances

 List of reserved Elasticsearch instances.
 








Class com.amazonaws.services.elasticsearch.model.DisabledOperationException extends AWSElasticsearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.DomainEndpointOptions extends Object implements Serializable


Serialized Fields


enforceHTTPS
Boolean enforceHTTPS

 Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
 


tLSSecurityPolicy
String tLSSecurityPolicy

 Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. 

 It can be one of the following values:
 

 Policy-Min-TLS-1-0-2019-07:  TLS security policy which supports TLSv1.0 and higher.
 Policy-Min-TLS-1-2-2019-07:  TLS security policy which supports only TLSv1.2
 
 








Class com.amazonaws.services.elasticsearch.model.DomainEndpointOptionsStatus extends Object implements Serializable


Serialized Fields


options
DomainEndpointOptions options

 Options to configure endpoint for the Elasticsearch domain.
 


status
OptionStatus status

 The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status
 information that's included.
 








Class com.amazonaws.services.elasticsearch.model.DomainInfo extends Object implements Serializable


Serialized Fields


domainName
String domainName

 Specifies the DomainName.
 








Class com.amazonaws.services.elasticsearch.model.EBSOptions extends Object implements Serializable


Serialized Fields


eBSEnabled
Boolean eBSEnabled

 Specifies whether EBS-based storage is enabled.
 


volumeType
String volumeType

 Specifies the volume type for EBS-based storage.
 


volumeSize
Integer volumeSize

 Integer to specify the size of an EBS volume.
 


iops
Integer iops

 Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
 








Class com.amazonaws.services.elasticsearch.model.EBSOptionsStatus extends Object implements Serializable


Serialized Fields


options
EBSOptions options

 Specifies the EBS options for the specified Elasticsearch domain.
 


status
OptionStatus status

 Specifies the status of the EBS options for the specified Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.ElasticsearchClusterConfig extends Object implements Serializable


Serialized Fields


instanceType
String instanceType

 The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
 


instanceCount
Integer instanceCount

 The number of instances in the specified domain cluster.
 


dedicatedMasterEnabled
Boolean dedicatedMasterEnabled

 A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
 


zoneAwarenessEnabled
Boolean zoneAwarenessEnabled

 A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
 


zoneAwarenessConfig
ZoneAwarenessConfig zoneAwarenessConfig

 Specifies the zone awareness configuration for a domain when zone awareness is enabled.
 


dedicatedMasterType
String dedicatedMasterType

 The instance type for a dedicated master node.
 


dedicatedMasterCount
Integer dedicatedMasterCount

 Total number of dedicated master nodes, active and on standby, for the cluster.
 


warmEnabled
Boolean warmEnabled

 True to enable warm storage.
 


warmType
String warmType

 The instance type for the Elasticsearch cluster's warm nodes.
 


warmCount
Integer warmCount

 The number of warm nodes in the cluster.
 








Class com.amazonaws.services.elasticsearch.model.ElasticsearchClusterConfigStatus extends Object implements Serializable


Serialized Fields


options
ElasticsearchClusterConfig options

 Specifies the cluster configuration for the specified Elasticsearch domain.
 


status
OptionStatus status

 Specifies the status of the configuration for the specified Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.ElasticsearchDomainConfig extends Object implements Serializable


Serialized Fields


elasticsearchVersion
ElasticsearchVersionStatus elasticsearchVersion

 String of format X.Y to specify version for the Elasticsearch domain.
 


elasticsearchClusterConfig
ElasticsearchClusterConfigStatus elasticsearchClusterConfig

 Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.
 


eBSOptions
EBSOptionsStatus eBSOptions

 Specifies the EBSOptions for the Elasticsearch domain.
 


accessPolicies
AccessPoliciesStatus accessPolicies

 IAM access policy as a JSON-formatted string.
 


snapshotOptions
SnapshotOptionsStatus snapshotOptions

 Specifies the SnapshotOptions for the Elasticsearch domain.
 


vPCOptions
VPCDerivedInfoStatus vPCOptions

 The VPCOptions for the specified domain. For more information, see VPC
 Endpoints for Amazon Elasticsearch Service Domains.
 


cognitoOptions
CognitoOptionsStatus cognitoOptions

 The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.
 


encryptionAtRestOptions
EncryptionAtRestOptionsStatus encryptionAtRestOptions

 Specifies the EncryptionAtRestOptions for the Elasticsearch domain.
 


nodeToNodeEncryptionOptions
NodeToNodeEncryptionOptionsStatus nodeToNodeEncryptionOptions

 Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.
 


advancedOptions
AdvancedOptionsStatus advancedOptions

 Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.
 


logPublishingOptions
LogPublishingOptionsStatus logPublishingOptions

 Log publishing options for the given domain.
 


domainEndpointOptions
DomainEndpointOptionsStatus domainEndpointOptions

 Specifies the DomainEndpointOptions for the Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.ElasticsearchDomainStatus extends Object implements Serializable


Serialized Fields


domainId
String domainId

 The unique identifier for the specified Elasticsearch domain.
 


domainName
String domainName

 The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS
 region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase),
 0-9, and - (hyphen).
 


aRN
String aRN

 The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more
 information.
 


created
Boolean created

 The domain creation status. True if the creation of an Elasticsearch domain is complete.
 False if domain creation is still in progress.
 


deleted
Boolean deleted

 The domain deletion status. True if a delete request has been received for the domain but resource
 cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is
 complete, the status of the domain is no longer returned.
 


endpoint
String endpoint

 The Elasticsearch domain endpoint that you use to submit index and search requests.
 


endpoints
Map<K,V> endpoints

 Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example
 key, value:
 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
 


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.
 


upgradeProcessing
Boolean upgradeProcessing

 The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is
 undergoing a version upgrade. False if the configuration is active.
 


elasticsearchVersion
String elasticsearchVersion


elasticsearchClusterConfig
ElasticsearchClusterConfig elasticsearchClusterConfig

 The type and number of instances in the domain cluster.
 


eBSOptions
EBSOptions eBSOptions

 The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.
 


accessPolicies
String accessPolicies

 IAM access policy as a JSON-formatted string.
 


snapshotOptions
SnapshotOptions snapshotOptions

 Specifies the status of the SnapshotOptions
 


vPCOptions
VPCDerivedInfo vPCOptions

 The VPCOptions for the specified domain. For more information, see VPC
 Endpoints for Amazon Elasticsearch Service Domains.
 


cognitoOptions
CognitoOptions cognitoOptions

 The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.
 


encryptionAtRestOptions
EncryptionAtRestOptions encryptionAtRestOptions

 Specifies the status of the EncryptionAtRestOptions.
 


nodeToNodeEncryptionOptions
NodeToNodeEncryptionOptions nodeToNodeEncryptionOptions

 Specifies the status of the NodeToNodeEncryptionOptions.
 


advancedOptions
Map<K,V> advancedOptions

 Specifies the status of the AdvancedOptions
 


logPublishingOptions
Map<K,V> logPublishingOptions

 Log publishing options for the given domain.
 


serviceSoftwareOptions
ServiceSoftwareOptions serviceSoftwareOptions

 The current status of the Elasticsearch domain's service software.
 


domainEndpointOptions
DomainEndpointOptions domainEndpointOptions

 The current status of the Elasticsearch domain's endpoint options.
 








Class com.amazonaws.services.elasticsearch.model.ElasticsearchVersionStatus extends Object implements Serializable


Serialized Fields


options
String options

 Specifies the Elasticsearch version for the specified Elasticsearch domain.
 


status
OptionStatus status

 Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.EncryptionAtRestOptions extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specifies the option to enable Encryption At Rest.
 


kmsKeyId
String kmsKeyId

 Specifies the KMS Key ID for Encryption At Rest options.
 








Class com.amazonaws.services.elasticsearch.model.EncryptionAtRestOptionsStatus extends Object implements Serializable


Serialized Fields


options
EncryptionAtRestOptions options

 Specifies the Encryption At Rest options for the specified Elasticsearch domain.
 


status
OptionStatus status

 Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.GetCompatibleElasticsearchVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName








Class com.amazonaws.services.elasticsearch.model.GetCompatibleElasticsearchVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


compatibleElasticsearchVersions
List<E> compatibleElasticsearchVersions

 A map of compatible Elasticsearch versions returned as part of the
  GetCompatibleElasticsearchVersions  operation.
 








Class com.amazonaws.services.elasticsearch.model.GetUpgradeHistoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName


maxResults
Integer maxResults


nextToken
String nextToken








Class com.amazonaws.services.elasticsearch.model.GetUpgradeHistoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


upgradeHistories
List<E> upgradeHistories

 A list of  UpgradeHistory  objects corresponding to each Upgrade or Upgrade Eligibility Check
 performed on a domain returned as part of  GetUpgradeHistoryResponse  object.
 


nextToken
String nextToken

 Pagination token that needs to be supplied to the next call to get the next page of results
 








Class com.amazonaws.services.elasticsearch.model.GetUpgradeStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName








Class com.amazonaws.services.elasticsearch.model.GetUpgradeStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


upgradeStep
String upgradeStep

 Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
 

 PreUpgradeCheck
 Snapshot
 Upgrade
 
 


stepStatus
String stepStatus

 One of 4 statuses that a step can go through returned as part of the
  GetUpgradeStatusResponse  object. The status can take one of the following values:
 

 In Progress
 Succeeded
 Succeeded with Issues
 Failed
 
 


upgradeName
String upgradeName

 A string that describes the update briefly
 








Class com.amazonaws.services.elasticsearch.model.InstanceCountLimits extends Object implements Serializable


Serialized Fields


minimumInstanceCount
Integer minimumInstanceCount


maximumInstanceCount
Integer maximumInstanceCount








Class com.amazonaws.services.elasticsearch.model.InstanceLimits extends Object implements Serializable


Serialized Fields


instanceCountLimits
InstanceCountLimits instanceCountLimits








Class com.amazonaws.services.elasticsearch.model.InternalException extends AWSElasticsearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.InvalidTypeException extends AWSElasticsearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.LimitExceededException extends AWSElasticsearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.Limits extends Object implements Serializable


Serialized Fields


storageTypes
List<E> storageTypes

 StorageType represents the list of storage related types and attributes that are available for given
 InstanceType.
 


instanceLimits
InstanceLimits instanceLimits


additionalLimits
List<E> additionalLimits

 List of additional limits that are specific to a given InstanceType and for each of it's
  InstanceRole  .
 








Class com.amazonaws.services.elasticsearch.model.ListDomainNamesRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.elasticsearch.model.ListDomainNamesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainNames
List<E> domainNames

 List of Elasticsearch domain names.
 








Class com.amazonaws.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


elasticsearchVersion
String elasticsearchVersion

 Version of Elasticsearch for which list of supported elasticsearch instance types are needed.
 


domainName
String domainName

 DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are
 querying for list of available Elasticsearch instance types when modifying existing domain.
 


maxResults
Integer maxResults

 Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be
 honored.
 


nextToken
String nextToken

 NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for
 pagination.
 








Class com.amazonaws.services.elasticsearch.model.ListElasticsearchInstanceTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


elasticsearchInstanceTypes
List<E> elasticsearchInstanceTypes

 List of instance types supported by Amazon Elasticsearch service for given
  ElasticsearchVersion 
 


nextToken
String nextToken

 In case if there are more results available NextToken would be present, make further request to the same API with
 received NextToken to paginate remaining results.
 








Class com.amazonaws.services.elasticsearch.model.ListElasticsearchVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be
 honored.
 


nextToken
String nextToken








Class com.amazonaws.services.elasticsearch.model.ListElasticsearchVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


elasticsearchVersions
List<E> elasticsearchVersions


nextToken
String nextToken








Class com.amazonaws.services.elasticsearch.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


aRN
String aRN

 Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.
 








Class com.amazonaws.services.elasticsearch.model.ListTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagList
List<E> tagList

 List of Tag for the requested Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.LogPublishingOption extends Object implements Serializable


Serialized Fields


cloudWatchLogsLogGroupArn
String cloudWatchLogsLogGroupArn


enabled
Boolean enabled

 Specifies whether given log publishing option is enabled or not.
 








Class com.amazonaws.services.elasticsearch.model.LogPublishingOptionsStatus extends Object implements Serializable


Serialized Fields


options
Map<K,V> options

 The log publishing options configured for the Elasticsearch domain.
 


status
OptionStatus status

 The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the
 status information that's included.
 








Class com.amazonaws.services.elasticsearch.model.NodeToNodeEncryptionOptions extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Specify true to enable node-to-node encryption.
 








Class com.amazonaws.services.elasticsearch.model.NodeToNodeEncryptionOptionsStatus extends Object implements Serializable


Serialized Fields


options
NodeToNodeEncryptionOptions options

 Specifies the node-to-node encryption options for the specified Elasticsearch domain.
 


status
OptionStatus status

 Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.OptionStatus extends Object implements Serializable


Serialized Fields


creationDate
Date creationDate

 Timestamp which tells the creation date for the entity.
 


updateDate
Date updateDate

 Timestamp which tells the last updated time for the entity.
 


updateVersion
Integer updateVersion

 Specifies the latest version for the entity.
 


state
String state

 Provides the OptionState for the Elasticsearch domain.
 


pendingDeletion
Boolean pendingDeletion

 Indicates whether the Elasticsearch domain is being deleted.
 








Class com.amazonaws.services.elasticsearch.model.PurchaseReservedElasticsearchInstanceOfferingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reservedElasticsearchInstanceOfferingId
String reservedElasticsearchInstanceOfferingId

 The ID of the reserved Elasticsearch instance offering to purchase.
 


reservationName
String reservationName

 A customer-specified identifier to track this reservation.
 


instanceCount
Integer instanceCount

 The number of Elasticsearch instances to reserve.
 








Class com.amazonaws.services.elasticsearch.model.PurchaseReservedElasticsearchInstanceOfferingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservedElasticsearchInstanceId
String reservedElasticsearchInstanceId

 Details of the reserved Elasticsearch instance which was purchased.
 


reservationName
String reservationName

 The customer-specified identifier used to track this reservation.
 








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


Serialized Fields


recurringChargeAmount
Double recurringChargeAmount

 The monetary amount of the recurring charge.
 


recurringChargeFrequency
String recurringChargeFrequency

 The frequency of the recurring charge.
 








Class com.amazonaws.services.elasticsearch.model.RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


aRN
String aRN

 Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.
 


tagKeys
List<E> tagKeys

 Specifies the TagKey list which you want to remove from the Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.RemoveTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elasticsearch.model.ReservedElasticsearchInstance extends Object implements Serializable


Serialized Fields


reservationName
String reservationName

 The customer-specified identifier to track this reservation.
 


reservedElasticsearchInstanceId
String reservedElasticsearchInstanceId

 The unique identifier for the reservation.
 


reservedElasticsearchInstanceOfferingId
String reservedElasticsearchInstanceOfferingId

 The offering identifier.
 


elasticsearchInstanceType
String elasticsearchInstanceType

 The Elasticsearch instance type offered by the reserved instance offering.
 


startTime
Date startTime

 The time the reservation started.
 


duration
Integer duration

 The duration, in seconds, for which the Elasticsearch instance is reserved.
 


fixedPrice
Double fixedPrice

 The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.
 


usagePrice
Double usagePrice

 The rate you are charged for each hour for the domain that is using this reserved instance.
 


currencyCode
String currencyCode

 The currency code for the reserved Elasticsearch instance offering.
 


elasticsearchInstanceCount
Integer elasticsearchInstanceCount

 The number of Elasticsearch instances that have been reserved.
 


state
String state

 The state of the reserved Elasticsearch instance.
 


paymentOption
String paymentOption

 The payment option as defined in the reserved Elasticsearch instance offering.
 


recurringCharges
List<E> recurringCharges

 The charge to your account regardless of whether you are creating any domains using the instance offering.
 








Class com.amazonaws.services.elasticsearch.model.ReservedElasticsearchInstanceOffering extends Object implements Serializable


Serialized Fields


reservedElasticsearchInstanceOfferingId
String reservedElasticsearchInstanceOfferingId

 The Elasticsearch reserved instance offering identifier.
 


elasticsearchInstanceType
String elasticsearchInstanceType

 The Elasticsearch instance type offered by the reserved instance offering.
 


duration
Integer duration

 The duration, in seconds, for which the offering will reserve the Elasticsearch instance.
 


fixedPrice
Double fixedPrice

 The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.
 


usagePrice
Double usagePrice

 The rate you are charged for each hour the domain that is using the offering is running.
 


currencyCode
String currencyCode

 The currency code for the reserved Elasticsearch instance offering.
 


paymentOption
String paymentOption

 Payment option for the reserved Elasticsearch instance offering
 


recurringCharges
List<E> recurringCharges

 The charge to your account regardless of whether you are creating any domains using the instance offering.
 








Class com.amazonaws.services.elasticsearch.model.ResourceAlreadyExistsException extends AWSElasticsearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.ResourceNotFoundException extends AWSElasticsearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.ServiceSoftwareOptions extends Object implements Serializable


Serialized Fields


currentVersion
String currentVersion

 The current service software version that is present on the domain.
 


newVersion
String newVersion

 The new service software version if one is available.
 


updateAvailable
Boolean updateAvailable

 True if you are able to update you service software version. False if you are not able
 to update your service software version.
 


cancellable
Boolean cancellable

 True if you are able to cancel your service software version update. False if you are
 not able to cancel your service software version.
 


updateStatus
String updateStatus

 The status of your service software update. This field can take the following values: ELIGIBLE,
 PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.
 


description
String description

 The description of the UpdateStatus.
 


automatedUpdateDate
Date automatedUpdateDate

 Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we
 automatically update your service software.
 








Class com.amazonaws.services.elasticsearch.model.SnapshotOptions extends Object implements Serializable


Serialized Fields


automatedSnapshotStartHour
Integer automatedSnapshotStartHour

 Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified
 Elasticsearch domain. Default value is 0 hours.
 








Class com.amazonaws.services.elasticsearch.model.SnapshotOptionsStatus extends Object implements Serializable


Serialized Fields


options
SnapshotOptions options

 Specifies the daily snapshot options specified for the Elasticsearch domain.
 


status
OptionStatus status

 Specifies the status of a daily automated snapshot.
 








Class com.amazonaws.services.elasticsearch.model.StartElasticsearchServiceSoftwareUpdateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the domain that you want to update to the latest service software.
 








Class com.amazonaws.services.elasticsearch.model.StartElasticsearchServiceSoftwareUpdateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serviceSoftwareOptions
ServiceSoftwareOptions serviceSoftwareOptions

 The current status of the Elasticsearch service software update.
 








Class com.amazonaws.services.elasticsearch.model.StorageType extends Object implements Serializable


Serialized Fields


storageTypeName
String storageTypeName


storageSubTypeName
String storageSubTypeName


storageTypeLimits
List<E> storageTypeLimits

 List of limits that are applicable for given storage type.
 








Class com.amazonaws.services.elasticsearch.model.StorageTypeLimit extends Object implements Serializable


Serialized Fields


limitName
String limitName

 Name of storage limits that are applicable for given storage type. If  StorageType  is ebs,
 following storage options are applicable
 

 MinimumVolumeSize Minimum amount of volume size that is applicable for given storage type.It can be
 empty if it is not applicable.
 MaximumVolumeSize Maximum amount of volume size that is applicable for given storage type.It can be
 empty if it is not applicable.
 MaximumIops Maximum amount of Iops that is applicable for given storage type.It can be empty if it is
 not applicable.
 MinimumIops Minimum amount of Iops that is applicable for given storage type.It can be empty if it is
 not applicable.
 
 


limitValues
List<E> limitValues

 Values for the  StorageTypeLimit$LimitName  .
 








Class com.amazonaws.services.elasticsearch.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to
 which they are attached.
 


value
String value

 Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and
 do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of
 project : Trinity and cost-center : Trinity
 








Class com.amazonaws.services.elasticsearch.model.UpdateElasticsearchDomainConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the Elasticsearch domain that you are updating.
 


elasticsearchClusterConfig
ElasticsearchClusterConfig elasticsearchClusterConfig

 The type and number of instances to instantiate for the domain cluster.
 


eBSOptions
EBSOptions eBSOptions

 Specify the type and size of the EBS volume that you want to use.
 


snapshotOptions
SnapshotOptions snapshotOptions

 Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
 


vPCOptions
VPCOptions vPCOptions

 Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains
 


cognitoOptions
CognitoOptions cognitoOptions

 Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
 


advancedOptions
Map<K,V> advancedOptions

 Modifies the advanced option to allow references to indices in an HTTP request body. Must be false
 when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
 


accessPolicies
String accessPolicies

 IAM access policy as a JSON-formatted string.
 


logPublishingOptions
Map<K,V> logPublishingOptions

 Map of LogType and LogPublishingOption, each containing options to publish a given type
 of Elasticsearch log.
 


domainEndpointOptions
DomainEndpointOptions domainEndpointOptions

 Options to specify configuration that will be applied to the domain endpoint.
 








Class com.amazonaws.services.elasticsearch.model.UpdateElasticsearchDomainConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainConfig
ElasticsearchDomainConfig domainConfig

 The status of the updated Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.UpgradeElasticsearchDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName


targetVersion
String targetVersion

 The version of Elasticsearch that you intend to upgrade the domain to.
 


performCheckOnly
Boolean performCheckOnly

 This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not
 actually perform the Upgrade.
 








Class com.amazonaws.services.elasticsearch.model.UpgradeElasticsearchDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainName
String domainName


targetVersion
String targetVersion

 The version of Elasticsearch that you intend to upgrade the domain to.
 


performCheckOnly
Boolean performCheckOnly

 This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not
 actually perform the Upgrade.
 








Class com.amazonaws.services.elasticsearch.model.UpgradeHistory extends Object implements Serializable


Serialized Fields


upgradeName
String upgradeName

 A string that describes the update briefly
 


startTimestamp
Date startTimestamp

 UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
 


upgradeStatus
String upgradeStatus

 The overall status of the update. The status can take one of the following values:
 

 In Progress
 Succeeded
 Succeeded with Issues
 Failed
 
 


stepsList
List<E> stepsList

 A list of  UpgradeStepItem  s representing information about each step performed as pard of a
 specific Upgrade or Upgrade Eligibility Check.
 








Class com.amazonaws.services.elasticsearch.model.UpgradeStepItem extends Object implements Serializable


Serialized Fields


upgradeStep
String upgradeStep

 Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
 

 PreUpgradeCheck
 Snapshot
 Upgrade
 
 


upgradeStepStatus
String upgradeStepStatus

 The status of a particular step during an upgrade. The status can take one of the following values:
 

 In Progress
 Succeeded
 Succeeded with Issues
 Failed
 
 


issues
List<E> issues

 A list of strings containing detailed information about the errors encountered in a particular step.
 


progressPercent
Double progressPercent

 The Floating point value representing progress percentage of a particular step.
 








Class com.amazonaws.services.elasticsearch.model.ValidationException extends AWSElasticsearchException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.VPCDerivedInfo extends Object implements Serializable


Serialized Fields


vPCId
String vPCId

 The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
 


subnetIds
List<E> subnetIds

 Specifies the subnets for VPC endpoint.
 


availabilityZones
List<E> availabilityZones

 The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
 


securityGroupIds
List<E> securityGroupIds

 Specifies the security groups for VPC endpoint.
 








Class com.amazonaws.services.elasticsearch.model.VPCDerivedInfoStatus extends Object implements Serializable


Serialized Fields


options
VPCDerivedInfo options

 Specifies the VPC options for the specified Elasticsearch domain.
 


status
OptionStatus status

 Specifies the status of the VPC options for the specified Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.VPCOptions extends Object implements Serializable


Serialized Fields


subnetIds
List<E> subnetIds

 Specifies the subnets for VPC endpoint.
 


securityGroupIds
List<E> securityGroupIds

 Specifies the security groups for VPC endpoint.
 








Class com.amazonaws.services.elasticsearch.model.ZoneAwarenessConfig extends Object implements Serializable


Serialized Fields


availabilityZoneCount
Integer availabilityZoneCount

 An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This
 should be equal to number of subnets if VPC endpoints is enabled
 








Package com.amazonaws.services.elastictranscoder.model




Class com.amazonaws.services.elastictranscoder.model.AccessDeniedException extends AmazonElasticTranscoderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.AmazonElasticTranscoderException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.Artwork extends Object implements Serializable


Serialized Fields


inputKey
String inputKey

 The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file,
 Elastic Transcoder checks the pipeline specified by PipelineId; the InputBucket object
 in that pipeline identifies the bucket.
 
 
 If the file name includes a prefix, for example, cooking/pie.jpg, include the prefix in the key. If
 the file isn't in the specified bucket, Elastic Transcoder returns an error.
 


maxWidth
String maxWidth

 The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder uses
 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.
 


maxHeight
String maxHeight

 The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder uses
 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.
 


sizingPolicy
String sizingPolicy

 Specify one of the following values to control scaling of the output album art:
 
 
 
 
 Fit: Elastic Transcoder scales the output art so it matches the value that you specified in either
 MaxWidth or MaxHeight without exceeding the other value.
 
 
 
 
 Fill: Elastic Transcoder scales the output art so it matches the value that you specified in either
 MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder
 centers the output art and then crops it in the dimension (if any) that exceeds the maximum value.
 
 
 
 
 Stretch: Elastic Transcoder stretches the output art to match the values that you specified for
 MaxWidth and MaxHeight. If the relative proportions of the input art and the output art
 are different, the output art will be distorted.
 
 
 
 
 Keep: Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds
 the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the
 output art.
 
 
 
 
 ShrinkToFit: Elastic Transcoder scales the output art down so that its dimensions match the values
 that you specified for at least one of MaxWidth and MaxHeight without exceeding either
 value. If you specify this option, Elastic Transcoder does not scale the art up.
 
 
 
 
 ShrinkToFill Elastic Transcoder scales the output art down so that its dimensions match the values
 that you specified for at least one of MaxWidth and MaxHeight without dropping below
 either value. If you specify this option, Elastic Transcoder does not scale the art up.
 
 
 


paddingPolicy
String paddingPolicy

 When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the top and
 bottom and/or left and right sides of the output album art to make the total size of the output art match the
 values that you specified for MaxWidth and MaxHeight.
 


albumArtFormat
String albumArtFormat

 The format of album art, if any. Valid formats are .jpg and .png.
 


encryption
Encryption encryption

 The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.
 








Class com.amazonaws.services.elastictranscoder.model.AudioCodecOptions extends Object implements Serializable


Serialized Fields


profile
String profile

 You can only choose an audio profile when you specify AAC for the value of Audio:Codec.
 
 
 Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:
 
 
 
 
 auto: If you specify auto, Elastic Transcoder selects the profile based on the bit rate
 selected for the output file.
 
 
 
 
 AAC-LC: The most common AAC profile. Use for bit rates larger than 64 kbps.
 
 
 
 
 HE-AAC: Not supported on some older players and devices. Use for bit rates between 40 and 80 kbps.
 
 
 
 
 HE-AACv2: Not supported on some players and devices. Use for bit rates less than 48 kbps.
 
 
 
 
 All outputs in a Smooth playlist must have the same value for Profile.
 
 
 
 If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets
 to use AAC-LC. You can change the value as required.
 
 


bitDepth
String bitDepth

 You can only choose an audio bit depth when you specify flac or pcm for the value of
 Audio:Codec.
 
 
 The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit
 depth, the better the audio, but the larger the file.
 
 
 Valid values are 16 and 24.
 
 
 The most common bit depth is 24.
 


bitOrder
String bitOrder

 You can only choose an audio bit order when you specify pcm for the value of Audio:Codec.
 
 
 The order the bits of a PCM sample are stored in.
 
 
 The supported value is LittleEndian.
 


signed
String signed

 You can only choose whether an audio sample is signed when you specify pcm for the value of
 Audio:Codec.
 
 
 Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers
 (unsigned).
 
 
 The supported value is Signed.
 








Class com.amazonaws.services.elastictranscoder.model.AudioParameters extends Object implements Serializable


Serialized Fields


codec
String codec

 The audio codec for the output file. Valid values include aac, flac, mp2,
 mp3, pcm, and vorbis.
 


sampleRate
String sampleRate

 The sample rate of the audio stream in the output file, in Hertz. Valid values include:
 
 
 auto, 22050, 32000, 44100, 48000,
 96000
 
 
 If you specify auto, Elastic Transcoder automatically detects the sample rate.
 


bitRate
String bitRate

 The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320,
 inclusive.
 


channels
String channels

 The number of audio channels in the output file. The following values are valid:
 
 
 auto, 0, 1, 2
 
 
 One channel carries the information played by a single speaker. For example, a stereo track with two channels
 sends one channel to the left speaker, and the other channel to the right speaker. The output channels are
 organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the
 input file and use that value for the output file, select auto.
 
 
 The output of a specific channel value and inputs are as follows:
 
 
 
 
 auto  channel specified, with any input: Pass through up to eight input channels.
 
 
 
 
 0  channels specified, with any input: Audio omitted from the output.
 
 
 
 
 1  channel specified, with at least one input channel: Mono sound.
 
 
 
 
 2  channels specified, with any input: Two identical mono channels or stereo. For more
 information about tracks, see Audio:AudioPackingMode.
 
 
 
 
 For more information about how Elastic Transcoder organizes channels and tracks, see
 Audio:AudioPackingMode.
 


audioPackingMode
String audioPackingMode

 The method of organizing audio channels and tracks. Use Audio:Channels to specify the number of
 channels in your output, and Audio:AudioPackingMode to specify the number of tracks and their
 relation to the channels. If you do not specify an Audio:AudioPackingMode, Elastic Transcoder uses
 SingleTrack.
 
 
 The following values are valid:
 
 
 SingleTrack, OneChannelPerTrack, and OneChannelPerTrackWithMosTo8Tracks
 
 
 When you specify SingleTrack, Elastic Transcoder creates a single track for your output. The track
 can have up to eight channels. Use SingleTrack for all non-mxf containers.
 
 
 The outputs of SingleTrack for a specific channel value and inputs are as follows:
 
 
 
 
 0  channels with any input: Audio omitted from the output
 
 
 
 
 1, 2, or auto  channels with no audio input: Audio omitted from the output
 
 
 
 
 1  channel with any input with audio: One track with one channel, downmixed if necessary
 
 
 
 
 2  channels with one track with one channel: One track with two identical channels
 
 
 
 
 2 or auto  channels with two tracks with one channel each: One track with two channels
 
 
 
 
 2 or auto  channels with one track with two channels: One track with two channels
 
 
 
 
 2  channels with one track with multiple channels: One track with two channels
 
 
 
 
 auto  channels with one track with one channel: One track with one channel
 
 
 
 
 auto  channels with one track with multiple channels: One track with multiple channels
 
 
 
 
 When you specify OneChannelPerTrack, Elastic Transcoder creates a new track for every channel in
 your output. Your output can have up to eight single-channel tracks.
 
 
 The outputs of OneChannelPerTrack for a specific channel value and inputs are as follows:
 
 
 
 
 0  channels with any input: Audio omitted from the output
 
 
 
 
 1, 2, or auto  channels with no audio input: Audio omitted from the output
 
 
 
 
 1  channel with any input with audio: One track with one channel, downmixed if necessary
 
 
 
 
 2  channels with one track with one channel: Two tracks with one identical channel each
 
 
 
 
 2 or auto  channels with two tracks with one channel each: Two tracks with one channel each
 
 
 
 
 2 or auto  channels with one track with two channels: Two tracks with one channel each
 
 
 
 
 2  channels with one track with multiple channels: Two tracks with one channel each
 
 
 
 
 auto  channels with one track with one channel: One track with one channel
 
 
 
 
 auto  channels with one track with multiple channels: Up to eight tracks with one channel
 each
 
 
 
 
 When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder creates eight single-channel
 tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out
 Sound, tracks.
 
 
 The outputs of OneChannelPerTrackWithMosTo8Tracks for a specific channel value and inputs are as
 follows:
 
 
 
 
 0  channels with any input: Audio omitted from the output
 
 
 
 
 1, 2, or auto  channels with no audio input: Audio omitted from the output
 
 
 
 
 1  channel with any input with audio: One track with one channel, downmixed if necessary,
 plus six MOS tracks
 
 
 
 
 2  channels with one track with one channel: Two tracks with one identical channel each, plus
 six MOS tracks
 
 
 
 
 2 or auto  channels with two tracks with one channel each: Two tracks with one channel each,
 plus six MOS tracks
 
 
 
 
 2 or auto  channels with one track with two channels: Two tracks with one channel each, plus
 six MOS tracks
 
 
 
 
 2  channels with one track with multiple channels: Two tracks with one channel each, plus six
 MOS tracks
 
 
 
 
 auto  channels with one track with one channel: One track with one channel, plus seven MOS
 tracks
 
 
 
 
 auto  channels with one track with multiple channels: Up to eight tracks with one channel
 each, plus MOS tracks until there are eight tracks in all
 
 
 


codecOptions
AudioCodecOptions codecOptions

 If you specified AAC for Audio:Codec, this is the AAC compression profile
 to use. Valid values include:
 
 
 auto, AAC-LC, HE-AAC, HE-AACv2
 
 
 If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file.
 








Class com.amazonaws.services.elastictranscoder.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the job that you want to cancel.
 
 
 To get a list of the jobs (including their jobId) that have a status of Submitted, use
 the ListJobsByStatus API action.
 








Class com.amazonaws.services.elastictranscoder.model.CancelJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elastictranscoder.model.CaptionFormat extends Object implements Serializable


Serialized Fields


format
String format

 The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this
 output.
 
 
 
 
 Valid Embedded Caption Formats:
 
 
 
 
 for FLAC: None
 
 
 
 
 For MP3: None
 
 
 
 
 For MP4: mov-text
 
 
 
 
 For MPEG-TS: None
 
 
 
 
 For ogg: None
 
 
 
 
 For webm: None
 
 
 
 
 
 
 Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and
 webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
 
 
 
 
 For FMP4: dfxp
 
 
 
 
 Non-FMP4 outputs: All sidecar types
 
 
 
 
 fmp4 captions have an extension of .ismt
 
 
 


pattern
String pattern

 The prefix for caption filenames, in the form description-{language}, where:
 
 
 
 
 description is a description of the video.
 
 
 
 
 {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code
 for the language of the caption in the output file names.
 
 
 
 
 If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends "
 {language}" to the value that you specify for the description. In addition, Elastic Transcoder
 automatically appends the count to the end of the segment files.
 
 
 For example, suppose you're transcoding into srt format. When you enter "Sydney-{language}-sunrise", and the
 language of the captions is English (en), the name of the first caption file is be Sydney-en-sunrise00000.srt.
 


encryption
Encryption encryption

 The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.
 








Class com.amazonaws.services.elastictranscoder.model.Captions extends Object implements Serializable


Serialized Fields


mergePolicy
String mergePolicy
Deprecated. 

 A policy that determines how Elastic Transcoder handles the existence of multiple captions.
 
 
 
 
 MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions
 for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the
 sidecar captions and ignores the embedded captions for that language.
 
 
 
 
 MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions
 for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the
 embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty,
 Elastic Transcoder omits all sidecar captions from the output files.
 
 
 
 
 Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
 CaptionSources.
 
 
 
 
 MergePolicy cannot be null.
 


captionSources
SdkInternalList<T> captionSources
Deprecated. 

 Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions,
 leave CaptionSources blank.
 


captionFormats
SdkInternalList<T> captionFormats

 The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an
 error.
 








Class com.amazonaws.services.elastictranscoder.model.CaptionSource extends Object implements Serializable


Serialized Fields


key
String key

 The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.
 


language
String language

 A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption
 language must match in order to be included in the output. Specify this as one of:
 
 
 
 
 2-character ISO 639-1 code
 
 
 
 
 3-character ISO 639-2 code
 
 
 
 
 For more information on ISO language codes and language names, see the List of ISO 639-1 codes.
 


timeOffset
String timeOffset

 For clip generation or captions that do not start at the same time as the associated video file, the
 TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.
 
 
 Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.
 


label
String label

 The label of the caption shown in the player when choosing a language. We recommend that you put the caption
 language name here, in the language of the captions.
 


encryption
Encryption encryption

 The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want
 Elastic Transcoder to apply to your caption sources.
 








Class com.amazonaws.services.elastictranscoder.model.Clip extends Object implements Serializable


Serialized Fields


timeSpan
TimeSpan timeSpan
Deprecated. 

 Settings that determine when a clip begins and how long it lasts.
 








Class com.amazonaws.services.elastictranscoder.model.CreateJobOutput extends Object implements Serializable


Serialized Fields


key
String key

 The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by
 the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the
 specified name already exists in the output bucket, the job fails.
 


thumbnailPattern
String thumbnailPattern

 Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic
 Transcoder to name the files.
 
 
 If you don't want Elastic Transcoder to create thumbnails, specify "".
 
 
 If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the
 file name for each thumbnail. You can specify the following values in any sequence:
 
 
 
 
  {count} (Required): If you want to create thumbnails, you must include {count}
 in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a
 five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a
 given thumbnail appears in the sequence of thumbnails for a transcoded file.
 
 
 
 If you specify a literal value and/or {resolution} but you omit {count}, Elastic
 Transcoder returns a validation error and does not create the job.
 
 
 
 
 Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern
 object. For example, you can include them as a file name prefix or as a delimiter between
 {resolution} and {count}.
 
 
 
 
  {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the
 file name, include {resolution} in the ThumbnailPattern object.
 
 
 
 
 When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that
 appears in the preset that you specified in the PresetID value of CreateJobOutput.
 Elastic Transcoder also appends the applicable file name extension.
 


thumbnailEncryption
Encryption thumbnailEncryption

 The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
 


rotate
String rotate

 The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input.
 Enter one of the following values: auto, 0, 90, 180,
 270. The value auto generally works only if the file that you're transcoding contains
 rotation metadata.
 


presetId
String presetId

 The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail
 settings that Elastic Transcoder uses for transcoding.
 


segmentDuration
String segmentDuration

 
 (Outputs in Fragmented MP4 or MPEG-TS format only.
 
 
 
 If you specify a preset in PresetId for which the value of Container is
 fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target
 maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is
 stored in a separate .ts file. For HLSv4 and Smooth playlists, all media
 segments for an output are stored in a single file. Each segment is approximately the length of the
 SegmentDuration, though individual segments might be shorter or longer.
 
 
 The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by
 SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration.
 
 
 Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify
 in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of
 the associated playlist.
 


watermarks
SdkInternalList<T> watermarks

 Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can
 specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the
 current output.
 


albumArt
JobAlbumArt albumArt

 Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can
 specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the
 current output.
 


composition
SdkInternalList<T> composition
Deprecated. 

 You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come
 from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make
 up an output file. For the current release, you can only specify settings for a single clip per output file. The
 Composition object cannot be null.
 


captions
Captions captions

 You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All
 captions must be in UTF-8. Elastic Transcoder supports two types of captions:
 
 
 
 
 Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder
 supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
 
 
 Valid input values include: CEA-608 (EIA-608, first non-empty channel only),
 CEA-708 (EIA-708, first non-empty channel only), and mov-text
 
 
 Valid outputs include: mov-text
 
 
 Elastic Transcoder supports a maximum of one embedded format per output.
 
 
 
 
 Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar
 captions require a player that is capable of understanding the relationship between the video file and the
 sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar
 captions per file.
 
 
 Valid input values include: dfxp (first div element only), ebu-tt, scc,
 smpt, srt, ttml (first div element only), and webvtt
 
 
 Valid outputs include: dfxp (first div element only), scc, srt, and
 webvtt.
 
 
 
 
 If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
 
 
 Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid
 input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text
 formatting (for example, italics) during the transcoding process.
 
 
 To remove captions or leave the captions empty, set Captions to null. To pass through existing
 captions unchanged, set the MergePolicy to MergeRetain, and pass in a null
 CaptionSources array.
 
 
 For more information on embedded files, see the Subtitles Wikipedia page.
 
 
 For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
 


encryption
Encryption encryption

 You can specify encryption settings for any output files that you want to use for a transcoding job. This
 includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must
 specify encryption settings for each file individually.
 








Class com.amazonaws.services.elastictranscoder.model.CreateJobPlaylist extends Object implements Serializable


Serialized Fields


name
String name

 The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If
 the name includes a / character, the section of the name before the last / must be
 identical for all Name objects. If you create more than one master playlist, the values of all
 Name objects must be unique.
 
 
 
 Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for
 HLSv3 and HLSv4 playlists, and .ism and .ismc for
 Smooth playlists). If you include a file extension in Name, the file name will have two
 extensions.
 
 


format
String format

 The format of the output playlist. Valid formats include HLSv3, HLSv4, and
 Smooth.
 


outputKeys
SdkInternalList<T> outputKeys

 For each output in this job that you want to include in a master playlist, the value of the
 Outputs:Key object.
 
 
 
 
 If your output is not HLS or does not have a segment duration set, the name of the output file is a
 concatenation of OutputKeyPrefix and Outputs:Key:
 
 
 OutputKeyPrefixOutputs:Key
 
 
 
 
 If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic
 Transcoder creates an output playlist file with a file extension of .m3u8, and a series of
 .ts files that include a five-digit sequential counter beginning with 00000:
 
 
 OutputKeyPrefixOutputs:Key.m3u8
 
 
 OutputKeyPrefixOutputs:Key00000.ts
 
 
 
 
 If your output is HLSv4, has a segment duration set, and is included in an HLSv4
 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If
 the output is video, Elastic Transcoder also creates an output file with an extension of
 _iframe.m3u8:
 
 
 OutputKeyPrefixOutputs:Key_v4.m3u8
 
 
 OutputKeyPrefixOutputs:Key_iframe.m3u8
 
 
 OutputKeyPrefixOutputs:Key.ts
 
 
 
 
 Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file
 extension in Output Key, the file name will have two extensions.
 
 
 If you include more than one output in a playlist, any segment duration settings, clip settings, or caption
 settings must be the same for all outputs in the playlist. For Smooth playlists, the
 Audio:Profile, Video:Profile, and Video:FrameRate to
 Video:KeyframesMaxDist ratio must be the same for all outputs.
 


hlsContentProtection
HlsContentProtection hlsContentProtection

 The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files
 associated with this playlist.
 


playReadyDrm
PlayReadyDrm playReadyDrm

 The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this
 playlist.
 








Class com.amazonaws.services.elastictranscoder.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline
 determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to
 transcode and the bucket into which Elastic Transcoder puts the transcoded files.
 


input
JobInput input

 A section of the request body that provides information about the file that is being transcoded.
 


inputs
SdkInternalList<T> inputs

 A section of the request body that provides information about the files that are being transcoded.
 


output
CreateJobOutput output

 A section of the request body that provides information about the transcoded (target) file. We strongly recommend
 that you use the Outputs syntax instead of the Output syntax.
 


outputs
SdkInternalList<T> outputs

 A section of the request body that provides information about the transcoded (target) files. We recommend that
 you use the Outputs syntax instead of the Output syntax.
 


outputKeyPrefix
String outputKeyPrefix

 The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates,
 including output files, thumbnails, and playlists.
 


playlists
SdkInternalList<T> playlists

 If you specify a preset in PresetId for which the value of Container is fmp4
 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic
 Transcoder to create.
 
 
 The maximum number of master playlists in a job is 30.
 


userMetadata
SdkInternalMap<K,V> userMetadata

 User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in
 key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder
 does not guarantee that key/value pairs are returned in the same order in which you specify them.
 








Class com.amazonaws.services.elastictranscoder.model.CreateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


job
Job job

 A section of the response body that provides information about the job that is created.
 








Class com.amazonaws.services.elastictranscoder.model.CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not
 enforced.
 
 
 Constraints: Maximum 40 characters.
 


inputBucket
String inputBucket

 The Amazon S3 bucket in which you saved the media files that you want to transcode.
 


outputBucket
String outputBucket

 The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use
 ContentConfig:Bucket plus ThumbnailConfig:Bucket.)
 
 
 Specify this value when all of the following are true:
 
 
 
 
 You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
 
 
 
 
 You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and
 playlists.
 
 
 
 
 You do not want to specify the permissions that Elastic Transcoder grants to the files.
 
 
 
 When Elastic Transcoder saves files in OutputBucket, it grants full control over the files only to
 the AWS account that owns the role that is specified by Role.
 
 
 
 
 You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
 
 
 
 
 If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which
 users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class,
 omit OutputBucket and specify values for ContentConfig and ThumbnailConfig
 instead.
 


role
String role

 The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.
 


awsKmsKeyArn
String awsKmsKeyArn

 The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
 
 
 If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need
 to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically.
 You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an
 Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.
 


notifications
Notifications notifications

 The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
 
 
 
 To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
 
 
 
 
 
 Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to
 notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS
 returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification
 Service Developer Guide.
 
 
 
 
 Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has
 finished processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.
 
 
 
 
 Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters
 a warning condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you
 created the topic.
 
 
 
 
 Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters
 an error condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you
 created the topic.
 
 
 


contentConfig
PipelineOutputConfig contentConfig

 The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want
 Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have
 access to the files, the type of access you want users to have, and the storage class that you want to assign to
 the files.
 
 
 If you specify values for ContentConfig, you must also specify values for
 ThumbnailConfig.
 
 
 If you specify values for ContentConfig and ThumbnailConfig, omit the
 OutputBucket object.
 
 
 
 
 Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
 
 
 
 
 Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded
 files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or
 predefined Amazon S3 groups.
 
 
 
 
 Grantee Type: Specify the type of value that appears in the Grantee object:
 
 
 
 
 Canonical: The value in the Grantee object is either the canonical user ID for an AWS account
 or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user
 IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more
 information about using CloudFront origin access identities to require that users use CloudFront URLs instead of
 Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.
 
 
 
 A canonical user ID is not the same as an AWS account number.
 
 
 
 
 Email: The value in the Grantee object is the registered email address of an AWS account.
 
 
 
 
 Group: The value in the Grantee object is one of the following predefined Amazon S3 groups:
 AllUsers, AuthenticatedUsers, or LogDelivery.
 
 
 
 
 
 
 Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify
 the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a
 CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group
 
 
 
 
 Access: The permission that you want to give to the AWS user that you specified in Grantee.
 Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video
 files. Valid values include:
 
 
 
 
 READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the
 Amazon S3 bucket.
 
 
 
 
 READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon
 S3 bucket.
 
 
 
 
 WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon
 S3 bucket.
 
 
 
 
 FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP
 permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
 
 
 
 
 
 
 StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that
 you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
 
 
 


thumbnailConfig
PipelineOutputConfig thumbnailConfig

 The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you
 want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of
 access you want users to have, and the storage class that you want to assign to the files.
 
 
 If you specify values for ContentConfig, you must also specify values for
 ThumbnailConfig even if you don't want to create thumbnails.
 
 
 If you specify values for ContentConfig and ThumbnailConfig, omit the
 OutputBucket object.
 
 
 
 
 Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
 
 
 
 
 Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon
 S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant
 permissions to a maximum of 30 users and/or predefined Amazon S3 groups.
 
 
 
 
 GranteeType: Specify the type of value that appears in the Grantee object:
 
 
 
 
 Canonical: The value in the Grantee object is either the canonical user ID for an AWS account
 or an origin access identity for an Amazon CloudFront distribution.
 
 
 
 A canonical user ID is not the same as an AWS account number.
 
 
 
 
 Email: The value in the Grantee object is the registered email address of an AWS account.
 
 
 
 
 Group: The value in the Grantee object is one of the following predefined Amazon S3 groups:
 AllUsers, AuthenticatedUsers, or LogDelivery.
 
 
 
 
 
 
 Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or
 group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront
 distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
 
 
 
 
 Access: The permission that you want to give to the AWS user that you specified in Grantee.
 Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:
 
 
 
 
 READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to
 the Amazon S3 bucket.
 
 
 
 
 READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the
 Amazon S3 bucket.
 
 
 
 
 WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the
 Amazon S3 bucket.
 
 
 
 
 FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP
 permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
 
 
 
 
 
 
 StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that
 you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.
 
 
 








Class com.amazonaws.services.elastictranscoder.model.CreatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipeline
Pipeline pipeline

 A section of the response body that provides information about the pipeline that is created.
 


warnings
SdkInternalList<T> warnings

 Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the
 pipeline.
 
 
 Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS
 key, reduces processing time and prevents cross-regional charges.
 








Class com.amazonaws.services.elastictranscoder.model.CreatePresetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not
 enforced.
 


description
String description

 A description of the preset.
 


container
String container

 The container type for the output file. Valid values include flac, flv,
 fmp4, gif, mp3, mp4, mpg, mxf,
 oga, ogg, ts, and webm.
 


video
VideoParameters video

 A section of the request body that specifies the video parameters.
 


audio
AudioParameters audio

 A section of the request body that specifies the audio parameters.
 


thumbnails
Thumbnails thumbnails

 A section of the request body that specifies the thumbnail parameters, if any.
 








Class com.amazonaws.services.elastictranscoder.model.CreatePresetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


preset
Preset preset

 A section of the response body that provides information about the preset that is created.
 


warning
String warning

 If the preset settings don't comply with the standards for the video codec but Elastic Transcoder created the
 preset, this message explains the reason the preset settings don't meet the standard. Elastic Transcoder created
 the preset because the settings might produce acceptable output.
 








Class com.amazonaws.services.elastictranscoder.model.DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the pipeline that you want to delete.
 








Class com.amazonaws.services.elastictranscoder.model.DeletePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elastictranscoder.model.DeletePresetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the preset for which you want to get detailed information.
 








Class com.amazonaws.services.elastictranscoder.model.DeletePresetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.elastictranscoder.model.DetectedProperties extends Object implements Serializable


Serialized Fields


width
Integer width

 The detected width of the input file, in pixels.
 


height
Integer height

 The detected height of the input file, in pixels.
 


frameRate
String frameRate

 The detected frame rate of the input file, in frames per second.
 


fileSize
Long fileSize

 The detected file size of the input file, in bytes.
 


durationMillis
Long durationMillis

 The detected duration of the input file, in milliseconds.
 








Class com.amazonaws.services.elastictranscoder.model.Encryption extends Object implements Serializable


Serialized Fields


mode
String mode

 The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files
 or encrypting your output files. Elastic Transcoder supports the following options:
 
 
 
 
 s3: Amazon S3 creates and manages the keys used for encrypting your files.
 
 
 
 
 s3-aws-kms: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are
 used for encrypting your files. If you specify s3-aws-kms and you don't want to use the default key,
 you must add the AWS-KMS key that you want to use to your pipeline.
 
 
 
 
 aes-cbc-pkcs7: A padded cipher-block mode of operation originally used for HLS files.
 
 
 
 
 aes-ctr: AES Counter Mode.
 
 
 
 
 aes-gcm: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning
 that a file, key, or initialization vector that has been tampered with fails the decryption process.
 
 
 
 
 For all three AES options, you must provide the following settings, which must be base64-encoded:
 
 
 
 
 Key
 
 
 
 
 Key MD5
 
 
 
 
 Initialization Vector
 
 
 
 
 
 For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it
 is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your
 data.
 
 


key
String key

 The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to
 encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before
 being base64-encoded:
 
 
 128, 192, or 256.
 
 
 The key must also be encrypted by using the Amazon Key Management Service.
 


keyMd5
String keyMd5

 The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to
 encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not
 corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being
 base64-encoded.
 


initializationVector
String initializationVector

 The series of random bits created by a random bit generator, unique for every encryption operation, that you used
 to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The
 initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.
 








Class com.amazonaws.services.elastictranscoder.model.HlsContentProtection extends Object implements Serializable


Serialized Fields


method
String method

 The content protection method for your output. The only valid value is: aes-128.
 
 
 This value is written into the method attribute of the EXT-X-KEY metadata tag in the output
 playlist.
 


key
String key

 If you want Elastic Transcoder to generate a key for you, leave this field blank.
 
 
 If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded,
 and it must be one of the following bit lengths before being base64-encoded:
 
 
 128, 192, or 256.
 


keyMd5
String keyMd5

 If Elastic Transcoder is generating your key for you, you must leave this field blank.
 
 
 The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want
 Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be
 base64-encoded, and it must be exactly 16 bytes before being base64- encoded.
 


initializationVector
String initializationVector

 If Elastic Transcoder is generating your key for you, you must leave this field blank.
 
 
 The series of random bits created by a random bit generator, unique for every encryption operation, that you want
 Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it
 must be exactly 16 bytes before being base64-encoded.
 


licenseAcquisitionUrl
String licenseAcquisitionUrl

 The location of the license key required to decrypt your HLS playlist. The URL must be an absolute path, and is
 referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file.
 


keyStoragePolicy
String keyStoragePolicy

 Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If you choose
 WithVariantPlaylists, LicenseAcquisitionUrl must be left blank and Elastic Transcoder
 writes your data key into the same bucket as the associated playlist.
 








Class com.amazonaws.services.elastictranscoder.model.IncompatibleVersionException extends AmazonElasticTranscoderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.InputCaptions extends Object implements Serializable


Serialized Fields


mergePolicy
String mergePolicy

 A policy that determines how Elastic Transcoder handles the existence of multiple captions.
 
 
 
 
 MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions
 for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the
 sidecar captions and ignores the embedded captions for that language.
 
 
 
 
 MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions
 for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the
 embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty,
 Elastic Transcoder omits all sidecar captions from the output files.
 
 
 
 
 Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
 CaptionSources.
 
 
 
 
 MergePolicy cannot be null.
 


captionSources
SdkInternalList<T> captionSources

 Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions,
 leave CaptionSources blank.
 








Class com.amazonaws.services.elastictranscoder.model.InternalServiceException extends AmazonElasticTranscoderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.Job extends Object implements Serializable


Serialized Fields


id
String id

 The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to
 delete the job.
 


arn
String arn

 The Amazon Resource Name (ARN) for the job.
 


pipelineId
String pipelineId

 The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline
 determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to
 transcode and the bucket into which Elastic Transcoder puts the transcoded files.
 


input
JobInput input

 A section of the request or response body that provides information about the file that is being transcoded.
 


inputs
SdkInternalList<T> inputs

 Information about the files that you're transcoding. If you specified multiple files for this job, Elastic
 Transcoder stitches the files together to make one output.
 


output
JobOutput output

 If you specified one output for a job, information about that output. If you specified multiple outputs for a
 job, the Output object lists information about the first output. This duplicates the information that is listed
 for the first output in the Outputs object.
 
 
 
 Outputs recommended instead.
 
 
 
 A section of the request or response body that provides information about the transcoded (target) file.
 


outputs
SdkInternalList<T> outputs

 Information about the output files. We recommend that you use the Outputs syntax for all jobs, even
 when you want Elastic Transcoder to transcode a file into only one format. Do not use both the
 Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs
 per job.
 
 
 If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order
 in which you specify them in the job.
 


outputKeyPrefix
String outputKeyPrefix

 The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates,
 including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the
 end of the OutputKeyPrefix.
 


playlists
SdkInternalList<T> playlists

 
 Outputs in Fragmented MP4 or MPEG-TS format only.
 
 
 
 If you specify a preset in PresetId for which the value of Container is fmp4
 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you
 want Elastic Transcoder to create.
 
 
 The maximum number of master playlists in a job is 30.
 


status
String status

 The status of the job: Submitted, Progressing, Complete,
 Canceled, or Error.
 


userMetadata
SdkInternalMap<K,V> userMetadata

 User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in
 key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder
 does not guarantee that key/value pairs are returned in the same order in which you specify them.
 
 
 Metadata keys and values must use characters from the following list:
 
 
 
 
 0-9
 
 
 
 
 A-Z and a-z
 
 
 
 
 Space
 
 
 
 
 The following symbols: _.:/=+-%@
 
 
 


timing
Timing timing

 Details about the timing of a job.
 








Class com.amazonaws.services.elastictranscoder.model.JobAlbumArt extends Object implements Serializable


Serialized Fields


mergePolicy
String mergePolicy

 A policy that determines how Elastic Transcoder handles the existence of multiple album artwork files.
 
 
 
 
 Replace: The specified album art replaces any existing album art.
 
 
 
 
 Prepend: The specified album art is placed in front of any existing album art.
 
 
 
 
 Append: The specified album art is placed after any existing album art.
 
 
 
 
 Fallback: If the original input file contains artwork, Elastic Transcoder uses that artwork for the
 output. If the original input does not contain artwork, Elastic Transcoder uses the specified album art file.
 
 
 


artwork
SdkInternalList<T> artwork

 The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of
 20. Valid formats are .jpg and .png
 








Class com.amazonaws.services.elastictranscoder.model.JobInput extends Object implements Serializable


Serialized Fields


key
String key

 The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use
 for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which
 Amazon S3 bucket to get the file from.
 
 
 If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If
 the file isn't in the specified bucket, Elastic Transcoder returns an error.
 


frameRate
String frameRate

 The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the
 input file, specify auto. If you want to specify the frame rate for the input file, enter one of the
 following values:
 
 
 10, 15, 23.97, 24, 25, 29.97,
 30, 60
 
 
 If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame
 rate.
 


resolution
String resolution

 This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of
 the input file.
 


aspectRatio
String aspectRatio

 The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of
 the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one
 of the following values:
 
 
 1:1, 4:3, 3:2, 16:9
 
 
 If you specify a value other than auto, Elastic Transcoder disables automatic detection of the
 aspect ratio.
 


interlaced
String interlaced

 Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input
 file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter
 one of the following values:
 
 
 true, false
 
 
 If you specify a value other than auto, Elastic Transcoder disables automatic detection of
 interlacing.
 


container
String container

 The container type for the input file. If you want Elastic Transcoder to automatically detect the container type
 of the input file, specify auto. If you want to specify the container type for the input file, enter
 one of the following values:
 
 
 3gp, aac, asf, avi, divx, flv,
 m4a, mkv, mov, mp3, mp4, mpeg,
 mpeg-ps, mpeg-ts, mxf, ogg, vob,
 wav, webm
 


encryption
Encryption encryption

 The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted,
 you must specify the mode that Elastic Transcoder uses to decrypt your file.
 


timeSpan
TimeSpan timeSpan

 Settings for clipping an input. Each input can have different clip settings.
 


inputCaptions
InputCaptions inputCaptions

 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.
 


detectedProperties
DetectedProperties detectedProperties

 The detected properties of the input file.
 








Class com.amazonaws.services.elastictranscoder.model.JobOutput extends Object implements Serializable


Serialized Fields


id
String id

 A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the
 Output syntax, this value is always 1.
 


key
String key

 The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by
 the OutputBucket object in the pipeline that is specified by the pipeline ID.
 


thumbnailPattern
String thumbnailPattern

 Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic
 Transcoder to name the files.
 
 
 If you don't want Elastic Transcoder to create thumbnails, specify "".
 
 
 If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the
 file name for each thumbnail. You can specify the following values in any sequence:
 
 
 
 
  {count} (Required): If you want to create thumbnails, you must include {count}
 in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a
 five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a
 given thumbnail appears in the sequence of thumbnails for a transcoded file.
 
 
 
 If you specify a literal value and/or {resolution} but you omit {count}, Elastic
 Transcoder returns a validation error and does not create the job.
 
 
 
 
 Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern
 object. For example, you can include them as a file name prefix or as a delimiter between
 {resolution} and {count}.
 
 
 
 
  {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the
 file name, include {resolution} in the ThumbnailPattern object.
 
 
 
 
 When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that
 appears in the preset that you specified in the PresetID value of CreateJobOutput.
 Elastic Transcoder also appends the applicable file name extension.
 


thumbnailEncryption
Encryption thumbnailEncryption

 The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.
 


rotate
String rotate

 The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input.
 Enter one of the following values:
 
 
 auto, 0, 90, 180, 270
 
 
 The value auto generally works only if the file that you're transcoding contains rotation metadata.
 


presetId
String presetId

 The value of the Id object for the preset that you want to use for this job. The preset determines
 the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. To use a preset that you
 created, specify the preset ID that Elastic Transcoder returned in the response when you created the preset. You
 can also use the Elastic Transcoder system presets, which you can get with ListPresets.
 


segmentDuration
String segmentDuration

 
 (Outputs in Fragmented MP4 or MPEG-TS format only.
 
 
 
 If you specify a preset in PresetId for which the value of Container is
 fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target
 maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is
 stored in a separate .ts file. For HLSv4, MPEG-DASH, and
 Smooth playlists, all media segments for an output are stored in a single file. Each segment is
 approximately the length of the SegmentDuration, though individual segments might be shorter or
 longer.
 
 
 The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by
 SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration.
 
 
 Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify
 in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of
 the associated playlist.
 


status
String status

 The status of one output in a job. If you specified only one output for the job, Outputs:Status is
 always the same as Job:Status. If you specified more than one output:
 
 
 
 
 Job:Status and Outputs:Status for all of the outputs is Submitted until Elastic
 Transcoder starts to process the first output.
 
 
 
 
 When Elastic Transcoder starts to process the first output, Outputs:Status for that output and
 Job:Status both change to Progressing. For each output, the value of Outputs:Status
 remains Submitted until Elastic Transcoder starts to process the output.
 
 
 
 
 Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.
 
 
 
 
 When all of the outputs reach a terminal status, Job:Status changes to Complete only if
 Outputs:Status for all of the outputs is Complete. If Outputs:Status for
 one or more outputs is Error, the terminal status for Job:Status is also
 Error.
 
 
 
 
 The value of Status is one of the following: Submitted, Progressing,
 Complete, Canceled, or Error.
 


statusDetail
String statusDetail

 Information that further explains Status.
 


duration
Long duration

 Duration of the output file, in seconds.
 


width
Integer width

 Specifies the width of the output file in pixels.
 


height
Integer height

 Height of the output file, in pixels.
 


frameRate
String frameRate

 Frame rate of the output file, in frames per second.
 


fileSize
Long fileSize

 File size of the output file, in bytes.
 


durationMillis
Long durationMillis

 Duration of the output file, in milliseconds.
 


watermarks
SdkInternalList<T> watermarks

 Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can
 specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you
 specify in Preset for the current output.
 
 
 Watermarks are added to the output video in the sequence in which you list them in the job output—the first
 watermark in the list is added to the output video first, the second watermark in the list is added next, and so
 on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same
 location, the second watermark that you add covers the first one, the third one covers the second, and the fourth
 one covers the third.
 


albumArt
JobAlbumArt albumArt

 The album art to be associated with the output file, if any.
 


composition
SdkInternalList<T> composition
Deprecated. 

 You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come
 from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make
 up an output file. For the current release, you can only specify settings for a single clip per output file. The
 Composition object cannot be null.
 


captions
Captions captions

 You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All
 captions must be in UTF-8. Elastic Transcoder supports two types of captions:
 
 
 
 
 Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder
 supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
 
 
 Valid input values include: CEA-608 (EIA-608, first non-empty channel only),
 CEA-708 (EIA-708, first non-empty channel only), and mov-text
 
 
 Valid outputs include: mov-text
 
 
 Elastic Transcoder supports a maximum of one embedded format per output.
 
 
 
 
 Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar
 captions require a player that is capable of understanding the relationship between the video file and the
 sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar
 captions per file.
 
 
 Valid input values include: dfxp (first div element only), ebu-tt, scc,
 smpt, srt, ttml (first div element only), and webvtt
 
 
 Valid outputs include: dfxp (first div element only), scc, srt, and
 webvtt.
 
 
 
 
 If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
 
 
 Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid
 input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text
 formatting (for example, italics) during the transcoding process.
 
 
 To remove captions or leave the captions empty, set Captions to null. To pass through existing
 captions unchanged, set the MergePolicy to MergeRetain, and pass in a null
 CaptionSources array.
 
 
 For more information on embedded files, see the Subtitles Wikipedia page.
 
 
 For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.
 


encryption
Encryption encryption

 The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to
 use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder writes an
 unencrypted file to your Amazon S3 bucket.
 


appliedColorSpaceConversion
String appliedColorSpaceConversion

 If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode the output file,
 the AppliedColorSpaceConversion parameter shows the conversion used. If no
 ColorSpaceConversionMode was defined in the preset, this parameter is not be included in the job
 response.
 








Class com.amazonaws.services.elastictranscoder.model.JobWatermark extends Object implements Serializable


Serialized Fields


presetWatermarkId
String presetWatermarkId

 The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding.
 The settings are in the preset specified by Preset for the current output. In that preset, the value of
 Watermarks Id tells Elastic Transcoder which settings to use.
 


inputKey
String inputKey

 The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket
 contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the
 Input Bucket object in that pipeline identifies the bucket.
 
 
 If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the
 file isn't in the specified bucket, Elastic Transcoder returns an error.
 


encryption
Encryption encryption

 The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.
 








Class com.amazonaws.services.elastictranscoder.model.LimitExceededException extends AmazonElasticTranscoderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.ListJobsByPipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline for which you want to get job information.
 


ascending
String ascending

 To list jobs in chronological order by the date and time that they were submitted, enter true. To
 list jobs in reverse chronological order, enter false.
 


pageToken
String pageToken

 When Elastic Transcoder returns more than one page of results, use pageToken in subsequent
 GET requests to get each successive page of results.
 








Class com.amazonaws.services.elastictranscoder.model.ListJobsByPipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobs
SdkInternalList<T> jobs

 An array of Job objects that are in the specified pipeline.
 


nextPageToken
String nextPageToken

 A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified
 pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken
 is null.
 








Class com.amazonaws.services.elastictranscoder.model.ListJobsByStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


status
String status

 To get information about all of the jobs associated with the current AWS account that have a given status,
 specify the following status: Submitted, Progressing, Complete,
 Canceled, or Error.
 


ascending
String ascending

 To list jobs in chronological order by the date and time that they were submitted, enter true. To
 list jobs in reverse chronological order, enter false.
 


pageToken
String pageToken

 When Elastic Transcoder returns more than one page of results, use pageToken in subsequent
 GET requests to get each successive page of results.
 








Class com.amazonaws.services.elastictranscoder.model.ListJobsByStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobs
SdkInternalList<T> jobs

 An array of Job objects that have the specified status.
 


nextPageToken
String nextPageToken

 A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified
 pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken
 is null.
 








Class com.amazonaws.services.elastictranscoder.model.ListPipelinesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ascending
String ascending

 To list pipelines in chronological order by the date and time that they were created, enter true. To
 list pipelines in reverse chronological order, enter false.
 


pageToken
String pageToken

 When Elastic Transcoder returns more than one page of results, use pageToken in subsequent
 GET requests to get each successive page of results.
 








Class com.amazonaws.services.elastictranscoder.model.ListPipelinesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelines
SdkInternalList<T> pipelines

 An array of Pipeline objects.
 


nextPageToken
String nextPageToken

 A value that you use to access the second and subsequent pages of results, if any. When the pipelines fit on one
 page or when you've reached the last page of results, the value of NextPageToken is
 null.
 








Class com.amazonaws.services.elastictranscoder.model.ListPresetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ascending
String ascending

 To list presets in chronological order by the date and time that they were created, enter true. To
 list presets in reverse chronological order, enter false.
 


pageToken
String pageToken

 When Elastic Transcoder returns more than one page of results, use pageToken in subsequent
 GET requests to get each successive page of results.
 








Class com.amazonaws.services.elastictranscoder.model.ListPresetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


presets
SdkInternalList<T> presets

 An array of Preset objects.
 


nextPageToken
String nextPageToken

 A value that you use to access the second and subsequent pages of results, if any. When the presets fit on one
 page or when you've reached the last page of results, the value of NextPageToken is
 null.
 








Class com.amazonaws.services.elastictranscoder.model.Notifications extends Object implements Serializable


Serialized Fields


progressing
String progressing

 The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has
 started to process the job.
 


completed
String completed

 The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.
 


warning
String warning

 The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.
 


error
String error

 The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.
 








Class com.amazonaws.services.elastictranscoder.model.Permission extends Object implements Serializable


Serialized Fields


granteeType
String granteeType

 The type of value that appears in the Grantee object:
 
 
 
 
 Canonical: Either the canonical user ID for an AWS account or an origin access identity for an
 Amazon CloudFront distribution.
 
 
 
 A canonical user ID is not the same as an AWS account number.
 
 
 
 
 Email: The registered email address of an AWS account.
 
 
 
 
 Group: One of the following predefined Amazon S3 groups: AllUsers,
 AuthenticatedUsers, or LogDelivery.
 
 
 


grantee
String grantee

 The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or
 group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront
 distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
 


access
SdkInternalList<T> access

 The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
 
 
 
 
 READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds
 to the Amazon S3 bucket.
 
 
 
 
 READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the
 Amazon S3 bucket.
 
 
 
 
 WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the
 Amazon S3 bucket.
 
 
 
 
 FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that
 Elastic Transcoder adds to the Amazon S3 bucket.
 
 
 








Class com.amazonaws.services.elastictranscoder.model.Pipeline extends Object implements Serializable


Serialized Fields


id
String id

 The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a
 variety of operations, such as creating a job or a preset.
 


arn
String arn

 The Amazon Resource Name (ARN) for the pipeline.
 


name
String name

 The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not
 enforced.
 
 
 Constraints: Maximum 40 characters
 


status
String status

 The current status of the pipeline:
 
 
 
 
 Active: The pipeline is processing jobs.
 
 
 
 
 Paused: The pipeline is not currently processing jobs.
 
 
 


inputBucket
String inputBucket

 The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if
 any, that you want to use for watermarks.
 


outputBucket
String outputBucket

 The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists.
 Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.
 


role
String role

 The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.
 


awsKmsKeyArn
String awsKmsKeyArn

 The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
 
 
 If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need
 to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically.
 You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an
 Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.
 


notifications
Notifications notifications

 The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.
 
 
 
 To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
 
 
 
 
 
 Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify
 when Elastic Transcoder has started to process the job.
 
 
 
 
 Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished
 processing the job.
 
 
 
 
 Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a
 warning condition.
 
 
 
 
 Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error
 condition.
 
 
 


contentConfig
PipelineOutputConfig contentConfig

 Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and
 playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify
 OutputBucket.
 
 
 
 
 Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
 
 
 
 
 Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded
 files and playlists, and the type of access that you want them to have.
 
 
 
 
 GranteeType: The type of value that appears in the Grantee object:
 
 
 
 
 Canonical: Either the canonical user ID for an AWS account or an origin access identity for an
 Amazon CloudFront distribution.
 
 
 
 
 Email: The registered email address of an AWS account.
 
 
 
 
 Group: One of the following predefined Amazon S3 groups: AllUsers,
 AuthenticatedUsers, or LogDelivery.
 
 
 
 
 
 
 Grantee: The AWS user or group that you want to have access to transcoded files and playlists.
 
 
 
 
 Access: The permission that you want to give to the AWS user that is listed in Grantee.
 Valid values include:
 
 
 
 
 READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the
 Amazon S3 bucket.
 
 
 
 
 READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon
 S3 bucket.
 
 
 
 
 WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon
 S3 bucket.
 
 
 
 
 FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP
 permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
 
 
 
 
 
 
 
 
 StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder
 to assign to the video files and playlists that it stores in your Amazon S3 bucket.
 
 
 


thumbnailConfig
PipelineOutputConfig thumbnailConfig

 Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you
 specify both ContentConfig and ThumbnailConfig, or you specify
 OutputBucket.
 
 
 
 
 Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
 
 
 
 
 Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to
 thumbnail files, and the type of access that you want them to have.
 
 
 
 
 GranteeType: The type of value that appears in the Grantee object:
 
 
 
 
 Canonical: Either the canonical user ID for an AWS account or an origin access identity for an
 Amazon CloudFront distribution.
 
 
 
 A canonical user ID is not the same as an AWS account number.
 
 
 
 
 Email: The registered email address of an AWS account.
 
 
 
 
 Group: One of the following predefined Amazon S3 groups: AllUsers,
 AuthenticatedUsers, or LogDelivery.
 
 
 
 
 
 
 Grantee: The AWS user or group that you want to have access to thumbnail files.
 
 
 
 
 Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:
 
 
 
 
 READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds
 to the Amazon S3 bucket.
 
 
 
 
 READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the
 Amazon S3 bucket.
 
 
 
 
 WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the
 Amazon S3 bucket.
 
 
 
 
 FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that
 Elastic Transcoder adds to the Amazon S3 bucket.
 
 
 
 
 
 
 
 
 StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy,
 that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.
 
 
 








Class com.amazonaws.services.elastictranscoder.model.PipelineOutputConfig extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when
 all of the following are true:
 
 
 
 
 You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.
 
 
 
 
 You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and
 playlists.
 
 
 
 
 You do not want to specify the permissions that Elastic Transcoder grants to the files.
 
 
 
 
 You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.
 
 
 
 
 If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which
 users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class,
 omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.
 


storageClass
String storageClass

 The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic
 Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
 


permissions
SdkInternalList<T> permissions

 Optional. The Permissions object specifies which users and/or predefined Amazon S3 groups you want
 to have access to transcoded files and playlists, and the type of access you want them to have. You can grant
 permissions to a maximum of 30 users and/or predefined Amazon S3 groups.
 
 
 If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does
 not grant full permissions to the owner of the role specified by Role. If you want that user to have
 full control, you must explicitly grant full control to the user.
 
 
 If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and
 playlists to the owner of the role specified by Role, and grants no other permissions to any other
 user or group.
 








Class com.amazonaws.services.elastictranscoder.model.Playlist extends Object implements Serializable


Serialized Fields


name
String name

 The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If
 the name includes a / character, the section of the name before the last / must be
 identical for all Name objects. If you create more than one master playlist, the values of all
 Name objects must be unique.
 
 
 
 Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for
 HLSv3 and HLSv4 playlists, and .ism and .ismc for
 Smooth playlists). If you include a file extension in Name, the file name will have two
 extensions.
 
 


format
String format

 The format of the output playlist. Valid formats include HLSv3, HLSv4, and
 Smooth.
 


outputKeys
SdkInternalList<T> outputKeys

 For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.
 
 
 
 
 If your output is not HLS or does not have a segment duration set, the name of the output file is a
 concatenation of OutputKeyPrefix and Outputs:Key:
 
 
 OutputKeyPrefixOutputs:Key
 
 
 
 
 If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic
 Transcoder creates an output playlist file with a file extension of .m3u8, and a series of
 .ts files that include a five-digit sequential counter beginning with 00000:
 
 
 OutputKeyPrefixOutputs:Key.m3u8
 
 
 OutputKeyPrefixOutputs:Key00000.ts
 
 
 
 
 If your output is HLSv4, has a segment duration set, and is included in an HLSv4
 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If
 the output is video, Elastic Transcoder also creates an output file with an extension of
 _iframe.m3u8:
 
 
 OutputKeyPrefixOutputs:Key_v4.m3u8
 
 
 OutputKeyPrefixOutputs:Key_iframe.m3u8
 
 
 OutputKeyPrefixOutputs:Key.ts
 
 
 
 
 Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file
 extension in Output Key, the file name will have two extensions.
 
 
 If you include more than one output in a playlist, any segment duration settings, clip settings, or caption
 settings must be the same for all outputs in the playlist. For Smooth playlists, the
 Audio:Profile, Video:Profile, and Video:FrameRate to
 Video:KeyframesMaxDist ratio must be the same for all outputs.
 


hlsContentProtection
HlsContentProtection hlsContentProtection

 The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files
 associated with this playlist.
 


playReadyDrm
PlayReadyDrm playReadyDrm

 The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this
 playlist.
 


status
String status

 The status of the job with which the playlist is associated.
 


statusDetail
String statusDetail

 Information that further explains the status.
 








Class com.amazonaws.services.elastictranscoder.model.PlayReadyDrm extends Object implements Serializable


Serialized Fields


format
String format

 The type of DRM, if any, that you want Elastic Transcoder to apply to the output files associated with this
 playlist.
 


key
String key

 The DRM key for your file, provided by your DRM license provider. The key must be base64-encoded, and it must be
 one of the following bit lengths before being base64-encoded:
 
 
 128, 192, or 256.
 
 
 The key must also be encrypted by using AWS KMS.
 


keyMd5
String keyMd5

 The MD5 digest of the key used for DRM on your file, and that you want Elastic Transcoder to use as a checksum to
 make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16
 bytes before being base64-encoded.
 


keyId
String keyId

 The ID for your DRM key, so that your DRM license provider knows which key to provide.
 
 
 The key ID must be provided in big endian, and Elastic Transcoder converts it to little endian before inserting
 it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in big or
 little endian, check with your DRM provider.
 


initializationVector
String initializationVector

 The series of random bits created by a random bit generator, unique for every encryption operation, that you want
 Elastic Transcoder to use to encrypt your files. The initialization vector must be base64-encoded, and it must be
 exactly 8 bytes long before being base64-encoded. If no initialization vector is provided, Elastic Transcoder
 generates one for you.
 


licenseAcquisitionUrl
String licenseAcquisitionUrl

 The location of the license key required to play DRM content. The URL must be an absolute path, and is referenced
 by the PlayReady header. The PlayReady header is referenced in the protection header of the client manifest for
 Smooth Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO metadata tags for HLS playlist outputs. An
 example URL looks like this: https://www.example.com/exampleKey/
 








Class com.amazonaws.services.elastictranscoder.model.Preset extends Object implements Serializable


Serialized Fields


id
String id

 Identifier for the new preset. You use this value to get settings for the preset or to delete it.
 


arn
String arn

 The Amazon Resource Name (ARN) for the preset.
 


name
String name

 The name of the preset.
 


description
String description

 A description of the preset.
 


container
String container

 The container type for the output file. Valid values include flac, flv,
 fmp4, gif, mp3, mp4, mpg, mxf,
 oga, ogg, ts, and webm.
 


audio
AudioParameters audio

 A section of the response body that provides information about the audio preset values.
 


video
VideoParameters video

 A section of the response body that provides information about the video preset values.
 


thumbnails
Thumbnails thumbnails

 A section of the response body that provides information about the thumbnail preset values, if any.
 


type
String type

 Whether the preset is a default preset provided by Elastic Transcoder (System) or a preset that you
 have defined (Custom).
 








Class com.amazonaws.services.elastictranscoder.model.PresetWatermark extends Object implements Serializable


Serialized Fields


id
String id

 A unique identifier for the settings for one watermark. The value of Id can be up to 40 characters
 long.
 


maxWidth
String maxWidth

 The maximum width of the watermark in one of the following formats:
 
 
 
 
 number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of
 MaxWidth.
 
 
 
 
 integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify
 whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in
 the calculation.
 
 
 If you specify the value in pixels, it must be less than or equal to the value of MaxWidth.
 
 
 


maxHeight
String maxHeight

 The maximum height of the watermark in one of the following formats:
 
 
 
 
 number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of
 MaxHeight.
 
 
 
 
 integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify
 whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in
 the calculation.
 
 
 
 
 If you specify the value in pixels, it must be less than or equal to the value of MaxHeight.
 


sizingPolicy
String sizingPolicy

 A value that controls scaling of the watermark:
 
 
 
 
 Fit: Elastic Transcoder scales the watermark so it matches the value that you specified in either
 MaxWidth or MaxHeight without exceeding the other value.
 
 
 
 
 Stretch: Elastic Transcoder stretches the watermark to match the values that you specified for
 MaxWidth and MaxHeight. If the relative proportions of the watermark and the values of
 MaxWidth and MaxHeight are different, the watermark will be distorted.
 
 
 
 
 ShrinkToFit: Elastic Transcoder scales the watermark down so that its dimensions match the values that you
 specified for at least one of MaxWidth and MaxHeight without exceeding either value. If
 you specify this option, Elastic Transcoder does not scale the watermark up.
 
 
 


horizontalAlign
String horizontalAlign

 The horizontal position of the watermark unless you specify a non-zero value for HorizontalOffset:
 
 
 
 
 Left: The left edge of the watermark is aligned with the left border of the video.
 
 
 
 
 Right: The right edge of the watermark is aligned with the right border of the video.
 
 
 
 
 Center: The watermark is centered between the left and right borders.
 
 
 


horizontalOffset
String horizontalOffset

 The amount by which you want the horizontal position of the watermark to be offset from the position specified by
 HorizontalAlign:
 
 
 
 
 number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxWidth.
 
 
 
 
 integer percentage (%): The range of valid values is 0 to 100.
 
 
 
 
 For example, if you specify Left for HorizontalAlign and 5px for HorizontalOffset, the
 left side of the watermark appears 5 pixels from the left border of the output video.
 
 
 HorizontalOffset is only valid when the value of HorizontalAlign is Left
 or Right. If you specify an offset that causes the watermark to extend beyond the left or right
 border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added
 black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is
 cropped.
 
 
 Use the value of Target to specify whether you want to include the black bars that are added by
 Elastic Transcoder, if any, in the offset calculation.
 


verticalAlign
String verticalAlign

 The vertical position of the watermark unless you specify a non-zero value for VerticalOffset:
 
 
 
 
 Top: The top edge of the watermark is aligned with the top border of the video.
 
 
 
 
 Bottom: The bottom edge of the watermark is aligned with the bottom border of the video.
 
 
 
 
 Center: The watermark is centered between the top and bottom borders.
 
 
 


verticalOffset
String verticalOffset

 VerticalOffset
 
 
 The amount by which you want the vertical position of the watermark to be offset from the position specified by
 VerticalAlign:
 
 
 
 
 number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of
 MaxHeight.
 
 
 
 
 integer percentage (%): The range of valid values is 0 to 100.
 
 
 
 
 For example, if you specify Top for VerticalAlign and 5px for
 VerticalOffset, the top of the watermark appears 5 pixels from the top border of the output video.
 
 
 VerticalOffset is only valid when the value of VerticalAlign is Top or Bottom.
 
 
 If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic
 Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the
 watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.
 
 
 Use the value of Target to specify whether you want Elastic Transcoder to include the black bars
 that are added by Elastic Transcoder, if any, in the offset calculation.
 


opacity
String opacity

 A percentage that indicates how much you want a watermark to obscure the video in the location where it appears.
 Valid values are 0 (the watermark is invisible) to 100 (the watermark completely obscures the video in the
 specified location). The datatype of Opacity is float.
 
 
 Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent portion of
 the video appears as if you had specified a value of 0 for Opacity. The .jpg file format doesn't
 support transparency.
 


target
String target

 A value that determines how Elastic Transcoder interprets values that you specified for
 HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight:
 
 
 
 
 Content: HorizontalOffset and VerticalOffset values are calculated based on the
 borders of the video excluding black bars added by Elastic Transcoder, if any. In addition, MaxWidth
 and MaxHeight, if specified as a percentage, are calculated based on the borders of the video
 excluding black bars added by Elastic Transcoder, if any.
 
 
 
 
 Frame: HorizontalOffset and VerticalOffset values are calculated based on the
 borders of the video including black bars added by Elastic Transcoder, if any. In addition, MaxWidth
 and MaxHeight, if specified as a percentage, are calculated based on the borders of the video
 including black bars added by Elastic Transcoder, if any.
 
 
 








Class com.amazonaws.services.elastictranscoder.model.ReadJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the job for which you want to get detailed information.
 








Class com.amazonaws.services.elastictranscoder.model.ReadJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


job
Job job

 A section of the response body that provides information about the job.
 








Class com.amazonaws.services.elastictranscoder.model.ReadPipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the pipeline to read.
 








Class com.amazonaws.services.elastictranscoder.model.ReadPipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipeline
Pipeline pipeline

 A section of the response body that provides information about the pipeline.
 


warnings
SdkInternalList<T> warnings

 Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the
 pipeline.
 
 
 Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS
 key, reduces processing time and prevents cross-regional charges.
 








Class com.amazonaws.services.elastictranscoder.model.ReadPresetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the preset for which you want to get detailed information.
 








Class com.amazonaws.services.elastictranscoder.model.ReadPresetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


preset
Preset preset

 A section of the response body that provides information about the preset.
 








Class com.amazonaws.services.elastictranscoder.model.ResourceInUseException extends AmazonElasticTranscoderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.ResourceNotFoundException extends AmazonElasticTranscoderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.TestRoleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


role
String role

 The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.
 


inputBucket
String inputBucket

 The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.
 


outputBucket
String outputBucket

 The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to. The action attempts to read from
 this bucket.
 


topics
SdkInternalList<T> topics

 The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a
 test notification to.
 








Class com.amazonaws.services.elastictranscoder.model.TestRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


success
String success
Deprecated. 

 If the operation is successful, this value is true; otherwise, the value is false.
 


messages
SdkInternalList<T> messages
Deprecated. 

 If the Success element contains false, this value is an array of one or more error
 messages that were generated during the test process.
 








Class com.amazonaws.services.elastictranscoder.model.Thumbnails extends Object implements Serializable


Serialized Fields


format
String format

 The format of thumbnails, if any. Valid values are jpg and png.
 
 
 You specify whether you want Elastic Transcoder to create thumbnails when you create a job.
 


interval
String interval

 The approximate number of seconds between thumbnails. Specify an integer value.
 


resolution
String resolution

 
 To better control resolution and aspect ratio of thumbnails, we recommend that you use the values
 MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead
 of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do
 not use them together.
 
 
 
 The width and height of thumbnail files in pixels. Specify a value in the format  width  x
  height  where both values are even integers. The values cannot exceed the width and height
 that you specified in the Video:Resolution object.
 


aspectRatio
String aspectRatio

 
 To better control resolution and aspect ratio of thumbnails, we recommend that you use the values
 MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead
 of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do
 not use them together.
 
 
 
 The aspect ratio of thumbnails. Valid values include:
 
 
 auto, 1:1, 4:3, 3:2, 16:9
 
 
 If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the
 output file.
 


maxWidth
String maxWidth

 The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the
 default value. If you specify a numeric value, enter an even integer between 32 and 4096.
 


maxHeight
String maxHeight

 The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the
 default value. If you specify a numeric value, enter an even integer between 32 and 3072.
 


sizingPolicy
String sizingPolicy

 Specify one of the following values to control scaling of thumbnails:
 
 
 
 
 Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail
 MaxWidth or MaxHeight settings without exceeding the other value.
 
 
 
 
 Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail
 MaxWidth or MaxHeight settings and matches or exceeds the other value. Elastic
 Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum
 value.
 
 
 
 
 Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for
 thumbnail MaxWidth and MaxHeight settings. If the relative proportions of the input
 video and thumbnails are different, the thumbnails will be distorted.
 
 
 
 
 Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds
 the values that you specified for thumbnail MaxWidth and MaxHeight settings, Elastic
 Transcoder crops the thumbnails.
 
 
 
 
 ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values
 that you specified for at least one of thumbnail MaxWidth and MaxHeight without
 exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
 
 
 
 
 ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values
 that you specified for at least one of MaxWidth and MaxHeight without dropping below
 either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.
 
 
 


paddingPolicy
String paddingPolicy

 When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and
 bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that
 you specified for thumbnail MaxWidth and MaxHeight settings.
 








Class com.amazonaws.services.elastictranscoder.model.TimeSpan extends Object implements Serializable


Serialized Fields


startTime
String startTime

 The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS (maximum value:
 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a
 value, Elastic Transcoder starts at the beginning of the input file.
 


duration
String duration

 The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths
 of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder creates an
 output file from StartTime to the end of the file.
 
 
 If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and
 returns a warning message.
 








Class com.amazonaws.services.elastictranscoder.model.Timing extends Object implements Serializable


Serialized Fields


submitTimeMillis
Long submitTimeMillis

 The time the job was submitted to Elastic Transcoder, in epoch milliseconds.
 


startTimeMillis
Long startTimeMillis

 The time the job began transcoding, in epoch milliseconds.
 


finishTimeMillis
Long finishTimeMillis

 The time the job finished transcoding, in epoch milliseconds.
 








Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineNotificationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the pipeline for which you want to change notification settings.
 


notifications
Notifications notifications

 The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job
 status.
 
 
 
 To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.
 
 
 
 
 
 Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to
 notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that
 Amazon SNS returned when you created the topic.
 
 
 
 
 Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has
 finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.
 
 
 
 
 Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters
 a warning condition. This is the ARN that Amazon SNS returned when you created the topic.
 
 
 
 
 Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters
 an error condition. This is the ARN that Amazon SNS returned when you created the topic.
 
 
 








Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineNotificationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipeline
Pipeline pipeline

 A section of the response body that provides information about the pipeline associated with this notification.
 








Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the pipeline that you want to update.
 


name
String name

 The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not
 enforced.
 
 
 Constraints: Maximum 40 characters
 


inputBucket
String inputBucket

 The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want
 to use as watermarks.
 


role
String role

 The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for
 this pipeline.
 


awsKmsKeyArn
String awsKmsKeyArn

 The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.
 
 
 If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need
 to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically.
 You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an
 Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.
 


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


contentConfig
PipelineOutputConfig contentConfig

 The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want
 Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have
 access to the files, the type of access you want users to have, and the storage class that you want to assign to
 the files.
 
 
 If you specify values for ContentConfig, you must also specify values for
 ThumbnailConfig.
 
 
 If you specify values for ContentConfig and ThumbnailConfig, omit the
 OutputBucket object.
 
 
 
 
 Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.
 
 
 
 
 Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded
 files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or
 predefined Amazon S3 groups.
 
 
 
 
 Grantee Type: Specify the type of value that appears in the Grantee object:
 
 
 
 
 Canonical: The value in the Grantee object is either the canonical user ID for an AWS account
 or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user
 IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more
 information about using CloudFront origin access identities to require that users use CloudFront URLs instead of
 Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.
 
 
 
 A canonical user ID is not the same as an AWS account number.
 
 
 
 
 Email: The value in the Grantee object is the registered email address of an AWS account.
 
 
 
 
 Group: The value in the Grantee object is one of the following predefined Amazon S3 groups:
 AllUsers, AuthenticatedUsers, or LogDelivery.
 
 
 
 
 
 
 Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify
 the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a
 CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group
 
 
 
 
 Access: The permission that you want to give to the AWS user that you specified in Grantee.
 Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video
 files. Valid values include:
 
 
 
 
 READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the
 Amazon S3 bucket.
 
 
 
 
 READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon
 S3 bucket.
 
 
 
 
 WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon
 S3 bucket.
 
 
 
 
 FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP
 permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.
 
 
 
 
 
 
 StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that
 you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.
 
 
 


thumbnailConfig
PipelineOutputConfig thumbnailConfig

 The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you
 want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of
 access you want users to have, and the storage class that you want to assign to the files.
 
 
 If you specify values for ContentConfig, you must also specify values for
 ThumbnailConfig even if you don't want to create thumbnails.
 
 
 If you specify values for ContentConfig and ThumbnailConfig, omit the
 OutputBucket object.
 
 
 
 
 Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.
 
 
 
 
 Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon
 S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant
 permissions to a maximum of 30 users and/or predefined Amazon S3 groups.
 
 
 
 
 GranteeType: Specify the type of value that appears in the Grantee object:
 
 
 
 
 Canonical: The value in the Grantee object is either the canonical user ID for an AWS account
 or an origin access identity for an Amazon CloudFront distribution.
 
 
 
 A canonical user ID is not the same as an AWS account number.
 
 
 
 
 Email: The value in the Grantee object is the registered email address of an AWS account.
 
 
 
 
 Group: The value in the Grantee object is one of the following predefined Amazon S3 groups:
 AllUsers, AuthenticatedUsers, or LogDelivery.
 
 
 
 
 
 
 Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or
 group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront
 distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.
 
 
 
 
 Access: The permission that you want to give to the AWS user that you specified in Grantee.
 Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:
 
 
 
 
 READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to
 the Amazon S3 bucket.
 
 
 
 
 READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the
 Amazon S3 bucket.
 
 
 
 
 WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the
 Amazon S3 bucket.
 
 
 
 
 FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP
 permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.
 
 
 
 
 
 
 StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that
 you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.
 
 
 








Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipeline
Pipeline pipeline

 The pipeline updated by this UpdatePipelineResponse call.
 


warnings
SdkInternalList<T> warnings

 Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the
 pipeline.
 
 
 Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS
 key, reduces processing time and prevents cross-regional charges.
 








Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the pipeline to update.
 


status
String status

 The desired status of the pipeline:
 
 
 
 
 Active: The pipeline is processing jobs.
 
 
 
 
 Paused: The pipeline is not currently processing jobs.
 
 
 








Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipeline
Pipeline pipeline

 A section of the response body that provides information about the pipeline.
 








Class com.amazonaws.services.elastictranscoder.model.ValidationException extends AmazonElasticTranscoderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.VideoParameters extends Object implements Serializable


Serialized Fields


codec
String codec

 The video codec for the output file. Valid values include gif, H.264,
 mpeg2, vp8, and vp9. You can only specify vp8 and
 vp9 when the container type is webm, gif when the container type is
 gif, and mpeg2 when the container type is mpg.
 


codecOptions
SdkInternalMap<K,V> codecOptions

 Profile (H.264/VP8/VP9 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/VP9 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/VP9 only)
 
 
 The maximum number of bits in any x seconds of the output video. This window is commonly 10 seconds, the standard
 segment duration when you're using FMP4 or MPEG-TS for the container type of the output video. Specify an integer
 greater than 0. If you specify MaxBitRate and omit BufferSize, Elastic Transcoder sets
 BufferSize to 10 times the value of MaxBitRate.
 
 
 InterlacedMode (Optional, H.264/MPEG2 Only)
 
 
 The interlace mode for the output video.
 
 
 Interlaced video is used to double the perceived frame rate for a video by interlacing two fields (one field on
 every other line, the other field on the other lines) so that the human eye registers multiple pictures per
 frame. Interlacing reduces the bandwidth required for transmitting a video, but can result in blurred images and
 flickering.
 
 
 Valid values include Progressive (no interlacing, top to bottom), TopFirst (top field
 first), BottomFirst (bottom field first), and Auto.
 
 
 If InterlaceMode is not specified, Elastic Transcoder uses Progressive for the output.
 If Auto is specified, Elastic Transcoder interlaces the output.
 
 
 ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)
 
 
 The color space conversion Elastic Transcoder applies to the output video. Color spaces are the algorithms used
 by the computer to store information about how to render color. Bt.601 is the standard for standard
 definition video, while Bt.709 is the standard for high definition video.
 
 
 Valid values include None, Bt709toBt601, Bt601toBt709, and
 Auto.
 
 
 If you chose Auto for ColorSpaceConversionMode and your output is interlaced, your
 frame rate is one of 23.97, 24, 25, 29.97, 50,
 or 60, your SegmentDuration is null, and you are using one of the resolution changes
 from the list below, Elastic Transcoder applies the following color space conversions:
 
 
 
 
 Standard to HD, 720x480 to 1920x1080 - Elastic Transcoder applies Bt601ToBt709
 
 
 
 
 Standard to HD, 720x576 to 1920x1080 - Elastic Transcoder applies Bt601ToBt709
 
 
 
 
 HD to Standard, 1920x1080 to 720x480 - Elastic Transcoder applies Bt709ToBt601
 
 
 
 
 HD to Standard, 1920x1080 to 720x576 - Elastic Transcoder applies Bt709ToBt601
 
 
 
 
 
 Elastic Transcoder may change the behavior of the ColorspaceConversionMode Auto mode in
 the future. All outputs in a playlist must use the same ColorSpaceConversionMode.
 
 
 
 If you do not specify a ColorSpaceConversionMode, Elastic Transcoder does not change the color space
 of a file. If you are unsure what ColorSpaceConversionMode was applied to your output file, you can
 check the AppliedColorSpaceConversion parameter included in your job response. If your job does not
 have an AppliedColorSpaceConversion in its response, no ColorSpaceConversionMode was
 applied.
 
 
 ChromaSubsampling
 
 
 The sampling pattern for the chroma (color) channels of the output video. Valid values include
 yuv420p and yuv422p.
 
 
 yuv420p samples the chroma information of every other horizontal and every other vertical line,
 yuv422p samples the color information of every horizontal line and every other vertical line.
 
 
 LoopCount (Gif Only)
 
 
 The number of times you want the output gif to loop. Valid values include Infinite and integers
 between 0 and 100, inclusive.
 


keyframesMaxDist
String keyframesMaxDist

 Applicable only when the value of Video:Codec is one of H.264, MPEG2, or
 VP8.
 
 
 The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key
 frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a
 string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in
 higher compression but may also discernibly decrease video quality.
 
 
 For Smooth outputs, the FrameRate must have a constant ratio to the
 KeyframesMaxDist. This allows Smooth playlists to switch between different quality
 levels while the file is being played.
 
 
 For example, an input file can have a FrameRate of 30 with a KeyframesMaxDist of 90.
 The output file then needs to have a ratio of 1:3. Valid outputs would have FrameRate of 30, 25, and
 10, and KeyframesMaxDist of 90, 75, and 30, respectively.
 
 
 Alternately, this can be achieved by setting FrameRate to auto and having the same values for
 MaxFrameRate and KeyframesMaxDist.
 


fixedGOP
String fixedGOP

 Applicable only when the value of Video:Codec is one of H.264, MPEG2, or
 VP8.
 
 
 Whether to use a fixed value for FixedGOP. Valid values are true and false
 :
 
 
 
 
 true: Elastic Transcoder uses the value of KeyframesMaxDist for the distance between
 key frames (the number of frames in a group of pictures, or GOP).
 
 
 
 
 false: The distance between key frames can vary.
 
 
 
 
 
 FixedGOP must be set to true for fmp4 containers.
 
 


bitRate
String bitRate

 The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of
 Level and Profile. If you specify auto, Elastic Transcoder uses the
 detected bit rate of the input source. If you specify a value other than auto, we recommend that you
 specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile:
 
 
 Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in
 kilobits/second (high Profile)
 
 
 
 
 1 - 64 : 80
 
 
 
 
 1b - 128 : 160
 
 
 
 
 1.1 - 192 : 240
 
 
 
 
 1.2 - 384 : 480
 
 
 
 
 1.3 - 768 : 960
 
 
 
 
 2 - 2000 : 2500
 
 
 
 
 3 - 10000 : 12500
 
 
 
 
 3.1 - 14000 : 17500
 
 
 
 
 3.2 - 20000 : 25000
 
 
 
 
 4 - 20000 : 25000
 
 
 
 
 4.1 - 50000 : 62500
 
 
 


frameRate
String frameRate

 The frames per second for the video stream in the output file. Valid values include:
 
 
 auto, 10, 15, 23.97, 24, 25,
 29.97, 30, 60
 
 
 If you specify auto, Elastic Transcoder uses the detected frame rate of the input source. If you
 specify a frame rate, we recommend that you perform the following calculation:
 
 
 Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)
 
 
 where:
 
 
 
 
 width in pixels and height in pixels represent the Resolution of the output video.
 
 
 
 
 maximum recommended decoding speed in Luma samples/second is less than or equal to the maximum value
 listed in the following table, based on the value that you specified for Level.
 
 
 
 
 The maximum recommended decoding speed in Luma samples/second for each level is described in the following list
 (Level - Decoding speed):
 
 
 
 
 1 - 380160
 
 
 
 
 1b - 380160
 
 
 
 
 1.1 - 76800
 
 
 
 
 1.2 - 1536000
 
 
 
 
 1.3 - 3041280
 
 
 
 
 2 - 3041280
 
 
 
 
 2.1 - 5068800
 
 
 
 
 2.2 - 5184000
 
 
 
 
 3 - 10368000
 
 
 
 
 3.1 - 27648000
 
 
 
 
 3.2 - 55296000
 
 
 
 
 4 - 62914560
 
 
 
 
 4.1 - 62914560
 
 
 


maxFrameRate
String maxFrameRate

 If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of the input
 video for the frame rate of the output video. Specify the maximum frame rate that you want Elastic Transcoder to
 use when the frame rate of the input video is greater than the desired maximum frame rate of the output video.
 Valid values include: 10, 15, 23.97, 24, 25,
 29.97, 30, 60.
 


resolution
String resolution

 
 To better control resolution and aspect ratio of output videos, we recommend that you use the values
 MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and
 DisplayAspectRatio instead of Resolution and AspectRatio. The two groups
 of settings are mutually exclusive. Do not use them together.
 
 
 
 The width and height of the video in the output file, in pixels. Valid values are auto and
 width x height:
 
 
 
 
 auto: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the
 following rules.
 
 
 
 
  width x height : The width and height of the output video in pixels.
 
 
 
 
 Note the following about specifying the width and height:
 
 
 
 
 The width must be an even integer between 128 and 4096, inclusive.
 
 
 
 
 The height must be an even integer between 96 and 3072, inclusive.
 
 
 
 
 If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the
 output file to the lower resolution.
 
 
 
 
 If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales
 the output to the higher resolution.
 
 
 
 
 We recommend that you specify a resolution for which the product of width and height is less than or equal to the
 applicable value in the following list (List - Max width x height value):
 
 
 
 
 1 - 25344
 
 
 
 
 1b - 25344
 
 
 
 
 1.1 - 101376
 
 
 
 
 1.2 - 101376
 
 
 
 
 1.3 - 101376
 
 
 
 
 2 - 101376
 
 
 
 
 2.1 - 202752
 
 
 
 
 2.2 - 404720
 
 
 
 
 3 - 404720
 
 
 
 
 3.1 - 921600
 
 
 
 
 3.2 - 1310720
 
 
 
 
 4 - 2097152
 
 
 
 
 4.1 - 2097152
 
 
 
 
 


aspectRatio
String aspectRatio

 
 To better control resolution and aspect ratio of output videos, we recommend that you use the values
 MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and
 DisplayAspectRatio instead of Resolution and AspectRatio. The two groups
 of settings are mutually exclusive. Do not use them together.
 
 
 
 The display aspect ratio of the video in the output file. Valid values include:
 
 
 auto, 1:1, 4:3, 3:2, 16:9
 
 
 If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input file.
 
 
 If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic
 Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to
 maintain the aspect ratio of the active region of the video.
 


maxWidth
String maxWidth

 The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder uses 1920
 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096.
 


maxHeight
String maxHeight

 The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder uses 1080
 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072.
 


displayAspectRatio
String displayAspectRatio

 The value that Elastic Transcoder adds to the metadata in the output file.
 


sizingPolicy
String sizingPolicy

 Specify one of the following values to control scaling of the output video:
 
 
 
 
 Fit: Elastic Transcoder scales the output video so it matches the value that you specified in either
 MaxWidth or MaxHeight without exceeding the other value.
 
 
 
 
 Fill: Elastic Transcoder scales the output video so it matches the value that you specified in
 either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder
 centers the output video and then crops it in the dimension (if any) that exceeds the maximum value.
 
 
 
 
 Stretch: Elastic Transcoder stretches the output video to match the values that you specified for
 MaxWidth and MaxHeight. If the relative proportions of the input video and the output
 video are different, the output video will be distorted.
 
 
 
 
 Keep: Elastic Transcoder does not scale the output video. If either dimension of the input video
 exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder
 crops the output video.
 
 
 
 
 ShrinkToFit: Elastic Transcoder scales the output video down so that its dimensions match the values
 that you specified for at least one of MaxWidth and MaxHeight without exceeding either
 value. If you specify this option, Elastic Transcoder does not scale the video up.
 
 
 
 
 ShrinkToFill: Elastic Transcoder scales the output video down so that its dimensions match the
 values that you specified for at least one of MaxWidth and MaxHeight without dropping
 below either value. If you specify this option, Elastic Transcoder does not scale the video up.
 
 
 


paddingPolicy
String paddingPolicy

 When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and
 bottom and/or left and right sides of the output video to make the total size of the output video match the
 values that you specified for MaxWidth and MaxHeight.
 


watermarks
SdkInternalList<T> watermarks

 Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos
 that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in
 the specified size and location, and with the specified opacity for the duration of the transcoded video.
 
 
 Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the
 .png format, which supports transparency.
 
 
 When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic
 Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify
 watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have
 different dimensions.
 








Class com.amazonaws.services.elastictranscoder.model.Warning extends Object implements Serializable


Serialized Fields


code
String code

 The code of the cross-regional warning.
 


message
String message

 The message explaining what resources are in a different region from the pipeline.
 
 
 
 AWS KMS keys must be in the same region as the pipeline.
 
 








Package com.amazonaws.services.eventbridge.model




Class com.amazonaws.services.eventbridge.model.ActivateEventSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the partner event source to activate.
 








Class com.amazonaws.services.eventbridge.model.ActivateEventSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.eventbridge.model.AmazonEventBridgeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eventbridge.model.AwsVpcConfiguration extends Object implements Serializable


Serialized Fields


subnets
List<E> subnets

 Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as
 many as 16 subnets.
 


securityGroups
List<E> securityGroups

 Specifies the security groups associated with the task. These security groups must all be in the same VPC. You
 can specify as many as five security groups. If you don't specify a security group, the default security group
 for the VPC is used.
 


assignPublicIp
String assignPublicIp

 Specifies whether the task's elastic network interface receives a public IP address. You can specify
 ENABLED only when LaunchType in EcsParameters is set to
 FARGATE.
 








Class com.amazonaws.services.eventbridge.model.BatchArrayProperties extends Object implements Serializable


Serialized Fields


size
Integer size

 The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
 








Class com.amazonaws.services.eventbridge.model.BatchParameters extends Object implements Serializable


Serialized Fields


jobDefinition
String jobDefinition

 The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must
 already exist.
 


jobName
String jobName

 The name to use for this execution of the job, if the target is an AWS Batch job.
 


arrayProperties
BatchArrayProperties arrayProperties

 The array properties for the submitted job, such as the size of the array. The array size can be between 2 and
 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the
 target is an AWS Batch job.
 


retryStrategy
BatchRetryStrategy retryStrategy

 The retry strategy to use for failed jobs if the target is an AWS Batch job. The retry strategy is the number of
 times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it
 overrides the retry strategy defined in the job definition.
 








Class com.amazonaws.services.eventbridge.model.BatchRetryStrategy extends Object implements Serializable


Serialized Fields


attempts
Integer attempts

 The number of times to attempt to retry, if the job fails. Valid values are 1–10.
 








Class com.amazonaws.services.eventbridge.model.ConcurrentModificationException extends AmazonEventBridgeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eventbridge.model.Condition extends Object implements Serializable


Serialized Fields


type
String type

 The type of condition. Currently, the only supported value is StringEquals.
 


key
String key

 The key for the condition. Currently, the only supported key is aws:PrincipalOrgID.
 


value
String value

 The value for the key. Currently, this must be the ID of the organization.
 








Class com.amazonaws.services.eventbridge.model.CreateEventBusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the new event bus.
 
 
 The names of custom event buses can't contain the / character. You can't use the name
 default for a custom event bus because this name is already used for your account's default event
 bus.
 
 
 If this is a partner event bus, the name must exactly match the name of the partner event source that this event
 bus is matched to. This name will include the / character.
 


eventSourceName
String eventSourceName

 If you're creating a partner event bus, this specifies the partner event source that the new event bus will be
 matched with.
 








Class com.amazonaws.services.eventbridge.model.CreateEventBusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventBusArn
String eventBusArn

 The ARN of the new event bus.
 








Class com.amazonaws.services.eventbridge.model.CreatePartnerEventSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the partner event source. This name must be unique and must be in the format
  partner_name/event_namespace/event_name . The AWS account that wants to use
 this partner event source must create a partner event bus with a name that matches the name of the partner event
 source.
 


account
String account

 The AWS account ID of the customer who is permitted to create a matching partner event bus for this partner event
 source.
 








Class com.amazonaws.services.eventbridge.model.CreatePartnerEventSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventSourceArn
String eventSourceArn

 The ARN of the partner event source.
 








Class com.amazonaws.services.eventbridge.model.DeactivateEventSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the partner event source to deactivate.
 








Class com.amazonaws.services.eventbridge.model.DeactivateEventSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.eventbridge.model.DeleteEventBusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the event bus to delete.
 








Class com.amazonaws.services.eventbridge.model.DeleteEventBusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.eventbridge.model.DeletePartnerEventSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the event source to delete.
 


account
String account

 The AWS account ID of the AWS customer that the event source was created for.
 








Class com.amazonaws.services.eventbridge.model.DeletePartnerEventSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.eventbridge.model.DeleteRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule. If you omit this, the default event bus is used.
 


force
Boolean force

 If this is a managed rule, created by an AWS service on your behalf, you must specify Force as
 True to delete the rule. This parameter is ignored for rules that are not managed rules. You can
 check whether a rule is a managed rule by using DescribeRule or ListRules and checking
 the ManagedBy field of the response.
 








Class com.amazonaws.services.eventbridge.model.DeleteRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.eventbridge.model.DescribeEventBusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the event bus to show details for. If you omit this, the default event bus is displayed.
 








Class com.amazonaws.services.eventbridge.model.DescribeEventBusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the event bus. Currently, this is always default.
 


arn
String arn

 The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
 


policy
String policy

 The policy that enables the external account to send events to your account.
 








Class com.amazonaws.services.eventbridge.model.DescribeEventSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the partner event source to display the details of.
 








Class com.amazonaws.services.eventbridge.model.DescribeEventSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN of the partner event source.
 


createdBy
String createdBy

 The name of the SaaS partner that created the event source.
 


creationTime
Date creationTime

 The date and time that the event source was created.
 


expirationTime
Date expirationTime

 The date and time that the event source will expire if you don't create a matching event bus.
 


name
String name

 The name of the partner event source.
 


state
String state

 The state of the event source. If it's ACTIVE, you have already created a matching event bus for
 this event source, and that event bus is active. If it's PENDING, either you haven't yet created a
 matching event bus, or that event bus is deactivated. If it's DELETED, you have created a matching
 event bus, but the event source has since been deleted.
 








Class com.amazonaws.services.eventbridge.model.DescribePartnerEventSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the event source to display.
 








Class com.amazonaws.services.eventbridge.model.DescribePartnerEventSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The ARN of the event source.
 


name
String name

 The name of the event source.
 








Class com.amazonaws.services.eventbridge.model.DescribeRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule. If you omit this, the default event bus is used.
 








Class com.amazonaws.services.eventbridge.model.DescribeRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


arn
String arn

 The Amazon Resource Name (ARN) of the rule.
 


eventPattern
String eventPattern

 The event pattern. For more information, see Event
 Patterns in the Amazon EventBridge User Guide.
 


scheduleExpression
String scheduleExpression

 The scheduling expression: for example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
 


state
String state

 Specifies whether the rule is enabled or disabled.
 


description
String description

 The description of the rule.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role associated with the rule.
 


managedBy
String managedBy

 If this is a managed rule, created by an AWS service on your behalf, this field displays the principal name of
 the AWS service that created the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule.
 








Class com.amazonaws.services.eventbridge.model.DisableRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule. If you omit this, the default event bus is used.
 








Class com.amazonaws.services.eventbridge.model.DisableRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.eventbridge.model.EcsParameters extends Object implements Serializable


Serialized Fields


taskDefinitionArn
String taskDefinitionArn

 The ARN of the task definition to use if the event target is an Amazon ECS task.
 


taskCount
Integer taskCount

 The number of tasks to create based on TaskDefinition. The default is 1.
 


launchType
String launchType

 Specifies the launch type on which your task is running. The launch type that you specify here must match one of
 the launch type (compatibilities) of the target task. The FARGATE value is supported only in the
 Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS
 in the Amazon Elastic Container Service Developer Guide.
 


networkConfiguration
NetworkConfiguration networkConfiguration

 Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC
 subnets and security groups associated with the task and whether a public IP address is to be used. This
 structure is required if LaunchType is FARGATE because the awsvpc mode is
 required for Fargate tasks.
 
 
 If you specify NetworkConfiguration when the target ECS task doesn't use the awsvpc
 network mode, the task fails.
 


platformVersion
String platformVersion

 Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as
 1.1.0.
 
 
 This structure is used only if LaunchType is FARGATE. For more information about valid
 platform versions, see AWS Fargate Platform
 Versions in the Amazon Elastic Container Service Developer Guide.
 


group
String group

 Specifies an ECS task group for the task. The maximum length is 255 characters.
 








Class com.amazonaws.services.eventbridge.model.EnableRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule. If you omit this, the default event bus is used.
 








Class com.amazonaws.services.eventbridge.model.EnableRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.eventbridge.model.EventBus extends Object implements Serializable


Serialized Fields


name
String name

 The name of the event bus.
 


arn
String arn

 The ARN of the event bus.
 


policy
String policy

 The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.
 








Class com.amazonaws.services.eventbridge.model.EventSource extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the event source.
 


createdBy
String createdBy

 The name of the partner that created the event source.
 


creationTime
Date creationTime

 The date and time when the event source was created.
 


expirationTime
Date expirationTime

 The date and time when the event source will expire if the AWS account doesn't create a matching event bus for
 it.
 


name
String name

 The name of the event source.
 


state
String state

 The state of the event source. If it's ACTIVE, you have already created a matching event bus for
 this event source, and that event bus is active. If it's PENDING, either you haven't yet created a
 matching event bus, or that event bus is deactivated. If it's DELETED, you have created a matching
 event bus, but the event source has since been deleted.
 








Class com.amazonaws.services.eventbridge.model.InputTransformer extends Object implements Serializable


Serialized Fields


inputPathsMap
Map<K,V> inputPathsMap

 Map of JSON paths to be extracted from the event. You can then insert these in the template in
 InputTemplate to produce the output to be sent to the target.
 
 
 InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as
 many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.
 
 
 The keys can't start with "AWS".
 


inputTemplate
String inputTemplate

 Input template where you specify placeholders that will be filled with the values of the keys from
 InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps
 value in brackets: <value>. The InputTemplate must be valid JSON.
 
 
 If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:
 
 
 
 
 The placeholder can't be used as an object key
 
 
 
 
 Object values can't include quote marks
 
 
 
 
 The following example shows the syntax for using InputPathsMap and InputTemplate.
 
 
  "InputTransformer":
 
 
 {
 
 
 "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
 
 
 "InputTemplate": "<instance> is in state <status>"
 
 
 }
 
 
 To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a
 slash, as in the following example:
 
 
  "InputTransformer":
 
 
 {
 
 
 "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
 
 
 "InputTemplate": "<instance> is in state \"<status>\""
 
 
 }
 








Class com.amazonaws.services.eventbridge.model.InternalException extends AmazonEventBridgeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eventbridge.model.InvalidEventPatternException extends AmazonEventBridgeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eventbridge.model.InvalidStateException extends AmazonEventBridgeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eventbridge.model.KinesisParameters extends Object implements Serializable


Serialized Fields


partitionKeyPath
String partitionKeyPath

 The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key
 Concepts in the Amazon Kinesis Streams Developer Guide.
 








Class com.amazonaws.services.eventbridge.model.LimitExceededException extends AmazonEventBridgeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eventbridge.model.ListEventBusesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namePrefix
String namePrefix

 Specifying this limits the results to only those event buses with names that start with the specified prefix.
 


nextToken
String nextToken

 The token returned by a previous call to retrieve the next set of results.
 


limit
Integer limit

 Specifying this limits the number of results returned by this operation. The operation also returns a
 NextToken that you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.eventbridge.model.ListEventBusesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventBuses
List<E> eventBuses

 This list of event buses.
 


nextToken
String nextToken

 A token you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.eventbridge.model.ListEventSourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namePrefix
String namePrefix

 Specifying this limits the results to only those partner event sources with names that start with the specified
 prefix.
 


nextToken
String nextToken

 The token returned by a previous call to retrieve the next set of results.
 


limit
Integer limit

 Specifying this limits the number of results returned by this operation. The operation also returns a
 NextToken that you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.eventbridge.model.ListEventSourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventSources
List<E> eventSources

 The list of event sources.
 


nextToken
String nextToken

 A token you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.eventbridge.model.ListPartnerEventSourceAccountsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventSourceName
String eventSourceName

 The name of the partner event source to display account information about.
 


nextToken
String nextToken

 The token returned by a previous call to this operation. Specifying this retrieves the next set of results.
 


limit
Integer limit

 Specifying this limits the number of results returned by this operation. The operation also returns a
 NextToken that you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.eventbridge.model.ListPartnerEventSourceAccountsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


partnerEventSourceAccounts
List<E> partnerEventSourceAccounts

 The list of partner event sources returned by the operation.
 


nextToken
String nextToken

 A token you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.eventbridge.model.ListPartnerEventSourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namePrefix
String namePrefix

 If you specify this, the results are limited to only those partner event sources that start with the string you
 specify.
 


nextToken
String nextToken

 The token returned by a previous call to this operation. Specifying this retrieves the next set of results.
 


limit
Integer limit

 pecifying this limits the number of results returned by this operation. The operation also returns a
 NextToken that you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.eventbridge.model.ListPartnerEventSourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


partnerEventSources
List<E> partnerEventSources

 The list of partner event sources returned by the operation.
 


nextToken
String nextToken

 A token you can use in a subsequent operation to retrieve the next set of results.
 








Class com.amazonaws.services.eventbridge.model.ListRuleNamesByTargetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetArn
String targetArn

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


eventBusName
String eventBusName

 Limits the results to show only the rules associated with the specified event bus.
 


nextToken
String nextToken

 The token returned by a previous call to retrieve the next set of results.
 


limit
Integer limit

 The maximum number of results to return.
 








Class com.amazonaws.services.eventbridge.model.ListRuleNamesByTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ruleNames
List<E> ruleNames

 The names of the rules that can invoke the given target.
 


nextToken
String nextToken

 Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
 








Class com.amazonaws.services.eventbridge.model.ListRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namePrefix
String namePrefix

 The prefix matching the rule name.
 


eventBusName
String eventBusName

 Limits the results to show only the rules associated with the specified event bus.
 


nextToken
String nextToken

 The token returned by a previous call to retrieve the next set of results.
 


limit
Integer limit

 The maximum number of results to return.
 








Class com.amazonaws.services.eventbridge.model.ListRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rules
List<E> rules

 The rules that match the specified criteria.
 


nextToken
String nextToken

 Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
 








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


Serialized Fields


resourceARN
String resourceARN

 The ARN of the rule for which you want to view tags.
 








Class com.amazonaws.services.eventbridge.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The list of tag keys and values associated with the rule that you specified.
 








Class com.amazonaws.services.eventbridge.model.ListTargetsByRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rule
String rule

 The name of the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule. If you omit this, the default event bus is used.
 


nextToken
String nextToken

 The token returned by a previous call to retrieve the next set of results.
 


limit
Integer limit

 The maximum number of results to return.
 








Class com.amazonaws.services.eventbridge.model.ListTargetsByRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


targets
List<E> targets

 The targets assigned to the rule.
 


nextToken
String nextToken

 Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
 








Class com.amazonaws.services.eventbridge.model.ManagedRuleException extends AmazonEventBridgeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eventbridge.model.NetworkConfiguration extends Object implements Serializable


Serialized Fields


awsvpcConfiguration
AwsVpcConfiguration awsvpcConfiguration

 Use this structure to specify the VPC subnets and security groups for the task and whether a public IP address is
 to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
 








Class com.amazonaws.services.eventbridge.model.PartnerEventSource extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the partner event source.
 


name
String name

 The name of the partner event source.
 








Class com.amazonaws.services.eventbridge.model.PartnerEventSourceAccount extends Object implements Serializable


Serialized Fields


account
String account

 The AWS account ID that the partner event source was offered to.
 


creationTime
Date creationTime

 The date and time when the event source was created.
 


expirationTime
Date expirationTime

 The date and time when the event source will expire if the AWS account doesn't create a matching event bus for
 it.
 


state
String state

 The state of the event source. If it's ACTIVE, you have already created a matching event bus for
 this event source, and that event bus is active. If it's PENDING, either you haven't yet created a
 matching event bus, or that event bus is deactivated. If it's DELETED, you have created a matching
 event bus, but the event source has since been deleted.
 








Class com.amazonaws.services.eventbridge.model.PolicyLengthExceededException extends AmazonEventBridgeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eventbridge.model.PutEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


entries
List<E> entries

 The entry that defines an event in your system. You can specify several parameters for the entry such as the
 source and type of the event, resources associated with the event, and so on.
 








Class com.amazonaws.services.eventbridge.model.PutEventsRequestEntry extends Object implements Serializable


Serialized Fields


time
Date time

 The timestamp of the event, per RFC3339. If no timestamp
 is provided, the timestamp of the PutEvents call is used.
 


source
String source

 The source of the event. This field is required.
 


resources
List<E> resources

 AWS resources, identified by Amazon Resource Name (ARN), that the event primarily concerns. Any number, including
 zero, can be present.
 


detailType
String detailType

 Free-form string used to decide which fields to expect in the event detail. This field is required.
 


detail
String detail

 A valid JSON object. There is no other schema imposed. The JSON object can contain fields and nested subobjects.
 
 
 This field is required.
 


eventBusName
String eventBusName

 The event bus that will receive the event. Only the rules that are associated with this event bus can match the
 event.
 








Class com.amazonaws.services.eventbridge.model.PutEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedEntryCount
Integer failedEntryCount

 The number of failed entries.
 


entries
List<E> entries

 The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the
 event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.
 








Class com.amazonaws.services.eventbridge.model.PutEventsResultEntry extends Object implements Serializable


Serialized Fields


eventId
String eventId

 The ID of the event.
 


errorCode
String errorCode

 The error code that indicates why the event submission failed.
 


errorMessage
String errorMessage

 The error message that explains why the event submission failed.
 








Class com.amazonaws.services.eventbridge.model.PutPartnerEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


entries
List<E> entries

 The list of events to write to the event bus.
 








Class com.amazonaws.services.eventbridge.model.PutPartnerEventsRequestEntry extends Object implements Serializable


Serialized Fields


time
Date time

 The date and time of the event.
 


source
String source

 The event source that is generating the evntry. This field is required.
 


resources
List<E> resources

 AWS resources, identified by Amazon Resource Name (ARN), that the event primarily concerns. Any number, including
 zero, can be present.
 


detailType
String detailType

 A free-form string used to decide which fields to expect in the event detail. This field is required.
 


detail
String detail

 A valid JSON object. There is no other schema imposed. The JSON object can contain fields and nested subobjects.
 This field is required.
 








Class com.amazonaws.services.eventbridge.model.PutPartnerEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedEntryCount
Integer failedEntryCount

 The number of events from this operation that couldn't be written to the partner event bus.
 


entries
List<E> entries

 The list of events from this operation that were successfully written to the partner event bus.
 








Class com.amazonaws.services.eventbridge.model.PutPartnerEventsResultEntry extends Object implements Serializable


Serialized Fields


eventId
String eventId

 The ID of the event.
 


errorCode
String errorCode

 The error code that indicates why the event submission failed.
 


errorMessage
String errorMessage

 The error message that explains why the event submission failed.
 








Class com.amazonaws.services.eventbridge.model.PutPermissionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventBusName
String eventBusName

 The event bus associated with the rule. If you omit this, the default event bus is used.
 


action
String action

 The action that you're enabling the other account to perform. Currently, this must be
 events:PutEvents.
 


principal
String principal

 The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to
 permit any account to put events to your default event bus.
 
 
 If you specify "*" without specifying Condition, avoid creating rules that might match undesirable
 events. To create more secure rules, make sure that the event pattern for each rule contains an
 account field with a specific account ID to receive events from. Rules that have an account field
 match events sent only from accounts that are listed in the rule's account field.
 


statementId
String statementId

 An identifier string for the external account that you're granting permissions to. If you later want to revoke
 the permission for this external account, specify this StatementId when you run
 RemovePermission.
 


condition
Condition condition

 This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a
 member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS
 Organizations? in the AWS Organizations User Guide.
 
 
 If you specify Condition with an AWS organization ID and specify "*" as the value for
 Principal, you grant permission to all the accounts in the named organization.
 
 
 The Condition is a JSON string that must contain Type, Key, and
 Value fields.
 








Class com.amazonaws.services.eventbridge.model.PutPermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.eventbridge.model.PutRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the rule that you're creating or updating.
 
 
 A rule can't have the same name as another rule in the same Region or on the same event bus.
 


scheduleExpression
String scheduleExpression

 The scheduling expression: for example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
 


eventPattern
String eventPattern

 The event pattern. For more information, see Event
 Patterns in the Amazon EventBridge User Guide.
 


state
String state

 Indicates whether the rule is enabled or disabled.
 


description
String description

 A description of the rule.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role associated with the rule.
 


tags
List<E> tags

 The list of key-value pairs to associate with the rule.
 


eventBusName
String eventBusName

 The event bus to associate with this rule. If you omit this, the default event bus is used.
 








Class com.amazonaws.services.eventbridge.model.PutRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ruleArn
String ruleArn

 The Amazon Resource Name (ARN) of the rule.
 








Class com.amazonaws.services.eventbridge.model.PutTargetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rule
String rule

 The name of the rule.
 


eventBusName
String eventBusName

 The name of the event bus associated with the rule. If you omit this, the default event bus is used.
 


targets
List<E> targets

 The targets to update or add to the rule.
 








Class com.amazonaws.services.eventbridge.model.PutTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedEntryCount
Integer failedEntryCount

 The number of failed entries.
 


failedEntries
List<E> failedEntries

 The failed target entries.
 








Class com.amazonaws.services.eventbridge.model.PutTargetsResultEntry extends Object implements Serializable


Serialized Fields


targetId
String targetId

 The ID of the target.
 


errorCode
String errorCode

 The error code that indicates why the target addition failed. If the value is
 ConcurrentModificationException, too many requests were made at the same time.
 


errorMessage
String errorMessage

 The error message that explains why the target addition failed.
 








Class com.amazonaws.services.eventbridge.model.RemovePermissionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


statementId
String statementId

 The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.
 


eventBusName
String eventBusName

 The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.
 








Class com.amazonaws.services.eventbridge.model.RemovePermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.eventbridge.model.RemoveTargetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rule
String rule

 The name of the rule.
 


eventBusName
String eventBusName

 The name of the event bus associated with the rule.
 


ids
List<E> ids

 The IDs of the targets to remove from the rule.
 


force
Boolean force

 If this is a managed rule created by an AWS service on your behalf, you must specify Force as
 True to remove targets. This parameter is ignored for rules that aren't managed rules. You can check
 whether a rule is a managed rule by using DescribeRule or ListRules and checking the
 ManagedBy field of the response.
 








Class com.amazonaws.services.eventbridge.model.RemoveTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedEntryCount
Integer failedEntryCount

 The number of failed entries.
 


failedEntries
List<E> failedEntries

 The failed target entries.
 








Class com.amazonaws.services.eventbridge.model.RemoveTargetsResultEntry extends Object implements Serializable


Serialized Fields


targetId
String targetId

 The ID of the target.
 


errorCode
String errorCode

 The error code that indicates why the target removal failed. If the value is
 ConcurrentModificationException, too many requests were made at the same time.
 


errorMessage
String errorMessage

 The error message that explains why the target removal failed.
 








Class com.amazonaws.services.eventbridge.model.ResourceAlreadyExistsException extends AmazonEventBridgeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eventbridge.model.ResourceNotFoundException extends AmazonEventBridgeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.eventbridge.model.Rule extends Object implements Serializable


Serialized Fields


name
String name

 The name of the rule.
 


arn
String arn

 The Amazon Resource Name (ARN) of the rule.
 


eventPattern
String eventPattern

 The event pattern of the rule. For more information, see Event
 Patterns in the Amazon EventBridge User Guide.
 


state
String state

 The state of the rule.
 


description
String description

 The description of the rule.
 


scheduleExpression
String scheduleExpression

 The scheduling expression: for example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the role that is used for target invocation.
 


managedBy
String managedBy

 If an AWS service created the rule on behalf of your account, this field displays the principal name of the
 service that created the rule.
 


eventBusName
String eventBusName

 The event bus associated with the rule.
 








Class com.amazonaws.services.eventbridge.model.RunCommandParameters extends Object implements Serializable


Serialized Fields


runCommandTargets
List<E> runCommandTargets

 Currently, we support including only one RunCommandTarget block, which specifies either an array of
 InstanceIds or a tag.
 








Class com.amazonaws.services.eventbridge.model.RunCommandTarget extends Object implements Serializable


Serialized Fields


key
String key

 Can be either tag: tag-key or InstanceIds.
 


values
List<E> values

 If Key is tag: tag-key, Values is a list of tag values. If
 Key is InstanceIds, Values is a list of Amazon EC2 instance IDs.
 








Class com.amazonaws.services.eventbridge.model.SqsParameters extends Object implements Serializable


Serialized Fields


messageGroupId
String messageGroupId

 The FIFO message group ID to use as the target.
 








Class com.amazonaws.services.eventbridge.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A string that you can use to assign a value. The combination of tag keys and values can help you organize and
 categorize your resources.
 


value
String value

 The value for the specified tag key.
 








Class com.amazonaws.services.eventbridge.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the rule that you're adding tags to.
 


tags
List<E> tags

 The list of key-value pairs to associate with the rule.
 








Class com.amazonaws.services.eventbridge.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.eventbridge.model.Target extends Object implements Serializable


Serialized Fields


id
String id

 A name for the target. Use a string that will help you identify the target. Each target associated with a rule
 must have an Id unique for that rule.
 


arn
String arn

 The Amazon Resource Name (ARN) of the target.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule
 triggers multiple targets, you can use a different IAM role for each target.
 


input
String input

 Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For
 more information, 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.
 You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.
 


inputTransformer
InputTransformer inputTransformer

 Settings to enable you to provide custom input to a target based on certain event data. You can extract one or
 more key-value pairs from the event and then use that data to send customized input to the target.
 


kinesisParameters
KinesisParameters kinesisParameters

 The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream.
 If you don't include this parameter, the default is to use the eventId as the partition key.
 


runCommandParameters
RunCommandParameters runCommandParameters

 Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
 


ecsParameters
EcsParameters ecsParameters

 Contains the Amazon ECS task definition and task count to be used if the event target is an Amazon ECS task. For
 more information about Amazon ECS tasks, see Task Definitions  in
 the Amazon EC2 Container Service Developer Guide.
 


batchParameters
BatchParameters batchParameters

 If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For
 more information, see Jobs in the
 AWS Batch User Guide.
 


sqsParameters
SqsParameters sqsParameters

 Contains the message group ID to use when the target is a FIFO queue.
 
 
 If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
 








Class com.amazonaws.services.eventbridge.model.TestEventPatternRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventPattern
String eventPattern

 The event pattern. For more information, see Event
 Patterns in the Amazon EventBridge User Guide.
 


event
String event

 The event, in JSON format, to test against the event pattern.
 








Class com.amazonaws.services.eventbridge.model.TestEventPatternResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


result
Boolean result

 Indicates whether the event matches the event pattern.
 








Class com.amazonaws.services.eventbridge.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the rule that you're removing tags from.
 


tagKeys
List<E> tagKeys

 The list of tag keys to remove from the resource.
 








Class com.amazonaws.services.eventbridge.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.fms.model




Class com.amazonaws.services.fms.model.AssociateAdminAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


adminAccount
String adminAccount

 The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This
 can be an AWS Organizations master account or a member account. For more information about AWS Organizations and
 master accounts, see Managing the AWS
 Accounts in Your Organization.
 








Class com.amazonaws.services.fms.model.AssociateAdminAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.fms.model.AWSFMSException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fms.model.ComplianceViolator extends Object implements Serializable


Serialized Fields


resourceId
String resourceId

 The resource ID.
 


violationReason
String violationReason

 The reason that the resource is not protected by the policy.
 


resourceType
String resourceType

 The resource type. This is in the format shown in the AWS
 Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer or
 AWS::CloudFront::Distribution.
 








Class com.amazonaws.services.fms.model.DeleteNotificationChannelRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.fms.model.DeleteNotificationChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.fms.model.DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The ID of the policy that you want to delete. PolicyId is returned by PutPolicy and by
 ListPolicies.
 


deleteAllPolicyResources
Boolean deleteAllPolicyResources

 If True, the request performs cleanup according to the policy type.
 
 
 For AWS WAF and Shield Advanced policies, the cleanup does the following:
 
 
 
 
 Deletes rule groups created by AWS Firewall Manager
 
 
 
 
 Removes web ACLs from in-scope resources
 
 
 
 
 Deletes web ACLs that contain no rules or rule groups
 
 
 
 
 For security group policies, the cleanup does the following for each security group in the policy:
 
 
 
 
 Disassociates the security group from in-scope resources
 
 
 
 
 Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any
 resources through another policy
 
 
 
 
 After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of
 out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you
 associate with the policy. When creating the policy, if you specify that only resources in specific accounts or
 with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others
 are out of scope. If you don't specify tags or accounts, all resources are in scope.
 








Class com.amazonaws.services.fms.model.DeletePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.fms.model.DisassociateAdminAccountRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.fms.model.DisassociateAdminAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.fms.model.EvaluationResult extends Object implements Serializable


Serialized Fields


complianceStatus
String complianceStatus

 Describes an AWS account's compliance with the AWS Firewall Manager policy.
 


violatorCount
Long violatorCount

 The number of resources that are noncompliant with the specified policy. For AWS WAF and Shield Advanced
 policies, a resource is considered noncompliant if it is not associated with the policy. For security group
 policies, a resource is considered noncompliant if it doesn't comply with the rules of the policy and remediation
 is disabled or not possible.
 


evaluationLimitExceeded
Boolean evaluationLimitExceeded

 Indicates that over 100 resources are noncompliant with the AWS Firewall Manager policy.
 








Class com.amazonaws.services.fms.model.GetAdminAccountRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.fms.model.GetAdminAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


adminAccount
String adminAccount

 The AWS account that is set as the AWS Firewall Manager administrator.
 


roleStatus
String roleStatus

 The status of the AWS account that you set as the AWS Firewall Manager administrator.
 








Class com.amazonaws.services.fms.model.GetComplianceDetailRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The ID of the policy that you want to get the details for. PolicyId is returned by
 PutPolicy and by ListPolicies.
 


memberAccount
String memberAccount

 The AWS account that owns the resources that you want to get the details for.
 








Class com.amazonaws.services.fms.model.GetComplianceDetailResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyComplianceDetail
PolicyComplianceDetail policyComplianceDetail

 Information about the resources and the policy that you specified in the GetComplianceDetail
 request.
 








Class com.amazonaws.services.fms.model.GetNotificationChannelRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.fms.model.GetNotificationChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


snsTopicArn
String snsTopicArn

 The SNS topic that records AWS Firewall Manager activity.
 


snsRoleName
String snsRoleName

 The IAM role that is used by AWS Firewall Manager to record activity to SNS.
 








Class com.amazonaws.services.fms.model.GetPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The ID of the AWS Firewall Manager policy that you want the details for.
 








Class com.amazonaws.services.fms.model.GetPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
Policy policy

 Information about the specified AWS Firewall Manager policy.
 


policyArn
String policyArn

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








Class com.amazonaws.services.fms.model.GetProtectionStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The ID of the policy for which you want to get the attack information.
 


memberAccountId
String memberAccountId

 The AWS account that is in scope of the policy that you want to get the details for.
 


startTime
Date startTime

 The start of the time period to query for the attacks. This is a timestamp type. The request syntax
 listing indicates a number type because the default used by AWS Firewall Manager is Unix time in
 seconds. However, any valid timestamp format is allowed.
 


endTime
Date endTime

 The end of the time period to query for the attacks. This is a timestamp type. The request syntax
 listing indicates a number type because the default used by AWS Firewall Manager is Unix time in
 seconds. However, any valid timestamp format is allowed.
 


nextToken
String nextToken

 If you specify a value for MaxResults and you have more objects than the number that you specify for
 MaxResults, AWS Firewall Manager returns a NextToken value in the response, which you
 can use to retrieve another group of objects. For the second and subsequent GetProtectionStatus
 requests, specify the value of NextToken from the previous response to get information about another
 batch of objects.
 


maxResults
Integer maxResults

 Specifies the number of objects that you want AWS Firewall Manager to return for this request. If you have more
 objects than the number that you specify for MaxResults, the response includes a
 NextToken value that you can use to get another batch of objects.
 








Class com.amazonaws.services.fms.model.GetProtectionStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


adminAccountId
String adminAccountId

 The ID of the AWS Firewall administrator account for this policy.
 


serviceType
String serviceType

 The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED.
 


data
String data

 Details about the attack, including the following:
 
 
 
 
 Attack type
 
 
 
 
 Account ID
 
 
 
 
 ARN of the resource attacked
 
 
 
 
 Start time of the attack
 
 
 
 
 End time of the attack (ongoing attacks will not have an end time)
 
 
 
 
 The details are in JSON format.
 


nextToken
String nextToken

 If you have more objects than the number that you specified for MaxResults in the request, the
 response includes a NextToken value. To list more objects, submit another
 GetProtectionStatus request, and specify the NextToken value from the response in the
 NextToken value in the next request.
 
 
 AWS SDKs provide auto-pagination that identify NextToken in a response and make subsequent request
 calls automatically on your behalf. However, this feature is not supported by GetProtectionStatus.
 You must submit subsequent requests with NextToken using your own processes.
 








Class com.amazonaws.services.fms.model.InternalErrorException extends AWSFMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fms.model.InvalidInputException extends AWSFMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fms.model.InvalidOperationException extends AWSFMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fms.model.InvalidTypeException extends AWSFMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fms.model.LimitExceededException extends AWSFMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fms.model.ListComplianceStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The ID of the AWS Firewall Manager policy that you want the details for.
 


nextToken
String nextToken

 If you specify a value for MaxResults and you have more PolicyComplianceStatus objects
 than the number that you specify for MaxResults, AWS Firewall Manager returns a
 NextToken value in the response that allows you to list another group of
 PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus
 requests, specify the value of NextToken from the previous response to get information about another
 batch of PolicyComplianceStatus objects.
 


maxResults
Integer maxResults

 Specifies the number of PolicyComplianceStatus objects that you want AWS Firewall Manager to return
 for this request. If you have more PolicyComplianceStatus objects than the number that you specify
 for MaxResults, the response includes a NextToken value that you can use to get another
 batch of PolicyComplianceStatus objects.
 








Class com.amazonaws.services.fms.model.ListComplianceStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyComplianceStatusList
List<E> policyComplianceStatusList

 An array of PolicyComplianceStatus objects.
 


nextToken
String nextToken

 If you have more PolicyComplianceStatus objects than the number that you specified for
 MaxResults in the request, the response includes a NextToken value. To list more
 PolicyComplianceStatus objects, submit another ListComplianceStatus request, and
 specify the NextToken value from the response in the NextToken value in the next
 request.
 








Class com.amazonaws.services.fms.model.ListMemberAccountsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If you specify a value for MaxResults and you have more account IDs than the number that you specify
 for MaxResults, AWS Firewall Manager returns a NextToken value in the response that
 allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest
 requests, specify the value of NextToken from the previous response to get information about another
 batch of member account IDs.
 


maxResults
Integer maxResults

 Specifies the number of member account IDs that you want AWS Firewall Manager to return for this request. If you
 have more IDs than the number that you specify for MaxResults, the response includes a
 NextToken value that you can use to get another batch of member account IDs.
 








Class com.amazonaws.services.fms.model.ListMemberAccountsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


memberAccounts
List<E> memberAccounts

 An array of account IDs.
 


nextToken
String nextToken

 If you have more member account IDs than the number that you specified for MaxResults in the
 request, the response includes a NextToken value. To list more IDs, submit another
 ListMemberAccounts request, and specify the NextToken value from the response in the
 NextToken value in the next request.
 








Class com.amazonaws.services.fms.model.ListPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If you specify a value for MaxResults and you have more PolicySummary objects than the
 number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value
 in the response that allows you to list another group of PolicySummary objects. For the second and
 subsequent ListPolicies requests, specify the value of NextToken from the previous
 response to get information about another batch of PolicySummary objects.
 


maxResults
Integer maxResults

 Specifies the number of PolicySummary objects that you want AWS Firewall Manager to return for this
 request. If you have more PolicySummary objects than the number that you specify for
 MaxResults, the response includes a NextToken value that you can use to get another
 batch of PolicySummary objects.
 








Class com.amazonaws.services.fms.model.ListPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyList
List<E> policyList

 An array of PolicySummary objects.
 


nextToken
String nextToken

 If you have more PolicySummary objects than the number that you specified for
 MaxResults in the request, the response includes a NextToken value. To list more
 PolicySummary objects, submit another ListPolicies request, and specify the
 NextToken value from the response in the NextToken value in the next request.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource to return tags for. The Firewall Manager policy is the only AWS
 resource that supports tagging, so this ARN is a policy ARN..
 








Class com.amazonaws.services.fms.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagList
List<E> tagList

 The tags associated with the resource.
 








Class com.amazonaws.services.fms.model.Policy extends Object implements Serializable


Serialized Fields


policyId
String policyId

 The ID of the AWS Firewall Manager policy.
 


policyName
String policyName

 The friendly name of the AWS Firewall Manager policy.
 


policyUpdateToken
String policyUpdateToken

 A unique identifier for each update to the policy. When issuing a PutPolicy request, the
 PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy
 version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy
 request.
 


securityServicePolicyData
SecurityServicePolicyData securityServicePolicyData

 Details about the security service that is being used to protect the resources.
 


resourceType
String resourceType

 The type of resource protected by or in scope of the policy. This is in the format shown in the AWS
 Resource Types Reference. For AWS WAF and Shield Advanced, examples include
 AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution. For a
 security group common policy, valid values are AWS::EC2::NetworkInterface and
 AWS::EC2::Instance. For a security group content audit policy, valid values are
 AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and
 AWS::EC2::Instance. For a security group usage audit policy, the value is
 AWS::EC2::SecurityGroup.
 


resourceTypeList
List<E> resourceTypeList

 An array of ResourceType.
 


resourceTags
List<E> resourceTags

 An array of ResourceTag objects.
 


excludeResourceTags
Boolean excludeResourceTags

 If set to True, resources with the tags that are specified in the ResourceTag array are
 not in scope of the policy. If set to False, and the ResourceTag array is not null,
 only resources with the specified tags are in scope of the policy.
 


remediationEnabled
Boolean remediationEnabled

 Indicates if the policy should be automatically applied to new resources.
 


includeMap
Map<K,V> includeMap

 Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the
 organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values
 listed in IncludeMap are included in the policy.
 
 
 The key to the map is ACCOUNT. For example, a valid IncludeMap would be
 {“ACCOUNT” : [“accountID1”, “accountID2”]}.
 


excludeMap
Map<K,V> excludeMap

 Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first,
 with all the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are
 removed, resulting in the final list of accounts to add to the policy.
 
 
 The key to the map is ACCOUNT. For example, a valid ExcludeMap would be
 {“ACCOUNT” : [“accountID1”, “accountID2”]}.
 








Class com.amazonaws.services.fms.model.PolicyComplianceDetail extends Object implements Serializable


Serialized Fields


policyOwner
String policyOwner

 The AWS account that created the AWS Firewall Manager policy.
 


policyId
String policyId

 The ID of the AWS Firewall Manager policy.
 


memberAccount
String memberAccount

 The AWS account ID.
 


violators
List<E> violators

 An array of resources that aren't protected by the AWS WAF or Shield Advanced policy or that aren't in compliance
 with the security group policy.
 


evaluationLimitExceeded
Boolean evaluationLimitExceeded

 Indicates if over 100 resources are noncompliant with the AWS Firewall Manager policy.
 


expiredAt
Date expiredAt

 A timestamp that indicates when the returned information should be considered out of date.
 


issueInfoMap
Map<K,V> issueInfoMap

 Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be
 noncompliant. The details include the name of the dependent service and the error message received that indicates
 the problem with the service.
 








Class com.amazonaws.services.fms.model.PolicyComplianceStatus extends Object implements Serializable


Serialized Fields


policyOwner
String policyOwner

 The AWS account that created the AWS Firewall Manager policy.
 


policyId
String policyId

 The ID of the AWS Firewall Manager policy.
 


policyName
String policyName

 The friendly name of the AWS Firewall Manager policy.
 


memberAccount
String memberAccount

 The member account ID.
 


evaluationResults
List<E> evaluationResults

 An array of EvaluationResult objects.
 


lastUpdated
Date lastUpdated

 Timestamp of the last update to the EvaluationResult objects.
 


issueInfoMap
Map<K,V> issueInfoMap

 Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be
 noncompliant. The details include the name of the dependent service and the error message received that indicates
 the problem with the service.
 








Class com.amazonaws.services.fms.model.PolicySummary extends Object implements Serializable


Serialized Fields


policyArn
String policyArn

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


policyId
String policyId

 The ID of the specified policy.
 


policyName
String policyName

 The friendly name of the specified policy.
 


resourceType
String resourceType

 The type of resource protected by or in scope of the policy. This is in the format shown in the AWS
 Resource Types Reference. For AWS WAF and Shield Advanced, examples include
 AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution. For a
 security group common policy, valid values are AWS::EC2::NetworkInterface and
 AWS::EC2::Instance. For a security group content audit policy, valid values are
 AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and
 AWS::EC2::Instance. For a security group usage audit policy, the value is
 AWS::EC2::SecurityGroup.
 


securityServiceType
String securityServiceType

 The service that the policy is using to protect the resources. This specifies the type of policy that is created,
 either an AWS WAF policy, a Shield Advanced policy, or a security group policy.
 


remediationEnabled
Boolean remediationEnabled

 Indicates if the policy should be automatically applied to new resources.
 








Class com.amazonaws.services.fms.model.PutNotificationChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


snsTopicArn
String snsTopicArn

 The Amazon Resource Name (ARN) of the SNS topic that collects notifications from AWS Firewall Manager.
 


snsRoleName
String snsRoleName

 The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record AWS Firewall Manager activity.
 








Class com.amazonaws.services.fms.model.PutNotificationChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.fms.model.PutPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policy
Policy policy

 The details of the AWS Firewall Manager policy to be created.
 


tagList
List<E> tagList

 The tags to add to the AWS resource.
 








Class com.amazonaws.services.fms.model.PutPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
Policy policy

 The details of the AWS Firewall Manager policy that was created.
 


policyArn
String policyArn

 The Amazon Resource Name (ARN) of the policy that was created.
 








Class com.amazonaws.services.fms.model.ResourceNotFoundException extends AWSFMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fms.model.ResourceTag extends Object implements Serializable


Serialized Fields


key
String key

 The resource tag key.
 


value
String value

 The resource tag value.
 








Class com.amazonaws.services.fms.model.SecurityServicePolicyData extends Object implements Serializable


Serialized Fields


type
String type

 The service that the policy is using to protect the resources. This specifies the type of policy that is created,
 either an AWS WAF policy, a Shield Advanced policy, or a security group policy. For security group policies,
 Firewall Manager supports one security group for each common policy and for each content audit policy. This is an
 adjustable limit that you can increase by contacting AWS Support.
 


managedServiceData
String managedServiceData

 Details about the service that are specific to the service type, in JSON format. For service type
 SHIELD_ADVANCED, this is an empty string.
 
 
 
 
 Example: WAF
 
 
 ManagedServiceData": "{\"type\": \"WAF\", \"ruleGroups\": [{\"id\": \"12345678-1bcd-9012-efga-0987654321ab\", \"overrideAction\" : {\"type\": \"COUNT\"}}], \"defaultAction\": {\"type\": \"BLOCK\"}}
 
 
 
 
 Example: SECURITY_GROUPS_COMMON
 
 
 "SecurityServicePolicyData":{"Type":"SECURITY_GROUPS_COMMON","ManagedServiceData":"{\"type\":\"SECURITY_GROUPS_COMMON\",\"revertManualSecurityGroupChanges\":false,\"exclusiveResourceSecurityGroupManagement\":false,\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd\"}]}"},"RemediationEnabled":false,"ResourceType":"AWS::EC2::NetworkInterface"}
 
 
 
 
 Example: SECURITY_GROUPS_CONTENT_AUDIT
 
 
 "SecurityServicePolicyData":{"Type":"SECURITY_GROUPS_CONTENT_AUDIT","ManagedServiceData":"{\"type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"securityGroups\":[{\"id\":\" sg-000e55995d61a06bd \"}],\"securityGroupAction\":{\"type\":\"ALLOW\"}}"},"RemediationEnabled":false,"ResourceType":"AWS::EC2::NetworkInterface"}
 
 
 The security group action for content audit can be ALLOW or DENY. For
 ALLOW, all in-scope security group rules must be within the allowed range of the policy's security
 group rules. For DENY, all in-scope security group rules must not contain a value or a range that
 matches a rule value or range in the policy security group.
 
 
 
 
 Example: SECURITY_GROUPS_USAGE_AUDIT
 
 
 "SecurityServicePolicyData":{"Type":"SECURITY_GROUPS_USAGE_AUDIT","ManagedServiceData":"{\"type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"deleteUnusedSecurityGroups\":true,\"coalesceRedundantSecurityGroups\":true}"},"RemediationEnabled":false,"Resou rceType":"AWS::EC2::SecurityGroup"}
 
 
 








Class com.amazonaws.services.fms.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such
 as "customer." Tag keys are case-sensitive.
 


value
String value

 Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a
 category, such as "companyA" or "companyB." Tag values are case-sensitive.
 








Class com.amazonaws.services.fms.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource. The Firewall Manager policy is the only AWS resource that
 supports tagging, so this ARN is a policy ARN.
 


tagList
List<E> tagList

 The tags to add to the resource.
 








Class com.amazonaws.services.fms.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.fms.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource. The Firewall Manager policy is the only AWS resource that
 supports tagging, so this ARN is a policy ARN.
 


tagKeys
List<E> tagKeys

 The keys of the tags to remove from the resource.
 








Class com.amazonaws.services.fms.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.forecast.model




Class com.amazonaws.services.forecast.model.AmazonForecastException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.forecast.model.CategoricalParameterRange extends Object implements Serializable


Serialized Fields


name
String name

 The name of the categorical hyperparameter to tune.
 


values
List<E> values

 A list of the tunable categories for the hyperparameter.
 








Class com.amazonaws.services.forecast.model.ContinuousParameterRange extends Object implements Serializable


Serialized Fields


name
String name

 The name of the hyperparameter to tune.
 


maxValue
Double maxValue

 The maximum tunable value of the hyperparameter.
 


minValue
Double minValue

 The minimum tunable value of the hyperparameter.
 


scalingType
String scalingType

 The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
 
 
 Auto
 
 
 Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
 
 
 Linear
 
 
 Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
 
 
 Logarithmic
 
 
 Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
 
 
 Logarithmic scaling works only for ranges that have values greater than 0.
 
 
 ReverseLogarithmic
 
 
 hyperparameter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.
 
 
 Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
 
 
 
 
 For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
 








Class com.amazonaws.services.forecast.model.CreateDatasetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetGroupName
String datasetGroupName

 A name for the dataset group.
 


domain
String domain

 The domain associated with the dataset group. When you add a dataset to a dataset group, this value and the value
 specified for the Domain parameter of the CreateDataset operation must match.
 
 
 The Domain and DatasetType that you choose determine the fields that must be present in
 training data that you import to a dataset. For example, if you choose the RETAIL domain and
 TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires that
 item_id, timestamp, and demand fields are present in your data. For more
 information, see howitworks-datasets-groups.
 


datasetArns
List<E> datasetArns

 An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.
 








Class com.amazonaws.services.forecast.model.CreateDatasetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group.
 








Class com.amazonaws.services.forecast.model.CreateDatasetImportJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetImportJobName
String datasetImportJobName

 The name for the dataset import job. We recommend including the current timestamp in the name, for example,
 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException
 exception.
 


datasetArn
String datasetArn

 The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.
 


dataSource
DataSource dataSource

 The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon
 Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
 
 
 If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the IAM
 role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified
 in the EncryptionConfig parameter of the CreateDataset operation.
 


timestampFormat
String timestampFormat

 The format of timestamps in the dataset. The format that you specify depends on the DataFrequency
 specified when the dataset was created. The following formats are supported
 
 
 
 
 "yyyy-MM-dd"
 
 
 For the following data frequencies: Y, M, W, and D
 
 
 
 
 "yyyy-MM-dd HH:mm:ss"
 
 
 For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
 
 
 
 
 If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd HH:mm:ss".
 








Class com.amazonaws.services.forecast.model.CreateDatasetImportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetImportJobArn
String datasetImportJobArn

 The Amazon Resource Name (ARN) of the dataset import job.
 








Class com.amazonaws.services.forecast.model.CreateDatasetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetName
String datasetName

 A name for the dataset.
 


domain
String domain

 The domain associated with the dataset. When you add a dataset to a dataset group, this value and the value
 specified for the Domain parameter of the CreateDatasetGroup operation must match.
 
 
 The Domain and DatasetType that you choose determine the fields that must be present in
 the training data that you import to the dataset. For example, if you choose the RETAIL domain and
 TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id,
 timestamp, and demand fields to be present in your data. For more information, see
 howitworks-datasets-groups.
 


datasetType
String datasetType

 The dataset type. Valid values depend on the chosen Domain.
 


dataFrequency
String dataFrequency

 The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.
 
 
 Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes),
 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "D" indicates every day and "15min"
 indicates every 15 minutes.
 


schema
Schema schema

 The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset
 Domain and DatasetType that you choose determine the minimum required fields in your
 training data. For information about the required fields for a specific dataset domain and type, see
 howitworks-domains-ds-types.
 


encryptionConfig
EncryptionConfig encryptionConfig

 An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon
 Forecast can assume to access the key.
 








Class com.amazonaws.services.forecast.model.CreateDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetArn
String datasetArn

 The Amazon Resource Name (ARN) of the dataset.
 








Class com.amazonaws.services.forecast.model.CreateForecastExportJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


forecastExportJobName
String forecastExportJobName

 The name for the forecast export job.
 


forecastArn
String forecastArn

 The Amazon Resource Name (ARN) of the forecast that you want to export.
 


destination
DataDestination destination

 The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon
 Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.
 
 
 If encryption is used, Destination must include an AWS Key Management Service (KMS) key. The IAM
 role must allow Amazon Forecast permission to access the key.
 








Class com.amazonaws.services.forecast.model.CreateForecastExportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


forecastExportJobArn
String forecastExportJobArn

 The Amazon Resource Name (ARN) of the export job.
 








Class com.amazonaws.services.forecast.model.CreateForecastRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


forecastName
String forecastName

 A name for the forecast.
 


predictorArn
String predictorArn

 The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.
 


forecastTypes
List<E> forecastTypes

 The quantiles at which probabilistic forecasts are generated. You can specify up to 5 quantiles per forecast.
 Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean
 forecast is different from the median (0.50) when the distribution is not symmetric (e.g. Beta, Negative
 Binomial). The default value is ["0.1", "0.5", "0.9"].
 








Class com.amazonaws.services.forecast.model.CreateForecastResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


forecastArn
String forecastArn

 The Amazon Resource Name (ARN) of the forecast.
 








Class com.amazonaws.services.forecast.model.CreatePredictorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


predictorName
String predictorName

 A name for the predictor.
 


algorithmArn
String algorithmArn

 The Amazon Resource Name (ARN) of the algorithm to use for model training. Required if PerformAutoML
 is not set to true.
 
 
 Supported algorithms:
 
 
 
 
 arn:aws:forecast:::algorithm/ARIMA
 
 
 
 
 arn:aws:forecast:::algorithm/Deep_AR_Plus
 
 
 Supports hyperparameter optimization (HPO)
 
 
 
 
 arn:aws:forecast:::algorithm/ETS
 
 
 
 
 arn:aws:forecast:::algorithm/NPTS
 
 
 
 
 arn:aws:forecast:::algorithm/Prophet
 
 
 


forecastHorizon
Integer forecastHorizon

 Specifies the number of time-steps that the model is trained to predict. The forecast horizon is also called the
 prediction length.
 
 
 For example, if you configure a dataset for daily data collection (using the DataFrequency parameter
 of the CreateDataset operation) and set the forecast horizon to 10, the model returns predictions for 10
 days.
 
 
 The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length.
 


performAutoML
Boolean performAutoML

 Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms it provides and
 chooses the best algorithm and configuration for your training dataset.
 
 
 The default value is false. In this case, you are required to specify an algorithm.
 
 
 Set PerformAutoML to true to have Amazon Forecast perform AutoML. This is a good option
 if you aren't sure which algorithm is suitable for your training data. In this case, PerformHPO must
 be false.
 


performHPO
Boolean performHPO

 Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter values for your training
 data. The process of performing HPO is known as running a hyperparameter tuning job.
 
 
 The default value is false. In this case, Amazon Forecast uses default hyperparameter values from
 the chosen algorithm.
 
 
 To override the default values, set PerformHPO to true and, optionally, supply the
 HyperParameterTuningJobConfig object. The tuning job specifies a metric to optimize, which hyperparameters
 participate in tuning, and the valid range for each tunable hyperparameter. In this case, you are required to
 specify an algorithm and PerformAutoML must be false.
 
 
 The following algorithm supports HPO:
 
 
 
 
 DeepAR+
 
 
 


trainingParameters
Map<K,V> trainingParameters

 The hyperparameters to override for model training. The hyperparameters that you can override are listed in the
 individual algorithms. For the list of supported algorithms, see aws-forecast-choosing-recipes.
 


evaluationParameters
EvaluationParameters evaluationParameters

 Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a
 predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to
 perform the split and the number of iterations.
 


hPOConfig
HyperParameterTuningJobConfig hPOConfig

 Provides hyperparameter override values for the algorithm. If you don't provide this parameter, Amazon Forecast
 uses default values. The individual algorithms specify which hyperparameters support hyperparameter optimization
 (HPO). For more information, see aws-forecast-choosing-recipes.
 
 
 If you included the HPOConfig object, you must set PerformHPO to true.
 


inputDataConfig
InputDataConfig inputDataConfig

 Describes the dataset group that contains the data to use to train the predictor.
 


featurizationConfig
FeaturizationConfig featurizationConfig

 The featurization configuration.
 


encryptionConfig
EncryptionConfig encryptionConfig

 An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon
 Forecast can assume to access the key.
 








Class com.amazonaws.services.forecast.model.CreatePredictorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


predictorArn
String predictorArn

 The Amazon Resource Name (ARN) of the predictor.
 








Class com.amazonaws.services.forecast.model.DataDestination extends Object implements Serializable


Serialized Fields


s3Config
S3Config s3Config

 The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.
 








Class com.amazonaws.services.forecast.model.DatasetGroupSummary extends Object implements Serializable


Serialized Fields


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group.
 


datasetGroupName
String datasetGroupName

 The name of the dataset group.
 


creationTime
Date creationTime

 When the dataset group was created.
 


lastModificationTime
Date lastModificationTime

 When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While
 the dataset group is being updated, LastModificationTime is the current time of the
 ListDatasetGroups call.
 








Class com.amazonaws.services.forecast.model.DatasetImportJobSummary extends Object implements Serializable


Serialized Fields


datasetImportJobArn
String datasetImportJobArn

 The Amazon Resource Name (ARN) of the dataset import job.
 


datasetImportJobName
String datasetImportJobName

 The name of the dataset import job.
 


dataSource
DataSource dataSource

 The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon
 Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.
 
 
 If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.
 


status
String status

 The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the
 import job status is CREATE_IN_PROGRESS, the status of the dataset is
 UPDATE_IN_PROGRESS. States include:
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
 
 
 
 
 DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
 
 
 


message
String message

 If an error occurred, an informational message about the error.
 


creationTime
Date creationTime

 When the dataset import job was created.
 


lastModificationTime
Date lastModificationTime

 The last time that the dataset was modified. The time depends on the status of the job, as follows:
 
 
 
 
 CREATE_PENDING - The same time as CreationTime.
 
 
 
 
 CREATE_IN_PROGRESS - The current timestamp.
 
 
 
 
 ACTIVE or CREATE_FAILED - When the job finished or failed.
 
 
 








Class com.amazonaws.services.forecast.model.DatasetSummary extends Object implements Serializable


Serialized Fields


datasetArn
String datasetArn

 The Amazon Resource Name (ARN) of the dataset.
 


datasetName
String datasetName

 The name of the dataset.
 


datasetType
String datasetType

 The dataset type.
 


domain
String domain

 The domain associated with the dataset.
 


creationTime
Date creationTime

 When the dataset was created.
 


lastModificationTime
Date lastModificationTime

 When you create a dataset, LastModificationTime is the same as CreationTime. While data
 is being imported to the dataset, LastModificationTime is the current time of the
 ListDatasets call. After a CreateDatasetImportJob operation has finished,
 LastModificationTime is when the import job completed or failed.
 








Class com.amazonaws.services.forecast.model.DataSource extends Object implements Serializable


Serialized Fields


s3Config
S3Config s3Config

 The path to the training data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the
 credentials to access the data.
 








Class com.amazonaws.services.forecast.model.DeleteDatasetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group to delete.
 








Class com.amazonaws.services.forecast.model.DeleteDatasetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.forecast.model.DeleteDatasetImportJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetImportJobArn
String datasetImportJobArn

 The Amazon Resource Name (ARN) of the dataset import job to delete.
 








Class com.amazonaws.services.forecast.model.DeleteDatasetImportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.forecast.model.DeleteDatasetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetArn
String datasetArn

 The Amazon Resource Name (ARN) of the dataset to delete.
 








Class com.amazonaws.services.forecast.model.DeleteDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.forecast.model.DeleteForecastExportJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


forecastExportJobArn
String forecastExportJobArn

 The Amazon Resource Name (ARN) of the forecast export job to delete.
 








Class com.amazonaws.services.forecast.model.DeleteForecastExportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.forecast.model.DeleteForecastRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


forecastArn
String forecastArn

 The Amazon Resource Name (ARN) of the forecast to delete.
 








Class com.amazonaws.services.forecast.model.DeleteForecastResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.forecast.model.DeletePredictorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


predictorArn
String predictorArn

 The Amazon Resource Name (ARN) of the predictor to delete.
 








Class com.amazonaws.services.forecast.model.DeletePredictorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.forecast.model.DescribeDatasetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group.
 








Class com.amazonaws.services.forecast.model.DescribeDatasetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetGroupName
String datasetGroupName

 The name of the dataset group.
 


datasetGroupArn
String datasetGroupArn

 The ARN of the dataset group.
 


datasetArns
List<E> datasetArns

 An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.
 


domain
String domain

 The domain associated with the dataset group.
 


status
String status

 The status of the dataset group. States include:
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
 
 
 
 
 DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
 
 
 
 
 UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
 
 
 
 
 The UPDATE states apply when you call the UpdateDatasetGroup operation.
 
 
 
 The Status of the dataset group must be ACTIVE before you can use the dataset group to
 create a predictor.
 
 


creationTime
Date creationTime

 When the dataset group was created.
 


lastModificationTime
Date lastModificationTime

 When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While
 the dataset group is being updated, LastModificationTime is the current time of the
 DescribeDatasetGroup call.
 








Class com.amazonaws.services.forecast.model.DescribeDatasetImportJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetImportJobArn
String datasetImportJobArn

 The Amazon Resource Name (ARN) of the dataset import job.
 








Class com.amazonaws.services.forecast.model.DescribeDatasetImportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetImportJobName
String datasetImportJobName

 The name of the dataset import job.
 


datasetImportJobArn
String datasetImportJobArn

 The ARN of the dataset import job.
 


datasetArn
String datasetArn

 The Amazon Resource Name (ARN) of the dataset that the training data was imported to.
 


timestampFormat
String timestampFormat

 The format of timestamps in the dataset. The format that you specify depends on the DataFrequency
 specified when the dataset was created. The following formats are supported
 
 
 
 
 "yyyy-MM-dd"
 
 
 For the following data frequencies: Y, M, W, and D
 
 
 
 
 "yyyy-MM-dd HH:mm:ss"
 
 
 For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D
 
 
 


dataSource
DataSource dataSource

 The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon
 Forecast can assume to access the data.
 
 
 If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.
 


fieldStatistics
Map<K,V> fieldStatistics

 Statistical information about each field in the input data.
 


dataSize
Double dataSize

 The size of the dataset in gigabytes (GB) after the import job has finished.
 


status
String status

 The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the
 import job status is CREATE_IN_PROGRESS, the status of the dataset is
 UPDATE_IN_PROGRESS. States include:
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
 
 
 
 
 DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
 
 
 


message
String message

 If an error occurred, an informational message about the error.
 


creationTime
Date creationTime

 When the dataset import job was created.
 


lastModificationTime
Date lastModificationTime

 The last time that the dataset was modified. The time depends on the status of the job, as follows:
 
 
 
 
 CREATE_PENDING - The same time as CreationTime.
 
 
 
 
 CREATE_IN_PROGRESS - The current timestamp.
 
 
 
 
 ACTIVE or CREATE_FAILED - When the job finished or failed.
 
 
 








Class com.amazonaws.services.forecast.model.DescribeDatasetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetArn
String datasetArn

 The Amazon Resource Name (ARN) of the dataset.
 








Class com.amazonaws.services.forecast.model.DescribeDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetArn
String datasetArn

 The Amazon Resource Name (ARN) of the dataset.
 


datasetName
String datasetName

 The name of the dataset.
 


domain
String domain

 The domain associated with the dataset.
 


datasetType
String datasetType

 The dataset type.
 


dataFrequency
String dataFrequency

 The frequency of data collection.
 
 
 Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes),
 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "M" indicates every month and "30min"
 indicates every 30 minutes.
 


schema
Schema schema

 An array of SchemaAttribute objects that specify the dataset fields. Each
 SchemaAttribute specifies the name and data type of a field.
 


encryptionConfig
EncryptionConfig encryptionConfig

 The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon
 Forecast can assume to access the key.
 


status
String status

 The status of the dataset. States include:
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
 
 
 
 
 DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
 
 
 
 
 UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
 
 
 
 
 The UPDATE states apply while data is imported to the dataset from a call to the
 CreateDatasetImportJob operation and reflect the status of the dataset import job. For example, when the
 import job status is CREATE_IN_PROGRESS, the status of the dataset is
 UPDATE_IN_PROGRESS.
 
 
 
 The Status of the dataset must be ACTIVE before you can import training data.
 
 


creationTime
Date creationTime

 When the dataset was created.
 


lastModificationTime
Date lastModificationTime

 When you create a dataset, LastModificationTime is the same as CreationTime. While data
 is being imported to the dataset, LastModificationTime is the current time of the
 DescribeDataset call. After a CreateDatasetImportJob operation has finished,
 LastModificationTime is when the import job completed or failed.
 








Class com.amazonaws.services.forecast.model.DescribeForecastExportJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


forecastExportJobArn
String forecastExportJobArn

 The Amazon Resource Name (ARN) of the forecast export job.
 








Class com.amazonaws.services.forecast.model.DescribeForecastExportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


forecastExportJobArn
String forecastExportJobArn

 The ARN of the forecast export job.
 


forecastExportJobName
String forecastExportJobName

 The name of the forecast export job.
 


forecastArn
String forecastArn

 The Amazon Resource Name (ARN) of the exported forecast.
 


destination
DataDestination destination

 The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
 


message
String message

 If an error occurred, an informational message about the error.
 


status
String status

 The status of the forecast export job. States include:
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
 
 
 
 
 DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
 
 
 
 
 
 The Status of the forecast export job must be ACTIVE before you can access the forecast
 in your S3 bucket.
 
 


creationTime
Date creationTime

 When the forecast export job was created.
 


lastModificationTime
Date lastModificationTime

 When the last successful export job finished.
 








Class com.amazonaws.services.forecast.model.DescribeForecastRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


forecastArn
String forecastArn

 The Amazon Resource Name (ARN) of the forecast.
 








Class com.amazonaws.services.forecast.model.DescribeForecastResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


forecastArn
String forecastArn

 The forecast ARN as specified in the request.
 


forecastName
String forecastName

 The name of the forecast.
 


forecastTypes
List<E> forecastTypes

 The quantiles at which proababilistic forecasts were generated.
 


predictorArn
String predictorArn

 The ARN of the predictor used to generate the forecast.
 


datasetGroupArn
String datasetGroupArn

 The ARN of the dataset group that provided the data used to train the predictor.
 


status
String status

 The status of the forecast. States include:
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
 
 
 
 
 DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
 
 
 
 
 
 The Status of the forecast must be ACTIVE before you can query or export the forecast.
 
 


message
String message

 If an error occurred, an informational message about the error.
 


creationTime
Date creationTime

 When the forecast creation task was created.
 


lastModificationTime
Date lastModificationTime

 Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference
 (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is
 complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).
 








Class com.amazonaws.services.forecast.model.DescribePredictorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


predictorArn
String predictorArn

 The Amazon Resource Name (ARN) of the predictor that you want information about.
 








Class com.amazonaws.services.forecast.model.DescribePredictorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


predictorArn
String predictorArn

 The ARN of the predictor.
 


predictorName
String predictorName

 The name of the predictor.
 


algorithmArn
String algorithmArn

 The Amazon Resource Name (ARN) of the algorithm used for model training.
 


forecastHorizon
Integer forecastHorizon

 The number of time-steps of the forecast. The forecast horizon is also called the prediction length.
 


performAutoML
Boolean performAutoML

 Whether the predictor is set to perform AutoML.
 


performHPO
Boolean performHPO

 Whether the predictor is set to perform hyperparameter optimization (HPO).
 


trainingParameters
Map<K,V> trainingParameters

 The default training parameters or overrides selected during model training. If using the AutoML algorithm or if
 HPO is turned on while using the DeepAR+ algorithms, the optimized values for the chosen hyperparameters are
 returned. For more information, see aws-forecast-choosing-recipes.
 


evaluationParameters
EvaluationParameters evaluationParameters

 Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a
 predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to
 perform the split and the number of iterations.
 


hPOConfig
HyperParameterTuningJobConfig hPOConfig

 The hyperparameter override values for the algorithm.
 


inputDataConfig
InputDataConfig inputDataConfig

 Describes the dataset group that contains the data to use to train the predictor.
 


featurizationConfig
FeaturizationConfig featurizationConfig

 The featurization configuration.
 


encryptionConfig
EncryptionConfig encryptionConfig

 An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon
 Forecast can assume to access the key.
 


predictorExecutionDetails
PredictorExecutionDetails predictorExecutionDetails

 Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You
 specify the number of backtests to perform when you call the operation.
 


datasetImportJobArns
List<E> datasetImportJobArns

 An array of the ARNs of the dataset import jobs used to import training data for the predictor.
 


autoMLAlgorithmArns
List<E> autoMLAlgorithmArns

 When PerformAutoML is specified, the ARN of the chosen algorithm.
 


status
String status

 The status of the predictor. States include:
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
 
 
 
 
 DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
 
 
 
 
 UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
 
 
 
 
 
 The Status of the predictor must be ACTIVE before you can use the predictor to create a
 forecast.
 
 


message
String message

 If an error occurred, an informational message about the error.
 


creationTime
Date creationTime

 When the model training task was created.
 


lastModificationTime
Date lastModificationTime

 Initially, the same as CreationTime (when the status is CREATE_PENDING). This value is
 updated when training starts (when the status changes to CREATE_IN_PROGRESS), and when training has
 completed (when the status changes to ACTIVE) or fails (when the status changes to
 CREATE_FAILED).
 








Class com.amazonaws.services.forecast.model.EncryptionConfig extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.
 
 
 Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an
 InvalidInputException error.
 


kMSKeyArn
String kMSKeyArn

 The Amazon Resource Name (ARN) of the KMS key.
 








Class com.amazonaws.services.forecast.model.EvaluationParameters extends Object implements Serializable


Serialized Fields


numberOfBacktestWindows
Integer numberOfBacktestWindows

 The number of times to split the input data. The default is 1. Valid values are 1 through 5.
 


backTestWindowOffset
Integer backTestWindowOffset

 The point from the end of the dataset where you want to split the data for model training and testing
 (evaluation). Specify the value as the number of data points. The default is the value of the forecast horizon.
 BackTestWindowOffset can be used to mimic a past virtual forecast start date. This value must be
 greater than or equal to the forecast horizon and less than half of the TARGET_TIME_SERIES dataset length.
 
 
 ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset length
 








Class com.amazonaws.services.forecast.model.EvaluationResult extends Object implements Serializable


Serialized Fields


algorithmArn
String algorithmArn

 The Amazon Resource Name (ARN) of the algorithm that was evaluated.
 


testWindows
List<E> testWindows

 The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows from the
 EvaluationParameters object determines the number of windows in the array.
 








Class com.amazonaws.services.forecast.model.Featurization extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 The name of the schema attribute that specifies the data field to be featurized. Only the target
 field of the TARGET_TIME_SERIES dataset type is supported. For example, for the RETAIL
 domain, the target is demand, and for the CUSTOM domain, the target is
 target_value.
 


featurizationPipeline
List<E> featurizationPipeline

 An array of one FeaturizationMethod object that specifies the feature transformation method.
 








Class com.amazonaws.services.forecast.model.FeaturizationConfig extends Object implements Serializable


Serialized Fields


forecastFrequency
String forecastFrequency

 The frequency of predictions in a forecast.
 
 
 Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes),
 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min"
 indicates every five minutes.
 
 
 The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.
 
 
 When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset
 frequency.
 


forecastDimensions
List<E> forecastDimensions

 An array of dimension (field) names that specify how to group the generated forecast.
 
 
 For example, suppose that you are generating a forecast for item sales across all of your stores, and your
 dataset contains a store_id field. If you want the sales forecast for each item by store, you would
 specify store_id as the dimension.
 
 
 All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't need to be specified in
 the CreatePredictor request. All forecast dimensions specified in the
 RELATED_TIME_SERIES dataset must be specified in the CreatePredictor request.
 


featurizations
List<E> featurizations

 An array of featurization (transformation) information for the fields of a dataset. Only a single featurization
 is supported.
 








Class com.amazonaws.services.forecast.model.FeaturizationMethod extends Object implements Serializable


Serialized Fields


featurizationMethodName
String featurizationMethodName

 The name of the method. The "filling" method is the only supported method.
 


featurizationMethodParameters
Map<K,V> featurizationMethodParameters

 The method parameters (key-value pairs). Specify these parameters to override the default values. The following
 list shows the parameters and their valid values. Bold signifies the default value.
 
 
 
 
 aggregation: sum, avg, first, min, max
 
 
 
 
 frontfill: none
 
 
 
 
 middlefill: zero, nan (not a number)
 
 
 
 
 backfill: zero, nan
 
 
 








Class com.amazonaws.services.forecast.model.Filter extends Object implements Serializable


Serialized Fields


key
String key

 The name of the parameter to filter on.
 


value
String value

 The value to match.
 


condition
String condition

 The condition to apply. To include the objects that match the statement, specify IS. To exclude
 matching objects, specify IS_NOT.
 








Class com.amazonaws.services.forecast.model.ForecastExportJobSummary extends Object implements Serializable


Serialized Fields


forecastExportJobArn
String forecastExportJobArn

 The Amazon Resource Name (ARN) of the forecast export job.
 


forecastExportJobName
String forecastExportJobName

 The name of the forecast export job.
 


destination
DataDestination destination

 The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
 


status
String status

 The status of the forecast export job. States include:
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
 
 
 
 
 DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
 
 
 
 
 
 The Status of the forecast export job must be ACTIVE before you can access the forecast
 in your S3 bucket.
 
 


message
String message

 If an error occurred, an informational message about the error.
 


creationTime
Date creationTime

 When the forecast export job was created.
 


lastModificationTime
Date lastModificationTime

 When the last successful export job finished.
 








Class com.amazonaws.services.forecast.model.ForecastSummary extends Object implements Serializable


Serialized Fields


forecastArn
String forecastArn

 The ARN of the forecast.
 


forecastName
String forecastName

 The name of the forecast.
 


predictorArn
String predictorArn

 The ARN of the predictor used to generate the forecast.
 


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.
 


status
String status

 The status of the forecast. States include:
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
 
 
 
 
 DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
 
 
 
 
 
 The Status of the forecast must be ACTIVE before you can query or export the forecast.
 
 


message
String message

 If an error occurred, an informational message about the error.
 


creationTime
Date creationTime

 When the forecast creation task was created.
 


lastModificationTime
Date lastModificationTime

 Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference
 (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is
 complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).
 








Class com.amazonaws.services.forecast.model.GetAccuracyMetricsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


predictorArn
String predictorArn

 The Amazon Resource Name (ARN) of the predictor to get metrics for.
 








Class com.amazonaws.services.forecast.model.GetAccuracyMetricsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


predictorEvaluationResults
List<E> predictorEvaluationResults

 An array of results from evaluating the predictor.
 








Class com.amazonaws.services.forecast.model.HyperParameterTuningJobConfig extends Object implements Serializable


Serialized Fields


parameterRanges
ParameterRanges parameterRanges

 Specifies the ranges of valid values for the hyperparameters.
 








Class com.amazonaws.services.forecast.model.InputDataConfig extends Object implements Serializable


Serialized Fields


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group.
 


supplementaryFeatures
List<E> supplementaryFeatures

 An array of supplementary features. The only supported feature is a holiday calendar.
 








Class com.amazonaws.services.forecast.model.IntegerParameterRange extends Object implements Serializable


Serialized Fields


name
String name

 The name of the hyperparameter to tune.
 


maxValue
Integer maxValue

 The maximum tunable value of the hyperparameter.
 


minValue
Integer minValue

 The minimum tunable value of the hyperparameter.
 


scalingType
String scalingType

 The scale that hyperparameter tuning uses to search the hyperparameter range. Valid values:
 
 
 Auto
 
 
 Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
 
 
 Linear
 
 
 Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.
 
 
 Logarithmic
 
 
 Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.
 
 
 Logarithmic scaling works only for ranges that have values greater than 0.
 
 
 ReverseLogarithmic
 
 
 Not supported for IntegerParameterRange.
 
 
 Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.
 
 
 
 
 For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:
 








Class com.amazonaws.services.forecast.model.InvalidInputException extends AmazonForecastException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.forecast.model.InvalidNextTokenException extends AmazonForecastException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.forecast.model.LimitExceededException extends AmazonForecastException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.forecast.model.ListDatasetGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If the result of the previous request was truncated, the response includes a NextToken. To retrieve
 the next set of results, use the token in the next request. Tokens expire after 24 hours.
 


maxResults
Integer maxResults

 The number of items to return in the response.
 








Class com.amazonaws.services.forecast.model.ListDatasetGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetGroups
List<E> datasetGroups

 An array of objects that summarize each dataset group's properties.
 


nextToken
String nextToken

 If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the
 token in the next request.
 








Class com.amazonaws.services.forecast.model.ListDatasetImportJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If the result of the previous request was truncated, the response includes a NextToken. To retrieve
 the next set of results, use the token in the next request. Tokens expire after 24 hours.
 


maxResults
Integer maxResults

 The number of items to return in the response.
 


filters
List<E> filters

 An array of filters. For each filter, you provide a condition and a match statement. The condition is either
 IS or IS_NOT, which specifies whether to include or exclude the datasets that match the
 statement from the list, respectively. The match statement consists of a key and a value.
 
 
 Filter properties
 
 
 
 
 Condition - The condition to apply. Valid values are IS and IS_NOT. To
 include the datasets that match the statement, specify IS. To exclude matching datasets, specify
 IS_NOT.
 
 
 
 
 Key - The name of the parameter to filter on. Valid values are DatasetArn and
 Status.
 
 
 
 
 Value - The value to match.
 
 
 
 
 For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:
 
 
 "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
 








Class com.amazonaws.services.forecast.model.ListDatasetImportJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetImportJobs
List<E> datasetImportJobs

 An array of objects that summarize each dataset import job's properties.
 


nextToken
String nextToken

 If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the
 token in the next request.
 








Class com.amazonaws.services.forecast.model.ListDatasetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If the result of the previous request was truncated, the response includes a NextToken. To retrieve
 the next set of results, use the token in the next request. Tokens expire after 24 hours.
 


maxResults
Integer maxResults

 The number of items to return in the response.
 








Class com.amazonaws.services.forecast.model.ListDatasetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasets
List<E> datasets

 An array of objects that summarize each dataset's properties.
 


nextToken
String nextToken

 If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the
 token in the next request.
 








Class com.amazonaws.services.forecast.model.ListForecastExportJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If the result of the previous request was truncated, the response includes a NextToken. To retrieve
 the next set of results, use the token in the next request. Tokens expire after 24 hours.
 


maxResults
Integer maxResults

 The number of items to return in the response.
 


filters
List<E> filters

 An array of filters. For each filter, you provide a condition and a match statement. The condition is either
 IS or IS_NOT, which specifies whether to include or exclude the forecast export jobs
 that match the statement from the list, respectively. The match statement consists of a key and a value.
 
 
 Filter properties
 
 
 
 
 Condition - The condition to apply. Valid values are IS and IS_NOT. To
 include the forecast export jobs that match the statement, specify IS. To exclude matching forecast
 export jobs, specify IS_NOT.
 
 
 
 
 Key - The name of the parameter to filter on. Valid values are ForecastArn and
 Status.
 
 
 
 
 Value - The value to match.
 
 
 
 
 For example, to list all jobs that export a forecast named electricityforecast, specify the following
 filter:
 
 
 "Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast" } ]
 








Class com.amazonaws.services.forecast.model.ListForecastExportJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


forecastExportJobs
List<E> forecastExportJobs

 An array of objects that summarize each export job's properties.
 


nextToken
String nextToken

 If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the
 token in the next request.
 








Class com.amazonaws.services.forecast.model.ListForecastsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If the result of the previous request was truncated, the response includes a NextToken. To retrieve
 the next set of results, use the token in the next request. Tokens expire after 24 hours.
 


maxResults
Integer maxResults

 The number of items to return in the response.
 


filters
List<E> filters

 An array of filters. For each filter, you provide a condition and a match statement. The condition is either
 IS or IS_NOT, which specifies whether to include or exclude the forecasts that match
 the statement from the list, respectively. The match statement consists of a key and a value.
 
 
 Filter properties
 
 
 
 
 Condition - The condition to apply. Valid values are IS and IS_NOT. To
 include the forecasts that match the statement, specify IS. To exclude matching forecasts, specify
 IS_NOT.
 
 
 
 
 Key - The name of the parameter to filter on. Valid values are DatasetGroupArn,
 PredictorArn, and Status.
 
 
 
 
 Value - The value to match.
 
 
 
 
 For example, to list all forecasts whose status is not ACTIVE, you would specify:
 
 
 "Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" } ]
 








Class com.amazonaws.services.forecast.model.ListForecastsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


forecasts
List<E> forecasts

 An array of objects that summarize each forecast's properties.
 


nextToken
String nextToken

 If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the
 token in the next request.
 








Class com.amazonaws.services.forecast.model.ListPredictorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If the result of the previous request was truncated, the response includes a NextToken. To retrieve
 the next set of results, use the token in the next request. Tokens expire after 24 hours.
 


maxResults
Integer maxResults

 The number of items to return in the response.
 


filters
List<E> filters

 An array of filters. For each filter, you provide a condition and a match statement. The condition is either
 IS or IS_NOT, which specifies whether to include or exclude the predictors that match
 the statement from the list, respectively. The match statement consists of a key and a value.
 
 
 Filter properties
 
 
 
 
 Condition - The condition to apply. Valid values are IS and IS_NOT. To
 include the predictors that match the statement, specify IS. To exclude matching predictors, specify
 IS_NOT.
 
 
 
 
 Key - The name of the parameter to filter on. Valid values are DatasetGroupArn and
 Status.
 
 
 
 
 Value - The value to match.
 
 
 
 
 For example, to list all predictors whose status is ACTIVE, you would specify:
 
 
 "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]
 








Class com.amazonaws.services.forecast.model.ListPredictorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


predictors
List<E> predictors

 An array of objects that summarize each predictor's properties.
 


nextToken
String nextToken

 If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the
 token in the next request.
 








Class com.amazonaws.services.forecast.model.Metrics extends Object implements Serializable


Serialized Fields


rMSE
Double rMSE

 The root mean square error (RMSE).
 


weightedQuantileLosses
List<E> weightedQuantileLosses

 An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal
 probability. The distribution in this case is the loss function.
 








Class com.amazonaws.services.forecast.model.ParameterRanges extends Object implements Serializable


Serialized Fields


categoricalParameterRanges
List<E> categoricalParameterRanges

 Specifies the tunable range for each categorical hyperparameter.
 


continuousParameterRanges
List<E> continuousParameterRanges

 Specifies the tunable range for each continuous hyperparameter.
 


integerParameterRanges
List<E> integerParameterRanges

 Specifies the tunable range for each integer hyperparameter.
 








Class com.amazonaws.services.forecast.model.PredictorExecution extends Object implements Serializable


Serialized Fields


algorithmArn
String algorithmArn

 The ARN of the algorithm used to test the predictor.
 


testWindows
List<E> testWindows

 An array of test windows used to evaluate the algorithm. The NumberOfBacktestWindows from the object
 determines the number of windows in the array.
 








Class com.amazonaws.services.forecast.model.PredictorExecutionDetails extends Object implements Serializable


Serialized Fields


predictorExecutions
List<E> predictorExecutions

 An array of the backtests performed to evaluate the accuracy of the predictor against a particular algorithm. The
 NumberOfBacktestWindows from the object determines the number of windows in the array.
 








Class com.amazonaws.services.forecast.model.PredictorSummary extends Object implements Serializable


Serialized Fields


predictorArn
String predictorArn

 The ARN of the predictor.
 


predictorName
String predictorName

 The name of the predictor.
 


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
 


status
String status

 The status of the predictor. States include:
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
 
 
 
 
 DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
 
 
 
 
 UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
 
 
 
 
 
 The Status of the predictor must be ACTIVE before you can use the predictor to create a
 forecast.
 
 


message
String message

 If an error occurred, an informational message about the error.
 


creationTime
Date creationTime

 When the model training task was created.
 


lastModificationTime
Date lastModificationTime

 Initially, the same as CreationTime (status is CREATE_PENDING). Updated when training
 starts (status changed to CREATE_IN_PROGRESS), and when training is complete (status changed to
 ACTIVE) or fails (status changed to CREATE_FAILED).
 








Class com.amazonaws.services.forecast.model.ResourceAlreadyExistsException extends AmazonForecastException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.forecast.model.ResourceInUseException extends AmazonForecastException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.forecast.model.ResourceNotFoundException extends AmazonForecastException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.forecast.model.S3Config extends Object implements Serializable


Serialized Fields


path
String path

 The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.
 


roleArn
String roleArn

 The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon
 S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the
 key.
 
 
 Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an
 InvalidInputException error.
 


kMSKeyArn
String kMSKeyArn

 The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
 








Class com.amazonaws.services.forecast.model.Schema extends Object implements Serializable


Serialized Fields


attributes
List<E> attributes

 An array of attributes specifying the name and type of each field in a dataset.
 








Class com.amazonaws.services.forecast.model.SchemaAttribute extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 The name of the dataset field.
 


attributeType
String attributeType

 The data type of the field.
 








Class com.amazonaws.services.forecast.model.Statistics extends Object implements Serializable


Serialized Fields


count
Integer count

 The number of values in the field.
 


countDistinct
Integer countDistinct

 The number of distinct values in the field.
 


countNull
Integer countNull

 The number of null values in the field.
 


countNan
Integer countNan

 The number of NAN (not a number) values in the field.
 


min
String min

 For a numeric field, the minimum value in the field.
 


max
String max

 For a numeric field, the maximum value in the field.
 


avg
Double avg

 For a numeric field, the average value in the field.
 


stddev
Double stddev

 For a numeric field, the standard deviation.
 








Class com.amazonaws.services.forecast.model.SupplementaryFeature extends Object implements Serializable


Serialized Fields


name
String name

 The name of the feature. This must be "holiday".
 


value
String value

 One of the following 2 letter country codes:
 
 
 
 
 "AU" - AUSTRALIA
 
 
 
 
 "DE" - GERMANY
 
 
 
 
 "JP" - JAPAN
 
 
 
 
 "US" - UNITED_STATES
 
 
 
 
 "UK" - UNITED_KINGDOM
 
 
 








Class com.amazonaws.services.forecast.model.TestWindowSummary extends Object implements Serializable


Serialized Fields


testWindowStart
Date testWindowStart

 The time at which the test began.
 


testWindowEnd
Date testWindowEnd

 The time at which the test ended.
 


status
String status

 The status of the test. Possible status values are:
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE_IN_PROGRESS
 
 
 
 
 CREATE_FAILED
 
 
 


message
String message

 If the test failed, the reason why it failed.
 








Class com.amazonaws.services.forecast.model.UpdateDatasetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetGroupArn
String datasetGroupArn

 The ARN of the dataset group.
 


datasetArns
List<E> datasetArns

 An array of the Amazon Resource Names (ARNs) of the datasets to add to the dataset group.
 








Class com.amazonaws.services.forecast.model.UpdateDatasetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.forecast.model.WeightedQuantileLoss extends Object implements Serializable


Serialized Fields


quantile
Double quantile

 The quantile. Quantiles divide a probability distribution into regions of equal probability. For example, if the
 distribution was divided into 5 regions of equal probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8.
 


lossValue
Double lossValue

 The difference between the predicted value and the actual value over the quantile, weighted (normalized) by
 dividing by the sum over all quantiles.
 








Class com.amazonaws.services.forecast.model.WindowSummary extends Object implements Serializable


Serialized Fields


testWindowStart
Date testWindowStart

 The timestamp that defines the start of the window.
 


testWindowEnd
Date testWindowEnd

 The timestamp that defines the end of the window.
 


itemCount
Integer itemCount

 The number of data points within the window.
 


evaluationType
String evaluationType

 The type of evaluation.
 
 
 
 
 SUMMARY - The average metrics across all windows.
 
 
 
 
 COMPUTED - The metrics for the specified window.
 
 
 


metrics
Metrics metrics

 Provides metrics used to evaluate the performance of a predictor.
 








Package com.amazonaws.services.forecastquery.model




Class com.amazonaws.services.forecastquery.model.AmazonForecastQueryException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.forecastquery.model.DataPoint extends Object implements Serializable


Serialized Fields


timestamp
String timestamp

 The timestamp of the specific forecast.
 


value
Double value

 The forecast value.
 








Class com.amazonaws.services.forecastquery.model.Forecast extends Object implements Serializable


Serialized Fields


predictions
Map<K,V> predictions

 The forecast.
 
 
 The string of the string to array map is one of the following values:
 
 
 
 
 mean
 
 
 
 
 p10
 
 
 
 
 p50
 
 
 
 
 p90
 
 
 








Class com.amazonaws.services.forecastquery.model.InvalidInputException extends AmazonForecastQueryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.forecastquery.model.InvalidNextTokenException extends AmazonForecastQueryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.forecastquery.model.LimitExceededException extends AmazonForecastQueryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.forecastquery.model.QueryForecastRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


forecastArn
String forecastArn

 The Amazon Resource Name (ARN) of the forecast to query.
 


startDate
String startDate

 The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format)
 For example, "1970-01-01T00:00:00Z."
 


endDate
String endDate

 The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format).
 For example, "1970-01-01T00:00:00Z."
 


filters
Map<K,V> filters

 The filtering criteria to apply when retrieving the forecast. For example:
 
 
 
 
 To get a forecast for a specific item specify the following:
 
 
 {"item_id" : "client_1"}
 
 
 
 
 
 
 To get a forecast for a specific item sold in a specific location, specify the following:
 
 
 {"item_id" : "client_1", "location" : "ny"}
 
 
 
 
 
 
 To get a forecast for all blue items sold in a specific location, specify the following:
 
 
 { "location" : "ny", "color":"blue"}
 
 
 
 
 To get the full forecast, use the operation.
 


nextToken
String nextToken

 If the result of the previous request was truncated, the response includes a NextToken. To retrieve
 the next set of results, use the token in the next request. Tokens expire after 24 hours.
 








Class com.amazonaws.services.forecastquery.model.QueryForecastResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


forecast
Forecast forecast

 The forecast.
 








Class com.amazonaws.services.forecastquery.model.ResourceInUseException extends AmazonForecastQueryException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.forecastquery.model.ResourceNotFoundException extends AmazonForecastQueryException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.frauddetector.model




Class com.amazonaws.services.frauddetector.model.AmazonFraudDetectorException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.frauddetector.model.BatchCreateVariableError extends Object implements Serializable


Serialized Fields


name
String name

 The name.
 


code
Integer code

 The error code.
 


message
String message

 The error message.
 








Class com.amazonaws.services.frauddetector.model.BatchCreateVariableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


variableEntries
List<E> variableEntries

 The list of variables for the batch create variable request.
 








Class com.amazonaws.services.frauddetector.model.BatchCreateVariableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


errors
List<E> errors

 Provides the errors for the BatchCreateVariable request.
 








Class com.amazonaws.services.frauddetector.model.BatchGetVariableError extends Object implements Serializable


Serialized Fields


name
String name

 The error name.
 


code
Integer code

 The error code.
 


message
String message

 The error message.
 








Class com.amazonaws.services.frauddetector.model.BatchGetVariableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


names
List<E> names

 The list of variable names to get.
 








Class com.amazonaws.services.frauddetector.model.BatchGetVariableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


variables
List<E> variables

 The returned variables.
 


errors
List<E> errors

 The errors from the request.
 








Class com.amazonaws.services.frauddetector.model.CreateDetectorVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID of the detector under which you want to create a new version.
 


description
String description

 The description of the detector version.
 


externalModelEndpoints
List<E> externalModelEndpoints

 The Amazon Sagemaker model endpoints to include in the detector version.
 


rules
List<E> rules

 The rules to include in the detector version.
 


modelVersions
List<E> modelVersions

 The model versions to include in the detector version.
 








Class com.amazonaws.services.frauddetector.model.CreateDetectorVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID for the created version's parent detector.
 


detectorVersionId
String detectorVersionId

 The ID for the created detector.
 


status
String status

 The status of the detector version.
 








Class com.amazonaws.services.frauddetector.model.CreateModelVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


modelId
String modelId

 The model ID.
 


modelType
String modelType

 The model type.
 


description
String description

 The model version description.
 








Class com.amazonaws.services.frauddetector.model.CreateModelVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


modelId
String modelId

 The model ID.
 


modelType
String modelType

 The model type.
 


modelVersionNumber
String modelVersionNumber

 The version of the model.
 


status
String status

 The model version status.
 








Class com.amazonaws.services.frauddetector.model.CreateRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleId
String ruleId

 The rule ID.
 


detectorId
String detectorId

 The detector ID for the rule's parent detector.
 


description
String description

 The rule description.
 


expression
String expression

 The rule expression.
 


language
String language

 The language of the rule.
 


outcomes
List<E> outcomes

 The outcome or outcomes returned when the rule expression matches.
 








Class com.amazonaws.services.frauddetector.model.CreateRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rule
Rule rule

 The created rule.
 








Class com.amazonaws.services.frauddetector.model.CreateVariableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the variable.
 


dataType
String dataType

 The data type.
 


dataSource
String dataSource

 The source of the data.
 


defaultValue
String defaultValue

 The default value for the variable when no value is received.
 


description
String description

 The description.
 


variableType
String variableType

 The variable type.
 








Class com.amazonaws.services.frauddetector.model.CreateVariableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.DeleteDetectorVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID of the parent detector for the detector version to delete.
 


detectorVersionId
String detectorVersionId

 The ID of the detector version to delete.
 








Class com.amazonaws.services.frauddetector.model.DeleteDetectorVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.DeleteEventRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventId
String eventId

 The ID of the event to delete.
 








Class com.amazonaws.services.frauddetector.model.DeleteEventResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.DescribeDetectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The detector ID.
 


nextToken
String nextToken

 The next token from the previous response.
 


maxResults
Integer maxResults

 The maximum number of results to return for the request.
 








Class com.amazonaws.services.frauddetector.model.DescribeDetectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detectorId
String detectorId

 The detector ID.
 


detectorVersionSummaries
List<E> detectorVersionSummaries

 The status and description for each detector version.
 


nextToken
String nextToken

 The next token to be used for subsequent requests.
 








Class com.amazonaws.services.frauddetector.model.DescribeModelVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


modelId
String modelId

 The model ID.
 


modelVersionNumber
String modelVersionNumber

 The model version.
 


modelType
String modelType

 The model type.
 


nextToken
String nextToken

 The next token from the previous results.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 








Class com.amazonaws.services.frauddetector.model.DescribeModelVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


modelVersionDetails
List<E> modelVersionDetails

 The model version details.
 


nextToken
String nextToken

 The next token.
 








Class com.amazonaws.services.frauddetector.model.Detector extends Object implements Serializable


Serialized Fields


detectorId
String detectorId

 The detector ID.
 


description
String description

 The detector description.
 


lastUpdatedTime
String lastUpdatedTime

 Timestamp of when the detector was last updated.
 


createdTime
String createdTime

 Timestamp of when the detector was created.
 








Class com.amazonaws.services.frauddetector.model.DetectorVersionSummary extends Object implements Serializable


Serialized Fields


detectorVersionId
String detectorVersionId

 The detector version ID.
 


status
String status

 The detector version status.
 


description
String description

 The detector version description.
 


lastUpdatedTime
String lastUpdatedTime

 Timestamp of when the detector version was last updated.
 








Class com.amazonaws.services.frauddetector.model.ExternalModel extends Object implements Serializable


Serialized Fields


modelEndpoint
String modelEndpoint

 The Amazon SageMaker model endpoints.
 


modelSource
String modelSource

 The source of the model.
 


role
Role role

 The role used to invoke the model.
 


inputConfiguration
ModelInputConfiguration inputConfiguration

 The input configuration.
 


outputConfiguration
ModelOutputConfiguration outputConfiguration

 The output configuration.
 


modelEndpointStatus
String modelEndpointStatus

 The Amazon Fraud Detector status for the external model endpoint
 


lastUpdatedTime
String lastUpdatedTime

 Timestamp of when the model was last updated.
 


createdTime
String createdTime

 Timestamp of when the model was last created.
 








Class com.amazonaws.services.frauddetector.model.GetDetectorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The detector ID.
 


nextToken
String nextToken

 The next token for the subsequent request.
 


maxResults
Integer maxResults

 The maximum number of objects to return for the request.
 








Class com.amazonaws.services.frauddetector.model.GetDetectorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detectors
List<E> detectors

 The detectors.
 


nextToken
String nextToken

 The next page token.
 








Class com.amazonaws.services.frauddetector.model.GetDetectorVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The detector ID.
 


detectorVersionId
String detectorVersionId

 The detector version ID.
 








Class com.amazonaws.services.frauddetector.model.GetDetectorVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detectorId
String detectorId

 The detector ID.
 


detectorVersionId
String detectorVersionId

 The detector version ID.
 


description
String description

 The detector version description.
 


externalModelEndpoints
List<E> externalModelEndpoints

 The Amazon SageMaker model endpoints included in the detector version.
 


modelVersions
List<E> modelVersions

 The model versions included in the detector version.
 


rules
List<E> rules

 The rules included in the detector version.
 


status
String status

 The status of the detector version.
 


lastUpdatedTime
String lastUpdatedTime

 The timestamp when the detector version was last updated.
 


createdTime
String createdTime

 The timestamp when the detector version was created.
 








Class com.amazonaws.services.frauddetector.model.GetExternalModelsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


modelEndpoint
String modelEndpoint

 The Amazon SageMaker model endpoint.
 


nextToken
String nextToken

 The next page token for the request.
 


maxResults
Integer maxResults

 The maximum number of objects to return for the request.
 








Class com.amazonaws.services.frauddetector.model.GetExternalModelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


externalModels
List<E> externalModels

 Gets the Amazon SageMaker models.
 


nextToken
String nextToken

 The next page token to be used in subsequent requests.
 








Class com.amazonaws.services.frauddetector.model.GetModelsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


modelType
String modelType

 The model type.
 


modelId
String modelId

 The model ID.
 


nextToken
String nextToken

 The next token for the request.
 


maxResults
Integer maxResults

 The maximum results to return for the request.
 








Class com.amazonaws.services.frauddetector.model.GetModelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 The next token for subsequent requests.
 


models
List<E> models

 The returned models.
 








Class com.amazonaws.services.frauddetector.model.GetModelVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


modelId
String modelId

 The model ID.
 


modelType
String modelType

 The model type.
 


modelVersionNumber
String modelVersionNumber

 The model version.
 








Class com.amazonaws.services.frauddetector.model.GetModelVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


modelId
String modelId

 The model ID.
 


modelType
String modelType

 The model type.
 


modelVersionNumber
String modelVersionNumber

 The model version.
 


description
String description

 The model version description.
 


status
String status

 The model version status.
 








Class com.amazonaws.services.frauddetector.model.GetOutcomesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the outcome or outcomes to get.
 


nextToken
String nextToken

 The next page token for the request.
 


maxResults
Integer maxResults

 The maximum number of objects to return for the request.
 








Class com.amazonaws.services.frauddetector.model.GetOutcomesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


outcomes
List<E> outcomes

 The outcomes.
 


nextToken
String nextToken

 The next page token for subsequent requests.
 








Class com.amazonaws.services.frauddetector.model.GetPredictionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The detector ID.
 


detectorVersionId
String detectorVersionId

 The detector version ID.
 


eventId
String eventId

 The unique ID used to identify the event.
 


eventAttributes
Map<K,V> eventAttributes

 Names of variables you defined in Amazon Fraud Detector to represent event data elements and their corresponding
 values for the event you are sending for evaluation.
 


externalModelEndpointDataBlobs
Map<K,V> externalModelEndpointDataBlobs

 The Amazon SageMaker model endpoint input data blobs.
 








Class com.amazonaws.services.frauddetector.model.GetPredictionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


outcomes
List<E> outcomes

 The prediction outcomes.
 


modelScores
List<E> modelScores

 The model scores for models used in the detector version.
 








Class com.amazonaws.services.frauddetector.model.GetRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleId
String ruleId

 The rule ID.
 


detectorId
String detectorId

 The detector ID.
 


ruleVersion
String ruleVersion

 The rule version.
 


nextToken
String nextToken

 The next page token.
 


maxResults
Integer maxResults

 The maximum number of rules to return for the request.
 








Class com.amazonaws.services.frauddetector.model.GetRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ruleDetails
List<E> ruleDetails

 The details of the requested rule.
 


nextToken
String nextToken

 The next page token to be used in subsequent requests.
 








Class com.amazonaws.services.frauddetector.model.GetVariablesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the variable.
 


nextToken
String nextToken

 The next page token of the get variable request.
 


maxResults
Integer maxResults

 The max size per page determined for the get variable request.
 








Class com.amazonaws.services.frauddetector.model.GetVariablesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


variables
List<E> variables

 The names of the variables returned.
 


nextToken
String nextToken

 The next page token to be used in subsequent requests.
 








Class com.amazonaws.services.frauddetector.model.InternalServerException extends AmazonFraudDetectorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.frauddetector.model.LabelSchema extends Object implements Serializable


Serialized Fields


labelKey
String labelKey

 The label key.
 


labelMapper
Map<K,V> labelMapper

 The label mapper maps the Amazon Fraud Detector supported label to the appropriate source labels. For example, if
 "FRAUD" and "LEGIT" are Amazon Fraud Detector supported labels, this mapper could be:
 {"FRAUD" => ["0"], "LEGIT" => ["1"]} or
 {"FRAUD" => ["false"], "LEGIT" => ["true"]} or
 {"FRAUD" => ["fraud", "abuse"], "LEGIT" => ["legit", "safe"]}. The value part of the mapper is
 a list, because you may have multiple variants for a single Amazon Fraud Detector label.
 








Class com.amazonaws.services.frauddetector.model.Model extends Object implements Serializable


Serialized Fields


modelId
String modelId

 The model ID.
 


modelType
String modelType

 The model type.
 


description
String description

 The model description.
 


trainingDataSource
TrainingDataSource trainingDataSource

 The model training data source in Amazon S3.
 


modelVariables
List<E> modelVariables

 The model input variables.
 


labelSchema
LabelSchema labelSchema

 The model label schema.
 


lastUpdatedTime
String lastUpdatedTime

 Timestamp of last time the model was updated.
 


createdTime
String createdTime

 Timestamp of when the model was created.
 








Class com.amazonaws.services.frauddetector.model.ModelEndpointDataBlob extends Object implements Serializable


Serialized Fields


byteBuffer
ByteBuffer byteBuffer

 The byte buffer of the Amazon SageMaker model endpoint input data blob.
 


contentType
String contentType

 The content type of the Amazon SageMaker model endpoint input data blob.
 








Class com.amazonaws.services.frauddetector.model.ModelInputConfiguration extends Object implements Serializable


Serialized Fields


format
String format

 The format of the model input configuration. The format differs depending on if it is passed through to SageMaker
 or constructed by Amazon Fraud Detector.
 


isOpaque
Boolean isOpaque

 For an opaque-model, the input to the model will be a ByteBuffer blob provided in the getPrediction request, and
 will be passed to SageMaker as-is. For non-opaque models, the input will be constructed by Amazon Fraud Detector
 based on the model-configuration.
 


jsonInputTemplate
String jsonInputTemplate

 Template for constructing the JSON input-data sent to SageMaker. At event-evaluation, the placeholders for
 variable names in the template will be replaced with the variable values before being sent to SageMaker.
 


csvInputTemplate
String csvInputTemplate

 Template for constructing the CSV input-data sent to SageMaker. At event-evaluation, the placeholders for
 variable-names in the template will be replaced with the variable values before being sent to SageMaker.
 








Class com.amazonaws.services.frauddetector.model.ModelOutputConfiguration extends Object implements Serializable


Serialized Fields


format
String format

 The format of the model output configuration.
 


jsonKeyToVariableMap
Map<K,V> jsonKeyToVariableMap

 A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.
 


csvIndexToVariableMap
Map<K,V> csvIndexToVariableMap

 A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.
 








Class com.amazonaws.services.frauddetector.model.ModelScores extends Object implements Serializable


Serialized Fields


modelVersion
ModelVersion modelVersion

 The model version.
 


scores
Map<K,V> scores

 The model's fraud prediction scores.
 








Class com.amazonaws.services.frauddetector.model.ModelVariable extends Object implements Serializable


Serialized Fields


name
String name

 The model variable's name.>
 


index
Integer index

 The model variable's index.>
 








Class com.amazonaws.services.frauddetector.model.ModelVersion extends Object implements Serializable


Serialized Fields


modelId
String modelId

 The parent model ID.
 


modelType
String modelType

 The model type.
 


modelVersionNumber
String modelVersionNumber

 The model version.
 








Class com.amazonaws.services.frauddetector.model.ModelVersionDetail extends Object implements Serializable


Serialized Fields


modelId
String modelId

 The model ID.
 


modelType
String modelType

 The model type.
 


modelVersionNumber
String modelVersionNumber

 The model version.
 


description
String description

 The model description.
 


status
String status

 The model status.
 


trainingDataSource
TrainingDataSource trainingDataSource

 The model training data source.
 


modelVariables
List<E> modelVariables

 The model variables.
 


labelSchema
LabelSchema labelSchema

 The model label schema.
 


validationMetrics
Map<K,V> validationMetrics

 The model validation metrics.
 


trainingMetrics
Map<K,V> trainingMetrics

 The model training metrics.
 


lastUpdatedTime
String lastUpdatedTime

 The timestamp when the model was last updated.
 


createdTime
String createdTime

 The timestamp when the model was created.
 








Class com.amazonaws.services.frauddetector.model.Outcome extends Object implements Serializable


Serialized Fields


name
String name

 The outcome name.
 


description
String description

 The outcome description.
 


lastUpdatedTime
String lastUpdatedTime

 The timestamp when the outcome was last updated.
 


createdTime
String createdTime

 The timestamp when the outcome was created.
 








Class com.amazonaws.services.frauddetector.model.PutDetectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The detector ID.
 


description
String description

 The description of the detector.
 








Class com.amazonaws.services.frauddetector.model.PutDetectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.PutExternalModelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


modelEndpoint
String modelEndpoint

 The model endpoints name.
 


modelSource
String modelSource

 The source of the model.
 


role
Role role

 The IAM role used to invoke the model endpoint.
 


inputConfiguration
ModelInputConfiguration inputConfiguration

 The model endpoint input configuration.
 


outputConfiguration
ModelOutputConfiguration outputConfiguration

 The model endpoint output configuration.
 


modelEndpointStatus
String modelEndpointStatus

 The model endpoint’s status in Amazon Fraud Detector.
 








Class com.amazonaws.services.frauddetector.model.PutExternalModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.PutModelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


modelId
String modelId

 The model ID.
 


modelType
String modelType

 The model type.
 


description
String description

 The model description.
 


trainingDataSource
TrainingDataSource trainingDataSource

 The training data source location in Amazon S3.
 


modelVariables
List<E> modelVariables

 The model input variables.
 


labelSchema
LabelSchema labelSchema

 The label schema.
 








Class com.amazonaws.services.frauddetector.model.PutModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.PutOutcomeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the outcome.
 


description
String description

 The outcome description.
 








Class com.amazonaws.services.frauddetector.model.PutOutcomeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.ResourceNotFoundException extends AmazonFraudDetectorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.frauddetector.model.Role extends Object implements Serializable


Serialized Fields


arn
String arn

 The role ARN.
 


name
String name

 The role name.
 








Class com.amazonaws.services.frauddetector.model.Rule extends Object implements Serializable


Serialized Fields


detectorId
String detectorId

 The detector for which the rule is associated.
 


ruleId
String ruleId

 The rule ID.
 


ruleVersion
String ruleVersion

 The rule version.
 








Class com.amazonaws.services.frauddetector.model.RuleDetail extends Object implements Serializable


Serialized Fields


ruleId
String ruleId

 The rule ID.
 


description
String description

 The rule description.
 


detectorId
String detectorId

 The detector for which the rule is associated.
 


ruleVersion
String ruleVersion

 The rule version.
 


expression
String expression

 The rule expression.
 


language
String language

 The rule language.
 


outcomes
List<E> outcomes

 The rule outcomes.
 


lastUpdatedTime
String lastUpdatedTime

 Timestamp of the last time the rule was updated.
 


createdTime
String createdTime

 The timestamp of when the rule was created.
 








Class com.amazonaws.services.frauddetector.model.ThrottlingException extends AmazonFraudDetectorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.frauddetector.model.TrainingDataSource extends Object implements Serializable


Serialized Fields


dataLocation
String dataLocation

 The data location of the training data source.
 


dataAccessRoleArn
String dataAccessRoleArn

 The data access role ARN for the training data source.
 








Class com.amazonaws.services.frauddetector.model.UpdateDetectorVersionMetadataRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The detector ID.
 


detectorVersionId
String detectorVersionId

 The detector version ID.
 


description
String description

 The description.
 








Class com.amazonaws.services.frauddetector.model.UpdateDetectorVersionMetadataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.UpdateDetectorVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The parent detector ID for the detector version you want to update.
 


detectorVersionId
String detectorVersionId

 The detector version ID.
 


externalModelEndpoints
List<E> externalModelEndpoints

 The Amazon SageMaker model endpoints to include in the detector version.
 


rules
List<E> rules

 The rules to include in the detector version.
 


description
String description

 The detector version description.
 


modelVersions
List<E> modelVersions

 The model versions to include in the detector version.
 








Class com.amazonaws.services.frauddetector.model.UpdateDetectorVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.UpdateDetectorVersionStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The detector ID.
 


detectorVersionId
String detectorVersionId

 The detector version ID.
 


status
String status

 The new status.
 








Class com.amazonaws.services.frauddetector.model.UpdateDetectorVersionStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.UpdateModelVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


modelId
String modelId

 The model ID.
 


modelType
String modelType

 The model type.
 


modelVersionNumber
String modelVersionNumber

 The model version.
 


description
String description

 The model description.
 


status
String status

 The new model status.
 








Class com.amazonaws.services.frauddetector.model.UpdateModelVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.UpdateRuleMetadataRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rule
Rule rule

 The rule to update.
 


description
String description

 The rule description.
 








Class com.amazonaws.services.frauddetector.model.UpdateRuleMetadataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.UpdateRuleVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rule
Rule rule

 The rule to update.
 


description
String description

 The description.
 


expression
String expression

 The rule expression.
 


language
String language

 The language.
 


outcomes
List<E> outcomes

 The outcomes.
 








Class com.amazonaws.services.frauddetector.model.UpdateRuleVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rule
Rule rule

 The new rule version that was created.
 








Class com.amazonaws.services.frauddetector.model.UpdateVariableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the variable.
 


defaultValue
String defaultValue

 The new default value of the variable.
 


description
String description

 The new description.
 


variableType
String variableType

 The variable type.
 








Class com.amazonaws.services.frauddetector.model.UpdateVariableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.frauddetector.model.ValidationException extends AmazonFraudDetectorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.frauddetector.model.Variable extends Object implements Serializable


Serialized Fields


name
String name

 The name of the variable.
 


dataType
String dataType

 The data type of the variable.
 


dataSource
String dataSource

 The data source of the variable.
 


defaultValue
String defaultValue

 The default value of the variable.
 


description
String description

 The description of the variable.
 


variableType
String variableType

 The variable type of the variable.
 


lastUpdatedTime
String lastUpdatedTime

 The time when variable was last updated.
 


createdTime
String createdTime

 The time when the variable was created.
 








Class com.amazonaws.services.frauddetector.model.VariableEntry extends Object implements Serializable


Serialized Fields


name
String name

 The name of the variable entry.
 


dataType
String dataType

 The data type of the variable entry.
 


dataSource
String dataSource

 The data source of the variable entry.
 


defaultValue
String defaultValue

 The default value of the variable entry.
 


description
String description

 The description of the variable entry.
 


variableType
String variableType

 The type of the variable entry.
 








Package com.amazonaws.services.fsx.model




Class com.amazonaws.services.fsx.model.ActiveDirectoryBackupAttributes extends Object implements Serializable


Serialized Fields


domainName
String domainName

 The fully qualified domain name of the self-managed AD directory.
 


activeDirectoryId
String activeDirectoryId

 The ID of the AWS Managed Microsoft Active Directory instance to which the file system is joined.
 








Class com.amazonaws.services.fsx.model.ActiveDirectoryErrorException extends AmazonFSxException implements Serializable

serialVersionUID:
1L



Serialized Fields


activeDirectoryId
String activeDirectoryId

 The directory ID of the directory that an error pertains to.
 


type
String type

 The type of Active Directory error.
 








Class com.amazonaws.services.fsx.model.AmazonFSxException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.Backup extends Object implements Serializable


Serialized Fields


backupId
String backupId

 The ID of the backup.
 


lifecycle
String lifecycle

 The lifecycle status of the backup.
 


failureDetails
BackupFailureDetails failureDetails

 Details explaining any failures that occur when creating a backup.
 


type
String type

 The type of the backup.
 


progressPercent
Integer progressPercent


creationTime
Date creationTime

 The time when a particular backup was created.
 


kmsKeyId
String kmsKeyId

 The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup of the Amazon FSx for Windows
 file system's data at rest. Amazon FSx for Lustre does not support KMS encryption.
 


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) for the backup resource.
 


tags
List<E> tags

 Tags associated with a particular file system.
 


fileSystem
FileSystem fileSystem

 Metadata of the file system associated with the backup. This metadata is persisted even if the file system is
 deleted.
 


directoryInformation
ActiveDirectoryBackupAttributes directoryInformation

 The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance
 is joined.
 








Class com.amazonaws.services.fsx.model.BackupFailureDetails extends Object implements Serializable


Serialized Fields


message
String message

 A message describing the backup creation failure.
 








Class com.amazonaws.services.fsx.model.BackupInProgressException extends AmazonFSxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.BackupNotFoundException extends AmazonFSxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.BackupRestoringException extends AmazonFSxException implements Serializable

serialVersionUID:
1L



Serialized Fields


fileSystemId
String fileSystemId

 The ID of a file system being restored from the backup.
 








Class com.amazonaws.services.fsx.model.BadRequestException extends AmazonFSxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.CancelDataRepositoryTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 Specifies the data repository task to cancel.
 








Class com.amazonaws.services.fsx.model.CancelDataRepositoryTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


lifecycle
String lifecycle

 The lifecycle status of the data repository task, as follows:
 
 
 
 
 PENDING - Amazon FSx has not started the task.
 
 
 
 
 EXECUTING - Amazon FSx is processing the task.
 
 
 
 
 FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task
 failed to process. The DataRepositoryTaskFailureDetails property provides more information about task
 failures.
 
 
 
 
 SUCCEEDED - FSx completed the task successfully.
 
 
 
 
 CANCELED - Amazon FSx canceled the task and it did not complete.
 
 
 
 
 CANCELING - FSx is in process of canceling the task.
 
 
 


taskId
String taskId

 The ID of the task being canceled.
 








Class com.amazonaws.services.fsx.model.CompletionReport extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Set Enabled to True to generate a CompletionReport when the task
 completes. If set to true, then you need to provide a report Scope, Path,
 and Format. Set Enabled to False if you do not want a
 CompletionReport generated when the task completes.
 


path
String path

 Required if Enabled is set to true. Specifies the location of the report on the file
 system's linked S3 data repository. An absolute path that defines where the completion report will be stored in
 the destination location. The Path you provide must be located within the file system’s ExportPath.
 An example Path value is "s3://myBucket/myExportPath/optionalPrefix". The report provides the
 following information for each file in the report: FilePath, FileStatus, and ErrorCode. To learn more about a
 file system's ExportPath, see .
 


format
String format

 Required if Enabled is set to true. Specifies the format of the
 CompletionReport. REPORT_CSV_20191124 is the only format currently supported. When
 Format is set to REPORT_CSV_20191124, the CompletionReport is provided in
 CSV format, and is delivered to {path}/task-{id}/failures.csv.
 


scope
String scope

 Required if Enabled is set to true. Specifies the scope of the
 CompletionReport; FAILED_FILES_ONLY is the only scope currently supported. When
 Scope is set to FAILED_FILES_ONLY, the CompletionReport only contains
 information about files that the data repository task failed to process.
 








Class com.amazonaws.services.fsx.model.CreateBackupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 The ID of the file system to back up.
 


clientRequestToken
String clientRequestToken

 (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string
 is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
 


tags
List<E> tags

 The tags to apply to the backup at backup creation. The key value of the Name tag appears in the
 console as the backup name.
 








Class com.amazonaws.services.fsx.model.CreateBackupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


backup
Backup backup

 A description of the backup.
 








Class com.amazonaws.services.fsx.model.CreateDataRepositoryTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


type
String type

 Specifies the type of data repository task to create.
 


paths
List<E> paths

 (Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. The
 default path is the file system root directory.
 


fileSystemId
String fileSystemId


report
CompletionReport report

 Defines whether or not Amazon FSx provides a CompletionReport once the task has completed. A CompletionReport
 provides a detailed report on the files that Amazon FSx processed that meet the criteria specified by the
 Scope parameter.
 


clientRequestToken
String clientRequestToken


tags
List<E> tags








Class com.amazonaws.services.fsx.model.CreateDataRepositoryTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataRepositoryTask
DataRepositoryTask dataRepositoryTask

 The description of the data repository task that you just created.
 








Class com.amazonaws.services.fsx.model.CreateFileSystemFromBackupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


backupId
String backupId


clientRequestToken
String clientRequestToken

 (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string
 is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
 


subnetIds
List<E> subnetIds

 A list of IDs for the subnets that the file system will be accessible from. Currently, you can specify only one
 subnet. The file server is also launched in that subnet's Availability Zone.
 


securityGroupIds
List<E> securityGroupIds

 A list of IDs for the security groups that apply to the specified network interfaces created for file system
 access. These security groups apply to all network interfaces. This value isn't returned in later describe
 requests.
 


tags
List<E> tags

 The tags to be applied to the file system at file system creation. The key value of the Name tag
 appears in the console as the file system name.
 


windowsConfiguration
CreateFileSystemWindowsConfiguration windowsConfiguration

 The configuration for this Microsoft Windows file system.
 








Class com.amazonaws.services.fsx.model.CreateFileSystemFromBackupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fileSystem
FileSystem fileSystem

 A description of the file system.
 








Class com.amazonaws.services.fsx.model.CreateFileSystemLustreConfiguration extends Object implements Serializable


Serialized Fields


weeklyMaintenanceStartTime
String weeklyMaintenanceStartTime

 The preferred time to perform weekly maintenance, in the UTC time zone.
 


importPath
String importPath

 (Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data
 repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped
 to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If
 you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file
 system.
 


exportPath
String exportPath

 (Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. The path must use the
 same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed
 data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not
 provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp].
 The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z.
 
 
 The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you
 only specify a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects
 to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a
 custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx
 exports the contents of your file system to that export prefix in the Amazon S3 bucket.
 


importedFileChunkSize
Integer importedFileChunkSize

 (Optional) For files imported from a data repository, this value determines the stripe count and maximum amount
 of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be
 striped across is limited by the total number of disks that make up the file system.
 
 
 The chunk size default is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a
 maximum size of 5 TB.
 








Class com.amazonaws.services.fsx.model.CreateFileSystemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientRequestToken
String clientRequestToken

 (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string
 is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
 


fileSystemType
String fileSystemType

 The type of Amazon FSx file system to create.
 


storageCapacity
Integer storageCapacity

 The storage capacity of the file system being created.
 
 
 For Windows file systems, valid values are 32 GiB - 65,536 GiB.
 
 
 For Lustre file systems, valid values are 1,200, 2,400, 3,600, then continuing in increments of 3600 GiB.
 


subnetIds
List<E> subnetIds

 Specifies the IDs of the subnets that the file system will be accessible from. For Windows
 MULTI_AZ_1 file system deployment types, provide exactly two subnet IDs, one for the preferred file
 server and one for the standy file server. You specify one of these subnets as the preferred subnet using the
 WindowsConfiguration > PreferredSubnetID property.
 
 
 For Windows SINGLE_AZ_1 file system deployment types and Lustre file systems, provide exactly one
 subnet ID. The file server is launched in that subnet's Availability Zone.
 


securityGroupIds
List<E> securityGroupIds

 A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
 This list isn't returned in later requests to describe the file system.
 


tags
List<E> tags

 The tags to apply to the file system being created. The key value of the Name tag appears in the
 console as the file system name.
 


kmsKeyId
String kmsKeyId


windowsConfiguration
CreateFileSystemWindowsConfiguration windowsConfiguration

 The Microsoft Windows configuration for the file system being created. This value is required if
 FileSystemType is set to WINDOWS.
 


lustreConfiguration
CreateFileSystemLustreConfiguration lustreConfiguration








Class com.amazonaws.services.fsx.model.CreateFileSystemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fileSystem
FileSystem fileSystem

 The configuration of the file system that was created.
 








Class com.amazonaws.services.fsx.model.CreateFileSystemWindowsConfiguration extends Object implements Serializable


Serialized Fields


activeDirectoryId
String activeDirectoryId

 The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when
 it's created.
 


selfManagedActiveDirectoryConfiguration
SelfManagedActiveDirectoryConfiguration selfManagedActiveDirectoryConfiguration


deploymentType
String deploymentType

 Specifies the file system deployment type, valid values are the following:
 
 
 
 
 MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate
 temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that
 have a minimum of three Availability Zones.
 
 
 
 
 SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.
 
 
 
 
 To learn more about high availability Multi-AZ file systems, see  High Availability for
 Amazon FSx for Windows File Server.
 


preferredSubnetId
String preferredSubnetId

 Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which
 you want the preferred file server to be located. For in-AWS applications, we recommend that you launch your
 clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ data transfer costs
 and minimize latency.
 


throughputCapacity
Integer throughputCapacity

 The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the nth increments,
 between 2^3 (8) and 2^11 (2048).
 


weeklyMaintenanceStartTime
String weeklyMaintenanceStartTime

 The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone.
 


dailyAutomaticBackupStartTime
String dailyAutomaticBackupStartTime

 The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.
 


automaticBackupRetentionDays
Integer automaticBackupRetentionDays

 The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value
 to 0 disables the creation of automatic backups. The maximum retention period for backups is 35 days.
 


copyTagsToBackups
Boolean copyTagsToBackups

 A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to
 false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups
 where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified
 tags are copied to backups.
 








Class com.amazonaws.services.fsx.model.DataRepositoryConfiguration extends Object implements Serializable


Serialized Fields


importPath
String importPath

 The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your
 FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified
 after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.
 


exportPath
String exportPath

 The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file
 system files in S3.
 


importedFileChunkSize
Integer importedFileChunkSize

 For files imported from a data repository, this value determines the stripe count and maximum amount of data per
 file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped
 across is limited by the total number of disks that make up the file system.
 
 
 The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a
 maximum size of 5 TB.
 








Class com.amazonaws.services.fsx.model.DataRepositoryTask extends Object implements Serializable


Serialized Fields


taskId
String taskId

 The system-generated, unique 17-digit ID of the data repository task.
 


lifecycle
String lifecycle

 The lifecycle status of the data repository task, as follows:
 
 
 
 
 PENDING - Amazon FSx has not started the task.
 
 
 
 
 EXECUTING - Amazon FSx is processing the task.
 
 
 
 
 FAILED - Amazon FSx was not able to complete the task. For example, there may be files the task
 failed to process. The DataRepositoryTaskFailureDetails property provides more information about task
 failures.
 
 
 
 
 SUCCEEDED - FSx completed the task successfully.
 
 
 
 
 CANCELED - Amazon FSx canceled the task and it did not complete.
 
 
 
 
 CANCELING - FSx is in process of canceling the task.
 
 
 
 
 
 You cannot delete an FSx for Lustre file system if there are data repository tasks for the file system in the
 PENDING or EXECUTING states. Please retry when the data repository task is finished
 (with a status of CANCELED, SUCCEEDED, or FAILED). You can use the
 DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your
 file system immediately.
 
 


type
String type

 The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
 


creationTime
Date creationTime


startTime
Date startTime

 The time that Amazon FSx began processing the task.
 


endTime
Date endTime

 The time that Amazon FSx completed processing the task, populated after the task is complete.
 


resourceARN
String resourceARN


tags
List<E> tags


fileSystemId
String fileSystemId


paths
List<E> paths

 An array of paths on the Amazon FSx for Lustre file system that specify the data for the data repository task to
 process. For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data
 repository.
 
 
 (Default) If Paths is not specified, Amazon FSx uses the file system root directory.
 


failureDetails
DataRepositoryTaskFailureDetails failureDetails

 Failure message describing why the task failed, it is populated only when Lifecycle is set to
 FAILED.
 


status
DataRepositoryTaskStatus status

 Provides the status of the number of files that the task has processed successfully and failed to process.
 


report
CompletionReport report








Class com.amazonaws.services.fsx.model.DataRepositoryTaskEndedException extends AmazonFSxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.DataRepositoryTaskExecutingException extends AmazonFSxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.DataRepositoryTaskFailureDetails extends Object implements Serializable


Serialized Fields


message
String message








Class com.amazonaws.services.fsx.model.DataRepositoryTaskFilter extends Object implements Serializable


Serialized Fields


name
String name

 Name of the task property to use in filtering the tasks returned in the response.
 
 
 
 
 Use file-system-id to retrieve data repository tasks for specific file systems.
 
 
 
 
 Use task-lifecycle to retrieve data repository tasks with one or more specific lifecycle states, as
 follows: CANCELED, EXECUTING, FAILED, PENDING, and SUCCEEDED.
 
 
 


values
List<E> values

 Use Values to include the specific file system IDs and task lifecycle states for the filters you are using.
 








Class com.amazonaws.services.fsx.model.DataRepositoryTaskNotFoundException extends AmazonFSxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.DataRepositoryTaskStatus extends Object implements Serializable


Serialized Fields


totalCount
Long totalCount

 The total number of files that the task will process. While a task is executing, the sum of
 SucceededCount plus FailedCount may not equal TotalCount. When the task is
 complete, TotalCount equals the sum of SucceededCount plus FailedCount.
 


succeededCount
Long succeededCount

 A running total of the number of files that the task has successfully processed.
 


failedCount
Long failedCount

 A running total of the number of files that the task failed to process.
 


lastUpdatedTime
Date lastUpdatedTime

 The time at which the task status was last updated.
 








Class com.amazonaws.services.fsx.model.DeleteBackupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


backupId
String backupId

 The ID of the backup you want to delete.
 


clientRequestToken
String clientRequestToken

 (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is
 automatically filled on your behalf when using the AWS CLI or SDK.
 








Class com.amazonaws.services.fsx.model.DeleteBackupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


backupId
String backupId

 The ID of the backup deleted.
 


lifecycle
String lifecycle

 The lifecycle of the backup. Should be DELETED.
 








Class com.amazonaws.services.fsx.model.DeleteFileSystemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 The ID of the file system you want to delete.
 


clientRequestToken
String clientRequestToken

 (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is
 automatically filled on your behalf when using the AWS CLI or SDK.
 


windowsConfiguration
DeleteFileSystemWindowsConfiguration windowsConfiguration








Class com.amazonaws.services.fsx.model.DeleteFileSystemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fileSystemId
String fileSystemId

 The ID of the file system being deleted.
 


lifecycle
String lifecycle

 The file system lifecycle for the deletion request. Should be DELETING.
 


windowsResponse
DeleteFileSystemWindowsResponse windowsResponse








Class com.amazonaws.services.fsx.model.DeleteFileSystemWindowsConfiguration extends Object implements Serializable


Serialized Fields


skipFinalBackup
Boolean skipFinalBackup

 By default, Amazon FSx for Windows takes a final backup on your behalf when the DeleteFileSystem
 operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final
 backup. If you want to skip this backup, use this flag to do so.
 


finalBackupTags
List<E> finalBackupTags

 A set of tags for your final backup.
 








Class com.amazonaws.services.fsx.model.DeleteFileSystemWindowsResponse extends Object implements Serializable


Serialized Fields


finalBackupId
String finalBackupId

 The ID of the final backup for this file system.
 


finalBackupTags
List<E> finalBackupTags

 The set of tags applied to the final backup.
 








Class com.amazonaws.services.fsx.model.DescribeBackupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


backupIds
List<E> backupIds

 (Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not
 found, BackupNotFound will be thrown.
 


filters
List<E> filters

 (Optional) Filters structure. Supported names are file-system-id and backup-type.
 


maxResults
Integer maxResults

 (Optional) Maximum number of backups to return in the response (integer). This parameter value must be greater
 than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter
 specified in the request and the service's internal maximum number of items per page.
 


nextToken
String nextToken

 (Optional) Opaque pagination token returned from a previous DescribeBackups operation (String). If a
 token present, the action continues the list from where the returning call left off.
 








Class com.amazonaws.services.fsx.model.DescribeBackupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


backups
List<E> backups

 Any array of backups.
 


nextToken
String nextToken

 This is present if there are more backups than returned in the response (String). You can use the
 NextToken value in the later request to fetch the backups.
 








Class com.amazonaws.services.fsx.model.DescribeDataRepositoryTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskIds
List<E> taskIds

 (Optional) IDs of the tasks whose descriptions you want to retrieve (String).
 


filters
List<E> filters

 (Optional) You can use filters to narrow the DescribeDataRepositoryTasks response to include just
 tasks for specific file systems, or tasks in a specific lifecycle state.
 


maxResults
Integer maxResults


nextToken
String nextToken








Class com.amazonaws.services.fsx.model.DescribeDataRepositoryTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataRepositoryTasks
List<E> dataRepositoryTasks

 The collection of data repository task descriptions returned.
 


nextToken
String nextToken








Class com.amazonaws.services.fsx.model.DescribeFileSystemsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemIds
List<E> fileSystemIds

 (Optional) IDs of the file systems whose descriptions you want to retrieve (String).
 


maxResults
Integer maxResults

 (Optional) Maximum number of file systems to return in the response (integer). This parameter value must be
 greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults
 parameter specified in the request and the service's internal maximum number of items per page.
 


nextToken
String nextToken

 (Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String).
 If a token present, the action continues the list from where the returning call left off.
 








Class com.amazonaws.services.fsx.model.DescribeFileSystemsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fileSystems
List<E> fileSystems

 An array of file system descriptions.
 


nextToken
String nextToken

 Present if there are more file systems than returned in the response (String). You can use the
 NextToken value in the later request to fetch the descriptions.
 








Class com.amazonaws.services.fsx.model.FileSystem extends Object implements Serializable


Serialized Fields


ownerId
String ownerId

 The AWS account that created the file system. If the file system was created by an AWS Identity and Access
 Management (IAM) user, the AWS account to which the IAM user belongs is the owner.
 


creationTime
Date creationTime

 The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.
 


fileSystemId
String fileSystemId

 The system-generated, unique 17-digit ID of the file system.
 


fileSystemType
String fileSystemType

 The type of Amazon FSx file system, either LUSTRE or WINDOWS.
 


lifecycle
String lifecycle

 The lifecycle status of the file system, following are the possible values and what they mean:
 
 
 
 
 AVAILABLE - The file system is in a healthy state, and is reachable and available for use.
 
 
 
 
 CREATING - Amazon FSx is creating the new file system.
 
 
 
 
 DELETING - Amazon FSx is deleting an existing file system.
 
 
 
 
 FAILED - An existing file system has experienced an unrecoverable failure. When creating a new file
 system, Amazon FSx was unable to create the file system.
 
 
 
 
 MISCONFIGURED indicates that the file system is in a failed but recoverable state.
 
 
 
 
 UPDATING indicates that the file system is undergoing a customer initiated update.
 
 
 


failureDetails
FileSystemFailureDetails failureDetails


storageCapacity
Integer storageCapacity

 The storage capacity of the file system in gigabytes (GB).
 


vpcId
String vpcId

 The ID of the primary VPC for the file system.
 


subnetIds
List<E> subnetIds

 The ID of the subnet to contain the endpoint for the file system. One and only one is supported. The file system
 is launched in the Availability Zone associated with this subnet.
 


networkInterfaceIds
List<E> networkInterfaceIds

 The IDs of the elastic network interface from which a specific file system is accessible. The elastic network
 interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more
 information, see Elastic Network
 Interfaces in the Amazon EC2 User Guide.
 
 
 For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx
 for Lustre file system, you can have more than one.
 


dNSName
String dNSName

 The DNS name for the file system.
 


kmsKeyId
String kmsKeyId

 The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx
 for Windows File Server file system. Amazon FSx for Lustre does not support KMS encryption.
 


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) for the file system resource.
 


tags
List<E> tags

 The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources
 in the Amazon EC2 User Guide.
 


windowsConfiguration
WindowsFileSystemConfiguration windowsConfiguration

 The configuration for this Microsoft Windows file system.
 


lustreConfiguration
LustreFileSystemConfiguration lustreConfiguration








Class com.amazonaws.services.fsx.model.FileSystemFailureDetails extends Object implements Serializable


Serialized Fields


message
String message

 A message describing any failures that occurred during file system creation.
 








Class com.amazonaws.services.fsx.model.FileSystemNotFoundException extends AmazonFSxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.Filter extends Object implements Serializable


Serialized Fields


name
String name

 The name for this filter.
 


values
List<E> values

 The values of the filter. These are all the values for any of the applied filters.
 








Class com.amazonaws.services.fsx.model.IncompatibleParameterErrorException extends AmazonFSxException implements Serializable

serialVersionUID:
1L



Serialized Fields


parameter
String parameter

 A parameter that is incompatible with the earlier request.
 








Class com.amazonaws.services.fsx.model.InternalServerErrorException extends AmazonFSxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.InvalidExportPathException extends AmazonFSxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.InvalidImportPathException extends AmazonFSxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.InvalidNetworkSettingsException extends AmazonFSxException implements Serializable

serialVersionUID:
1L



Serialized Fields


invalidSubnetId
String invalidSubnetId


invalidSecurityGroupId
String invalidSecurityGroupId








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


Serialized Fields


resourceARN
String resourceARN

 The ARN of the Amazon FSx resource that will have its tags listed.
 


maxResults
Integer maxResults

 (Optional) Maximum number of tags to return in the response (integer). This parameter value must be greater than
 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified
 in the request and the service's internal maximum number of items per page.
 


nextToken
String nextToken

 (Optional) Opaque pagination token returned from a previous ListTagsForResource operation (String).
 If a token present, the action continues the list from where the returning call left off.
 








Class com.amazonaws.services.fsx.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 A list of tags on the resource.
 


nextToken
String nextToken

 This is present if there are more tags than returned in the response (String). You can use the
 NextToken value in the later request to fetch the tags.
 








Class com.amazonaws.services.fsx.model.LustreFileSystemConfiguration extends Object implements Serializable


Serialized Fields


weeklyMaintenanceStartTime
String weeklyMaintenanceStartTime

 The UTC time that you want to begin your weekly maintenance window.
 


dataRepositoryConfiguration
DataRepositoryConfiguration dataRepositoryConfiguration








Class com.amazonaws.services.fsx.model.MissingFileSystemConfigurationException extends AmazonFSxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.NotServiceResourceErrorException extends AmazonFSxException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the non-Amazon FSx resource.
 








Class com.amazonaws.services.fsx.model.ResourceDoesNotSupportTaggingException extends AmazonFSxException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the resource that doesn't support tagging.
 








Class com.amazonaws.services.fsx.model.ResourceNotFoundException extends AmazonFSxException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceARN
String resourceARN

 The resource ARN of the resource that can't be found.
 








Class com.amazonaws.services.fsx.model.SelfManagedActiveDirectoryAttributes extends Object implements Serializable


Serialized Fields


domainName
String domainName

 The fully qualified domain name of the self-managed AD directory.
 


organizationalUnitDistinguishedName
String organizationalUnitDistinguishedName

 The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which
 the Windows File Server instance is joined.
 


fileSystemAdministratorsGroup
String fileSystemAdministratorsGroup

 The name of the domain group whose members have administrative privileges for the FSx file system.
 


userName
String userName

 The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.
 


dnsIps
List<E> dnsIps

 A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
 








Class com.amazonaws.services.fsx.model.SelfManagedActiveDirectoryConfiguration extends Object implements Serializable


Serialized Fields


domainName
String domainName

 The fully qualified domain name of the self-managed AD directory, such as corp.example.com.
 


organizationalUnitDistinguishedName
String organizationalUnitDistinguishedName

 (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD
 directory that the Windows File Server instance will join. Amazon FSx only accepts OU as the direct parent of the
 file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in
 the default location of your self-managed AD directory.
 
 
 
 Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.
 
 


fileSystemAdministratorsGroup
String fileSystemAdministratorsGroup

 (Optional) The name of the domain group whose members are granted administrative privileges for the file system.
 Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on
 files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that
 you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is
 used.
 


userName
String userName

 The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD
 domain. This account must have the permission to join computers to the domain in the organizational unit provided
 in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.
 


password
String password

 The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD
 domain.
 


dnsIps
List<E> dnsIps

 A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP
 addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being
 created, or in the private IP version 4 (IPv4) address ranges, as specified in RFC 1918:
 
 
 
 
 10.0.0.0 - 10.255.255.255 (10/8 prefix)
 
 
 
 
 172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
 
 
 
 
 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
 
 
 








Class com.amazonaws.services.fsx.model.SelfManagedActiveDirectoryConfigurationUpdates extends Object implements Serializable


Serialized Fields


userName
String userName

 The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD
 domain. This account must have the permission to join computers to the domain in the organizational unit provided
 in OrganizationalUnitDistinguishedName.
 


password
String password

 The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD
 domain.
 


dnsIps
List<E> dnsIps

 A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.
 








Class com.amazonaws.services.fsx.model.ServiceLimitExceededException extends AmazonFSxException implements Serializable

serialVersionUID:
1L



Serialized Fields


limit
String limit

 Enumeration of the service limit that was exceeded.
 








Class com.amazonaws.services.fsx.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to
 which they are attached.
 


value
String value

 A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can
 be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of
 finances : April and also of payroll : April.
 








Class com.amazonaws.services.fsx.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag.
 


tags
List<E> tags

 A list of tags for the resource. If a tag with a given key already exists, the value is replaced by the one
 specified in this parameter.
 








Class com.amazonaws.services.fsx.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.fsx.model.UnsupportedOperationException extends AmazonFSxException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.fsx.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the Amazon FSx resource to untag.
 


tagKeys
List<E> tagKeys

 A list of keys of tags on the resource to untag. In case the tag key doesn't exist, the call will still succeed
 to be idempotent.
 








Class com.amazonaws.services.fsx.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.fsx.model.UpdateFileSystemLustreConfiguration extends Object implements Serializable


Serialized Fields


weeklyMaintenanceStartTime
String weeklyMaintenanceStartTime

 The preferred time to perform weekly maintenance, in the UTC time zone.
 








Class com.amazonaws.services.fsx.model.UpdateFileSystemRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fileSystemId
String fileSystemId


clientRequestToken
String clientRequestToken

 (Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string
 is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.
 


windowsConfiguration
UpdateFileSystemWindowsConfiguration windowsConfiguration

 The configuration update for this Microsoft Windows file system. The only supported options are for backup and
 maintenance and for self-managed Active Directory configuration.
 


lustreConfiguration
UpdateFileSystemLustreConfiguration lustreConfiguration








Class com.amazonaws.services.fsx.model.UpdateFileSystemResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fileSystem
FileSystem fileSystem

 A description of the file system that was updated.
 








Class com.amazonaws.services.fsx.model.UpdateFileSystemWindowsConfiguration extends Object implements Serializable


Serialized Fields


weeklyMaintenanceStartTime
String weeklyMaintenanceStartTime

 The preferred time to perform weekly maintenance, in the UTC time zone.
 


dailyAutomaticBackupStartTime
String dailyAutomaticBackupStartTime

 The preferred time to take daily automatic backups, in the UTC time zone.
 


automaticBackupRetentionDays
Integer automaticBackupRetentionDays

 The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain
 automatic backups for a maximum of 35 days.
 


selfManagedActiveDirectoryConfiguration
SelfManagedActiveDirectoryConfigurationUpdates selfManagedActiveDirectoryConfiguration

 The configuration Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft AD
 directory.
 








Class com.amazonaws.services.fsx.model.WindowsFileSystemConfiguration extends Object implements Serializable


Serialized Fields


activeDirectoryId
String activeDirectoryId

 The ID for an existing Microsoft Active Directory instance that the file system should join when it's created.
 


selfManagedActiveDirectoryConfiguration
SelfManagedActiveDirectoryAttributes selfManagedActiveDirectoryConfiguration


deploymentType
String deploymentType

 Specifies the file system deployment type, valid values are the following:
 
 
 
 
 MULTI_AZ_1 - Specifies a high availability file system that is configured for Multi-AZ redundancy to
 tolerate temporary Availability Zone (AZ) unavailability.
 
 
 
 
 SINGLE_AZ_1 - (Default) Specifies a file system that is configured for single AZ redundancy.
 
 
 


remoteAdministrationEndpoint
String remoteAdministrationEndpoint

 For MULTI_AZ_1 deployment types, use this endpoint when performing administrative tasks on the file
 system using Amazon FSx Remote PowerShell.
 
 
 For SINGLE_AZ_1 deployment types, this is the DNS name of the file system.
 
 
 This endpoint is temporarily unavailable when the file system is undergoing maintenance.
 


preferredSubnetId
String preferredSubnetId

 For MULTI_AZ_1 deployment types, it specifies the ID of the subnet where the preferred file server
 is located. Must be one of the two subnet IDs specified in SubnetIds property. Amazon FSx serves
 traffic from this subnet except in the event of a failover to the secondary file server.
 
 
 For SINGLE_AZ_1 deployment types, this value is the same as that for SubnetIDs.
 


preferredFileServerIp
String preferredFileServerIp

 For MULTI_AZ_1 deployment types, the IP address of the primary, or preferred, file server.
 
 
 Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined
 to a Microsoft Active Directory. Applicable for both SINGLE_AZ_1 and MULTI_AZ_1
 deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For
 Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For
 more information and instruction on mapping and mounting file shares, see https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html.
 


throughputCapacity
Integer throughputCapacity

 The throughput of an Amazon FSx file system, measured in megabytes per second.
 


maintenanceOperationsInProgress
List<E> maintenanceOperationsInProgress

 The list of maintenance operations in progress for this file system.
 


weeklyMaintenanceStartTime
String weeklyMaintenanceStartTime

 The preferred time to perform weekly maintenance, in the UTC time zone.
 


dailyAutomaticBackupStartTime
String dailyAutomaticBackupStartTime

 The preferred time to take daily automatic backups, in the UTC time zone.
 


automaticBackupRetentionDays
Integer automaticBackupRetentionDays

 The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain
 automatic backups for a maximum of 35 days.
 


copyTagsToBackups
Boolean copyTagsToBackups

 A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to
 false. If it's set to true, all tags on the file system are copied to all automatic backups and any
 user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or
 more tags, only the specified tags are copied to backups.
 








Package com.amazonaws.services.gamelift.model




Class com.amazonaws.services.gamelift.model.AcceptMatchRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ticketId
String ticketId

 A unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE;
 otherwise this request will fail.
 


playerIds
List<E> playerIds

 A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.
 


acceptanceType
String acceptanceType

 Player response to the proposed match.
 








Class com.amazonaws.services.gamelift.model.AcceptMatchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.Alias extends Object implements Serializable


Serialized Fields


aliasId
String aliasId

 A unique identifier for an alias. Alias IDs are unique within a Region.
 


name
String name

 A descriptive label that is associated with an alias. Alias names do not need to be unique.
 


aliasArn
String aliasArn

 Amazon Resource Name (ARN) that is assigned to a
 GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions.. In a GameLift alias ARN,
 the resource ID matches the alias ID value.
 


description
String description

 A human-readable description of an alias.
 


routingStrategy
RoutingStrategy routingStrategy

 The routing configuration, including routing type and fleet target, for the alias.
 


creationTime
Date creationTime

 A time stamp indicating when this data object was created. Format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 


lastUpdatedTime
Date lastUpdatedTime

 The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for
 example "1469498468.057").
 








Class com.amazonaws.services.gamelift.model.AmazonGameLiftException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.AttributeValue extends Object implements Serializable


Serialized Fields


s
String s

 For single string values. Maximum string length is 100 characters.
 


n
Double n

 For number values, expressed as double.
 


sL
List<E> sL

 For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not
 recognized; all occurrences of the repeated value after the first of a repeated value are ignored.
 


sDM
Map<K,V> sDM

 For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.
 








Class com.amazonaws.services.gamelift.model.Build extends Object implements Serializable


Serialized Fields


buildId
String buildId

 A unique identifier for a build.
 


buildArn
String buildArn

 Amazon Resource Name (ARN) that is assigned to a
 GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift build ARN,
 the resource ID matches the BuildId value.
 


name
String name

 A descriptive label that is associated with a build. Build names do not need to be unique. It can be set using
 CreateBuild or UpdateBuild.
 


version
String version

 Version information that is associated with a build or script. Version strings do not need to be unique. This
 value can be set using CreateBuild or UpdateBuild.
 


status
String status

 Current status of the build.
 
 
 Possible build statuses include the following:
 
 
 
 
 INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for
 builds that are in this status. When a build is successfully created, the build status is set to this value.
 
 
 
 
 READY -- The game build has been successfully uploaded. You can now create new fleets for this build.
 
 
 
 
 FAILED -- The game build upload failed. You cannot create new fleets for this build.
 
 
 


sizeOnDisk
Long sizeOnDisk

 File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this
 value is 0.
 


operatingSystem
String operatingSystem

 Operating system that the game server binaries are built to run on. This value determines the type of fleet
 resources that you can use for this build.
 


creationTime
Date creationTime

 Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 








Class com.amazonaws.services.gamelift.model.CertificateConfiguration extends Object implements Serializable


Serialized Fields


certificateType
String certificateType

 Indicates whether a TLS/SSL certificate was generated for a fleet.
 
 
 
 
 








Class com.amazonaws.services.gamelift.model.ConflictException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A descriptive label that is associated with an alias. Alias names do not need to be unique.
 


description
String description

 A human-readable description of the alias.
 


routingStrategy
RoutingStrategy routingStrategy

 The routing configuration, including routing type and fleet target, for the alias.
 


tags
List<E> tags

 A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging AWS
 resources are useful for resource management, access management and cost allocation. For more information, see  Tagging AWS Resources in the AWS
 General Reference. Once the resource is created, you can use TagResource, UntagResource, and
 ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the
 AWS General Reference for actual tagging limits.
 








Class com.amazonaws.services.gamelift.model.CreateAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


alias
Alias alias

 The newly created alias resource.
 








Class com.amazonaws.services.gamelift.model.CreateBuildRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A descriptive label that is associated with a build. Build names do not need to be unique. You can use
 UpdateBuild to change this value later.
 


version
String version

 Version information that is associated with a build or script. Version strings do not need to be unique. You can
 use UpdateBuild to change this value later.
 


storageLocation
S3Location storageLocation

 Information indicating where your game build files are stored. Use this parameter only when creating a build with
 files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and
 key. The location must also specify a role ARN that you set up to allow Amazon GameLift to access your Amazon S3
 bucket. The S3 bucket and your new build must be in the same Region.
 


operatingSystem
String operatingSystem

 The operating system that the game server binaries are built to run on. This value determines the type of fleet
 resources that you can use for this build. If your game build contains multiple executables, they all must run on
 the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses
 the default value (WINDOWS_2012). This value cannot be changed later.
 


tags
List<E> tags

 A list of labels to assign to the new build resource. Tags are developer-defined key-value pairs. Tagging AWS
 resources are useful for resource management, access management and cost allocation. For more information, see  Tagging AWS Resources in the AWS
 General Reference. Once the resource is created, you can use TagResource, UntagResource, and
 ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the
 AWS General Reference for actual tagging limits.
 








Class com.amazonaws.services.gamelift.model.CreateBuildResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


build
Build build

 The newly created build record, including a unique build IDs and status.
 


uploadCredentials
Credentials uploadCredentials

 This element is returned only when the operation is called without a storage location. It contains credentials to
 use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have
 a limited life span. To refresh these credentials, call RequestUploadCredentials.
 


storageLocation
S3Location storageLocation

 Amazon S3 location for your game build file, including bucket name and key.
 








Class com.amazonaws.services.gamelift.model.CreateFleetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
 


description
String description

 A human-readable description of a fleet.
 


buildId
String buildId

 A unique identifier for a build to be deployed on the new fleet. You can use either the build ID or ARN value.
 The custom game server build must have been successfully uploaded to Amazon GameLift and be in a
 READY status. This fleet setting cannot be changed once the fleet is created.
 


scriptId
String scriptId

 A unique identifier for a Realtime script to be deployed on the new fleet. You can use either the script ID or
 ARN value. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot
 be changed once the fleet is created.
 


serverLaunchPath
String serverLaunchPath

 This parameter is no longer used. Instead, specify a server launch path using the
 RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters
 instead of a runtime configuration will continue to work.
 


serverLaunchParameters
String serverLaunchParameters

 This parameter is no longer used. Instead, specify server launch parameters in the
 RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters
 instead of a runtime configuration will continue to work.)
 


logPaths
List<E> logPaths

 This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server
 process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more
 directory paths in logParameters. See more information in the Server API Reference.
 


eC2InstanceType
String eC2InstanceType

 The name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the
 computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity.
 Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
 


eC2InboundPermissions
List<E> eC2InboundPermissions

 Range of IP addresses and port settings that permit inbound traffic to access game sessions that are running on
 the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the
 fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges
 for use by the Realtime servers. You can specify multiple permission settings or add more by updating the fleet.
 


newGameSessionProtectionPolicy
String newGameSessionProtectionPolicy

 A game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances
 in this fleet default to no protection. You can change a fleet's protection policy using
 UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can
 also 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.
 
 
 


runtimeConfiguration
RuntimeConfiguration runtimeConfiguration

 Instructions for launching server processes on each instance in the fleet. Server processes run either a custom
 game build executable or a Realtime script. The runtime configuration defines the server executables or launch
 script file, launch parameters, and the number of processes to run concurrently on each instance. When creating a
 fleet, the runtime configuration must have at least one server process configuration; otherwise the request fails
 with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and
 ServerLaunchParameters, although requests that contain values for these parameters instead of a
 runtime configuration will continue to work.) This parameter is required unless the parameters
 ServerLaunchPath and ServerLaunchParameters are defined. Runtime configuration replaced
 these parameters, but fleets that use them will continue to work.
 


resourceCreationLimitPolicy
ResourceCreationLimitPolicy resourceCreationLimitPolicy

 A policy that limits the number of game sessions an individual player can create over a span of time for this
 fleet.
 


metricGroups
List<E> metricGroups

 The name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all
 fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A
 fleet can only be included in one metric group at a time.
 


peerVpcAwsAccountId
String peerVpcAwsAccountId

 A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You
 can find your account ID in the AWS Management Console under account settings.
 


peerVpcId
String peerVpcId

 A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the
 same Region as your fleet. To look up a VPC ID, use the VPC
 Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon
 GameLift Fleets.
 


fleetType
String fleetType

 Indicates whether to use On-Demand instances or Spot instances for this fleet. If empty, the default is
 ON_DEMAND. Both categories of instances use identical hardware and configurations based on the
 instance type selected for this fleet. Learn more about  On-Demand versus Spot Instances.
 


instanceRoleArn
String instanceRoleArn

 A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set,
 any application that runs on an instance in this fleet can assume the role, including install scripts, server
 processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console. Learn more about
 using on-box credentials for your game servers at  Access
 external resources from a game server.
 


certificateConfiguration
CertificateConfiguration certificateConfiguration

 Indicates whether to generate a TLS/SSL certificate for the new fleet. TLS certificates are used for encrypting
 traffic between game clients and game servers running on GameLift. If this parameter is not specified, the
 default value, DISABLED, is used. This fleet setting cannot be changed once the fleet is created. Learn more at
 Securing Client/Server Communication.
 
 
 Note: This feature requires the AWS Certificate Manager (ACM) service, which is available in the AWS global
 partition but not in all other partitions. When working in a partition that does not support this feature, a
 request for a new fleet with certificate generation results fails with a 4xx unsupported Region error.
 
 
 Valid values include:
 
 
 
 
 GENERATED - Generate a TLS/SSL certificate for this fleet.
 
 
 
 
 DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
 
 
 


tags
List<E> tags

 A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging AWS
 resources are useful for resource management, access management and cost allocation. For more information, see  Tagging AWS Resources in the AWS
 General Reference. Once the resource is created, you can use TagResource, UntagResource, and
 ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the
 AWS General Reference for actual tagging limits.
 








Class com.amazonaws.services.gamelift.model.CreateFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fleetAttributes
FleetAttributes fleetAttributes

 Properties for the newly created fleet.
 








Class com.amazonaws.services.gamelift.model.CreateGameSessionQueueRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
 


timeoutInSeconds
Integer timeoutInSeconds

 The maximum time, in seconds, that a new game session placement request remains in the queue. When a request
 exceeds this time, the game session placement changes to a TIMED_OUT status.
 


playerLatencyPolicies
List<E> playerLatencyPolicies

 A collection of latency policies to apply when processing game sessions placement requests with player latency
 information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest
 latency values. With just one policy, the policy is enforced at the start of the game session placement for the
 duration period. With multiple policies, each policy is enforced consecutively for its duration period. For
 example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the
 remainder of the placement. A player latency policy must set a value for
 MaximumIndividualPlayerLatencyMilliseconds. If none is set, this API request fails.
 


destinations
List<E> destinations

 A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified
 by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
 


tags
List<E> tags

 A list of labels to assign to the new game session queue resource. Tags are developer-defined key-value pairs.
 Tagging AWS resources are useful for resource management, access management and cost allocation. For more
 information, see  Tagging AWS
 Resources in the AWS General Reference. Once the resource is created, you can use TagResource,
 UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be
 lower than stated. See the AWS General Reference for actual tagging limits.
 








Class com.amazonaws.services.gamelift.model.CreateGameSessionQueueResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gameSessionQueue
GameSessionQueue gameSessionQueue

 An object that describes the newly created game session queue.
 








Class com.amazonaws.services.gamelift.model.CreateGameSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to create a game session in. You can use either the fleet ID or ARN value. Each
 request must reference either a fleet ID or alias ID, but not both.
 


aliasId
String aliasId

 A unique identifier for an alias associated with the fleet to create a game session in. You can use either the
 alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
 


maximumPlayerSessionCount
Integer maximumPlayerSessionCount

 The maximum number of players that can be connected simultaneously to the game session.
 


name
String name

 A descriptive label that is associated with a game session. Session names do not need to be unique.
 


gameProperties
List<E> gameProperties

 Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game
 server process in the GameSession object with a request to start a new game session (see Start a Game Session).
 


creatorId
String creatorId

 A unique identifier for a player or entity creating the game session. This ID is used to enforce a resource
 protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.
 


gameSessionId
String gameSessionId

 This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string
 that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided,
 this string is included in the new game session's ID. (A game session ARN has the following format:
 arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>
 .)
 


idempotencyToken
String idempotencyToken

 Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters.
 If provided, this string is included in the new game session's ID. (A game session ARN has the following format:
 arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>
 .) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained
 for this time period and then deleted.
 


gameSessionData
String gameSessionData

 Set of custom game session properties, formatted as a single string value. This data is passed to a game server
 process in the GameSession object with a request to start a new game session (see Start a Game Session).
 








Class com.amazonaws.services.gamelift.model.CreateGameSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gameSession
GameSession gameSession

 Object that describes the newly created game session record.
 








Class com.amazonaws.services.gamelift.model.CreateMatchmakingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A unique identifier for a matchmaking configuration. This name is used to identify the configuration associated
 with a matchmaking request or ticket.
 


description
String description

 A human-readable description of the matchmaking configuration.
 


gameSessionQueueArns
List<E> gameSessionQueueArns

 Amazon Resource Name (ARN) that is assigned to a
 GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. These queues
 are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can
 be located in any Region.
 


requestTimeoutSeconds
Integer requestTimeoutSeconds

 The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests
 that fail due to timing out can be resubmitted as needed.
 


acceptanceTimeoutSeconds
Integer acceptanceTimeoutSeconds

 The length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match
 or fails to accept before the timeout, the ticket continues to look for an acceptable match.
 


acceptanceRequired
Boolean acceptanceRequired

 A flag that determines whether a match that was created with this configuration must be accepted by the matched
 players. To require acceptance, set to TRUE.
 


ruleSetName
String ruleSetName

 A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set
 name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.
 


notificationTarget
String notificationTarget

 An SNS topic ARN that is set up to receive matchmaking notifications.
 


additionalPlayerCount
Integer additionalPlayerCount

 The number of player slots in a match to keep open for future players. For example, assume that the
 configuration's rule set specifies a match for a single 12-person team. If the additional player count is set to
 2, only 10 players are initially selected for the match.
 


customEventData
String customEventData

 Information to be added to all events related to this matchmaking configuration.
 


gameProperties
List<E> gameProperties

 A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a
 game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a
 successful match.
 


gameSessionData
String gameSessionData

 A set of custom game session properties, formatted as a single string value. This data is passed to a game server
 process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a
 successful match.
 


backfillMode
String backfillMode

 The method used to backfill game sessions that are created with this matchmaking configuration. Specify
 MANUAL when your game manages backfill requests manually or does not use the match backfill feature.
 Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game
 session has one or more open slots. Learn more about manual and automatic backfill in  Backfill Existing Games
 with FlexMatch.
 


tags
List<E> tags

 A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value
 pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more
 information, see  Tagging AWS
 Resources in the AWS General Reference. Once the resource is created, you can use TagResource,
 UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be
 lower than stated. See the AWS General Reference for actual tagging limits.
 








Class com.amazonaws.services.gamelift.model.CreateMatchmakingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configuration
MatchmakingConfiguration configuration

 Object that describes the newly created matchmaking configuration.
 








Class com.amazonaws.services.gamelift.model.CreateMatchmakingRuleSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A unique identifier for a matchmaking rule set. A matchmaking configuration identifies the rule set it uses by
 this name value. Note that the rule set name is different from the optional name field in the rule
 set body.
 


ruleSetBody
String ruleSetBody

 A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most
 elements support a description field.
 


tags
List<E> tags

 A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs.
 Tagging AWS resources are useful for resource management, access management and cost allocation. For more
 information, see  Tagging AWS
 Resources in the AWS General Reference. Once the resource is created, you can use TagResource,
 UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be
 lower than stated. See the AWS General Reference for actual tagging limits.
 








Class com.amazonaws.services.gamelift.model.CreateMatchmakingRuleSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ruleSet
MatchmakingRuleSet ruleSet

 The newly created matchmaking rule set.
 








Class com.amazonaws.services.gamelift.model.CreatePlayerSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


gameSessionId
String gameSessionId

 A unique identifier for the game session to add a player to.
 


playerId
String playerId

 A unique identifier for a player. Player IDs are developer-defined.
 


playerData
String playerData

 Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted
 as needed for use in the game.
 








Class com.amazonaws.services.gamelift.model.CreatePlayerSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


playerSession
PlayerSession playerSession

 Object that describes the newly created player session record.
 








Class com.amazonaws.services.gamelift.model.CreatePlayerSessionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


gameSessionId
String gameSessionId

 A unique identifier for the game session to add players to.
 


playerIds
List<E> playerIds

 List of unique identifiers for the players to be added.
 


playerDataMap
Map<K,V> playerDataMap

 Map of string pairs, each specifying a player ID and a set of developer-defined information related to the
 player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Player data
 strings for player IDs not included in the PlayerIds parameter are ignored.
 








Class com.amazonaws.services.gamelift.model.CreatePlayerSessionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


playerSessions
List<E> playerSessions

 A collection of player session objects created for the added players.
 








Class com.amazonaws.services.gamelift.model.CreateScriptRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A descriptive label that is associated with a script. Script names do not need to be unique. You can use
 UpdateScript to change this value later.
 


version
String version

 The version that is associated with a build or script. Version strings do not need to be unique. You can use
 UpdateScript to change this value later.
 


storageLocation
S3Location storageLocation

 The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage
 location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon
 GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to
 create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3
 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
 


zipFile
ByteBuffer zipFile

 A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or
 multiple files. Maximum size of a zip file is 5 MB.
 
 
 When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended
 with the string "fileb://" to indicate that the file data is a binary object. For example:
 --zip-file fileb://myRealtimeScript.zip.
 


tags
List<E> tags

 A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS
 resources are useful for resource management, access management and cost allocation. For more information, see  Tagging AWS Resources in the AWS
 General Reference. Once the resource is created, you can use TagResource, UntagResource, and
 ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the
 AWS General Reference for actual tagging limits.
 








Class com.amazonaws.services.gamelift.model.CreateScriptResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


script
Script script

 The newly created script record with a unique script ID and ARN. The new script's storage location reflects an
 Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location
 reflects the information that was provided in the CreateScript request; (2) If the script file was
 uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift
 service.
 








Class com.amazonaws.services.gamelift.model.CreateVpcPeeringAuthorizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


gameLiftAwsAccountId
String gameLiftAwsAccountId

 A unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your
 Account ID in the AWS Management Console under account settings.
 


peerVpcId
String peerVpcId

 A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the
 same Region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC
 peering in VPC Peering with
 Amazon GameLift Fleets.
 








Class com.amazonaws.services.gamelift.model.CreateVpcPeeringAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcPeeringAuthorization
VpcPeeringAuthorization vpcPeeringAuthorization

 Details on the requested VPC peering authorization, including expiration.
 








Class com.amazonaws.services.gamelift.model.CreateVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet. You can use either the fleet ID or ARN value. This tells Amazon GameLift which
 GameLift VPC to peer with.
 


peerVpcAwsAccountId
String peerVpcAwsAccountId

 A unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You
 can find your Account ID in the AWS Management Console under account settings.
 


peerVpcId
String peerVpcId

 A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the
 same Region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC
 peering in VPC Peering with
 Amazon GameLift Fleets.
 








Class com.amazonaws.services.gamelift.model.CreateVpcPeeringConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.Credentials extends Object implements Serializable


Serialized Fields


accessKeyId
String accessKeyId

 Temporary key allowing access to the Amazon GameLift S3 account.
 


secretAccessKey
String secretAccessKey

 Temporary secret key allowing access to the Amazon GameLift S3 account.
 


sessionToken
String sessionToken

 Token used to associate a specific build ID with the files uploaded using these credentials.
 








Class com.amazonaws.services.gamelift.model.DeleteAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


aliasId
String aliasId

 A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value.
 








Class com.amazonaws.services.gamelift.model.DeleteAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.DeleteBuildRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


buildId
String buildId

 A unique identifier for a build to delete. You can use either the build ID or ARN value.
 








Class com.amazonaws.services.gamelift.model.DeleteBuildResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.DeleteFleetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to be deleted. You can use either the fleet ID or ARN value.
 








Class com.amazonaws.services.gamelift.model.DeleteFleetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.DeleteGameSessionQueueRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
 You can use either the queue ID or ARN value.
 








Class com.amazonaws.services.gamelift.model.DeleteGameSessionQueueResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.DeleteMatchmakingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A unique identifier for a matchmaking configuration. You can use either the configuration name or ARN value.
 








Class com.amazonaws.services.gamelift.model.DeleteMatchmakingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.DeleteMatchmakingRuleSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A unique identifier for a matchmaking rule set to be deleted. (Note: The rule set name is different from the
 optional "name" field in the rule set body.) You can use either the rule set name or ARN value.
 








Class com.amazonaws.services.gamelift.model.DeleteMatchmakingRuleSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.DeleteScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
 


fleetId
String fleetId

 A unique identifier for a fleet to be deleted. You can use either the fleet ID or ARN value.
 








Class com.amazonaws.services.gamelift.model.DeleteScalingPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.DeleteScriptRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


scriptId
String scriptId

 A unique identifier for a Realtime script to delete. You can use either the script ID or ARN value.
 








Class com.amazonaws.services.gamelift.model.DeleteScriptResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.DeleteVpcPeeringAuthorizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


gameLiftAwsAccountId
String gameLiftAwsAccountId

 A unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your
 Account ID in the AWS Management Console under account settings.
 


peerVpcId
String peerVpcId

 A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the
 same Region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC
 peering in VPC Peering with
 Amazon GameLift Fleets.
 








Class com.amazonaws.services.gamelift.model.DeleteVpcPeeringAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.DeleteVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet. This fleet specified must match the fleet referenced in the VPC peering
 connection record. You can use either the fleet ID or ARN value.
 


vpcPeeringConnectionId
String vpcPeeringConnectionId

 A unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection
 object, which can be retrieved by calling DescribeVpcPeeringConnections.
 








Class com.amazonaws.services.gamelift.model.DeleteVpcPeeringConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.DescribeAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


aliasId
String aliasId

 The unique identifier for the fleet alias that you want to retrieve. You can use either the alias ID or ARN
 value.
 








Class com.amazonaws.services.gamelift.model.DescribeAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


alias
Alias alias

 The requested alias resource.
 








Class com.amazonaws.services.gamelift.model.DescribeBuildRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


buildId
String buildId

 A unique identifier for a build to retrieve properties for. You can use either the build ID or ARN value.
 








Class com.amazonaws.services.gamelift.model.DescribeBuildResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


build
Build build

 Set of properties describing the requested build.
 








Class com.amazonaws.services.gamelift.model.DescribeEC2InstanceLimitsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eC2InstanceType
String eC2InstanceType

 Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing
 resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift
 supports the following EC2 instance types. See Amazon EC2
 Instance Types for detailed descriptions. Leave this parameter blank to retrieve limits for all types.
 








Class com.amazonaws.services.gamelift.model.DescribeEC2InstanceLimitsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eC2InstanceLimits
List<E> eC2InstanceLimits

 The maximum number of instances for the specified instance type.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetIds
List<E> fleetIds

 A unique identifier for a fleet(s) to retrieve attributes for. You can use either the fleet ID or ARN value.
 


limit
Integer limit

 The maximum number of results to return. 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 that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter
 is ignored when the request specifies one or a list of fleet IDs.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fleetAttributes
List<E> fleetAttributes

 A collection of objects containing attribute metadata for each requested fleet ID.
 


nextToken
String nextToken

 Token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetCapacityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetIds
List<E> fleetIds

 A unique identifier for a fleet(s) to retrieve capacity information for. You can use either the fleet ID or ARN
 value.
 


limit
Integer limit

 The maximum number of results to return. 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 that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter
 is ignored when the request specifies one or a list of fleet IDs.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetCapacityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fleetCapacity
List<E> fleetCapacity

 A 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 that indicates 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.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to get event logs for. You can use either the fleet ID or ARN 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 a number expressed in Unix time as milliseconds
 (ex: "1469498468.057").
 


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 a number expressed in Unix time as milliseconds (ex:
 "1469498468.057").
 


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages.
 


nextToken
String nextToken

 Token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


events
List<E> events

 A collection of objects containing event log entries for the specified fleet.
 


nextToken
String nextToken

 Token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetPortSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to retrieve port settings for. You can use either the fleet ID or ARN value.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetPortSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


inboundPermissions
List<E> inboundPermissions

 The port settings for the requested fleet ID.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetUtilizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetIds
List<E> fleetIds

 A unique identifier for a fleet(s) to retrieve utilization data for. You can use either the fleet ID or ARN
 value.
 


limit
Integer limit

 The maximum number of results to return. 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 that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter
 is ignored when the request specifies one or a list of fleet IDs.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetUtilizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fleetUtilization
List<E> fleetUtilization

 A collection of objects containing utilization information for each requested fleet ID.
 


nextToken
String nextToken

 Token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.DescribeGameSessionDetailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to retrieve all game sessions active on the fleet. You can use either the fleet
 ID or ARN value.
 


gameSessionId
String gameSessionId

 A unique identifier for the game session to retrieve.
 


aliasId
String aliasId

 A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either
 the alias ID or ARN value.
 


statusFilter
String statusFilter

 Game session status to filter results on. Possible game session statuses include ACTIVE,
 TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
 


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages.
 


nextToken
String nextToken

 Token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.DescribeGameSessionDetailsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gameSessionDetails
List<E> gameSessionDetails

 A collection of objects containing game session properties and the protection policy currently in force for each
 session matching the request.
 


nextToken
String nextToken

 Token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.DescribeGameSessionPlacementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


placementId
String placementId

 A unique identifier for a game session placement to retrieve.
 








Class com.amazonaws.services.gamelift.model.DescribeGameSessionPlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gameSessionPlacement
GameSessionPlacement gameSessionPlacement

 Object that describes the requested game session placement.
 








Class com.amazonaws.services.gamelift.model.DescribeGameSessionQueuesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


names
List<E> names

 A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request
 settings for all queues, leave this parameter empty.
 


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages.
 


nextToken
String nextToken

 A token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.DescribeGameSessionQueuesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gameSessionQueues
List<E> gameSessionQueues

 A collection of objects that describe the requested game session queues.
 


nextToken
String nextToken

 A token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.DescribeGameSessionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to retrieve all game sessions for. You can use either the fleet ID or ARN value.
 


gameSessionId
String gameSessionId

 A unique identifier for the game session to retrieve.
 


aliasId
String aliasId

 A unique identifier for an alias associated with the fleet to retrieve all game sessions for. You can use either
 the alias ID or ARN value.
 


statusFilter
String statusFilter

 Game session status to filter results on. Possible game session statuses include ACTIVE,
 TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).
 


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages.
 


nextToken
String nextToken

 Token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.DescribeGameSessionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gameSessions
List<E> gameSessions

 A collection of objects containing game session properties for each session matching the request.
 


nextToken
String nextToken

 Token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.DescribeInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to retrieve instance information for. You can use either the fleet ID or ARN
 value.
 


instanceId
String instanceId

 A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances
 in the fleet.
 


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages.
 


nextToken
String nextToken

 Token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.DescribeInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instances
List<E> instances

 A collection of objects containing properties for each instance returned.
 


nextToken
String nextToken

 Token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.DescribeMatchmakingConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


names
List<E> names

 A unique identifier for a matchmaking configuration(s) to retrieve. You can use either the configuration name or
 ARN value. To request all existing configurations, leave this parameter empty.
 


ruleSetName
String ruleSetName

 A unique identifier for a matchmaking rule set. You can use either the rule set name or ARN value. Use this
 parameter to retrieve all matchmaking configurations that use this rule set.
 


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages. This parameter is limited to 10.
 


nextToken
String nextToken

 A token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.DescribeMatchmakingConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurations
List<E> configurations

 A collection of requested matchmaking configurations.
 


nextToken
String nextToken

 A token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.DescribeMatchmakingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ticketIds
List<E> ticketIds

 A unique identifier for a matchmaking ticket. You can include up to 10 ID values.
 








Class com.amazonaws.services.gamelift.model.DescribeMatchmakingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ticketList
List<E> ticketList

 A collection of existing matchmaking ticket objects matching the request.
 








Class com.amazonaws.services.gamelift.model.DescribeMatchmakingRuleSetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


names
List<E> names

 A list of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different
 from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value.
 


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages.
 


nextToken
String nextToken

 A token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.DescribeMatchmakingRuleSetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ruleSets
List<E> ruleSets

 A collection of requested matchmaking rule set objects.
 


nextToken
String nextToken

 A token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.DescribePlayerSessionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


gameSessionId
String gameSessionId

 A unique identifier for the game session to retrieve player sessions for.
 


playerId
String playerId

 A unique identifier for a player to retrieve player sessions for.
 


playerSessionId
String playerSessionId

 A unique identifier for a player session to retrieve.
 


playerSessionStatusFilter
String playerSessionStatusFilter

 Player session status to filter results on.
 
 
 Possible player session statuses include the following:
 
 
 
 
 RESERVED -- The player session request has been received, but the player has not yet connected to the
 server process and/or been validated.
 
 
 
 
 ACTIVE -- The player has been validated by the server process 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 timeout limit (60 seconds).
 
 
 


limit
Integer limit

 The maximum number of results to return. 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 that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value. If a player
 session ID is specified, this parameter is ignored.
 








Class com.amazonaws.services.gamelift.model.DescribePlayerSessionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


playerSessions
List<E> playerSessions

 A collection of objects containing properties for each player session that matches the request.
 


nextToken
String nextToken

 Token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.DescribeRuntimeConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to get the runtime configuration for. You can use either the fleet ID or ARN
 value.
 








Class com.amazonaws.services.gamelift.model.DescribeRuntimeConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


runtimeConfiguration
RuntimeConfiguration runtimeConfiguration

 Instructions describing how server processes should be launched and maintained on each instance in the fleet.
 








Class com.amazonaws.services.gamelift.model.DescribeScalingPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to retrieve scaling policies for. You can use either the fleet ID or ARN value.
 


statusFilter
String statusFilter

 Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE
 status.
 
 
 
 
 ACTIVE -- The scaling policy is currently in force.
 
 
 
 
 UPDATEREQUESTED -- A request to update the scaling policy has been received.
 
 
 
 
 UPDATING -- A change is being made to the scaling policy.
 
 
 
 
 DELETEREQUESTED -- A request to delete the scaling policy has been received.
 
 
 
 
 DELETING -- The scaling policy is being deleted.
 
 
 
 
 DELETED -- The scaling policy has been deleted.
 
 
 
 
 ERROR -- An error occurred in creating the policy. It should be removed and recreated.
 
 
 


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages.
 


nextToken
String nextToken

 Token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.DescribeScalingPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


scalingPolicies
List<E> scalingPolicies

 A collection of objects containing the scaling policies matching the request.
 


nextToken
String nextToken

 Token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.DescribeScriptRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


scriptId
String scriptId

 A unique identifier for a Realtime script to retrieve properties for. You can use either the script ID or ARN
 value.
 








Class com.amazonaws.services.gamelift.model.DescribeScriptResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


script
Script script

 A set of properties describing the requested script.
 








Class com.amazonaws.services.gamelift.model.DescribeVpcPeeringAuthorizationsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.gamelift.model.DescribeVpcPeeringAuthorizationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcPeeringAuthorizations
List<E> vpcPeeringAuthorizations

 A collection of objects that describe all valid VPC peering operations for the current AWS account.
 








Class com.amazonaws.services.gamelift.model.DescribeVpcPeeringConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet. You can use either the fleet ID or ARN value.
 








Class com.amazonaws.services.gamelift.model.DescribeVpcPeeringConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vpcPeeringConnections
List<E> vpcPeeringConnections

 A collection of VPC peering connection records that match the request.
 








Class com.amazonaws.services.gamelift.model.DesiredPlayerSession extends Object implements Serializable


Serialized Fields


playerId
String playerId

 A unique identifier for a player to associate with the player session.
 


playerData
String playerData

 Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted
 as needed for use in the game.
 








Class com.amazonaws.services.gamelift.model.EC2InstanceCounts extends Object implements Serializable


Serialized Fields


dESIRED
Integer dESIRED

 Ideal number of active instances in the fleet.
 


mINIMUM
Integer mINIMUM

 The minimum value allowed for the fleet's instance count.
 


mAXIMUM
Integer mAXIMUM

 The maximum value allowed for the fleet's instance count.
 


pENDING
Integer pENDING

 Number of instances in the fleet that are starting but not yet active.
 


aCTIVE
Integer aCTIVE

 Actual number of active instances in the fleet.
 


iDLE
Integer iDLE

 Number of active instances in the fleet that are not currently hosting a game session.
 


tERMINATING
Integer tERMINATING

 Number of instances in the fleet that are no longer active but haven't yet been terminated.
 








Class com.amazonaws.services.gamelift.model.EC2InstanceLimit extends Object implements Serializable


Serialized Fields


eC2InstanceType
String eC2InstanceType

 Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing
 resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift
 supports the following EC2 instance types. See Amazon EC2
 Instance Types for detailed descriptions.
 


currentInstances
Integer currentInstances

 Number of instances of the specified type that are currently in use by this AWS account.
 


instanceLimit
Integer instanceLimit

 Number of instances allowed.
 








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


Serialized Fields


eventId
String eventId

 A unique identifier for a fleet event.
 


resourceId
String resourceId

 A unique identifier for an event resource, such as a fleet ID.
 


eventCode
String eventCode

 The type of event being logged.
 
 
 Fleet creation events (ordered by fleet creation activity):
 
 
 
 
 FLEET_CREATED -- A fleet record was successfully created with a status of NEW. Event messaging
 includes the fleet ID.
 
 
 
 
 FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. The compressed
 build has started downloading to a fleet instance for installation.
 
 
 
 
 FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance.
 
 
 
 
 FLEET_CREATION_EXTRACTING_BUILD – The game server build was successfully downloaded to an instance, and the build
 files are now being extracted from the uploaded build and saved to an instance. Failure at this stage prevents a
 fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are
 extracted and saved on the instance. Access the logs by using the URL in PreSignedLogUrl.
 
 
 
 
 FLEET_CREATION_RUNNING_INSTALLER – The game server build files were successfully extracted, and the Amazon
 GameLift is now running the build's install script (if one is included). Failure in this stage prevents a fleet
 from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the
 install completed successfully. Access the logs by using the URL in PreSignedLogUrl.
 
 
 
 
 FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the Amazon GameLift is now
 verifying that the game server launch paths, which are specified in the fleet's runtime configuration, exist. If
 any listed launch path exists, Amazon GameLift tries to launch a game server process and waits for the process to
 report ready. Failures in this stage prevent a fleet from moving to ACTIVE status. Logs for this
 stage list the launch paths in the runtime configuration and indicate whether each is found. Access the logs by
 using the URL in PreSignedLogUrl.
 
 
 
 
 FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING.
 
 
 
 
 FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime configuration failed because the executable
 specified in a launch path does not exist on the instance.
 
 
 
 
 FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING.
 
 
 
 
 FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime configuration failed because the
 executable specified in a launch path failed to run on the fleet instance.
 
 
 
 
 FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING.
 
 
 
 
 FLEET_ACTIVATION_FAILED - The fleet failed to successfully complete one of the steps in the fleet activation
 process. This event code indicates that the game build was successfully downloaded to a fleet instance, built,
 and validated, but was not able to start a server process. Learn more at  Debug Fleet Creation Issues
 
 
 
 
 FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. The fleet
 is now ready to host game sessions.
 
 
 
 
 VPC peering events:
 
 
 
 
 FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an Amazon
 GameLift fleet and a VPC in your AWS account.
 
 
 
 
 FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information
 (see DescribeVpcPeeringConnections) provide additional detail. A common reason for peering failure is that
 the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC
 in your AWS account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html
 
 
 
 
 FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted.
 
 
 
 
 Spot instance events:
 
 
 
 
 INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification.
 
 
 
 
 Other fleet events:
 
 
 
 
 FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum
 scaling limits). Event messaging includes the new capacity settings.
 
 
 
 
 FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection
 policy setting. Event messaging includes both the old and new policy setting.
 
 
 
 
 FLEET_DELETED -- A request to delete a fleet was initiated.
 
 
 
 
 GENERIC_EVENT -- An unspecified event has occurred.
 
 
 


message
String message

 Additional information related to the event.
 


eventTime
Date eventTime

 Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for
 example "1469498468.057").
 


preSignedLogUrl
String preSignedLogUrl

 Location of stored logs with additional detail that is related to the event. This is useful for debugging issues.
 The URL is valid for 15 minutes. You can also access fleet creation logs through the Amazon GameLift console.
 








Class com.amazonaws.services.gamelift.model.FleetAttributes extends Object implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet.
 


fleetArn
String fleetArn

 The Amazon Resource Name (ARN) that is assigned to a
 GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN,
 the resource ID matches the FleetId value.
 


fleetType
String fleetType

 Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a
 two-minute notification.
 


instanceType
String instanceType

 EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory,
 storage, and networking capacity. See Amazon EC2 Instance
 Types for detailed descriptions.
 


description
String description

 Human-readable description of the fleet.
 


name
String name

 A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
 


creationTime
Date creationTime

 Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 


terminationTime
Date terminationTime

 Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 


status
String status

 Current status of the fleet.
 
 
 Possible fleet statuses include the following:
 
 
 
 
 NEW -- A new fleet has been defined and desired instances is set to 1.
 
 
 
 
 DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new
 instances with the game build or Realtime script and starting server processes.
 
 
 
 
 ACTIVE -- Hosts can now accept game sessions.
 
 
 
 
 ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
 
 
 
 
 DELETING -- Hosts are responding to a delete fleet request.
 
 
 
 
 TERMINATED -- The fleet no longer exists.
 
 
 


buildId
String buildId

 A unique identifier for a build.
 


buildArn
String buildArn

 The Amazon Resource Name (ARN) associated with the
 GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID
 matches the BuildId value.
 


scriptId
String scriptId

 A unique identifier for a Realtime script.
 


scriptArn
String scriptArn

 The Amazon Resource Name (ARN) associated with the
 GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID
 matches the ScriptId value.
 


serverLaunchPath
String serverLaunchPath

 Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK
 v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's
 RuntimeConfiguration.
 


serverLaunchParameters
String serverLaunchParameters

 Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server
 launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.
 


logPaths
List<E> logPaths

 Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log
 files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift
 automatically uploads logs that are stored on each instance at C:\game\logs (for Windows) or
 /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.
 


newGameSessionProtectionPolicy
String newGameSessionProtectionPolicy

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


operatingSystem
String operatingSystem

 Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for
 the build that is deployed on this fleet.
 


resourceCreationLimitPolicy
ResourceCreationLimitPolicy resourceCreationLimitPolicy

 Fleet policy to limit the number of game sessions an individual player can create over a span of time.
 


metricGroups
List<E> metricGroups

 Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an
 individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in
 only one metric group at a time.
 


stoppedActions
List<E> stoppedActions

 List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.
 


instanceRoleArn
String instanceRoleArn

 A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set,
 any application that runs on an instance in this fleet can assume the role, including install scripts, server
 processes, and daemons (background processes). Create a role or look up a role's ARN from the IAM dashboard in the AWS Management Console. Learn more about
 using on-box credentials for your game servers at  Access
 external resources from a game server.
 


certificateConfiguration
CertificateConfiguration certificateConfiguration

 Indicates whether a TLS/SSL certificate was generated for the fleet.
 








Class com.amazonaws.services.gamelift.model.FleetCapacity extends Object implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet.
 


instanceType
String instanceType

 Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing
 resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift
 supports the following EC2 instance types. See Amazon EC2
 Instance Types for detailed descriptions.
 


instanceCounts
EC2InstanceCounts instanceCounts

 Current status of fleet capacity.
 








Class com.amazonaws.services.gamelift.model.FleetCapacityExceededException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.FleetUtilization extends Object implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet.
 


activeServerProcessCount
Integer activeServerProcessCount

 Number of server processes in an ACTIVE status currently running across all instances in the fleet
 


activeGameSessionCount
Integer activeGameSessionCount

 Number of active game sessions currently being hosted on all instances in the fleet.
 


currentPlayerSessionCount
Integer currentPlayerSessionCount

 Number of active player sessions currently being hosted on all instances in the fleet.
 


maximumPlayerSessionCount
Integer maximumPlayerSessionCount

 The maximum number of players allowed across all game sessions currently being hosted on all instances in the
 fleet.
 








Class com.amazonaws.services.gamelift.model.GameProperty extends Object implements Serializable


Serialized Fields


key
String key

 The game property identifier.
 


value
String value

 The game property value.
 








Class com.amazonaws.services.gamelift.model.GameSession extends Object implements Serializable


Serialized Fields


gameSessionId
String gameSessionId

 A unique identifier for the game session. A game session ARN has the following format:
 arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>
 .
 


name
String name

 A descriptive label that is associated with a game session. Session names do not need to be unique.
 


fleetId
String fleetId

 A unique identifier for a fleet that the game session is running on.
 


fleetArn
String fleetArn

 The Amazon Resource Name (ARN) associated with the
 GameLift fleet that this game session is running on.
 


creationTime
Date creationTime

 Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 


terminationTime
Date terminationTime

 Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 


currentPlayerSessionCount
Integer currentPlayerSessionCount

 Number of players currently in the game session.
 


maximumPlayerSessionCount
Integer maximumPlayerSessionCount

 The maximum number of players that can be connected simultaneously to the game session.
 


status
String status

 Current status of the game session. A game session must have an ACTIVE status to have player
 sessions.
 


statusReason
String statusReason

 Provides additional information about game session status. INTERRUPTED indicates that the game
 session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.
 


gameProperties
List<E> gameProperties

 Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game
 server process in the GameSession object with a request to start a new game session (see Start a Game Session). You can search for active game sessions based on this custom data with
 SearchGameSessions.
 


ipAddress
String ipAddress

 IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a
 client needs to reference an IP address (or DNS name) and port number.
 


dnsName
String dnsName

 DNS identifier assigned to the instance that is running the game session. Values have the following format:
 
 
 
 
 TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
 
 
 
 
 Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
 
 
 
 
 When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP
 address.
 


port
Integer port

 Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address
 and port number.
 


playerSessionCreationPolicy
String playerSessionCreationPolicy

 Indicates whether or not the game session is accepting new players.
 


creatorId
String creatorId

 A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that
 limits the number of game sessions a player can create.
 


gameSessionData
String gameSessionData

 Set of custom game session properties, formatted as a single string value. This data is passed to a game server
 process in the GameSession object with a request to start a new game session (see Start a Game Session).
 


matchmakerData
String matchmakerData

 Information about the matchmaking process that was used to create the game session. It is in JSON syntax,
 formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned
 to the match, including player attributes and team assignments. For more details on matchmaker data, see Match
 Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are
 added during a successful backfill (see StartMatchBackfill).
 








Class com.amazonaws.services.gamelift.model.GameSessionConnectionInfo extends Object implements Serializable


Serialized Fields


gameSessionArn
String gameSessionArn

 Amazon Resource Name (ARN) that is assigned to a
 game session and uniquely identifies it.
 


ipAddress
String ipAddress

 IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a
 client needs to reference an IP address (or DNS name) and port number.
 


dnsName
String dnsName

 DNS identifier assigned to the instance that is running the game session. Values have the following format:
 
 
 
 
 TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
 
 
 
 
 Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
 
 
 
 
 When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP
 address.
 


port
Integer port

 Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address
 and port number.
 


matchedPlayerSessions
List<E> matchedPlayerSessions

 A collection of player session IDs, one for each player ID that was included in the original matchmaking request.
 








Class com.amazonaws.services.gamelift.model.GameSessionDetail extends Object implements Serializable


Serialized Fields


gameSession
GameSession gameSession

 Object that describes a game session.
 


protectionPolicy
String protectionPolicy

 Current status of protection for the game session.
 
 
 
 
 NoProtection -- The game session can be terminated during a scale-down event.
 
 
 
 
 FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during
 a scale-down event.
 
 
 








Class com.amazonaws.services.gamelift.model.GameSessionFullException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.GameSessionPlacement extends Object implements Serializable


Serialized Fields


placementId
String placementId

 A unique identifier for a game session placement.
 


gameSessionQueueName
String gameSessionQueueName

 A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
 


status
String status

 Current status of the game session placement request.
 
 
 
 
 PENDING -- The placement request is currently in the queue waiting to be processed.
 
 
 
 
 FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values
 for GameSessionArn and GameSessionRegion are available.
 
 
 
 
 CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.
 
 
 
 
 TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can
 resubmit the placement request as needed.
 
 
 
 
 FAILED -- GameLift is not able to complete the process of placing the game session. Common reasons are the
 game session terminated before the placement process was completed, or an unexpected internal error.
 
 
 


gameProperties
List<E> gameProperties

 Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game
 server process in the GameSession object with a request to start a new game session (see Start a Game Session).
 


maximumPlayerSessionCount
Integer maximumPlayerSessionCount

 The maximum number of players that can be connected simultaneously to the game session.
 


gameSessionName
String gameSessionName

 A descriptive label that is associated with a game session. Session names do not need to be unique.
 


gameSessionId
String gameSessionId

 A unique identifier for the game session. This value is set once the new game session is placed (placement status
 is FULFILLED).
 


gameSessionArn
String gameSessionArn

 Identifier for the game session created by this placement request. This value is set once the new game session is
 placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use
 this value as a GameSessionId value as needed.
 


gameSessionRegion
String gameSessionRegion

 Name of the Region where the game session created by this placement request is running. This value is set once
 the new game session is placed (placement status is FULFILLED).
 


playerLatencies
List<E> playerLatencies

 Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when
 connected to AWS Regions.
 


startTime
Date startTime

 Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 


endTime
Date endTime

 Time stamp indicating when this request was completed, canceled, or timed out.
 


ipAddress
String ipAddress

 IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a
 client needs to reference an IP address (or DNS name) and port number. This value is set once the new game
 session is placed (placement status is FULFILLED).
 


dnsName
String dnsName

 DNS identifier assigned to the instance that is running the game session. Values have the following format:
 
 
 
 
 TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
 
 
 
 
 Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
 
 
 
 
 When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP
 address.
 


port
Integer port

 Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address
 and port number. This value is set once the new game session is placed (placement status is
 FULFILLED).
 


placedPlayerSessions
List<E> placedPlayerSessions

 A collection of information on player sessions created in response to the game session placement request. These
 player sessions are created only once a new game session is successfully placed (placement status is
 FULFILLED). This information includes the player ID (as provided in the placement request) and the
 corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the
 player session ID.
 


gameSessionData
String gameSessionData

 Set of custom game session properties, formatted as a single string value. This data is passed to a game server
 process in the GameSession object with a request to start a new game session (see Start a Game Session).
 


matchmakerData
String matchmakerData

 Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It
 identifies the matchmaking configuration used to create the match, and contains data on all players assigned to
 the match, including player attributes and team assignments. For more details on matchmaker data, see Match
 Data.
 








Class com.amazonaws.services.gamelift.model.GameSessionQueue extends Object implements Serializable


Serialized Fields


name
String name

 A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
 


gameSessionQueueArn
String gameSessionQueueArn

 Amazon Resource Name (ARN) that is assigned to a
 GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. In a
 GameLift game session queue ARN, the resource ID matches the Name value.
 


timeoutInSeconds
Integer timeoutInSeconds

 The maximum time, in seconds, that a new game session placement request remains in the queue. When a request
 exceeds this time, the game session placement changes to a TIMED_OUT status.
 


playerLatencyPolicies
List<E> playerLatencyPolicies

 A collection of latency policies to apply when processing game sessions placement requests with player latency
 information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest
 latency values. With just one policy, the policy is enforced at the start of the game session placement for the
 duration period. With multiple policies, each policy is enforced consecutively for its duration period. For
 example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the
 remainder of the placement.
 


destinations
List<E> destinations

 A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified
 by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.
 








Class com.amazonaws.services.gamelift.model.GameSessionQueueDestination extends Object implements Serializable


Serialized Fields


destinationArn
String destinationArn

 The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias
 ID and a Region name, provide a unique identifier across all Regions.
 








Class com.amazonaws.services.gamelift.model.GetGameSessionLogUrlRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


gameSessionId
String gameSessionId

 A unique identifier for the game session to get logs for.
 








Class com.amazonaws.services.gamelift.model.GetGameSessionLogUrlResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


preSignedUrl
String preSignedUrl

 Location of the requested game session logs, available for download. This URL is valid for 15 minutes, after
 which S3 will reject any download request using this URL. You can request a new URL any time within the 14-day
 period that the logs are retained.
 








Class com.amazonaws.services.gamelift.model.GetInstanceAccessRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet that contains the instance you want access to. You can use either the fleet ID or
 ARN value. The fleet can be in any of the following statuses: ACTIVATING, ACTIVE, or
 ERROR. Fleets with an ERROR status may be accessible for a short time before they are
 deleted.
 


instanceId
String instanceId

 A unique identifier for an instance you want to get access to. You can access an instance in any status.
 








Class com.amazonaws.services.gamelift.model.GetInstanceAccessResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceAccess
InstanceAccess instanceAccess

 The connection information for a fleet instance, including IP address and access credentials.
 








Class com.amazonaws.services.gamelift.model.IdempotentParameterMismatchException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.Instance extends Object implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet that the instance is in.
 


instanceId
String instanceId

 A unique identifier for an instance.
 


ipAddress
String ipAddress

 IP address that is assigned to the instance.
 


dnsName
String dnsName

 DNS identifier assigned to the instance that is running the game session. Values have the following format:
 
 
 
 
 TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
 
 
 
 
 Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
 
 
 
 
 When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP
 address.
 


operatingSystem
String operatingSystem

 Operating system that is running on this instance.
 


type
String type

 EC2 instance type that defines the computing resources of this instance.
 


status
String status

 Current status of the instance. Possible statuses include the following:
 
 
 
 
 PENDING -- The instance is in the process of being created and launching server processes as defined in
 the fleet's run-time configuration.
 
 
 
 
 ACTIVE -- The instance has been successfully created and at least one server process has successfully
 launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now
 considered ready to host game sessions.
 
 
 
 
 TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during
 a scaling down event or to recycle resources in the event of a problem.
 
 
 


creationTime
Date creationTime

 Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 








Class com.amazonaws.services.gamelift.model.InstanceAccess extends Object implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet containing the instance being accessed.
 


instanceId
String instanceId

 A unique identifier for an instance being accessed.
 


ipAddress
String ipAddress

 IP address that is assigned to the instance.
 


operatingSystem
String operatingSystem

 Operating system that is running on the instance.
 


credentials
InstanceCredentials credentials

 Credentials required to access the instance.
 








Class com.amazonaws.services.gamelift.model.InstanceCredentials extends Object implements Serializable


Serialized Fields


userName
String userName

 User login string.
 


secret
String secret

 Secret string. For Windows instances, the secret is a password for use with Windows Remote Desktop. For Linux
 instances, it is a private key (which must be saved as a .pem file) for use with SSH.
 








Class com.amazonaws.services.gamelift.model.InternalServiceException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.InvalidFleetStatusException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.InvalidGameSessionStatusException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.InvalidRequestException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.IpPermission extends Object implements Serializable


Serialized Fields


fromPort
Integer fromPort

 A starting value for a range of allowed port numbers.
 


toPort
Integer toPort

 An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher
 than FromPort.
 


ipRange
String ipRange

 A 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

 The network communication protocol used by the fleet.
 








Class com.amazonaws.services.gamelift.model.LimitExceededException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.ListAliasesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


routingStrategyType
String routingStrategyType

 The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type.
 To retrieve all aliases, leave this parameter empty.
 
 
 Possible routing types include the following:
 
 
 
 
 SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.
 
 
 
 
 TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the
 user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message
 embedded.
 
 
 


name
String name

 A descriptive label that is associated with an alias. Alias names do not need to be unique.
 


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages.
 


nextToken
String nextToken

 A token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.ListAliasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


aliases
List<E> aliases

 A collection of alias resources that match the request parameters.
 


nextToken
String nextToken

 A token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.ListBuildsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


status
String status

 Build status to filter results by. To retrieve all builds, leave this parameter empty.
 
 
 Possible build statuses include the following:
 
 
 
 
 INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for
 builds that are in this status. When a build is successfully created, the build status is set to this value.
 
 
 
 
 READY -- The game build has been successfully uploaded. You can now create new fleets for this build.
 
 
 
 
 FAILED -- The game build upload failed. You cannot create new fleets for this build.
 
 
 


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages.
 


nextToken
String nextToken

 Token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.ListBuildsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


builds
List<E> builds

 A collection of build records that match the request.
 


nextToken
String nextToken

 Token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.ListFleetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


buildId
String buildId

 A unique identifier for a build to return fleets for. Use this parameter to return only fleets using the
 specified build. Use either the build ID or ARN value.To retrieve all fleets, leave this parameter empty.
 


scriptId
String scriptId

 A unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using
 the specified script. Use either the script ID or ARN value.To retrieve all fleets, leave this parameter empty.
 


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages.
 


nextToken
String nextToken

 Token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.ListFleetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fleetIds
List<E> fleetIds

 Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by
 passing this result set to a call to DescribeFleetAttributes, DescribeFleetCapacity, or
 DescribeFleetUtilization.
 


nextToken
String nextToken

 Token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.ListScriptsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages.
 


nextToken
String nextToken

 A token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.ListScriptsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


scripts
List<E> scripts

 A set of properties describing the requested script.
 


nextToken
String nextToken

 A token that indicates 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.
 








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


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN)
 that is assigned to and uniquely identifies the GameLift resource that you want to retrieve tags for. GameLift
 resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or
 Describe action for the resource type.
 








Class com.amazonaws.services.gamelift.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The collection of tags that have been assigned to the specified resource.
 








Class com.amazonaws.services.gamelift.model.MatchedPlayerSession extends Object implements Serializable


Serialized Fields


playerId
String playerId

 A unique identifier for a player
 


playerSessionId
String playerSessionId

 A unique identifier for a player session
 








Class com.amazonaws.services.gamelift.model.MatchmakingConfiguration extends Object implements Serializable


Serialized Fields


name
String name

 A unique identifier for a matchmaking configuration. This name is used to identify the configuration associated
 with a matchmaking request or ticket.
 


configurationArn
String configurationArn

 Amazon Resource Name (ARN) that is assigned to a
 GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. In a
 GameLift configuration ARN, the resource ID matches the Name value.
 


description
String description

 A descriptive label that is associated with matchmaking configuration.
 


gameSessionQueueArns
List<E> gameSessionQueueArns

 Amazon Resource Name (ARN) that is assigned to a
 GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. GameLift
 uses the listed queues when placing game sessions for matches that are created with this matchmaking
 configuration. Queues can be located in any Region.
 


requestTimeoutSeconds
Integer requestTimeoutSeconds

 The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests
 that fail due to timing out can be resubmitted as needed.
 


acceptanceTimeoutSeconds
Integer acceptanceTimeoutSeconds

 The length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match
 or fails to accept before the timeout, the ticket continues to look for an acceptable match.
 


acceptanceRequired
Boolean acceptanceRequired

 A flag that indicates whether a match that was created with this configuration must be accepted by the matched
 players. To require acceptance, set to TRUE.
 


ruleSetName
String ruleSetName

 A unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can
 only use rule sets that are defined in the same Region.
 


ruleSetArn
String ruleSetArn

 The Amazon Resource Name (ARN) associated with the
 GameLift matchmaking rule set resource that this configuration uses.
 


notificationTarget
String notificationTarget

 An SNS topic ARN that is set up to receive matchmaking notifications.
 


additionalPlayerCount
Integer additionalPlayerCount

 The number of player slots in a match to keep open for future players. For example, assume that the
 configuration's rule set specifies a match for a single 12-person team. If the additional player count is set to
 2, only 10 players are initially selected for the match.
 


customEventData
String customEventData

 Information to attach to all events related to the matchmaking configuration.
 


creationTime
Date creationTime

 The time stamp indicating when this data object was created. The format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 


gameProperties
List<E> gameProperties

 A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a
 game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a
 successful match.
 


gameSessionData
String gameSessionData

 A set of custom game session properties, formatted as a single string value. This data is passed to a game server
 process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a
 successful match.
 


backfillMode
String backfillMode

 The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the
 game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift
 creates StartMatchBackfill requests whenever a game session has one or more open slots. Learn more about
 manual and automatic backfill in Backfill Existing Games
 with FlexMatch.
 








Class com.amazonaws.services.gamelift.model.MatchmakingRuleSet extends Object implements Serializable


Serialized Fields


ruleSetName
String ruleSetName

 A unique identifier for a matchmaking rule set
 


ruleSetArn
String ruleSetArn

 Amazon Resource Name (ARN) that is assigned to a
 GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. In a
 GameLift rule set ARN, the resource ID matches the RuleSetName value.
 


ruleSetBody
String ruleSetBody

 A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most
 elements support a description field.
 


creationTime
Date creationTime

 The time stamp indicating when this data object was created. The format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 








Class com.amazonaws.services.gamelift.model.MatchmakingTicket extends Object implements Serializable


Serialized Fields


ticketId
String ticketId

 A unique identifier for a matchmaking ticket.
 


configurationName
String configurationName

 Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine
 how players are grouped into a match and how a new game session is created for the match.
 


configurationArn
String configurationArn

 The Amazon Resource Name (ARN) associated with the
 GameLift matchmaking configuration resource that is used with this ticket.
 


status
String status

 Current status of the matchmaking request.
 
 
 
 
 QUEUED -- The matchmaking request has been received and is currently waiting to be processed.
 
 
 
 
 SEARCHING -- The matchmaking request is currently being processed.
 
 
 
 
 REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see
 AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player
 acceptance requirement.
 
 
 
 
 PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session
 for the match.
 
 
 
 
 COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this
 state contains the necessary connection information for players.
 
 
 
 
 FAILED -- The matchmaking request was not completed.
 
 
 
 
 CANCELLED -- The matchmaking request was canceled. This may be the result of a call to
 StopMatchmaking or a proposed match that one or more players failed to accept.
 
 
 
 
 TIMED_OUT -- The matchmaking request was not successful within the duration specified in the matchmaking
 configuration.
 
 
 
 
 
 Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be
 resubmitted as new requests with new ticket IDs.
 
 


statusReason
String statusReason

 Code to explain the current status. For example, a status reason may indicate when a ticket has returned to
 SEARCHING status after a proposed match fails to receive player acceptances.
 


statusMessage
String statusMessage

 Additional information about the current status.
 


startTime
Date startTime

 Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 


endTime
Date endTime

 Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or
 cancellation. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
 


players
List<E> players

 A set of Player objects, each representing a player to find matches for. Players are identified by a
 unique player ID and may include latency data for use during matchmaking. If the ticket is in status
 COMPLETED, the Player objects include the team the players were assigned to in the
 resulting match.
 


gameSessionConnectionInfo
GameSessionConnectionInfo gameSessionConnectionInfo

 Identifier and connection information of the game session created for the match. This information is added to the
 ticket only after the matchmaking request has been successfully completed.
 


estimatedWaitTime
Integer estimatedWaitTime

 Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent
 data, this property may be empty.
 








Class com.amazonaws.services.gamelift.model.NotFoundException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.PlacedPlayerSession extends Object implements Serializable


Serialized Fields


playerId
String playerId

 A unique identifier for a player that is associated with this player session.
 


playerSessionId
String playerSessionId

 A unique identifier for a player session.
 








Class com.amazonaws.services.gamelift.model.Player extends Object implements Serializable


Serialized Fields


playerId
String playerId

 A unique identifier for a player
 


playerAttributes
Map<K,V> playerAttributes

 A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must
 match the playerAttributes used in a matchmaking rule set. Example:
 "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.
 


team
String team

 Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.
 


latencyInMs
Map<K,V> latencyInMs

 Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when
 connected to AWS Regions. If this property is present, FlexMatch considers placing the match only in Regions for
 which latency is reported.
 
 
 If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If
 no latency is reported in this scenario, FlexMatch assumes that no Regions are available to the player and the
 ticket is not matchable.
 








Class com.amazonaws.services.gamelift.model.PlayerLatency extends Object implements Serializable


Serialized Fields


playerId
String playerId

 A unique identifier for a player associated with the latency data.
 


regionIdentifier
String regionIdentifier

 Name of the Region that is associated with the latency value.
 


latencyInMilliseconds
Float latencyInMilliseconds

 Amount of time that represents the time lag experienced by the player when connected to the specified Region.
 








Class com.amazonaws.services.gamelift.model.PlayerLatencyPolicy extends Object implements Serializable


Serialized Fields


maximumIndividualPlayerLatencyMilliseconds
Integer maximumIndividualPlayerLatencyMilliseconds

 The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for
 this property.
 


policyDurationSeconds
Integer policyDurationSeconds

 The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for
 this property means that the policy is enforced until the queue times out.
 








Class com.amazonaws.services.gamelift.model.PlayerSession extends Object implements Serializable


Serialized Fields


playerSessionId
String playerSessionId

 A unique identifier for a player session.
 


playerId
String playerId

 A unique identifier for a player that is associated with this player session.
 


gameSessionId
String gameSessionId

 A unique identifier for the game session that the player session is connected to.
 


fleetId
String fleetId

 A unique identifier for a fleet that the player's game session is running on.
 


fleetArn
String fleetArn

 The Amazon Resource Name (ARN) associated with the
 GameLift fleet that the player's game session is running on.
 


creationTime
Date creationTime

 Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 


terminationTime
Date terminationTime

 Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 


status
String status

 Current status of the player session.
 
 
 Possible player session statuses include the following:
 
 
 
 
 RESERVED -- The player session request has been received, but the player has not yet connected to the
 server process and/or been validated.
 
 
 
 
 ACTIVE -- The player has been validated by the server process 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 timeout limit (60 seconds).
 
 
 


ipAddress
String ipAddress

 IP address of the instance that is running the game session. When connecting to a Amazon GameLift game server, a
 client needs to reference an IP address (or DNS name) and port number.
 


dnsName
String dnsName

 DNS identifier assigned to the instance that is running the game session. Values have the following format:
 
 
 
 
 TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
 
 
 
 
 Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
 
 
 
 
 When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP
 address.
 


port
Integer port

 Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP
 address and port number.
 


playerData
String playerData

 Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted
 as needed for use in the game.
 








Class com.amazonaws.services.gamelift.model.PutScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can
 have only one scaling policy with the same name.
 


fleetId
String fleetId

 A unique identifier for a fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet
 cannot be in any of the following statuses: ERROR or DELETING.
 


scalingAdjustment
Integer scalingAdjustment

 Amount of adjustment to make, based on the scaling adjustment type.
 


scalingAdjustmentType
String scalingAdjustmentType

 The type of adjustment to make to a fleet's instance count (see FleetCapacity):
 
 
 
 
 ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count.
 Positive values scale up while negative values scale down.
 
 
 
 
 ExactCapacity -- set the instance count to the scaling adjustment value.
 
 
 
 
 PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read
 as a percentage. Positive values scale up while negative values scale down; for example, a value of "-10" scales
 the fleet down by 10%.
 
 
 


threshold
Double threshold

 Metric value used to trigger a scaling event.
 


comparisonOperator
String comparisonOperator

 Comparison operator to use when measuring the metric against the threshold value.
 


evaluationPeriods
Integer evaluationPeriods

 Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
 


metricName
String metricName

 Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed
 descriptions of fleet metrics, see Monitor Amazon
 GameLift with Amazon CloudWatch.
 
 
 
 
 ActivatingGameSessions -- Game sessions in the process of being created.
 
 
 
 
 ActiveGameSessions -- Game sessions that are currently running.
 
 
 
 
 ActiveInstances -- Fleet instances that are currently running at least one game session.
 
 
 
 
 AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current
 capacity.
 
 
 
 
 AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game
 sessions that are not currently accepting players. Reserved player slots are not included.
 
 
 
 
 CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are
 reserved for a player.
 
 
 
 
 IdleInstances -- Active instances that are currently hosting zero game sessions.
 
 
 
 
 PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could
 host simultaneously, given current capacity. Use this metric for a target-based scaling policy.
 
 
 
 
 PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game
 sessions.
 
 
 
 
 QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the
 top-priority destination.
 
 
 
 
 WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current
 fleet is the top-priority destination.
 
 
 


policyType
String policyType

 The type of scaling policy to create. For a target-based policy, set the parameter MetricName to
 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the
 following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods,
 ScalingAdjustmentType, and ScalingAdjustment.
 


targetConfiguration
TargetConfiguration targetConfiguration

 The settings for a target-based scaling policy.
 








Class com.amazonaws.services.gamelift.model.PutScalingPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
 








Class com.amazonaws.services.gamelift.model.RequestUploadCredentialsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


buildId
String buildId

 A unique identifier for a build to get credentials for. You can use either the build ID or ARN value.
 








Class com.amazonaws.services.gamelift.model.RequestUploadCredentialsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uploadCredentials
Credentials uploadCredentials

 AWS credentials required when uploading a game build to the storage location. These credentials have a limited
 lifespan and are valid only for the build they were issued for.
 


storageLocation
S3Location storageLocation

 Amazon S3 path and key, identifying where the game build files are stored.
 








Class com.amazonaws.services.gamelift.model.ResolveAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


aliasId
String aliasId

 The unique identifier of the alias that you want to retrieve a fleet ID for. You can use either the alias ID or
 ARN value.
 








Class com.amazonaws.services.gamelift.model.ResolveAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fleetId
String fleetId

 The fleet identifier that the alias is pointing to.
 


fleetArn
String fleetArn

 The Amazon Resource Name (ARN) associated with the
 GameLift fleet resource that this alias points to.
 








Class com.amazonaws.services.gamelift.model.ResourceCreationLimitPolicy extends Object implements Serializable


Serialized Fields


newGameSessionsPerCreator
Integer newGameSessionsPerCreator

 The maximum number of game sessions that an individual can create during the policy period.
 


policyPeriodInMinutes
Integer policyPeriodInMinutes

 The time span used in evaluating the resource creation limit policy.
 








Class com.amazonaws.services.gamelift.model.RoutingStrategy extends Object implements Serializable


Serialized Fields


type
String type

 The type of routing strategy for the alias.
 
 
 Possible routing types include the following:
 
 
 
 
 SIMPLE - The alias resolves to one specific fleet. Use this type when routing to active fleets.
 
 
 
 
 TERMINAL - The alias does not resolve to a fleet but instead can be used to display a message to the user.
 A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
 
 
 


fleetId
String fleetId

 The unique identifier for a fleet that the alias points to. This value is the fleet ID, not the fleet ARN.
 


message
String message

 The message text to be used with a terminal routing strategy.
 








Class com.amazonaws.services.gamelift.model.RuntimeConfiguration extends Object implements Serializable


Serialized Fields


serverProcesses
List<E> serverProcesses

 A collection of server process configurations that describe which server processes to run on each instance in a
 fleet.
 


maxConcurrentGameSessionActivations
Integer maxConcurrentGameSessionActivations

 The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously.
 This setting limits the amount of instance resources that can be used for new game activations at any one time.
 


gameSessionActivationTimeoutSeconds
Integer gameSessionActivationTimeoutSeconds

 The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the
 game session is not active before the timeout, activation is terminated and the game session status is changed to
 TERMINATED.
 








Class com.amazonaws.services.gamelift.model.S3Location extends Object implements Serializable


Serialized Fields


bucket
String bucket

 An Amazon S3 bucket identifier. This is the name of the S3 bucket.
 


key
String key

 The name of the zip file that contains the build files or script files.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN)
 for an IAM role that allows Amazon GameLift to access the S3 bucket.
 


objectVersion
String objectVersion

 The version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information
 when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the
 file. If not set, the latest version of the file is retrieved.
 








Class com.amazonaws.services.gamelift.model.ScalingPolicy extends Object implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet that is associated with this scaling policy.
 


name
String name

 A descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
 


status
String status

 Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE
 status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a
 fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
 
 
 
 
 ACTIVE -- The scaling policy can be used for auto-scaling a fleet.
 
 
 
 
 UPDATE_REQUESTED -- A request to update the scaling policy has been received.
 
 
 
 
 UPDATING -- A change is being made to the scaling policy.
 
 
 
 
 DELETE_REQUESTED -- A request to delete the scaling policy has been received.
 
 
 
 
 DELETING -- The scaling policy is being deleted.
 
 
 
 
 DELETED -- The scaling policy has been deleted.
 
 
 
 
 ERROR -- An error occurred in creating the policy. It should be removed and recreated.
 
 
 


scalingAdjustment
Integer scalingAdjustment

 Amount of adjustment to make, based on the scaling adjustment type.
 


scalingAdjustmentType
String scalingAdjustmentType

 The type of adjustment to make to a fleet's instance count (see FleetCapacity):
 
 
 
 
 ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count.
 Positive values scale up while negative values scale down.
 
 
 
 
 ExactCapacity -- set the instance count to the scaling adjustment value.
 
 
 
 
 PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read
 as a percentage. Positive values scale up while negative values scale down.
 
 
 


comparisonOperator
String comparisonOperator

 Comparison operator to use when measuring a metric against the threshold value.
 


threshold
Double threshold

 Metric value used to trigger a scaling event.
 


evaluationPeriods
Integer evaluationPeriods

 Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
 


metricName
String metricName

 Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed
 descriptions of fleet metrics, see Monitor Amazon
 GameLift with Amazon CloudWatch.
 
 
 
 
 ActivatingGameSessions -- Game sessions in the process of being created.
 
 
 
 
 ActiveGameSessions -- Game sessions that are currently running.
 
 
 
 
 ActiveInstances -- Fleet instances that are currently running at least one game session.
 
 
 
 
 AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current
 capacity.
 
 
 
 
 AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game
 sessions that are not currently accepting players. Reserved player slots are not included.
 
 
 
 
 CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are
 reserved for a player.
 
 
 
 
 IdleInstances -- Active instances that are currently hosting zero game sessions.
 
 
 
 
 PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could
 host simultaneously, given current capacity. Use this metric for a target-based scaling policy.
 
 
 
 
 PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game
 sessions.
 
 
 
 
 QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the
 top-priority destination.
 
 
 
 
 WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current
 fleet is the top-priority destination.
 
 
 


policyType
String policyType

 The type of scaling policy to create. For a target-based policy, set the parameter MetricName to
 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the
 following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods,
 ScalingAdjustmentType, and ScalingAdjustment.
 


targetConfiguration
TargetConfiguration targetConfiguration

 The settings for a target-based scaling policy.
 








Class com.amazonaws.services.gamelift.model.Script extends Object implements Serializable


Serialized Fields


scriptId
String scriptId

 A unique identifier for a Realtime script
 


scriptArn
String scriptArn

 Amazon Resource Name (ARN) that is assigned to a
 GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script
 ARN, the resource ID matches the ScriptId value.
 


name
String name

 A descriptive label that is associated with a script. Script names do not need to be unique.
 


version
String version

 The version that is associated with a build or script. Version strings do not need to be unique.
 


sizeOnDisk
Long sizeOnDisk

 The file size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location,
 this value remains at "0".
 


creationTime
Date creationTime

 A time stamp indicating when this data object was created. The format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 


storageLocation
S3Location storageLocation








Class com.amazonaws.services.gamelift.model.SearchGameSessionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to search for active game sessions. You can use either the fleet ID or ARN value.
 Each request must reference either a fleet ID or alias ID, but not both.
 


aliasId
String aliasId

 A unique identifier for an alias associated with the fleet to search for active game sessions. You can use either
 the alias ID or ARN value. Each request must reference either a fleet ID or alias ID, but not both.
 


filterExpression
String filterExpression

 String containing the search criteria for the session search. If no filter expression is included, the request
 returns results for all game sessions in the fleet that are in ACTIVE status.
 
 
 A filter expression can contain one or multiple conditions. Each condition consists of the following:
 
 
 
 
 Operand -- Name of a game session attribute. Valid values are gameSessionName,
 gameSessionId, gameSessionProperties, maximumSessions,
 creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
 
 
 
 
 Comparator -- Valid comparators are: =, <>, <,
 >, <=, >=.
 
 
 
 
 Value -- Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending
 on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must
 be escaped. Boolean and string values can only be used with the comparators = and
 <>. For example, the following filter expression searches on gameSessionName: "
 FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game 1'".
 
 
 
 
 To chain multiple conditions in a single expression, use the logical keywords AND, OR,
 and NOT and parentheses as needed. For example: x AND y AND NOT z,
 NOT (x OR y).
 
 
 Session search evaluates conditions from left to right using the following precedence rules:
 
 
 
 
 =, <>, <, >, <=,
 >=
 
 
 
 
 Parentheses
 
 
 
 
 NOT
 
 
 
 
 AND
 
 
 
 
 OR
 
 
 
 
 For example, this filter expression retrieves game sessions hosting at least ten players that have an open player
 slot: "maximumSessions>=10 AND hasAvailablePlayerSessions=true".
 


sortExpression
String sortExpression

 Instructions on how to sort the search results. If no sort expression is included, the request returns results in
 random order. A sort expression consists of the following elements:
 
 
 
 
 Operand -- Name of a game session attribute. Valid values are gameSessionName,
 gameSessionId, gameSessionProperties, maximumSessions,
 creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.
 
 
 
 
 Order -- Valid sort orders are ASC (ascending) and DESC (descending).
 
 
 
 
 For example, this sort expression returns the oldest active sessions first:
 "SortExpression": "creationTimeMillis ASC". Results with a null value for the sort operand are
 returned at the end of the list.
 


limit
Integer limit

 The maximum number of results to return. Use this parameter with NextToken to get results as a set
 of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher
 than 20.
 


nextToken
String nextToken

 Token that indicates the start of the next sequential page of results. Use the token that is returned with a
 previous call to this action. To start at the beginning of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.SearchGameSessionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gameSessions
List<E> gameSessions

 A collection of objects containing game session properties for each session matching the request.
 


nextToken
String nextToken

 Token that indicates 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.
 








Class com.amazonaws.services.gamelift.model.ServerProcess extends Object implements Serializable


Serialized Fields


launchPath
String launchPath

 The location of the server executable in a custom game build or the name of the Realtime script file that
 contains the Init() function. Game builds and Realtime scripts are installed on instances at the
 root:
 
 
 
 
 Windows (for custom game builds only): C:\game. Example: "C:\game\MyGame\server.exe"
 
 
 
 
 Linux: /local/game. Examples: "/local/game/MyGame/server.exe" or "
 /local/game/MyRealtimeScript.js"
 
 
 


parameters
String parameters

 An optional list of parameters to pass to the server executable or Realtime script on launch.
 


concurrentExecutions
Integer concurrentExecutions

 The number of server processes that use this configuration to run concurrently on an instance.
 








Class com.amazonaws.services.gamelift.model.StartFleetActionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to start actions on. You can use either the fleet ID or ARN value.
 


actions
List<E> actions

 List of actions to restart on the fleet.
 








Class com.amazonaws.services.gamelift.model.StartFleetActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.StartGameSessionPlacementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


placementId
String placementId

 A unique identifier to assign to the new game session placement. This value is developer-defined. The value must
 be unique across all Regions and cannot be reused unless you are resubmitting a canceled or timed-out placement
 request.
 


gameSessionQueueName
String gameSessionQueueName

 Name of the queue to use to place the new game session. You can use either the qieue name or ARN value.
 


gameProperties
List<E> gameProperties

 Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game
 server process in the GameSession object with a request to start a new game session (see Start a Game Session).
 


maximumPlayerSessionCount
Integer maximumPlayerSessionCount

 The maximum number of players that can be connected simultaneously to the game session.
 


gameSessionName
String gameSessionName

 A descriptive label that is associated with a game session. Session names do not need to be unique.
 


playerLatencies
List<E> playerLatencies

 Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when
 connected to AWS Regions. This information is used to try to place the new game session where it can offer the
 best possible gameplay experience for the players.
 


desiredPlayerSessions
List<E> desiredPlayerSessions

 Set of information on each player to create a player session for.
 


gameSessionData
String gameSessionData

 Set of custom game session properties, formatted as a single string value. This data is passed to a game server
 process in the GameSession object with a request to start a new game session (see Start a Game Session).
 








Class com.amazonaws.services.gamelift.model.StartGameSessionPlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gameSessionPlacement
GameSessionPlacement gameSessionPlacement

 Object that describes the newly created game session placement. This object includes all the information provided
 in the request, as well as start/end time stamps and placement status.
 








Class com.amazonaws.services.gamelift.model.StartMatchBackfillRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ticketId
String ticketId

 A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate
 one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match
 results.
 


configurationName
String configurationName

 Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN
 of the matchmaker that was used with the original game session is listed in the GameSession object,
 MatchmakerData property.
 


gameSessionArn
String gameSessionArn

 Amazon Resource Name (ARN) that is assigned to a
 game session and uniquely identifies it. This is the same as the game session ID.
 


players
List<E> players

 Match information on all players that are currently assigned to the game session. This information is used by the
 matchmaker to find new players and add them to the existing game.
 
 
 
 
 PlayerID, PlayerAttributes, Team -\\- This information is maintained in the GameSession object,
 MatchmakerData property, for all players who are currently assigned to the game session. The
 matchmaker data is in JSON syntax, formatted as a string. For more details, see  Match
 Data.
 
 
 
 
 LatencyInMs -\\- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region
 that the game session is currently in. Do not include latency values for any other Region.
 
 
 








Class com.amazonaws.services.gamelift.model.StartMatchBackfillResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


matchmakingTicket
MatchmakingTicket matchmakingTicket

 Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket
 status, and match results as generated during the matchmaking process.
 








Class com.amazonaws.services.gamelift.model.StartMatchmakingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ticketId
String ticketId

 A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate
 one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.
 


configurationName
String configurationName

 Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same
 Region as this request. You can use either the configuration name or ARN value.
 


players
List<E> players

 Information on each player to be matched. This information must include a player ID, and may contain player
 attributes and latency data to be used in the matchmaking process. After a successful match, Player
 objects contain the name of the team the player is assigned to.
 








Class com.amazonaws.services.gamelift.model.StartMatchmakingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


matchmakingTicket
MatchmakingTicket matchmakingTicket

 Ticket representing the matchmaking request. This object include the information included in the request, ticket
 status, and match results as generated during the matchmaking process.
 








Class com.amazonaws.services.gamelift.model.StopFleetActionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to stop actions on. You can use either the fleet ID or ARN value.
 


actions
List<E> actions

 List of actions to suspend on the fleet.
 








Class com.amazonaws.services.gamelift.model.StopFleetActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.StopGameSessionPlacementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


placementId
String placementId

 A unique identifier for a game session placement to cancel.
 








Class com.amazonaws.services.gamelift.model.StopGameSessionPlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gameSessionPlacement
GameSessionPlacement gameSessionPlacement

 Object that describes the canceled game session placement, with CANCELLED status and an end time
 stamp.
 








Class com.amazonaws.services.gamelift.model.StopMatchmakingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ticketId
String ticketId

 A unique identifier for a matchmaking ticket.
 








Class com.amazonaws.services.gamelift.model.StopMatchmakingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key for a developer-defined key:value pair for tagging an AWS resource.
 


value
String value

 The value for a developer-defined key:value pair for tagging an AWS resource.
 








Class com.amazonaws.services.gamelift.model.TaggingFailedException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN)
 that is assigned to and uniquely identifies the GameLift resource that you want to assign tags to. GameLift
 resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or
 Describe action for the resource type.
 


tags
List<E> tags

 A list of one or more tags to assign to the specified GameLift resource. Tags are developer-defined and
 structured as key-value pairs. The maximum tag limit may be lower than stated. See  Tagging AWS Resources for actual
 tagging limits.
 








Class com.amazonaws.services.gamelift.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.TargetConfiguration extends Object implements Serializable


Serialized Fields


targetValue
Double targetValue

 Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the
 scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value
 should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new
 game sessions).
 








Class com.amazonaws.services.gamelift.model.TerminalRoutingStrategyException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.UnauthorizedException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.UnsupportedRegionException extends AmazonGameLiftException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN)
 that is assigned to and uniquely identifies the GameLift resource that you want to remove tags from. GameLift
 resource ARNs are included in the data object for the resource, which can be retrieved by calling a List or
 Describe action for the resource type.
 


tagKeys
List<E> tagKeys

 A list of one or more tags to remove from the specified GameLift resource. Tags are developer-defined and
 structured as key-value pairs.
 








Class com.amazonaws.services.gamelift.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.gamelift.model.UpdateAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


aliasId
String aliasId

 A unique identifier for the alias that you want to update. You can use either the alias ID or ARN value.
 


name
String name

 A descriptive label that is associated with an alias. Alias names do not need to be unique.
 


description
String description

 A human-readable description of the alias.
 


routingStrategy
RoutingStrategy routingStrategy

 The routing configuration, including routing type and fleet target, for the alias.
 








Class com.amazonaws.services.gamelift.model.UpdateAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


alias
Alias alias

 The updated alias resource.
 








Class com.amazonaws.services.gamelift.model.UpdateBuildRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


buildId
String buildId

 A unique identifier for a build to update. You can use either the build ID or ARN value.
 


name
String name

 A descriptive label that is associated with a build. Build names do not need to be unique.
 


version
String version

 Version information that is associated with a build or script. Version strings do not need to be unique.
 








Class com.amazonaws.services.gamelift.model.UpdateBuildResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


build
Build build

 The updated build record.
 








Class com.amazonaws.services.gamelift.model.UpdateFleetAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to update attribute metadata for. You can use either the fleet ID or ARN value.
 


name
String name

 A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
 


description
String description

 Human-readable description of a fleet.
 


newGameSessionProtectionPolicy
String newGameSessionProtectionPolicy

 Game session protection policy to apply to all new instances created in this fleet. Instances that already exist
 are not 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.
 
 
 


resourceCreationLimitPolicy
ResourceCreationLimitPolicy resourceCreationLimitPolicy

 Policy that limits the number of game sessions an individual player can create over a span of time.
 


metricGroups
List<E> metricGroups

 Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate
 metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name
 to create a new metric group. A fleet can only be included in one metric group at a time.
 








Class com.amazonaws.services.gamelift.model.UpdateFleetAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet that was updated. Use either the fleet ID or ARN value.
 








Class com.amazonaws.services.gamelift.model.UpdateFleetCapacityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to update capacity for. You can use either the fleet ID or ARN value.
 


desiredInstances
Integer desiredInstances

 Number of EC2 instances you want this fleet to host.
 


minSize
Integer minSize

 The minimum value allowed for the fleet's instance count. Default if not set is 0.
 


maxSize
Integer maxSize

 The maximum value allowed for the fleet's instance count. Default if not set is 1.
 








Class com.amazonaws.services.gamelift.model.UpdateFleetCapacityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet that was updated.
 








Class com.amazonaws.services.gamelift.model.UpdateFleetPortSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to update port settings for. You can use either the fleet ID or ARN value.
 


inboundPermissionAuthorizations
List<E> inboundPermissionAuthorizations

 A collection of port settings to be added to the fleet record.
 


inboundPermissionRevocations
List<E> inboundPermissionRevocations

 A collection of port settings to be removed from the fleet record.
 








Class com.amazonaws.services.gamelift.model.UpdateFleetPortSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet that was updated.
 








Class com.amazonaws.services.gamelift.model.UpdateGameSessionQueueRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
 You can use either the queue ID or ARN value.
 


timeoutInSeconds
Integer timeoutInSeconds

 The maximum time, in seconds, that a new game session placement request remains in the queue. When a request
 exceeds this time, the game session placement changes to a TIMED_OUT status.
 


playerLatencyPolicies
List<E> playerLatencyPolicies

 A collection of latency policies to apply when processing game sessions placement requests with player latency
 information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest
 latency values. With just one policy, the policy is enforced at the start of the game session placement for the
 duration period. With multiple policies, each policy is enforced consecutively for its duration period. For
 example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the
 remainder of the placement. When updating policies, provide a complete collection of policies.
 


destinations
List<E> destinations

 A list of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified
 by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. When updating
 this list, provide a complete list of destinations.
 








Class com.amazonaws.services.gamelift.model.UpdateGameSessionQueueResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gameSessionQueue
GameSessionQueue gameSessionQueue

 An object that describes the newly updated game session queue.
 








Class com.amazonaws.services.gamelift.model.UpdateGameSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


gameSessionId
String gameSessionId

 A unique identifier for the game session to update.
 


maximumPlayerSessionCount
Integer maximumPlayerSessionCount

 The maximum number of players that can be connected simultaneously to the game session.
 


name
String name

 A descriptive label that is associated with a game session. Session names do not need to be unique.
 


playerSessionCreationPolicy
String playerSessionCreationPolicy

 Policy determining whether or not the game session accepts new players.
 


protectionPolicy
String protectionPolicy

 Game session protection policy to apply to this game session only.
 
 
 
 
 NoProtection -- The game session can be terminated during a scale-down event.
 
 
 
 
 FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during
 a scale-down event.
 
 
 








Class com.amazonaws.services.gamelift.model.UpdateGameSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


gameSession
GameSession gameSession

 The updated game session metadata.
 








Class com.amazonaws.services.gamelift.model.UpdateMatchmakingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A unique identifier for a matchmaking configuration to update. You can use either the configuration name or ARN
 value.
 


description
String description

 A descriptive label that is associated with matchmaking configuration.
 


gameSessionQueueArns
List<E> gameSessionQueueArns

 Amazon Resource Name (ARN) that is assigned to a
 GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. These queues
 are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can
 be located in any Region.
 


requestTimeoutSeconds
Integer requestTimeoutSeconds

 The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests
 that fail due to timing out can be resubmitted as needed.
 


acceptanceTimeoutSeconds
Integer acceptanceTimeoutSeconds

 The length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match
 or fails to accept before the timeout, the ticket continues to look for an acceptable match.
 


acceptanceRequired
Boolean acceptanceRequired

 A flag that indicates whether a match that was created with this configuration must be accepted by the matched
 players. To require acceptance, set to TRUE.
 


ruleSetName
String ruleSetName

 A unique identifier for a matchmaking rule set to use with this configuration. You can use either the rule set
 name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.
 


notificationTarget
String notificationTarget

 An SNS topic ARN that is set up to receive matchmaking notifications. See  Setting up
 Notifications for Matchmaking for more information.
 


additionalPlayerCount
Integer additionalPlayerCount

 The number of player slots in a match to keep open for future players. For example, assume that the
 configuration's rule set specifies a match for a single 12-person team. If the additional player count is set to
 2, only 10 players are initially selected for the match.
 


customEventData
String customEventData

 Information to add to all events related to the matchmaking configuration.
 


gameProperties
List<E> gameProperties

 A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a
 game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a
 successful match.
 


gameSessionData
String gameSessionData

 A set of custom game session properties, formatted as a single string value. This data is passed to a game server
 process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a
 successful match.
 


backfillMode
String backfillMode

 The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL
 when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC
 to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots.
 Learn more about manual and automatic backfill in Backfill Existing Games
 with FlexMatch.
 








Class com.amazonaws.services.gamelift.model.UpdateMatchmakingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configuration
MatchmakingConfiguration configuration

 The updated matchmaking configuration.
 








Class com.amazonaws.services.gamelift.model.UpdateRuntimeConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet to update runtime configuration for. You can use either the fleet ID or ARN
 value.
 


runtimeConfiguration
RuntimeConfiguration runtimeConfiguration

 Instructions for launching server processes on each instance in the fleet. Server processes run either a custom
 game build executable or a Realtime Servers script. The runtime configuration lists the types of server processes
 to run on an instance and includes the following configuration settings: the server executable or launch script
 file, launch parameters, and the number of processes to run concurrently on each instance. A CreateFleet request
 must include a runtime configuration with at least one server process configuration.
 








Class com.amazonaws.services.gamelift.model.UpdateRuntimeConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


runtimeConfiguration
RuntimeConfiguration runtimeConfiguration

 The runtime configuration currently in force. If the update was successful, this object matches the one in the
 request.
 








Class com.amazonaws.services.gamelift.model.UpdateScriptRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


scriptId
String scriptId

 A unique identifier for a Realtime script to update. You can use either the script ID or ARN value.
 


name
String name

 A descriptive label that is associated with a script. Script names do not need to be unique.
 


version
String version

 The version that is associated with a build or script. Version strings do not need to be unique.
 


storageLocation
S3Location storageLocation

 The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage
 location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon
 GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to
 create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3
 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.
 


zipFile
ByteBuffer zipFile

 A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or
 multiple files. Maximum size of a zip file is 5 MB.
 
 
 When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended
 with the string "fileb://" to indicate that the file data is a binary object. For example:
 --zip-file fileb://myRealtimeScript.zip.
 








Class com.amazonaws.services.gamelift.model.UpdateScriptResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


script
Script script

 The newly created script record with a unique script ID. The new script's storage location reflects an Amazon S3
 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the
 information that was provided in the CreateScript request; (2) If the script file was uploaded from a
 local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service.
 








Class com.amazonaws.services.gamelift.model.ValidateMatchmakingRuleSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleSetBody
String ruleSetBody

 A collection of matchmaking rules to validate, formatted as a JSON string.
 








Class com.amazonaws.services.gamelift.model.ValidateMatchmakingRuleSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


valid
Boolean valid

 A response indicating whether the rule set is valid.
 








Class com.amazonaws.services.gamelift.model.VpcPeeringAuthorization extends Object implements Serializable


Serialized Fields


gameLiftAwsAccountId
String gameLiftAwsAccountId

 A unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your
 Account ID in the AWS Management Console under account settings.
 


peerVpcAwsAccountId
String peerVpcAwsAccountId



peerVpcId
String peerVpcId

 A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the
 same Region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC
 peering in VPC Peering with
 Amazon GameLift Fleets.
 


creationTime
Date creationTime

 Time stamp indicating when this authorization was issued. Format is a number expressed in Unix time as
 milliseconds (for example "1469498468.057").
 


expirationTime
Date expirationTime

 Time stamp indicating when this authorization expires (24 hours after issuance). Format is a number expressed in
 Unix time as milliseconds (for example "1469498468.057").
 








Class com.amazonaws.services.gamelift.model.VpcPeeringConnection extends Object implements Serializable


Serialized Fields


fleetId
String fleetId

 A unique identifier for a fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.
 


fleetArn
String fleetArn

 The Amazon Resource Name (ARN) associated with the
 GameLift fleet resource for this connection.
 


ipV4CidrBlock
String ipV4CidrBlock

 CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift VPC. The peered VPC also has
 an IPv4 CIDR block associated with it; these blocks cannot overlap or the peering connection cannot be created.
 


vpcPeeringConnectionId
String vpcPeeringConnectionId

 A unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering
 connection events, and is used when deleting a connection with DeleteVpcPeeringConnection.
 


status
VpcPeeringConnectionStatus status

 The status information about the connection. Status indicates if a connection is pending, successful, or failed.
 


peerVpcId
String peerVpcId

 A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the
 same Region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC
 peering in VPC Peering with
 Amazon GameLift Fleets.
 


gameLiftVpcId
String gameLiftVpcId

 A unique identifier for the VPC that contains the Amazon GameLift fleet for this connection. This VPC is managed
 by Amazon GameLift and does not appear in your AWS account.
 








Class com.amazonaws.services.gamelift.model.VpcPeeringConnectionStatus extends Object implements Serializable


Serialized Fields


code
String code

 Code indicating the status of a VPC peering connection.
 


message
String message

 Additional messaging associated with the connection status.
 








Package com.amazonaws.services.glacier.model




Class com.amazonaws.services.glacier.model.AbortMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


uploadId
String uploadId

 The upload ID of the multipart upload to delete.
 








Class com.amazonaws.services.glacier.model.AbortMultipartUploadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glacier.model.AbortVaultLockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID. This value must match the AWS account ID associated with
 the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '
 -' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials
 used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 








Class com.amazonaws.services.glacier.model.AbortVaultLockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glacier.model.AddTagsToVaultRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


tags
Map<K,V> tags

 The tags to add to the vault. Each tag is composed of a key and a value. The value can be an empty string.
 








Class com.amazonaws.services.glacier.model.AddTagsToVaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glacier.model.AmazonGlacierException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glacier.model.CompleteMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


uploadId
String uploadId

 The upload ID of the multipart upload.
 


archiveSize
String archiveSize

 The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual
 parts that you uploaded.
 


checksum
String checksum

 The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If
 the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as
 computed by Amazon S3 Glacier (Glacier), Glacier returns an error and the request fails.
 








Class com.amazonaws.services.glacier.model.CompleteMultipartUploadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


location
String location

 The relative URI path of the newly added archive resource.
 


checksum
String checksum

 The checksum of the archive computed by Amazon S3 Glacier.
 


archiveId
String archiveId

 The ID of the archive. This value is also included as part of the location.
 








Class com.amazonaws.services.glacier.model.CompleteVaultLockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID. This value must match the AWS account ID associated with
 the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '
 -' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials
 used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


lockId
String lockId

 The lockId value is the lock ID obtained from a InitiateVaultLock request.
 








Class com.amazonaws.services.glacier.model.CompleteVaultLockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glacier.model.CreateVaultRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID. This value must match the AWS account ID associated with
 the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '
 -' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials
 used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 








Class com.amazonaws.services.glacier.model.CreateVaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


location
String location

 The URI of the vault that was created.
 








Class com.amazonaws.services.glacier.model.CSVInput extends Object implements Serializable


Serialized Fields


fileHeaderInfo
String fileHeaderInfo

 Describes the first line of input. Valid values are None, Ignore, and Use.
 


comments
String comments

 A single character used to indicate that a row should be ignored when the character is present at the start of
 that row.
 


quoteEscapeCharacter
String quoteEscapeCharacter

 A single character used for escaping the quotation-mark character inside an already escaped value.
 


recordDelimiter
String recordDelimiter

 A value used to separate individual records from each other.
 


fieldDelimiter
String fieldDelimiter

 A value used to separate individual fields from each other within a record.
 


quoteCharacter
String quoteCharacter

 A value used as an escape character where the field delimiter is part of the value.
 








Class com.amazonaws.services.glacier.model.CSVOutput extends Object implements Serializable


Serialized Fields


quoteFields
String quoteFields

 A value that indicates whether all output fields should be contained within quotation marks.
 


quoteEscapeCharacter
String quoteEscapeCharacter

 A single character used for escaping the quotation-mark character inside an already escaped value.
 


recordDelimiter
String recordDelimiter

 A value used to separate individual records from each other.
 


fieldDelimiter
String fieldDelimiter

 A value used to separate individual fields from each other within a record.
 


quoteCharacter
String quoteCharacter

 A value used as an escape character where the field delimiter is part of the value.
 








Class com.amazonaws.services.glacier.model.DataRetrievalPolicy extends Object implements Serializable


Serialized Fields


rules
List<E> rules

 The policy rule. Although this is a list type, currently there must be only one rule, which contains a Strategy
 field and optionally a BytesPerHour field.
 








Class com.amazonaws.services.glacier.model.DataRetrievalRule extends Object implements Serializable


Serialized Fields


strategy
String strategy

 The type of data retrieval policy to set.
 
 
 Valid values: BytesPerHour|FreeTier|None
 


bytesPerHour
Long bytesPerHour

 The maximum number of bytes that can be retrieved in an hour.
 
 
 This field is required only if the value of the Strategy field is BytesPerHour. Your PUT operation
 will be rejected if the Strategy field is not set to BytesPerHour and you set this field.
 








Class com.amazonaws.services.glacier.model.DeleteArchiveRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


archiveId
String archiveId

 The ID of the archive to delete.
 








Class com.amazonaws.services.glacier.model.DeleteArchiveResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glacier.model.DeleteVaultAccessPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 








Class com.amazonaws.services.glacier.model.DeleteVaultAccessPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glacier.model.DeleteVaultNotificationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 








Class com.amazonaws.services.glacier.model.DeleteVaultNotificationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glacier.model.DeleteVaultRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 








Class com.amazonaws.services.glacier.model.DeleteVaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glacier.model.DescribeJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


jobId
String jobId

 The ID of the job to describe.
 








Class com.amazonaws.services.glacier.model.DescribeJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 An opaque string that identifies an Amazon S3 Glacier job.
 


jobDescription
String jobDescription

 The job description provided when initiating the job.
 


action
String action

 The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
 Select.
 


archiveId
String archiveId

 The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
 


vaultARN
String vaultARN

 The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
 


creationDate
String creationDate

 The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example
 "2012-03-20T17:03:43.221Z".
 


completed
Boolean completed

 The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
 


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.
 


archiveSizeInBytes
Long archiveSizeInBytes

 For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an
 inventory retrieval or select job, this value is null.
 


inventorySizeInBytes
Long inventorySizeInBytes

 For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an
 archive retrieval or select job, this value is null.
 


sNSTopic
String sNSTopic

 An Amazon SNS topic that receives notification.
 


completionDate
String completionDate

 The UTC time that the job request completed. While the job is in progress, the value is null.
 


sHA256TreeHash
String sHA256TreeHash

 For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.
 
 
 The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an
 archive specified a tree-hash aligned range, then this field returns a value.
 
 
 If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
 
 
 This field is null for the following:
 
 
 
 
 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, when the job status is
 InProgress
 
 
 
 
 
 
 Inventory jobs
 
 
 
 
 Select jobs
 
 
 


archiveSHA256TreeHash
String archiveSHA256TreeHash

 The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this
 field is null.
 


retrievalByteRange
String retrievalByteRange

 The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no
 range was specified in the archive retrieval, then the whole archive is retrieved. In this case,
 StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory
 retrieval or select jobs, this field is null.
 


tier
String tier

 The tier to use for a select or an archive retrieval. Valid values are Expedited,
 Standard, or Bulk. Standard is the default.
 


inventoryRetrievalParameters
InventoryRetrievalJobDescription inventoryRetrievalParameters

 Parameters used for range inventory retrieval.
 


jobOutputPath
String jobOutputPath

 Contains the job output location.
 


selectParameters
SelectParameters selectParameters

 Contains the parameters used for a select.
 


outputLocation
OutputLocation outputLocation

 Contains the location where the data from the select job is stored.
 








Class com.amazonaws.services.glacier.model.DescribeVaultOutput extends Object implements Serializable


Serialized Fields


vaultARN
String vaultARN

 The Amazon Resource Name (ARN) of the vault.
 


vaultName
String vaultName

 The name of the vault.
 


creationDate
String creationDate

 The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO
 8601 date format, for example 2012-03-20T17:03:43.221Z.
 


lastInventoryDate
String lastInventoryDate

 The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the last vault inventory. This value
 should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z.
 


numberOfArchives
Long numberOfArchives

 The number of archives in the vault as of the last inventory date. This field will return null if an
 inventory has not yet run on the vault, for example if you just created the vault.
 


sizeInBytes
Long sizeInBytes

 Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if
 an inventory has not yet run on the vault, for example if you just created the vault.
 








Class com.amazonaws.services.glacier.model.DescribeVaultRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 








Class com.amazonaws.services.glacier.model.DescribeVaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vaultARN
String vaultARN

 The Amazon Resource Name (ARN) of the vault.
 


vaultName
String vaultName

 The name of the vault.
 


creationDate
String creationDate

 The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO
 8601 date format, for example 2012-03-20T17:03:43.221Z.
 


lastInventoryDate
String lastInventoryDate

 The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the last vault inventory. This value
 should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z.
 


numberOfArchives
Long numberOfArchives

 The number of archives in the vault as of the last inventory date. This field will return null if an
 inventory has not yet run on the vault, for example if you just created the vault.
 


sizeInBytes
Long sizeInBytes

 Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if
 an inventory has not yet run on the vault, for example if you just created the vault.
 








Class com.amazonaws.services.glacier.model.Encryption extends Object implements Serializable


Serialized Fields


encryptionType
String encryptionType

 The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256
 or aws:kms.
 


kMSKeyId
String kMSKeyId

 The AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS fail
 if not made by using Secure Sockets Layer (SSL) or Signature Version 4.
 


kMSContext
String kMSContext

 Optional. If the encryption type is aws:kms, you can use this value to specify the encryption
 context for the job results.
 








Class com.amazonaws.services.glacier.model.GetDataRetrievalPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID. This value must match the AWS account ID associated with
 the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '
 -' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials
 used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.
 








Class com.amazonaws.services.glacier.model.GetDataRetrievalPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
DataRetrievalPolicy policy

 Contains the returned data retrieval policy in JSON format.
 








Class com.amazonaws.services.glacier.model.GetJobOutputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


jobId
String jobId

 The job ID whose data is downloaded.
 


range
String range

 The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes,
 specify the range as bytes=0-1048575. By default, this operation downloads the entire output.
 
 
 If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to
 download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want
 to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output
 requests. You use the following process to download the job output:
 
 
 
 
 Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was
 received.
 
 
 
 
 Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the
 payload on the client and compare it with the checksum you received in the response to ensure you received all
 the expected data.
 
 
 
 
 Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte
 range.
 
 
 
 
 After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree
 hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job
 information of the job that provided you the output. The response includes the checksum of the entire archive
 stored in Amazon S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded
 the entire archive content with no errors.
 
 
 








Class com.amazonaws.services.glacier.model.GetJobOutputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


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.
 
 
 


status
Integer status

 The HTTP response code for a job output request. The value depends on whether a range was specified in the
 request.
 


contentRange
String contentRange

 The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the
 range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.
 


acceptRanges
String acceptRanges

 Indicates the range units accepted. For more information, see RFC2616.
 


contentType
String contentType

 The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the
 Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the
 job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the
 Content-Type is application/json.
 


archiveDescription
String archiveDescription

 The description of an archive.
 








Class com.amazonaws.services.glacier.model.GetVaultAccessPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 








Class com.amazonaws.services.glacier.model.GetVaultAccessPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
VaultAccessPolicy policy

 Contains the returned vault access policy as a JSON string.
 








Class com.amazonaws.services.glacier.model.GetVaultLockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 








Class com.amazonaws.services.glacier.model.GetVaultLockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
String policy

 The vault lock policy as a JSON string, which uses "\" as an escape character.
 


state
String state

 The state of the vault lock. InProgress or Locked.
 


expirationDate
String expirationDate

 The UTC date and time at which the lock ID expires. This value can be null if the vault lock is in a
 Locked state.
 


creationDate
String creationDate

 The UTC date and time at which the vault lock was put into the InProgress state.
 








Class com.amazonaws.services.glacier.model.GetVaultNotificationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 








Class com.amazonaws.services.glacier.model.GetVaultNotificationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vaultNotificationConfig
VaultNotificationConfig vaultNotificationConfig

 Returns the notification configuration set on the vault.
 








Class com.amazonaws.services.glacier.model.GlacierJobDescription extends Object implements Serializable


Serialized Fields


jobId
String jobId

 An opaque string that identifies an Amazon S3 Glacier job.
 


jobDescription
String jobDescription

 The job description provided when initiating the job.
 


action
String action

 The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or
 Select.
 


archiveId
String archiveId

 The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.
 


vaultARN
String vaultARN

 The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.
 


creationDate
String creationDate

 The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example
 "2012-03-20T17:03:43.221Z".
 


completed
Boolean completed

 The job status. When a job is completed, you get the job's output using Get Job Output (GET output).
 


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.
 


archiveSizeInBytes
Long archiveSizeInBytes

 For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an
 inventory retrieval or select job, this value is null.
 


inventorySizeInBytes
Long inventorySizeInBytes

 For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an
 archive retrieval or select job, this value is null.
 


sNSTopic
String sNSTopic

 An Amazon SNS topic that receives notification.
 


completionDate
String completionDate

 The UTC time that the job request completed. While the job is in progress, the value is null.
 


sHA256TreeHash
String sHA256TreeHash

 For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.
 
 
 The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an
 archive specified a tree-hash aligned range, then this field returns a value.
 
 
 If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.
 
 
 This field is null for the following:
 
 
 
 
 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, when the job status is
 InProgress
 
 
 
 
 
 
 Inventory jobs
 
 
 
 
 Select jobs
 
 
 


archiveSHA256TreeHash
String archiveSHA256TreeHash

 The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this
 field is null.
 


retrievalByteRange
String retrievalByteRange

 The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no
 range was specified in the archive retrieval, then the whole archive is retrieved. In this case,
 StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory
 retrieval or select jobs, this field is null.
 


tier
String tier

 The tier to use for a select or an archive retrieval. Valid values are Expedited,
 Standard, or Bulk. Standard is the default.
 


inventoryRetrievalParameters
InventoryRetrievalJobDescription inventoryRetrievalParameters

 Parameters used for range inventory retrieval.
 


jobOutputPath
String jobOutputPath

 Contains the job output location.
 


selectParameters
SelectParameters selectParameters

 Contains the parameters used for a select.
 


outputLocation
OutputLocation outputLocation

 Contains the location where the data from the select job is stored.
 








Class com.amazonaws.services.glacier.model.Grant extends Object implements Serializable


Serialized Fields


grantee
Grantee grantee

 The grantee.
 


permission
String permission

 Specifies the permission given to the grantee.
 








Class com.amazonaws.services.glacier.model.Grantee extends Object implements Serializable


Serialized Fields


type
String type

 Type of grantee
 


displayName
String displayName

 Screen name of the grantee.
 


uRI
String uRI

 URI of the grantee group.
 


iD
String iD

 The canonical user ID of the grantee.
 


emailAddress
String emailAddress

 Email address of the grantee.
 








Class com.amazonaws.services.glacier.model.InitiateJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


jobParameters
JobParameters jobParameters

 Provides options for specifying job information.
 








Class com.amazonaws.services.glacier.model.InitiateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


location
String location

 The relative URI path of the job.
 


jobId
String jobId

 The ID of the job.
 


jobOutputPath
String jobOutputPath

 The path to the location of where the select results are stored.
 








Class com.amazonaws.services.glacier.model.InitiateMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


archiveDescription
String archiveDescription

 The archive description that you are uploading in parts.
 
 
 The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2
 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB
 (4096 MB).
 


partSize
String partSize

 The size of each part except the last, in bytes. The last part can be smaller than this part size.
 








Class com.amazonaws.services.glacier.model.InitiateMultipartUploadResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


location
String location

 The relative URI path of the multipart upload ID Amazon S3 Glacier created.
 


uploadId
String uploadId

 The ID of the multipart upload. This value is also included as part of the location.
 








Class com.amazonaws.services.glacier.model.InitiateVaultLockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID. This value must match the AWS account ID associated with
 the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '
 -' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials
 used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


policy
VaultLockPolicy policy

 The vault lock policy as a JSON string, which uses "\" as an escape character.
 








Class com.amazonaws.services.glacier.model.InitiateVaultLockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


lockId
String lockId

 The lock ID, which is used to complete the vault locking process.
 








Class com.amazonaws.services.glacier.model.InputSerialization extends Object implements Serializable


Serialized Fields


csv
CSVInput csv

 Describes the serialization of a CSV-encoded object.
 








Class com.amazonaws.services.glacier.model.InsufficientCapacityException extends AmazonGlacierException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type


code
String code








Class com.amazonaws.services.glacier.model.InvalidParameterValueException extends AmazonGlacierException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 Client
 


code
String code

 400 Bad Request
 








Class com.amazonaws.services.glacier.model.InventoryRetrievalJobDescription extends Object implements Serializable


Serialized Fields


format
String format

 The output format for the vault inventory list, which is set by the InitiateJob request when initiating a
 job to retrieve a vault inventory. Valid values are CSV and JSON.
 


startDate
String startDate

 The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes
 archives created on or after this date. This value should be a string in the ISO 8601 date format, for example
 2013-03-20T17:03:43Z.
 


endDate
String endDate

 The end of the date range in UTC for vault inventory retrieval that includes archives created before this date.
 This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
 


limit
String limit

 The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when
 initiating the job with the a InitiateJob request.
 


marker
String marker

 An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use
 the marker in a new InitiateJob request to obtain additional inventory items. If there are no more
 inventory items, this value is null. For more information, see  Range Inventory Retrieval.
 








Class com.amazonaws.services.glacier.model.InventoryRetrievalJobInput extends Object implements Serializable


Serialized Fields


startDate
String startDate

 The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this
 date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
 


endDate
String endDate

 The end of the date range in UTC for vault inventory retrieval that includes archives created before this date.
 This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.
 


limit
String limit

 Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are
 greater than or equal to 1.
 


marker
String marker

 An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use
 the marker in a new InitiateJob request to obtain additional inventory items. If there are no more
 inventory items, this value is null.
 








Class com.amazonaws.services.glacier.model.JobParameters extends Object implements Serializable


Serialized Fields


format
String format

 When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to
 specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the
 default format. Valid values are "CSV" and "JSON".
 


type
String type

 The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an
 inventory of a vault. Valid values are "select", "archive-retrieval" and "inventory-retrieval".
 


archiveId
String archiveId

 The ID of the archive that you want to retrieve. This field is required only if Type is set to
 select or archive-retrievalcode>. An error occurs if you specify this request
 parameter for an inventory retrieval job request.
 


description
String description

 The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable
 characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E
 hexadecimal.
 


sNSTopic
String sNSTopic

 The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output
 is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic
 must exist.
 


retrievalByteRange
String retrievalByteRange

 The byte range to retrieve for an archive retrieval. in the form "StartByteValue-EndByteValue" If
 not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned
 which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible
 by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is
 not megabyte aligned, this operation returns a 400 response.
 
 
 An error occurs if you specify this field for an inventory retrieval job request.
 


tier
String tier

 The tier to use for a select or an archive retrieval job. Valid values are Expedited,
 Standard, or Bulk. Standard is the default.
 


inventoryRetrievalParameters
InventoryRetrievalJobInput inventoryRetrievalParameters

 Input parameters used for range inventory retrieval.
 


selectParameters
SelectParameters selectParameters

 Contains the parameters that define a job.
 


outputLocation
OutputLocation outputLocation

 Contains information about the location where the select job results are stored.
 








Class com.amazonaws.services.glacier.model.LimitExceededException extends AmazonGlacierException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 Client
 


code
String code

 400 Bad Request
 








Class com.amazonaws.services.glacier.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


limit
String limit

 The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer
 than the specified limit, but the number of returned jobs never exceeds the limit.
 


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 only need to include the marker if you are continuing
 the pagination of results started in a previous List Jobs request.
 


statuscode
String statuscode

 The type of job status to return. You can specify the following values: InProgress,
 Succeeded, or Failed.
 


completed
String completed

 The state of the jobs to return. You can specify true or false.
 








Class com.amazonaws.services.glacier.model.ListJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobList
List<E> jobList

 A list of job objects. Each job object contains metadata describing the job.
 


marker
String marker

 An opaque string used for pagination that specifies the job at which the listing of jobs should begin. You get
 the marker value from a previous List Jobs response. You only need to include the marker if you are
 continuing the pagination of the results started in a previous List Jobs request.
 








Class com.amazonaws.services.glacier.model.ListMultipartUploadsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


limit
String limit

 Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List
 Uploads operation returns up to 50 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.
 








Class com.amazonaws.services.glacier.model.ListMultipartUploadsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uploadsList
List<E> uploadsList

 A list of in-progress multipart uploads.
 


marker
String marker

 An opaque string that represents where to continue pagination of the results. You use the marker in a new List
 Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is
 null.
 








Class com.amazonaws.services.glacier.model.ListPartsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


uploadId
String uploadId

 The upload ID of the multipart upload.
 


marker
String marker

 An opaque string used for pagination. This value specifies the part at which the listing of parts should begin.
 Get the marker value from the response of a previous List Parts response. You need only include the marker if you
 are continuing the pagination of results started in a previous List Parts request.
 


limit
String limit

 The maximum number of parts to be returned. The default limit is 50. The number of parts returned might be fewer
 than the specified limit, but the number of returned parts never exceeds the limit.
 








Class com.amazonaws.services.glacier.model.ListPartsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


multipartUploadId
String multipartUploadId

 The ID of the upload to which the parts are associated.
 


vaultARN
String vaultARN

 The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.
 


archiveDescription
String archiveDescription

 The description of the archive that was specified in the Initiate Multipart Upload request.
 


partSizeInBytes
Long partSizeInBytes

 The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request.
 


creationDate
String creationDate

 The UTC time at which the multipart upload was initiated.
 


parts
List<E> parts

 A list of the part sizes of the multipart upload. Each object in the array contains a RangeBytes and
 sha256-tree-hash name/value pair.
 


marker
String marker

 An opaque string that represents where to continue pagination of the results. You use the marker in a new List
 Parts request to obtain more jobs in the list. If there are no more parts, this value is null.
 








Class com.amazonaws.services.glacier.model.ListProvisionedCapacityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a
 single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
 to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID.
 








Class com.amazonaws.services.glacier.model.ListProvisionedCapacityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


provisionedCapacityList
List<E> provisionedCapacityList

 The response body contains the following JSON fields.
 








Class com.amazonaws.services.glacier.model.ListTagsForVaultRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 








Class com.amazonaws.services.glacier.model.ListTagsForVaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The tags attached to the vault. Each tag is composed of a key and a value.
 








Class com.amazonaws.services.glacier.model.ListVaultsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID. This value must match the AWS account ID associated with
 the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '
 -' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials
 used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.
 


marker
String marker

 A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
 


limit
String limit

 The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be
 fewer than the specified limit, but the number of returned vaults never exceeds the limit.
 








Class com.amazonaws.services.glacier.model.ListVaultsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


vaultList
List<E> vaultList

 List of vaults.
 


marker
String marker

 The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request
 to obtain more vaults in the list.
 








Class com.amazonaws.services.glacier.model.MissingParameterValueException extends AmazonGlacierException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 Client.
 


code
String code

 400 Bad Request
 








Class com.amazonaws.services.glacier.model.OutputLocation extends Object implements Serializable


Serialized Fields


s3
S3Location s3

 Describes an S3 location that will receive the results of the job request.
 








Class com.amazonaws.services.glacier.model.OutputSerialization extends Object implements Serializable


Serialized Fields


csv
CSVOutput csv

 Describes the serialization of CSV-encoded query results.
 








Class com.amazonaws.services.glacier.model.PartListElement extends Object implements Serializable


Serialized Fields


rangeInBytes
String rangeInBytes

 The byte range of a part, inclusive of the upper value of the range.
 


sHA256TreeHash
String sHA256TreeHash

 The SHA256 tree hash value that Amazon S3 Glacier calculated for the part. This field is never null.
 








Class com.amazonaws.services.glacier.model.PolicyEnforcedException extends AmazonGlacierException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 Client
 


code
String code

 PolicyEnforcedException
 








Class com.amazonaws.services.glacier.model.ProvisionedCapacityDescription extends Object implements Serializable


Serialized Fields


capacityId
String capacityId

 The ID that identifies the provisioned capacity unit.
 


startDate
String startDate

 The date that the provisioned capacity unit was purchased, in Universal Coordinated Time (UTC).
 


expirationDate
String expirationDate

 The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC).
 








Class com.amazonaws.services.glacier.model.PurchaseProvisionedCapacityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a
 single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used
 to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID.
 








Class com.amazonaws.services.glacier.model.PurchaseProvisionedCapacityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


capacityId
String capacityId

 The ID that identifies the provisioned capacity unit.
 








Class com.amazonaws.services.glacier.model.RemoveTagsFromVaultRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


tagKeys
List<E> tagKeys

 A list of tag keys. Each corresponding tag is removed from the vault.
 








Class com.amazonaws.services.glacier.model.RemoveTagsFromVaultResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glacier.model.RequestTimeoutException extends AmazonGlacierException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 Client
 


code
String code

 408 Request Timeout
 








Class com.amazonaws.services.glacier.model.ResourceNotFoundException extends AmazonGlacierException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 Client
 


code
String code

 404 Not Found
 








Class com.amazonaws.services.glacier.model.S3Location extends Object implements Serializable


Serialized Fields


bucketName
String bucketName

 The name of the Amazon S3 bucket where the job results are stored.
 


prefix
String prefix

 The prefix that is prepended to the results for this request.
 


encryption
Encryption encryption

 Contains information about the encryption used to store the job results in Amazon S3.
 


cannedACL
String cannedACL

 The canned access control list (ACL) to apply to the job results.
 


accessControlList
List<E> accessControlList

 A list of grants that control access to the staged results.
 


tagging
Map<K,V> tagging

 The tag-set that is applied to the job results.
 


userMetadata
Map<K,V> userMetadata

 A map of metadata to store with the job results in Amazon S3.
 


storageClass
String storageClass

 The storage class used to store the job results.
 








Class com.amazonaws.services.glacier.model.SelectParameters extends Object implements Serializable


Serialized Fields


inputSerialization
InputSerialization inputSerialization

 Describes the serialization format of the object.
 


expressionType
String expressionType

 The type of the provided expression, for example SQL.
 


expression
String expression

 The expression that is used to select the object.
 


outputSerialization
OutputSerialization outputSerialization

 Describes how the results of the select job are serialized.
 








Class com.amazonaws.services.glacier.model.ServiceUnavailableException extends AmazonGlacierException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 Server
 


code
String code

 500 Internal Server Error
 








Class com.amazonaws.services.glacier.model.SetDataRetrievalPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID. This value must match the AWS account ID associated with
 the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '
 -' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials
 used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.
 


policy
DataRetrievalPolicy policy

 The data retrieval policy in JSON format.
 








Class com.amazonaws.services.glacier.model.SetDataRetrievalPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glacier.model.SetVaultAccessPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


policy
VaultAccessPolicy policy

 The vault access policy as a JSON string.
 








Class com.amazonaws.services.glacier.model.SetVaultAccessPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glacier.model.SetVaultNotificationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


vaultNotificationConfig
VaultNotificationConfig vaultNotificationConfig

 Provides options for specifying notification configuration.
 








Class com.amazonaws.services.glacier.model.SetVaultNotificationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glacier.model.UploadArchiveRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


vaultName
String vaultName

 The name of the vault.
 


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


archiveDescription
String archiveDescription

 The optional description of the archive you are uploading.
 


checksum
String checksum

 The SHA256 tree hash of the data being uploaded.
 


body
InputStream body

 The data to upload.
 


contentLength
Long contentLength
The content length of the archive to upload.








Class com.amazonaws.services.glacier.model.UploadArchiveResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


location
String location

 The relative URI path of the newly added archive resource.
 


checksum
String checksum

 The checksum of the archive computed by Amazon S3 Glacier.
 


archiveId
String archiveId

 The ID of the archive. This value is also included as part of the location.
 








Class com.amazonaws.services.glacier.model.UploadListElement extends Object implements Serializable


Serialized Fields


multipartUploadId
String multipartUploadId

 The ID of a multipart upload.
 


vaultARN
String vaultARN

 The Amazon Resource Name (ARN) of the vault that contains the archive.
 


archiveDescription
String archiveDescription

 The description of the archive that was specified in the Initiate Multipart Upload request.
 


partSizeInBytes
Long partSizeInBytes

 The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in
 the upload except the last part, which may be smaller than this size.
 


creationDate
String creationDate

 The UTC time at which the multipart upload was initiated.
 








Class com.amazonaws.services.glacier.model.UploadMultipartPartRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The AccountId value is the AWS account ID of the account that owns the vault. You can either specify
 an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS
 account ID associated with the credentials used to sign the request. If you use an account ID, do not include any
 hyphens ('-') in the ID.
 


vaultName
String vaultName

 The name of the vault.
 


uploadId
String uploadId

 The upload ID of the multipart upload.
 


checksum
String checksum

 The SHA256 tree hash of the data being uploaded.
 


range
String range

 Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon S3 Glacier uses
 this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An
 example header is Content-Range:bytes 0-4194303/*.
 


body
InputStream body

 The data to upload.
 








Class com.amazonaws.services.glacier.model.UploadMultipartPartResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


checksum
String checksum

 The SHA256 tree hash that Amazon S3 Glacier computed for the uploaded part.
 








Class com.amazonaws.services.glacier.model.VaultAccessPolicy extends Object implements Serializable


Serialized Fields


policy
String policy

 The vault access policy.
 








Class com.amazonaws.services.glacier.model.VaultLockPolicy extends Object implements Serializable


Serialized Fields


policy
String policy

 The vault lock policy.
 








Class com.amazonaws.services.glacier.model.VaultNotificationConfig extends Object implements Serializable


Serialized Fields


sNSTopic
String sNSTopic

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


events
List<E> events

 A list of one or more events for which Amazon S3 Glacier will send a notification to the specified Amazon SNS
 topic.
 








Package com.amazonaws.services.globalaccelerator.model




Class com.amazonaws.services.globalaccelerator.model.Accelerator extends Object implements Serializable


Serialized Fields


acceleratorArn
String acceleratorArn

 The Amazon Resource Name (ARN) of the accelerator.
 


name
String name

 The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not
 begin or end with a hyphen.
 


ipAddressType
String ipAddressType

 The value for the address type must be IPv4.
 


enabled
Boolean enabled

 Indicates whether the accelerator is enabled. The value is true or false. The default value is true.
 
 
 If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.
 


ipSets
List<E> ipSets

 The static IP addresses that Global Accelerator associates with the accelerator.
 


dnsName
String dnsName

 The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP
 addresses.
 
 
 The naming convention for the DNS name is: a lower case letter a, followed by a 16-bit random hex string,
 followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.
 
 
 For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.
 


status
String status

 Describes the deployment status of the accelerator.
 


createdTime
Date createdTime

 The date and time that the accelerator was created.
 


lastModifiedTime
Date lastModifiedTime

 The date and time that the accelerator was last modified.
 








Class com.amazonaws.services.globalaccelerator.model.AcceleratorAttributes extends Object implements Serializable


Serialized Fields


flowLogsEnabled
Boolean flowLogsEnabled

 Indicates whether flow logs are enabled. The default value is false. If the value is true,
 FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
 
 
 For more information, see Flow
 Logs in the AWS Global Accelerator Developer Guide.
 


flowLogsS3Bucket
String flowLogsS3Bucket

 The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is
 true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission
 to write to the bucket.
 


flowLogsS3Prefix
String flowLogsS3Prefix

 The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
 FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the
 root of the bucket.
 








Class com.amazonaws.services.globalaccelerator.model.AcceleratorNotDisabledException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.AcceleratorNotFoundException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.AccessDeniedException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.AssociatedEndpointGroupFoundException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.AssociatedListenerFoundException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.AWSGlobalAcceleratorException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.CreateAcceleratorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of an accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric
 characters or hyphens (-), and must not begin or end with a hyphen.
 


ipAddressType
String ipAddressType

 The value for the address type must be IPv4.
 


enabled
Boolean enabled

 Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
 
 
 If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.
 


idempotencyToken
String idempotencyToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an
 accelerator.
 








Class com.amazonaws.services.globalaccelerator.model.CreateAcceleratorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accelerator
Accelerator accelerator

 The accelerator that is created by specifying a listener and the supported IP address types.
 








Class com.amazonaws.services.globalaccelerator.model.CreateEndpointGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener.
 


endpointGroupRegion
String endpointGroupRegion

 The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a
 specific Region.
 


endpointConfigurations
List<E> endpointConfigurations

 The list of endpoint objects.
 


trafficDialPercentage
Float trafficDialPercentage

 The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups
 for this listener.
 
 
 Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is
 applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
 
 
 The default value is 100.
 


healthCheckPort
Integer healthCheckPort

 The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group.
 The default port is the listener port that this endpoint group is associated with. If listener port is a list of
 ports, Global Accelerator uses the first port in the list.
 


healthCheckProtocol
String healthCheckProtocol

 The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint
 group. The default value is TCP.
 


healthCheckPath
String healthCheckPath

 If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The
 default value is slash (/).
 


healthCheckIntervalSeconds
Integer healthCheckIntervalSeconds

 The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
 


thresholdCount
Integer thresholdCount

 The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set
 an unhealthy endpoint to healthy. The default value is 3.
 


idempotencyToken
String idempotencyToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the
 request.
 








Class com.amazonaws.services.globalaccelerator.model.CreateEndpointGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpointGroup
EndpointGroup endpointGroup

 The information about the endpoint group that was created.
 








Class com.amazonaws.services.globalaccelerator.model.CreateListenerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


acceleratorArn
String acceleratorArn

 The Amazon Resource Name (ARN) of your accelerator.
 


portRanges
List<E> portRanges

 The list of port ranges to support for connections from clients to your accelerator.
 


protocol
String protocol

 The protocol for connections from clients to your accelerator.
 


clientAffinity
String clientAffinity

 Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,
 regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to
 always route each client to the same specific endpoint.
 
 
 AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection.
 If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP
 address, source port, destination IP address, destination port, and protocol—to select the hash value, and then
 chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global
 Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.
 
 
 If you want a given client to always be routed to the same endpoint, set client affinity to
 SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the
 "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.
 
 
 The default value is NONE.
 


idempotencyToken
String idempotencyToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the
 request.
 








Class com.amazonaws.services.globalaccelerator.model.CreateListenerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


listener
Listener listener

 The listener that you've created.
 








Class com.amazonaws.services.globalaccelerator.model.DeleteAcceleratorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


acceleratorArn
String acceleratorArn

 The Amazon Resource Name (ARN) of an accelerator.
 








Class com.amazonaws.services.globalaccelerator.model.DeleteAcceleratorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.globalaccelerator.model.DeleteEndpointGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointGroupArn
String endpointGroupArn

 The Amazon Resource Name (ARN) of the endpoint group to delete.
 








Class com.amazonaws.services.globalaccelerator.model.DeleteEndpointGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.globalaccelerator.model.DeleteListenerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener.
 








Class com.amazonaws.services.globalaccelerator.model.DeleteListenerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.globalaccelerator.model.DescribeAcceleratorAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


acceleratorArn
String acceleratorArn

 The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.
 








Class com.amazonaws.services.globalaccelerator.model.DescribeAcceleratorAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


acceleratorAttributes
AcceleratorAttributes acceleratorAttributes

 The attributes of the accelerator.
 








Class com.amazonaws.services.globalaccelerator.model.DescribeAcceleratorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


acceleratorArn
String acceleratorArn

 The Amazon Resource Name (ARN) of the accelerator to describe.
 








Class com.amazonaws.services.globalaccelerator.model.DescribeAcceleratorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accelerator
Accelerator accelerator

 The description of the accelerator.
 








Class com.amazonaws.services.globalaccelerator.model.DescribeEndpointGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointGroupArn
String endpointGroupArn

 The Amazon Resource Name (ARN) of the endpoint group to describe.
 








Class com.amazonaws.services.globalaccelerator.model.DescribeEndpointGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpointGroup
EndpointGroup endpointGroup

 The description of an endpoint group.
 








Class com.amazonaws.services.globalaccelerator.model.DescribeListenerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener to describe.
 








Class com.amazonaws.services.globalaccelerator.model.DescribeListenerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


listener
Listener listener

 The description of a listener.
 








Class com.amazonaws.services.globalaccelerator.model.EndpointConfiguration extends Object implements Serializable


Serialized Fields


endpointId
String endpointId

 An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the
 Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP
 address allocation ID.
 


weight
Integer weight

 The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator
 to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5,
 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is
 routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see
 Endpoint
 Weights in the AWS Global Accelerator Developer Guide.
 


clientIPPreservationEnabled
Boolean clientIPPreservationEnabled

 Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value
 is true or false. The default value is true for new accelerators.
 
 
 If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request
 header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
 
 
 For more information, see  Viewing
 Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
 








Class com.amazonaws.services.globalaccelerator.model.EndpointDescription extends Object implements Serializable


Serialized Fields


endpointId
String endpointId

 An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the
 Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP
 address allocation ID. An Application Load Balancer can be either internal or internet-facing.
 


weight
Integer weight

 The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator
 to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5,
 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is
 routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see
 Endpoint
 Weights in the AWS Global Accelerator Developer Guide.
 


healthState
String healthState

 The health status of the endpoint.
 


healthReason
String healthReason

 The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code
 is not provided.
 
 
 If the endpoint state is unhealthy, the reason code can be one of the following values:
 
 
 
 
 Timeout: The health check requests to the endpoint are timing out before returning a status.
 
 
 
 
 Failed: The health check failed, for example because the endpoint response was invalid (malformed).
 
 
 
 
 If the endpoint state is initial, the reason code can be one of the following values:
 
 
 
 
 ProvisioningInProgress: The endpoint is in the process of being provisioned.
 
 
 
 
 InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the
 endpoint that are required to determine its health status.
 
 
 


clientIPPreservationEnabled
Boolean clientIPPreservationEnabled

 Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value
 is true or false. The default value is true for new accelerators.
 
 
 If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request
 header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.
 
 
 For more information, see  Viewing
 Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.
 








Class com.amazonaws.services.globalaccelerator.model.EndpointGroup extends Object implements Serializable


Serialized Fields


endpointGroupArn
String endpointGroupArn

 The Amazon Resource Name (ARN) of the endpoint group.
 


endpointGroupRegion
String endpointGroupRegion

 The AWS Region that this endpoint group belongs.
 


endpointDescriptions
List<E> endpointDescriptions

 The list of endpoint objects.
 


trafficDialPercentage
Float trafficDialPercentage

 The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups
 for this listener.
 
 
 Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is
 applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
 
 
 The default value is 100.
 


healthCheckPort
Integer healthCheckPort

 The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.
 
 
 The default port is the port for the listener that this endpoint group is associated with. If the listener port
 is a list, Global Accelerator uses the first specified port in the list of ports.
 


healthCheckProtocol
String healthCheckProtocol

 The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint
 group. The default value is TCP.
 


healthCheckPath
String healthCheckPath

 If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the
 destination on the endpoints for health checks. The default is slash (/).
 


healthCheckIntervalSeconds
Integer healthCheckIntervalSeconds

 The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
 


thresholdCount
Integer thresholdCount

 The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set
 an unhealthy endpoint to healthy. The default value is 3.
 








Class com.amazonaws.services.globalaccelerator.model.EndpointGroupAlreadyExistsException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.EndpointGroupNotFoundException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.InternalServiceErrorException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.InvalidArgumentException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.InvalidNextTokenException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.InvalidPortRangeException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.IpSet extends Object implements Serializable


Serialized Fields


ipFamily
String ipFamily

 The types of IP addresses included in this IP set.
 


ipAddresses
List<E> ipAddresses

 The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.
 








Class com.amazonaws.services.globalaccelerator.model.LimitExceededException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.ListAcceleratorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The number of Global Accelerator objects that you want to return with this call. The default value is 10.
 


nextToken
String nextToken

 The token for the next set of results. You receive this token from a previous call.
 








Class com.amazonaws.services.globalaccelerator.model.ListAcceleratorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accelerators
List<E> accelerators

 The list of accelerators for a customer account.
 


nextToken
String nextToken

 The token for the next set of results. You receive this token from a previous call.
 








Class com.amazonaws.services.globalaccelerator.model.ListEndpointGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener.
 


maxResults
Integer maxResults

 The number of endpoint group objects that you want to return with this call. The default value is 10.
 


nextToken
String nextToken

 The token for the next set of results. You receive this token from a previous call.
 








Class com.amazonaws.services.globalaccelerator.model.ListEndpointGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpointGroups
List<E> endpointGroups

 The list of the endpoint groups associated with a listener.
 


nextToken
String nextToken

 The token for the next set of results. You receive this token from a previous call.
 








Class com.amazonaws.services.globalaccelerator.model.Listener extends Object implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener.
 


portRanges
List<E> portRanges

 The list of port ranges for the connections from clients to the accelerator.
 


protocol
String protocol

 The protocol for the connections from clients to the accelerator.
 


clientAffinity
String clientAffinity

 Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,
 regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to
 always route each client to the same specific endpoint.
 
 
 AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection.
 If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP
 address, source port, destination IP address, destination port, and protocol—to select the hash value, and then
 chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global
 Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.
 
 
 If you want a given client to always be routed to the same endpoint, set client affinity to
 SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the
 "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.
 
 
 The default value is NONE.
 








Class com.amazonaws.services.globalaccelerator.model.ListenerNotFoundException extends AWSGlobalAcceleratorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.globalaccelerator.model.ListListenersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


acceleratorArn
String acceleratorArn

 The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.
 


maxResults
Integer maxResults

 The number of listener objects that you want to return with this call. The default value is 10.
 


nextToken
String nextToken

 The token for the next set of results. You receive this token from a previous call.
 








Class com.amazonaws.services.globalaccelerator.model.ListListenersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


listeners
List<E> listeners

 The list of listeners for an accelerator.
 


nextToken
String nextToken

 The token for the next set of results. You receive this token from a previous call.
 








Class com.amazonaws.services.globalaccelerator.model.PortRange extends Object implements Serializable


Serialized Fields


fromPort
Integer fromPort

 The first port in the range of ports, inclusive.
 


toPort
Integer toPort

 The last port in the range of ports, inclusive.
 








Class com.amazonaws.services.globalaccelerator.model.UpdateAcceleratorAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


acceleratorArn
String acceleratorArn

 The Amazon Resource Name (ARN) of the accelerator that you want to update.
 


flowLogsEnabled
Boolean flowLogsEnabled

 Update whether flow logs are enabled. The default value is false. If the value is true,
 FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.
 
 
 For more information, see Flow
 Logs in the AWS Global Accelerator Developer Guide.
 


flowLogsS3Bucket
String flowLogsS3Bucket

 The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is
 true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission
 to write to the bucket.
 


flowLogsS3Prefix
String flowLogsS3Prefix

 Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if
 FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the
 root of the bucket.
 








Class com.amazonaws.services.globalaccelerator.model.UpdateAcceleratorAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


acceleratorAttributes
AcceleratorAttributes acceleratorAttributes

 Updated attributes for the accelerator.
 








Class com.amazonaws.services.globalaccelerator.model.UpdateAcceleratorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


acceleratorArn
String acceleratorArn

 The Amazon Resource Name (ARN) of the accelerator to update.
 


name
String name

 The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric
 characters or hyphens (-), and must not begin or end with a hyphen.
 


ipAddressType
String ipAddressType

 The value for the address type must be IPv4.
 


enabled
Boolean enabled

 Indicates whether an accelerator is enabled. The value is true or false. The default value is true.
 
 
 If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.
 








Class com.amazonaws.services.globalaccelerator.model.UpdateAcceleratorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accelerator
Accelerator accelerator

 Information about the updated accelerator.
 








Class com.amazonaws.services.globalaccelerator.model.UpdateEndpointGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointGroupArn
String endpointGroupArn

 The Amazon Resource Name (ARN) of the endpoint group.
 


endpointConfigurations
List<E> endpointConfigurations

 The list of endpoint objects.
 


trafficDialPercentage
Float trafficDialPercentage

 The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups
 for this listener.
 
 
 Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is
 applied to the traffic that would otherwise have been routed to the Region based on optimal routing.
 
 
 The default value is 100.
 


healthCheckPort
Integer healthCheckPort

 The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group.
 The default port is the listener port that this endpoint group is associated with. If the listener port is a list
 of ports, Global Accelerator uses the first port in the list.
 


healthCheckProtocol
String healthCheckProtocol

 The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint
 group. The default value is TCP.
 


healthCheckPath
String healthCheckPath

 If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The
 default value is slash (/).
 


healthCheckIntervalSeconds
Integer healthCheckIntervalSeconds

 The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.
 


thresholdCount
Integer thresholdCount

 The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set
 an unhealthy endpoint to healthy. The default value is 3.
 








Class com.amazonaws.services.globalaccelerator.model.UpdateEndpointGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpointGroup
EndpointGroup endpointGroup

 The information about the endpoint group that was updated.
 








Class com.amazonaws.services.globalaccelerator.model.UpdateListenerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listenerArn
String listenerArn

 The Amazon Resource Name (ARN) of the listener to update.
 


portRanges
List<E> portRanges

 The updated list of port ranges for the connections from clients to the accelerator.
 


protocol
String protocol

 The updated protocol for the connections from clients to the accelerator.
 


clientAffinity
String clientAffinity

 Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications,
 regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to
 always route each client to the same specific endpoint.
 
 
 AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection.
 If client affinity is NONE, Global Accelerator uses the "five-tuple" (5-tuple) properties—source IP
 address, source port, destination IP address, destination port, and protocol—to select the hash value, and then
 chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global
 Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.
 
 
 If you want a given client to always be routed to the same endpoint, set client affinity to
 SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the
 "two-tuple" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.
 
 
 The default value is NONE.
 








Class com.amazonaws.services.globalaccelerator.model.UpdateListenerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


listener
Listener listener

 Information for the updated listener.
 








Package com.amazonaws.services.glue.model




Class com.amazonaws.services.glue.model.AccessDeniedException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.Action extends Object implements Serializable


Serialized Fields


jobName
String jobName

 The name of a job to be executed.
 


arguments
Map<K,V> arguments

 The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the
 job definition itself.
 
 
 You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue
 itself consumes.
 
 
 For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs
 in Python topic in the developer guide.
 
 
 For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters
 Used by AWS Glue topic in the developer guide.
 


timeout
Integer timeout

 The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before
 it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides
 the timeout value set in the parent job.
 


securityConfiguration
String securityConfiguration

 The name of the SecurityConfiguration structure to be used with this action.
 


notificationProperty
NotificationProperty notificationProperty

 Specifies configuration properties of a job run notification.
 


crawlerName
String crawlerName

 The name of the crawler to be used with this action.
 








Class com.amazonaws.services.glue.model.AlreadyExistsException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.AWSGlueException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.BatchCreatePartitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the catalog in which the partition is to be created. Currently, this should be the AWS account ID.
 


databaseName
String databaseName

 The name of the metadata database in which the partition is to be created.
 


tableName
String tableName

 The name of the metadata table in which the partition is to be created.
 


partitionInputList
List<E> partitionInputList

 A list of PartitionInput structures that define the partitions to be created.
 








Class com.amazonaws.services.glue.model.BatchCreatePartitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


errors
List<E> errors

 The errors encountered when trying to create the requested partitions.
 








Class com.amazonaws.services.glue.model.BatchDeleteConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by
 default.
 


connectionNameList
List<E> connectionNameList

 A list of names of the connections to delete.
 








Class com.amazonaws.services.glue.model.BatchDeleteConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


succeeded
List<E> succeeded

 A list of names of the connection definitions that were successfully deleted.
 


errors
Map<K,V> errors

 A map of the names of connections that were not successfully deleted to error details.
 








Class com.amazonaws.services.glue.model.BatchDeletePartitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the AWS account ID is
 used by default.
 


databaseName
String databaseName

 The name of the catalog database in which the table in question resides.
 


tableName
String tableName

 The name of the table that contains the partitions to be deleted.
 


partitionsToDelete
List<E> partitionsToDelete

 A list of PartitionInput structures that define the partitions to be deleted.
 








Class com.amazonaws.services.glue.model.BatchDeletePartitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


errors
List<E> errors

 The errors encountered when trying to delete the requested partitions.
 








Class com.amazonaws.services.glue.model.BatchDeleteTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.
 


databaseName
String databaseName

 The name of the catalog database in which the tables to delete reside. For Hive compatibility, this name is
 entirely lowercase.
 


tablesToDelete
List<E> tablesToDelete

 A list of the table to delete.
 








Class com.amazonaws.services.glue.model.BatchDeleteTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


errors
List<E> errors

 A list of errors encountered in attempting to delete the specified tables.
 








Class com.amazonaws.services.glue.model.BatchDeleteTableVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.
 


databaseName
String databaseName

 The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
 


tableName
String tableName

 The name of the table. For Hive compatibility, this name is entirely lowercase.
 


versionIds
List<E> versionIds

 A list of the IDs of versions to be deleted. A VersionId is a string representation of an integer.
 Each version is incremented by 1.
 








Class com.amazonaws.services.glue.model.BatchDeleteTableVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


errors
List<E> errors

 A list of errors encountered while trying to delete the specified table versions.
 








Class com.amazonaws.services.glue.model.BatchGetCrawlersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


crawlerNames
List<E> crawlerNames

 A list of crawler names, which might be the names returned from the ListCrawlers operation.
 








Class com.amazonaws.services.glue.model.BatchGetCrawlersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


crawlers
List<E> crawlers

 A list of crawler definitions.
 


crawlersNotFound
List<E> crawlersNotFound

 A list of names of crawlers that were not found.
 








Class com.amazonaws.services.glue.model.BatchGetDevEndpointsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


devEndpointNames
List<E> devEndpointNames

 The list of DevEndpoint names, which might be the names returned from the
 ListDevEndpoint operation.
 








Class com.amazonaws.services.glue.model.BatchGetDevEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devEndpoints
List<E> devEndpoints

 A list of DevEndpoint definitions.
 


devEndpointsNotFound
List<E> devEndpointsNotFound

 A list of DevEndpoints not found.
 








Class com.amazonaws.services.glue.model.BatchGetJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobNames
List<E> jobNames

 A list of job names, which might be the names returned from the ListJobs operation.
 








Class com.amazonaws.services.glue.model.BatchGetJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobs
List<E> jobs

 A list of job definitions.
 


jobsNotFound
List<E> jobsNotFound

 A list of names of jobs not found.
 








Class com.amazonaws.services.glue.model.BatchGetPartitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is
 used by default.
 


databaseName
String databaseName

 The name of the catalog database where the partitions reside.
 


tableName
String tableName

 The name of the partitions' table.
 


partitionsToGet
List<E> partitionsToGet

 A list of partition values identifying the partitions to retrieve.
 








Class com.amazonaws.services.glue.model.BatchGetPartitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


partitions
List<E> partitions

 A list of the requested partitions.
 


unprocessedKeys
List<E> unprocessedKeys

 A list of the partition values in the request for which partitions were not returned.
 








Class com.amazonaws.services.glue.model.BatchGetTriggersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


triggerNames
List<E> triggerNames

 A list of trigger names, which may be the names returned from the ListTriggers operation.
 








Class com.amazonaws.services.glue.model.BatchGetTriggersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


triggers
List<E> triggers

 A list of trigger definitions.
 


triggersNotFound
List<E> triggersNotFound

 A list of names of triggers not found.
 








Class com.amazonaws.services.glue.model.BatchGetWorkflowsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


names
List<E> names

 A list of workflow names, which may be the names returned from the ListWorkflows operation.
 


includeGraph
Boolean includeGraph

 Specifies whether to include a graph when returning the workflow resource metadata.
 








Class com.amazonaws.services.glue.model.BatchGetWorkflowsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


workflows
List<E> workflows

 A list of workflow resource metadata.
 


missingWorkflows
List<E> missingWorkflows

 A list of names of workflows not found.
 








Class com.amazonaws.services.glue.model.BatchStopJobRunError extends Object implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job definition that is used in the job run in question.
 


jobRunId
String jobRunId

 The JobRunId of the job run in question.
 


errorDetail
ErrorDetail errorDetail

 Specifies details about the error that was encountered.
 








Class com.amazonaws.services.glue.model.BatchStopJobRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job definition for which to stop job runs.
 


jobRunIds
List<E> jobRunIds

 A list of the JobRunIds that should be stopped for that job definition.
 








Class com.amazonaws.services.glue.model.BatchStopJobRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successfulSubmissions
List<E> successfulSubmissions

 A list of the JobRuns that were successfully submitted for stopping.
 


errors
List<E> errors

 A list of the errors that were encountered in trying to stop JobRuns, including the
 JobRunId for which each error was encountered and details about the error.
 








Class com.amazonaws.services.glue.model.BatchStopJobRunSuccessfulSubmission extends Object implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job definition used in the job run that was stopped.
 


jobRunId
String jobRunId

 The JobRunId of the job run that was stopped.
 








Class com.amazonaws.services.glue.model.CancelMLTaskRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the machine learning transform.
 


taskRunId
String taskRunId

 A unique identifier for the task run.
 








Class com.amazonaws.services.glue.model.CancelMLTaskRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the machine learning transform.
 


taskRunId
String taskRunId

 The unique identifier for the task run.
 


status
String status

 The status for this run.
 








Class com.amazonaws.services.glue.model.CatalogEntry extends Object implements Serializable


Serialized Fields


databaseName
String databaseName

 The database in which the table metadata resides.
 


tableName
String tableName

 The name of the table in question.
 








Class com.amazonaws.services.glue.model.CatalogImportStatus extends Object implements Serializable


Serialized Fields


importCompleted
Boolean importCompleted

 True if the migration has completed, or False otherwise.
 


importTime
Date importTime

 The time that the migration was started.
 


importedBy
String importedBy

 The name of the person who initiated the migration.
 








Class com.amazonaws.services.glue.model.CatalogTarget extends Object implements Serializable


Serialized Fields


databaseName
String databaseName

 The name of the database to be synchronized.
 


tables
List<E> tables

 A list of the tables to be synchronized.
 








Class com.amazonaws.services.glue.model.Classifier extends Object implements Serializable


Serialized Fields


grokClassifier
GrokClassifier grokClassifier

 A classifier that uses grok.
 


xMLClassifier
XMLClassifier xMLClassifier

 A classifier for XML content.
 


jsonClassifier
JsonClassifier jsonClassifier

 A classifier for JSON content.
 


csvClassifier
CsvClassifier csvClassifier

 A classifier for comma-separated values (CSV).
 








Class com.amazonaws.services.glue.model.CloudWatchEncryption extends Object implements Serializable


Serialized Fields


cloudWatchEncryptionMode
String cloudWatchEncryptionMode

 The encryption mode to use for CloudWatch data.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
 








Class com.amazonaws.services.glue.model.CodeGenEdge extends Object implements Serializable


Serialized Fields


source
String source

 The ID of the node at which the edge starts.
 


target
String target

 The ID of the node at which the edge ends.
 


targetParameter
String targetParameter

 The target of the edge.
 








Class com.amazonaws.services.glue.model.CodeGenNode extends Object implements Serializable


Serialized Fields


id
String id

 A node identifier that is unique within the node's graph.
 


nodeType
String nodeType

 The type of node that this is.
 


args
List<E> args

 Properties of the node, in the form of name-value pairs.
 


lineNumber
Integer lineNumber

 The line number of the node.
 








Class com.amazonaws.services.glue.model.CodeGenNodeArg extends Object implements Serializable


Serialized Fields


name
String name

 The name of the argument or property.
 


value
String value

 The value of the argument or property.
 


param
Boolean param

 True if the value is used as a parameter.
 








Class com.amazonaws.services.glue.model.Column extends Object implements Serializable


Serialized Fields


name
String name

 The name of the Column.
 


type
String type

 The data type of the Column.
 


comment
String comment

 A free-form text comment.
 


parameters
Map<K,V> parameters

 These key-value pairs define properties associated with the column.
 








Class com.amazonaws.services.glue.model.ConcurrentModificationException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.ConcurrentRunsExceededException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.Condition extends Object implements Serializable


Serialized Fields


logicalOperator
String logicalOperator

 A logical operator.
 


jobName
String jobName

 The name of the job whose JobRuns this condition applies to, and on which this trigger waits.
 


state
String state

 The condition state. Currently, the values supported are SUCCEEDED, STOPPED,
 TIMEOUT, and FAILED.
 


crawlerName
String crawlerName

 The name of the crawler to which this condition applies.
 


crawlState
String crawlState

 The state of the crawler to which this condition applies.
 








Class com.amazonaws.services.glue.model.ConditionCheckFailureException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.ConfusionMatrix extends Object implements Serializable


Serialized Fields


numTruePositives
Long numTruePositives

 The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.
 


numFalsePositives
Long numFalsePositives

 The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion
 matrix for your transform.
 


numTrueNegatives
Long numTrueNegatives

 The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your
 transform.
 


numFalseNegatives
Long numFalseNegatives

 The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.
 








Class com.amazonaws.services.glue.model.Connection extends Object implements Serializable


Serialized Fields


name
String name

 The name of the connection definition.
 


description
String description

 The description of the connection.
 


connectionType
String connectionType

 The type of the connection. Currently, only JDBC is supported; SFTP is not supported.
 


matchCriteria
List<E> matchCriteria

 A list of criteria that can be used in selecting this connection.
 


connectionProperties
Map<K,V> connectionProperties

 These key-value pairs define parameters for the connection:
 
 
 
 
 HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the
 database host.
 
 
 
 
 PORT - The port number, between 1024 and 65535, of the port on which the database host is listening
 for database connections.
 
 
 
 
 USER_NAME - The name under which to log in to the database. The value string for
 USER_NAME is "USERNAME".
 
 
 
 
 PASSWORD - A password, if one is used, for the user name.
 
 
 
 
 ENCRYPTED_PASSWORD - When you enable connection password protection by setting
 ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the
 encrypted password.
 
 
 
 
 JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that
 contains the JDBC driver to use.
 
 
 
 
 JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.
 
 
 
 
 JDBC_ENGINE - The name of the JDBC engine to use.
 
 
 
 
 JDBC_ENGINE_VERSION - The version of the JDBC engine to use.
 
 
 
 
 CONFIG_FILES - (Reserved for future use.)
 
 
 
 
 INSTANCE_ID - The instance ID to use.
 
 
 
 
 JDBC_CONNECTION_URL - The URL for the JDBC connection.
 
 
 
 
 JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with
 hostname matching is enforced for the JDBC connection on the client. The default is false.
 
 
 
 
 CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. AWS Glue uses
 this root certificate to validate the customer’s certificate when connecting to the customer database. AWS Glue
 only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM
 format.
 
 
 
 
 SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. AWS Glue validates the
 Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms
 for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key
 Algorithm, the key length must be at least 2048. You can set the value of this property to true to
 skip AWS Glue’s validation of the customer certificate.
 
 
 
 
 CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or
 distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the
 SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.
 
 
 


physicalConnectionRequirements
PhysicalConnectionRequirements physicalConnectionRequirements

 A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup,
 that are needed to make this connection successfully.
 


creationTime
Date creationTime

 The time that this connection definition was created.
 


lastUpdatedTime
Date lastUpdatedTime

 The last time that this connection definition was updated.
 


lastUpdatedBy
String lastUpdatedBy

 The user, group, or role that last updated this connection definition.
 








Class com.amazonaws.services.glue.model.ConnectionInput extends Object implements Serializable


Serialized Fields


name
String name

 The name of the connection.
 


description
String description

 The description of the connection.
 


connectionType
String connectionType

 The type of the connection. Currently, only JDBC is supported; SFTP is not supported.
 


matchCriteria
List<E> matchCriteria

 A list of criteria that can be used in selecting this connection.
 


connectionProperties
Map<K,V> connectionProperties

 These key-value pairs define parameters for the connection.
 


physicalConnectionRequirements
PhysicalConnectionRequirements physicalConnectionRequirements

 A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup,
 that are needed to successfully make this connection.
 








Class com.amazonaws.services.glue.model.ConnectionPasswordEncryption extends Object implements Serializable


Serialized Fields


returnConnectionPasswordEncrypted
Boolean returnConnectionPasswordEncrypted

 When the ReturnConnectionPasswordEncrypted flag is set to "true", passwords remain encrypted in the
 responses of GetConnection and GetConnections. This encryption takes effect
 independently from catalog encryption.
 


awsKmsKeyId
String awsKmsKeyId

 An AWS KMS key that is used to encrypt the connection password.
 
 
 If connection password protection is enabled, the caller of CreateConnection and
 UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to
 encrypt passwords before storing them in the Data Catalog.
 
 
 You can set the decrypt permission to enable or restrict access on the password key according to your security
 requirements.
 








Class com.amazonaws.services.glue.model.ConnectionsList extends Object implements Serializable


Serialized Fields


connections
List<E> connections

 A list of connections used by the job.
 








Class com.amazonaws.services.glue.model.Crawl extends Object implements Serializable


Serialized Fields


state
String state

 The state of the crawler.
 


startedOn
Date startedOn

 The date and time on which the crawl started.
 


completedOn
Date completedOn

 The date and time on which the crawl completed.
 


errorMessage
String errorMessage

 The error message associated with the crawl.
 


logGroup
String logGroup

 The log group associated with the crawl.
 


logStream
String logStream

 The log stream associated with the crawl.
 








Class com.amazonaws.services.glue.model.Crawler extends Object implements Serializable


Serialized Fields


name
String name

 The name of the crawler.
 


role
String role

 The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple
 Storage Service (Amazon S3) data.
 


targets
CrawlerTargets targets

 A collection of targets to crawl.
 


databaseName
String databaseName

 The name of the database in which the crawler's output is stored.
 


description
String description

 A description of the crawler.
 


classifiers
List<E> classifiers

 A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.
 


schemaChangePolicy
SchemaChangePolicy schemaChangePolicy

 The policy that specifies update and delete behaviors for the crawler.
 


state
String state

 Indicates whether the crawler is running, or whether a run is pending.
 


tablePrefix
String tablePrefix

 The prefix added to the names of tables that are created.
 


schedule
Schedule schedule

 For scheduled crawlers, the schedule when the crawler runs.
 


crawlElapsedTime
Long crawlElapsedTime

 If the crawler is running, contains the total time elapsed since the last crawl began.
 


creationTime
Date creationTime

 The time that the crawler was created.
 


lastUpdated
Date lastUpdated

 The time that the crawler was last updated.
 


lastCrawl
LastCrawlInfo lastCrawl

 The status of the last crawl, and potentially error information if an error occurred.
 


version
Long version

 The version of the crawler.
 


configuration
String configuration

 Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's
 behavior. For more information, see Configuring a Crawler.
 


crawlerSecurityConfiguration
String crawlerSecurityConfiguration

 The name of the SecurityConfiguration structure to be used by this crawler.
 








Class com.amazonaws.services.glue.model.CrawlerMetrics extends Object implements Serializable


Serialized Fields


crawlerName
String crawlerName

 The name of the crawler.
 


timeLeftSeconds
Double timeLeftSeconds

 The estimated time left to complete a running crawl.
 


stillEstimating
Boolean stillEstimating

 True if the crawler is still estimating how long it will take to complete this run.
 


lastRuntimeSeconds
Double lastRuntimeSeconds

 The duration of the crawler's most recent run, in seconds.
 


medianRuntimeSeconds
Double medianRuntimeSeconds

 The median duration of this crawler's runs, in seconds.
 


tablesCreated
Integer tablesCreated

 The number of tables created by this crawler.
 


tablesUpdated
Integer tablesUpdated

 The number of tables updated by this crawler.
 


tablesDeleted
Integer tablesDeleted

 The number of tables deleted by this crawler.
 








Class com.amazonaws.services.glue.model.CrawlerNodeDetails extends Object implements Serializable


Serialized Fields


crawls
List<E> crawls

 A list of crawls represented by the crawl node.
 








Class com.amazonaws.services.glue.model.CrawlerNotRunningException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.CrawlerRunningException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.CrawlerStoppingException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.CrawlerTargets extends Object implements Serializable


Serialized Fields


s3Targets
List<E> s3Targets

 Specifies Amazon Simple Storage Service (Amazon S3) targets.
 


jdbcTargets
List<E> jdbcTargets

 Specifies JDBC targets.
 


dynamoDBTargets
List<E> dynamoDBTargets

 Specifies Amazon DynamoDB targets.
 


catalogTargets
List<E> catalogTargets

 Specifies AWS Glue Data Catalog targets.
 








Class com.amazonaws.services.glue.model.CreateClassifierRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


grokClassifier
CreateGrokClassifierRequest grokClassifier

 A GrokClassifier object specifying the classifier to create.
 


xMLClassifier
CreateXMLClassifierRequest xMLClassifier

 An XMLClassifier object specifying the classifier to create.
 


jsonClassifier
CreateJsonClassifierRequest jsonClassifier

 A JsonClassifier object specifying the classifier to create.
 


csvClassifier
CreateCsvClassifierRequest csvClassifier

 A CsvClassifier object specifying the classifier to create.
 








Class com.amazonaws.services.glue.model.CreateClassifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.CreateConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog in which to create the connection. If none is provided, the AWS account ID is used by
 default.
 


connectionInput
ConnectionInput connectionInput

 A ConnectionInput object defining the connection to create.
 








Class com.amazonaws.services.glue.model.CreateConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.CreateCrawlerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the new crawler.
 


role
String role

 The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.
 


databaseName
String databaseName

 The AWS Glue database where results are written, such as:
 arn:aws:daylight:us-east-1::database/sometable/*.
 


description
String description

 A description of the new crawler.
 


targets
CrawlerTargets targets

 A list of collection of targets to crawl.
 


schedule
String schedule

 A cron expression used to specify the schedule. For more information, see Time-Based Schedules for
 Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify
 cron(15 12 * * ? *).
 


classifiers
List<E> classifiers

 A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a
 crawl, but these custom classifiers always override the default classifiers for a given classification.
 


tablePrefix
String tablePrefix

 The table prefix used for catalog tables that are created.
 


schemaChangePolicy
SchemaChangePolicy schemaChangePolicy

 The policy for the crawler's update and deletion behavior.
 


configuration
String configuration

 The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's
 behavior. For more information, see Configuring a Crawler.
 


crawlerSecurityConfiguration
String crawlerSecurityConfiguration

 The name of the SecurityConfiguration structure to be used by this crawler.
 


tags
Map<K,V> tags

 The tags to use with this crawler request. You can use tags to limit access to the crawler. For more information,
 see AWS Tags in AWS Glue.
 








Class com.amazonaws.services.glue.model.CreateCrawlerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.CreateCsvClassifierRequest extends Object implements Serializable


Serialized Fields


name
String name

 The name of the classifier.
 


delimiter
String delimiter

 A custom symbol to denote what separates each column entry in the row.
 


quoteSymbol
String quoteSymbol

 A custom symbol to denote what combines content into a single column value. Must be different from the column
 delimiter.
 


containsHeader
String containsHeader

 Indicates whether the CSV file contains a header.
 


header
List<E> header

 A list of strings representing column names.
 


disableValueTrimming
Boolean disableValueTrimming

 Specifies not to trim values before identifying the type of column values. The default value is true.
 


allowSingleColumn
Boolean allowSingleColumn

 Enables the processing of files that contain only one column.
 








Class com.amazonaws.services.glue.model.CreateDatabaseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog in which to create the database. If none is provided, the AWS account ID is used by
 default.
 


databaseInput
DatabaseInput databaseInput

 The metadata for the database.
 








Class com.amazonaws.services.glue.model.CreateDatabaseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.CreateDevEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointName
String endpointName

 The name to be assigned to the new DevEndpoint.
 


roleArn
String roleArn

 The IAM role for the DevEndpoint.
 


securityGroupIds
List<E> securityGroupIds

 Security group IDs for the security groups to be used by the new DevEndpoint.
 


subnetId
String subnetId

 The subnet ID for the new DevEndpoint to use.
 


publicKey
String publicKey

 The public key to be used by this DevEndpoint for authentication. This attribute is provided for
 backward compatibility because the recommended attribute to use is public keys.
 


publicKeys
List<E> publicKeys

 A list of public keys to be used by the development endpoints for authentication. The use of this attribute is
 preferred over a single public key because the public keys allow you to have a different private key per client.
 
 
 
 If you previously created an endpoint with a public key, you must remove that key to be able to set a list of
 public keys. Call the UpdateDevEndpoint API with the public key content in the
 deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
 
 


numberOfNodes
Integer numberOfNodes

 The number of AWS Glue Data Processing Units (DPUs) to allocate to this DevEndpoint.
 


workerType
String workerType

 The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X,
 or G.2X.
 
 
 
 
 For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2
 executors per worker.
 
 
 
 
 For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and
 provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
 
 
 
 
 For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and
 provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
 
 
 
 
 Known issue: when a development endpoint is created with the G.2X WorkerType
 configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB
 disk.
 


glueVersion
String glueVersion

 Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version
 indicates the version supported for running your ETL scripts on development endpoints.
 
 
 For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
 
 
 Development endpoints that are created without specifying a Glue version default to Glue 0.9.
 
 
 You can specify a version of Python support for development endpoints by using the Arguments
 parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are
 provided, the version defaults to Python 2.
 


numberOfWorkers
Integer numberOfWorkers

 The number of workers of a defined workerType that are allocated to the development endpoint.
 
 
 The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
 


extraPythonLibsS3Path
String extraPythonLibsS3Path

 The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your
 DevEndpoint. Multiple values must be complete paths separated by a comma.
 
 
 
 You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such
 as the pandas Python data analysis library, are not yet supported.
 
 


extraJarsS3Path
String extraJarsS3Path

 The path to one or more Java .jar files in an S3 bucket that should be loaded in your
 DevEndpoint.
 


securityConfiguration
String securityConfiguration

 The name of the SecurityConfiguration structure to be used with this DevEndpoint.
 


tags
Map<K,V> tags

 The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information
 about tags in AWS Glue, see AWS Tags in
 AWS Glue in the developer guide.
 


arguments
Map<K,V> arguments

 A map of arguments used to configure the DevEndpoint.
 








Class com.amazonaws.services.glue.model.CreateDevEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpointName
String endpointName

 The name assigned to the new DevEndpoint.
 


status
String status

 The current status of the new DevEndpoint.
 


securityGroupIds
List<E> securityGroupIds

 The security groups assigned to the new DevEndpoint.
 


subnetId
String subnetId

 The subnet ID assigned to the new DevEndpoint.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the role assigned to the new DevEndpoint.
 


yarnEndpointAddress
String yarnEndpointAddress

 The address of the YARN endpoint used by this DevEndpoint.
 


zeppelinRemoteSparkInterpreterPort
Integer zeppelinRemoteSparkInterpreterPort

 The Apache Zeppelin port for the remote Apache Spark interpreter.
 


numberOfNodes
Integer numberOfNodes

 The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
 


workerType
String workerType

 The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or
 G.2X.
 


glueVersion
String glueVersion

 Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version
 indicates the version supported for running your ETL scripts on development endpoints.
 


numberOfWorkers
Integer numberOfWorkers

 The number of workers of a defined workerType that are allocated to the development endpoint.
 


availabilityZone
String availabilityZone

 The AWS Availability Zone where this DevEndpoint is located.
 


vpcId
String vpcId

 The ID of the virtual private cloud (VPC) used by this DevEndpoint.
 


extraPythonLibsS3Path
String extraPythonLibsS3Path

 The paths to one or more Python libraries in an S3 bucket that will be loaded in your DevEndpoint.
 


extraJarsS3Path
String extraJarsS3Path

 Path to one or more Java .jar files in an S3 bucket that will be loaded in your
 DevEndpoint.
 


failureReason
String failureReason

 The reason for a current failure in this DevEndpoint.
 


securityConfiguration
String securityConfiguration

 The name of the SecurityConfiguration structure being used with this DevEndpoint.
 


createdTimestamp
Date createdTimestamp

 The point in time at which this DevEndpoint was created.
 


arguments
Map<K,V> arguments

 The map of arguments used to configure this DevEndpoint.
 
 
 Valid arguments are:
 
 
 
 
 "--enable-glue-datacatalog": ""
 
 
 
 
 "GLUE_PYTHON_VERSION": "3"
 
 
 
 
 "GLUE_PYTHON_VERSION": "2"
 
 
 
 
 You can specify a version of Python support for development endpoints by using the Arguments
 parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are
 provided, the version defaults to Python 2.
 








Class com.amazonaws.services.glue.model.CreateGrokClassifierRequest extends Object implements Serializable


Serialized Fields


classification
String classification

 An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon
 CloudWatch Logs, and so on.
 


name
String name

 The name of the new classifier.
 


grokPattern
String grokPattern

 The grok pattern used by this classifier.
 


customPatterns
String customPatterns

 Optional custom grok patterns used by this classifier.
 








Class com.amazonaws.services.glue.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name you assign to this job definition. It must be unique in your account.
 


description
String description

 Description of the job being defined.
 


logUri
String logUri

 This field is reserved for future use.
 


role
String role

 The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
 


executionProperty
ExecutionProperty executionProperty

 An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
 


command
JobCommand command

 The JobCommand that executes this job.
 


defaultArguments
Map<K,V> defaultArguments

 The default arguments for this job.
 
 
 You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue
 itself consumes.
 
 
 For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs
 in Python topic in the developer guide.
 
 
 For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters
 Used by AWS Glue topic in the developer guide.
 


connections
ConnectionsList connections

 The connections used for this job.
 


maxRetries
Integer maxRetries

 The maximum number of times to retry this job if it fails.
 


allocatedCapacity
Integer allocatedCapacity
Deprecated. 

 This parameter is deprecated. Use MaxCapacity instead.
 
 
 The number of AWS Glue data processing units (DPUs) to allocate to this Job. You can allocate from 2 to 100 DPUs;
 the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity
 and 16 GB of memory. For more information, see the AWS Glue
 pricing page.
 


timeout
Integer timeout

 The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated
 and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
 


maxCapacity
Double maxCapacity

 The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative
 measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more
 information, see the AWS Glue pricing page.
 
 
 Do not set Max Capacity if using WorkerType and NumberOfWorkers.
 
 
 The value that can be allocated for MaxCapacity depends on whether you are running a Python shell
 job or an Apache Spark ETL job:
 
 
 
 
 When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625
 or 1 DPU. The default is 0.0625 DPU.
 
 
 
 
 When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100
 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
 
 
 


securityConfiguration
String securityConfiguration

 The name of the SecurityConfiguration structure to be used with this job.
 


tags
Map<K,V> tags

 The tags to use with this job. You may use tags to limit access to the job. For more information about tags in
 AWS Glue, see AWS Tags in AWS Glue in
 the developer guide.
 


notificationProperty
NotificationProperty notificationProperty

 Specifies configuration properties of a job notification.
 


glueVersion
String glueVersion

 Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version
 indicates the version supported for jobs of type Spark.
 
 
 For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
 
 
 Jobs that are created without specifying a Glue version default to Glue 0.9.
 


numberOfWorkers
Integer numberOfWorkers

 The number of workers of a defined workerType that are allocated when a job runs.
 
 
 The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
 


workerType
String workerType

 The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
 
 
 
 
 For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2
 executors per worker.
 
 
 
 
 For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and
 provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
 
 
 
 
 For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and
 provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
 
 
 








Class com.amazonaws.services.glue.model.CreateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The unique name that was provided for this job definition.
 








Class com.amazonaws.services.glue.model.CreateJsonClassifierRequest extends Object implements Serializable


Serialized Fields


name
String name

 The name of the classifier.
 


jsonPath
String jsonPath

 A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset
 of JsonPath, as described in Writing JsonPath
 Custom Classifiers.
 








Class com.amazonaws.services.glue.model.CreateMLTransformRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The unique name that you give the transform when you create it.
 


description
String description

 A description of the machine learning transform that is being defined. The default is an empty string.
 


inputRecordTables
List<E> inputRecordTables

 A list of AWS Glue table definitions used by the transform.
 


parameters
TransformParameters parameters

 The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform
 type.
 


role
String role

 The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions
 include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the
 transform.
 
 
 
 
 This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That
 Access AWS Glue.
 
 
 
 
 This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary
 directory, scripts, and any libraries used by the task run for this transform.
 
 
 


glueVersion
String glueVersion

 This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is
 recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more
 information, see AWS Glue Versions
 in the developer guide.
 


maxCapacity
Double maxCapacity

 The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can
 allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of
 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.
 
 
 MaxCapacity is a mutually exclusive option with NumberOfWorkers and
 WorkerType.
 
 
 
 
 If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be
 set.
 
 
 
 
 If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be
 set.
 
 
 
 
 If WorkerType is set, then NumberOfWorkers is required (and vice versa).
 
 
 
 
 MaxCapacity and NumberOfWorkers must both be at least 1.
 
 
 
 
 When the WorkerType field is set to a value other than Standard, the
 MaxCapacity field is set automatically and becomes read-only.
 
 
 When the WorkerType field is set to a value other than Standard, the
 MaxCapacity field is set automatically and becomes read-only.
 


workerType
String workerType

 The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
 
 
 
 
 For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2
 executors per worker.
 
 
 
 
 For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1
 executor per worker.
 
 
 
 
 For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1
 executor per worker.
 
 
 
 
 MaxCapacity is a mutually exclusive option with NumberOfWorkers and
 WorkerType.
 
 
 
 
 If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be
 set.
 
 
 
 
 If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be
 set.
 
 
 
 
 If WorkerType is set, then NumberOfWorkers is required (and vice versa).
 
 
 
 
 MaxCapacity and NumberOfWorkers must both be at least 1.
 
 
 


numberOfWorkers
Integer numberOfWorkers

 The number of workers of a defined workerType that are allocated when this task runs.
 
 
 If WorkerType is set, then NumberOfWorkers is required (and vice versa).
 


timeout
Integer timeout

 The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this
 transform can consume resources before it is terminated and enters TIMEOUT status. The default is
 2,880 minutes (48 hours).
 


maxRetries
Integer maxRetries

 The maximum number of times to retry a task for this transform after a task run fails.
 








Class com.amazonaws.services.glue.model.CreateMLTransformResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transformId
String transformId

 A unique identifier that is generated for the transform.
 








Class com.amazonaws.services.glue.model.CreatePartitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The AWS account ID of the catalog in which the partition is to be created.
 


databaseName
String databaseName

 The name of the metadata database in which the partition is to be created.
 


tableName
String tableName

 The name of the metadata table in which the partition is to be created.
 


partitionInput
PartitionInput partitionInput

 A PartitionInput structure defining the partition to be created.
 








Class com.amazonaws.services.glue.model.CreatePartitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.CreateScriptRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dagNodes
List<E> dagNodes

 A list of the nodes in the DAG.
 


dagEdges
List<E> dagEdges

 A list of the edges in the DAG.
 


language
String language

 The programming language of the resulting code from the DAG.
 








Class com.amazonaws.services.glue.model.CreateScriptResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pythonScript
String pythonScript

 The Python script generated from the DAG.
 


scalaCode
String scalaCode

 The Scala code generated from the DAG.
 








Class com.amazonaws.services.glue.model.CreateSecurityConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name for the new security configuration.
 


encryptionConfiguration
EncryptionConfiguration encryptionConfiguration

 The encryption configuration for the new security configuration.
 








Class com.amazonaws.services.glue.model.CreateSecurityConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name assigned to the new security configuration.
 


createdTimestamp
Date createdTimestamp

 The time at which the new security configuration was created.
 








Class com.amazonaws.services.glue.model.CreateTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog in which to create the Table. If none is supplied, the AWS account ID is
 used by default.
 


databaseName
String databaseName

 The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.
 


tableInput
TableInput tableInput

 The TableInput object that defines the metadata table to create in the catalog.
 








Class com.amazonaws.services.glue.model.CreateTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.CreateTriggerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the trigger.
 


workflowName
String workflowName

 The name of the workflow associated with the trigger.
 


type
String type

 The type of the new trigger.
 


schedule
String schedule

 A cron expression used to specify the schedule (see Time-Based Schedules for
 Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify:
 cron(15 12 * * ? *).
 
 
 This field is required when the trigger type is SCHEDULED.
 


predicate
Predicate predicate

 A predicate to specify when the new trigger should fire.
 
 
 This field is required when the trigger type is CONDITIONAL.
 


actions
List<E> actions

 The actions initiated by this trigger when it fires.
 


description
String description

 A description of the new trigger.
 


startOnCreation
Boolean startOnCreation

 Set to true to start SCHEDULED and CONDITIONAL triggers when created. True
 is not supported for ON_DEMAND triggers.
 


tags
Map<K,V> tags

 The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about
 tags in AWS Glue, see AWS Tags in AWS
 Glue in the developer guide.
 








Class com.amazonaws.services.glue.model.CreateTriggerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the trigger.
 








Class com.amazonaws.services.glue.model.CreateUserDefinedFunctionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog in which to create the function. If none is provided, the AWS account ID is used by
 default.
 


databaseName
String databaseName

 The name of the catalog database in which to create the function.
 


functionInput
UserDefinedFunctionInput functionInput

 A FunctionInput object that defines the function to create in the Data Catalog.
 








Class com.amazonaws.services.glue.model.CreateUserDefinedFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.CreateWorkflowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name to be assigned to the workflow. It should be unique within your account.
 


description
String description

 A description of the workflow.
 


defaultRunProperties
Map<K,V> defaultRunProperties

 A collection of properties to be used as part of each execution of the workflow.
 


tags
Map<K,V> tags

 The tags to be used with this workflow.
 








Class com.amazonaws.services.glue.model.CreateWorkflowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the workflow which was provided as part of the request.
 








Class com.amazonaws.services.glue.model.CreateXMLClassifierRequest extends Object implements Serializable


Serialized Fields


classification
String classification

 An identifier of the data format that the classifier matches.
 


name
String name

 The name of the classifier.
 


rowTag
String rowTag

 The XML tag designating the element that contains each record in an XML document being parsed. This can't
 identify a self-closing element (closed by />). An empty row element that contains only
 attributes can be parsed as long as it ends with a closing tag (for example,
 <row item_a="A" item_b="B"></row> is okay, but
 <row item_a="A" item_b="B" /> is not).
 








Class com.amazonaws.services.glue.model.CsvClassifier extends Object implements Serializable


Serialized Fields


name
String name

 The name of the classifier.
 


creationTime
Date creationTime

 The time that this classifier was registered.
 


lastUpdated
Date lastUpdated

 The time that this classifier was last updated.
 


version
Long version

 The version of this classifier.
 


delimiter
String delimiter

 A custom symbol to denote what separates each column entry in the row.
 


quoteSymbol
String quoteSymbol

 A custom symbol to denote what combines content into a single column value. It must be different from the column
 delimiter.
 


containsHeader
String containsHeader

 Indicates whether the CSV file contains a header.
 


header
List<E> header

 A list of strings representing column names.
 


disableValueTrimming
Boolean disableValueTrimming

 Specifies not to trim values before identifying the type of column values. The default value is true
 .
 


allowSingleColumn
Boolean allowSingleColumn

 Enables the processing of files that contain only one column.
 








Class com.amazonaws.services.glue.model.Database extends Object implements Serializable


Serialized Fields


name
String name

 The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
 


description
String description

 A description of the database.
 


locationUri
String locationUri

 The location of the database (for example, an HDFS path).
 


parameters
Map<K,V> parameters

 These key-value pairs define parameters and properties of the database.
 


createTime
Date createTime

 The time at which the metadata database was created in the catalog.
 


createTableDefaultPermissions
List<E> createTableDefaultPermissions

 Creates a set of default permissions on the table for principals.
 








Class com.amazonaws.services.glue.model.DatabaseInput extends Object implements Serializable


Serialized Fields


name
String name

 The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
 


description
String description

 A description of the database.
 


locationUri
String locationUri

 The location of the database (for example, an HDFS path).
 


parameters
Map<K,V> parameters

 These key-value pairs define parameters and properties of the database.
 
 
 These key-value pairs define parameters and properties of the database.
 


createTableDefaultPermissions
List<E> createTableDefaultPermissions

 Creates a set of default permissions on the table for principals.
 








Class com.amazonaws.services.glue.model.DataCatalogEncryptionSettings extends Object implements Serializable


Serialized Fields


encryptionAtRest
EncryptionAtRest encryptionAtRest

 Specifies the encryption-at-rest configuration for the Data Catalog.
 


connectionPasswordEncryption
ConnectionPasswordEncryption connectionPasswordEncryption

 When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the
 password as part of CreateConnection or UpdateConnection and store it in the
 ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only
 password encryption.
 








Class com.amazonaws.services.glue.model.DataLakePrincipal extends Object implements Serializable


Serialized Fields


dataLakePrincipalIdentifier
String dataLakePrincipalIdentifier

 An identifier for the AWS Lake Formation principal.
 








Class com.amazonaws.services.glue.model.DeleteClassifierRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the classifier to remove.
 








Class com.amazonaws.services.glue.model.DeleteClassifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.DeleteConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by
 default.
 


connectionName
String connectionName

 The name of the connection to delete.
 








Class com.amazonaws.services.glue.model.DeleteConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.DeleteCrawlerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the crawler to remove.
 








Class com.amazonaws.services.glue.model.DeleteCrawlerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.DeleteDatabaseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog in which the database resides. If none is provided, the AWS account ID is used by
 default.
 


name
String name

 The name of the database to delete. For Hive compatibility, this must be all lowercase.
 








Class com.amazonaws.services.glue.model.DeleteDatabaseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.DeleteDevEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointName
String endpointName

 The name of the DevEndpoint.
 








Class com.amazonaws.services.glue.model.DeleteDevEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.DeleteJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job definition to delete.
 








Class com.amazonaws.services.glue.model.DeleteJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job definition that was deleted.
 








Class com.amazonaws.services.glue.model.DeleteMLTransformRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the transform to delete.
 








Class com.amazonaws.services.glue.model.DeleteMLTransformResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the transform that was deleted.
 








Class com.amazonaws.services.glue.model.DeletePartitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the AWS account ID is
 used by default.
 


databaseName
String databaseName

 The name of the catalog database in which the table in question resides.
 


tableName
String tableName

 The name of the table that contains the partition to be deleted.
 


partitionValues
List<E> partitionValues

 The values that define the partition.
 








Class com.amazonaws.services.glue.model.DeletePartitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.DeleteResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyHashCondition
String policyHashCondition

 The hash value returned when this policy was set.
 








Class com.amazonaws.services.glue.model.DeleteResourcePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.DeleteSecurityConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the security configuration to delete.
 








Class com.amazonaws.services.glue.model.DeleteSecurityConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.DeleteTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.
 


databaseName
String databaseName

 The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely
 lowercase.
 


name
String name

 The name of the table to be deleted. For Hive compatibility, this name is entirely lowercase.
 








Class com.amazonaws.services.glue.model.DeleteTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.DeleteTableVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.
 


databaseName
String databaseName

 The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
 


tableName
String tableName

 The name of the table. For Hive compatibility, this name is entirely lowercase.
 


versionId
String versionId

 The ID of the table version to be deleted. A VersionID is a string representation of an integer.
 Each version is incremented by 1.
 








Class com.amazonaws.services.glue.model.DeleteTableVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.DeleteTriggerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the trigger to delete.
 








Class com.amazonaws.services.glue.model.DeleteTriggerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the trigger that was deleted.
 








Class com.amazonaws.services.glue.model.DeleteUserDefinedFunctionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the function to be deleted is located. If none is supplied, the AWS account ID
 is used by default.
 


databaseName
String databaseName

 The name of the catalog database where the function is located.
 


functionName
String functionName

 The name of the function definition to be deleted.
 








Class com.amazonaws.services.glue.model.DeleteUserDefinedFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.DeleteWorkflowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the workflow to be deleted.
 








Class com.amazonaws.services.glue.model.DeleteWorkflowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 Name of the workflow specified in input.
 








Class com.amazonaws.services.glue.model.DevEndpoint extends Object implements Serializable


Serialized Fields


endpointName
String endpointName

 The name of the DevEndpoint.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint.
 


securityGroupIds
List<E> securityGroupIds

 A list of security group identifiers used in this DevEndpoint.
 


subnetId
String subnetId

 The subnet ID for this DevEndpoint.
 


yarnEndpointAddress
String yarnEndpointAddress

 The YARN endpoint address used by this DevEndpoint.
 


privateAddress
String privateAddress

 A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is
 created within one. The PrivateAddress field is present only when you create the
 DevEndpoint within your VPC.
 


zeppelinRemoteSparkInterpreterPort
Integer zeppelinRemoteSparkInterpreterPort

 The Apache Zeppelin port for the remote Apache Spark interpreter.
 


publicAddress
String publicAddress

 The public IP address used by this DevEndpoint. The PublicAddress field is present only
 when you create a non-virtual private cloud (VPC) DevEndpoint.
 


status
String status

 The current status of this DevEndpoint.
 


workerType
String workerType

 The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X,
 or G.2X.
 
 
 
 
 For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2
 executors per worker.
 
 
 
 
 For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and
 provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
 
 
 
 
 For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and
 provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
 
 
 
 
 Known issue: when a development endpoint is created with the G.2X WorkerType
 configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB
 disk.
 


glueVersion
String glueVersion

 Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version
 indicates the version supported for running your ETL scripts on development endpoints.
 
 
 For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
 
 
 Development endpoints that are created without specifying a Glue version default to Glue 0.9.
 
 
 You can specify a version of Python support for development endpoints by using the Arguments
 parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are
 provided, the version defaults to Python 2.
 


numberOfWorkers
Integer numberOfWorkers

 The number of workers of a defined workerType that are allocated to the development endpoint.
 
 
 The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
 


numberOfNodes
Integer numberOfNodes

 The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.
 


availabilityZone
String availabilityZone

 The AWS Availability Zone where this DevEndpoint is located.
 


vpcId
String vpcId

 The ID of the virtual private cloud (VPC) used by this DevEndpoint.
 


extraPythonLibsS3Path
String extraPythonLibsS3Path

 The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your
 DevEndpoint. Multiple values must be complete paths separated by a comma.
 
 
 
 You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such
 as the pandas Python data analysis library, are not currently supported.
 
 


extraJarsS3Path
String extraJarsS3Path

 The path to one or more Java .jar files in an S3 bucket that should be loaded in your
 DevEndpoint.
 
 
 
 You can only use pure Java/Scala libraries with a DevEndpoint.
 
 


failureReason
String failureReason

 The reason for a current failure in this DevEndpoint.
 


lastUpdateStatus
String lastUpdateStatus

 The status of the last update.
 


createdTimestamp
Date createdTimestamp

 The point in time at which this DevEndpoint was created.
 


lastModifiedTimestamp
Date lastModifiedTimestamp

 The point in time at which this DevEndpoint was last modified.
 


publicKey
String publicKey

 The public key to be used by this DevEndpoint for authentication. This attribute is provided for
 backward compatibility because the recommended attribute to use is public keys.
 


publicKeys
List<E> publicKeys

 A list of public keys to be used by the DevEndpoints for authentication. Using this attribute is
 preferred over a single public key because the public keys allow you to have a different private key per client.
 
 
 
 If you previously created an endpoint with a public key, you must remove that key to be able to set a list of
 public keys. Call the UpdateDevEndpoint API operation with the public key content in the
 deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.
 
 


securityConfiguration
String securityConfiguration

 The name of the SecurityConfiguration structure to be used with this DevEndpoint.
 


arguments
Map<K,V> arguments

 A map of arguments used to configure the DevEndpoint.
 
 
 Valid arguments are:
 
 
 
 
 "--enable-glue-datacatalog": ""
 
 
 
 
 "GLUE_PYTHON_VERSION": "3"
 
 
 
 
 "GLUE_PYTHON_VERSION": "2"
 
 
 
 
 You can specify a version of Python support for development endpoints by using the Arguments
 parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are
 provided, the version defaults to Python 2.
 








Class com.amazonaws.services.glue.model.DevEndpointCustomLibraries extends Object implements Serializable


Serialized Fields


extraPythonLibsS3Path
String extraPythonLibsS3Path

 The paths to one or more Python libraries in an Amazon Simple Storage Service (Amazon S3) bucket that should be
 loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.
 
 
 
 You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such
 as the pandas Python data analysis library, are not currently supported.
 
 


extraJarsS3Path
String extraJarsS3Path

 The path to one or more Java .jar files in an S3 bucket that should be loaded in your
 DevEndpoint.
 
 
 
 You can only use pure Java/Scala libraries with a DevEndpoint.
 
 








Class com.amazonaws.services.glue.model.DynamoDBTarget extends Object implements Serializable


Serialized Fields


path
String path

 The name of the DynamoDB table to crawl.
 








Class com.amazonaws.services.glue.model.Edge extends Object implements Serializable


Serialized Fields


sourceId
String sourceId

 The unique of the node within the workflow where the edge starts.
 


destinationId
String destinationId

 The unique of the node within the workflow where the edge ends.
 








Class com.amazonaws.services.glue.model.EncryptionAtRest extends Object implements Serializable


Serialized Fields


catalogEncryptionMode
String catalogEncryptionMode

 The encryption-at-rest mode for encrypting Data Catalog data.
 


sseAwsKmsKeyId
String sseAwsKmsKeyId

 The ID of the AWS KMS key to use for encryption at rest.
 








Class com.amazonaws.services.glue.model.EncryptionConfiguration extends Object implements Serializable


Serialized Fields


s3Encryption
List<E> s3Encryption

 The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.
 


cloudWatchEncryption
CloudWatchEncryption cloudWatchEncryption

 The encryption configuration for Amazon CloudWatch.
 


jobBookmarksEncryption
JobBookmarksEncryption jobBookmarksEncryption

 The encryption configuration for job bookmarks.
 








Class com.amazonaws.services.glue.model.EntityNotFoundException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.ErrorDetail extends Object implements Serializable


Serialized Fields


errorCode
String errorCode

 The code associated with this error.
 


errorMessage
String errorMessage

 A message describing the error.
 








Class com.amazonaws.services.glue.model.EvaluationMetrics extends Object implements Serializable


Serialized Fields


transformType
String transformType

 The type of machine learning transform.
 


findMatchesMetrics
FindMatchesMetrics findMatchesMetrics

 The evaluation metrics for the find matches algorithm.
 








Class com.amazonaws.services.glue.model.ExecutionProperty extends Object implements Serializable


Serialized Fields


maxConcurrentRuns
Integer maxConcurrentRuns

 The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this
 threshold is reached. The maximum value you can specify is controlled by a service limit.
 








Class com.amazonaws.services.glue.model.ExportLabelsTaskRunProperties extends Object implements Serializable


Serialized Fields


outputS3Path
String outputS3Path

 The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.
 








Class com.amazonaws.services.glue.model.FindMatchesMetrics extends Object implements Serializable


Serialized Fields


areaUnderPRCurve
Double areaUnderPRCurve

 The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the
 transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have
 a more attractive precision vs. recall tradeoff.
 
 
 For more information, see Precision and recall
 in Wikipedia.
 


precision
Double precision

 The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it
 measures how well the transform finds true positives from the total true positives possible.
 
 
 For more information, see Precision and recall
 in Wikipedia.
 


recall
Double recall

 The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically,
 it measures how well the transform finds true positives from the total records in the source data.
 
 
 For more information, see Precision and recall
 in Wikipedia.
 


f1
Double f1

 The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.
 
 
 For more information, see F1 score in Wikipedia.
 


confusionMatrix
ConfusionMatrix confusionMatrix

 The confusion matrix shows you what your transform is predicting accurately and what types of errors it is
 making.
 
 
 For more information, see Confusion matrix in
 Wikipedia.
 








Class com.amazonaws.services.glue.model.FindMatchesParameters extends Object implements Serializable


Serialized Fields


primaryKeyColumnName
String primaryKeyColumnName

 The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.
 


precisionRecallTradeoff
Double precisionRecallTradeoff

 The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no
 preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because
 this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results
 in very low precision.
 
 
 The precision metric indicates how often your model is correct when it predicts a match.
 
 
 The recall metric indicates that for an actual match, how often your model predicts the match.
 


accuracyCostTradeoff
Double accuracyCostTradeoff

 The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5
 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which
 typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost,
 which results in a less accurate FindMatches transform, sometimes with unacceptable accuracy.
 
 
 Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires
 more machine resources and cost. But it also results in increased recall.
 
 
 Cost measures how many compute resources, and thus money, are consumed to run the transform.
 


enforceProvidedLabels
Boolean enforceProvidedLabels

 The value to switch on or off to force the output to match the provided labels from users. If the value is
 True, the find matches transform forces the output to match the provided labels. The
 results override the normal conflation results. If the value is False, the find matches
 transform does not ensure all the labels provided are respected, and the results rely on the trained model.
 
 
 Note that setting this value to true may increase the conflation execution time.
 








Class com.amazonaws.services.glue.model.FindMatchesTaskRunProperties extends Object implements Serializable


Serialized Fields


jobId
String jobId

 The job ID for the Find Matches task run.
 


jobName
String jobName

 The name assigned to the job for the Find Matches task run.
 


jobRunId
String jobRunId

 The job run ID for the Find Matches task run.
 








Class com.amazonaws.services.glue.model.GetCatalogImportStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the catalog to migrate. Currently, this should be the AWS account ID.
 








Class com.amazonaws.services.glue.model.GetCatalogImportStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


importStatus
CatalogImportStatus importStatus

 The status of the specified catalog migration.
 








Class com.amazonaws.services.glue.model.GetClassifierRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the classifier to retrieve.
 








Class com.amazonaws.services.glue.model.GetClassifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


classifier
Classifier classifier

 The requested classifier.
 








Class com.amazonaws.services.glue.model.GetClassifiersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The size of the list to return (optional).
 


nextToken
String nextToken

 An optional continuation token.
 








Class com.amazonaws.services.glue.model.GetClassifiersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


classifiers
List<E> classifiers

 The requested list of classifier objects.
 


nextToken
String nextToken

 A continuation token.
 








Class com.amazonaws.services.glue.model.GetConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by
 default.
 


name
String name

 The name of the connection definition to retrieve.
 


hidePassword
Boolean hidePassword

 Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console
 uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller
 might not have permission to use the AWS KMS key to decrypt the password, but it does have permission to access
 the rest of the connection properties.
 








Class com.amazonaws.services.glue.model.GetConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connection
Connection connection

 The requested connection definition.
 








Class com.amazonaws.services.glue.model.GetConnectionsFilter extends Object implements Serializable


Serialized Fields


matchCriteria
List<E> matchCriteria

 A criteria string that must match the criteria recorded in the connection definition for that connection
 definition to be returned.
 


connectionType
String connectionType

 The type of connections to return. Currently, only JDBC is supported; SFTP is not supported.
 








Class com.amazonaws.services.glue.model.GetConnectionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by
 default.
 


filter
GetConnectionsFilter filter

 A filter that controls which connections are returned.
 


hidePassword
Boolean hidePassword

 Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console
 uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller
 might not have permission to use the AWS KMS key to decrypt the password, but it does have permission to access
 the rest of the connection properties.
 


nextToken
String nextToken

 A continuation token, if this is a continuation call.
 


maxResults
Integer maxResults

 The maximum number of connections to return in one response.
 








Class com.amazonaws.services.glue.model.GetConnectionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectionList
List<E> connectionList

 A list of requested connection definitions.
 


nextToken
String nextToken

 A continuation token, if the list of connections returned does not include the last of the filtered connections.
 








Class com.amazonaws.services.glue.model.GetCrawlerMetricsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


crawlerNameList
List<E> crawlerNameList

 A list of the names of crawlers about which to retrieve metrics.
 


maxResults
Integer maxResults

 The maximum size of a list to return.
 


nextToken
String nextToken

 A continuation token, if this is a continuation call.
 








Class com.amazonaws.services.glue.model.GetCrawlerMetricsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


crawlerMetricsList
List<E> crawlerMetricsList

 A list of metrics for the specified crawler.
 


nextToken
String nextToken

 A continuation token, if the returned list does not contain the last metric available.
 








Class com.amazonaws.services.glue.model.GetCrawlerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the crawler to retrieve metadata for.
 








Class com.amazonaws.services.glue.model.GetCrawlerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


crawler
Crawler crawler

 The metadata for the specified crawler.
 








Class com.amazonaws.services.glue.model.GetCrawlersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The number of crawlers to return on each call.
 


nextToken
String nextToken

 A continuation token, if this is a continuation request.
 








Class com.amazonaws.services.glue.model.GetCrawlersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


crawlers
List<E> crawlers

 A list of crawler metadata.
 


nextToken
String nextToken

 A continuation token, if the returned list has not reached the end of those defined in this customer account.
 








Class com.amazonaws.services.glue.model.GetDatabaseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog in which the database resides. If none is provided, the AWS account ID is used by
 default.
 


name
String name

 The name of the database to retrieve. For Hive compatibility, this should be all lowercase.
 








Class com.amazonaws.services.glue.model.GetDatabaseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


database
Database database

 The definition of the specified database in the Data Catalog.
 








Class com.amazonaws.services.glue.model.GetDatabasesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog from which to retrieve Databases. If none is provided, the AWS account ID
 is used by default.
 


nextToken
String nextToken

 A continuation token, if this is a continuation call.
 


maxResults
Integer maxResults

 The maximum number of databases to return in one response.
 








Class com.amazonaws.services.glue.model.GetDatabasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


databaseList
List<E> databaseList

 A list of Database objects from the specified catalog.
 


nextToken
String nextToken

 A continuation token for paginating the returned list of tokens, returned if the current segment of the list is
 not the last.
 








Class com.amazonaws.services.glue.model.GetDataCatalogEncryptionSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog to retrieve the security configuration for. If none is provided, the AWS account ID is
 used by default.
 








Class com.amazonaws.services.glue.model.GetDataCatalogEncryptionSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataCatalogEncryptionSettings
DataCatalogEncryptionSettings dataCatalogEncryptionSettings

 The requested security configuration.
 








Class com.amazonaws.services.glue.model.GetDataflowGraphRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pythonScript
String pythonScript

 The Python script to transform.
 








Class com.amazonaws.services.glue.model.GetDataflowGraphResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dagNodes
List<E> dagNodes

 A list of the nodes in the resulting DAG.
 


dagEdges
List<E> dagEdges

 A list of the edges in the resulting DAG.
 








Class com.amazonaws.services.glue.model.GetDevEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointName
String endpointName

 Name of the DevEndpoint to retrieve information for.
 








Class com.amazonaws.services.glue.model.GetDevEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devEndpoint
DevEndpoint devEndpoint

 A DevEndpoint definition.
 








Class com.amazonaws.services.glue.model.GetDevEndpointsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum size of information to return.
 


nextToken
String nextToken

 A continuation token, if this is a continuation call.
 








Class com.amazonaws.services.glue.model.GetDevEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devEndpoints
List<E> devEndpoints

 A list of DevEndpoint definitions.
 


nextToken
String nextToken

 A continuation token, if not all DevEndpoint definitions have yet been returned.
 








Class com.amazonaws.services.glue.model.GetJobBookmarkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job in question.
 


runId
String runId

 The unique run identifier associated with this job run.
 








Class com.amazonaws.services.glue.model.GetJobBookmarkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobBookmarkEntry
JobBookmarkEntry jobBookmarkEntry

 A structure that defines a point that a job can resume processing.
 








Class com.amazonaws.services.glue.model.GetJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job definition to retrieve.
 








Class com.amazonaws.services.glue.model.GetJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


job
Job job

 The requested job definition.
 








Class com.amazonaws.services.glue.model.GetJobRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 Name of the job definition being run.
 


runId
String runId

 The ID of the job run.
 


predecessorsIncluded
Boolean predecessorsIncluded

 True if a list of predecessor runs should be returned.
 








Class com.amazonaws.services.glue.model.GetJobRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobRun
JobRun jobRun

 The requested job-run metadata.
 








Class com.amazonaws.services.glue.model.GetJobRunsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job definition for which to retrieve all job runs.
 


nextToken
String nextToken

 A continuation token, if this is a continuation call.
 


maxResults
Integer maxResults

 The maximum size of the response.
 








Class com.amazonaws.services.glue.model.GetJobRunsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobRuns
List<E> jobRuns

 A list of job-run metadata objects.
 


nextToken
String nextToken

 A continuation token, if not all requested job runs have been returned.
 








Class com.amazonaws.services.glue.model.GetJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A continuation token, if this is a continuation call.
 


maxResults
Integer maxResults

 The maximum size of the response.
 








Class com.amazonaws.services.glue.model.GetJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobs
List<E> jobs

 A list of job definitions.
 


nextToken
String nextToken

 A continuation token, if not all job definitions have yet been returned.
 








Class com.amazonaws.services.glue.model.GetMappingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


source
CatalogEntry source

 Specifies the source table.
 


sinks
List<E> sinks

 A list of target tables.
 


location
Location location

 Parameters for the mapping.
 








Class com.amazonaws.services.glue.model.GetMappingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


mapping
List<E> mapping

 A list of mappings to the specified targets.
 








Class com.amazonaws.services.glue.model.GetMLTaskRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the machine learning transform.
 


taskRunId
String taskRunId

 The unique identifier of the task run.
 








Class com.amazonaws.services.glue.model.GetMLTaskRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the task run.
 


taskRunId
String taskRunId

 The unique run identifier associated with this run.
 


status
String status

 The status for this task run.
 


logGroupName
String logGroupName

 The names of the log groups that are associated with the task run.
 


properties
TaskRunProperties properties

 The list of properties that are associated with the task run.
 


errorString
String errorString

 The error strings that are associated with the task run.
 


startedOn
Date startedOn

 The date and time when this task run started.
 


lastModifiedOn
Date lastModifiedOn

 The date and time when this task run was last modified.
 


completedOn
Date completedOn

 The date and time when this task run was completed.
 


executionTime
Integer executionTime

 The amount of time (in seconds) that the task run consumed resources.
 








Class com.amazonaws.services.glue.model.GetMLTaskRunsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the machine learning transform.
 


nextToken
String nextToken

 A token for pagination of the results. The default is empty.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 


filter
TaskRunFilterCriteria filter

 The filter criteria, in the TaskRunFilterCriteria structure, for the task run.
 


sort
TaskRunSortCriteria sort

 The sorting criteria, in the TaskRunSortCriteria structure, for the task run.
 








Class com.amazonaws.services.glue.model.GetMLTaskRunsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskRuns
List<E> taskRuns

 A list of task runs that are associated with the transform.
 


nextToken
String nextToken

 A pagination token, if more results are available.
 








Class com.amazonaws.services.glue.model.GetMLTransformRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the transform, generated at the time that the transform was created.
 








Class com.amazonaws.services.glue.model.GetMLTransformResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the transform, generated at the time that the transform was created.
 


name
String name

 The unique name given to the transform when it was created.
 


description
String description

 A description of the transform.
 


status
String status

 The last known status of the transform (to indicate whether it can be used or not). One of "NOT_READY", "READY",
 or "DELETING".
 


createdOn
Date createdOn

 The date and time when the transform was created.
 


lastModifiedOn
Date lastModifiedOn

 The date and time when the transform was last modified.
 


inputRecordTables
List<E> inputRecordTables

 A list of AWS Glue table definitions used by the transform.
 


parameters
TransformParameters parameters

 The configuration parameters that are specific to the algorithm used.
 


evaluationMetrics
EvaluationMetrics evaluationMetrics

 The latest evaluation metrics.
 


labelCount
Integer labelCount

 The number of labels available for this transform.
 


schema
List<E> schema

 The Map<Column, Type> object that represents the schema that this transform accepts. Has an
 upper bound of 100 columns.
 


role
String role

 The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
 


glueVersion
String glueVersion

 This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is
 recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more
 information, see AWS Glue Versions
 in the developer guide.
 


maxCapacity
Double maxCapacity

 The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can
 allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of
 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.
 
 
 When the WorkerType field is set to a value other than Standard, the
 MaxCapacity field is set automatically and becomes read-only.
 


workerType
String workerType

 The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
 
 
 
 
 For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2
 executors per worker.
 
 
 
 
 For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1
 executor per worker.
 
 
 
 
 For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1
 executor per worker.
 
 
 


numberOfWorkers
Integer numberOfWorkers

 The number of workers of a defined workerType that are allocated when this task runs.
 


timeout
Integer timeout

 The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this
 transform can consume resources before it is terminated and enters TIMEOUT status. The default is
 2,880 minutes (48 hours).
 


maxRetries
Integer maxRetries

 The maximum number of times to retry a task for this transform after a task run fails.
 








Class com.amazonaws.services.glue.model.GetMLTransformsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A paginated token to offset the results.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 


filter
TransformFilterCriteria filter

 The filter transformation criteria.
 


sort
TransformSortCriteria sort

 The sorting criteria.
 








Class com.amazonaws.services.glue.model.GetMLTransformsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transforms
List<E> transforms

 A list of machine learning transforms.
 


nextToken
String nextToken

 A pagination token, if more results are available.
 








Class com.amazonaws.services.glue.model.GetPartitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the partition in question resides. If none is provided, the AWS account ID is
 used by default.
 


databaseName
String databaseName

 The name of the catalog database where the partition resides.
 


tableName
String tableName

 The name of the partition's table.
 


partitionValues
List<E> partitionValues

 The values that define the partition.
 








Class com.amazonaws.services.glue.model.GetPartitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


partition
Partition partition

 The requested information, in the form of a Partition object.
 








Class com.amazonaws.services.glue.model.GetPartitionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the partitions in question reside. If none is provided, the AWS account ID is
 used by default.
 


databaseName
String databaseName

 The name of the catalog database where the partitions reside.
 


tableName
String tableName

 The name of the partitions' table.
 


expression
String expression

 An expression that filters the partitions to be returned.
 
 
 The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression.
 
 
 Operators: The following are the operators that you can use in the Expression API call:
 
 
 =
 
 
 Checks whether the values of the two operands are equal; if yes, then the condition becomes true.
 
 
 Example: Assume 'variable a' holds 10 and 'variable b' holds 20.
 
 
 (a = b) is not true.
 
 
 < >
 
 
 Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes
 true.
 
 
 Example: (a < > b) is true.
 
 
 >
 
 
 Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the
 condition becomes true.
 
 
 Example: (a > b) is not true.
 
 
 <
 
 
 Checks whether the value of the left operand is less than the value of the right operand; if yes, then the
 condition becomes true.
 
 
 Example: (a < b) is true.
 
 
 >=
 
 
 Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes,
 then the condition becomes true.
 
 
 Example: (a >= b) is not true.
 
 
 <=
 
 
 Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes,
 then the condition becomes true.
 
 
 Example: (a <= b) is true.
 
 
 AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL
 
 
 Logical operators.
 
 
 
 
 Supported Partition Key Types: The following are the supported partition keys.
 
 
 
 
 string
 
 
 
 
 date
 
 
 
 
 timestamp
 
 
 
 
 int
 
 
 
 
 bigint
 
 
 
 
 long
 
 
 
 
 tinyint
 
 
 
 
 smallint
 
 
 
 
 decimal
 
 
 
 
 If an invalid type is encountered, an exception is thrown.
 
 
 The following list shows the valid operators on each type. When you define a crawler, the
 partitionKey type is created as a STRING, to be compatible with the catalog partitions.
 
 
 Sample API Call:
 


nextToken
String nextToken

 A continuation token, if this is not the first call to retrieve these partitions.
 


segment
Segment segment

 The segment of the table's partitions to scan in this request.
 


maxResults
Integer maxResults

 The maximum number of partitions to return in a single response.
 








Class com.amazonaws.services.glue.model.GetPartitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


partitions
List<E> partitions

 A list of requested partitions.
 


nextToken
String nextToken

 A continuation token, if the returned list of partitions does not include the last one.
 








Class com.amazonaws.services.glue.model.GetPlanRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mapping
List<E> mapping

 The list of mappings from a source table to target tables.
 


source
CatalogEntry source

 The source table.
 


sinks
List<E> sinks

 The target tables.
 


location
Location location

 The parameters for the mapping.
 


language
String language

 The programming language of the code to perform the mapping.
 








Class com.amazonaws.services.glue.model.GetPlanResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pythonScript
String pythonScript

 A Python script to perform the mapping.
 


scalaCode
String scalaCode

 The Scala code to perform the mapping.
 








Class com.amazonaws.services.glue.model.GetResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.glue.model.GetResourcePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyInJson
String policyInJson

 Contains the requested policy document, in JSON format.
 


policyHash
String policyHash

 Contains the hash value associated with this policy.
 


createTime
Date createTime

 The date and time at which the policy was created.
 


updateTime
Date updateTime

 The date and time at which the policy was last updated.
 








Class com.amazonaws.services.glue.model.GetSecurityConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the security configuration to retrieve.
 








Class com.amazonaws.services.glue.model.GetSecurityConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityConfiguration
SecurityConfiguration securityConfiguration

 The requested security configuration.
 








Class com.amazonaws.services.glue.model.GetSecurityConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results to return.
 


nextToken
String nextToken

 A continuation token, if this is a continuation call.
 








Class com.amazonaws.services.glue.model.GetSecurityConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityConfigurations
List<E> securityConfigurations

 A list of security configurations.
 


nextToken
String nextToken

 A continuation token, if there are more security configurations to return.
 








Class com.amazonaws.services.glue.model.GetTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.
 


databaseName
String databaseName

 The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely
 lowercase.
 


name
String name

 The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely
 lowercase.
 








Class com.amazonaws.services.glue.model.GetTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


table
Table table

 The Table object that defines the specified table.
 








Class com.amazonaws.services.glue.model.GetTablesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.
 


databaseName
String databaseName

 The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.
 


expression
String expression

 A regular expression pattern. If present, only those tables whose names match the pattern are returned.
 


nextToken
String nextToken

 A continuation token, included if this is a continuation call.
 


maxResults
Integer maxResults

 The maximum number of tables to return in a single response.
 








Class com.amazonaws.services.glue.model.GetTablesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableList
List<E> tableList

 A list of the requested Table objects.
 


nextToken
String nextToken

 A continuation token, present if the current list segment is not the last.
 








Class com.amazonaws.services.glue.model.GetTableVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.
 


databaseName
String databaseName

 The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
 


tableName
String tableName

 The name of the table. For Hive compatibility, this name is entirely lowercase.
 


versionId
String versionId

 The ID value of the table version to be retrieved. A VersionID is a string representation of an
 integer. Each version is incremented by 1.
 








Class com.amazonaws.services.glue.model.GetTableVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableVersion
TableVersion tableVersion

 The requested table version.
 








Class com.amazonaws.services.glue.model.GetTableVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.
 


databaseName
String databaseName

 The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.
 


tableName
String tableName

 The name of the table. For Hive compatibility, this name is entirely lowercase.
 


nextToken
String nextToken

 A continuation token, if this is not the first call.
 


maxResults
Integer maxResults

 The maximum number of table versions to return in one response.
 








Class com.amazonaws.services.glue.model.GetTableVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tableVersions
List<E> tableVersions

 A list of strings identifying available versions of the specified table.
 


nextToken
String nextToken

 A continuation token, if the list of available versions does not include the last one.
 








Class com.amazonaws.services.glue.model.GetTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource for which to retrieve tags.
 








Class com.amazonaws.services.glue.model.GetTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The requested tags.
 








Class com.amazonaws.services.glue.model.GetTriggerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the trigger to retrieve.
 








Class com.amazonaws.services.glue.model.GetTriggerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trigger
Trigger trigger

 The requested trigger definition.
 








Class com.amazonaws.services.glue.model.GetTriggersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A continuation token, if this is a continuation call.
 


dependentJobName
String dependentJobName

 The name of the job to retrieve triggers for. The trigger that can start this job is returned, and if there is no
 such trigger, all triggers are returned.
 


maxResults
Integer maxResults

 The maximum size of the response.
 








Class com.amazonaws.services.glue.model.GetTriggersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


triggers
List<E> triggers

 A list of triggers for the specified job.
 


nextToken
String nextToken

 A continuation token, if not all the requested triggers have yet been returned.
 








Class com.amazonaws.services.glue.model.GetUserDefinedFunctionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the function to be retrieved is located. If none is provided, the AWS account ID
 is used by default.
 


databaseName
String databaseName

 The name of the catalog database where the function is located.
 


functionName
String functionName

 The name of the function.
 








Class com.amazonaws.services.glue.model.GetUserDefinedFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userDefinedFunction
UserDefinedFunction userDefinedFunction

 The requested function definition.
 








Class com.amazonaws.services.glue.model.GetUserDefinedFunctionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the functions to be retrieved are located. If none is provided, the AWS account
 ID is used by default.
 


databaseName
String databaseName

 The name of the catalog database where the functions are located.
 


pattern
String pattern

 An optional function-name pattern string that filters the function definitions returned.
 


nextToken
String nextToken

 A continuation token, if this is a continuation call.
 


maxResults
Integer maxResults

 The maximum number of functions to return in one response.
 








Class com.amazonaws.services.glue.model.GetUserDefinedFunctionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userDefinedFunctions
List<E> userDefinedFunctions

 A list of requested function definitions.
 


nextToken
String nextToken

 A continuation token, if the list of functions returned does not include the last requested function.
 








Class com.amazonaws.services.glue.model.GetWorkflowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the workflow to retrieve.
 


includeGraph
Boolean includeGraph

 Specifies whether to include a graph when returning the workflow resource metadata.
 








Class com.amazonaws.services.glue.model.GetWorkflowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


workflow
Workflow workflow

 The resource metadata for the workflow.
 








Class com.amazonaws.services.glue.model.GetWorkflowRunPropertiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the workflow which was run.
 


runId
String runId

 The ID of the workflow run whose run properties should be returned.
 








Class com.amazonaws.services.glue.model.GetWorkflowRunPropertiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


runProperties
Map<K,V> runProperties

 The workflow run properties which were set during the specified run.
 








Class com.amazonaws.services.glue.model.GetWorkflowRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the workflow being run.
 


runId
String runId

 The ID of the workflow run.
 


includeGraph
Boolean includeGraph

 Specifies whether to include the workflow graph in response or not.
 








Class com.amazonaws.services.glue.model.GetWorkflowRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


run
WorkflowRun run

 The requested workflow run metadata.
 








Class com.amazonaws.services.glue.model.GetWorkflowRunsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the workflow whose metadata of runs should be returned.
 


includeGraph
Boolean includeGraph

 Specifies whether to include the workflow graph in response or not.
 


nextToken
String nextToken

 The maximum size of the response.
 


maxResults
Integer maxResults

 The maximum number of workflow runs to be included in the response.
 








Class com.amazonaws.services.glue.model.GetWorkflowRunsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


runs
List<E> runs

 A list of workflow run metadata objects.
 


nextToken
String nextToken

 A continuation token, if not all requested workflow runs have been returned.
 








Class com.amazonaws.services.glue.model.GlueEncryptionException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.GlueTable extends Object implements Serializable


Serialized Fields


databaseName
String databaseName

 A database name in the AWS Glue Data Catalog.
 


tableName
String tableName

 A table name in the AWS Glue Data Catalog.
 


catalogId
String catalogId

 A unique identifier for the AWS Glue Data Catalog.
 


connectionName
String connectionName

 The name of the connection to the AWS Glue Data Catalog.
 








Class com.amazonaws.services.glue.model.GrokClassifier extends Object implements Serializable


Serialized Fields


name
String name

 The name of the classifier.
 


classification
String classification

 An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.
 


creationTime
Date creationTime

 The time that this classifier was registered.
 


lastUpdated
Date lastUpdated

 The time that this classifier was last updated.
 


version
Long version

 The version of this classifier.
 


grokPattern
String grokPattern

 The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers.
 


customPatterns
String customPatterns

 Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.
 








Class com.amazonaws.services.glue.model.IdempotentParameterMismatchException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.ImportCatalogToGlueRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the catalog to import. Currently, this should be the AWS account ID.
 








Class com.amazonaws.services.glue.model.ImportCatalogToGlueResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.ImportLabelsTaskRunProperties extends Object implements Serializable


Serialized Fields


inputS3Path
String inputS3Path

 The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.
 


replace
Boolean replace

 Indicates whether to overwrite your existing labels.
 








Class com.amazonaws.services.glue.model.InternalServiceException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.InvalidInputException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.JdbcTarget extends Object implements Serializable


Serialized Fields


connectionName
String connectionName

 The name of the connection to use to connect to the JDBC target.
 


path
String path

 The path of the JDBC target.
 


exclusions
List<E> exclusions

 A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
 








Class com.amazonaws.services.glue.model.Job extends Object implements Serializable


Serialized Fields


name
String name

 The name you assign to this job definition.
 


description
String description

 A description of the job.
 


logUri
String logUri

 This field is reserved for future use.
 


role
String role

 The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
 


createdOn
Date createdOn

 The time and date that this job definition was created.
 


lastModifiedOn
Date lastModifiedOn

 The last point in time when this job definition was modified.
 


executionProperty
ExecutionProperty executionProperty

 An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
 


command
JobCommand command

 The JobCommand that executes this job.
 


defaultArguments
Map<K,V> defaultArguments

 The default arguments for this job, specified as name-value pairs.
 
 
 You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue
 itself consumes.
 
 
 For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs
 in Python topic in the developer guide.
 
 
 For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters
 Used by AWS Glue topic in the developer guide.
 


connections
ConnectionsList connections

 The connections used for this job.
 


maxRetries
Integer maxRetries

 The maximum number of times to retry this job after a JobRun fails.
 


allocatedCapacity
Integer allocatedCapacity
Deprecated. 

 This field is deprecated. Use MaxCapacity instead.
 
 
 The number of AWS Glue data processing units (DPUs) allocated to runs of this job. You can allocate from 2 to 100
 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute
 capacity and 16 GB of memory. For more information, see the AWS
 Glue pricing page.
 
 


timeout
Integer timeout

 The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated
 and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
 


maxCapacity
Double maxCapacity

 The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative
 measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more
 information, see the AWS Glue pricing page.
 
 
 Do not set Max Capacity if using WorkerType and NumberOfWorkers.
 
 
 The value that can be allocated for MaxCapacity depends on whether you are running a Python shell
 job or an Apache Spark ETL job:
 
 
 
 
 When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625
 or 1 DPU. The default is 0.0625 DPU.
 
 
 
 
 When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100
 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
 
 
 


workerType
String workerType

 The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
 
 
 
 
 For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2
 executors per worker.
 
 
 
 
 For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and
 provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
 
 
 
 
 For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and
 provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
 
 
 


numberOfWorkers
Integer numberOfWorkers

 The number of workers of a defined workerType that are allocated when a job runs.
 
 
 The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
 


securityConfiguration
String securityConfiguration

 The name of the SecurityConfiguration structure to be used with this job.
 


notificationProperty
NotificationProperty notificationProperty

 Specifies configuration properties of a job notification.
 


glueVersion
String glueVersion

 Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version
 indicates the version supported for jobs of type Spark.
 
 
 For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
 
 
 Jobs that are created without specifying a Glue version default to Glue 0.9.
 








Class com.amazonaws.services.glue.model.JobBookmarkEntry extends Object implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job in question.
 


version
Integer version

 The version of the job.
 


run
Integer run

 The run ID number.
 


attempt
Integer attempt

 The attempt ID number.
 


previousRunId
String previousRunId

 The unique run identifier associated with the previous job run.
 


runId
String runId

 The run ID number.
 


jobBookmark
String jobBookmark

 The bookmark itself.
 








Class com.amazonaws.services.glue.model.JobBookmarksEncryption extends Object implements Serializable


Serialized Fields


jobBookmarksEncryptionMode
String jobBookmarksEncryptionMode

 The encryption mode to use for job bookmarks data.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
 








Class com.amazonaws.services.glue.model.JobCommand extends Object implements Serializable


Serialized Fields


name
String name

 The name of the job command. For an Apache Spark ETL job, this must be glueetl. For a Python shell
 job, it must be pythonshell.
 


scriptLocation
String scriptLocation

 Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a job.
 


pythonVersion
String pythonVersion

 The Python version being used to execute a Python shell job. Allowed values are 2 or 3.
 








Class com.amazonaws.services.glue.model.JobNodeDetails extends Object implements Serializable


Serialized Fields


jobRuns
List<E> jobRuns

 The information for the job runs represented by the job node.
 








Class com.amazonaws.services.glue.model.JobRun extends Object implements Serializable


Serialized Fields


id
String id

 The ID of this job run.
 


attempt
Integer attempt

 The number of the attempt to run this job.
 


previousRunId
String previousRunId

 The ID of the previous run of this job. For example, the JobRunId specified in the
 StartJobRun action.
 


triggerName
String triggerName

 The name of the trigger that started this job run.
 


jobName
String jobName

 The name of the job definition being used in this run.
 


startedOn
Date startedOn

 The date and time at which this job run was started.
 


lastModifiedOn
Date lastModifiedOn

 The last time that this job run was modified.
 


completedOn
Date completedOn

 The date and time that this job run completed.
 


jobRunState
String jobRunState

 The current state of the job run.
 


arguments
Map<K,V> arguments

 The job arguments associated with this run. For this job run, they replace the default arguments set in the job
 definition itself.
 
 
 You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue
 itself consumes.
 
 
 For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs
 in Python topic in the developer guide.
 
 
 For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters
 Used by AWS Glue topic in the developer guide.
 


errorMessage
String errorMessage

 An error message associated with this job run.
 


predecessorRuns
List<E> predecessorRuns

 A list of predecessors to this job run.
 


allocatedCapacity
Integer allocatedCapacity
Deprecated. 

 This field is deprecated. Use MaxCapacity instead.
 
 
 The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be
 allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute
 capacity and 16 GB of memory. For more information, see the AWS
 Glue pricing page.
 


executionTime
Integer executionTime

 The amount of time (in seconds) that the job run consumed resources.
 


timeout
Integer timeout

 The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before
 it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides
 the timeout value set in the parent job.
 


maxCapacity
Double maxCapacity

 The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative
 measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more
 information, see the AWS Glue pricing
 page.
 
 
 Do not set Max Capacity if using WorkerType and NumberOfWorkers.
 
 
 The value that can be allocated for MaxCapacity depends on whether you are running a Python shell
 job or an Apache Spark ETL job:
 
 
 
 
 When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625
 or 1 DPU. The default is 0.0625 DPU.
 
 
 
 
 When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100
 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
 
 
 


workerType
String workerType

 The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
 
 
 
 
 For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2
 executors per worker.
 
 
 
 
 For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1
 executor per worker.
 
 
 
 
 For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1
 executor per worker.
 
 
 


numberOfWorkers
Integer numberOfWorkers

 The number of workers of a defined workerType that are allocated when a job runs.
 
 
 The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
 


securityConfiguration
String securityConfiguration

 The name of the SecurityConfiguration structure to be used with this job run.
 


logGroupName
String logGroupName

 The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS
 KMS. This name can be /aws-glue/jobs/, in which case the default encryption is NONE. If
 you add a role name and SecurityConfiguration name (in other words,
 /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security configuration is
 used to encrypt the log group.
 


notificationProperty
NotificationProperty notificationProperty

 Specifies configuration properties of a job run notification.
 


glueVersion
String glueVersion

 Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version
 indicates the version supported for jobs of type Spark.
 
 
 For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
 
 
 Jobs that are created without specifying a Glue version default to Glue 0.9.
 








Class com.amazonaws.services.glue.model.JobUpdate extends Object implements Serializable


Serialized Fields


description
String description

 Description of the job being defined.
 


logUri
String logUri

 This field is reserved for future use.
 


role
String role

 The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).
 


executionProperty
ExecutionProperty executionProperty

 An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.
 


command
JobCommand command

 The JobCommand that executes this job (required).
 


defaultArguments
Map<K,V> defaultArguments

 The default arguments for this job.
 
 
 You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue
 itself consumes.
 
 
 For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs
 in Python topic in the developer guide.
 
 
 For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters
 Used by AWS Glue topic in the developer guide.
 


connections
ConnectionsList connections

 The connections used for this job.
 


maxRetries
Integer maxRetries

 The maximum number of times to retry this job if it fails.
 


allocatedCapacity
Integer allocatedCapacity
Deprecated. 

 This field is deprecated. Use MaxCapacity instead.
 
 
 The number of AWS Glue data processing units (DPUs) to allocate to this job. You can allocate from 2 to 100 DPUs;
 the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity
 and 16 GB of memory. For more information, see the AWS Glue
 pricing page.
 


timeout
Integer timeout

 The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated
 and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
 


maxCapacity
Double maxCapacity

 The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative
 measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more
 information, see the AWS Glue pricing page.
 
 
 Do not set Max Capacity if using WorkerType and NumberOfWorkers.
 
 
 The value that can be allocated for MaxCapacity depends on whether you are running a Python shell
 job or an Apache Spark ETL job:
 
 
 
 
 When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625
 or 1 DPU. The default is 0.0625 DPU.
 
 
 
 
 When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100
 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
 
 
 


workerType
String workerType

 The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
 
 
 
 
 For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2
 executors per worker.
 
 
 
 
 For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and
 provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
 
 
 
 
 For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and
 provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
 
 
 


numberOfWorkers
Integer numberOfWorkers

 The number of workers of a defined workerType that are allocated when a job runs.
 
 
 The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
 


securityConfiguration
String securityConfiguration

 The name of the SecurityConfiguration structure to be used with this job.
 


notificationProperty
NotificationProperty notificationProperty

 Specifies the configuration properties of a job notification.
 


glueVersion
String glueVersion

 Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version
 indicates the version supported for jobs of type Spark.
 
 
 For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
 








Class com.amazonaws.services.glue.model.JsonClassifier extends Object implements Serializable


Serialized Fields


name
String name

 The name of the classifier.
 


creationTime
Date creationTime

 The time that this classifier was registered.
 


lastUpdated
Date lastUpdated

 The time that this classifier was last updated.
 


version
Long version

 The version of this classifier.
 


jsonPath
String jsonPath

 A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset
 of JsonPath, as described in Writing JsonPath
 Custom Classifiers.
 








Class com.amazonaws.services.glue.model.LabelingSetGenerationTaskRunProperties extends Object implements Serializable


Serialized Fields


outputS3Path
String outputS3Path

 The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.
 








Class com.amazonaws.services.glue.model.LastCrawlInfo extends Object implements Serializable


Serialized Fields


status
String status

 Status of the last crawl.
 


errorMessage
String errorMessage

 If an error occurred, the error information about the last crawl.
 


logGroup
String logGroup

 The log group for the last crawl.
 


logStream
String logStream

 The log stream for the last crawl.
 


messagePrefix
String messagePrefix

 The prefix for a message about this crawl.
 


startTime
Date startTime

 The time at which the crawl started.
 








Class com.amazonaws.services.glue.model.ListCrawlersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum size of a list to return.
 


nextToken
String nextToken

 A continuation token, if this is a continuation request.
 


tags
Map<K,V> tags

 Specifies to return only these tagged resources.
 








Class com.amazonaws.services.glue.model.ListCrawlersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


crawlerNames
List<E> crawlerNames

 The names of all crawlers in the account, or the crawlers with the specified tags.
 


nextToken
String nextToken

 A continuation token, if the returned list does not contain the last metric available.
 








Class com.amazonaws.services.glue.model.ListDevEndpointsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A continuation token, if this is a continuation request.
 


maxResults
Integer maxResults

 The maximum size of a list to return.
 


tags
Map<K,V> tags

 Specifies to return only these tagged resources.
 








Class com.amazonaws.services.glue.model.ListDevEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devEndpointNames
List<E> devEndpointNames

 The names of all the DevEndpoints in the account, or the DevEndpoints with the
 specified tags.
 


nextToken
String nextToken

 A continuation token, if the returned list does not contain the last metric available.
 








Class com.amazonaws.services.glue.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A continuation token, if this is a continuation request.
 


maxResults
Integer maxResults

 The maximum size of a list to return.
 


tags
Map<K,V> tags

 Specifies to return only these tagged resources.
 








Class com.amazonaws.services.glue.model.ListJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobNames
List<E> jobNames

 The names of all jobs in the account, or the jobs with the specified tags.
 


nextToken
String nextToken

 A continuation token, if the returned list does not contain the last metric available.
 








Class com.amazonaws.services.glue.model.ListTriggersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A continuation token, if this is a continuation request.
 


dependentJobName
String dependentJobName

 The name of the job for which to retrieve triggers. The trigger that can start this job is returned. If there is
 no such trigger, all triggers are returned.
 


maxResults
Integer maxResults

 The maximum size of a list to return.
 


tags
Map<K,V> tags

 Specifies to return only these tagged resources.
 








Class com.amazonaws.services.glue.model.ListTriggersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


triggerNames
List<E> triggerNames

 The names of all triggers in the account, or the triggers with the specified tags.
 


nextToken
String nextToken

 A continuation token, if the returned list does not contain the last metric available.
 








Class com.amazonaws.services.glue.model.ListWorkflowsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A continuation token, if this is a continuation request.
 


maxResults
Integer maxResults

 The maximum size of a list to return.
 








Class com.amazonaws.services.glue.model.ListWorkflowsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


workflows
List<E> workflows

 List of names of workflows in the account.
 


nextToken
String nextToken

 A continuation token, if not all workflow names have been returned.
 








Class com.amazonaws.services.glue.model.Location extends Object implements Serializable


Serialized Fields


jdbc
List<E> jdbc

 A JDBC location.
 


s3
List<E> s3

 An Amazon Simple Storage Service (Amazon S3) location.
 


dynamoDB
List<E> dynamoDB

 An Amazon DynamoDB table location.
 








Class com.amazonaws.services.glue.model.MappingEntry extends Object implements Serializable


Serialized Fields


sourceTable
String sourceTable

 The name of the source table.
 


sourcePath
String sourcePath

 The source path.
 


sourceType
String sourceType

 The source type.
 


targetTable
String targetTable

 The target table.
 


targetPath
String targetPath

 The target path.
 


targetType
String targetType

 The target type.
 








Class com.amazonaws.services.glue.model.MLTransform extends Object implements Serializable


Serialized Fields


transformId
String transformId

 The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique
 and does not change.
 


name
String name

 A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any
 time.
 


description
String description

 A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to
 be unique and can be changed at any time.
 


status
String status

 The current status of the machine learning transform.
 


createdOn
Date createdOn

 A timestamp. The time and date that this machine learning transform was created.
 


lastModifiedOn
Date lastModifiedOn

 A timestamp. The last point in time when this machine learning transform was modified.
 


inputRecordTables
List<E> inputRecordTables

 A list of AWS Glue table definitions used by the transform.
 


parameters
TransformParameters parameters

 A TransformParameters object. You can use parameters to tune (customize) the behavior of the machine
 learning transform by specifying what data it learns from and your preference on various tradeoffs (such as
 precious vs. recall, or accuracy vs. cost).
 


evaluationMetrics
EvaluationMetrics evaluationMetrics

 An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine
 learning transform.
 


labelCount
Integer labelCount

 A count identifier for the labeling files generated by AWS Glue for this transform. As you create a better
 transform, you can iteratively download, label, and upload the labeling file.
 


schema
List<E> schema

 A map of key-value pairs representing the columns and data types that this transform can run against. Has an
 upper bound of 100 columns.
 


role
String role

 The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. The required permissions
 include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the
 transform.
 
 
 
 
 This role needs AWS Glue service role permissions to allow access to resources in AWS Glue. See Attach a Policy to IAM Users That
 Access AWS Glue.
 
 
 
 
 This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary
 directory, scripts, and any libraries used by the task run for this transform.
 
 
 


glueVersion
String glueVersion

 This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is
 recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more
 information, see AWS Glue Versions
 in the developer guide.
 


maxCapacity
Double maxCapacity

 The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can
 allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of
 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.
 
 
 MaxCapacity is a mutually exclusive option with NumberOfWorkers and
 WorkerType.
 
 
 
 
 If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be
 set.
 
 
 
 
 If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be
 set.
 
 
 
 
 If WorkerType is set, then NumberOfWorkers is required (and vice versa).
 
 
 
 
 MaxCapacity and NumberOfWorkers must both be at least 1.
 
 
 
 
 When the WorkerType field is set to a value other than Standard, the
 MaxCapacity field is set automatically and becomes read-only.
 


workerType
String workerType

 The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard,
 G.1X, or G.2X.
 
 
 
 
 For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2
 executors per worker.
 
 
 
 
 For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1
 executor per worker.
 
 
 
 
 For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1
 executor per worker.
 
 
 
 
 MaxCapacity is a mutually exclusive option with NumberOfWorkers and
 WorkerType.
 
 
 
 
 If either NumberOfWorkers or WorkerType is set, then MaxCapacity cannot be
 set.
 
 
 
 
 If MaxCapacity is set then neither NumberOfWorkers or WorkerType can be
 set.
 
 
 
 
 If WorkerType is set, then NumberOfWorkers is required (and vice versa).
 
 
 
 
 MaxCapacity and NumberOfWorkers must both be at least 1.
 
 
 


numberOfWorkers
Integer numberOfWorkers

 The number of workers of a defined workerType that are allocated when a task of the transform runs.
 
 
 If WorkerType is set, then NumberOfWorkers is required (and vice versa).
 


timeout
Integer timeout

 The timeout in minutes of the machine learning transform.
 


maxRetries
Integer maxRetries

 The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.
 








Class com.amazonaws.services.glue.model.MLTransformNotReadyException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.Node extends Object implements Serializable


Serialized Fields


type
String type

 The type of AWS Glue component represented by the node.
 


name
String name

 The name of the AWS Glue component represented by the node.
 


uniqueId
String uniqueId

 The unique Id assigned to the node within the workflow.
 


triggerDetails
TriggerNodeDetails triggerDetails

 Details of the Trigger when the node represents a Trigger.
 


jobDetails
JobNodeDetails jobDetails

 Details of the Job when the node represents a Job.
 


crawlerDetails
CrawlerNodeDetails crawlerDetails

 Details of the crawler when the node represents a crawler.
 








Class com.amazonaws.services.glue.model.NoScheduleException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.NotificationProperty extends Object implements Serializable


Serialized Fields


notifyDelayAfter
Integer notifyDelayAfter

 After a job run starts, the number of minutes to wait before sending a job run delay notification.
 








Class com.amazonaws.services.glue.model.OperationTimeoutException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.Order extends Object implements Serializable


Serialized Fields


column
String column

 The name of the column.
 


sortOrder
Integer sortOrder

 Indicates that the column is sorted in ascending order (== 1), or in descending order (
 ==0).
 








Class com.amazonaws.services.glue.model.Partition extends Object implements Serializable


Serialized Fields


values
List<E> values

 The values of the partition.
 


databaseName
String databaseName

 The name of the catalog database in which to create the partition.
 


tableName
String tableName

 The name of the database table in which to create the partition.
 


creationTime
Date creationTime

 The time at which the partition was created.
 


lastAccessTime
Date lastAccessTime

 The last time at which the partition was accessed.
 


storageDescriptor
StorageDescriptor storageDescriptor

 Provides information about the physical location where the partition is stored.
 


parameters
Map<K,V> parameters

 These key-value pairs define partition parameters.
 


lastAnalyzedTime
Date lastAnalyzedTime

 The last time at which column statistics were computed for this partition.
 








Class com.amazonaws.services.glue.model.PartitionError extends Object implements Serializable


Serialized Fields


partitionValues
List<E> partitionValues

 The values that define the partition.
 


errorDetail
ErrorDetail errorDetail

 The details about the partition error.
 








Class com.amazonaws.services.glue.model.PartitionInput extends Object implements Serializable


Serialized Fields


values
List<E> values

 The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter
 for a valid input.
 
 
 The values for the keys for the new partition must be passed as an array of String objects that must be ordered
 in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise AWS Glue will add the values
 to the wrong keys.
 


lastAccessTime
Date lastAccessTime

 The last time at which the partition was accessed.
 


storageDescriptor
StorageDescriptor storageDescriptor

 Provides information about the physical location where the partition is stored.
 


parameters
Map<K,V> parameters

 These key-value pairs define partition parameters.
 


lastAnalyzedTime
Date lastAnalyzedTime

 The last time at which column statistics were computed for this partition.
 








Class com.amazonaws.services.glue.model.PartitionValueList extends Object implements Serializable


Serialized Fields


values
List<E> values

 The list of values.
 








Class com.amazonaws.services.glue.model.PhysicalConnectionRequirements extends Object implements Serializable


Serialized Fields


subnetId
String subnetId

 The subnet ID used by the connection.
 


securityGroupIdList
List<E> securityGroupIdList

 The security group ID list used by the connection.
 


availabilityZone
String availabilityZone

 The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability
 Zone to be used. Currently the field must be populated, but it will be deprecated in the future.
 








Class com.amazonaws.services.glue.model.Predecessor extends Object implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job definition used by the predecessor job run.
 


runId
String runId

 The job-run ID of the predecessor job run.
 








Class com.amazonaws.services.glue.model.Predicate extends Object implements Serializable


Serialized Fields


logical
String logical

 An optional field if only one condition is listed. If multiple conditions are listed, then this field is
 required.
 


conditions
List<E> conditions

 A list of the conditions that determine when the trigger will fire.
 








Class com.amazonaws.services.glue.model.PrincipalPermissions extends Object implements Serializable


Serialized Fields


principal
DataLakePrincipal principal

 The principal who is granted permissions.
 


permissions
List<E> permissions

 The permissions that are granted to the principal.
 








Class com.amazonaws.services.glue.model.PropertyPredicate extends Object implements Serializable


Serialized Fields


key
String key

 The key of the property.
 


value
String value

 The value of the property.
 


comparator
String comparator

 The comparator used to compare this property to others.
 








Class com.amazonaws.services.glue.model.PutDataCatalogEncryptionSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used
 by default.
 


dataCatalogEncryptionSettings
DataCatalogEncryptionSettings dataCatalogEncryptionSettings

 The security configuration to set.
 








Class com.amazonaws.services.glue.model.PutDataCatalogEncryptionSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.PutResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyInJson
String policyInJson

 Contains the policy document to set, in JSON format.
 


policyHashCondition
String policyHashCondition

 The hash value returned when the previous policy was set using PutResourcePolicy. Its purpose is to
 prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.
 


policyExistsCondition
String policyExistsCondition

 A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to
 create a new policy. If a value of NONE or a null value is used, the call will not depend on the
 existence of a policy.
 








Class com.amazonaws.services.glue.model.PutResourcePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyHash
String policyHash

 A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or
 updates this policy.
 








Class com.amazonaws.services.glue.model.PutWorkflowRunPropertiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the workflow which was run.
 


runId
String runId

 The ID of the workflow run for which the run properties should be updated.
 


runProperties
Map<K,V> runProperties

 The properties to put for the specified run.
 








Class com.amazonaws.services.glue.model.PutWorkflowRunPropertiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.ResetJobBookmarkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job in question.
 


runId
String runId

 The unique run identifier associated with this job run.
 








Class com.amazonaws.services.glue.model.ResetJobBookmarkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobBookmarkEntry
JobBookmarkEntry jobBookmarkEntry

 The reset bookmark entry.
 








Class com.amazonaws.services.glue.model.ResourceNumberLimitExceededException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.ResourceUri extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of the resource.
 


uri
String uri

 The URI for accessing the resource.
 








Class com.amazonaws.services.glue.model.S3Encryption extends Object implements Serializable


Serialized Fields


s3EncryptionMode
String s3EncryptionMode

 The encryption mode to use for Amazon S3 data.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.
 








Class com.amazonaws.services.glue.model.S3Target extends Object implements Serializable


Serialized Fields


path
String path

 The path to the Amazon S3 target.
 


exclusions
List<E> exclusions

 A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.
 








Class com.amazonaws.services.glue.model.Schedule extends Object implements Serializable


Serialized Fields


scheduleExpression
String scheduleExpression

 A cron expression used to specify the schedule. For more information, see Time-Based Schedules for
 Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify
 cron(15 12 * * ? *).
 


state
String state

 The state of the schedule.
 








Class com.amazonaws.services.glue.model.SchedulerNotRunningException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.SchedulerRunningException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.SchedulerTransitioningException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.SchemaChangePolicy extends Object implements Serializable


Serialized Fields


updateBehavior
String updateBehavior

 The update behavior when the crawler finds a changed schema.
 


deleteBehavior
String deleteBehavior

 The deletion behavior when the crawler finds a deleted object.
 








Class com.amazonaws.services.glue.model.SchemaColumn extends Object implements Serializable


Serialized Fields


name
String name

 The name of the column.
 


dataType
String dataType

 The type of data in the column.
 








Class com.amazonaws.services.glue.model.SearchTablesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 A unique identifier, consisting of  account_id/datalake.
 


nextToken
String nextToken

 A continuation token, included if this is a continuation call.
 


filters
List<E> filters

 A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the
 predicate.
 


searchText
String searchText

 A string used for a text search.
 
 
 Specifying a value in quotes filters based on an exact match to the value.
 


sortCriteria
List<E> sortCriteria

 A list of criteria for sorting the results by a field name, in an ascending or descending order.
 


maxResults
Integer maxResults

 The maximum number of tables to return in a single response.
 








Class com.amazonaws.services.glue.model.SearchTablesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 A continuation token, present if the current list segment is not the last.
 


tableList
List<E> tableList

 A list of the requested Table objects. The SearchTables response returns only the
 tables that you have access to.
 








Class com.amazonaws.services.glue.model.SecurityConfiguration extends Object implements Serializable


Serialized Fields


name
String name

 The name of the security configuration.
 


createdTimeStamp
Date createdTimeStamp

 The time at which this security configuration was created.
 


encryptionConfiguration
EncryptionConfiguration encryptionConfiguration

 The encryption configuration associated with this security configuration.
 








Class com.amazonaws.services.glue.model.Segment extends Object implements Serializable


Serialized Fields


segmentNumber
Integer segmentNumber

 The zero-based index number of the segment. For example, if the total number of segments is 4,
 SegmentNumber values range from 0 through 3.
 


totalSegments
Integer totalSegments

 The total number of segments.
 








Class com.amazonaws.services.glue.model.SerDeInfo extends Object implements Serializable


Serialized Fields


name
String name

 Name of the SerDe.
 


serializationLibrary
String serializationLibrary

 Usually the class that implements the SerDe. An example is
 org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.
 


parameters
Map<K,V> parameters

 These key-value pairs define initialization parameters for the SerDe.
 








Class com.amazonaws.services.glue.model.SkewedInfo extends Object implements Serializable


Serialized Fields


skewedColumnNames
List<E> skewedColumnNames

 A list of names of columns that contain skewed values.
 


skewedColumnValues
List<E> skewedColumnValues

 A list of values that appear so frequently as to be considered skewed.
 


skewedColumnValueLocationMaps
Map<K,V> skewedColumnValueLocationMaps

 A mapping of skewed values to the columns that contain them.
 








Class com.amazonaws.services.glue.model.SortCriterion extends Object implements Serializable


Serialized Fields


fieldName
String fieldName

 The name of the field on which to sort.
 


sort
String sort

 An ascending or descending sort.
 








Class com.amazonaws.services.glue.model.StartCrawlerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the crawler to start.
 








Class com.amazonaws.services.glue.model.StartCrawlerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.StartCrawlerScheduleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


crawlerName
String crawlerName

 Name of the crawler to schedule.
 








Class com.amazonaws.services.glue.model.StartCrawlerScheduleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.StartExportLabelsTaskRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the machine learning transform.
 


outputS3Path
String outputS3Path

 The Amazon S3 path where you export the labels.
 








Class com.amazonaws.services.glue.model.StartExportLabelsTaskRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskRunId
String taskRunId

 The unique identifier for the task run.
 








Class com.amazonaws.services.glue.model.StartImportLabelsTaskRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the machine learning transform.
 


inputS3Path
String inputS3Path

 The Amazon Simple Storage Service (Amazon S3) path from where you import the labels.
 


replaceAllLabels
Boolean replaceAllLabels

 Indicates whether to overwrite your existing labels.
 








Class com.amazonaws.services.glue.model.StartImportLabelsTaskRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskRunId
String taskRunId

 The unique identifier for the task run.
 








Class com.amazonaws.services.glue.model.StartJobRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job definition to use.
 


jobRunId
String jobRunId

 The ID of a previous JobRun to retry.
 


arguments
Map<K,V> arguments

 The job arguments specifically for this run. For this job run, they replace the default arguments set in the job
 definition itself.
 
 
 You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue
 itself consumes.
 
 
 For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs
 in Python topic in the developer guide.
 
 
 For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters
 Used by AWS Glue topic in the developer guide.
 


allocatedCapacity
Integer allocatedCapacity
Deprecated. 

 This field is deprecated. Use MaxCapacity instead.
 
 
 The number of AWS Glue data processing units (DPUs) to allocate to this JobRun. From 2 to 100 DPUs can be
 allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute
 capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.
 


timeout
Integer timeout

 The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before
 it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides
 the timeout value set in the parent job.
 


maxCapacity
Double maxCapacity

 The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative
 measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more
 information, see the AWS Glue pricing
 page.
 
 
 Do not set Max Capacity if using WorkerType and NumberOfWorkers.
 
 
 The value that can be allocated for MaxCapacity depends on whether you are running a Python shell
 job, or an Apache Spark ETL job:
 
 
 
 
 When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625
 or 1 DPU. The default is 0.0625 DPU.
 
 
 
 
 When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100
 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
 
 
 


securityConfiguration
String securityConfiguration

 The name of the SecurityConfiguration structure to be used with this job run.
 


notificationProperty
NotificationProperty notificationProperty

 Specifies configuration properties of a job run notification.
 


workerType
String workerType

 The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.
 
 
 
 
 For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2
 executors per worker.
 
 
 
 
 For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1
 executor per worker.
 
 
 
 
 For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1
 executor per worker.
 
 
 


numberOfWorkers
Integer numberOfWorkers

 The number of workers of a defined workerType that are allocated when a job runs.
 
 
 The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.
 








Class com.amazonaws.services.glue.model.StartJobRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobRunId
String jobRunId

 The ID assigned to this job run.
 








Class com.amazonaws.services.glue.model.StartMLEvaluationTaskRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the machine learning transform.
 








Class com.amazonaws.services.glue.model.StartMLEvaluationTaskRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskRunId
String taskRunId

 The unique identifier associated with this run.
 








Class com.amazonaws.services.glue.model.StartMLLabelingSetGenerationTaskRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier of the machine learning transform.
 


outputS3Path
String outputS3Path

 The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling set.
 








Class com.amazonaws.services.glue.model.StartMLLabelingSetGenerationTaskRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskRunId
String taskRunId

 The unique run identifier that is associated with this task run.
 








Class com.amazonaws.services.glue.model.StartTriggerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the trigger to start.
 








Class com.amazonaws.services.glue.model.StartTriggerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the trigger that was started.
 








Class com.amazonaws.services.glue.model.StartWorkflowRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the workflow to start.
 








Class com.amazonaws.services.glue.model.StartWorkflowRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


runId
String runId

 An Id for the new run.
 








Class com.amazonaws.services.glue.model.StopCrawlerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the crawler to stop.
 








Class com.amazonaws.services.glue.model.StopCrawlerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.StopCrawlerScheduleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


crawlerName
String crawlerName

 Name of the crawler whose schedule state to set.
 








Class com.amazonaws.services.glue.model.StopCrawlerScheduleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.StopTriggerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the trigger to stop.
 








Class com.amazonaws.services.glue.model.StopTriggerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the trigger that was stopped.
 








Class com.amazonaws.services.glue.model.StorageDescriptor extends Object implements Serializable


Serialized Fields


columns
List<E> columns

 A list of the Columns in the table.
 


location
String location

 The physical location of the table. By default, this takes the form of the warehouse location, followed by the
 database location in the warehouse, followed by the table name.
 


inputFormat
String inputFormat

 The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom
 format.
 


outputFormat
String outputFormat

 The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or
 a custom format.
 


compressed
Boolean compressed

 True if the data in the table is compressed, or False if not.
 


numberOfBuckets
Integer numberOfBuckets

 Must be specified if the table contains any dimension columns.
 


serdeInfo
SerDeInfo serdeInfo

 The serialization/deserialization (SerDe) information.
 


bucketColumns
List<E> bucketColumns

 A list of reducer grouping columns, clustering columns, and bucketing columns in the table.
 


sortColumns
List<E> sortColumns

 A list specifying the sort order of each bucket in the table.
 


parameters
Map<K,V> parameters

 The user-supplied properties in key-value form.
 


skewedInfo
SkewedInfo skewedInfo

 The information about values that appear frequently in a column (skewed values).
 


storedAsSubDirectories
Boolean storedAsSubDirectories

 True if the table data is stored in subdirectories, or False if not.
 








Class com.amazonaws.services.glue.model.Table extends Object implements Serializable


Serialized Fields


name
String name

 The table name. For Hive compatibility, this must be entirely lowercase.
 


databaseName
String databaseName

 The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.
 


description
String description

 A description of the table.
 


owner
String owner

 The owner of the table.
 


createTime
Date createTime

 The time when the table definition was created in the Data Catalog.
 


updateTime
Date updateTime

 The last time that the table was updated.
 


lastAccessTime
Date lastAccessTime

 The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.
 


lastAnalyzedTime
Date lastAnalyzedTime

 The last time that column statistics were computed for this table.
 


retention
Integer retention

 The retention time for this table.
 


storageDescriptor
StorageDescriptor storageDescriptor

 A storage descriptor containing information about the physical storage of this table.
 


partitionKeys
List<E> partitionKeys

 A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
 
 
 When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at
 least set the value of partitionKeys to an empty list. For example:
 
 
 "PartitionKeys": []
 


viewOriginalText
String viewOriginalText

 If the table is a view, the original text of the view; otherwise null.
 


viewExpandedText
String viewExpandedText

 If the table is a view, the expanded text of the view; otherwise null.
 


tableType
String tableType

 The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
 


parameters
Map<K,V> parameters

 These key-value pairs define properties associated with the table.
 


createdBy
String createdBy

 The person or entity who created the table.
 


isRegisteredWithLakeFormation
Boolean isRegisteredWithLakeFormation

 Indicates whether the table has been registered with AWS Lake Formation.
 








Class com.amazonaws.services.glue.model.TableError extends Object implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table. For Hive compatibility, this must be entirely lowercase.
 


errorDetail
ErrorDetail errorDetail

 The details about the error.
 








Class com.amazonaws.services.glue.model.TableInput extends Object implements Serializable


Serialized Fields


name
String name

 The table name. For Hive compatibility, this is folded to lowercase when it is stored.
 


description
String description

 A description of the table.
 


owner
String owner

 The table owner.
 


lastAccessTime
Date lastAccessTime

 The last time that the table was accessed.
 


lastAnalyzedTime
Date lastAnalyzedTime

 The last time that column statistics were computed for this table.
 


retention
Integer retention

 The retention time for this table.
 


storageDescriptor
StorageDescriptor storageDescriptor

 A storage descriptor containing information about the physical storage of this table.
 


partitionKeys
List<E> partitionKeys

 A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.
 
 
 When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at
 least set the value of partitionKeys to an empty list. For example:
 
 
 "PartitionKeys": []
 


viewOriginalText
String viewOriginalText

 If the table is a view, the original text of the view; otherwise null.
 


viewExpandedText
String viewExpandedText

 If the table is a view, the expanded text of the view; otherwise null.
 


tableType
String tableType

 The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).
 


parameters
Map<K,V> parameters

 These key-value pairs define properties associated with the table.
 








Class com.amazonaws.services.glue.model.TableVersion extends Object implements Serializable


Serialized Fields


table
Table table

 The table in question.
 


versionId
String versionId

 The ID value that identifies this table version. A VersionId is a string representation of an
 integer. Each version is incremented by 1.
 








Class com.amazonaws.services.glue.model.TableVersionError extends Object implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table in question.
 


versionId
String versionId

 The ID value of the version in question. A VersionID is a string representation of an integer. Each
 version is incremented by 1.
 


errorDetail
ErrorDetail errorDetail

 The details about the error.
 








Class com.amazonaws.services.glue.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the AWS Glue resource to which to add the tags. For more information about AWS Glue resource ARNs, see
 the AWS
 Glue ARN string pattern.
 


tagsToAdd
Map<K,V> tagsToAdd

 Tags to add to this resource.
 








Class com.amazonaws.services.glue.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.TaskRun extends Object implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier for the transform.
 


taskRunId
String taskRunId

 The unique identifier for this task run.
 


status
String status

 The current status of the requested task run.
 


logGroupName
String logGroupName

 The names of the log group for secure logging, associated with this task run.
 


properties
TaskRunProperties properties

 Specifies configuration properties associated with this task run.
 


errorString
String errorString

 The list of error strings associated with this task run.
 


startedOn
Date startedOn

 The date and time that this task run started.
 


lastModifiedOn
Date lastModifiedOn

 The last point in time that the requested task run was updated.
 


completedOn
Date completedOn

 The last point in time that the requested task run was completed.
 


executionTime
Integer executionTime

 The amount of time (in seconds) that the task run consumed resources.
 








Class com.amazonaws.services.glue.model.TaskRunFilterCriteria extends Object implements Serializable


Serialized Fields


taskRunType
String taskRunType

 The type of task run.
 


status
String status

 The current status of the task run.
 


startedBefore
Date startedBefore

 Filter on task runs started before this date.
 


startedAfter
Date startedAfter

 Filter on task runs started after this date.
 








Class com.amazonaws.services.glue.model.TaskRunProperties extends Object implements Serializable


Serialized Fields


taskType
String taskType

 The type of task run.
 


importLabelsTaskRunProperties
ImportLabelsTaskRunProperties importLabelsTaskRunProperties

 The configuration properties for an importing labels task run.
 


exportLabelsTaskRunProperties
ExportLabelsTaskRunProperties exportLabelsTaskRunProperties

 The configuration properties for an exporting labels task run.
 


labelingSetGenerationTaskRunProperties
LabelingSetGenerationTaskRunProperties labelingSetGenerationTaskRunProperties

 The configuration properties for a labeling set generation task run.
 


findMatchesTaskRunProperties
FindMatchesTaskRunProperties findMatchesTaskRunProperties

 The configuration properties for a find matches task run.
 








Class com.amazonaws.services.glue.model.TaskRunSortCriteria extends Object implements Serializable


Serialized Fields


column
String column

 The column to be used to sort the list of task runs for the machine learning transform.
 


sortDirection
String sortDirection

 The sort direction to be used to sort the list of task runs for the machine learning transform.
 








Class com.amazonaws.services.glue.model.TransformFilterCriteria extends Object implements Serializable


Serialized Fields


name
String name

 A unique transform name that is used to filter the machine learning transforms.
 


transformType
String transformType

 The type of machine learning transform that is used to filter the machine learning transforms.
 


status
String status

 Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a
 transform can be used or not). One of "NOT_READY", "READY", or "DELETING".
 


glueVersion
String glueVersion

 This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is
 recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more
 information, see AWS Glue Versions
 in the developer guide.
 


createdBefore
Date createdBefore

 The time and date before which the transforms were created.
 


createdAfter
Date createdAfter

 The time and date after which the transforms were created.
 


lastModifiedBefore
Date lastModifiedBefore

 Filter on transforms last modified before this date.
 


lastModifiedAfter
Date lastModifiedAfter

 Filter on transforms last modified after this date.
 


schema
List<E> schema

 Filters on datasets with a specific schema. The Map<Column, Type> object is an array of
 key-value pairs representing the schema this transform accepts, where Column is the name of a
 column, and Type is the type of the data such as an integer or string. Has an upper bound of 100
 columns.
 








Class com.amazonaws.services.glue.model.TransformParameters extends Object implements Serializable


Serialized Fields


transformType
String transformType

 The type of machine learning transform.
 
 
 For information about the types of machine learning transforms, see Creating Machine
 Learning Transforms.
 


findMatchesParameters
FindMatchesParameters findMatchesParameters

 The parameters for the find matches algorithm.
 








Class com.amazonaws.services.glue.model.TransformSortCriteria extends Object implements Serializable


Serialized Fields


column
String column

 The column to be used in the sorting criteria that are associated with the machine learning transform.
 


sortDirection
String sortDirection

 The sort direction to be used in the sorting criteria that are associated with the machine learning transform.
 








Class com.amazonaws.services.glue.model.Trigger extends Object implements Serializable


Serialized Fields


name
String name

 The name of the trigger.
 


workflowName
String workflowName

 The name of the workflow associated with the trigger.
 


id
String id

 Reserved for future use.
 


type
String type

 The type of trigger that this is.
 


state
String state

 The current state of the trigger.
 


description
String description

 A description of this trigger.
 


schedule
String schedule

 A cron expression used to specify the schedule (see Time-Based Schedules for
 Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify:
 cron(15 12 * * ? *).
 


actions
List<E> actions

 The actions initiated by this trigger.
 


predicate
Predicate predicate

 The predicate of this trigger, which defines when it will fire.
 








Class com.amazonaws.services.glue.model.TriggerNodeDetails extends Object implements Serializable


Serialized Fields


trigger
Trigger trigger

 The information of the trigger represented by the trigger node.
 








Class com.amazonaws.services.glue.model.TriggerUpdate extends Object implements Serializable


Serialized Fields


name
String name

 Reserved for future use.
 


description
String description

 A description of this trigger.
 


schedule
String schedule

 A cron expression used to specify the schedule (see Time-Based Schedules for
 Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify:
 cron(15 12 * * ? *).
 


actions
List<E> actions

 The actions initiated by this trigger.
 


predicate
Predicate predicate

 The predicate of this trigger, which defines when it will fire.
 








Class com.amazonaws.services.glue.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource from which to remove the tags.
 


tagsToRemove
List<E> tagsToRemove

 Tags to remove from this resource.
 








Class com.amazonaws.services.glue.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.UpdateClassifierRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


grokClassifier
UpdateGrokClassifierRequest grokClassifier

 A GrokClassifier object with updated fields.
 


xMLClassifier
UpdateXMLClassifierRequest xMLClassifier

 An XMLClassifier object with updated fields.
 


jsonClassifier
UpdateJsonClassifierRequest jsonClassifier

 A JsonClassifier object with updated fields.
 


csvClassifier
UpdateCsvClassifierRequest csvClassifier

 A CsvClassifier object with updated fields.
 








Class com.amazonaws.services.glue.model.UpdateClassifierResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.UpdateConnectionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by
 default.
 


name
String name

 The name of the connection definition to update.
 


connectionInput
ConnectionInput connectionInput

 A ConnectionInput object that redefines the connection in question.
 








Class com.amazonaws.services.glue.model.UpdateConnectionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.UpdateCrawlerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the new crawler.
 


role
String role

 The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer
 resources.
 


databaseName
String databaseName

 The AWS Glue database where results are stored, such as:
 arn:aws:daylight:us-east-1::database/sometable/*.
 


description
String description

 A description of the new crawler.
 


targets
CrawlerTargets targets

 A list of targets to crawl.
 


schedule
String schedule

 A cron expression used to specify the schedule. For more information, see Time-Based Schedules for
 Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify
 cron(15 12 * * ? *).
 


classifiers
List<E> classifiers

 A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a
 crawl, but these custom classifiers always override the default classifiers for a given classification.
 


tablePrefix
String tablePrefix

 The table prefix used for catalog tables that are created.
 


schemaChangePolicy
SchemaChangePolicy schemaChangePolicy

 The policy for the crawler's update and deletion behavior.
 


configuration
String configuration

 The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's
 behavior. For more information, see Configuring a Crawler.
 


crawlerSecurityConfiguration
String crawlerSecurityConfiguration

 The name of the SecurityConfiguration structure to be used by this crawler.
 








Class com.amazonaws.services.glue.model.UpdateCrawlerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.UpdateCrawlerScheduleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


crawlerName
String crawlerName

 The name of the crawler whose schedule to update.
 


schedule
String schedule

 The updated cron expression used to specify the schedule. For more information, see Time-Based Schedules for
 Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify
 cron(15 12 * * ? *).
 








Class com.amazonaws.services.glue.model.UpdateCrawlerScheduleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.UpdateCsvClassifierRequest extends Object implements Serializable


Serialized Fields


name
String name

 The name of the classifier.
 


delimiter
String delimiter

 A custom symbol to denote what separates each column entry in the row.
 


quoteSymbol
String quoteSymbol

 A custom symbol to denote what combines content into a single column value. It must be different from the column
 delimiter.
 


containsHeader
String containsHeader

 Indicates whether the CSV file contains a header.
 


header
List<E> header

 A list of strings representing column names.
 


disableValueTrimming
Boolean disableValueTrimming

 Specifies not to trim values before identifying the type of column values. The default value is true.
 


allowSingleColumn
Boolean allowSingleColumn

 Enables the processing of files that contain only one column.
 








Class com.amazonaws.services.glue.model.UpdateDatabaseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog in which the metadata database resides. If none is provided, the AWS account ID is
 used by default.
 


name
String name

 The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.
 


databaseInput
DatabaseInput databaseInput

 A DatabaseInput object specifying the new definition of the metadata database in the catalog.
 








Class com.amazonaws.services.glue.model.UpdateDatabaseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.UpdateDevEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointName
String endpointName

 The name of the DevEndpoint to be updated.
 


publicKey
String publicKey

 The public key for the DevEndpoint to use.
 


addPublicKeys
List<E> addPublicKeys

 The list of public keys for the DevEndpoint to use.
 


deletePublicKeys
List<E> deletePublicKeys

 The list of public keys to be deleted from the DevEndpoint.
 


customLibraries
DevEndpointCustomLibraries customLibraries

 Custom Python or Java libraries to be loaded in the DevEndpoint.
 


updateEtlLibraries
Boolean updateEtlLibraries

 True if the list of custom libraries to be loaded in the development endpoint needs to be updated,
 or False if otherwise.
 


deleteArguments
List<E> deleteArguments

 The list of argument keys to be deleted from the map of arguments used to configure the DevEndpoint.
 


addArguments
Map<K,V> addArguments

 The map of arguments to add the map of arguments used to configure the DevEndpoint.
 
 
 Valid arguments are:
 
 
 
 
 "--enable-glue-datacatalog": ""
 
 
 
 
 "GLUE_PYTHON_VERSION": "3"
 
 
 
 
 "GLUE_PYTHON_VERSION": "2"
 
 
 
 
 You can specify a version of Python support for development endpoints by using the Arguments
 parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are
 provided, the version defaults to Python 2.
 








Class com.amazonaws.services.glue.model.UpdateDevEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.UpdateGrokClassifierRequest extends Object implements Serializable


Serialized Fields


name
String name

 The name of the GrokClassifier.
 


classification
String classification

 An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon
 CloudWatch Logs, and so on.
 


grokPattern
String grokPattern

 The grok pattern used by this classifier.
 


customPatterns
String customPatterns

 Optional custom grok patterns used by this classifier.
 








Class com.amazonaws.services.glue.model.UpdateJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 The name of the job definition to update.
 


jobUpdate
JobUpdate jobUpdate

 Specifies the values with which to update the job definition.
 








Class com.amazonaws.services.glue.model.UpdateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobName
String jobName

 Returns the name of the updated job definition.
 








Class com.amazonaws.services.glue.model.UpdateJsonClassifierRequest extends Object implements Serializable


Serialized Fields


name
String name

 The name of the classifier.
 


jsonPath
String jsonPath

 A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset
 of JsonPath, as described in Writing JsonPath
 Custom Classifiers.
 








Class com.amazonaws.services.glue.model.UpdateMLTransformRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


transformId
String transformId

 A unique identifier that was generated when the transform was created.
 


name
String name

 The unique name that you gave the transform when you created it.
 


description
String description

 A description of the transform. The default is an empty string.
 


parameters
TransformParameters parameters

 The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on
 the transform type.
 


role
String role

 The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.
 


glueVersion
String glueVersion

 This value determines which version of AWS Glue this machine learning transform is compatible with. Glue 1.0 is
 recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more
 information, see AWS Glue Versions
 in the developer guide.
 


maxCapacity
Double maxCapacity

 The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can
 allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of
 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.
 
 
 When the WorkerType field is set to a value other than Standard, the
 MaxCapacity field is set automatically and becomes read-only.
 


workerType
String workerType

 The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.
 
 
 
 
 For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2
 executors per worker.
 
 
 
 
 For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1
 executor per worker.
 
 
 
 
 For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1
 executor per worker.
 
 
 


numberOfWorkers
Integer numberOfWorkers

 The number of workers of a defined workerType that are allocated when this task runs.
 


timeout
Integer timeout

 The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this
 transform can consume resources before it is terminated and enters TIMEOUT status. The default is
 2,880 minutes (48 hours).
 


maxRetries
Integer maxRetries

 The maximum number of times to retry a task for this transform after a task run fails.
 








Class com.amazonaws.services.glue.model.UpdateMLTransformResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transformId
String transformId

 The unique identifier for the transform that was updated.
 








Class com.amazonaws.services.glue.model.UpdatePartitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the partition to be updated resides. If none is provided, the AWS account ID is
 used by default.
 


databaseName
String databaseName

 The name of the catalog database in which the table in question resides.
 


tableName
String tableName

 The name of the table in which the partition to be updated is located.
 


partitionValueList
List<E> partitionValueList

 A list of the values defining the partition.
 


partitionInput
PartitionInput partitionInput

 The new partition object to update the partition to.
 








Class com.amazonaws.services.glue.model.UpdatePartitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.UpdateTableRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.
 


databaseName
String databaseName

 The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely
 lowercase.
 


tableInput
TableInput tableInput

 An updated TableInput object to define the metadata table in the catalog.
 


skipArchive
Boolean skipArchive

 By default, UpdateTable always creates an archived version of the table before updating it. However,
 if skipArchive is set to true, UpdateTable does not create the archived version.
 








Class com.amazonaws.services.glue.model.UpdateTableResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.UpdateTriggerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the trigger to update.
 


triggerUpdate
TriggerUpdate triggerUpdate

 The new values with which to update the trigger.
 








Class com.amazonaws.services.glue.model.UpdateTriggerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


trigger
Trigger trigger

 The resulting trigger definition.
 








Class com.amazonaws.services.glue.model.UpdateUserDefinedFunctionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The ID of the Data Catalog where the function to be updated is located. If none is provided, the AWS account ID
 is used by default.
 


databaseName
String databaseName

 The name of the catalog database where the function to be updated is located.
 


functionName
String functionName

 The name of the function.
 


functionInput
UserDefinedFunctionInput functionInput

 A FunctionInput object that redefines the function in the Data Catalog.
 








Class com.amazonaws.services.glue.model.UpdateUserDefinedFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.glue.model.UpdateWorkflowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the workflow to be updated.
 


description
String description

 The description of the workflow.
 


defaultRunProperties
Map<K,V> defaultRunProperties

 A collection of properties to be used as part of each execution of the workflow.
 








Class com.amazonaws.services.glue.model.UpdateWorkflowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the workflow which was specified in input.
 








Class com.amazonaws.services.glue.model.UpdateXMLClassifierRequest extends Object implements Serializable


Serialized Fields


name
String name

 The name of the classifier.
 


classification
String classification

 An identifier of the data format that the classifier matches.
 


rowTag
String rowTag

 The XML tag designating the element that contains each record in an XML document being parsed. This cannot
 identify a self-closing element (closed by />). An empty row element that contains only
 attributes can be parsed as long as it ends with a closing tag (for example,
 <row item_a="A" item_b="B"></row> is okay, but
 <row item_a="A" item_b="B" /> is not).
 








Class com.amazonaws.services.glue.model.UserDefinedFunction extends Object implements Serializable


Serialized Fields


functionName
String functionName

 The name of the function.
 


className
String className

 The Java class that contains the function code.
 


ownerName
String ownerName

 The owner of the function.
 


ownerType
String ownerType

 The owner type.
 


createTime
Date createTime

 The time at which the function was created.
 


resourceUris
List<E> resourceUris

 The resource URIs for the function.
 








Class com.amazonaws.services.glue.model.UserDefinedFunctionInput extends Object implements Serializable


Serialized Fields


functionName
String functionName

 The name of the function.
 


className
String className

 The Java class that contains the function code.
 


ownerName
String ownerName

 The owner of the function.
 


ownerType
String ownerType

 The owner type.
 


resourceUris
List<E> resourceUris

 The resource URIs for the function.
 








Class com.amazonaws.services.glue.model.ValidationException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.VersionMismatchException extends AWSGlueException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.glue.model.Workflow extends Object implements Serializable


Serialized Fields


name
String name

 The name of the workflow representing the flow.
 


description
String description

 A description of the workflow.
 


defaultRunProperties
Map<K,V> defaultRunProperties

 A collection of properties to be used as part of each execution of the workflow.
 


createdOn
Date createdOn

 The date and time when the workflow was created.
 


lastModifiedOn
Date lastModifiedOn

 The date and time when the workflow was last modified.
 


lastRun
WorkflowRun lastRun

 The information about the last execution of the workflow.
 


graph
WorkflowGraph graph

 The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections
 between them as edges.
 








Class com.amazonaws.services.glue.model.WorkflowGraph extends Object implements Serializable


Serialized Fields


nodes
List<E> nodes

 A list of the the AWS Glue components belong to the workflow represented as nodes.
 


edges
List<E> edges

 A list of all the directed connections between the nodes belonging to the workflow.
 








Class com.amazonaws.services.glue.model.WorkflowRun extends Object implements Serializable


Serialized Fields


name
String name

 Name of the workflow which was executed.
 


workflowRunId
String workflowRunId

 The ID of this workflow run.
 


workflowRunProperties
Map<K,V> workflowRunProperties

 The workflow run properties which were set during the run.
 


startedOn
Date startedOn

 The date and time when the workflow run was started.
 


completedOn
Date completedOn

 The date and time when the workflow run completed.
 


status
String status

 The status of the workflow run.
 


statistics
WorkflowRunStatistics statistics

 The statistics of the run.
 


graph
WorkflowGraph graph

 The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections
 between them as edges.
 








Class com.amazonaws.services.glue.model.WorkflowRunStatistics extends Object implements Serializable


Serialized Fields


totalActions
Integer totalActions

 Total number of Actions in the workflow run.
 


timeoutActions
Integer timeoutActions

 Total number of Actions which timed out.
 


failedActions
Integer failedActions

 Total number of Actions which have failed.
 


stoppedActions
Integer stoppedActions

 Total number of Actions which have stopped.
 


succeededActions
Integer succeededActions

 Total number of Actions which have succeeded.
 


runningActions
Integer runningActions

 Total number Actions in running state.
 








Class com.amazonaws.services.glue.model.XMLClassifier extends Object implements Serializable


Serialized Fields


name
String name

 The name of the classifier.
 


classification
String classification

 An identifier of the data format that the classifier matches.
 


creationTime
Date creationTime

 The time that this classifier was registered.
 


lastUpdated
Date lastUpdated

 The time that this classifier was last updated.
 


version
Long version

 The version of this classifier.
 


rowTag
String rowTag

 The XML tag designating the element that contains each record in an XML document being parsed. This can't
 identify a self-closing element (closed by />). An empty row element that contains only
 attributes can be parsed as long as it ends with a closing tag (for example,
 <row item_a="A" item_b="B"></row> is okay, but
 <row item_a="A" item_b="B" /> is not).
 








Package com.amazonaws.services.greengrass.model




Class com.amazonaws.services.greengrass.model.AssociateRoleToGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId
The ID of the Greengrass group.


roleArn
String roleArn
The ARN of the role you wish to associate with this group. The existence of the role is not validated.








Class com.amazonaws.services.greengrass.model.AssociateRoleToGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


associatedAt
String associatedAt
The time, in milliseconds since the epoch, when the role ARN was associated with the group.








Class com.amazonaws.services.greengrass.model.AssociateServiceRoleToAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleArn
String roleArn
The ARN of the service role you wish to associate with your account.








Class com.amazonaws.services.greengrass.model.AssociateServiceRoleToAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


associatedAt
String associatedAt
The time when the service role was associated with the account.








Class com.amazonaws.services.greengrass.model.AWSGreengrassException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.greengrass.model.BadRequestException extends AWSGreengrassException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorDetails
List<E> errorDetails
Details about the error.








Class com.amazonaws.services.greengrass.model.BulkDeployment extends Object implements Serializable


Serialized Fields


bulkDeploymentArn
String bulkDeploymentArn
The ARN of the bulk deployment.


bulkDeploymentId
String bulkDeploymentId
The ID of the bulk deployment.


createdAt
String createdAt
The time, in ISO format, when the deployment was created.








Class com.amazonaws.services.greengrass.model.BulkDeploymentMetrics extends Object implements Serializable


Serialized Fields


invalidInputRecords
Integer invalidInputRecords
The total number of records that returned a non-retryable error. For example, this can occur if a group record
 from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role
 doesn't grant permission to deploy a group or group version.


recordsProcessed
Integer recordsProcessed
The total number of group records from the input file that have been processed so far, or attempted.


retryAttempts
Integer retryAttempts
The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the
 attempt to deploy a group returns a throttling error. ''StartBulkDeployment'' retries a group deployment up to
 five times.








Class com.amazonaws.services.greengrass.model.BulkDeploymentResult extends Object implements Serializable


Serialized Fields


createdAt
String createdAt
The time, in ISO format, when the deployment was created.


deploymentArn
String deploymentArn
The ARN of the group deployment.


deploymentId
String deploymentId
The ID of the group deployment.


deploymentStatus
String deploymentStatus
The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.


deploymentType
String deploymentType
The type of the deployment.


errorDetails
List<E> errorDetails
Details about the error.


errorMessage
String errorMessage
The error message for a failed deployment


groupArn
String groupArn
The ARN of the Greengrass group.








Class com.amazonaws.services.greengrass.model.ConnectivityInfo extends Object implements Serializable


Serialized Fields


hostAddress
String hostAddress
The endpoint for the Greengrass core. Can be an IP address or DNS.


id
String id
The ID of the connectivity information.


metadata
String metadata
Metadata for this endpoint.


portNumber
Integer portNumber
The port of the Greengrass core. Usually 8883.








Class com.amazonaws.services.greengrass.model.Connector extends Object implements Serializable


Serialized Fields


connectorArn
String connectorArn
The ARN of the connector.


id
String id
A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition
 version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+.


parameters
Map<K,V> parameters
The parameters or configuration that the connector uses.








Class com.amazonaws.services.greengrass.model.ConnectorDefinitionVersion extends Object implements Serializable


Serialized Fields


connectors
List<E> connectors
A list of references to connectors in this version, with their corresponding configuration settings.








Class com.amazonaws.services.greengrass.model.Core extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn
The ARN of the certificate associated with the core.


id
String id
A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max
 length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.


syncShadow
Boolean syncShadow
If true, the core's local shadow is automatically synced with the cloud.


thingArn
String thingArn
The ARN of the thing which is the core.








Class com.amazonaws.services.greengrass.model.CoreDefinitionVersion extends Object implements Serializable


Serialized Fields


cores
List<E> cores
A list of cores in the core definition version.








Class com.amazonaws.services.greengrass.model.CreateConnectorDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


initialVersion
ConnectorDefinitionVersion initialVersion
Information about the initial version of the connector definition.


name
String name
The name of the connector definition.


tags
Map<K,V> tags
Tag(s) to add to the new resource.








Class com.amazonaws.services.greengrass.model.CreateConnectorDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.CreateConnectorDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


connectorDefinitionId
String connectorDefinitionId
The ID of the connector definition.


connectors
List<E> connectors
A list of references to connectors in this version, with their corresponding configuration settings.








Class com.amazonaws.services.greengrass.model.CreateConnectorDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the version was created.


id
String id
The ID of the parent definition that the version is associated with.


version
String version
The ID of the version.








Class com.amazonaws.services.greengrass.model.CreateCoreDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


initialVersion
CoreDefinitionVersion initialVersion
Information about the initial version of the core definition.


name
String name
The name of the core definition.


tags
Map<K,V> tags
Tag(s) to add to the new resource.








Class com.amazonaws.services.greengrass.model.CreateCoreDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.CreateCoreDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


coreDefinitionId
String coreDefinitionId
The ID of the core definition.


cores
List<E> cores
A list of cores in the core definition version.








Class com.amazonaws.services.greengrass.model.CreateCoreDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the version was created.


id
String id
The ID of the parent definition that the version is associated with.


version
String version
The ID of the version.








Class com.amazonaws.services.greengrass.model.CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


deploymentId
String deploymentId
The ID of the deployment if you wish to redeploy a previous deployment.


deploymentType
String deploymentType
The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are
 valid.


groupId
String groupId
The ID of the Greengrass group.


groupVersionId
String groupVersionId
The ID of the group version to be deployed.








Class com.amazonaws.services.greengrass.model.CreateDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentArn
String deploymentArn
The ARN of the deployment.


deploymentId
String deploymentId
The ID of the deployment.








Class com.amazonaws.services.greengrass.model.CreateDeviceDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


initialVersion
DeviceDefinitionVersion initialVersion
Information about the initial version of the device definition.


name
String name
The name of the device definition.


tags
Map<K,V> tags
Tag(s) to add to the new resource.








Class com.amazonaws.services.greengrass.model.CreateDeviceDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.CreateDeviceDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


deviceDefinitionId
String deviceDefinitionId
The ID of the device definition.


devices
List<E> devices
A list of devices in the definition version.








Class com.amazonaws.services.greengrass.model.CreateDeviceDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the version was created.


id
String id
The ID of the parent definition that the version is associated with.


version
String version
The ID of the version.








Class com.amazonaws.services.greengrass.model.CreateFunctionDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


initialVersion
FunctionDefinitionVersion initialVersion
Information about the initial version of the function definition.


name
String name
The name of the function definition.


tags
Map<K,V> tags
Tag(s) to add to the new resource.








Class com.amazonaws.services.greengrass.model.CreateFunctionDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.CreateFunctionDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


defaultConfig
FunctionDefaultConfig defaultConfig
The default configuration that applies to all Lambda functions in this function definition version. Individual
 Lambda functions can override these settings.


functionDefinitionId
String functionDefinitionId
The ID of the Lambda function definition.


functions
List<E> functions
A list of Lambda functions in this function definition version.








Class com.amazonaws.services.greengrass.model.CreateFunctionDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the version was created.


id
String id
The ID of the parent definition that the version is associated with.


version
String version
The ID of the version.








Class com.amazonaws.services.greengrass.model.CreateGroupCertificateAuthorityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


groupId
String groupId
The ID of the Greengrass group.








Class com.amazonaws.services.greengrass.model.CreateGroupCertificateAuthorityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


groupCertificateAuthorityArn
String groupCertificateAuthorityArn
The ARN of the group certificate authority.








Class com.amazonaws.services.greengrass.model.CreateGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


initialVersion
GroupVersion initialVersion
Information about the initial version of the group.


name
String name
The name of the group.


tags
Map<K,V> tags
Tag(s) to add to the new resource.








Class com.amazonaws.services.greengrass.model.CreateGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.CreateGroupVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


connectorDefinitionVersionArn
String connectorDefinitionVersionArn
The ARN of the connector definition version for this group.


coreDefinitionVersionArn
String coreDefinitionVersionArn
The ARN of the core definition version for this group.


deviceDefinitionVersionArn
String deviceDefinitionVersionArn
The ARN of the device definition version for this group.


functionDefinitionVersionArn
String functionDefinitionVersionArn
The ARN of the function definition version for this group.


groupId
String groupId
The ID of the Greengrass group.


loggerDefinitionVersionArn
String loggerDefinitionVersionArn
The ARN of the logger definition version for this group.


resourceDefinitionVersionArn
String resourceDefinitionVersionArn
The ARN of the resource definition version for this group.


subscriptionDefinitionVersionArn
String subscriptionDefinitionVersionArn
The ARN of the subscription definition version for this group.








Class com.amazonaws.services.greengrass.model.CreateGroupVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the version was created.


id
String id
The ID of the parent definition that the version is associated with.


version
String version
The ID of the version.








Class com.amazonaws.services.greengrass.model.CreateLoggerDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


initialVersion
LoggerDefinitionVersion initialVersion
Information about the initial version of the logger definition.


name
String name
The name of the logger definition.


tags
Map<K,V> tags
Tag(s) to add to the new resource.








Class com.amazonaws.services.greengrass.model.CreateLoggerDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.CreateLoggerDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


loggerDefinitionId
String loggerDefinitionId
The ID of the logger definition.


loggers
List<E> loggers
A list of loggers.








Class com.amazonaws.services.greengrass.model.CreateLoggerDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the version was created.


id
String id
The ID of the parent definition that the version is associated with.


version
String version
The ID of the version.








Class com.amazonaws.services.greengrass.model.CreateResourceDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


initialVersion
ResourceDefinitionVersion initialVersion
Information about the initial version of the resource definition.


name
String name
The name of the resource definition.


tags
Map<K,V> tags
Tag(s) to add to the new resource.








Class com.amazonaws.services.greengrass.model.CreateResourceDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.CreateResourceDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


resourceDefinitionId
String resourceDefinitionId
The ID of the resource definition.


resources
List<E> resources
A list of resources.








Class com.amazonaws.services.greengrass.model.CreateResourceDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the version was created.


id
String id
The ID of the parent definition that the version is associated with.


version
String version
The ID of the version.








Class com.amazonaws.services.greengrass.model.CreateSoftwareUpdateJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


s3UrlSignerRole
String s3UrlSignerRole


softwareToUpdate
String softwareToUpdate


updateAgentLogLevel
String updateAgentLogLevel


updateTargets
List<E> updateTargets


updateTargetsArchitecture
String updateTargetsArchitecture


updateTargetsOperatingSystem
String updateTargetsOperatingSystem








Class com.amazonaws.services.greengrass.model.CreateSoftwareUpdateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


iotJobArn
String iotJobArn
The IoT Job ARN corresponding to this update.


iotJobId
String iotJobId
The IoT Job Id corresponding to this update.


platformSoftwareVersion
String platformSoftwareVersion
The software version installed on the device or devices after the update.








Class com.amazonaws.services.greengrass.model.CreateSubscriptionDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


initialVersion
SubscriptionDefinitionVersion initialVersion
Information about the initial version of the subscription definition.


name
String name
The name of the subscription definition.


tags
Map<K,V> tags
Tag(s) to add to the new resource.








Class com.amazonaws.services.greengrass.model.CreateSubscriptionDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.CreateSubscriptionDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


subscriptionDefinitionId
String subscriptionDefinitionId
The ID of the subscription definition.


subscriptions
List<E> subscriptions
A list of subscriptions.








Class com.amazonaws.services.greengrass.model.CreateSubscriptionDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the version was created.


id
String id
The ID of the parent definition that the version is associated with.


version
String version
The ID of the version.








Class com.amazonaws.services.greengrass.model.DefinitionInformation extends Object implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.


tags
Map<K,V> tags
Tag(s) attached to the resource arn.








Class com.amazonaws.services.greengrass.model.DeleteConnectorDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorDefinitionId
String connectorDefinitionId
The ID of the connector definition.








Class com.amazonaws.services.greengrass.model.DeleteConnectorDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.DeleteCoreDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


coreDefinitionId
String coreDefinitionId
The ID of the core definition.








Class com.amazonaws.services.greengrass.model.DeleteCoreDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.DeleteDeviceDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceDefinitionId
String deviceDefinitionId
The ID of the device definition.








Class com.amazonaws.services.greengrass.model.DeleteDeviceDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.DeleteFunctionDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionDefinitionId
String functionDefinitionId
The ID of the Lambda function definition.








Class com.amazonaws.services.greengrass.model.DeleteFunctionDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.DeleteGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId
The ID of the Greengrass group.








Class com.amazonaws.services.greengrass.model.DeleteGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.DeleteLoggerDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loggerDefinitionId
String loggerDefinitionId
The ID of the logger definition.








Class com.amazonaws.services.greengrass.model.DeleteLoggerDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.DeleteResourceDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceDefinitionId
String resourceDefinitionId
The ID of the resource definition.








Class com.amazonaws.services.greengrass.model.DeleteResourceDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.DeleteSubscriptionDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subscriptionDefinitionId
String subscriptionDefinitionId
The ID of the subscription definition.








Class com.amazonaws.services.greengrass.model.DeleteSubscriptionDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


createdAt
String createdAt
The time, in milliseconds since the epoch, when the deployment was created.


deploymentArn
String deploymentArn
The ARN of the deployment.


deploymentId
String deploymentId
The ID of the deployment.


deploymentType
String deploymentType
The type of the deployment.


groupArn
String groupArn
The ARN of the group for this deployment.








Class com.amazonaws.services.greengrass.model.Device extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn
The ARN of the certificate associated with the device.


id
String id
A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max
 length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.


syncShadow
Boolean syncShadow
If true, the device's local shadow will be automatically synced with the cloud.


thingArn
String thingArn
The thing ARN of the device.








Class com.amazonaws.services.greengrass.model.DeviceDefinitionVersion extends Object implements Serializable


Serialized Fields


devices
List<E> devices
A list of devices in the definition version.








Class com.amazonaws.services.greengrass.model.DisassociateRoleFromGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId
The ID of the Greengrass group.








Class com.amazonaws.services.greengrass.model.DisassociateRoleFromGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


disassociatedAt
String disassociatedAt
The time, in milliseconds since the epoch, when the role was disassociated from the group.








Class com.amazonaws.services.greengrass.model.DisassociateServiceRoleFromAccountRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.greengrass.model.DisassociateServiceRoleFromAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


disassociatedAt
String disassociatedAt
The time when the service role was disassociated from the account.








Class com.amazonaws.services.greengrass.model.ErrorDetail extends Object implements Serializable


Serialized Fields


detailedErrorCode
String detailedErrorCode
A detailed error code.


detailedErrorMessage
String detailedErrorMessage
A detailed error message.








Class com.amazonaws.services.greengrass.model.Function extends Object implements Serializable


Serialized Fields


functionArn
String functionArn
The ARN of the Lambda function.


functionConfiguration
FunctionConfiguration functionConfiguration
The configuration of the Lambda function.


id
String id
A descriptive or arbitrary ID for the function. This value must be unique within the function definition version.
 Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.








Class com.amazonaws.services.greengrass.model.FunctionConfiguration extends Object implements Serializable


Serialized Fields


encodingType
String encodingType
The expected encoding type of the input payload for the function. The default is ''json''.


environment
FunctionConfigurationEnvironment environment
The environment configuration of the function.


execArgs
String execArgs
The execution arguments.


executable
String executable
The name of the function executable.


memorySize
Integer memorySize
The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when
 you run the Lambda function without containerization.


pinned
Boolean pinned
True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.


timeout
Integer timeout
The allowed function execution time, after which Lambda should terminate the function. This timeout still applies
 to pinned Lambda functions for each request.








Class com.amazonaws.services.greengrass.model.FunctionConfigurationEnvironment extends Object implements Serializable


Serialized Fields


accessSysfs
Boolean accessSysfs
If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs
 to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass
 container.


execution
FunctionExecutionConfig execution
Configuration related to executing the Lambda function


resourceAccessPolicies
List<E> resourceAccessPolicies
A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda
 function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a
 Greengrass container.


variables
Map<K,V> variables
Environment variables for the Lambda function's configuration.








Class com.amazonaws.services.greengrass.model.FunctionDefaultConfig extends Object implements Serializable


Serialized Fields


execution
FunctionDefaultExecutionConfig execution








Class com.amazonaws.services.greengrass.model.FunctionDefaultExecutionConfig extends Object implements Serializable


Serialized Fields


isolationMode
String isolationMode


runAs
FunctionRunAsConfig runAs








Class com.amazonaws.services.greengrass.model.FunctionDefinitionVersion extends Object implements Serializable


Serialized Fields


defaultConfig
FunctionDefaultConfig defaultConfig
The default configuration that applies to all Lambda functions in this function definition version. Individual
 Lambda functions can override these settings.


functions
List<E> functions
A list of Lambda functions in this function definition version.








Class com.amazonaws.services.greengrass.model.FunctionExecutionConfig extends Object implements Serializable


Serialized Fields


isolationMode
String isolationMode


runAs
FunctionRunAsConfig runAs








Class com.amazonaws.services.greengrass.model.FunctionRunAsConfig extends Object implements Serializable


Serialized Fields


gid
Integer gid
The group ID whose permissions are used to run a Lambda function.


uid
Integer uid
The user ID whose permissions are used to run a Lambda function.








Class com.amazonaws.services.greengrass.model.GetAssociatedRoleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId
The ID of the Greengrass group.








Class com.amazonaws.services.greengrass.model.GetAssociatedRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


associatedAt
String associatedAt
The time when the role was associated with the group.


roleArn
String roleArn
The ARN of the role that is associated with the group.








Class com.amazonaws.services.greengrass.model.GetBulkDeploymentStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


bulkDeploymentId
String bulkDeploymentId
The ID of the bulk deployment.








Class com.amazonaws.services.greengrass.model.GetBulkDeploymentStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bulkDeploymentMetrics
BulkDeploymentMetrics bulkDeploymentMetrics
Relevant metrics on input records processed during bulk deployment.


bulkDeploymentStatus
String bulkDeploymentStatus
The status of the bulk deployment.


createdAt
String createdAt
The time, in ISO format, when the deployment was created.


errorDetails
List<E> errorDetails
Error details


errorMessage
String errorMessage
Error message


tags
Map<K,V> tags
Tag(s) attached to the resource arn.








Class com.amazonaws.services.greengrass.model.GetConnectivityInfoRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName
The thing name.








Class com.amazonaws.services.greengrass.model.GetConnectivityInfoResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


connectivityInfo
List<E> connectivityInfo
Connectivity info list.


message
String message
A message about the connectivity info request.








Class com.amazonaws.services.greengrass.model.GetConnectorDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorDefinitionId
String connectorDefinitionId
The ID of the connector definition.








Class com.amazonaws.services.greengrass.model.GetConnectorDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.


tags
Map<K,V> tags
Tag(s) attached to the resource arn.








Class com.amazonaws.services.greengrass.model.GetConnectorDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorDefinitionId
String connectorDefinitionId
The ID of the connector definition.


connectorDefinitionVersionId
String connectorDefinitionVersionId
The ID of the connector definition version. This value maps to the ''Version'' property of the corresponding
 ''VersionInformation'' object, which is returned by ''ListConnectorDefinitionVersions'' requests. If the version
 is the last one that was associated with a connector definition, the value also maps to the ''LatestVersion''
 property of the corresponding ''DefinitionInformation'' object.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.GetConnectorDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the connector definition version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the connector definition version was created.


definition
ConnectorDefinitionVersion definition
Information about the connector definition version.


id
String id
The ID of the connector definition version.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


version
String version
The version of the connector definition version.








Class com.amazonaws.services.greengrass.model.GetCoreDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


coreDefinitionId
String coreDefinitionId
The ID of the core definition.








Class com.amazonaws.services.greengrass.model.GetCoreDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.


tags
Map<K,V> tags
Tag(s) attached to the resource arn.








Class com.amazonaws.services.greengrass.model.GetCoreDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


coreDefinitionId
String coreDefinitionId
The ID of the core definition.


coreDefinitionVersionId
String coreDefinitionVersionId
The ID of the core definition version. This value maps to the ''Version'' property of the corresponding
 ''VersionInformation'' object, which is returned by ''ListCoreDefinitionVersions'' requests. If the version is
 the last one that was associated with a core definition, the value also maps to the ''LatestVersion'' property of
 the corresponding ''DefinitionInformation'' object.








Class com.amazonaws.services.greengrass.model.GetCoreDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the core definition version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the core definition version was created.


definition
CoreDefinitionVersion definition
Information about the core definition version.


id
String id
The ID of the core definition version.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


version
String version
The version of the core definition version.








Class com.amazonaws.services.greengrass.model.GetDeploymentStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId
The ID of the deployment.


groupId
String groupId
The ID of the Greengrass group.








Class com.amazonaws.services.greengrass.model.GetDeploymentStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentStatus
String deploymentStatus
The status of the deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''.


deploymentType
String deploymentType
The type of the deployment.


errorDetails
List<E> errorDetails
Error details


errorMessage
String errorMessage
Error message


updatedAt
String updatedAt
The time, in milliseconds since the epoch, when the deployment status was updated.








Class com.amazonaws.services.greengrass.model.GetDeviceDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceDefinitionId
String deviceDefinitionId
The ID of the device definition.








Class com.amazonaws.services.greengrass.model.GetDeviceDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.


tags
Map<K,V> tags
Tag(s) attached to the resource arn.








Class com.amazonaws.services.greengrass.model.GetDeviceDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceDefinitionId
String deviceDefinitionId
The ID of the device definition.


deviceDefinitionVersionId
String deviceDefinitionVersionId
The ID of the device definition version. This value maps to the ''Version'' property of the corresponding
 ''VersionInformation'' object, which is returned by ''ListDeviceDefinitionVersions'' requests. If the version is
 the last one that was associated with a device definition, the value also maps to the ''LatestVersion'' property
 of the corresponding ''DefinitionInformation'' object.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.GetDeviceDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the device definition version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the device definition version was created.


definition
DeviceDefinitionVersion definition
Information about the device definition version.


id
String id
The ID of the device definition version.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


version
String version
The version of the device definition version.








Class com.amazonaws.services.greengrass.model.GetFunctionDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionDefinitionId
String functionDefinitionId
The ID of the Lambda function definition.








Class com.amazonaws.services.greengrass.model.GetFunctionDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.


tags
Map<K,V> tags
Tag(s) attached to the resource arn.








Class com.amazonaws.services.greengrass.model.GetFunctionDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionDefinitionId
String functionDefinitionId
The ID of the Lambda function definition.


functionDefinitionVersionId
String functionDefinitionVersionId
The ID of the function definition version. This value maps to the ''Version'' property of the corresponding
 ''VersionInformation'' object, which is returned by ''ListFunctionDefinitionVersions'' requests. If the version
 is the last one that was associated with a function definition, the value also maps to the ''LatestVersion''
 property of the corresponding ''DefinitionInformation'' object.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.GetFunctionDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the function definition version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the function definition version was created.


definition
FunctionDefinitionVersion definition
Information on the definition.


id
String id
The ID of the function definition version.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


version
String version
The version of the function definition version.








Class com.amazonaws.services.greengrass.model.GetGroupCertificateAuthorityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateAuthorityId
String certificateAuthorityId
The ID of the certificate authority.


groupId
String groupId
The ID of the Greengrass group.








Class com.amazonaws.services.greengrass.model.GetGroupCertificateAuthorityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


groupCertificateAuthorityArn
String groupCertificateAuthorityArn
The ARN of the certificate authority for the group.


groupCertificateAuthorityId
String groupCertificateAuthorityId
The ID of the certificate authority for the group.


pemEncodedCertificate
String pemEncodedCertificate
The PEM encoded certificate for the group.








Class com.amazonaws.services.greengrass.model.GetGroupCertificateConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId
The ID of the Greengrass group.








Class com.amazonaws.services.greengrass.model.GetGroupCertificateConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificateAuthorityExpiryInMilliseconds
String certificateAuthorityExpiryInMilliseconds
The amount of time remaining before the certificate authority expires, in milliseconds.


certificateExpiryInMilliseconds
String certificateExpiryInMilliseconds
The amount of time remaining before the certificate expires, in milliseconds.


groupId
String groupId
The ID of the group certificate configuration.








Class com.amazonaws.services.greengrass.model.GetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId
The ID of the Greengrass group.








Class com.amazonaws.services.greengrass.model.GetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.


tags
Map<K,V> tags
Tag(s) attached to the resource arn.








Class com.amazonaws.services.greengrass.model.GetGroupVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId
The ID of the Greengrass group.


groupVersionId
String groupVersionId
The ID of the group version. This value maps to the ''Version'' property of the corresponding
 ''VersionInformation'' object, which is returned by ''ListGroupVersions'' requests. If the version is the last
 one that was associated with a group, the value also maps to the ''LatestVersion'' property of the corresponding
 ''GroupInformation'' object.








Class com.amazonaws.services.greengrass.model.GetGroupVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the group version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the group version was created.


definition
GroupVersion definition
Information about the group version definition.


id
String id
The ID of the group that the version is associated with.


version
String version
The ID of the group version.








Class com.amazonaws.services.greengrass.model.GetLoggerDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loggerDefinitionId
String loggerDefinitionId
The ID of the logger definition.








Class com.amazonaws.services.greengrass.model.GetLoggerDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.


tags
Map<K,V> tags
Tag(s) attached to the resource arn.








Class com.amazonaws.services.greengrass.model.GetLoggerDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loggerDefinitionId
String loggerDefinitionId
The ID of the logger definition.


loggerDefinitionVersionId
String loggerDefinitionVersionId
The ID of the logger definition version. This value maps to the ''Version'' property of the corresponding
 ''VersionInformation'' object, which is returned by ''ListLoggerDefinitionVersions'' requests. If the version is
 the last one that was associated with a logger definition, the value also maps to the ''LatestVersion'' property
 of the corresponding ''DefinitionInformation'' object.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.GetLoggerDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the logger definition version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the logger definition version was created.


definition
LoggerDefinitionVersion definition
Information about the logger definition version.


id
String id
The ID of the logger definition version.


version
String version
The version of the logger definition version.








Class com.amazonaws.services.greengrass.model.GetResourceDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceDefinitionId
String resourceDefinitionId
The ID of the resource definition.








Class com.amazonaws.services.greengrass.model.GetResourceDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.


tags
Map<K,V> tags
Tag(s) attached to the resource arn.








Class com.amazonaws.services.greengrass.model.GetResourceDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceDefinitionId
String resourceDefinitionId
The ID of the resource definition.


resourceDefinitionVersionId
String resourceDefinitionVersionId
The ID of the resource definition version. This value maps to the ''Version'' property of the corresponding
 ''VersionInformation'' object, which is returned by ''ListResourceDefinitionVersions'' requests. If the version
 is the last one that was associated with a resource definition, the value also maps to the ''LatestVersion''
 property of the corresponding ''DefinitionInformation'' object.








Class com.amazonaws.services.greengrass.model.GetResourceDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
Arn of the resource definition version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the resource definition version was created.


definition
ResourceDefinitionVersion definition
Information about the definition.


id
String id
The ID of the resource definition version.


version
String version
The version of the resource definition version.








Class com.amazonaws.services.greengrass.model.GetServiceRoleForAccountRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.greengrass.model.GetServiceRoleForAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


associatedAt
String associatedAt
The time when the service role was associated with the account.


roleArn
String roleArn
The ARN of the role which is associated with the account.








Class com.amazonaws.services.greengrass.model.GetSubscriptionDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subscriptionDefinitionId
String subscriptionDefinitionId
The ID of the subscription definition.








Class com.amazonaws.services.greengrass.model.GetSubscriptionDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the definition.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the definition was created.


id
String id
The ID of the definition.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the definition was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the definition.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the definition.


name
String name
The name of the definition.


tags
Map<K,V> tags
Tag(s) attached to the resource arn.








Class com.amazonaws.services.greengrass.model.GetSubscriptionDefinitionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


subscriptionDefinitionId
String subscriptionDefinitionId
The ID of the subscription definition.


subscriptionDefinitionVersionId
String subscriptionDefinitionVersionId
The ID of the subscription definition version. This value maps to the ''Version'' property of the corresponding
 ''VersionInformation'' object, which is returned by ''ListSubscriptionDefinitionVersions'' requests. If the
 version is the last one that was associated with a subscription definition, the value also maps to the
 ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object.








Class com.amazonaws.services.greengrass.model.GetSubscriptionDefinitionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the subscription definition version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the subscription definition version was created.


definition
SubscriptionDefinitionVersion definition
Information about the subscription definition version.


id
String id
The ID of the subscription definition version.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


version
String version
The version of the subscription definition version.








Class com.amazonaws.services.greengrass.model.GroupCertificateAuthorityProperties extends Object implements Serializable


Serialized Fields


groupCertificateAuthorityArn
String groupCertificateAuthorityArn
The ARN of the certificate authority for the group.


groupCertificateAuthorityId
String groupCertificateAuthorityId
The ID of the certificate authority for the group.








Class com.amazonaws.services.greengrass.model.GroupInformation extends Object implements Serializable


Serialized Fields


arn
String arn
The ARN of the group.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the group was created.


id
String id
The ID of the group.


lastUpdatedTimestamp
String lastUpdatedTimestamp
The time, in milliseconds since the epoch, when the group was last updated.


latestVersion
String latestVersion
The ID of the latest version associated with the group.


latestVersionArn
String latestVersionArn
The ARN of the latest version associated with the group.


name
String name
The name of the group.








Class com.amazonaws.services.greengrass.model.GroupOwnerSetting extends Object implements Serializable


Serialized Fields


autoAddGroupOwner
Boolean autoAddGroupOwner
If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda
 process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.


groupOwner
String groupOwner
The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.








Class com.amazonaws.services.greengrass.model.GroupVersion extends Object implements Serializable


Serialized Fields


connectorDefinitionVersionArn
String connectorDefinitionVersionArn
The ARN of the connector definition version for this group.


coreDefinitionVersionArn
String coreDefinitionVersionArn
The ARN of the core definition version for this group.


deviceDefinitionVersionArn
String deviceDefinitionVersionArn
The ARN of the device definition version for this group.


functionDefinitionVersionArn
String functionDefinitionVersionArn
The ARN of the function definition version for this group.


loggerDefinitionVersionArn
String loggerDefinitionVersionArn
The ARN of the logger definition version for this group.


resourceDefinitionVersionArn
String resourceDefinitionVersionArn
The ARN of the resource definition version for this group.


subscriptionDefinitionVersionArn
String subscriptionDefinitionVersionArn
The ARN of the subscription definition version for this group.








Class com.amazonaws.services.greengrass.model.InternalServerErrorException extends AWSGreengrassException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorDetails
List<E> errorDetails
Details about the error.








Class com.amazonaws.services.greengrass.model.ListBulkDeploymentDetailedReportsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


bulkDeploymentId
String bulkDeploymentId
The ID of the bulk deployment.


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListBulkDeploymentDetailedReportsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deployments
List<E> deployments
A list of the individual group deployments in the bulk deployment operation.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListBulkDeploymentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListBulkDeploymentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bulkDeployments
List<E> bulkDeployments
A list of bulk deployments.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListConnectorDefinitionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListConnectorDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


definitions
List<E> definitions
Information about a definition.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListConnectorDefinitionVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorDefinitionId
String connectorDefinitionId
The ID of the connector definition.


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListConnectorDefinitionVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


versions
List<E> versions
Information about a version.








Class com.amazonaws.services.greengrass.model.ListCoreDefinitionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListCoreDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


definitions
List<E> definitions
Information about a definition.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListCoreDefinitionVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


coreDefinitionId
String coreDefinitionId
The ID of the core definition.


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListCoreDefinitionVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


versions
List<E> versions
Information about a version.








Class com.amazonaws.services.greengrass.model.ListDeploymentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId
The ID of the Greengrass group.


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListDeploymentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deployments
List<E> deployments
A list of deployments for the requested groups.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListDeviceDefinitionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListDeviceDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


definitions
List<E> definitions
Information about a definition.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListDeviceDefinitionVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceDefinitionId
String deviceDefinitionId
The ID of the device definition.


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListDeviceDefinitionVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


versions
List<E> versions
Information about a version.








Class com.amazonaws.services.greengrass.model.ListFunctionDefinitionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListFunctionDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


definitions
List<E> definitions
Information about a definition.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListFunctionDefinitionVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionDefinitionId
String functionDefinitionId
The ID of the Lambda function definition.


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListFunctionDefinitionVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


versions
List<E> versions
Information about a version.








Class com.amazonaws.services.greengrass.model.ListGroupCertificateAuthoritiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId
The ID of the Greengrass group.








Class com.amazonaws.services.greengrass.model.ListGroupCertificateAuthoritiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


groupCertificateAuthorities
List<E> groupCertificateAuthorities
A list of certificate authorities associated with the group.








Class com.amazonaws.services.greengrass.model.ListGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


groups
List<E> groups
Information about a group.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListGroupVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId
The ID of the Greengrass group.


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListGroupVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


versions
List<E> versions
Information about a version.








Class com.amazonaws.services.greengrass.model.ListLoggerDefinitionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListLoggerDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


definitions
List<E> definitions
Information about a definition.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListLoggerDefinitionVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loggerDefinitionId
String loggerDefinitionId
The ID of the logger definition.


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListLoggerDefinitionVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


versions
List<E> versions
Information about a version.








Class com.amazonaws.services.greengrass.model.ListResourceDefinitionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListResourceDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


definitions
List<E> definitions
Information about a definition.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListResourceDefinitionVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


resourceDefinitionId
String resourceDefinitionId
The ID of the resource definition.








Class com.amazonaws.services.greengrass.model.ListResourceDefinitionVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


versions
List<E> versions
Information about a version.








Class com.amazonaws.services.greengrass.model.ListSubscriptionDefinitionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListSubscriptionDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


definitions
List<E> definitions
Information about a definition.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.








Class com.amazonaws.services.greengrass.model.ListSubscriptionDefinitionVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
String maxResults
The maximum number of results to be returned per request.


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


subscriptionDefinitionId
String subscriptionDefinitionId
The ID of the subscription definition.








Class com.amazonaws.services.greengrass.model.ListSubscriptionDefinitionVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
The token for the next set of results, or ''null'' if there are no additional results.


versions
List<E> versions
Information about a version.








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


Serialized Fields


resourceArn
String resourceArn
The Amazon Resource Name (ARN) of the resource.








Class com.amazonaws.services.greengrass.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags








Class com.amazonaws.services.greengrass.model.LocalDeviceResourceData extends Object implements Serializable


Serialized Fields


groupOwnerSetting
GroupOwnerSetting groupOwnerSetting
Group/owner related settings for local resources.


sourcePath
String sourcePath
The local absolute path of the device resource. The source path for a device resource can refer only to a
 character device or block device under ''/dev''.








Class com.amazonaws.services.greengrass.model.LocalVolumeResourceData extends Object implements Serializable


Serialized Fields


destinationPath
String destinationPath
The absolute local path of the resource inside the Lambda environment.


groupOwnerSetting
GroupOwnerSetting groupOwnerSetting
Allows you to configure additional group privileges for the Lambda process. This field is optional.


sourcePath
String sourcePath
The local absolute path of the volume resource on the host. The source path for a volume resource type cannot
 start with ''/sys''.








Class com.amazonaws.services.greengrass.model.Logger extends Object implements Serializable


Serialized Fields


component
String component
The component that will be subject to logging.


id
String id
A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max
 length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.


level
String level
The level of the logs.


space
Integer space
The amount of file space, in KB, to use if the local file system is used for logging purposes.


type
String type
The type of log output which will be used.








Class com.amazonaws.services.greengrass.model.LoggerDefinitionVersion extends Object implements Serializable


Serialized Fields


loggers
List<E> loggers
A list of loggers.








Class com.amazonaws.services.greengrass.model.ResetDeploymentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


force
Boolean force
If true, performs a best-effort only core reset.


groupId
String groupId
The ID of the Greengrass group.








Class com.amazonaws.services.greengrass.model.ResetDeploymentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentArn
String deploymentArn
The ARN of the deployment.


deploymentId
String deploymentId
The ID of the deployment.








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


Serialized Fields


id
String id
The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128 characters
 with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.


name
String name
The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Max length 128 characters
 with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.


resourceDataContainer
ResourceDataContainer resourceDataContainer
A container of data for all resource types.








Class com.amazonaws.services.greengrass.model.ResourceAccessPolicy extends Object implements Serializable


Serialized Fields


permission
String permission
The permissions that the Lambda function has to the resource. Can be one of ''rw'' (read/write) or ''ro''
 (read-only).


resourceId
String resourceId
The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)








Class com.amazonaws.services.greengrass.model.ResourceDataContainer extends Object implements Serializable


Serialized Fields


localDeviceResourceData
LocalDeviceResourceData localDeviceResourceData
Attributes that define the local device resource.


localVolumeResourceData
LocalVolumeResourceData localVolumeResourceData
Attributes that define the local volume resource.


s3MachineLearningModelResourceData
S3MachineLearningModelResourceData s3MachineLearningModelResourceData
Attributes that define an Amazon S3 machine learning resource.


sageMakerMachineLearningModelResourceData
SageMakerMachineLearningModelResourceData sageMakerMachineLearningModelResourceData
Attributes that define an Amazon SageMaker machine learning resource.


secretsManagerSecretResourceData
SecretsManagerSecretResourceData secretsManagerSecretResourceData
Attributes that define a secret resource, which references a secret from AWS Secrets Manager.








Class com.amazonaws.services.greengrass.model.ResourceDefinitionVersion extends Object implements Serializable


Serialized Fields


resources
List<E> resources
A list of resources.








Class com.amazonaws.services.greengrass.model.ResourceDownloadOwnerSetting extends Object implements Serializable


Serialized Fields


groupOwner
String groupOwner
The group owner of the resource. This is the name of an existing Linux OS group on the system or a GID. The
 group's permissions are added to the Lambda process.


groupPermission
String groupPermission
The permissions that the group owner has to the resource. Valid values are ''rw'' (read/write) or ''ro''
 (read-only).








Class com.amazonaws.services.greengrass.model.S3MachineLearningModelResourceData extends Object implements Serializable


Serialized Fields


destinationPath
String destinationPath
The absolute local path of the resource inside the Lambda environment.


ownerSetting
ResourceDownloadOwnerSetting ownerSetting


s3Uri
String s3Uri
The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.








Class com.amazonaws.services.greengrass.model.SageMakerMachineLearningModelResourceData extends Object implements Serializable


Serialized Fields


destinationPath
String destinationPath
The absolute local path of the resource inside the Lambda environment.


ownerSetting
ResourceDownloadOwnerSetting ownerSetting


sageMakerJobArn
String sageMakerJobArn
The ARN of the Amazon SageMaker training job that represents the source model.








Class com.amazonaws.services.greengrass.model.SecretsManagerSecretResourceData extends Object implements Serializable


Serialized Fields


aRN
String aRN
The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version
 (represented by the ''AWSCURRENT'' staging label) is included by default.


additionalStagingLabelsToDownload
List<E> additionalStagingLabelsToDownload
Optional. The staging labels whose values you want to make available on the core, in addition to ''AWSCURRENT''.








Class com.amazonaws.services.greengrass.model.StartBulkDeploymentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


amznClientToken
String amznClientToken
A client token used to correlate requests and responses.


executionRoleArn
String executionRoleArn
The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the
 ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role
 must have access to the S3 bucket containing the input file.


inputFileUri
String inputFileUri
The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on
 this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8
 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100
 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types.


tags
Map<K,V> tags
Tag(s) to add to the new resource.








Class com.amazonaws.services.greengrass.model.StartBulkDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bulkDeploymentArn
String bulkDeploymentArn
The ARN of the bulk deployment.


bulkDeploymentId
String bulkDeploymentId
The ID of the bulk deployment.








Class com.amazonaws.services.greengrass.model.StopBulkDeploymentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


bulkDeploymentId
String bulkDeploymentId
The ID of the bulk deployment.








Class com.amazonaws.services.greengrass.model.StopBulkDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.Subscription extends Object implements Serializable


Serialized Fields


id
String id
A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition
 version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''.


source
String source
The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which
 represents the AWS IoT cloud), or 'GGShadowService'.


subject
String subject
The MQTT topic used to route the message.


target
String target
Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which
 represents the AWS IoT cloud), or 'GGShadowService'.








Class com.amazonaws.services.greengrass.model.SubscriptionDefinitionVersion extends Object implements Serializable


Serialized Fields


subscriptions
List<E> subscriptions
A list of subscriptions.








Class com.amazonaws.services.greengrass.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn
The Amazon Resource Name (ARN) of the resource.


tags
Map<K,V> tags








Class com.amazonaws.services.greengrass.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn
The Amazon Resource Name (ARN) of the resource.


tagKeys
List<E> tagKeys
An array of tag keys to delete








Class com.amazonaws.services.greengrass.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.UpdateConnectivityInfoRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectivityInfo
List<E> connectivityInfo
A list of connectivity info.


thingName
String thingName
The thing name.








Class com.amazonaws.services.greengrass.model.UpdateConnectivityInfoResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


message
String message
A message about the connectivity info update request.


version
String version
The new version of the connectivity info.








Class com.amazonaws.services.greengrass.model.UpdateConnectorDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


connectorDefinitionId
String connectorDefinitionId
The ID of the connector definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.UpdateConnectorDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.UpdateCoreDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


coreDefinitionId
String coreDefinitionId
The ID of the core definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.UpdateCoreDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.UpdateDeviceDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceDefinitionId
String deviceDefinitionId
The ID of the device definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.UpdateDeviceDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.UpdateFunctionDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionDefinitionId
String functionDefinitionId
The ID of the Lambda function definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.UpdateFunctionDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.UpdateGroupCertificateConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateExpiryInMilliseconds
String certificateExpiryInMilliseconds
The amount of time remaining before the certificate expires, in milliseconds.


groupId
String groupId
The ID of the Greengrass group.








Class com.amazonaws.services.greengrass.model.UpdateGroupCertificateConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificateAuthorityExpiryInMilliseconds
String certificateAuthorityExpiryInMilliseconds
The amount of time remaining before the certificate authority expires, in milliseconds.


certificateExpiryInMilliseconds
String certificateExpiryInMilliseconds
The amount of time remaining before the certificate expires, in milliseconds.


groupId
String groupId
The ID of the group certificate configuration.








Class com.amazonaws.services.greengrass.model.UpdateGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupId
String groupId
The ID of the Greengrass group.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.UpdateGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.UpdateLoggerDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loggerDefinitionId
String loggerDefinitionId
The ID of the logger definition.


name
String name
The name of the definition.








Class com.amazonaws.services.greengrass.model.UpdateLoggerDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.UpdateResourceDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name
The name of the definition.


resourceDefinitionId
String resourceDefinitionId
The ID of the resource definition.








Class com.amazonaws.services.greengrass.model.UpdateResourceDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.UpdateSubscriptionDefinitionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name
The name of the definition.


subscriptionDefinitionId
String subscriptionDefinitionId
The ID of the subscription definition.








Class com.amazonaws.services.greengrass.model.UpdateSubscriptionDefinitionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.greengrass.model.VersionInformation extends Object implements Serializable


Serialized Fields


arn
String arn
The ARN of the version.


creationTimestamp
String creationTimestamp
The time, in milliseconds since the epoch, when the version was created.


id
String id
The ID of the parent definition that the version is associated with.


version
String version
The ID of the version.








Package com.amazonaws.services.groundstation.model




Class com.amazonaws.services.groundstation.model.AntennaDownlinkConfig extends Object implements Serializable


Serialized Fields


spectrumConfig
SpectrumConfig spectrumConfig

 Object that describes a spectral Config.
 








Class com.amazonaws.services.groundstation.model.AntennaDownlinkDemodDecodeConfig extends Object implements Serializable


Serialized Fields


decodeConfig
DecodeConfig decodeConfig

 Information about the decode Config.
 


demodulationConfig
DemodulationConfig demodulationConfig

 Information about the demodulation Config.
 


spectrumConfig
SpectrumConfig spectrumConfig

 Information about the spectral Config.
 








Class com.amazonaws.services.groundstation.model.AntennaUplinkConfig extends Object implements Serializable


Serialized Fields


spectrumConfig
UplinkSpectrumConfig spectrumConfig

 Information about the uplink spectral Config.
 


targetEirp
Eirp targetEirp

 EIRP of the target.
 








Class com.amazonaws.services.groundstation.model.AWSGroundStationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.groundstation.model.CancelContactRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


contactId
String contactId

 UUID of a contact.
 








Class com.amazonaws.services.groundstation.model.CancelContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contactId
String contactId

 UUID of a contact.
 








Class com.amazonaws.services.groundstation.model.ConfigListItem extends Object implements Serializable


Serialized Fields


configArn
String configArn

 ARN of a Config.
 


configId
String configId

 UUID of a Config.
 


configType
String configType

 Type of a Config.
 


name
String name

 Name of a Config.
 








Class com.amazonaws.services.groundstation.model.ConfigTypeData extends Object implements Serializable


Serialized Fields


antennaDownlinkConfig
AntennaDownlinkConfig antennaDownlinkConfig

 Information about how AWS Ground Station should configure an antenna for downlink during a contact.
 


antennaDownlinkDemodDecodeConfig
AntennaDownlinkDemodDecodeConfig antennaDownlinkDemodDecodeConfig

 Information about how AWS Ground Station should conﬁgure an antenna for downlink demod decode during a contact.
 


antennaUplinkConfig
AntennaUplinkConfig antennaUplinkConfig

 Information about how AWS Ground Station should conﬁgure an antenna for uplink during a contact.
 


dataflowEndpointConfig
DataflowEndpointConfig dataflowEndpointConfig

 Information about the dataflow endpoint Config.
 


trackingConfig
TrackingConfig trackingConfig

 Object that determines whether tracking should be used during a contact executed with this Config in
 the mission profile.
 


uplinkEchoConfig
UplinkEchoConfig uplinkEchoConfig

 Information about an uplink echo Config.
 
 
 Parameters from the AntennaUplinkConfig, corresponding to the specified
 AntennaUplinkConfigArn, are used when this UplinkEchoConfig is used in a contact.
 








Class com.amazonaws.services.groundstation.model.ContactData extends Object implements Serializable


Serialized Fields


contactId
String contactId

 UUID of a contact.
 


contactStatus
String contactStatus

 Status of a contact.
 


endTime
Date endTime

 End time of a contact.
 


errorMessage
String errorMessage

 Error message of a contact.
 


groundStation
String groundStation

 Name of a ground station.
 


maximumElevation
Elevation maximumElevation

 Maximum elevation angle of a contact.
 


missionProfileArn
String missionProfileArn

 ARN of a mission profile.
 


postPassEndTime
Date postPassEndTime

 Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has
 finished.
 


prePassStartTime
Date prePassStartTime

 Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
 


satelliteArn
String satelliteArn

 ARN of a satellite.
 


startTime
Date startTime

 Start time of a contact.
 


tags
Map<K,V> tags

 Tags assigned to a contact.
 








Class com.amazonaws.services.groundstation.model.CreateConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configData
ConfigTypeData configData

 Parameters of a Config.
 


name
String name

 Name of a Config.
 


tags
Map<K,V> tags

 Tags assigned to a Config.
 








Class com.amazonaws.services.groundstation.model.CreateConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configArn
String configArn

 ARN of a Config.
 


configId
String configId

 UUID of a Config.
 


configType
String configType

 Type of a Config.
 








Class com.amazonaws.services.groundstation.model.CreateDataflowEndpointGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointDetails
List<E> endpointDetails

 Endpoint details of each endpoint in the dataflow endpoint group.
 


tags
Map<K,V> tags

 Tags of a dataflow endpoint group.
 








Class com.amazonaws.services.groundstation.model.CreateDataflowEndpointGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataflowEndpointGroupId
String dataflowEndpointGroupId

 ID of a dataflow endpoint group.
 








Class com.amazonaws.services.groundstation.model.CreateMissionProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


contactPostPassDurationSeconds
Integer contactPostPassDurationSeconds

 Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has
 finished.
 


contactPrePassDurationSeconds
Integer contactPrePassDurationSeconds

 Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
 


dataflowEdges
List<E> dataflowEdges

 A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to
 Config.
 


minimumViableContactDurationSeconds
Integer minimumViableContactDurationSeconds

 Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not
 present you with contacts shorter than this duration.
 


name
String name

 Name of a mission profile.
 


tags
Map<K,V> tags

 Tags assigned to a mission profile.
 


trackingConfigArn
String trackingConfigArn

 ARN of a tracking Config.
 








Class com.amazonaws.services.groundstation.model.CreateMissionProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


missionProfileId
String missionProfileId

 ID of a mission profile.
 








Class com.amazonaws.services.groundstation.model.DataflowEndpoint extends Object implements Serializable


Serialized Fields


address
SocketAddress address

 Socket address of a dataflow endpoint.
 


name
String name

 Name of a dataflow endpoint.
 


status
String status

 Status of a dataflow endpoint.
 








Class com.amazonaws.services.groundstation.model.DataflowEndpointConfig extends Object implements Serializable


Serialized Fields


dataflowEndpointName
String dataflowEndpointName

 Name of a dataflow endpoint.
 








Class com.amazonaws.services.groundstation.model.DataflowEndpointListItem extends Object implements Serializable


Serialized Fields


dataflowEndpointGroupArn
String dataflowEndpointGroupArn

 ARN of a dataflow endpoint group.
 


dataflowEndpointGroupId
String dataflowEndpointGroupId

 UUID of a dataflow endpoint group.
 








Class com.amazonaws.services.groundstation.model.DecodeConfig extends Object implements Serializable


Serialized Fields


unvalidatedJSON
String unvalidatedJSON

 Unvalidated JSON of a decode Config.
 








Class com.amazonaws.services.groundstation.model.DeleteConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configId
String configId

 UUID of a Config.
 


configType
String configType

 Type of a Config.
 








Class com.amazonaws.services.groundstation.model.DeleteConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configArn
String configArn

 ARN of a Config.
 


configId
String configId

 UUID of a Config.
 


configType
String configType

 Type of a Config.
 








Class com.amazonaws.services.groundstation.model.DeleteDataflowEndpointGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataflowEndpointGroupId
String dataflowEndpointGroupId

 ID of a dataflow endpoint group.
 








Class com.amazonaws.services.groundstation.model.DeleteDataflowEndpointGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataflowEndpointGroupId
String dataflowEndpointGroupId

 ID of a dataflow endpoint group.
 








Class com.amazonaws.services.groundstation.model.DeleteMissionProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


missionProfileId
String missionProfileId

 UUID of a mission profile.
 








Class com.amazonaws.services.groundstation.model.DeleteMissionProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


missionProfileId
String missionProfileId

 ID of a mission profile.
 








Class com.amazonaws.services.groundstation.model.DemodulationConfig extends Object implements Serializable


Serialized Fields


unvalidatedJSON
String unvalidatedJSON

 Unvalidated JSON of a demodulation Config.
 








Class com.amazonaws.services.groundstation.model.DependencyException extends AWSGroundStationException implements Serializable

serialVersionUID:
1L



Serialized Fields


parameterName
String parameterName









Class com.amazonaws.services.groundstation.model.DescribeContactRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


contactId
String contactId

 UUID of a contact.
 








Class com.amazonaws.services.groundstation.model.DescribeContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contactId
String contactId

 UUID of a contact.
 


contactStatus
String contactStatus

 Status of a contact.
 


endTime
Date endTime

 End time of a contact.
 


errorMessage
String errorMessage

 Error message for a contact.
 


groundStation
String groundStation

 Ground station for a contact.
 


maximumElevation
Elevation maximumElevation

 Maximum elevation angle of a contact.
 


missionProfileArn
String missionProfileArn

 ARN of a mission profile.
 


postPassEndTime
Date postPassEndTime

 Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has
 finished.
 


prePassStartTime
Date prePassStartTime

 Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
 


satelliteArn
String satelliteArn

 ARN of a satellite.
 


startTime
Date startTime

 Start time of a contact.
 


tags
Map<K,V> tags

 Tags assigned to a contact.
 








Class com.amazonaws.services.groundstation.model.Eirp extends Object implements Serializable


Serialized Fields


units
String units

 Units of an EIRP.
 


value
Double value

 Value of an EIRP.
 








Class com.amazonaws.services.groundstation.model.Elevation extends Object implements Serializable


Serialized Fields


unit
String unit

 Elevation angle units.
 


value
Double value

 Elevation angle value.
 








Class com.amazonaws.services.groundstation.model.EndpointDetails extends Object implements Serializable


Serialized Fields


endpoint
DataflowEndpoint endpoint

 A dataflow endpoint.
 


securityDetails
SecurityDetails securityDetails

 Endpoint security details.
 








Class com.amazonaws.services.groundstation.model.Frequency extends Object implements Serializable


Serialized Fields


units
String units

 Frequency units.
 


value
Double value

 Frequency value.
 








Class com.amazonaws.services.groundstation.model.FrequencyBandwidth extends Object implements Serializable


Serialized Fields


units
String units

 Frequency bandwidth units.
 


value
Double value

 Frequency bandwidth value.
 








Class com.amazonaws.services.groundstation.model.GetConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configId
String configId

 UUID of a Config.
 


configType
String configType

 Type of a Config.
 








Class com.amazonaws.services.groundstation.model.GetConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configArn
String configArn

 ARN of a Config
 


configData
ConfigTypeData configData

 Data elements in a Config.
 


configId
String configId

 UUID of a Config.
 


configType
String configType

 Type of a Config.
 


name
String name

 Name of a Config.
 


tags
Map<K,V> tags

 Tags assigned to a Config.
 








Class com.amazonaws.services.groundstation.model.GetDataflowEndpointGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataflowEndpointGroupId
String dataflowEndpointGroupId

 UUID of a dataflow endpoint group.
 








Class com.amazonaws.services.groundstation.model.GetDataflowEndpointGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataflowEndpointGroupArn
String dataflowEndpointGroupArn

 ARN of a dataflow endpoint group.
 


dataflowEndpointGroupId
String dataflowEndpointGroupId

 UUID of a dataflow endpoint group.
 


endpointsDetails
List<E> endpointsDetails

 Details of a dataflow endpoint.
 


tags
Map<K,V> tags

 Tags assigned to a dataflow endpoint group.
 








Class com.amazonaws.services.groundstation.model.GetMinuteUsageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


month
Integer month

 The month being requested, with a value of 1-12.
 


year
Integer year

 The year being requested, in the format of YYYY.
 








Class com.amazonaws.services.groundstation.model.GetMinuteUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


estimatedMinutesRemaining
Integer estimatedMinutesRemaining

 Estimated number of minutes remaining for an account, specific to the month being requested.
 


isReservedMinutesCustomer
Boolean isReservedMinutesCustomer

 Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month
 being requested.
 


totalReservedMinuteAllocation
Integer totalReservedMinuteAllocation

 Total number of reserved minutes allocated, specific to the month being requested.
 


totalScheduledMinutes
Integer totalScheduledMinutes

 Total scheduled minutes for an account, specific to the month being requested.
 


upcomingMinutesScheduled
Integer upcomingMinutesScheduled

 Upcoming minutes scheduled for an account, specific to the month being requested.
 








Class com.amazonaws.services.groundstation.model.GetMissionProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


missionProfileId
String missionProfileId

 UUID of a mission profile.
 








Class com.amazonaws.services.groundstation.model.GetMissionProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contactPostPassDurationSeconds
Integer contactPostPassDurationSeconds

 Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has
 finished.
 


contactPrePassDurationSeconds
Integer contactPrePassDurationSeconds

 Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
 


dataflowEdges
List<E> dataflowEdges

 A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to
 Config.
 


minimumViableContactDurationSeconds
Integer minimumViableContactDurationSeconds

 Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not
 present you with contacts shorter than this duration.
 


missionProfileArn
String missionProfileArn

 ARN of a mission profile.
 


missionProfileId
String missionProfileId

 ID of a mission profile.
 


name
String name

 Name of a mission profile.
 


region
String region

 Region of a mission profile.
 


tags
Map<K,V> tags

 Tags assigned to a mission profile.
 


trackingConfigArn
String trackingConfigArn

 ARN of a tracking Config.
 








Class com.amazonaws.services.groundstation.model.GetSatelliteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


satelliteId
String satelliteId

 UUID of a satellite.
 








Class com.amazonaws.services.groundstation.model.GetSatelliteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dateCreated
Date dateCreated

 When a satellite was created.
 


lastUpdated
Date lastUpdated

 When a satellite was last updated.
 


noradSatelliteID
Integer noradSatelliteID

 NORAD satellite ID number.
 


satelliteArn
String satelliteArn

 ARN of a satellite.
 


satelliteId
String satelliteId

 UUID of a satellite.
 


tags
Map<K,V> tags

 Tags assigned to a satellite.
 








Class com.amazonaws.services.groundstation.model.GroundStationData extends Object implements Serializable


Serialized Fields


groundStationId
String groundStationId

 ID of a ground station.
 


groundStationName
String groundStationName

 Name of a ground station.
 


region
String region

 Ground station Region.
 








Class com.amazonaws.services.groundstation.model.InvalidParameterException extends AWSGroundStationException implements Serializable

serialVersionUID:
1L



Serialized Fields


parameterName
String parameterName









Class com.amazonaws.services.groundstation.model.ListConfigsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 Maximum number of Configs returned.
 


nextToken
String nextToken

 Next token returned in the request of a previous ListConfigs call. Used to get the next page of
 results.
 








Class com.amazonaws.services.groundstation.model.ListConfigsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configList
List<E> configList

 List of Config items.
 


nextToken
String nextToken

 Next token returned in the response of a previous ListConfigs call. Used to get the next page of
 results.
 








Class com.amazonaws.services.groundstation.model.ListContactsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endTime
Date endTime

 End time of a contact.
 


groundStation
String groundStation

 Name of a ground station.
 


maxResults
Integer maxResults

 Maximum number of contacts returned.
 


missionProfileArn
String missionProfileArn

 ARN of a mission profile.
 


nextToken
String nextToken

 Next token returned in the request of a previous ListContacts call. Used to get the next page of
 results.
 


satelliteArn
String satelliteArn

 ARN of a satellite.
 


startTime
Date startTime

 Start time of a contact.
 


statusList
List<E> statusList

 Status of a contact reservation.
 








Class com.amazonaws.services.groundstation.model.ListContactsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contactList
List<E> contactList

 List of contacts.
 


nextToken
String nextToken

 Next token returned in the response of a previous ListContacts call. Used to get the next page of
 results.
 








Class com.amazonaws.services.groundstation.model.ListDataflowEndpointGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 Maximum number of dataflow endpoint groups returned.
 


nextToken
String nextToken

 Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the
 next page of results.
 








Class com.amazonaws.services.groundstation.model.ListDataflowEndpointGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataflowEndpointGroupList
List<E> dataflowEndpointGroupList

 A list of dataflow endpoint groups.
 


nextToken
String nextToken

 Next token returned in the response of a previous ListDataflowEndpointGroups call. Used to get the
 next page of results.
 








Class com.amazonaws.services.groundstation.model.ListGroundStationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 Maximum number of ground stations returned.
 


nextToken
String nextToken

 Next token that can be supplied in the next call to get the next page of ground stations.
 








Class com.amazonaws.services.groundstation.model.ListGroundStationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


groundStationList
List<E> groundStationList

 List of ground stations.
 


nextToken
String nextToken

 Next token that can be supplied in the next call to get the next page of ground stations.
 








Class com.amazonaws.services.groundstation.model.ListMissionProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 Maximum number of mission profiles returned.
 


nextToken
String nextToken

 Next token returned in the request of a previous ListMissionProfiles call. Used to get the next page
 of results.
 








Class com.amazonaws.services.groundstation.model.ListMissionProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


missionProfileList
List<E> missionProfileList

 List of mission profiles
 


nextToken
String nextToken

 Next token returned in the response of a previous ListMissionProfiles call. Used to get the next
 page of results.
 








Class com.amazonaws.services.groundstation.model.ListSatellitesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 Maximum number of satellites returned.
 


nextToken
String nextToken

 Next token that can be supplied in the next call to get the next page of satellites.
 








Class com.amazonaws.services.groundstation.model.ListSatellitesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 Next token that can be supplied in the next call to get the next page of satellites.
 


satellites
List<E> satellites

 List of satellites.
 








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


Serialized Fields


resourceArn
String resourceArn

 ARN of a resource.
 








Class com.amazonaws.services.groundstation.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 Tags assigned to a resource.
 








Class com.amazonaws.services.groundstation.model.MissionProfileListItem extends Object implements Serializable


Serialized Fields


missionProfileArn
String missionProfileArn

 ARN of a mission profile.
 


missionProfileId
String missionProfileId

 ID of a mission profile.
 


name
String name

 Name of a mission profile.
 


region
String region

 Region of a mission profile.
 








Class com.amazonaws.services.groundstation.model.ReserveContactRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endTime
Date endTime

 End time of a contact.
 


groundStation
String groundStation

 Name of a ground station.
 


missionProfileArn
String missionProfileArn

 ARN of a mission profile.
 


satelliteArn
String satelliteArn

 ARN of a satellite
 


startTime
Date startTime

 Start time of a contact.
 


tags
Map<K,V> tags

 Tags assigned to a contact.
 








Class com.amazonaws.services.groundstation.model.ReserveContactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contactId
String contactId

 UUID of a contact.
 








Class com.amazonaws.services.groundstation.model.ResourceNotFoundException extends AWSGroundStationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.groundstation.model.SatelliteListItem extends Object implements Serializable


Serialized Fields


noradSatelliteID
Integer noradSatelliteID

 NORAD satellite ID number.
 


satelliteArn
String satelliteArn

 ARN of a satellite.
 


satelliteId
String satelliteId

 ID of a satellite.
 








Class com.amazonaws.services.groundstation.model.SecurityDetails extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 ARN to a role needed for connecting streams to your instances.
 


securityGroupIds
List<E> securityGroupIds

 The security groups to attach to the elastic network interfaces.
 


subnetIds
List<E> subnetIds

 A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
 








Class com.amazonaws.services.groundstation.model.SocketAddress extends Object implements Serializable


Serialized Fields


name
String name

 Name of a socket address.
 


port
Integer port

 Port of a socket address.
 








Class com.amazonaws.services.groundstation.model.SpectrumConfig extends Object implements Serializable


Serialized Fields


bandwidth
FrequencyBandwidth bandwidth

 Bandwidth of a spectral Config.
 


centerFrequency
Frequency centerFrequency

 Center frequency of a spectral Config.
 


polarization
String polarization

 Polarization of a spectral Config.
 








Class com.amazonaws.services.groundstation.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 ARN of a resource tag.
 


tags
Map<K,V> tags

 Tags assigned to a resource.
 








Class com.amazonaws.services.groundstation.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.groundstation.model.TrackingConfig extends Object implements Serializable


Serialized Fields


autotrack
String autotrack

 Current setting for autotrack.
 








Class com.amazonaws.services.groundstation.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 ARN of a resource.
 


tagKeys
List<E> tagKeys

 Keys of a resource tag.
 








Class com.amazonaws.services.groundstation.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.groundstation.model.UpdateConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configData
ConfigTypeData configData

 Parameters for a Config.
 


configId
String configId

 UUID of a Config.
 


configType
String configType

 Type of a Config.
 


name
String name

 Name of a Config.
 








Class com.amazonaws.services.groundstation.model.UpdateConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configArn
String configArn

 ARN of a Config.
 


configId
String configId

 UUID of a Config.
 


configType
String configType

 Type of a Config.
 








Class com.amazonaws.services.groundstation.model.UpdateMissionProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


contactPostPassDurationSeconds
Integer contactPostPassDurationSeconds

 Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has
 finished.
 


contactPrePassDurationSeconds
Integer contactPrePassDurationSeconds

 Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has
 finished.
 


dataflowEdges
List<E> dataflowEdges

 A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to
 Config.
 


minimumViableContactDurationSeconds
Integer minimumViableContactDurationSeconds

 Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not
 present you with contacts shorter than this duration.
 


missionProfileId
String missionProfileId

 ID of a mission profile.
 


name
String name

 Name of a mission profile.
 


trackingConfigArn
String trackingConfigArn

 ARN of a tracking Config.
 








Class com.amazonaws.services.groundstation.model.UpdateMissionProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


missionProfileId
String missionProfileId

 ID of a mission profile.
 








Class com.amazonaws.services.groundstation.model.UplinkEchoConfig extends Object implements Serializable


Serialized Fields


antennaUplinkConfigArn
String antennaUplinkConfigArn

 ARN of an uplink Config.
 


enabled
Boolean enabled

 Whether or not an uplink Config is enabled.
 








Class com.amazonaws.services.groundstation.model.UplinkSpectrumConfig extends Object implements Serializable


Serialized Fields


centerFrequency
Frequency centerFrequency

 Center frequency of an uplink spectral Config.
 


polarization
String polarization

 Polarization of an uplink spectral Config.
 








Package com.amazonaws.services.guardduty.model




Class com.amazonaws.services.guardduty.model.AcceptInvitationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty member account.
 


masterId
String masterId

 The account ID of the master GuardDuty account whose invitation you're accepting.
 


invitationId
String invitationId

 This value is used to validate the master account to the member account.
 








Class com.amazonaws.services.guardduty.model.AcceptInvitationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.AccessKeyDetails extends Object implements Serializable


Serialized Fields


accessKeyId
String accessKeyId

 Access key ID of the user.
 


principalId
String principalId

 The principal ID of the user.
 


userName
String userName

 The name of the user.
 


userType
String userType

 The type of the user.
 








Class com.amazonaws.services.guardduty.model.AccountDetail extends Object implements Serializable


Serialized Fields


accountId
String accountId

 Member account ID.
 


email
String email

 Member account's email address.
 








Class com.amazonaws.services.guardduty.model.Action extends Object implements Serializable


Serialized Fields


actionType
String actionType

 GuardDuty Finding activity type.
 


awsApiCallAction
AwsApiCallAction awsApiCallAction

 Information about the AWS_API_CALL action described in this finding.
 


dnsRequestAction
DnsRequestAction dnsRequestAction

 Information about the DNS_REQUEST action described in this finding.
 


networkConnectionAction
NetworkConnectionAction networkConnectionAction

 Information about the NETWORK_CONNECTION action described in this finding.
 


portProbeAction
PortProbeAction portProbeAction

 Information about the PORT_PROBE action described in this finding.
 








Class com.amazonaws.services.guardduty.model.AmazonGuardDutyException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.guardduty.model.ArchiveFindingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID of the detector that specifies the GuardDuty service whose findings you want to archive.
 


findingIds
List<E> findingIds

 IDs of the findings that you want to archive.
 








Class com.amazonaws.services.guardduty.model.ArchiveFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.AwsApiCallAction extends Object implements Serializable


Serialized Fields


api
String api

 AWS API name.
 


callerType
String callerType

 AWS API caller type.
 


domainDetails
DomainDetails domainDetails

 Domain information for the AWS API call.
 


remoteIpDetails
RemoteIpDetails remoteIpDetails

 Remote IP information of the connection.
 


serviceName
String serviceName

 AWS service name whose API was invoked.
 








Class com.amazonaws.services.guardduty.model.BadRequestException extends AmazonGuardDutyException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 The error type.
 








Class com.amazonaws.services.guardduty.model.City extends Object implements Serializable


Serialized Fields


cityName
String cityName

 City name of the remote IP address.
 








Class com.amazonaws.services.guardduty.model.Condition extends Object implements Serializable


Serialized Fields


eq
List<E> eq
Deprecated. 

 Represents the equal condition to be applied to a single field when querying for findings.
 


neq
List<E> neq
Deprecated. 

 Represents the not equal condition to be applied to a single field when querying for findings.
 


gt
Integer gt
Deprecated. 

 Represents a greater than condition to be applied to a single field when querying for findings.
 


gte
Integer gte
Deprecated. 

 Represents a greater than equal condition to be applied to a single field when querying for findings.
 


lt
Integer lt
Deprecated. 

 Represents a less than condition to be applied to a single field when querying for findings.
 


lte
Integer lte
Deprecated. 

 Represents a less than equal condition to be applied to a single field when querying for findings.
 


equals
List<E> equals

 Represents an equal condition to be applied to a single field when querying for findings.
 


notEquals
List<E> notEquals

 Represents an not equal condition to be applied to a single field when querying for findings.
 


greaterThan
Long greaterThan

 Represents a greater than condition to be applied to a single field when querying for findings.
 


greaterThanOrEqual
Long greaterThanOrEqual

 Represents a greater than equal condition to be applied to a single field when querying for findings.
 


lessThan
Long lessThan

 Represents a less than condition to be applied to a single field when querying for findings.
 


lessThanOrEqual
Long lessThanOrEqual

 Represents a less than equal condition to be applied to a single field when querying for findings.
 








Class com.amazonaws.services.guardduty.model.Country extends Object implements Serializable


Serialized Fields


countryCode
String countryCode

 Country code of the remote IP address.
 


countryName
String countryName

 Country name of the remote IP address.
 








Class com.amazonaws.services.guardduty.model.CreateDetectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


enable
Boolean enable

 A boolean value that specifies whether the detector is to be enabled.
 


clientToken
String clientToken

 The idempotency token for the create request.
 


findingPublishingFrequency
String findingPublishingFrequency

 A enum value that specifies how frequently customer got Finding updates published.
 


tags
Map<K,V> tags

 The tags to be added to a new detector resource.
 








Class com.amazonaws.services.guardduty.model.CreateDetectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the created detector.
 








Class com.amazonaws.services.guardduty.model.CreateFilterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty account for which you want to create a filter.
 


name
String name

 The name of the filter.
 


description
String description

 The description of the filter.
 


action
String action

 Specifies the action that is to be applied to the findings that match the filter.
 


rank
Integer rank

 Specifies the position of the filter in the list of current filters. Also specifies the order in which this
 filter is applied to the findings.
 


findingCriteria
FindingCriteria findingCriteria

 Represents the criteria to be used in the filter for querying findings.
 


clientToken
String clientToken

 The idempotency token for the create request.
 


tags
Map<K,V> tags

 The tags to be added to a new filter resource.
 








Class com.amazonaws.services.guardduty.model.CreateFilterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the successfully created filter.
 








Class com.amazonaws.services.guardduty.model.CreateIPSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.
 


name
String name

 The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by
 activity that involves IP addresses included in this IPSet.
 


format
String format

 The format of the file that contains the IPSet.
 


location
String location

 The URI of the file that contains the IPSet. For example
 (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
 


activate
Boolean activate

 A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.
 


clientToken
String clientToken

 The idempotency token for the create request.
 


tags
Map<K,V> tags

 The tags to be added to a new IP set resource.
 








Class com.amazonaws.services.guardduty.model.CreateIPSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ipSetId
String ipSetId

 The ID of the IPSet resource.
 








Class com.amazonaws.services.guardduty.model.CreateMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty account with which you want to associate member accounts.
 


accountDetails
List<E> accountDetails

 A list of account ID and email address pairs of the accounts that you want to associate with the master GuardDuty
 account.
 








Class com.amazonaws.services.guardduty.model.CreateMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unprocessedAccounts
List<E> unprocessedAccounts

 A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
 








Class com.amazonaws.services.guardduty.model.CreatePublishingDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID of the GuardDuty detector associated with the publishing destination.
 


destinationType
String destinationType

 The type of resource for the publishing destination. Currently only S3 is supported.
 


destinationProperties
DestinationProperties destinationProperties

 Properties of the publishing destination, including the ARNs for the destination and the KMS key used for
 encryption.
 


clientToken
String clientToken

 The idempotency token for the request.
 








Class com.amazonaws.services.guardduty.model.CreatePublishingDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


destinationId
String destinationId

 The ID of the publishing destination created.
 








Class com.amazonaws.services.guardduty.model.CreateSampleFindingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID of the detector to create sample findings for.
 


findingTypes
List<E> findingTypes

 Types of sample findings to generate.
 








Class com.amazonaws.services.guardduty.model.CreateSampleFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.CreateThreatIntelSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty account for which you want to create a threatIntelSet.
 


name
String name

 A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP
 addresses included in this ThreatIntelSet.
 


format
String format

 The format of the file that contains the ThreatIntelSet.
 


location
String location

 The URI of the file that contains the ThreatIntelSet. For example
 (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
 


activate
Boolean activate

 A boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.
 


clientToken
String clientToken

 The idempotency token for the create request.
 


tags
Map<K,V> tags

 The tags to be added to a new Threat List resource.
 








Class com.amazonaws.services.guardduty.model.CreateThreatIntelSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


threatIntelSetId
String threatIntelSetId

 The ID of the ThreatIntelSet resource.
 








Class com.amazonaws.services.guardduty.model.DeclineInvitationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountIds
List<E> accountIds

 A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to
 decline invitations from.
 








Class com.amazonaws.services.guardduty.model.DeclineInvitationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unprocessedAccounts
List<E> unprocessedAccounts

 A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
 








Class com.amazonaws.services.guardduty.model.DeleteDetectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector that you want to delete.
 








Class com.amazonaws.services.guardduty.model.DeleteDetectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.DeleteFilterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector the filter is associated with.
 


filterName
String filterName

 The name of the filter you want to delete.
 








Class com.amazonaws.services.guardduty.model.DeleteFilterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.DeleteInvitationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountIds
List<E> accountIds

 A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to
 delete invitations from.
 








Class com.amazonaws.services.guardduty.model.DeleteInvitationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unprocessedAccounts
List<E> unprocessedAccounts

 A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
 








Class com.amazonaws.services.guardduty.model.DeleteIPSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector associated with the IPSet.
 


ipSetId
String ipSetId

 The unique ID of the IPSet to delete.
 








Class com.amazonaws.services.guardduty.model.DeleteIPSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.DeleteMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty account whose members you want to delete.
 


accountIds
List<E> accountIds

 A list of account IDs of the GuardDuty member accounts that you want to delete.
 








Class com.amazonaws.services.guardduty.model.DeleteMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unprocessedAccounts
List<E> unprocessedAccounts

 The accounts that could not be processed.
 








Class com.amazonaws.services.guardduty.model.DeletePublishingDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector associated with the publishing destination to delete.
 


destinationId
String destinationId

 The ID of the publishing destination to delete.
 








Class com.amazonaws.services.guardduty.model.DeletePublishingDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.DeleteThreatIntelSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector the threatIntelSet is associated with.
 


threatIntelSetId
String threatIntelSetId

 The unique ID of the threatIntelSet you want to delete.
 








Class com.amazonaws.services.guardduty.model.DeleteThreatIntelSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.DescribePublishingDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector associated with the publishing destination to retrieve.
 


destinationId
String destinationId

 The ID of the publishing destination to retrieve.
 








Class com.amazonaws.services.guardduty.model.DescribePublishingDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


destinationId
String destinationId

 The ID of the publishing destination.
 


destinationType
String destinationType

 The type of the publishing destination. Currently, only S3 is supported.
 


status
String status

 The status of the publishing destination.
 


publishingFailureStartTimestamp
Long publishingFailureStartTimestamp

 The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the
 destination.
 


destinationProperties
DestinationProperties destinationProperties

 A DestinationProperties object that includes the DestinationArn and
 KmsKeyArn of the publishing destination.
 








Class com.amazonaws.services.guardduty.model.Destination extends Object implements Serializable


Serialized Fields


destinationId
String destinationId

 The unique ID of the publishing destination.
 


destinationType
String destinationType

 The type of resource used for the publishing destination. Currently, only S3 is supported.
 


status
String status

 The status of the publishing destination.
 








Class com.amazonaws.services.guardduty.model.DestinationProperties extends Object implements Serializable


Serialized Fields


destinationArn
String destinationArn

 The ARN of the resource to publish to.
 


kmsKeyArn
String kmsKeyArn

 The ARN of the KMS key to use for encryption.
 








Class com.amazonaws.services.guardduty.model.DisassociateFromMasterAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty member account.
 








Class com.amazonaws.services.guardduty.model.DisassociateFromMasterAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.DisassociateMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty account whose members you want to disassociate from master.
 


accountIds
List<E> accountIds

 A list of account IDs of the GuardDuty member accounts that you want to disassociate from master.
 








Class com.amazonaws.services.guardduty.model.DisassociateMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unprocessedAccounts
List<E> unprocessedAccounts

 A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
 








Class com.amazonaws.services.guardduty.model.DnsRequestAction extends Object implements Serializable


Serialized Fields


domain
String domain

 Domain information for the API request.
 








Class com.amazonaws.services.guardduty.model.DomainDetails extends Object implements Serializable


Serialized Fields


domain
String domain

 Domain information for the AWS API call.
 








Class com.amazonaws.services.guardduty.model.Evidence extends Object implements Serializable


Serialized Fields


threatIntelligenceDetails
List<E> threatIntelligenceDetails

 A list of threat intelligence details related to the evidence.
 








Class com.amazonaws.services.guardduty.model.Finding extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The ID of the account in which the finding was generated.
 


arn
String arn

 The ARN for the finding.
 


confidence
Double confidence

 The confidence score for the finding.
 


createdAt
String createdAt

 The time and date at which the finding was created.
 


description
String description

 The description of the finding.
 


id
String id

 The ID of the finding.
 


partition
String partition

 The partition associated with the finding.
 


region
String region

 The Region in which the finding was generated.
 


resource
Resource resource


schemaVersion
String schemaVersion

 The version of the schema used for the finding.
 


service
Service service


severity
Double severity

 The severity of the finding.
 


title
String title

 The title for the finding.
 


type
String type

 The type of the finding.
 


updatedAt
String updatedAt

 The time and date at which the finding was laste updated.
 








Class com.amazonaws.services.guardduty.model.FindingCriteria extends Object implements Serializable


Serialized Fields


criterion
Map<K,V> criterion

 Represents a map of finding properties that match specified conditions and values when querying findings.
 








Class com.amazonaws.services.guardduty.model.FindingStatistics extends Object implements Serializable


Serialized Fields


countBySeverity
Map<K,V> countBySeverity

 Represents a map of severity to count statistic for a set of findings
 








Class com.amazonaws.services.guardduty.model.GeoLocation extends Object implements Serializable


Serialized Fields


lat
Double lat

 Latitude information of remote IP address.
 


lon
Double lon

 Longitude information of remote IP address.
 








Class com.amazonaws.services.guardduty.model.GetDetectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector that you want to get.
 








Class com.amazonaws.services.guardduty.model.GetDetectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


createdAt
String createdAt

 Detector creation timestamp.
 


findingPublishingFrequency
String findingPublishingFrequency

 Finding publishing frequency.
 


serviceRole
String serviceRole

 The GuardDuty service role.
 


status
String status

 The detector status.
 


updatedAt
String updatedAt

 Detector last update timestamp.
 


tags
Map<K,V> tags

 The tags of the detector resource.
 








Class com.amazonaws.services.guardduty.model.GetFilterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector the filter is associated with.
 


filterName
String filterName

 The name of the filter you want to get.
 








Class com.amazonaws.services.guardduty.model.GetFilterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the filter.
 


description
String description

 The description of the filter.
 


action
String action

 Specifies the action that is to be applied to the findings that match the filter.
 


rank
Integer rank

 Specifies the position of the filter in the list of current filters. Also specifies the order in which this
 filter is applied to the findings.
 


findingCriteria
FindingCriteria findingCriteria

 Represents the criteria to be used in the filter for querying findings.
 


tags
Map<K,V> tags

 The tags of the filter resource.
 








Class com.amazonaws.services.guardduty.model.GetFindingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve.
 


findingIds
List<E> findingIds

 IDs of the findings that you want to retrieve.
 


sortCriteria
SortCriteria sortCriteria

 Represents the criteria used for sorting findings.
 








Class com.amazonaws.services.guardduty.model.GetFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


findings
List<E> findings

 A list of findings.
 








Class com.amazonaws.services.guardduty.model.GetFindingsStatisticsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID of the detector that specifies the GuardDuty service whose findings' statistics you want to retrieve.
 


findingStatisticTypes
List<E> findingStatisticTypes

 Types of finding statistics to retrieve.
 


findingCriteria
FindingCriteria findingCriteria

 Represents the criteria used for querying findings.
 








Class com.amazonaws.services.guardduty.model.GetFindingsStatisticsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


findingStatistics
FindingStatistics findingStatistics

 Finding statistics object.
 








Class com.amazonaws.services.guardduty.model.GetInvitationsCountRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.guardduty.model.GetInvitationsCountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


invitationsCount
Integer invitationsCount

 The number of received invitations.
 








Class com.amazonaws.services.guardduty.model.GetIPSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector the ipSet is associated with.
 


ipSetId
String ipSetId

 The unique ID of the IPSet to retrieve.
 








Class com.amazonaws.services.guardduty.model.GetIPSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The user friendly name for the IPSet.
 


format
String format

 The format of the file that contains the IPSet.
 


location
String location

 The URI of the file that contains the IPSet. For example
 (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
 


status
String status

 The status of ipSet file uploaded.
 


tags
Map<K,V> tags

 The tags of the IP set resource.
 








Class com.amazonaws.services.guardduty.model.GetMasterAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty member account.
 








Class com.amazonaws.services.guardduty.model.GetMasterAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


master
Master master

 Master account details.
 








Class com.amazonaws.services.guardduty.model.GetMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty account whose members you want to retrieve.
 


accountIds
List<E> accountIds

 A list of account IDs of the GuardDuty member accounts that you want to describe.
 








Class com.amazonaws.services.guardduty.model.GetMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


members
List<E> members

 A list of members.
 


unprocessedAccounts
List<E> unprocessedAccounts

 A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
 








Class com.amazonaws.services.guardduty.model.GetThreatIntelSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector the threatIntelSet is associated with.
 


threatIntelSetId
String threatIntelSetId

 The unique ID of the threatIntelSet you want to get.
 








Class com.amazonaws.services.guardduty.model.GetThreatIntelSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP
 addresses included in this ThreatIntelSet.
 


format
String format

 The format of the threatIntelSet.
 


location
String location

 The URI of the file that contains the ThreatIntelSet. For example
 (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
 


status
String status

 The status of threatIntelSet file uploaded.
 


tags
Map<K,V> tags

 The tags of the Threat List resource.
 








Class com.amazonaws.services.guardduty.model.IamInstanceProfile extends Object implements Serializable


Serialized Fields


arn
String arn

 AWS EC2 instance profile ARN.
 


id
String id

 AWS EC2 instance profile ID.
 








Class com.amazonaws.services.guardduty.model.InstanceDetails extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The availability zone of the EC2 instance.
 


iamInstanceProfile
IamInstanceProfile iamInstanceProfile

 The profile information of the EC2 instance.
 


imageDescription
String imageDescription

 The image description of the EC2 instance.
 


imageId
String imageId

 The image ID of the EC2 instance.
 


instanceId
String instanceId

 The ID of the EC2 instance.
 


instanceState
String instanceState

 The state of the EC2 instance.
 


instanceType
String instanceType

 The type of the EC2 instance.
 


launchTime
String launchTime

 The launch time of the EC2 instance.
 


networkInterfaces
List<E> networkInterfaces

 The network interface information of the EC2 instance.
 


platform
String platform

 The platform of the EC2 instance.
 


productCodes
List<E> productCodes

 The product code of the EC2 instance.
 


tags
List<E> tags

 The tags of the EC2 instance.
 








Class com.amazonaws.services.guardduty.model.InternalServerErrorException extends AmazonGuardDutyException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 The error type.
 








Class com.amazonaws.services.guardduty.model.Invitation extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The ID of the account from which the invitations was sent.
 


invitationId
String invitationId

 The ID of the invitation. This value is used to validate the inviter account to the member account.
 


relationshipStatus
String relationshipStatus

 The status of the relationship between the inviter and invitee accounts.
 


invitedAt
String invitedAt

 Timestamp at which the invitation was sent.
 








Class com.amazonaws.services.guardduty.model.InviteMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty account with which you want to invite members.
 


accountIds
List<E> accountIds

 A list of account IDs of the accounts that you want to invite to GuardDuty as members.
 


disableEmailNotification
Boolean disableEmailNotification

 A boolean value that specifies whether you want to disable email notification to the accounts that you’re
 inviting to GuardDuty as members.
 


message
String message

 The invitation message that you want to send to the accounts that you’re inviting to GuardDuty as members.
 








Class com.amazonaws.services.guardduty.model.InviteMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unprocessedAccounts
List<E> unprocessedAccounts

 A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
 








Class com.amazonaws.services.guardduty.model.ListDetectorsRequest 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
 50. The maximum value is 50.
 


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 list action. For 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.guardduty.model.ListDetectorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detectorIds
List<E> detectorIds

 A list of detector Ids.
 


nextToken
String nextToken

 Pagination parameter to be used on the next list operation to retrieve more items.
 








Class com.amazonaws.services.guardduty.model.ListFiltersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector the filter is associated with.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 50. The maximum value is 50.
 


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 list action. For 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.guardduty.model.ListFiltersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


filterNames
List<E> filterNames

 A list of filter names
 


nextToken
String nextToken

 Pagination parameter to be used on the next list operation to retrieve more items.
 








Class com.amazonaws.services.guardduty.model.ListFindingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID of the detector that specifies the GuardDuty service whose findings you want to list.
 


findingCriteria
FindingCriteria findingCriteria

 Represents the criteria used for querying findings. Valid values include:
 
 
 
 
 JSON field name
 
 
 
 
 accountId
 
 
 
 
 region
 
 
 
 
 confidence
 
 
 
 
 id
 
 
 
 
 resource.accessKeyDetails.accessKeyId
 
 
 
 
 resource.accessKeyDetails.principalId
 
 
 
 
 resource.accessKeyDetails.userName
 
 
 
 
 resource.accessKeyDetails.userType
 
 
 
 
 resource.instanceDetails.iamInstanceProfile.id
 
 
 
 
 resource.instanceDetails.imageId
 
 
 
 
 resource.instanceDetails.instanceId
 
 
 
 
 resource.instanceDetails.networkInterfaces.ipv6Addresses
 
 
 
 
 resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
 
 
 
 
 resource.instanceDetails.networkInterfaces.publicDnsName
 
 
 
 
 resource.instanceDetails.networkInterfaces.publicIp
 
 
 
 
 resource.instanceDetails.networkInterfaces.securityGroups.groupId
 
 
 
 
 resource.instanceDetails.networkInterfaces.securityGroups.groupName
 
 
 
 
 resource.instanceDetails.networkInterfaces.subnetId
 
 
 
 
 resource.instanceDetails.networkInterfaces.vpcId
 
 
 
 
 resource.instanceDetails.tags.key
 
 
 
 
 resource.instanceDetails.tags.value
 
 
 
 
 resource.resourceType
 
 
 
 
 service.action.actionType
 
 
 
 
 service.action.awsApiCallAction.api
 
 
 
 
 service.action.awsApiCallAction.callerType
 
 
 
 
 service.action.awsApiCallAction.remoteIpDetails.city.cityName
 
 
 
 
 service.action.awsApiCallAction.remoteIpDetails.country.countryName
 
 
 
 
 service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
 
 
 
 
 service.action.awsApiCallAction.remoteIpDetails.organization.asn
 
 
 
 
 service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
 
 
 
 
 service.action.awsApiCallAction.serviceName
 
 
 
 
 service.action.dnsRequestAction.domain
 
 
 
 
 service.action.networkConnectionAction.blocked
 
 
 
 
 service.action.networkConnectionAction.connectionDirection
 
 
 
 
 service.action.networkConnectionAction.localPortDetails.port
 
 
 
 
 service.action.networkConnectionAction.protocol
 
 
 
 
 service.action.networkConnectionAction.remoteIpDetails.city.cityName
 
 
 
 
 service.action.networkConnectionAction.remoteIpDetails.country.countryName
 
 
 
 
 service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
 
 
 
 
 service.action.networkConnectionAction.remoteIpDetails.organization.asn
 
 
 
 
 service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
 
 
 
 
 service.action.networkConnectionAction.remotePortDetails.port
 
 
 
 
 service.additionalInfo.threatListName
 
 
 
 
 service.archived
 
 
 When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only
 unarchived findings are listed. When this attribute is not set, all existing findings are listed.
 
 
 
 
 service.resourceRole
 
 
 
 
 severity
 
 
 
 
 type
 
 
 
 
 updatedAt
 
 
 Type: Timestamp in Unix Epoch millisecond format: 1486685375000
 
 
 


sortCriteria
SortCriteria sortCriteria

 Represents the criteria used for sorting findings.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 50. The maximum value is 50.
 


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 list action. For 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.guardduty.model.ListFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


findingIds
List<E> findingIds

 The IDs of the findings you are listing.
 


nextToken
String nextToken

 Pagination parameter to be used on the next list operation to retrieve more items.
 








Class com.amazonaws.services.guardduty.model.ListInvitationsRequest 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
 50. The maximum value is 50.
 


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 list action. For 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.guardduty.model.ListInvitationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


invitations
List<E> invitations

 A list of invitation descriptions.
 


nextToken
String nextToken

 Pagination parameter to be used on the next list operation to retrieve more items.
 








Class com.amazonaws.services.guardduty.model.ListIPSetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector the ipSet is associated with.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 50. The maximum value is 50.
 


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 list action. For 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.guardduty.model.ListIPSetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ipSetIds
List<E> ipSetIds

 The IDs of the IPSet resources.
 


nextToken
String nextToken

 Pagination parameter to be used on the next list operation to retrieve more items.
 








Class com.amazonaws.services.guardduty.model.ListMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector the member is associated with.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 50. The maximum value is 50.
 


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 list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken
 from the previous response to continue listing data.
 


onlyAssociated
String onlyAssociated

 Specifies whether to only return associated members or to return all members (including members which haven't
 been invited yet or have been disassociated).
 








Class com.amazonaws.services.guardduty.model.ListMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


members
List<E> members

 A list of members.
 


nextToken
String nextToken

 Pagination parameter to be used on the next list operation to retrieve more items.
 








Class com.amazonaws.services.guardduty.model.ListPublishingDestinationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID of the detector to retrieve publishing destinations for.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response.
 


nextToken
String nextToken

 A token to use for paginating results returned in the repsonse. Set the value of this parameter to null for the
 first request to a list action. For subsequent calls, use the NextToken value returned from the
 previous request to continue listing results after the first page.
 








Class com.amazonaws.services.guardduty.model.ListPublishingDestinationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


destinations
List<E> destinations

 A Destinations obect that includes information about each publishing destination returned.
 


nextToken
String nextToken

 A token to use for paginating results returned in the repsonse. Set the value of this parameter to null for the
 first request to a list action. For subsequent calls, use the NextToken value returned from the
 previous request to continue listing results after the first page.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) for the given GuardDuty resource
 








Class com.amazonaws.services.guardduty.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The tags associated with the resource.
 








Class com.amazonaws.services.guardduty.model.ListThreatIntelSetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector the threatIntelSet is associated with.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 50. The maximum value is 50.
 


nextToken
String nextToken

 You can use this parameter to paginate results in the response. Set the value of this parameter to null on your
 first call to the list action. For 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.guardduty.model.ListThreatIntelSetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


threatIntelSetIds
List<E> threatIntelSetIds

 The IDs of the ThreatIntelSet resources.
 


nextToken
String nextToken

 Pagination parameter to be used on the next list operation to retrieve more items.
 








Class com.amazonaws.services.guardduty.model.LocalPortDetails extends Object implements Serializable


Serialized Fields


port
Integer port

 Port number of the local connection.
 


portName
String portName

 Port name of the local connection.
 








Class com.amazonaws.services.guardduty.model.Master extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The ID of the account used as the Master account.
 


invitationId
String invitationId

 This value is used to validate the master account to the member account.
 


relationshipStatus
String relationshipStatus

 The status of the relationship between the master and member accounts.
 


invitedAt
String invitedAt

 Timestamp at which the invitation was sent.
 








Class com.amazonaws.services.guardduty.model.Member extends Object implements Serializable


Serialized Fields


accountId
String accountId

 Member account ID.
 


detectorId
String detectorId

 Member account's detector ID.
 


masterId
String masterId

 Master account ID.
 


email
String email

 Member account's email address.
 


relationshipStatus
String relationshipStatus

 The status of the relationship between the member and the master.
 


invitedAt
String invitedAt

 Timestamp at which the invitation was sent
 


updatedAt
String updatedAt

 Member last updated timestamp.
 








Class com.amazonaws.services.guardduty.model.NetworkConnectionAction extends Object implements Serializable


Serialized Fields


blocked
Boolean blocked

 Network connection blocked information.
 


connectionDirection
String connectionDirection

 Network connection direction.
 


localPortDetails
LocalPortDetails localPortDetails

 Local port information of the connection.
 


protocol
String protocol

 Network connection protocol.
 


remoteIpDetails
RemoteIpDetails remoteIpDetails

 Remote IP information of the connection.
 


remotePortDetails
RemotePortDetails remotePortDetails

 Remote port information of the connection.
 








Class com.amazonaws.services.guardduty.model.NetworkInterface extends Object implements Serializable


Serialized Fields


ipv6Addresses
List<E> ipv6Addresses

 A list of EC2 instance IPv6 address information.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface
 


privateDnsName
String privateDnsName

 Private DNS name of the EC2 instance.
 


privateIpAddress
String privateIpAddress

 Private IP address of the EC2 instance.
 


privateIpAddresses
List<E> privateIpAddresses

 Other private IP address information of the EC2 instance.
 


publicDnsName
String publicDnsName

 Public DNS name of the EC2 instance.
 


publicIp
String publicIp

 Public IP address of the EC2 instance.
 


securityGroups
List<E> securityGroups

 Security groups associated with the EC2 instance.
 


subnetId
String subnetId

 The subnet ID of the EC2 instance.
 


vpcId
String vpcId

 The VPC ID of the EC2 instance.
 








Class com.amazonaws.services.guardduty.model.Organization extends Object implements Serializable


Serialized Fields


asn
String asn

 Autonomous system number of the internet provider of the remote IP address.
 


asnOrg
String asnOrg

 Organization that registered this ASN.
 


isp
String isp

 ISP information for the internet provider.
 


org
String org

 Name of the internet provider.
 








Class com.amazonaws.services.guardduty.model.PortProbeAction extends Object implements Serializable


Serialized Fields


blocked
Boolean blocked

 Port probe blocked information.
 


portProbeDetails
List<E> portProbeDetails

 A list of port probe details objects.
 








Class com.amazonaws.services.guardduty.model.PortProbeDetail extends Object implements Serializable


Serialized Fields


localPortDetails
LocalPortDetails localPortDetails

 Local port information of the connection.
 


remoteIpDetails
RemoteIpDetails remoteIpDetails

 Remote IP information of the connection.
 








Class com.amazonaws.services.guardduty.model.PrivateIpAddressDetails extends Object implements Serializable


Serialized Fields


privateDnsName
String privateDnsName

 Private DNS name of the EC2 instance.
 


privateIpAddress
String privateIpAddress

 Private IP address of the EC2 instance.
 








Class com.amazonaws.services.guardduty.model.ProductCode extends Object implements Serializable


Serialized Fields


code
String code

 Product code information.
 


productType
String productType

 Product code type.
 








Class com.amazonaws.services.guardduty.model.RemoteIpDetails extends Object implements Serializable


Serialized Fields


city
City city

 City information of the remote IP address.
 


country
Country country

 Country code of the remote IP address.
 


geoLocation
GeoLocation geoLocation

 Location information of the remote IP address.
 


ipAddressV4
String ipAddressV4

 IPV4 remote address of the connection.
 


organization
Organization organization

 ISP Organization information of the remote IP address.
 








Class com.amazonaws.services.guardduty.model.RemotePortDetails extends Object implements Serializable


Serialized Fields


port
Integer port

 Port number of the remote connection.
 


portName
String portName

 Port name of the remote connection.
 








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


Serialized Fields


accessKeyDetails
AccessKeyDetails accessKeyDetails

 The IAM access key details (IAM user information) of a user that engaged in the activity that prompted GuardDuty
 to generate a finding.
 


instanceDetails
InstanceDetails instanceDetails

 The information about the EC2 instance associated with the activity that prompted GuardDuty to generate a
 finding.
 


resourceType
String resourceType

 The type of the AWS resource.
 








Class com.amazonaws.services.guardduty.model.SecurityGroup extends Object implements Serializable


Serialized Fields


groupId
String groupId

 EC2 instance's security group ID.
 


groupName
String groupName

 EC2 instance's security group name.
 








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


Serialized Fields


action
Action action

 Information about the activity described in a finding.
 


evidence
Evidence evidence

 An evidence object associated with the service.
 


archived
Boolean archived

 Indicates whether this finding is archived.
 


count
Integer count

 Total count of the occurrences of this finding type.
 


detectorId
String detectorId

 Detector ID for the GuardDuty service.
 


eventFirstSeen
String eventFirstSeen

 First seen timestamp of the activity that prompted GuardDuty to generate this finding.
 


eventLastSeen
String eventLastSeen

 Last seen timestamp of the activity that prompted GuardDuty to generate this finding.
 


resourceRole
String resourceRole

 Resource role information for this finding.
 


serviceName
String serviceName

 The name of the AWS service (GuardDuty) that generated a finding.
 


userFeedback
String userFeedback

 Feedback left about the finding.
 








Class com.amazonaws.services.guardduty.model.SortCriteria extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 Represents the finding attribute (for example, accountId) by which to sort findings.
 


orderBy
String orderBy

 Order by which the sorted findings are to be displayed.
 








Class com.amazonaws.services.guardduty.model.StartMonitoringMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty master account associated with the member accounts to monitor.
 


accountIds
List<E> accountIds

 A list of account IDs of the GuardDuty member accounts to start monitoring.
 








Class com.amazonaws.services.guardduty.model.StartMonitoringMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unprocessedAccounts
List<E> unprocessedAccounts

 A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
 








Class com.amazonaws.services.guardduty.model.StopMonitoringMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector of the GuardDuty account that you want to stop from monitor members' findings.
 


accountIds
List<E> accountIds

 A list of account IDs of the GuardDuty member accounts whose findings you want the master account to stop
 monitoring.
 








Class com.amazonaws.services.guardduty.model.StopMonitoringMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


unprocessedAccounts
List<E> unprocessedAccounts

 A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
 








Class com.amazonaws.services.guardduty.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 EC2 instance tag key.
 


value
String value

 EC2 instance tag value.
 








Class com.amazonaws.services.guardduty.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) for the GuardDuty resource to apply a tag to.
 


tags
Map<K,V> tags

 The tags to be added to a resource.
 








Class com.amazonaws.services.guardduty.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.ThreatIntelligenceDetail extends Object implements Serializable


Serialized Fields


threatListName
String threatListName

 The name of the threat intelligence list that triggered the finding.
 


threatNames
List<E> threatNames

 A list of names of the threats in the threat intelligence list that triggered the finding.
 








Class com.amazonaws.services.guardduty.model.UnarchiveFindingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID of the detector associated with the findings to unarchive.
 


findingIds
List<E> findingIds

 IDs of the findings to unarchive.
 








Class com.amazonaws.services.guardduty.model.UnarchiveFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.UnprocessedAccount extends Object implements Serializable


Serialized Fields


accountId
String accountId

 AWS Account ID.
 


result
String result

 A reason why the account hasn't been processed.
 








Class com.amazonaws.services.guardduty.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) for the resource to remove tags from.
 


tagKeys
List<E> tagKeys

 The tag keys to remove from the resource.
 








Class com.amazonaws.services.guardduty.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.UpdateDetectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector to update.
 


enable
Boolean enable

 Specifies whether the detector is enabled or not enabled.
 


findingPublishingFrequency
String findingPublishingFrequency

 A enum value that specifies how frequently findings are exported, such as to CloudWatch Events.
 








Class com.amazonaws.services.guardduty.model.UpdateDetectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.UpdateFilterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The unique ID of the detector that specifies the GuardDuty service where you want to update a filter.
 


filterName
String filterName

 The name of the filter.
 


description
String description

 The description of the filter.
 


action
String action

 Specifies the action that is to be applied to the findings that match the filter.
 


rank
Integer rank

 Specifies the position of the filter in the list of current filters. Also specifies the order in which this
 filter is applied to the findings.
 


findingCriteria
FindingCriteria findingCriteria

 Represents the criteria to be used in the filter for querying findings.
 








Class com.amazonaws.services.guardduty.model.UpdateFilterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the filter.
 








Class com.amazonaws.services.guardduty.model.UpdateFindingsFeedbackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID of the detector associated with the findings to update feedback for.
 


findingIds
List<E> findingIds

 IDs of the findings that you want to mark as useful or not useful.
 


feedback
String feedback

 The feedback for the finding.
 


comments
String comments

 Additional feedback about the GuardDuty findings.
 








Class com.amazonaws.services.guardduty.model.UpdateFindingsFeedbackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.UpdateIPSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The detectorID that specifies the GuardDuty service whose IPSet you want to update.
 


ipSetId
String ipSetId

 The unique ID that specifies the IPSet that you want to update.
 


name
String name

 The unique ID that specifies the IPSet that you want to update.
 


location
String location

 The updated URI of the file that contains the IPSet. For example
 (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).
 


activate
Boolean activate

 The updated boolean value that specifies whether the IPSet is active or not.
 








Class com.amazonaws.services.guardduty.model.UpdateIPSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.UpdatePublishingDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The ID of the
 


destinationId
String destinationId

 The ID of the detector associated with the publishing destinations to update.
 


destinationProperties
DestinationProperties destinationProperties

 A DestinationProperties object that includes the DestinationArn and
 KmsKeyArn of the publishing destination.
 








Class com.amazonaws.services.guardduty.model.UpdatePublishingDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.guardduty.model.UpdateThreatIntelSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorId
String detectorId

 The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update.
 


threatIntelSetId
String threatIntelSetId

 The unique ID that specifies the ThreatIntelSet that you want to update.
 


name
String name

 The unique ID that specifies the ThreatIntelSet that you want to update.
 


location
String location

 The updated URI of the file that contains the ThreateIntelSet. For example
 (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)
 


activate
Boolean activate

 The updated boolean value that specifies whether the ThreateIntelSet is active or not.
 








Class com.amazonaws.services.guardduty.model.UpdateThreatIntelSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.health.model




Class com.amazonaws.services.health.model.AffectedEntity extends Object implements Serializable


Serialized Fields


entityArn
String entityArn

 The unique identifier for the entity. Format:
 arn:aws:health:entity-region:aws-account:entity/entity-id . Example:
 arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
 


eventArn
String eventArn

 The unique identifier for the event. Format:
 arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID 
 . Example:
 Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
 


entityValue
String entityValue

 The ID of the affected entity.
 


entityUrl
String entityUrl

 The URL of the affected entity.
 


awsAccountId
String awsAccountId

 The 12-digit AWS account number that contains the affected entity.
 


lastUpdatedTime
Date lastUpdatedTime

 The most recent time that the entity was updated.
 


statusCode
String statusCode

 The most recent status of the entity affected by the event. The possible values are IMPAIRED,
 UNIMPAIRED, and UNKNOWN.
 


tags
Map<K,V> tags

 A map of entity tags attached to the affected entity.
 








Class com.amazonaws.services.health.model.AWSHealthException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.health.model.ConcurrentModificationException extends AWSHealthException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.health.model.DateTimeRange extends Object implements Serializable


Serialized Fields


from
Date from

 The starting date and time of a time range.
 


to
Date to

 The ending date and time of a time range.
 








Class com.amazonaws.services.health.model.DescribeAffectedAccountsForOrganizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventArn
String eventArn

 The unique identifier for the event. Format:
 arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID 
 . Example:
 Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 


maxResults
Integer maxResults

 The maximum number of items to return in one batch, between 10 and 100, inclusive.
 








Class com.amazonaws.services.health.model.DescribeAffectedAccountsForOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


affectedAccounts
List<E> affectedAccounts

 A JSON set of elements of the affected accounts.
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 








Class com.amazonaws.services.health.model.DescribeAffectedEntitiesForOrganizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationEntityFilters
List<E> organizationEntityFilters

 A JSON set of elements including the awsAccountId and the eventArn.
 


locale
String locale

 The locale (language) to return information in. English (en) is the default and the only supported value at this
 time.
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 


maxResults
Integer maxResults

 The maximum number of items to return in one batch, between 10 and 100, inclusive.
 








Class com.amazonaws.services.health.model.DescribeAffectedEntitiesForOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entities
List<E> entities

 A JSON set of elements including the awsAccountId and its entityArn,
 entityValue and its entityArn, lastUpdatedTime, statusCode,
 and tags.
 


failedSet
List<E> failedSet

 A JSON set of elements of the failed response, including the awsAccountId, errorMessage, errorName, and eventArn.
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 








Class com.amazonaws.services.health.model.DescribeAffectedEntitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
EntityFilter filter

 Values to narrow the results returned. At least one event ARN is required.
 


locale
String locale

 The locale (language) to return information in. English (en) is the default and the only supported value at this
 time.
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 


maxResults
Integer maxResults

 The maximum number of items to return in one batch, between 10 and 100, inclusive.
 








Class com.amazonaws.services.health.model.DescribeAffectedEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entities
List<E> entities

 The entities that match the filter criteria.
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 








Class com.amazonaws.services.health.model.DescribeEntityAggregatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventArns
List<E> eventArns

 A list of event ARNs (unique identifiers). For example:
 "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
 








Class com.amazonaws.services.health.model.DescribeEntityAggregatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entityAggregates
List<E> entityAggregates

 The number of entities that are affected by each of the specified events.
 








Class com.amazonaws.services.health.model.DescribeEventAggregatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
EventFilter filter

 Values to narrow the results returned.
 


aggregateField
String aggregateField

 The only currently supported value is eventTypeCategory.
 


maxResults
Integer maxResults

 The maximum number of items to return in one batch, between 10 and 100, inclusive.
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 








Class com.amazonaws.services.health.model.DescribeEventAggregatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventAggregates
List<E> eventAggregates

 The number of events in each category that meet the optional filter criteria.
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 








Class com.amazonaws.services.health.model.DescribeEventDetailsForOrganizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationEventDetailFilters
List<E> organizationEventDetailFilters

 A set of JSON elements that includes the awsAccountId and the eventArn.
 


locale
String locale

 The locale (language) to return information in. English (en) is the default and the only supported value at this
 time.
 








Class com.amazonaws.services.health.model.DescribeEventDetailsForOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successfulSet
List<E> successfulSet

 Information about the events that could be retrieved.
 


failedSet
List<E> failedSet

 Error messages for any events that could not be retrieved.
 








Class com.amazonaws.services.health.model.DescribeEventDetailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventArns
List<E> eventArns

 A list of event ARNs (unique identifiers). For example:
 "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
 


locale
String locale

 The locale (language) to return information in. English (en) is the default and the only supported value at this
 time.
 








Class com.amazonaws.services.health.model.DescribeEventDetailsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


successfulSet
List<E> successfulSet

 Information about the events that could be retrieved.
 


failedSet
List<E> failedSet

 Error messages for any events that could not be retrieved.
 








Class com.amazonaws.services.health.model.DescribeEventsForOrganizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
OrganizationEventFilter filter

 Values to narrow the results returned.
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 


maxResults
Integer maxResults

 The maximum number of items to return in one batch, between 10 and 100, inclusive.
 


locale
String locale

 The locale (language) to return information in. English (en) is the default and the only supported value at this
 time.
 








Class com.amazonaws.services.health.model.DescribeEventsForOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


events
List<E> events

 The events that match the specified filter criteria.
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 








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


Serialized Fields


filter
EventFilter filter

 Values to narrow the results returned.
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 


maxResults
Integer maxResults

 The maximum number of items to return in one batch, between 10 and 100, inclusive.
 


locale
String locale

 The locale (language) to return information in. English (en) is the default and the only supported value at this
 time.
 








Class com.amazonaws.services.health.model.DescribeEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


events
List<E> events

 The events that match the specified filter criteria.
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 








Class com.amazonaws.services.health.model.DescribeEventTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
EventTypeFilter filter

 Values to narrow the results returned.
 


locale
String locale

 The locale (language) to return information in. English (en) is the default and the only supported value at this
 time.
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 


maxResults
Integer maxResults

 The maximum number of items to return in one batch, between 10 and 100, inclusive.
 








Class com.amazonaws.services.health.model.DescribeEventTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventTypes
List<E> eventTypes

 A list of event types that match the filter criteria. Event types have a category (issue,
 accountNotification, or scheduledChange), a service (for example, EC2,
 RDS, DATAPIPELINE, BILLING), and a code (in the format
 AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).
 


nextToken
String nextToken

 If the results of a search are large, only a portion of the results are returned, and a nextToken
 pagination token is returned in the response. To retrieve the next batch of results, reissue the search request
 and include the returned token. When all results have been returned, the response does not contain a pagination
 token value.
 








Class com.amazonaws.services.health.model.DescribeHealthServiceStatusForOrganizationRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.health.model.DescribeHealthServiceStatusForOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


healthServiceAccessStatusForOrganization
String healthServiceAccessStatusForOrganization

 Information about the status of enabling or disabling AWS Health Organizational View in your organization.
 
 
 Valid values are ENABLED | DISABLED | PENDING.
 








Class com.amazonaws.services.health.model.DisableHealthServiceAccessForOrganizationRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.health.model.DisableHealthServiceAccessForOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.health.model.EnableHealthServiceAccessForOrganizationRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.health.model.EnableHealthServiceAccessForOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.health.model.EntityAggregate extends Object implements Serializable


Serialized Fields


eventArn
String eventArn

 The unique identifier for the event. Format:
 arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID 
 . Example:
 Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
 


count
Integer count

 The number entities that match the criteria for the specified events.
 








Class com.amazonaws.services.health.model.EntityFilter extends Object implements Serializable


Serialized Fields


eventArns
List<E> eventArns

 A list of event ARNs (unique identifiers). For example:
 "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
 


entityArns
List<E> entityArns

 A list of entity ARNs (unique identifiers).
 


entityValues
List<E> entityValues

 A list of IDs for affected entities.
 


lastUpdatedTimes
List<E> lastUpdatedTimes

 A list of the most recent dates and times that the entity was updated.
 


tags
List<E> tags

 A map of entity tags attached to the affected entity.
 


statusCodes
List<E> statusCodes

 A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).
 








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


Serialized Fields


arn
String arn

 The unique identifier for the event. Format:
 arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID 
 . Example:
 Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
 


service
String service

 The AWS service that is affected by the event. For example, EC2, RDS.
 


eventTypeCode
String eventTypeCode

 The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for
 example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
 


eventTypeCategory
String eventTypeCategory

 The category of the event. Possible values are issue, scheduledChange, and
 accountNotification.
 


region
String region

 The AWS region name of the event.
 


availabilityZone
String availabilityZone

 The AWS Availability Zone of the event. For example, us-east-1a.
 


startTime
Date startTime

 The date and time that the event began.
 


endTime
Date endTime

 The date and time that the event ended.
 


lastUpdatedTime
Date lastUpdatedTime

 The most recent date and time that the event was updated.
 


statusCode
String statusCode

 The most recent status of the event. Possible values are open, closed, and
 upcoming.
 








Class com.amazonaws.services.health.model.EventAccountFilter extends Object implements Serializable


Serialized Fields


eventArn
String eventArn

 The unique identifier for the event. Format:
 arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID 
 . Example:
 Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
 


awsAccountId
String awsAccountId

 The 12-digit AWS account numbers that contains the affected entities.
 








Class com.amazonaws.services.health.model.EventAggregate extends Object implements Serializable


Serialized Fields


aggregateValue
String aggregateValue

 The issue type for the associated count.
 


count
Integer count

 The number of events of the associated issue type.
 








Class com.amazonaws.services.health.model.EventDescription extends Object implements Serializable


Serialized Fields


latestDescription
String latestDescription

 The most recent description of the event.
 








Class com.amazonaws.services.health.model.EventDetails extends Object implements Serializable


Serialized Fields


event
Event event

 Summary information about the event.
 


eventDescription
EventDescription eventDescription

 The most recent description of the event.
 


eventMetadata
Map<K,V> eventMetadata

 Additional metadata about the event.
 








Class com.amazonaws.services.health.model.EventDetailsErrorItem extends Object implements Serializable


Serialized Fields


eventArn
String eventArn

 The unique identifier for the event. Format:
 arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID 
 . Example:
 Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
 


errorName
String errorName

 The name of the error.
 


errorMessage
String errorMessage

 A message that describes the error.
 








Class com.amazonaws.services.health.model.EventFilter extends Object implements Serializable


Serialized Fields


eventArns
List<E> eventArns

 A list of event ARNs (unique identifiers). For example:
 "arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456", "arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101"
 


eventTypeCodes
List<E> eventTypeCodes

 A list of unique identifiers for event types. For example,
 "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
 


services
List<E> services

 The AWS services associated with the event. For example, EC2, RDS.
 


regions
List<E> regions

 A list of AWS regions.
 


availabilityZones
List<E> availabilityZones

 A list of AWS availability zones.
 


startTimes
List<E> startTimes

 A list of dates and times that the event began.
 


endTimes
List<E> endTimes

 A list of dates and times that the event ended.
 


lastUpdatedTimes
List<E> lastUpdatedTimes

 A list of dates and times that the event was last updated.
 


entityArns
List<E> entityArns

 A list of entity ARNs (unique identifiers).
 


entityValues
List<E> entityValues

 A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (
 vol-426ab23e).
 


eventTypeCategories
List<E> eventTypeCategories

 A list of event type category codes (issue, scheduledChange, or
 accountNotification).
 


tags
List<E> tags

 A map of entity tags attached to the affected entity.
 


eventStatusCodes
List<E> eventStatusCodes

 A list of event status codes.
 








Class com.amazonaws.services.health.model.EventType extends Object implements Serializable


Serialized Fields


service
String service

 The AWS service that is affected by the event. For example, EC2, RDS.
 


code
String code

 The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for
 example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
 


category
String category

 A list of event type category codes (issue, scheduledChange, or
 accountNotification).
 








Class com.amazonaws.services.health.model.EventTypeFilter extends Object implements Serializable


Serialized Fields


eventTypeCodes
List<E> eventTypeCodes

 A list of event type codes.
 


services
List<E> services

 The AWS services associated with the event. For example, EC2, RDS.
 


eventTypeCategories
List<E> eventTypeCategories

 A list of event type category codes (issue, scheduledChange, or
 accountNotification).
 








Class com.amazonaws.services.health.model.InvalidPaginationTokenException extends AWSHealthException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.health.model.OrganizationAffectedEntitiesErrorItem extends Object implements Serializable


Serialized Fields


awsAccountId
String awsAccountId

 The 12-digit AWS account numbers that contains the affected entities.
 


eventArn
String eventArn

 The unique identifier for the event. Format:
 arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID 
 . Example:
 Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
 


errorName
String errorName

 The name of the error.
 


errorMessage
String errorMessage

 The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example,
 AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
 








Class com.amazonaws.services.health.model.OrganizationEvent extends Object implements Serializable


Serialized Fields


arn
String arn

 The unique identifier for the event. Format:
 arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID 
 . Example:
 Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
 


service
String service

 The AWS service that is affected by the event. For example, EC2, RDS.
 


eventTypeCode
String eventTypeCode

 The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION. For example,
 AWS_EC2_SYSTEM_MAINTENANCE_EVENT.
 


eventTypeCategory
String eventTypeCategory

 The category of the event type.
 


region
String region

 The AWS Region name of the event.
 


startTime
Date startTime

 The date and time that the event began.
 


endTime
Date endTime

 The date and time that the event ended.
 


lastUpdatedTime
Date lastUpdatedTime

 The most recent date and time that the event was updated.
 


statusCode
String statusCode

 The most recent status of the event. Possible values are open, closed, and
 upcoming.
 








Class com.amazonaws.services.health.model.OrganizationEventDetails extends Object implements Serializable


Serialized Fields


awsAccountId
String awsAccountId

 The 12-digit AWS account numbers that contains the affected entities.
 


event
Event event


eventDescription
EventDescription eventDescription


eventMetadata
Map<K,V> eventMetadata

 Additional metadata about the event.
 








Class com.amazonaws.services.health.model.OrganizationEventDetailsErrorItem extends Object implements Serializable


Serialized Fields


awsAccountId
String awsAccountId

 Error information returned when a DescribeEventDetailsForOrganization operation cannot find a specified
 event.
 


eventArn
String eventArn

 The unique identifier for the event. Format:
 arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID 
 . Example:
 Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
 


errorName
String errorName

 The name of the error.
 


errorMessage
String errorMessage

 A message that describes the error.
 








Class com.amazonaws.services.health.model.OrganizationEventFilter extends Object implements Serializable


Serialized Fields


eventTypeCodes
List<E> eventTypeCodes

 A list of unique identifiers for event types. For example,
 "AWS_EC2_SYSTEM_MAINTENANCE_EVENT","AWS_RDS_MAINTENANCE_SCHEDULED".
 


awsAccountIds
List<E> awsAccountIds

 A list of 12-digit AWS account numbers that contains the affected entities.
 


services
List<E> services

 The AWS services associated with the event. For example, EC2, RDS.
 


regions
List<E> regions

 A list of AWS Regions.
 


startTime
DateTimeRange startTime


endTime
DateTimeRange endTime


lastUpdatedTime
DateTimeRange lastUpdatedTime


entityArns
List<E> entityArns

 REPLACEME
 


entityValues
List<E> entityValues

 A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).
 


eventTypeCategories
List<E> eventTypeCategories

 REPLACEME
 


eventStatusCodes
List<E> eventStatusCodes

 A list of event status codes.
 








Class com.amazonaws.services.health.model.UnsupportedLocaleException extends AWSHealthException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.identitymanagement.model




Class com.amazonaws.services.identitymanagement.model.AccessDetail extends Object implements Serializable


Serialized Fields


serviceName
String serviceName

 The name of the service in which access was attempted.
 


serviceNamespace
String serviceNamespace

 The namespace of the service in which access was attempted.
 
 
 To learn the service namespace of a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the
 service to view details for that service. In the first paragraph, find the service prefix. For example,
 (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference.
 


region
String region

 The Region where the last service access attempt occurred.
 
 
 This field is null if no principals in the reported Organizations entity attempted to access the service within
 the reporting period.
 


entityPath
String entityPath

 The path of the Organizations entity (root, organizational unit, or account) from which an authenticated
 principal last attempted to access the service. AWS does not report unauthenticated requests.
 
 
 This field is null if no principals (IAM users, IAM roles, or root users) in the reported Organizations entity
 attempted to access the service within the reporting period.
 


lastAuthenticatedTime
Date lastAuthenticatedTime

 The date and time, in ISO 8601 date-time format, when an
 authenticated principal most recently attempted to access the service. AWS does not report unauthenticated
 requests.
 
 
 This field is null if no principals in the reported Organizations entity attempted to access the service within
 the reporting period.
 


totalAuthenticatedEntities
Integer totalAuthenticatedEntities

 The number of accounts with authenticated principals (root users, IAM users, and IAM roles) that attempted to
 access the service in the reporting period.
 








Class com.amazonaws.services.identitymanagement.model.AccessKey extends Object implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user that the access key is associated with.
 


accessKeyId
String accessKeyId

 The ID for this access key.
 


status
String status

 The status of the access key. Active means that the key is valid for API calls, while
 Inactive means it is not.
 


secretAccessKey
String secretAccessKey

 The secret key used to sign requests.
 


createDate
Date createDate

 The date when the access key was created.
 








Class com.amazonaws.services.identitymanagement.model.AccessKeyLastUsed extends Object implements Serializable


Serialized Fields


lastUsedDate
Date lastUsedDate

 The date and time, in ISO 8601 date-time format, when the access key
 was most recently used. This field is null in the following situations:
 
 
 
 
 The user does not have an access key.
 
 
 
 
 An access key exists but has not been used since IAM began tracking this information.
 
 
 
 
 There is no sign-in data associated with the user.
 
 
 


serviceName
String serviceName

 The name of the AWS service with which this access key was most recently used. The value of this field is "N/A"
 in the following situations:
 
 
 
 
 The user does not have an access key.
 
 
 
 
 An access key exists but has not been used since IAM started tracking this information.
 
 
 
 
 There is no sign-in data associated with the user.
 
 
 


region
String region

 The AWS Region where this access key was most recently used. The value for this field is "N/A" in the following
 situations:
 
 
 
 
 The user does not have an access key.
 
 
 
 
 An access key exists but has not been used since IAM began tracking this information.
 
 
 
 
 There is no sign-in data associated with the user.
 
 
 
 
 For more information about AWS Regions, see Regions and Endpoints in the Amazon Web
 Services General Reference.
 








Class com.amazonaws.services.identitymanagement.model.AccessKeyMetadata extends Object implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user that the key is associated with.
 


accessKeyId
String accessKeyId

 The ID for this access key.
 


status
String status

 The status of the access key. Active means that the key is valid for API calls;
 Inactive means it is not.
 


createDate
Date createDate

 The date when the access key was created.
 








Class com.amazonaws.services.identitymanagement.model.AddClientIDToOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


openIDConnectProviderArn
String openIDConnectProviderArn

 The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You
 can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.
 


clientID
String clientID

 The client ID (also known as audience) to add to the IAM OpenID Connect provider resource.
 








Class com.amazonaws.services.identitymanagement.model.AddClientIDToOpenIDConnectProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.AddRoleToInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceProfileName
String instanceProfileName

 The name of the instance profile to update.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.AddUserToGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name of the group to update.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.AmazonIdentityManagementException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.AttachedPermissionsBoundary extends Object implements Serializable


Serialized Fields


permissionsBoundaryType
String permissionsBoundaryType

 The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary
 for an entity. This data type can only have a value of Policy.
 


permissionsBoundaryArn
String permissionsBoundaryArn

 The ARN of the policy used to set the permissions boundary for the user or role.
 








Class com.amazonaws.services.identitymanagement.model.AttachedPolicy extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The friendly name of the attached policy.
 


policyArn
String policyArn








Class com.amazonaws.services.identitymanagement.model.AttachGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name (friendly name, not ARN) of the group to attach the policy to.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.AttachRolePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name (friendly name, not ARN) of the role to attach the policy to.
 
 
 This parameter allows (through its regex pattern) 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.AttachRolePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.AttachUserPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name (friendly name, not ARN) of the IAM user to attach the policy to.
 
 
 This parameter allows (through its regex pattern) 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.AttachUserPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.ChangePasswordRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


oldPassword
String oldPassword

 The IAM user's current password.
 


newPassword
String newPassword

 The new password. The new password must conform to the AWS account's password policy, if one exists.
 
 
 The regex pattern that is used to validate this parameter is a
 string of characters. That string can include 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. Any
 of these characters are valid in a password. However, many tools, such as the AWS Management Console, might
 restrict the ability to type certain characters because they have special meaning within that tool.
 








Class com.amazonaws.services.identitymanagement.model.ChangePasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.ConcurrentModificationException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.ContextEntry extends Object implements Serializable


Serialized Fields


contextKeyName
String contextKeyName

 The full name of a condition context key, including the service prefix. For example, aws:SourceIp or
 s3:VersionId.
 


contextKeyValues
SdkInternalList<T> contextKeyValues

 The value (or values, if the condition context key supports multiple values) to provide to the simulation when
 the key is referenced by a Condition element in an input policy.
 


contextKeyType
String contextKeyType

 The data type of the value (or values) specified in the ContextKeyValues parameter.
 








Class com.amazonaws.services.identitymanagement.model.CreateAccessKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user that the new key will belong to.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accessKey
AccessKey accessKey

 A structure with details about the access key.
 








Class com.amazonaws.services.identitymanagement.model.CreateAccountAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountAlias
String accountAlias

 The account alias to create.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.CreateGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


path
String path

 The path to the group. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 
 
 This parameter is optional. If it is not included, it defaults to a slash (/).
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
 character (), including most punctuation characters, digits, and upper and lowercased letters.
 


groupName
String groupName

 The name of the group to create. Do not include the path in this value.
 
 
 IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case.
 For example, you cannot create resources named both "MyResource" and "myresource".
 








Class com.amazonaws.services.identitymanagement.model.CreateGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


group
Group group

 A structure containing details about the new group.
 








Class com.amazonaws.services.identitymanagement.model.CreateInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceProfileName
String instanceProfileName

 The name of the instance profile to create.
 
 
 This parameter allows (through its regex pattern) 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 (/).
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
 character (), including most punctuation characters, digits, and upper and lowercased letters.
 








Class com.amazonaws.services.identitymanagement.model.CreateInstanceProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceProfile
InstanceProfile instanceProfile

 A structure containing details about the new instance profile.
 








Class com.amazonaws.services.identitymanagement.model.CreateLoginProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user to create a password for. The user must already exist.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


password
String password

 The new password for the user.
 
 
 The regex pattern that is used to validate this parameter is a
 string of characters. That string can include 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. Any
 of these characters are valid in a password. However, many tools, such as the AWS Management Console, might
 restrict the ability to type 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.
 








Class com.amazonaws.services.identitymanagement.model.CreateLoginProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loginProfile
LoginProfile loginProfile

 A structure containing the user name and password create date.
 








Class com.amazonaws.services.identitymanagement.model.CreateOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


url
String url

 The URL of the identity provider. The URL must begin with https:// and should correspond to the
 iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are
 allowed but query parameters are not. Typically the URL consists of only a hostname, like
 https://server.example.org or https://example.com.
 
 
 You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has
 already been used for an OpenID Connect provider in the AWS account, you will get an error.
 


clientIDList
SdkInternalList<T> clientIDList

 A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect
 provider, they establish a value that identifies the application. (This is the value that's sent as the
 client_id parameter on OAuth requests.)
 
 
 You can register multiple client IDs with the same provider. For example, you might have multiple applications
 that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.
 
 
 There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest operation accepts
 client IDs up to 255 characters long.
 


thumbprintList
SdkInternalList<T> thumbprintList

 A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates.
 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, assume that the OIDC
 provider is server.example.com and the provider stores its keys at
 https://keys.server.example.com/openid-connect. In that case, the thumbprint string would be the hex-encoded
 SHA-1 hash value of the certificate used by https://keys.server.example.com.
 
 
 For more information about obtaining the OIDC provider's thumbprint, see Obtaining
 the Thumbprint for an OpenID Connect Provider in the IAM User Guide.
 








Class com.amazonaws.services.identitymanagement.model.CreateOpenIDConnectProviderResult extends AmazonWebServiceResult<ResponseMetadata> 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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The friendly name of the policy.
 
 
 IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case.
 For example, you cannot create resources named both "MyResource" and "myresource".
 


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 (/).
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through 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.
 
 
 You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you
 can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format
 before submitting it to IAM.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 


description
String description

 A friendly description of the policy.
 
 
 Typically used to store information about the permissions defined in the policy. For example,
 "Grants access to production DynamoDB tables."
 
 
 The policy description is immutable. After a value is assigned, it cannot be changed.
 








Class com.amazonaws.services.identitymanagement.model.CreatePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
Policy policy

 A structure containing details about the new policy.
 








Class com.amazonaws.services.identitymanagement.model.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.
 
 
 You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you
 can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format
 before submitting it to IAM.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 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, it
 becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.
 
 
 For more information about managed policy versions, see Versioning for Managed
 Policies in the IAM User Guide.
 








Class com.amazonaws.services.identitymanagement.model.CreatePolicyVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyVersion
PolicyVersion policyVersion

 A structure containing details about the new policy version.
 








Class com.amazonaws.services.identitymanagement.model.CreateRoleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


path
String path

 The path to the role. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 
 
 This parameter is optional. If it is not included, it defaults to a slash (/).
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
 character (), including most punctuation characters, digits, and upper and lowercased letters.
 


roleName
String roleName

 The name of the role to create.
 
 
 IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case.
 For example, you cannot create resources named both "MyResource" and "myresource".
 


assumeRolePolicyDocument
String assumeRolePolicyDocument

 The trust relationship policy document that grants an entity permission to assume the role.
 
 
 In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation
 templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always
 converts a YAML policy to JSON format before submitting it to IAM.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 
 
 Upon success, the response includes the same trust policy in JSON format.
 


description
String description

 A description of the role.
 


maxSessionDuration
Integer maxSessionDuration

 The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a
 value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to
 12 hours.
 
 
 Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the
 duration-seconds CLI parameter to request a longer session. The MaxSessionDuration
 setting determines the maximum duration that can be requested using the DurationSeconds parameter.
 If users don't specify a value for the DurationSeconds parameter, their security credentials are
 valid for one hour by default. This applies when you use the AssumeRole* API operations or the
 assume-role* CLI operations but does not apply when you use those operations to create a console
 URL. For more information, see Using
 IAM Roles in the IAM User Guide.
 


permissionsBoundary
String permissionsBoundary

 The ARN of the policy that is used to set the permissions boundary for the role.
 


tags
SdkInternalList<T> tags

 A list of tags that you want to attach to the newly created role. Each tag consists of a key name and an
 associated value. For more information about tagging, see Tagging IAM Identities in the IAM
 User Guide.
 
 
 
 If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request
 fails and the role is not created.
 
 








Class com.amazonaws.services.identitymanagement.model.CreateRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


role
Role role

 A structure containing details about the new role.
 








Class com.amazonaws.services.identitymanagement.model.CreateSAMLProviderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sAMLMetadataDocument
String sAMLMetadataDocument

 An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the
 issuer's name, expiration information, and keys that can be used to validate the SAML authentication response
 (assertions) that are received from the IdP. You must generate the metadata document using the identity
 management software that is used as your organization's IdP.
 
 
 For more information, see About SAML 2.0-based
 Federation in the IAM User Guide
 


name
String name

 The name of the provider to create.
 
 
 This parameter allows (through its regex pattern) 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.CreateSAMLProviderResult extends AmazonWebServiceResult<ResponseMetadata> 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.CreateServiceLinkedRoleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


aWSServiceName
String aWSServiceName

 The service principal for the AWS service to which this role is attached. You use a string similar to a URL but
 without the http:// in front. For example: elasticbeanstalk.amazonaws.com.
 
 
 Service principals are unique and case-sensitive. To find the exact service principal for your service-linked
 role, see AWS
 Services That Work with IAM in the IAM User Guide. Look for the services that have Yes in the
 Service-Linked Role column. Choose the Yes link to view the service-linked role documentation for
 that service.
 


description
String description

 The description of the role.
 


customSuffix
String customSuffix

 

 A string that you provide, which is combined with the service-provided prefix to form the complete role name. If
 you make multiple requests for the same service, then you must supply a different CustomSuffix for
 each request. Otherwise the request fails with a duplicate role name error. For example, you could add
 -1 or -debug to the suffix.
 
 
 Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the
 operation fails, try the operation again without the suffix.
 








Class com.amazonaws.services.identitymanagement.model.CreateServiceLinkedRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


role
Role role

 A Role object that contains details about the newly created role.
 








Class com.amazonaws.services.identitymanagement.model.CreateServiceSpecificCredentialRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have
 the same permissions as the associated user except that they can be used only to access the specified service.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


serviceName
String serviceName

 The name of the AWS service that is to be associated with the credentials. The service you specify here is the
 only service that can be accessed using these credentials.
 








Class com.amazonaws.services.identitymanagement.model.CreateServiceSpecificCredentialResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serviceSpecificCredential
ServiceSpecificCredential serviceSpecificCredential

 A structure that contains information about the newly created service-specific credential.
 
 
 
 This is the only time that the password for this credential set is available. It cannot be recovered later.
 Instead, you must reset the password with ResetServiceSpecificCredential.
 
 








Class com.amazonaws.services.identitymanagement.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


path
String path

 The path for the user name. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 
 
 This parameter is optional. If it is not included, it defaults to a slash (/).
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
 character (), including most punctuation characters, digits, and upper and lowercased letters.
 


userName
String userName

 The name of the user to create.
 
 
 IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case.
 For example, you cannot create resources named both "MyResource" and "myresource".
 


permissionsBoundary
String permissionsBoundary

 The ARN of the policy that is used to set the permissions boundary for the user.
 


tags
SdkInternalList<T> tags

 A list of tags that you want to attach to the newly created user. Each tag consists of a key name and an
 associated value. For more information about tagging, see Tagging IAM Identities in the IAM
 User Guide.
 
 
 
 If any one of the tags is invalid or if you exceed the allowed number of tags per user, then the entire request
 fails and the user is not created.
 
 








Class com.amazonaws.services.identitymanagement.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


user
User user

 A structure with details about the new IAM user.
 








Class com.amazonaws.services.identitymanagement.model.CreateVirtualMFADeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


path
String path

 The path for the virtual MFA device. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 
 
 This parameter is optional. If it is not included, it defaults to a slash (/).
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through 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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualMFADevice
VirtualMFADevice virtualMFADevice

 A structure containing details about the new virtual MFA device.
 








Class com.amazonaws.services.identitymanagement.model.CredentialReportExpiredException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.CredentialReportNotPresentException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.CredentialReportNotReadyException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.DeactivateMFADeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user whose MFA device you want to deactivate.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


serialNumber
String serialNumber

 The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the
 device ARN.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteAccessKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user whose access key pair you want to delete.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


accessKeyId
String accessKeyId

 The access key ID for the access key ID and secret access key you want to delete.
 
 
 This parameter allows (through its regex pattern) a string of
 characters that can consist of any upper or lowercased letter or digit.
 








Class com.amazonaws.services.identitymanagement.model.DeleteAccessKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteAccountAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountAlias
String accountAlias

 The name of the account alias to delete.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteAccountPasswordPolicyRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteAccountPasswordPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteConflictException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.DeleteGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name (friendly name, not ARN) identifying the group that the policy is embedded in.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name of the IAM group to delete.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceProfileName
String instanceProfileName

 The name of the instance profile to delete.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteLoginProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user whose password you want to delete.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


openIDConnectProviderArn
String openIDConnectProviderArn

 The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list
 of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders operation.
 








Class com.amazonaws.services.identitymanagement.model.DeleteOpenIDConnectProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteRolePermissionsBoundaryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name (friendly name, not ARN) of the IAM role from which you want to remove the permissions boundary.
 








Class com.amazonaws.services.identitymanagement.model.DeleteRolePermissionsBoundaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteRolePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name (friendly name, not ARN) identifying the role that the policy is embedded in.
 
 
 This parameter allows (through its regex pattern) 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 inline policy to delete from the specified IAM role.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteRoleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the role to delete.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteSAMLProviderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sAMLProviderArn
String sAMLProviderArn

 The Amazon Resource Name (ARN) of the SAML provider to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteSAMLProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteServerCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serverCertificateName
String serverCertificateName

 The name of the server certificate you want to delete.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteServiceLinkedRoleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the service-linked role to be deleted.
 








Class com.amazonaws.services.identitymanagement.model.DeleteServiceLinkedRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deletionTaskId
String deletionTaskId

 The deletion task identifier that you can use to check the status of the deletion. This identifier is returned in
 the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
 








Class com.amazonaws.services.identitymanagement.model.DeleteServiceSpecificCredentialRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user associated with the service-specific credential. If this value is not specified, then
 the operation assumes the user whose credentials are used to call the operation.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


serviceSpecificCredentialId
String serviceSpecificCredentialId

 The unique identifier of the service-specific credential. You can get this value by calling
 ListServiceSpecificCredentials.
 
 
 This parameter allows (through its regex pattern) a string of
 characters that can consist of any upper or lowercased letter or digit.
 








Class com.amazonaws.services.identitymanagement.model.DeleteServiceSpecificCredentialResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user the signing certificate belongs to.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


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.
 








Class com.amazonaws.services.identitymanagement.model.DeleteSigningCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user associated with the SSH public key.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


sSHPublicKeyId
String sSHPublicKeyId

 The unique identifier for the SSH public key.
 
 
 This parameter allows (through its regex pattern) a string of
 characters that can consist of any upper or lowercased letter or digit.
 








Class com.amazonaws.services.identitymanagement.model.DeleteSSHPublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteUserPermissionsBoundaryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name (friendly name, not ARN) of the IAM user from which you want to remove the permissions boundary.
 








Class com.amazonaws.services.identitymanagement.model.DeleteUserPermissionsBoundaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteUserPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name (friendly name, not ARN) identifying the user that the policy is embedded in.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user to delete.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteVirtualMFADeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serialNumber
String serialNumber

 The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same
 as the ARN.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeletionTaskFailureReasonType extends Object implements Serializable


Serialized Fields


reason
String reason

 A short description of the reason that the service-linked role deletion failed.
 


roleUsageList
SdkInternalList<T> roleUsageList

 A list of objects that contains details about the service-linked role deletion failure, if that information is
 returned by the service. If the service-linked role has active sessions or if any resources that were used by the
 role have not been deleted from the linked service, the role can't be deleted. This parameter includes a list of
 the resources that are associated with the role and the Region in which the resources are being used.
 








Class com.amazonaws.services.identitymanagement.model.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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DetachRolePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name (friendly name, not ARN) of the IAM role to detach the policy from.
 
 
 This parameter allows (through its regex pattern) 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.DetachRolePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DetachUserPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name (friendly name, not ARN) of the IAM user to detach the policy from.
 
 
 This parameter allows (through its regex pattern) 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.DetachUserPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.DuplicateCertificateException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.DuplicateSSHPublicKeyException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.EnableMFADeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user for whom you want to enable the MFA device.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


serialNumber
String serialNumber

 The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the
 device ARN.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: =,.@:/-
 


authenticationCode1
String authenticationCode1

 An authentication code emitted by the device.
 
 
 The format for this parameter is a string of six digits.
 
 
 
 Submit your request immediately after generating the authentication codes. If you generate the codes and then
 wait too long to submit the request, the MFA device successfully associates with the user but the MFA device
 becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of
 time. If this happens, you can resync the device.
 
 


authenticationCode2
String authenticationCode2

 A subsequent authentication code emitted by the device.
 
 
 The format for this parameter is a string of six digits.
 
 
 
 Submit your request immediately after generating the authentication codes. If you generate the codes and then
 wait too long to submit the request, the MFA device successfully associates with the user but the MFA device
 becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of
 time. If this happens, you can resync the device.
 
 








Class com.amazonaws.services.identitymanagement.model.EnableMFADeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.EntityAlreadyExistsException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.EntityDetails extends Object implements Serializable


Serialized Fields


entityInfo
EntityInfo entityInfo

 The EntityInfo object that contains details about the entity (user or role).
 


lastAuthenticated
Date lastAuthenticated

 The date and time, in ISO 8601 date-time format, when the
 authenticated entity last attempted to access AWS. AWS does not report unauthenticated requests.
 
 
 This field is null if no IAM entities attempted to access the service within the reporting period.
 








Class com.amazonaws.services.identitymanagement.model.EntityInfo extends Object implements Serializable


Serialized Fields


arn
String arn


name
String name

 The name of the entity (user or role).
 


type
String type

 The type of entity (user or role).
 


id
String id

 The identifier of the entity (user or role).
 


path
String path

 The path to the entity (user or role). For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 








Class com.amazonaws.services.identitymanagement.model.EntityTemporarilyUnmodifiableException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.ErrorDetails extends Object implements Serializable


Serialized Fields


message
String message

 Detailed information about the reason that the operation failed.
 


code
String code

 The error code associated with the operation failure.
 








Class com.amazonaws.services.identitymanagement.model.EvaluationResult extends Object implements Serializable


Serialized Fields


evalActionName
String evalActionName

 The name of the API operation tested on the indicated resource.
 


evalResourceName
String evalResourceName

 The ARN of the resource that the indicated API operation was tested on.
 


evalDecision
String evalDecision

 The result of the simulation.
 


matchedStatements
SdkInternalList<T> matchedStatements

 A list of the statements in the input policies that determine the result for this scenario. Remember that even if
 multiple statements allow the operation on the resource, if only one statement denies that operation, then the
 explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.
 


missingContextValues
SdkInternalList<T> missingContextValues

 A list of context keys that are required by the included input policies but that were not provided by one of the
 input parameters. 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.
 


organizationsDecisionDetail
OrganizationsDecisionDetail organizationsDecisionDetail

 A structure that details how Organizations and its service control policies affect the results of the simulation.
 Only applies if the simulated user's account is part of an organization.
 


permissionsBoundaryDecisionDetail
PermissionsBoundaryDecisionDetail permissionsBoundaryDecisionDetail

 Contains information about the effect that a permissions boundary has on a policy simulation when the boundary is
 applied to an IAM entity.
 


evalDecisionDetails
SdkInternalMap<K,V> evalDecisionDetails

 Additional details about the results of the cross-account evaluation decision. This parameter is populated for
 only cross-account simulations. It contains a brief summary of how each policy type contributes to the final
 evaluation decision.
 
 
 If the simulation evaluates policies within the same account and includes a resource ARN, then the parameter is
 present but the response is empty. If the simulation evaluates policies within the same account and specifies all
 resources (*), then the parameter is not returned.
 
 
 When you make a cross-account request, AWS evaluates the request in the trusting account and the trusted account.
 The request is allowed only if both evaluations return true. For more information about how policies
 are evaluated, see Evaluating Policies Within a Single Account.
 
 
 If an AWS Organizations SCP included in the evaluation denies access, the simulation ends. In this case, policy
 evaluation does not proceed any further and this parameter is not returned.
 


resourceSpecificResults
SdkInternalList<T> resourceSpecificResults

 The individual results of the simulation of the API operation specified in EvalActionName on each resource.
 








Class com.amazonaws.services.identitymanagement.model.GenerateCredentialReportRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.GenerateCredentialReportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


state
String state

 Information about the state of the credential report.
 


description
String description

 Information about the credential report.
 








Class com.amazonaws.services.identitymanagement.model.GenerateOrganizationsAccessReportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


entityPath
String entityPath

 The path of the AWS Organizations entity (root, OU, or account). You can build an entity path using the known
 structure of your organization. For example, assume that your account ID is 123456789012 and its
 parent OU ID is ou-rge0-awsabcde. The organization root ID is r-f6g7h8i9j0example and
 your organization ID is o-a1b2c3d4e5. Your entity path is
 o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.
 


organizationsPolicyId
String organizationsPolicyId

 The identifier of the AWS Organizations service control policy (SCP). This parameter is optional.
 
 
 This ID is used to generate information about when an account principal that is limited by the SCP attempted to
 access an AWS service.
 








Class com.amazonaws.services.identitymanagement.model.GenerateOrganizationsAccessReportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The job identifier that you can use in the GetOrganizationsAccessReport operation.
 








Class com.amazonaws.services.identitymanagement.model.GenerateServiceLastAccessedDetailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The ARN of the IAM resource (user, group, role, or managed policy) used to generate information about when the
 resource was last used in an attempt to access an AWS service.
 








Class com.amazonaws.services.identitymanagement.model.GenerateServiceLastAccessedDetailsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId

 The job ID that you can use in the GetServiceLastAccessedDetails or
 GetServiceLastAccessedDetailsWithEntities operations.
 








Class com.amazonaws.services.identitymanagement.model.GetAccessKeyLastUsedRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accessKeyId
String accessKeyId

 The identifier of an access key.
 
 
 This parameter allows (through its regex pattern) a string of
 characters that can consist of any upper or lowercased letter or digit.
 








Class com.amazonaws.services.identitymanagement.model.GetAccessKeyLastUsedResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userName
String userName

 The name of the AWS IAM user that owns this access key.
 
 


accessKeyLastUsed
AccessKeyLastUsed accessKeyLastUsed

 Contains information about the last time the access key was used.
 








Class com.amazonaws.services.identitymanagement.model.GetAccountAuthorizationDetailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
SdkInternalList<T> filter

 A list of entity types used to filter the results. Only the entities that match the types you specify are
 included in the output. Use the value LocalManagedPolicy to include customer managed policies.
 
 
 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.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 


marker
String marker

 Use this parameter only when paginating results and only after you receive a response indicating that the results
 are truncated. Set it to the value of the Marker element in the response that you received to
 indicate where the next call should start.
 








Class com.amazonaws.services.identitymanagement.model.GetAccountAuthorizationDetailsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userDetailList
SdkInternalList<T> userDetailList

 A list containing information about IAM users.
 


groupDetailList
SdkInternalList<T> groupDetailList

 A list containing information about IAM groups.
 


roleDetailList
SdkInternalList<T> roleDetailList

 A list containing information about IAM roles.
 


policies
SdkInternalList<T> policies

 A list containing information about managed policies.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.GetAccountPasswordPolicyRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.GetAccountPasswordPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


passwordPolicy
PasswordPolicy passwordPolicy

 A structure that contains details about the account's password policy.
 








Class com.amazonaws.services.identitymanagement.model.GetAccountSummaryRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.GetAccountSummaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaryMap
SdkInternalMap<K,V> summaryMap

 A set of key–value pairs containing information about IAM entity usage and IAM quotas.
 








Class com.amazonaws.services.identitymanagement.model.GetContextKeysForCustomPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyInputList
SdkInternalList<T> 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 used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 








Class com.amazonaws.services.identitymanagement.model.GetContextKeysForCustomPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contextKeyNames
SdkInternalList<T> contextKeyNames

 The list of context keys that are referenced in the input policies.
 








Class com.amazonaws.services.identitymanagement.model.GetContextKeysForPrincipalPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policySourceArn
String policySourceArn

 The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a
 user, the list includes context keys that are found in all policies that are attached to the user. The list also
 includes 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.
 


policyInputList
SdkInternalList<T> policyInputList

 An optional list of additional policies for which you want the list of context keys that are referenced.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 








Class com.amazonaws.services.identitymanagement.model.GetContextKeysForPrincipalPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contextKeyNames
SdkInternalList<T> contextKeyNames

 The list of context keys that are referenced in the input policies.
 








Class com.amazonaws.services.identitymanagement.model.GetCredentialReportRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.GetCredentialReportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


content
ByteBuffer content

 Contains the credential report. The report is Base64-encoded.
 


reportFormat
String reportFormat

 The format (MIME type) of the credential report.
 


generatedTime
Date generatedTime

 The date and time when the credential report was created, in ISO 8601
 date-time format.
 








Class com.amazonaws.services.identitymanagement.model.GetGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name of the group the policy is associated with.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


groupName
String groupName

 The group the policy is associated with.
 


policyName
String policyName

 The name of the policy.
 


policyDocument
String policyDocument

 The policy document.
 
 
 IAM stores policies in JSON format. However, resources that were created using AWS CloudFormation templates can
 be formatted in YAML. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to
 IAM.
 








Class com.amazonaws.services.identitymanagement.model.GetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name of the group.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.GetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


group
Group group

 A structure that contains details about the group.
 


users
SdkInternalList<T> users

 A list of users in the group.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.GetInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceProfileName
String instanceProfileName

 The name of the instance profile to get information about.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceProfile
InstanceProfile instanceProfile

 A structure containing details about the instance profile.
 








Class com.amazonaws.services.identitymanagement.model.GetLoginProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user whose login profile you want to retrieve.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> 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 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 operation.
 
 
 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


url
String url

 The URL that the IAM OIDC provider resource object is associated with. For more information, see
 CreateOpenIDConnectProvider.
 


clientIDList
SdkInternalList<T> 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.
 


thumbprintList
SdkInternalList<T> thumbprintList

 A list of certificate thumbprints 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.
 








Class com.amazonaws.services.identitymanagement.model.GetOrganizationsAccessReportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The identifier of the request generated by the GenerateOrganizationsAccessReport operation.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 


marker
String marker

 Use this parameter only when paginating results and only after you receive a response indicating that the results
 are truncated. Set it to the value of the Marker element in the response that you received to
 indicate where the next call should start.
 


sortKey
String sortKey

 The key that is used to sort the results. If you choose the namespace key, the results are returned in
 alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.
 








Class com.amazonaws.services.identitymanagement.model.GetOrganizationsAccessReportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobStatus
String jobStatus

 The status of the job.
 


jobCreationDate
Date jobCreationDate

 The date and time, in ISO 8601 date-time format, when the report job
 was created.
 


jobCompletionDate
Date jobCompletionDate

 The date and time, in ISO 8601 date-time format, when the generated
 report job was completed or failed.
 
 
 This field is null if the job is still in progress, as indicated by a job status value of
 IN_PROGRESS.
 


numberOfServicesAccessible
Integer numberOfServicesAccessible

 The number of services that the applicable SCPs allow account principals to access.
 


numberOfServicesNotAccessed
Integer numberOfServicesNotAccessed

 The number of services that account principals are allowed but did not attempt to access.
 


accessDetails
SdkInternalList<T> accessDetails

 An object that contains details about the most recent attempt to access the service.
 


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


errorDetails
ErrorDetails errorDetails








Class com.amazonaws.services.identitymanagement.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
Policy policy

 A structure containing details about the policy.
 








Class com.amazonaws.services.identitymanagement.model.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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyVersion
PolicyVersion policyVersion

 A structure containing details about the policy version.
 








Class com.amazonaws.services.identitymanagement.model.GetRolePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the role associated with the policy.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roleName
String roleName

 The role the policy is associated with.
 


policyName
String policyName

 The name of the policy.
 


policyDocument
String policyDocument

 The policy document.
 
 
 IAM stores policies in JSON format. However, resources that were created using AWS CloudFormation templates can
 be formatted in YAML. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to
 IAM.
 








Class com.amazonaws.services.identitymanagement.model.GetRoleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the IAM role to get information about.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


role
Role role

 A structure containing details about the IAM role.
 








Class com.amazonaws.services.identitymanagement.model.GetSAMLProviderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sAMLProviderArn
String sAMLProviderArn

 The Amazon Resource Name (ARN) of the SAML provider 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sAMLMetadataDocument
String sAMLMetadataDocument

 The XML metadata document that includes information about an identity provider.
 


createDate
Date createDate

 The date and time when the SAML provider was created.
 


validUntil
Date validUntil

 The expiration date and time for the SAML provider.
 








Class com.amazonaws.services.identitymanagement.model.GetServerCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serverCertificateName
String serverCertificateName

 The name of the server certificate you want to retrieve information about.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serverCertificate
ServerCertificate serverCertificate

 A structure containing details about the server certificate.
 








Class com.amazonaws.services.identitymanagement.model.GetServiceLastAccessedDetailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The ID of the request generated by the GenerateServiceLastAccessedDetails operation.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 


marker
String marker

 Use this parameter only when paginating results and only after you receive a response indicating that the results
 are truncated. Set it to the value of the Marker element in the response that you received to
 indicate where the next call should start.
 








Class com.amazonaws.services.identitymanagement.model.GetServiceLastAccessedDetailsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobStatus
String jobStatus

 The status of the job.
 


jobCreationDate
Date jobCreationDate

 The date and time, in ISO 8601 date-time format, when the report job
 was created.
 


servicesLastAccessed
SdkInternalList<T> servicesLastAccessed

 A ServiceLastAccessed object that contains details about the most recent attempt to access the
 service.
 


jobCompletionDate
Date jobCompletionDate

 The date and time, in ISO 8601 date-time format, when the generated
 report job was completed or failed.
 
 
 This field is null if the job is still in progress, as indicated by a job status value of
 IN_PROGRESS.
 


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


error
ErrorDetails error

 An object that contains details about the reason the operation failed.
 








Class com.amazonaws.services.identitymanagement.model.GetServiceLastAccessedDetailsWithEntitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The ID of the request generated by the GenerateServiceLastAccessedDetails operation.
 


serviceNamespace
String serviceNamespace

 The service namespace for an AWS service. Provide the service namespace to learn when the IAM entity last
 attempted to access the specified service.
 
 
 To learn the service namespace for a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the
 service to view details for that service. In the first paragraph, find the service prefix. For example,
 (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 


marker
String marker

 Use this parameter only when paginating results and only after you receive a response indicating that the results
 are truncated. Set it to the value of the Marker element in the response that you received to
 indicate where the next call should start.
 








Class com.amazonaws.services.identitymanagement.model.GetServiceLastAccessedDetailsWithEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobStatus
String jobStatus

 The status of the job.
 


jobCreationDate
Date jobCreationDate

 The date and time, in ISO 8601 date-time format, when the report job
 was created.
 


jobCompletionDate
Date jobCompletionDate

 The date and time, in ISO 8601 date-time format, when the generated
 report job was completed or failed.
 
 
 This field is null if the job is still in progress, as indicated by a job status value of
 IN_PROGRESS.
 


entityDetailsList
SdkInternalList<T> entityDetailsList

 An EntityDetailsList object that contains details about when an IAM entity (user or role) used group
 or policy permissions in an attempt to access the specified AWS service.
 


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


error
ErrorDetails error

 An object that contains details about the reason the operation failed.
 








Class com.amazonaws.services.identitymanagement.model.GetServiceLinkedRoleDeletionStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deletionTaskId
String deletionTaskId

 The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the
 format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.
 








Class com.amazonaws.services.identitymanagement.model.GetServiceLinkedRoleDeletionStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 The status of the deletion.
 


reason
DeletionTaskFailureReasonType reason

 An object that contains details about the reason the deletion failed.
 








Class com.amazonaws.services.identitymanagement.model.GetSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user associated with the SSH public key.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


sSHPublicKeyId
String sSHPublicKeyId

 The unique identifier for the SSH public key.
 
 
 This parameter allows (through its regex pattern) a string of
 characters that can consist of any upper or lowercased letter or digit.
 


encoding
String encoding

 Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format,
 use SSH. To retrieve the public key in PEM format, use PEM.
 








Class com.amazonaws.services.identitymanagement.model.GetSSHPublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sSHPublicKey
SSHPublicKey sSHPublicKey

 A structure containing details about the SSH public key.
 








Class com.amazonaws.services.identitymanagement.model.GetUserPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user who the policy is associated with.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userName
String userName

 The user the policy is associated with.
 


policyName
String policyName

 The name of the policy.
 


policyDocument
String policyDocument

 The policy document.
 
 
 IAM stores policies in JSON format. However, resources that were created using AWS CloudFormation templates can
 be formatted in YAML. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to
 IAM.
 








Class com.amazonaws.services.identitymanagement.model.GetUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user to get information about.
 
 
 This parameter is optional. If it is not included, it defaults to the user making the request. This parameter
 allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


user
User user

 A structure containing details about the IAM user.
 
 
 
 Due to a service issue, password last used data does not include password use from May 3, 2018 22:50 PDT to May
 23, 2018 14:08 PDT. This affects last sign-in dates
 shown in the IAM console and password last used dates in the IAM credential
 report, and returned by this GetUser API. If users signed in during the affected time, the password last used
 date that is returned is the date the user last signed in before May 3, 2018. For users that signed in after May
 23, 2018 14:08 PDT, the returned password last used date is accurate.
 
 
 You can use password last used information to identify unused credentials for deletion. For example, you might
 delete users who did not sign in to AWS in the last 90 days. In cases like this, we recommend that you adjust
 your evaluation window to include dates after May 23, 2018. Alternatively, if your users use access keys to
 access AWS programmatically you can refer to access key last used information because it is accurate for all
 dates.
 
 








Class com.amazonaws.services.identitymanagement.model.Group extends Object implements Serializable


Serialized Fields


path
String path

 The path to the group. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 


groupName
String groupName

 The friendly name that identifies the group.
 


groupId
String groupId

 The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the IAM
 User Guide.
 


arn
String arn

 The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in
 policies, see IAM
 Identifiers in the IAM User Guide.
 


createDate
Date createDate

 The date and time, in ISO 8601 date-time format, when the group was
 created.
 








Class com.amazonaws.services.identitymanagement.model.GroupDetail extends Object implements Serializable


Serialized Fields


path
String path

 The path to the group. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 


groupName
String groupName

 The friendly name that identifies the group.
 


groupId
String groupId

 The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the IAM
 User Guide.
 


arn
String arn


createDate
Date createDate

 The date and time, in ISO 8601 date-time format, when the group was
 created.
 


groupPolicyList
SdkInternalList<T> groupPolicyList

 A list of the inline policies embedded in the group.
 


attachedManagedPolicies
SdkInternalList<T> attachedManagedPolicies

 A list of the managed policies attached to the group.
 








Class com.amazonaws.services.identitymanagement.model.InstanceProfile extends Object implements Serializable


Serialized Fields


path
String path

 The path to the instance profile. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 


instanceProfileName
String instanceProfileName

 The name identifying the instance profile.
 


instanceProfileId
String instanceProfileId

 The stable and unique string identifying the instance profile. For more information about IDs, see IAM Identifiers in the IAM
 User Guide.
 


arn
String arn

 The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use
 them in policies, see IAM
 Identifiers in the IAM User Guide.
 


createDate
Date createDate

 The date when the instance profile was created.
 


roles
SdkInternalList<T> roles

 The role associated with the instance profile.
 








Class com.amazonaws.services.identitymanagement.model.InvalidAuthenticationCodeException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.InvalidCertificateException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.InvalidInputException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.InvalidPublicKeyException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.InvalidUserTypeException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.KeyPairMismatchException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.LimitExceededException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.ListAccessKeysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListAccessKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accessKeyMetadata
SdkInternalList<T> 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
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListAccountAliasesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


marker
String marker

 Use this parameter only when paginating results and only after you receive a response indicating that the results
 are truncated. Set it to the value of the Marker element in the response that you received to
 indicate where the next call should start.
 


maxItems
Integer maxItems

 Use this only when paginating results to indicate the maximum number of items you want in the response. If
 additional items exist beyond the maximum you specify, the IsTruncated response element is
 true.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListAccountAliasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accountAliases
SdkInternalList<T> accountAliases

 A list of aliases associated with the account. AWS supports only one alias per account.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListAttachedGroupPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name (friendly name, not ARN) of the group to list attached policies for.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


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.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
 character (), including most punctuation characters, digits, and upper and lowercased letters.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListAttachedGroupPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attachedPolicies
SdkInternalList<T> attachedPolicies

 A list of the attached policies.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListAttachedRolePoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name (friendly name, not ARN) of the role to list attached policies for.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


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.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
 character (), including most punctuation characters, digits, and upper and lowercased letters.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListAttachedRolePoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attachedPolicies
SdkInternalList<T> attachedPolicies

 A list of the attached policies.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListAttachedUserPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name (friendly name, not ARN) of the user to list attached policies for.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


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.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
 character (), including most punctuation characters, digits, and upper and lowercased letters.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListAttachedUserPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attachedPolicies
SdkInternalList<T> attachedPolicies

 A list of the attached policies.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListEntitiesForPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyArn
String policyArn

 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.
 


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.
 


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.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
 character (), including most punctuation characters, digits, and upper and lowercased letters.
 


policyUsageFilter
String policyUsageFilter

 The policy usage method to use for filtering the results.
 
 
 To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list
 only the policies used to set permissions boundaries, set the value to PermissionsBoundary.
 
 
 This parameter is optional. If it is not included, all policies are returned.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListEntitiesForPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyGroups
SdkInternalList<T> policyGroups

 A list of IAM groups that the policy is attached to.
 


policyUsers
SdkInternalList<T> policyUsers

 A list of IAM users that the policy is attached to.
 


policyRoles
SdkInternalList<T> policyRoles

 A list of IAM roles that the policy is attached to.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListGroupPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name of the group to list policies for.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListGroupPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyNames
SdkInternalList<T> policyNames

 A list of policy names.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


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


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListGroupsForUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user to list groups for.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListGroupsForUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


groups
SdkInternalList<T> groups

 A list of groups.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pathPrefix
String pathPrefix

 The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/
 gets all groups whose path starts with /division_abc/subdivision_xyz/.
 
 
 This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. This parameter
 allows (through its regex pattern) a string of characters
 consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In
 addition, it can contain any ASCII character from the ! (!) through the DEL character (
 ), including most punctuation characters, digits, and upper and lowercased letters.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


groups
SdkInternalList<T> groups

 A list of groups.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesForRoleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the role to list instance profiles for.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesForRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceProfiles
SdkInternalList<T> instanceProfiles

 A list of instance profiles.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pathPrefix
String pathPrefix

 The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/
 gets all instance profiles whose path starts with /application_abc/component_xyz/.
 
 
 This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles.
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
 character (), including most punctuation characters, digits, and upper and lowercased letters.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceProfiles
SdkInternalList<T> instanceProfiles

 A list of instance profiles.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListMFADevicesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user whose MFA devices you want to list.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListMFADevicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


mFADevices
SdkInternalList<T> mFADevices

 A list of MFA devices.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListOpenIDConnectProvidersRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.ListOpenIDConnectProvidersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


openIDConnectProviderList
SdkInternalList<T> openIDConnectProviderList

 The list of IAM OIDC provider resource objects defined in the AWS account.
 








Class com.amazonaws.services.identitymanagement.model.ListPoliciesGrantingServiceAccessEntry extends Object implements Serializable


Serialized Fields


serviceNamespace
String serviceNamespace

 The namespace of the service that was accessed.
 
 
 To learn the service namespace of a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the
 service to view details for that service. In the first paragraph, find the service prefix. For example,
 (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference.
 


policies
SdkInternalList<T> policies

 The PoliciesGrantingServiceAccess object that contains details about the policy.
 








Class com.amazonaws.services.identitymanagement.model.ListPoliciesGrantingServiceAccessRequest 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.
 


arn
String arn

 The ARN of the IAM identity (user, group, or role) whose policies you want to list.
 


serviceNamespaces
SdkInternalList<T> serviceNamespaces

 The service namespace for the AWS services whose policies you want to list.
 
 
 To learn the service namespace for a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the
 service to view details for that service. In the first paragraph, find the service prefix. For example,
 (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference.
 








Class com.amazonaws.services.identitymanagement.model.ListPoliciesGrantingServiceAccessResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policiesGrantingServiceAccess
SdkInternalList<T> policiesGrantingServiceAccess

 A ListPoliciesGrantingServiceAccess object that contains details about the permissions policies
 attached to the specified identity (user, group, or role).
 


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. We
 recommend that you check IsTruncated after every call to ensure that you receive all 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.ListPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


scope
String scope

 The scope to use for filtering the results.
 
 
 To list only AWS managed policies, set Scope to AWS. To list only the customer managed
 policies in your AWS account, set Scope to Local.
 
 
 This parameter is optional. If it is not included, or if it is set to All, all policies are
 returned.
 


onlyAttached
Boolean onlyAttached

 A flag to filter the results to only the attached policies.
 
 
 When OnlyAttached is true, the returned list contains only the policies that are
 attached to 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. This parameter allows (through its regex pattern) a string of characters consisting of either a forward
 slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any
 ASCII character from the ! (!) through the DEL character (), including most
 punctuation characters, digits, and upper and lowercased letters.
 


policyUsageFilter
String policyUsageFilter

 The policy usage method to use for filtering the results.
 
 
 To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list
 only the policies used to set permissions boundaries, set the value to PermissionsBoundary.
 
 
 This parameter is optional. If it is not included, all policies are returned.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policies
SdkInternalList<T> policies

 A list of policies.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListPolicyVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyArn
String policyArn

 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.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListPolicyVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


versions
SdkInternalList<T> versions

 A list of policy versions.
 
 
 For more information about managed policy versions, see Versioning for Managed
 Policies in the IAM User Guide.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListRolePoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the role to list policies for.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListRolePoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyNames
SdkInternalList<T> policyNames

 A list of policy names.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListRolesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pathPrefix
String pathPrefix

 The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/
 gets all roles whose path starts with /application_abc/component_xyz/.
 
 
 This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This parameter
 allows (through its regex pattern) a string of characters
 consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In
 addition, it can contain any ASCII character from the ! (!) through the DEL character (
 ), including most punctuation characters, digits, and upper and lowercased letters.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListRolesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roles
SdkInternalList<T> roles

 A list of roles.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 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.ListRoleTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the IAM role for which you want to see the list of tags.
 
 
 This parameter accepts (through its regex pattern) a string of
 characters that consist 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

 (Optional) Use this only when paginating results to indicate the maximum number of items that you want in the
 response. If additional items exist beyond the maximum that you specify, the IsTruncated response
 element is true.
 
 
 If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when
 more results are 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.ListRoleTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 The list of tags currently that is attached to the role. Each tag consists of a key name and an associated value.
 If no tags are attached to the specified role, the response contains an empty list.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can use the
 Marker request parameter to make a subsequent pagination request that retrieves more items. Note
 that IAM might return fewer than the MaxItems number of results even when more results are
 available. Check IsTruncated after every call to ensure that you receive all of your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListSAMLProvidersRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.ListSAMLProvidersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sAMLProviderList
SdkInternalList<T> sAMLProviderList

 The list of SAML provider resource objects defined in IAM for this AWS account.
 








Class com.amazonaws.services.identitymanagement.model.ListServerCertificatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pathPrefix
String pathPrefix

 The path prefix for filtering the results. For example: /company/servercerts would get all server
 certificates for which the path starts with /company/servercerts.
 
 
 This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates.
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
 character (), including most punctuation characters, digits, and upper and lowercased letters.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListServerCertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serverCertificateMetadataList
SdkInternalList<T> serverCertificateMetadataList

 A list of server certificates.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 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.ListServiceSpecificCredentialsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user whose service-specific credentials you want information about. If this value is not
 specified, then the operation assumes the user whose credentials are used to call the operation.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


serviceName
String serviceName

 Filters the returned results to only those for the specified AWS service. If not specified, then AWS returns
 service-specific credentials for all services.
 








Class com.amazonaws.services.identitymanagement.model.ListServiceSpecificCredentialsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serviceSpecificCredentials
SdkInternalList<T> serviceSpecificCredentials

 A list of structures that each contain details about a service-specific credential.
 








Class com.amazonaws.services.identitymanagement.model.ListSigningCertificatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user whose signing certificates you want to examine.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListSigningCertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificates
SdkInternalList<T> certificates

 A list of the user's signing certificate information.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListSSHPublicKeysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is
 determined implicitly based on the AWS access key used to sign the request.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListSSHPublicKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sSHPublicKeys
SdkInternalList<T> sSHPublicKeys

 A list of the SSH public keys assigned to IAM user.
 


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


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListUserPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user to list policies for.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListUserPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyNames
SdkInternalList<T> policyNames

 A list of policy names.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pathPrefix
String pathPrefix

 The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would
 get all user names whose path starts with /division_abc/subdivision_xyz/.
 
 
 This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. This
 parameter allows (through its regex pattern) a string of characters
 consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In
 addition, it can contain any ASCII character from the ! (!) through the DEL character (
 ), including most punctuation characters, digits, and upper and lowercased letters.
 


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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


users
SdkInternalList<T> users

 A list of users.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 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.ListUserTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user whose tags you want to see.
 
 
 This parameter accepts (through its regex pattern) a string of
 characters that consist 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

 (Optional) Use this only when paginating results to indicate the maximum number of items that you want in the
 response. If additional items exist beyond the maximum that you specify, the IsTruncated response
 element is true.
 
 
 If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when
 more results are 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.ListUserTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 The list of tags that are currently attached to the user. Each tag consists of a key name and an associated
 value. If no tags are attached to the specified user, the response contains an empty list.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can use the
 Marker request parameter to make a subsequent pagination request that retrieves more items. Note
 that IAM might return fewer than the MaxItems number of results even when more results are
 available. Check IsTruncated after every call to ensure that you receive all of your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.ListVirtualMFADevicesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assignmentStatus
String assignmentStatus

 The status (Unassigned or Assigned) of the devices to list. If you do not specify an
 AssignmentStatus, the operation 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.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 








Class com.amazonaws.services.identitymanagement.model.ListVirtualMFADevicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


virtualMFADevices
SdkInternalList<T> virtualMFADevices

 The list of virtual MFA devices in the current account that match the AssignmentStatus value that
 was passed in the request.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.LoginProfile extends Object implements Serializable


Serialized Fields


userName
String userName

 The name of the user, which can be used for signing in to the AWS Management Console.
 


createDate
Date createDate

 The date when the password for the user was created.
 


passwordResetRequired
Boolean passwordResetRequired

 Specifies whether the user is required to set a new password on next sign-in.
 








Class com.amazonaws.services.identitymanagement.model.MalformedCertificateException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.MalformedPolicyDocumentException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.ManagedPolicyDetail extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The friendly name (not ARN) identifying the policy.
 


policyId
String policyId

 The stable and unique string identifying the policy.
 
 
 For more information about IDs, see IAM Identifiers in the IAM
 User Guide.
 


arn
String arn


path
String path

 The path to the policy.
 
 
 For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 


defaultVersionId
String defaultVersionId

 The identifier for the version of the policy that is set as the default (operative) version.
 
 
 For more information about policy versions, see Versioning for Managed
 Policies in the IAM User Guide.
 


attachmentCount
Integer attachmentCount

 The number of principal entities (users, groups, and roles) that the policy is attached to.
 


permissionsBoundaryUsageCount
Integer permissionsBoundaryUsageCount

 The number of entities (users and roles) for which the policy is used as the permissions boundary.
 
 
 For more information about permissions boundaries, see Permissions Boundaries
 for IAM Identities  in the IAM User Guide.
 


isAttachable
Boolean isAttachable

 Specifies whether the policy can be attached to an IAM user, group, or role.
 


description
String description

 A friendly description of the policy.
 


createDate
Date createDate

 The date and time, in ISO 8601 date-time format, when the policy was
 created.
 


updateDate
Date updateDate

 The date and time, in ISO 8601 date-time format, when the policy was
 last updated.
 
 
 When a policy has only one version, this field contains the date and time when the policy was created. When a
 policy has more than one version, this field contains the date and time when the most recent policy version was
 created.
 


policyVersionList
SdkInternalList<T> policyVersionList

 A list containing information about the versions of the policy.
 








Class com.amazonaws.services.identitymanagement.model.MFADevice extends Object implements Serializable


Serialized Fields


userName
String userName

 The user with whom the MFA device is associated.
 


serialNumber
String serialNumber

 The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the
 device ARN.
 


enableDate
Date enableDate

 The date when the MFA device was enabled for the user.
 








Class com.amazonaws.services.identitymanagement.model.NoSuchEntityException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.OpenIDConnectProviderListEntry extends Object implements Serializable


Serialized Fields


arn
String arn








Class com.amazonaws.services.identitymanagement.model.OrganizationsDecisionDetail extends Object implements Serializable


Serialized Fields


allowedByOrganizations
Boolean allowedByOrganizations

 Specifies whether the simulated operation is allowed by the Organizations service control policies that impact
 the simulated user's account.
 








Class com.amazonaws.services.identitymanagement.model.PasswordPolicy extends Object implements Serializable


Serialized Fields


minimumPasswordLength
Integer minimumPasswordLength

 Minimum length to require for IAM user passwords.
 


requireSymbols
Boolean requireSymbols

 Specifies whether to require symbols for IAM user passwords.
 


requireNumbers
Boolean requireNumbers

 Specifies whether to require numbers for IAM user passwords.
 


requireUppercaseCharacters
Boolean requireUppercaseCharacters

 Specifies whether to require uppercase characters for IAM user passwords.
 


requireLowercaseCharacters
Boolean requireLowercaseCharacters

 Specifies whether to require lowercase characters for IAM user passwords.
 


allowUsersToChangePassword
Boolean allowUsersToChangePassword

 Specifies whether IAM users are allowed to change their own password.
 


expirePasswords
Boolean expirePasswords

 Indicates whether passwords in the account expire. Returns true if MaxPasswordAge contains a value
 greater than 0. Returns false if MaxPasswordAge is 0 or not present.
 


maxPasswordAge
Integer maxPasswordAge

 The number of days that an IAM user password is valid.
 


passwordReusePrevention
Integer passwordReusePrevention

 Specifies the number of previous passwords that IAM users are prevented from reusing.
 


hardExpiry
Boolean hardExpiry

 Specifies whether IAM users are prevented from setting a new password after their password has expired.
 








Class com.amazonaws.services.identitymanagement.model.PasswordPolicyViolationException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.PermissionsBoundaryDecisionDetail extends Object implements Serializable


Serialized Fields


allowedByPermissionsBoundary
Boolean allowedByPermissionsBoundary

 Specifies whether an action is allowed by a permissions boundary that is applied to an IAM entity (user or role).
 A value of true means that the permissions boundary does not deny the action. This means that the
 policy includes an Allow statement that matches the request. In this case, if an identity-based
 policy also allows the action, the request is allowed. A value of false means that either the
 requested action is not allowed (implicitly denied) or that the action is explicitly denied by the permissions
 boundary. In both of these cases, the action is not allowed, regardless of the identity-based policy.
 








Class com.amazonaws.services.identitymanagement.model.Policy extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The friendly name (not ARN) identifying the policy.
 


policyId
String policyId

 The stable and unique string identifying the policy.
 
 
 For more information about IDs, see IAM Identifiers in the IAM
 User Guide.
 


arn
String arn


path
String path

 The path to the policy.
 
 
 For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 


defaultVersionId
String defaultVersionId

 The identifier for the version of the policy that is set as the default version.
 


attachmentCount
Integer attachmentCount

 The number of entities (users, groups, and roles) that the policy is attached to.
 


permissionsBoundaryUsageCount
Integer permissionsBoundaryUsageCount

 The number of entities (users and roles) for which the policy is used to set the permissions boundary.
 
 
 For more information about permissions boundaries, see Permissions Boundaries
 for IAM Identities  in the IAM User Guide.
 


isAttachable
Boolean isAttachable

 Specifies whether the policy can be attached to an IAM user, group, or role.
 


description
String description

 A friendly description of the policy.
 
 
 This element is included in the response to the GetPolicy operation. It is not included in the response to
 the ListPolicies operation.
 


createDate
Date createDate

 The date and time, in ISO 8601 date-time format, when the policy was
 created.
 


updateDate
Date updateDate

 The date and time, in ISO 8601 date-time format, when the policy was
 last updated.
 
 
 When a policy has only one version, this field contains the date and time when the policy was created. When a
 policy has more than one version, this field contains the date and time when the most recent policy version was
 created.
 








Class com.amazonaws.services.identitymanagement.model.PolicyDetail extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The name of the policy.
 


policyDocument
String policyDocument

 The policy document.
 








Class com.amazonaws.services.identitymanagement.model.PolicyEvaluationException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.PolicyGrantingServiceAccess extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The policy name.
 


policyType
String policyType

 The policy type. For more information about these policy types, see Managed Policies
 and Inline Policies in the IAM User Guide.
 


policyArn
String policyArn


entityType
String entityType

 The type of entity (user or role) that used the policy to access the service to which the inline policy is
 attached.
 
 
 This field is null for managed policies. For more information about these policy types, see Managed Policies
 and Inline Policies in the IAM User Guide.
 


entityName
String entityName

 The name of the entity (user or role) to which the inline policy is attached.
 
 
 This field is null for managed policies. For more information about these policy types, see Managed Policies
 and Inline Policies in the IAM User Guide.
 








Class com.amazonaws.services.identitymanagement.model.PolicyGroup extends Object implements Serializable


Serialized Fields


groupName
String groupName

 The name (friendly name, not ARN) identifying the group.
 


groupId
String groupId

 The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the
 IAM User Guide.
 








Class com.amazonaws.services.identitymanagement.model.PolicyNotAttachableException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.PolicyRole extends Object implements Serializable


Serialized Fields


roleName
String roleName

 The name (friendly name, not ARN) identifying the role.
 


roleId
String roleId

 The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the
 IAM User Guide.
 








Class com.amazonaws.services.identitymanagement.model.PolicyUser extends Object implements Serializable


Serialized Fields


userName
String userName

 The name (friendly name, not ARN) identifying the user.
 


userId
String userId

 The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the
 IAM User Guide.
 








Class com.amazonaws.services.identitymanagement.model.PolicyVersion extends Object implements Serializable


Serialized Fields


document
String document

 The policy document.
 
 
 The policy document is returned in the response to the GetPolicyVersion and
 GetAccountAuthorizationDetails operations. It is not returned in the response to the
 CreatePolicyVersion or ListPolicyVersions operations.
 
 
 The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy
 back to plain JSON text. For example, if you use Java, you can use the decode method of the
 java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar
 functionality.
 


versionId
String versionId

 The identifier for the policy version.
 
 
 Policy version identifiers always begin with v (always lowercase). When a policy is created, the
 first policy version is v1.
 


isDefaultVersion
Boolean isDefaultVersion

 Specifies whether the policy version is set as the policy's default version.
 


createDate
Date createDate

 The date and time, in ISO 8601 date-time format, when the policy
 version was created.
 








Class com.amazonaws.services.identitymanagement.model.Position extends Object implements Serializable


Serialized Fields


line
Integer line

 The line containing the specified position in the document.
 


column
Integer column

 The column in the line containing the specified position in the document.
 








Class com.amazonaws.services.identitymanagement.model.PutGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name of the group to associate the policy with.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you
 can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format
 before submitting it to IAM.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 








Class com.amazonaws.services.identitymanagement.model.PutGroupPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.PutRolePermissionsBoundaryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name (friendly name, not ARN) of the IAM role for which you want to set the permissions boundary.
 


permissionsBoundary
String permissionsBoundary

 The ARN of the policy that is used to set the permissions boundary for the role.
 








Class com.amazonaws.services.identitymanagement.model.PutRolePermissionsBoundaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.PutRolePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the role to associate the policy with.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you
 can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format
 before submitting it to IAM.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 








Class com.amazonaws.services.identitymanagement.model.PutRolePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.PutUserPermissionsBoundaryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name (friendly name, not ARN) of the IAM user for which you want to set the permissions boundary.
 


permissionsBoundary
String permissionsBoundary

 The ARN of the policy that is used to set the permissions boundary for the user.
 








Class com.amazonaws.services.identitymanagement.model.PutUserPermissionsBoundaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.PutUserPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user to associate the policy with.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you
 can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format
 before submitting it to IAM.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 








Class com.amazonaws.services.identitymanagement.model.PutUserPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.RemoveClientIDFromOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


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 operation.
 
 
 For more information about ARNs, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces in the AWS General Reference.
 


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.
 








Class com.amazonaws.services.identitymanagement.model.RemoveClientIDFromOpenIDConnectProviderResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.RemoveRoleFromInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceProfileName
String instanceProfileName

 The name of the instance profile to update.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.RemoveUserFromGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


groupName
String groupName

 The name of the group to update.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.ReportGenerationLimitExceededException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.ResetServiceSpecificCredentialRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user associated with the service-specific credential. If this value is not specified, then
 the operation assumes the user whose credentials are used to call the operation.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


serviceSpecificCredentialId
String serviceSpecificCredentialId

 The unique identifier of the service-specific credential.
 
 
 This parameter allows (through its regex pattern) a string of
 characters that can consist of any upper or lowercased letter or digit.
 








Class com.amazonaws.services.identitymanagement.model.ResetServiceSpecificCredentialResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serviceSpecificCredential
ServiceSpecificCredential serviceSpecificCredential

 A structure with details about the updated service-specific credential, including the new password.
 
 
 
 This is the only time that you can access the password. You cannot recover the password later, but you can
 reset it again.
 
 








Class com.amazonaws.services.identitymanagement.model.ResourceSpecificResult extends Object implements Serializable


Serialized Fields


evalResourceName
String evalResourceName

 The name of the simulated resource, in Amazon Resource Name (ARN) format.
 


evalResourceDecision
String evalResourceDecision

 The result of the simulation of the simulated API operation on the resource specified in
 EvalResourceName.
 


matchedStatements
SdkInternalList<T> matchedStatements

 A list of the statements in the input policies that determine the result for this part of the simulation.
 Remember that even if multiple statements allow the operation on the resource, if any statement denies
 that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry
 included in the result.
 


missingContextValues
SdkInternalList<T> missingContextValues

 A list of context keys that are required by the included input policies but that were not provided by one of the
 input parameters. 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.
 


evalDecisionDetails
SdkInternalMap<K,V> evalDecisionDetails

 Additional details about the results of the evaluation decision on a single resource. This parameter is returned
 only for cross-account simulations. This parameter explains how each policy type contributes to the
 resource-specific evaluation decision.
 


permissionsBoundaryDecisionDetail
PermissionsBoundaryDecisionDetail permissionsBoundaryDecisionDetail

 Contains information about the effect that a permissions boundary has on a policy simulation when that boundary
 is applied to an IAM entity.
 








Class com.amazonaws.services.identitymanagement.model.ResyncMFADeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user whose MFA device you want to resynchronize.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


serialNumber
String serialNumber

 Serial number that uniquely identifies the MFA device.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


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.
 








Class com.amazonaws.services.identitymanagement.model.ResyncMFADeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.Role extends Object implements Serializable


Serialized Fields


path
String path

 The path to the role. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 


roleName
String roleName

 The friendly name that identifies the role.
 


roleId
String roleId

 The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the IAM
 User Guide.
 


arn
String arn

 The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in
 policies, see IAM
 Identifiers in the IAM User Guide guide.
 


createDate
Date createDate

 The date and time, in ISO 8601 date-time format, when the role was
 created.
 


assumeRolePolicyDocument
String assumeRolePolicyDocument

 The policy that grants an entity permission to assume the role.
 


description
String description

 A description of the role that you provide.
 


maxSessionDuration
Integer maxSessionDuration

 The maximum session duration (in seconds) for the specified role. Anyone who uses the AWS CLI, or API to assume
 the role can specify the duration using the optional DurationSeconds API parameter or
 duration-seconds CLI parameter.
 


permissionsBoundary
AttachedPermissionsBoundary permissionsBoundary

 The ARN of the policy used to set the permissions boundary for the role.
 
 
 For more information about permissions boundaries, see Permissions Boundaries
 for IAM Identities  in the IAM User Guide.
 


tags
SdkInternalList<T> tags

 A list of tags that are attached to the specified role. For more information about tagging, see Tagging IAM Identities in the IAM
 User Guide.
 


roleLastUsed
RoleLastUsed roleLastUsed

 Contains information about the last time that an IAM role was used. This includes the date and time and the
 Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be
 shorter if your Region began supporting these features within the last year. The role might have been used more
 than 400 days ago. For more information, see Regions Where Data Is Tracked in the IAM User Guide.
 








Class com.amazonaws.services.identitymanagement.model.RoleDetail extends Object implements Serializable


Serialized Fields


path
String path

 The path to the role. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 


roleName
String roleName

 The friendly name that identifies the role.
 


roleId
String roleId

 The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the IAM
 User Guide.
 


arn
String arn


createDate
Date createDate

 The date and time, in ISO 8601 date-time format, when the role was
 created.
 


assumeRolePolicyDocument
String assumeRolePolicyDocument

 The trust policy that grants permission to assume the role.
 


instanceProfileList
SdkInternalList<T> instanceProfileList

 A list of instance profiles that contain this role.
 


rolePolicyList
SdkInternalList<T> rolePolicyList

 A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.
 


attachedManagedPolicies
SdkInternalList<T> attachedManagedPolicies

 A list of managed policies attached to the role. These policies are the role's access (permissions) policies.
 


permissionsBoundary
AttachedPermissionsBoundary permissionsBoundary

 The ARN of the policy used to set the permissions boundary for the role.
 
 
 For more information about permissions boundaries, see Permissions Boundaries
 for IAM Identities  in the IAM User Guide.
 


tags
SdkInternalList<T> tags

 A list of tags that are attached to the specified role. For more information about tagging, see Tagging IAM Identities in the IAM
 User Guide.
 


roleLastUsed
RoleLastUsed roleLastUsed

 Contains information about the last time that an IAM role was used. This includes the date and time and the
 Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be
 shorter if your Region began supporting these features within the last year. The role might have been used more
 than 400 days ago. For more information, see Regions Where Data Is Tracked in the IAM User Guide.
 








Class com.amazonaws.services.identitymanagement.model.RoleLastUsed extends Object implements Serializable


Serialized Fields


lastUsedDate
Date lastUsedDate

 The date and time, in ISO 8601 date-time format that the role was
 last used.
 
 
 This field is null if the role has not been used within the IAM tracking period. For more information about the
 tracking period, see Regions Where Data Is Tracked in the IAM User Guide.
 


region
String region

 The name of the AWS Region in which the role was last used.
 








Class com.amazonaws.services.identitymanagement.model.RoleUsageType extends Object implements Serializable


Serialized Fields


region
String region

 The name of the Region where the service-linked role is being used.
 


resources
SdkInternalList<T> resources

 The name of the resource that is using the service-linked role.
 








Class com.amazonaws.services.identitymanagement.model.SAMLProviderListEntry extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the SAML provider.
 


validUntil
Date validUntil

 The expiration date and time for the SAML provider.
 


createDate
Date createDate

 The date and time when the SAML provider was created.
 








Class com.amazonaws.services.identitymanagement.model.ServerCertificate extends Object implements Serializable


Serialized Fields


serverCertificateMetadata
ServerCertificateMetadata serverCertificateMetadata

 The meta information of the server certificate, such as its name, path, ID, and ARN.
 


certificateBody
String certificateBody

 The contents of the public key certificate.
 


certificateChain
String certificateChain

 The contents of the public key certificate chain.
 








Class com.amazonaws.services.identitymanagement.model.ServerCertificateMetadata extends Object implements Serializable


Serialized Fields


path
String path

 The path to the server certificate. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 


serverCertificateName
String serverCertificateName

 The name that identifies the server certificate.
 


serverCertificateId
String serverCertificateId

 The stable and unique string identifying the server certificate. For more information about IDs, see IAM Identifiers in the IAM
 User Guide.
 


arn
String arn

 The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use
 them in policies, see IAM
 Identifiers in the IAM User Guide.
 


uploadDate
Date uploadDate

 The date when the server certificate was uploaded.
 


expiration
Date expiration

 The date on which the certificate is set to expire.
 








Class com.amazonaws.services.identitymanagement.model.ServiceFailureException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.ServiceLastAccessed extends Object implements Serializable


Serialized Fields


serviceName
String serviceName

 The name of the service in which access was attempted.
 


lastAuthenticated
Date lastAuthenticated

 The date and time, in ISO 8601 date-time format, when an
 authenticated entity most recently attempted to access the service. AWS does not report unauthenticated requests.
 
 
 This field is null if no IAM entities attempted to access the service within the reporting period.
 


serviceNamespace
String serviceNamespace

 The namespace of the service in which access was attempted.
 
 
 To learn the service namespace of a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the
 service to view details for that service. In the first paragraph, find the service prefix. For example,
 (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference.
 


lastAuthenticatedEntity
String lastAuthenticatedEntity

 The ARN of the authenticated entity (user or role) that last attempted to access the service. AWS does not report
 unauthenticated requests.
 
 
 This field is null if no IAM entities attempted to access the service within the reporting period.
 


totalAuthenticatedEntities
Integer totalAuthenticatedEntities

 The total number of authenticated principals (root user, IAM users, or IAM roles) that have attempted to access
 the service.
 
 
 This field is null if no principals attempted to access the service within the reporting period.
 








Class com.amazonaws.services.identitymanagement.model.ServiceNotSupportedException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.ServiceSpecificCredential extends Object implements Serializable


Serialized Fields


createDate
Date createDate

 The date and time, in ISO 8601 date-time format, when the
 service-specific credential were created.
 


serviceName
String serviceName

 The name of the service associated with the service-specific credential.
 


serviceUserName
String serviceUserName

 The generated user name for the service-specific credential. This value is generated by combining the IAM user's
 name combined with the ID number of the AWS account, as in jane-at-123456789012, for example. This
 value cannot be configured by the user.
 


servicePassword
String servicePassword

 The generated password for the service-specific credential.
 


serviceSpecificCredentialId
String serviceSpecificCredentialId

 The unique identifier for the service-specific credential.
 


userName
String userName

 The name of the IAM user associated with the service-specific credential.
 


status
String status

 The status of the service-specific credential. Active means that the key is valid for API calls,
 while Inactive means it is not.
 








Class com.amazonaws.services.identitymanagement.model.ServiceSpecificCredentialMetadata extends Object implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user associated with the service-specific credential.
 


status
String status

 The status of the service-specific credential. Active means that the key is valid for API calls,
 while Inactive means it is not.
 


serviceUserName
String serviceUserName

 The generated user name for the service-specific credential.
 


createDate
Date createDate

 The date and time, in ISO 8601 date-time format, when the
 service-specific credential were created.
 


serviceSpecificCredentialId
String serviceSpecificCredentialId

 The unique identifier for the service-specific credential.
 


serviceName
String serviceName

 The name of the service associated with the service-specific credential.
 








Class com.amazonaws.services.identitymanagement.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.SetSecurityTokenServicePreferencesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalEndpointTokenVersion
String globalEndpointTokenVersion

 The version of the global endpoint token. Version 1 tokens are valid only in AWS Regions that are available by
 default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens
 are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily
 store tokens.
 
 
 For information, see Activating and
 Deactivating STS in an AWS Region in the IAM User Guide.
 








Class com.amazonaws.services.identitymanagement.model.SetSecurityTokenServicePreferencesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.SigningCertificate extends Object implements Serializable


Serialized Fields


userName
String userName

 The name of the user the signing certificate is associated with.
 


certificateId
String certificateId

 The ID for the signing certificate.
 


certificateBody
String certificateBody

 The contents of the signing certificate.
 


status
String status

 The status of the signing certificate. Active means that the key is valid for API calls, while
 Inactive means it is not.
 


uploadDate
Date uploadDate

 The date when the signing certificate was uploaded.
 








Class com.amazonaws.services.identitymanagement.model.SimulateCustomPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyInputList
SdkInternalList<T> policyInputList

 A list of policy documents to include in the simulation. Each document is specified as a string containing the
 complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any
 resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be
 "scope-down" policies, such as you could include in a call to GetFederationToken or
 one of the AssumeRole API
 operations. In other words, do not use policies designed to restrict what a user can do while using the temporary
 credentials.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 


permissionsBoundaryPolicyInputList
SdkInternalList<T> permissionsBoundaryPolicyInputList

 The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that an
 IAM entity can have. You can input only one permissions boundary when you pass a policy to this operation. For
 more information about permissions boundaries, see Permissions Boundaries
 for IAM Entities in the IAM User Guide. The policy input is specified as a string that contains the
 complete, valid JSON text of a permissions boundary policy.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 


actionNames
SdkInternalList<T> actionNames

 A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each
 resource. Each operation must include the service identifier, such as iam:CreateUser. This operation
 does not support using wildcards (*) in an action name.
 


resourceArns
SdkInternalList<T> resourceArns

 A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided, then the value
 defaults to * (all resources). Each API in the ActionNames parameter is evaluated for
 each resource in this list. The simulation determines the access result (allowed or denied) of each combination
 and reports it in the response.
 
 
 The simulation does not automatically retrieve policies for the specified resources. If you want to include a
 resource policy in the simulation, then you must include the policy as a string in the
 ResourcePolicy parameter.
 
 
 If you include a ResourcePolicy, then it must be applicable to all of the resources included in the
 simulation or you receive an invalid input error.
 
 
 For more information about ARNs, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces in the AWS General Reference.
 


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 used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 


resourceOwner
String resourceOwner

 An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify
 its owner in the resource ARN. Examples of resource ARNs include 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.
 
 
 The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For
 example, to represent the account with the 112233445566 ID, use the following ARN:
 arn:aws:iam::112233445566-ID:root.
 


callerArn
String callerArn

 The ARN of the IAM user that you want to use as the simulated caller of the API operations.
 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
SdkInternalList<T> 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 permissions policies, the corresponding value is supplied.
 


resourceHandlingOption
String resourceHandlingOption

 Specifies the type of simulation to run. Different API operations 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 Amazon EC2 User Guide.
 
 
 
 
 EC2-Classic-InstanceStore
 
 
 instance, image, security-group
 
 
 
 
 EC2-Classic-EBS
 
 
 instance, image, security-group, volume
 
 
 
 
 EC2-VPC-InstanceStore
 
 
 instance, image, security-group, network-interface
 
 
 
 
 EC2-VPC-InstanceStore-Subnet
 
 
 instance, image, security-group, network-interface, subnet
 
 
 
 
 EC2-VPC-EBS
 
 
 instance, image, security-group, network-interface, volume
 
 
 
 
 EC2-VPC-EBS-Subnet
 
 
 instance, image, security-group, network-interface, subnet, volume
 
 
 


maxItems
Integer maxItems

 Use this only when paginating results to indicate the maximum number of items you want in the response. If
 additional items exist beyond the maximum you specify, the IsTruncated response element is
 true.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 


marker
String marker

 Use this parameter only when paginating results and only after you receive a response indicating that the results
 are truncated. Set it to the value of the Marker element in the response that you received to
 indicate where the next call should start.
 








Class com.amazonaws.services.identitymanagement.model.SimulateCustomPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


evaluationResults
SdkInternalList<T> evaluationResults

 The results of the simulation.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.SimulatePrincipalPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policySourceArn
String policySourceArn

 The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If
 you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If
 you specify a user, the simulation also includes all policies that are attached to any groups the user belongs
 to.
 
 
 For more information about ARNs, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces in the AWS General Reference.
 


policyInputList
SdkInternalList<T> policyInputList

 An optional list of additional policy documents to include in the simulation. Each document is specified as a
 string containing the complete, valid JSON text of an IAM policy.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 


permissionsBoundaryPolicyInputList
SdkInternalList<T> permissionsBoundaryPolicyInputList

 The IAM permissions boundary policy to simulate. The permissions boundary sets the maximum permissions that the
 entity can have. You can input only one permissions boundary when you pass a policy to this operation. An IAM
 entity can only have one permissions boundary in effect at a time. For example, if a permissions boundary is
 attached to an entity and you pass in a different permissions boundary policy using this parameter, then the new
 permission boundary policy is used for the simulation. For more information about permissions boundaries, see Permissions Boundaries
 for IAM Entities in the IAM User Guide. The policy input is specified as a string containing the
 complete, valid JSON text of a permissions boundary policy.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 


actionNames
SdkInternalList<T> actionNames

 A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each resource.
 Each operation must include the service identifier, such as iam:CreateUser.
 


resourceArns
SdkInternalList<T> resourceArns

 A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided, then the value
 defaults to * (all resources). Each API in the ActionNames parameter is evaluated for
 each resource in this list. The simulation determines the access result (allowed or denied) of each combination
 and reports it in the response.
 
 
 The simulation does not automatically retrieve policies for the specified resources. If you want to include a
 resource policy in the simulation, then you must include the policy as a string in the
 ResourcePolicy parameter.
 
 
 For more information about ARNs, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces in the AWS General Reference.
 


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 used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 


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. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is
 specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If
 the ResourceOwner parameter is not specified, then the owner of the resources and the resource
 policy defaults to the account of the identity provided in CallerArn. This parameter is required
 only if you specify a resource-based policy and account that owns the resource is different from the account that
 owns the simulated calling user CallerArn.
 


callerArn
String callerArn

 The ARN of the IAM user that you want to specify as the simulated caller of the API operations. 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 API operations 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
SdkInternalList<T> 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 permissions policies, the corresponding value is supplied.
 


resourceHandlingOption
String resourceHandlingOption

 Specifies the type of simulation to run. Different API operations 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 Amazon EC2 User Guide.
 
 
 
 
 EC2-Classic-InstanceStore
 
 
 instance, image, security group
 
 
 
 
 EC2-Classic-EBS
 
 
 instance, image, security group, volume
 
 
 
 
 EC2-VPC-InstanceStore
 
 
 instance, image, security group, network interface
 
 
 
 
 EC2-VPC-InstanceStore-Subnet
 
 
 instance, image, security group, network interface, subnet
 
 
 
 
 EC2-VPC-EBS
 
 
 instance, image, security group, network interface, volume
 
 
 
 
 EC2-VPC-EBS-Subnet
 
 
 instance, image, security group, network interface, subnet, volume
 
 
 


maxItems
Integer maxItems

 Use this only when paginating results to indicate the maximum number of items you want in the response. If
 additional items exist beyond the maximum you specify, the IsTruncated response element is
 true.
 
 
 If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer
 results, even when there are more results available. In that case, the IsTruncated response element
 returns true, and Marker contains a value to include in the subsequent call that tells
 the service where to continue from.
 


marker
String marker

 Use this parameter only when paginating results and only after you receive a response indicating that the results
 are truncated. Set it to the value of the Marker element in the response that you received to
 indicate where the next call should start.
 








Class com.amazonaws.services.identitymanagement.model.SimulatePrincipalPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


evaluationResults
SdkInternalList<T> evaluationResults

 The results of the simulation.
 


isTruncated
Boolean isTruncated

 A flag that indicates whether there are more items to return. If your results were truncated, you can make a
 subsequent pagination request using the Marker request parameter to retrieve more items. Note that
 IAM might return fewer than the MaxItems number of results even when there are more results
 available. We recommend that you check IsTruncated after every call to ensure that you receive all
 your results.
 


marker
String marker

 When IsTruncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent pagination request.
 








Class com.amazonaws.services.identitymanagement.model.SSHPublicKey extends Object implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user associated with the SSH public key.
 


sSHPublicKeyId
String sSHPublicKeyId

 The unique identifier for the SSH public key.
 


fingerprint
String fingerprint

 The MD5 message digest of the SSH public key.
 


sSHPublicKeyBody
String sSHPublicKeyBody

 The SSH public key.
 


status
String status

 The status of the SSH public key. Active means that the key can be used for authentication with an
 AWS CodeCommit repository. Inactive means that the key cannot be used.
 


uploadDate
Date uploadDate

 The date and time, in ISO 8601 date-time format, when the SSH public
 key was uploaded.
 








Class com.amazonaws.services.identitymanagement.model.SSHPublicKeyMetadata extends Object implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user associated with the SSH public key.
 


sSHPublicKeyId
String sSHPublicKeyId

 The unique identifier for the SSH public key.
 


status
String status

 The status of the SSH public key. Active means that the key can be used for authentication with an
 AWS CodeCommit repository. Inactive means that the key cannot be used.
 


uploadDate
Date uploadDate

 The date and time, in ISO 8601 date-time format, when the SSH public
 key was uploaded.
 








Class com.amazonaws.services.identitymanagement.model.Statement extends Object implements Serializable


Serialized Fields


sourcePolicyId
String sourcePolicyId

 The identifier of the policy that was provided as an input.
 


sourcePolicyType
String sourcePolicyType

 The type of the policy.
 


startPosition
Position startPosition

 The row and column of the beginning of the Statement in an IAM policy.
 


endPosition
Position endPosition

 The row and column of the end of a Statement in an IAM policy.
 








Class com.amazonaws.services.identitymanagement.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key name that can be used to look up or retrieve the associated value. For example, Department
 or Cost Center are common choices.
 


value
String value

 The value associated with this tag. For example, tags with a key name of Department could have
 values such as Human Resources, Accounting, and Support. Tags with a key
 name of Cost Center might have values that consist of the number associated with the different cost
 centers in your company. Typically, many resources have tags with the same key name but with different values.
 
 
 
 AWS always interprets the tag Value as a single string. If you need to store an array, you can store
 comma-separated values in the string. However, you must interpret the value in your code.
 
 








Class com.amazonaws.services.identitymanagement.model.TagRoleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the role that you want to add tags to.
 
 
 This parameter accepts (through its regex pattern) a string of
 characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any
 of the following characters: _+=,.@-
 


tags
SdkInternalList<T> tags

 The list of tags that you want to attach to the role. Each tag consists of a key name and an associated value.
 You can specify this with a JSON string.
 








Class com.amazonaws.services.identitymanagement.model.TagRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.TagUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user that you want to add tags to.
 
 
 This parameter accepts (through its regex pattern) a string of
 characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any
 of the following characters: =,.@-
 


tags
SdkInternalList<T> tags

 The list of tags that you want to attach to the user. Each tag consists of a key name and an associated value.
 








Class com.amazonaws.services.identitymanagement.model.TagUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UnmodifiableEntityException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.UnrecognizedPublicKeyEncodingException extends AmazonIdentityManagementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.UntagRoleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the IAM role from which you want to remove tags.
 
 
 This parameter accepts (through its regex pattern) a string of
 characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any
 of the following characters: _+=,.@-
 


tagKeys
SdkInternalList<T> tagKeys

 A list of key names as a simple array of strings. The tags with matching keys are removed from the specified
 role.
 








Class com.amazonaws.services.identitymanagement.model.UntagRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UntagUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user from which you want to remove tags.
 
 
 This parameter accepts (through its regex pattern) a string of
 characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any
 of the following characters: =,.@-
 


tagKeys
SdkInternalList<T> tagKeys

 A list of key names as a simple array of strings. The tags with matching keys are removed from the specified
 user.
 








Class com.amazonaws.services.identitymanagement.model.UntagUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UpdateAccessKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user whose key you want to update.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


accessKeyId
String accessKeyId

 The access key ID of the secret access key you want to update.
 
 
 This parameter allows (through its regex pattern) 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 that the key can be used for
 API calls to AWS, while Inactive means that the key cannot be used.
 








Class com.amazonaws.services.identitymanagement.model.UpdateAccessKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UpdateAccountPasswordPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


minimumPasswordLength
Integer minimumPasswordLength

 The minimum number of characters allowed in an IAM user password.
 
 
 If you do not specify a value for this parameter, then the operation uses the default value of 6.
 


requireSymbols
Boolean requireSymbols

 Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:
 
 
 ! @ # $ % ^ & * ( ) _ + - = [ ] { } | '
 
 
 If you do not specify a value for this parameter, then the operation uses the default value of false
 . The result is that passwords do not require at least one symbol character.
 


requireNumbers
Boolean requireNumbers

 Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).
 
 
 If you do not specify a value for this parameter, then the operation uses the default value of false
 . The result is that passwords do not require at least one numeric character.
 


requireUppercaseCharacters
Boolean requireUppercaseCharacters

 Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin
 alphabet (A to Z).
 
 
 If you do not specify a value for this parameter, then the operation uses the default value of false
 . The result is that passwords do not require at least one uppercase character.
 


requireLowercaseCharacters
Boolean requireLowercaseCharacters

 Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin
 alphabet (a to z).
 
 
 If you do not specify a value for this parameter, then the operation uses the default value of false
 . The result is that passwords do not require at least one lowercase character.
 


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.
 
 
 If you do not specify a value for this parameter, then the operation uses the default value of false
 . The result is that IAM users in the account do not automatically have permissions to change their own password.
 


maxPasswordAge
Integer maxPasswordAge

 The number of days that an IAM user password is valid.
 
 
 If you do not specify a value for this parameter, then the operation uses the default value of 0.
 The result is that IAM user passwords never expire.
 


passwordReusePrevention
Integer passwordReusePrevention

 Specifies the number of previous passwords that IAM users are prevented from reusing.
 
 
 If you do not specify a value for this parameter, then the operation uses the default value of 0.
 The result is that IAM users are not prevented from reusing previous passwords.
 


hardExpiry
Boolean hardExpiry

 Prevents IAM users from setting a new password after their password has expired. The IAM user cannot be accessed
 until an administrator resets the password.
 
 
 If you do not specify a value for this parameter, then the operation uses the default value of false
 . The result is that IAM users can change their passwords after they expire and continue to sign in as the user.
 








Class com.amazonaws.services.identitymanagement.model.UpdateAccountPasswordPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UpdateAssumeRolePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the role to update with the new policy.
 
 
 This parameter allows (through its regex pattern) 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 that grants an entity permission to assume the role.
 
 
 You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you
 can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format
 before submitting it to IAM.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 








Class com.amazonaws.services.identitymanagement.model.UpdateAssumeRolePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.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.
 
 
 This parameter allows (through its regex pattern) 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.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL
 character (), including most punctuation characters, digits, and upper and lowercased letters.
 


newGroupName
String newGroupName

 New name for the IAM group. Only include this if changing the group's name.
 
 
 IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case.
 For example, you cannot create resources named both "MyResource" and "myresource".
 








Class com.amazonaws.services.identitymanagement.model.UpdateGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UpdateLoginProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user whose password you want to update.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


password
String password

 The new password for the specified IAM user.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 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.
 








Class com.amazonaws.services.identitymanagement.model.UpdateLoginProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.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 operation.
 
 
 For more information about ARNs, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces in the AWS General Reference.
 


thumbprintList
SdkInternalList<T> thumbprintList

 A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more
 information, see CreateOpenIDConnectProvider.
 








Class com.amazonaws.services.identitymanagement.model.UpdateOpenIDConnectProviderThumbprintResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UpdateRoleDescriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the role that you want to modify.
 


description
String description

 The new description that you want to apply to the specified role.
 








Class com.amazonaws.services.identitymanagement.model.UpdateRoleDescriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


role
Role role

 A structure that contains details about the modified role.
 








Class com.amazonaws.services.identitymanagement.model.UpdateRoleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleName
String roleName

 The name of the role that you want to modify.
 


description
String description

 The new description that you want to apply to the specified role.
 


maxSessionDuration
Integer maxSessionDuration

 The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a
 value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to
 12 hours.
 
 
 Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the
 duration-seconds CLI parameter to request a longer session. The MaxSessionDuration
 setting determines the maximum duration that can be requested using the DurationSeconds parameter.
 If users don't specify a value for the DurationSeconds parameter, their security credentials are
 valid for one hour by default. This applies when you use the AssumeRole* API operations or the
 assume-role* CLI operations but does not apply when you use those operations to create a console
 URL. For more information, see Using
 IAM Roles in the IAM User Guide.
 








Class com.amazonaws.services.identitymanagement.model.UpdateRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UpdateSAMLProviderRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sAMLMetadataDocument
String sAMLMetadataDocument

 An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the
 issuer's name, expiration information, and keys that can be used to validate the SAML authentication response
 (assertions) that are received from the IdP. You must generate the metadata document using the identity
 management software that is used as your organization's IdP.
 


sAMLProviderArn
String sAMLProviderArn

 The Amazon Resource Name (ARN) of the SAML provider to update.
 
 
 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sAMLProviderArn
String sAMLProviderArn

 The Amazon Resource Name (ARN) of the SAML provider that was updated.
 








Class com.amazonaws.services.identitymanagement.model.UpdateServerCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serverCertificateName
String serverCertificateName

 The name of the server certificate that you want to update.
 
 
 This parameter allows (through its regex pattern) 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

 The new path for the server certificate. Include this only if you are updating the server certificate's path.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through 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.
 
 
 This parameter allows (through its regex pattern) 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UpdateServiceSpecificCredentialRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user associated with the service-specific credential. If you do not specify this value, then
 the operation assumes the user whose credentials are used to call the operation.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


serviceSpecificCredentialId
String serviceSpecificCredentialId

 The unique identifier of the service-specific credential.
 
 
 This parameter allows (through its regex pattern) a string of
 characters that can consist of any upper or lowercased letter or digit.
 


status
String status

 The status to be assigned to the service-specific credential.
 








Class com.amazonaws.services.identitymanagement.model.UpdateServiceSpecificCredentialResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UpdateSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user the signing certificate belongs to.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


certificateId
String certificateId

 The ID of the signing certificate you want to update.
 
 
 This parameter allows (through its regex pattern) 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 that the certificate can be used for
 API calls to AWS Inactive means that the certificate cannot be used.
 








Class com.amazonaws.services.identitymanagement.model.UpdateSigningCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UpdateSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user associated with the SSH public key.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


sSHPublicKeyId
String sSHPublicKeyId

 The unique identifier for the SSH public key.
 
 
 This parameter allows (through its regex pattern) 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 that the key can be used for authentication
 with an AWS CodeCommit repository. Inactive means that the key cannot be used.
 








Class com.amazonaws.services.identitymanagement.model.UpdateSSHPublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UpdateUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 Name of the user to update. If you're changing the name of the user, this is the original user name.
 
 
 This parameter allows (through its regex pattern) 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 user. Include this parameter only if you're changing the user's path.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
 slashes. In addition, it can contain any ASCII character from the ! (!) through 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.
 
 
 IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case.
 For example, you cannot create resources named both "MyResource" and "myresource".
 








Class com.amazonaws.services.identitymanagement.model.UpdateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.identitymanagement.model.UploadServerCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


path
String path

 The path for the server certificate. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 
 
 This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its
 regex pattern) a string of characters consisting of either a
 forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain
 any ASCII character from the ! (!) through 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 parameter. The path must begin with /cloudfront and must
 include a trailing slash (for example, /cloudfront/test/).
 
 


serverCertificateName
String serverCertificateName

 The name for the server certificate. Do not include the path in this value. The name of the certificate cannot
 contain any spaces.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


certificateBody
String certificateBody

 The contents of the public key certificate in PEM-encoded format.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 


privateKey
String privateKey

 The contents of the private key in PEM-encoded format.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 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 used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 








Class com.amazonaws.services.identitymanagement.model.UploadServerCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serverCertificateMetadata
ServerCertificateMetadata serverCertificateMetadata

 The meta information of the uploaded server certificate without its certificate body, certificate chain, and
 private key.
 








Class com.amazonaws.services.identitymanagement.model.UploadSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the user the signing certificate is for.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


certificateBody
String certificateBody

 The contents of the signing certificate.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 








Class com.amazonaws.services.identitymanagement.model.UploadSigningCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificate
SigningCertificate certificate

 Information about the certificate.
 








Class com.amazonaws.services.identitymanagement.model.UploadSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


userName
String userName

 The name of the IAM user to associate the SSH public key with.
 
 
 This parameter allows (through its regex pattern) a string of
 characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
 the following characters: _+=,.@-
 


sSHPublicKeyBody
String sSHPublicKeyBody

 The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the
 public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes
 long.
 
 
 The regex pattern used to validate this parameter is a string of
 characters consisting of the following:
 
 
 
 
 Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
 character range
 
 
 
 
 The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ)
 
 
 
 
 The special characters tab (     ), line feed (
), and carriage return (

 )
 
 
 








Class com.amazonaws.services.identitymanagement.model.UploadSSHPublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sSHPublicKey
SSHPublicKey sSHPublicKey

 Contains information about the SSH public key.
 








Class com.amazonaws.services.identitymanagement.model.User extends Object implements Serializable


Serialized Fields


path
String path

 The path to the user. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 


userName
String userName

 The friendly name identifying the user.
 


userId
String userId

 The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM
 User Guide.
 


arn
String arn

 The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in
 policies, see IAM
 Identifiers in the IAM User 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 IAM User Guide. If a password is used more than once in a five-minute span, only the first use is
 returned in this field. If the field is null (no value), then it indicates that they never signed in with a
 password. This can be because:
 
 
 
 
 The user never had a password.
 
 
 
 
 A password exists but has not been used since IAM started tracking this information on October 20, 2014.
 
 
 
 
 A null value does not mean that the user never had a password. Also, if the user does not currently have a
 password but had one in the past, then this field contains the date and time the most recent password was used.
 
 
 This value is returned only in the GetUser and ListUsers operations.
 


permissionsBoundary
AttachedPermissionsBoundary permissionsBoundary

 The ARN of the policy used to set the permissions boundary for the user.
 
 
 For more information about permissions boundaries, see Permissions Boundaries
 for IAM Identities  in the IAM User Guide.
 


tags
SdkInternalList<T> tags

 A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM
 User Guide.
 








Class com.amazonaws.services.identitymanagement.model.UserDetail extends Object implements Serializable


Serialized Fields


path
String path

 The path to the user. For more information about paths, see IAM Identifiers in the IAM
 User Guide.
 


userName
String userName

 The friendly name identifying the user.
 


userId
String userId

 The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM
 User Guide.
 


arn
String arn


createDate
Date createDate

 The date and time, in ISO 8601 date-time format, when the user was
 created.
 


userPolicyList
SdkInternalList<T> userPolicyList

 A list of the inline policies embedded in the user.
 


groupList
SdkInternalList<T> groupList

 A list of IAM groups that the user is in.
 


attachedManagedPolicies
SdkInternalList<T> attachedManagedPolicies

 A list of the managed policies attached to the user.
 


permissionsBoundary
AttachedPermissionsBoundary permissionsBoundary

 The ARN of the policy used to set the permissions boundary for the user.
 
 
 For more information about permissions boundaries, see Permissions Boundaries
 for IAM Identities  in the IAM User Guide.
 


tags
SdkInternalList<T> tags

 A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM
 User Guide.
 








Class com.amazonaws.services.identitymanagement.model.VirtualMFADevice extends Object implements Serializable


Serialized Fields


serialNumber
String serialNumber

 The serial number associated with VirtualMFADevice.
 


base32StringSeed
ByteBuffer base32StringSeed

 The base32 seed defined as specified in RFC3548. The
 Base32StringSeed is base64-encoded.
 


qRCodePNG
ByteBuffer qRCodePNG

 A QR code PNG image that encodes
 otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where
 $virtualMFADeviceName is one of the create call arguments. AccountName is the user name
 if set (otherwise, the account ID otherwise), and Base32String is the seed in base32 format. The
 Base32String value is base64-encoded.
 


user
User user

 The IAM user associated with this virtual MFA device.
 


enableDate
Date enableDate

 The date and time on which the virtual MFA device was enabled.
 








Package com.amazonaws.services.imagebuilder.model




Class com.amazonaws.services.imagebuilder.model.Ami extends Object implements Serializable


Serialized Fields


region
String region

 The region of the EC2 AMI.
 


image
String image

 The AMI ID of the EC2 AMI.
 


name
String name

 The name of the EC2 AMI.
 


description
String description

 The description of the EC2 AMI.
 


state
ImageState state








Class com.amazonaws.services.imagebuilder.model.AmiDistributionConfiguration extends Object implements Serializable


Serialized Fields


name
String name

 The name of the distribution configuration.
 


description
String description

 The description of the distribution configuration.
 


amiTags
Map<K,V> amiTags

 The tags to apply to AMIs distributed to this region.
 


launchPermission
LaunchPermissionConfiguration launchPermission

 Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.
 








Class com.amazonaws.services.imagebuilder.model.AWSimagebuilderException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.CallRateLimitExceededException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.CancelImageCreationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageBuildVersionArn
String imageBuildVersionArn

 The Amazon Resource Name (ARN) of the image whose creation you wish to cancel.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 








Class com.amazonaws.services.imagebuilder.model.CancelImageCreationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 


imageBuildVersionArn
String imageBuildVersionArn

 The Amazon Resource Name (ARN) of the image whose creation has been cancelled.
 








Class com.amazonaws.services.imagebuilder.model.ClientException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.Component extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the component.
 


name
String name

 The name of the component.
 


version
String version

 The version of the component.
 


description
String description

 The description of the component.
 


changeDescription
String changeDescription

 The change description of the component.
 


type
String type

 The type of the component denotes whether the component is used to build the image or only to test it.
 


platform
String platform

 The platform of the component.
 


owner
String owner

 The owner of the component.
 


data
String data

 The data of the component.
 


kmsKeyId
String kmsKeyId

 The KMS key identifier used to encrypt the component.
 


encrypted
Boolean encrypted

 The encryption status of the component.
 


dateCreated
String dateCreated

 The date that the component was created.
 


tags
Map<K,V> tags

 The tags associated with the component.
 








Class com.amazonaws.services.imagebuilder.model.ComponentConfiguration extends Object implements Serializable


Serialized Fields


componentArn
String componentArn

 The Amazon Resource Name (ARN) of the component.
 








Class com.amazonaws.services.imagebuilder.model.ComponentSummary extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the component.
 


name
String name

 The name of the component.
 


version
String version

 The version of the component.
 


platform
String platform

 The platform of the component.
 


type
String type

 The type of the component denotes whether the component is used to build the image or only to test it.
 


owner
String owner

 The owner of the component.
 


description
String description

 The description of the component.
 


changeDescription
String changeDescription

 The change description of the component.
 


dateCreated
String dateCreated

 The date that the component was created.
 


tags
Map<K,V> tags

 The tags associated with the component.
 








Class com.amazonaws.services.imagebuilder.model.ComponentVersion extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the component.
 


name
String name

 The name of the component.
 


version
String version

 The semantic version of the component.
 


description
String description

 The description of the component.
 


platform
String platform

 The platform of the component.
 


type
String type

 The type of the component denotes whether the component is used to build the image or only to test it.
 


owner
String owner

 The owner of the component.
 


dateCreated
String dateCreated

 The date that the component was created.
 








Class com.amazonaws.services.imagebuilder.model.CreateComponentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the component.
 


semanticVersion
String semanticVersion

 The semantic version of the component. This version to follow the semantic version syntax. i.e.
 major.minor.patch. This could be versioned like software 2.0.1 or date like 2019.12.01.
 


description
String description

 CThe description of the component. Describes the contents of the component.
 


changeDescription
String changeDescription

 CThe change description of the component. Describes what change has been made in this version. In other words
 what makes this version different from other versions of this component.
 


platform
String platform

 CThe platform of the component.
 


data
String data

 CThe data of the component.
 


uri
String uri

 CThe uri of the component.
 


kmsKeyId
String kmsKeyId

 The ID of the KMS key that should be used to encrypt this component.
 


tags
Map<K,V> tags

 CThe tags of the component.
 


clientToken
String clientToken

 CThe idempotency token of the component.
 








Class com.amazonaws.services.imagebuilder.model.CreateComponentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 CThe request ID that uniquely identifies this request.
 


clientToken
String clientToken

 CThe idempotency token used to make this request idempotent.
 


componentBuildVersionArn
String componentBuildVersionArn

 CThe Amazon Resource Name (ARN) of the component that was created by this request.
 








Class com.amazonaws.services.imagebuilder.model.CreateDistributionConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the distribution configuration.
 


description
String description

 The description of the distribution configuration.
 


distributions
List<E> distributions

 The distributions of the distribution configuration.
 


tags
Map<K,V> tags

 The tags of the distribution configuration.
 


clientToken
String clientToken

 The idempotency token of the distribution configuration.
 








Class com.amazonaws.services.imagebuilder.model.CreateDistributionConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 


distributionConfigurationArn
String distributionConfigurationArn

 The Amazon Resource Name (ARN) of the distribution configuration that was created by this request.
 








Class com.amazonaws.services.imagebuilder.model.CreateImagePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the image pipeline.
 


description
String description

 The description of the image pipeline.
 


imageRecipeArn
String imageRecipeArn

 The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image
 pipeline.
 


infrastructureConfigurationArn
String infrastructureConfigurationArn

 The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by
 this image pipeline.
 


distributionConfigurationArn
String distributionConfigurationArn

 The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute
 images created by this image pipeline.
 


imageTestsConfiguration
ImageTestsConfiguration imageTestsConfiguration

 The image test configuration of the image pipeline.
 


schedule
Schedule schedule

 The schedule of the image pipeline.
 


status
String status

 The status of the image pipeline.
 


tags
Map<K,V> tags

 The tags of the image pipeline.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 








Class com.amazonaws.services.imagebuilder.model.CreateImagePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 


imagePipelineArn
String imagePipelineArn

 The Amazon Resource Name (ARN) of the image pipeline that was created by this request.
 








Class com.amazonaws.services.imagebuilder.model.CreateImageRecipeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the image recipe.
 


description
String description

 The description of the image recipe.
 


semanticVersion
String semanticVersion

 The semantic version of the image recipe.
 


components
List<E> components

 The components of the image recipe.
 


parentImage
String parentImage

 The parent image of the image recipe.
 


blockDeviceMappings
List<E> blockDeviceMappings

 The block device mappings of the image recipe.
 


tags
Map<K,V> tags

 The tags of the image recipe.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 








Class com.amazonaws.services.imagebuilder.model.CreateImageRecipeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 


imageRecipeArn
String imageRecipeArn

 The Amazon Resource Name (ARN) of the image recipe that was created by this request.
 








Class com.amazonaws.services.imagebuilder.model.CreateImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageRecipeArn
String imageRecipeArn

 The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested and assessed.
 


distributionConfigurationArn
String distributionConfigurationArn

 The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your
 pipeline.
 


infrastructureConfigurationArn
String infrastructureConfigurationArn

 The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your
 image will be built and tested.
 


imageTestsConfiguration
ImageTestsConfiguration imageTestsConfiguration

 The image tests configuration of the image.
 


tags
Map<K,V> tags

 The tags of the image.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 








Class com.amazonaws.services.imagebuilder.model.CreateImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 


imageBuildVersionArn
String imageBuildVersionArn

 The Amazon Resource Name (ARN) of the image that was created by this request.
 








Class com.amazonaws.services.imagebuilder.model.CreateInfrastructureConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the infrastructure configuration.
 


description
String description

 The description of the infrastructure configuration.
 


instanceTypes
List<E> instanceTypes

 The instance types of the infrastructure configuration. You may specify one or more instance types to use for
 this build, the service will pick one of these instance types based on availability.
 


instanceProfileName
String instanceProfileName

 The instance profile to associate with the instance used to customize your EC2 AMI.
 


securityGroupIds
List<E> securityGroupIds

 The security group IDs to associate with the instance used to customize your EC2 AMI.
 


subnetId
String subnetId

 The subnet ID to place the instance used to customize your EC2 AMI in.
 


logging
Logging logging

 The logging configuration of the infrastructure configuration.
 


keyPair
String keyPair

 The key pair of the infrastructure configuration. This can be used to log onto and debug the instance used to
 create your image.
 


terminateInstanceOnFailure
Boolean terminateInstanceOnFailure

 The terminate instance on failure setting of the infrastructure configuration. Set to false if you wish for Image
 Builder to retain the instance used to configure your AMI in the event that the build or test phase of your
 workflow failed.
 


snsTopicArn
String snsTopicArn

 The SNS topic on which to send image build events.
 


tags
Map<K,V> tags

 The tags of the infrastructure configuration.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 








Class com.amazonaws.services.imagebuilder.model.CreateInfrastructureConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 


infrastructureConfigurationArn
String infrastructureConfigurationArn

 The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.
 








Class com.amazonaws.services.imagebuilder.model.DeleteComponentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


componentBuildVersionArn
String componentBuildVersionArn

 The Amazon Resource Name (ARN) of the component build version to delete.
 








Class com.amazonaws.services.imagebuilder.model.DeleteComponentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


componentBuildVersionArn
String componentBuildVersionArn

 The Amazon Resource Name (ARN) of the component build version that was deleted.
 








Class com.amazonaws.services.imagebuilder.model.DeleteDistributionConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


distributionConfigurationArn
String distributionConfigurationArn

 The Amazon Resource Name (ARN) of the distribution configuration to delete.
 








Class com.amazonaws.services.imagebuilder.model.DeleteDistributionConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


distributionConfigurationArn
String distributionConfigurationArn

 The Amazon Resource Name (ARN) of the distribution configuration that was deleted.
 








Class com.amazonaws.services.imagebuilder.model.DeleteImagePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imagePipelineArn
String imagePipelineArn

 The Amazon Resource Name (ARN) of the image pipeline to delete.
 








Class com.amazonaws.services.imagebuilder.model.DeleteImagePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


imagePipelineArn
String imagePipelineArn

 The Amazon Resource Name (ARN) of the image pipeline that was deleted.
 








Class com.amazonaws.services.imagebuilder.model.DeleteImageRecipeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageRecipeArn
String imageRecipeArn

 The Amazon Resource Name (ARN) of the image recipe to delete.
 








Class com.amazonaws.services.imagebuilder.model.DeleteImageRecipeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


imageRecipeArn
String imageRecipeArn

 The Amazon Resource Name (ARN) of the image recipe that was deleted.
 








Class com.amazonaws.services.imagebuilder.model.DeleteImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageBuildVersionArn
String imageBuildVersionArn

 The Amazon Resource Name (ARN) of the image to delete.
 








Class com.amazonaws.services.imagebuilder.model.DeleteImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


imageBuildVersionArn
String imageBuildVersionArn

 The Amazon Resource Name (ARN) of the image that was deleted.
 








Class com.amazonaws.services.imagebuilder.model.DeleteInfrastructureConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


infrastructureConfigurationArn
String infrastructureConfigurationArn

 The Amazon Resource Name (ARN) of the infrastructure configuration to delete.
 








Class com.amazonaws.services.imagebuilder.model.DeleteInfrastructureConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


infrastructureConfigurationArn
String infrastructureConfigurationArn

 The Amazon Resource Name (ARN) of the infrastructure configuration that was deleted.
 








Class com.amazonaws.services.imagebuilder.model.Distribution extends Object implements Serializable


Serialized Fields


region
String region

 


amiDistributionConfiguration
AmiDistributionConfiguration amiDistributionConfiguration

 


licenseConfigurationArns
List<E> licenseConfigurationArns

 








Class com.amazonaws.services.imagebuilder.model.DistributionConfiguration extends Object implements Serializable


Serialized Fields


arn
String arn

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


name
String name

 The name of the distribution configuration.
 


description
String description

 The description of the distribution configuration.
 


distributions
List<E> distributions

 The distributions of the distribution configuration.
 


timeoutMinutes
Integer timeoutMinutes

 The maximum duration in minutes for this distribution configuration.
 


dateCreated
String dateCreated

 The date on which this distribution configuration was created.
 


dateUpdated
String dateUpdated

 The date on which this distribution configuration was last updated.
 


tags
Map<K,V> tags

 The tags of the distribution configuration.
 








Class com.amazonaws.services.imagebuilder.model.DistributionConfigurationSummary extends Object implements Serializable


Serialized Fields


arn
String arn

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


name
String name

 The name of the distribution configuration.
 


description
String description

 The description of the distribution configuration.
 


dateCreated
String dateCreated

 The date on which the distribution configuration was created.
 


dateUpdated
String dateUpdated

 The date on which the distribution configuration was updated.
 


tags
Map<K,V> tags

 The tags associated with the distribution configuration.
 








Class com.amazonaws.services.imagebuilder.model.EbsInstanceBlockDeviceSpecification extends Object implements Serializable


Serialized Fields


encrypted
Boolean encrypted

 Use to configure device encryption.
 


deleteOnTermination
Boolean deleteOnTermination

 Use to configure delete on termination of the associated device.
 


iops
Integer iops

 Use to configure device IOPS.
 


kmsKeyId
String kmsKeyId

 Use to configure the KMS key to use when encrypting the device.
 


snapshotId
String snapshotId

 The snapshot that defines the device contents.
 


volumeSize
Integer volumeSize

 Use to override the device's volume size.
 


volumeType
String volumeType

 Use to override the device's volume type.
 








Class com.amazonaws.services.imagebuilder.model.Filter extends Object implements Serializable


Serialized Fields


name
String name

 


values
List<E> values

 








Class com.amazonaws.services.imagebuilder.model.ForbiddenException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.GetComponentPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


componentArn
String componentArn

 The Amazon Resource Name (ARN) of the component whose policy you wish to retrieve.
 








Class com.amazonaws.services.imagebuilder.model.GetComponentPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


policy
String policy

 The component policy.
 








Class com.amazonaws.services.imagebuilder.model.GetComponentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


componentBuildVersionArn
String componentBuildVersionArn

 The Amazon Resource Name (ARN) of the component that you wish to retrieve.
 








Class com.amazonaws.services.imagebuilder.model.GetComponentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


component
Component component

 The component object associated with the specified ARN.
 








Class com.amazonaws.services.imagebuilder.model.GetDistributionConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


distributionConfigurationArn
String distributionConfigurationArn

 The Amazon Resource Name (ARN) of the distribution configuration that you wish to retrieve.
 








Class com.amazonaws.services.imagebuilder.model.GetDistributionConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


distributionConfiguration
DistributionConfiguration distributionConfiguration

 The distribution configuration object.
 








Class com.amazonaws.services.imagebuilder.model.GetImagePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imagePipelineArn
String imagePipelineArn

 The Amazon Resource Name (ARN) of the image pipeline that you wish to retrieve.
 








Class com.amazonaws.services.imagebuilder.model.GetImagePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


imagePipeline
ImagePipeline imagePipeline

 The image pipeline object.
 








Class com.amazonaws.services.imagebuilder.model.GetImagePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageArn
String imageArn

 The Amazon Resource Name (ARN) of the image whose policy you wish to retrieve.
 








Class com.amazonaws.services.imagebuilder.model.GetImagePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


policy
String policy

 The image policy object.
 








Class com.amazonaws.services.imagebuilder.model.GetImageRecipePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageRecipeArn
String imageRecipeArn

 The Amazon Resource Name (ARN) of the image recipe whose policy you wish to retrieve.
 








Class com.amazonaws.services.imagebuilder.model.GetImageRecipePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


policy
String policy

 The image recipe policy object.
 








Class com.amazonaws.services.imagebuilder.model.GetImageRecipeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageRecipeArn
String imageRecipeArn

 The Amazon Resource Name (ARN) of the image recipe that you wish to retrieve.
 








Class com.amazonaws.services.imagebuilder.model.GetImageRecipeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


imageRecipe
ImageRecipe imageRecipe

 The image recipe object.
 








Class com.amazonaws.services.imagebuilder.model.GetImageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageBuildVersionArn
String imageBuildVersionArn

 The Amazon Resource Name (ARN) of the image that you wish to retrieve.
 








Class com.amazonaws.services.imagebuilder.model.GetImageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


image
Image image

 The image object.
 








Class com.amazonaws.services.imagebuilder.model.GetInfrastructureConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


infrastructureConfigurationArn
String infrastructureConfigurationArn

 The Amazon Resource Name (ARN) of the infrastructure configuration that you wish to retrieve.
 








Class com.amazonaws.services.imagebuilder.model.GetInfrastructureConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


infrastructureConfiguration
InfrastructureConfiguration infrastructureConfiguration

 The infrastructure configuration object.
 








Class com.amazonaws.services.imagebuilder.model.IdempotentParameterMismatchException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the image.
 


name
String name

 The name of the image.
 


version
String version

 The semantic version of the image.
 


platform
String platform

 The platform of the image.
 


state
ImageState state

 The state of the image.
 


imageRecipe
ImageRecipe imageRecipe

 The image recipe used when creating the image.
 


sourcePipelineName
String sourcePipelineName

 The name of the image pipeline that created this image.
 


sourcePipelineArn
String sourcePipelineArn

 The Amazon Resource Name (ARN) of the image pipeline that created this image.
 


infrastructureConfiguration
InfrastructureConfiguration infrastructureConfiguration

 The infrastructure used when creating this image.
 


distributionConfiguration
DistributionConfiguration distributionConfiguration

 The distribution configuration used when creating this image.
 


imageTestsConfiguration
ImageTestsConfiguration imageTestsConfiguration

 The image tests configuration used when creating this image.
 


dateCreated
String dateCreated

 The date on which this image was created.
 


outputResources
OutputResources outputResources

 The output resources produced when creating this image.
 


tags
Map<K,V> tags

 The tags of the image.
 








Class com.amazonaws.services.imagebuilder.model.ImagePipeline extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the image pipeline.
 


name
String name

 The name of the image pipeline.
 


description
String description

 The description of the image pipeline.
 


platform
String platform

 The platform of the image pipeline.
 


imageRecipeArn
String imageRecipeArn

 The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
 


infrastructureConfigurationArn
String infrastructureConfigurationArn

 The Amazon Resource Name (ARN) of the infrastruction configuration associated with this image pipeline.
 


distributionConfigurationArn
String distributionConfigurationArn

 The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
 


imageTestsConfiguration
ImageTestsConfiguration imageTestsConfiguration

 The image tests configuration of the image pipeline.
 


schedule
Schedule schedule

 The schedule of the image pipeline.
 


status
String status

 The status of the image pipeline.
 


dateCreated
String dateCreated

 The date on which this image pipeline was created.
 


dateUpdated
String dateUpdated

 The date on which this image pipeline was last updated.
 


dateLastRun
String dateLastRun

 The date on which this image pipeline was last run.
 


dateNextRun
String dateNextRun

 The date on which this image pipeline will next be run.
 


tags
Map<K,V> tags

 The tags of this image pipeline.
 








Class com.amazonaws.services.imagebuilder.model.ImageRecipe extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the image recipe.
 


name
String name

 The name of the image recipe.
 


description
String description

 The description of the image recipe.
 


platform
String platform

 The platform of the image recipe.
 


owner
String owner

 The owner of the image recipe.
 


version
String version

 The version of the image recipe.
 


components
List<E> components

 The components of the image recipe.
 


parentImage
String parentImage

 The parent image of the image recipe.
 


blockDeviceMappings
List<E> blockDeviceMappings

 The block device mappings to apply when creating images from this recipe.
 


dateCreated
String dateCreated

 The date on which this image recipe was created.
 


tags
Map<K,V> tags

 The tags of the image recipe.
 








Class com.amazonaws.services.imagebuilder.model.ImageRecipeSummary extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the image recipe.
 


name
String name

 The name of the image recipe.
 


platform
String platform

 The platform of the image recipe.
 


owner
String owner

 The owner of the image recipe.
 


parentImage
String parentImage

 The parent image of the image recipe.
 


dateCreated
String dateCreated

 The date on which this image recipe was created.
 


tags
Map<K,V> tags

 The tags of the image recipe.
 








Class com.amazonaws.services.imagebuilder.model.ImageState extends Object implements Serializable


Serialized Fields


status
String status

 The status of the image.
 


reason
String reason

 The reason for the image's status.
 








Class com.amazonaws.services.imagebuilder.model.ImageSummary extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the image.
 


name
String name

 The name of the image.
 


version
String version

 The version of the image.
 


platform
String platform

 The platform of the image.
 


state
ImageState state

 The state of the image.
 


owner
String owner

 The owner of the image.
 


dateCreated
String dateCreated

 The date on which this image was created.
 


outputResources
OutputResources outputResources

 The output resources produced when creating this image.
 


tags
Map<K,V> tags

 The tags of the image.
 








Class com.amazonaws.services.imagebuilder.model.ImageTestsConfiguration extends Object implements Serializable


Serialized Fields


imageTestsEnabled
Boolean imageTestsEnabled

 Defines if tests should be executed when building this image.
 


timeoutMinutes
Integer timeoutMinutes

 The maximum time in minutes that tests are permitted to run for.
 








Class com.amazonaws.services.imagebuilder.model.ImageVersion extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the image semantic verion.
 


name
String name

 The name of the image semantic version.
 


version
String version

 The semantic version of the image semantic version.
 


platform
String platform

 The platform of the image semantic version.
 


owner
String owner

 The owner of the image semantic version.
 


dateCreated
String dateCreated

 The date at which this image semantic version was created.
 








Class com.amazonaws.services.imagebuilder.model.ImportComponentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the component.
 


semanticVersion
String semanticVersion

 The semantic version of the component. This version to follow the semantic version syntax. i.e.
 major.minor.patch. This could be versioned like software 2.0.1 or date like 2019.12.01.
 


description
String description

 The description of the component. Describes the contents of the component.
 


changeDescription
String changeDescription

 The change description of the component. Describes what change has been made in this version. In other words what
 makes this version different from other versions of this component.
 


type
String type

 The type of the component denotes whether the component is used to build the image or only to test it.
 


format
String format

 The format of the resource that you wish to import as a component.
 


platform
String platform

 The platform of the component.
 


data
String data

 The data of the component.
 


uri
String uri

 The uri of the component.
 


kmsKeyId
String kmsKeyId

 The ID of the KMS key that should be used to encrypt this component.
 


tags
Map<K,V> tags

 The tags of the component.
 


clientToken
String clientToken

 The idempotency token of the component.
 








Class com.amazonaws.services.imagebuilder.model.ImportComponentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 


componentBuildVersionArn
String componentBuildVersionArn

 The Amazon Resource Name (ARN) of the imported component.
 








Class com.amazonaws.services.imagebuilder.model.InfrastructureConfiguration extends Object implements Serializable


Serialized Fields


arn
String arn

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


name
String name

 The name of the infrastruction configuration.
 


description
String description

 The description of the infrastruction configuration.
 


instanceTypes
List<E> instanceTypes

 The instance types of the infrastruction configuration.
 


instanceProfileName
String instanceProfileName

 The instance profile of the infrastruction configuration.
 


securityGroupIds
List<E> securityGroupIds

 The security group IDs of the infrastruction configuration.
 


subnetId
String subnetId

 The subnet ID of the infrastruction configuration.
 


logging
Logging logging

 The logging configuration of the infrastruction configuration.
 


keyPair
String keyPair

 The EC2 key pair of the infrastruction configuration.
 


terminateInstanceOnFailure
Boolean terminateInstanceOnFailure

 The terminate instance on failure configuration of the infrastruction configuration.
 


snsTopicArn
String snsTopicArn

 The SNS Topic Amazon Resource Name (ARN) of the infrastruction configuration.
 


dateCreated
String dateCreated

 The date on which the infrastructure configuration was created.
 


dateUpdated
String dateUpdated

 The date on which the infrastructure configuration was last updated.
 


tags
Map<K,V> tags

 The tags of the infrastruction configuration.
 








Class com.amazonaws.services.imagebuilder.model.InfrastructureConfigurationSummary extends Object implements Serializable


Serialized Fields


arn
String arn

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


name
String name

 The name of the infrastructure configuration.
 


description
String description

 The description of the infrastructure configuration.
 


dateCreated
String dateCreated

 The date on which the infrastructure configuration was created.
 


dateUpdated
String dateUpdated

 The date on which the infrastructure configuration was last updated.
 


tags
Map<K,V> tags

 The tags of the infrastructure configuration.
 








Class com.amazonaws.services.imagebuilder.model.InstanceBlockDeviceMapping extends Object implements Serializable


Serialized Fields


deviceName
String deviceName

 The device to which these mappings apply.
 


ebs
EbsInstanceBlockDeviceSpecification ebs

 Use to manage EBS specific configuration for this mapping.
 


virtualName
String virtualName

 Use to manage instance ephemeral devices.
 


noDevice
String noDevice

 Use to remove a mapping from the parent image.
 








Class com.amazonaws.services.imagebuilder.model.InvalidPaginationTokenException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.InvalidParameterCombinationException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.InvalidParameterException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.InvalidParameterValueException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.InvalidRequestException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.InvalidVersionNumberException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.LaunchPermissionConfiguration extends Object implements Serializable


Serialized Fields


userIds
List<E> userIds

 


userGroups
List<E> userGroups

 








Class com.amazonaws.services.imagebuilder.model.ListComponentBuildVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


componentVersionArn
String componentVersionArn

 The component version arn whose versions you wish to list.
 


maxResults
Integer maxResults

 The maximum items to return in a request.
 


nextToken
String nextToken

 A token to specify where to start paginating. This is the NextToken from a previously truncated response.
 








Class com.amazonaws.services.imagebuilder.model.ListComponentBuildVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


componentSummaryList
List<E> componentSummaryList

 The list of component summaries for the specified semantic version.
 


nextToken
String nextToken

 The next token used for paginated responses. When this is not empty then there are additional elements that the
 service that not include in this request. Use this token with the next request to retrieve additional object.
 








Class com.amazonaws.services.imagebuilder.model.ListComponentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


owner
String owner

 The owner defines whose components you wish to list. By default this request will only show components owned by
 your account. You may use this field to specify if you wish to view components owned by yourself, Amazon, or
 those components that have been shared with you by other customers.
 


filters
List<E> filters

 


maxResults
Integer maxResults

 The maximum items to return in a request.
 


nextToken
String nextToken

 A token to specify where to start paginating. This is the NextToken from a previously truncated response.
 








Class com.amazonaws.services.imagebuilder.model.ListComponentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


componentVersionList
List<E> componentVersionList

 The list of component semantic versions.
 


nextToken
String nextToken

 The next token used for paginated responses. When this is not empty then there are additional elements that the
 service that not include in this request. Use this token with the next request to retrieve additional object.
 








Class com.amazonaws.services.imagebuilder.model.ListDistributionConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 


maxResults
Integer maxResults

 The maximum items to return in a request.
 


nextToken
String nextToken

 A token to specify where to start paginating. This is the NextToken from a previously truncated response.
 








Class com.amazonaws.services.imagebuilder.model.ListDistributionConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


distributionConfigurationSummaryList
List<E> distributionConfigurationSummaryList

 The list of distributions.
 


nextToken
String nextToken

 The next token used for paginated responses. When this is not empty then there are additional elements that the
 service that not include in this request. Use this token with the next request to retrieve additional object.
 








Class com.amazonaws.services.imagebuilder.model.ListImageBuildVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageVersionArn
String imageVersionArn

 The Amazon Resource Name (ARN) of the image whose build versions you wish to retrieve.
 


filters
List<E> filters

 


maxResults
Integer maxResults

 The maximum items to return in a request.
 


nextToken
String nextToken

 A token to specify where to start paginating. This is the NextToken from a previously truncated response.
 








Class com.amazonaws.services.imagebuilder.model.ListImageBuildVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


imageSummaryList
List<E> imageSummaryList

 The list of image build versions.
 


nextToken
String nextToken

 The next token used for paginated responses. When this is not empty then there are additional elements that the
 service that not include in this request. Use this token with the next request to retrieve additional object.
 








Class com.amazonaws.services.imagebuilder.model.ListImagePipelineImagesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imagePipelineArn
String imagePipelineArn

 The Amazon Resource Name (ARN) of the image pipeline whose images you wish to view.
 


filters
List<E> filters

 


maxResults
Integer maxResults

 The maximum items to return in a request.
 


nextToken
String nextToken

 A token to specify where to start paginating. This is the NextToken from a previously truncated response.
 








Class com.amazonaws.services.imagebuilder.model.ListImagePipelineImagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


imageSummaryList
List<E> imageSummaryList

 The list of images built by this pipeline.
 


nextToken
String nextToken

 The next token used for paginated responses. When this is not empty then there are additional elements that the
 service that not include in this request. Use this token with the next request to retrieve additional object.
 








Class com.amazonaws.services.imagebuilder.model.ListImagePipelinesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 


maxResults
Integer maxResults

 The maximum items to return in a request.
 


nextToken
String nextToken

 A token to specify where to start paginating. This is the NextToken from a previously truncated response.
 








Class com.amazonaws.services.imagebuilder.model.ListImagePipelinesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


imagePipelineList
List<E> imagePipelineList

 The list of image pipelines.
 


nextToken
String nextToken

 The next token used for paginated responses. When this is not empty then there are additional elements that the
 service that not include in this request. Use this token with the next request to retrieve additional object.
 








Class com.amazonaws.services.imagebuilder.model.ListImageRecipesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


owner
String owner

 The owner defines whose image recipes you wish to list. By default this request will only show image recipes
 owned by your account. You may use this field to specify if you wish to view image recipes owned by yourself,
 Amazon, or those image recipes that have been shared with you by other customers.
 


filters
List<E> filters

 


maxResults
Integer maxResults

 The maximum items to return in a request.
 


nextToken
String nextToken

 A token to specify where to start paginating. This is the NextToken from a previously truncated response.
 








Class com.amazonaws.services.imagebuilder.model.ListImageRecipesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


imageRecipeSummaryList
List<E> imageRecipeSummaryList

 The list of image pipelines.
 


nextToken
String nextToken

 The next token used for paginated responses. When this is not empty then there are additional elements that the
 service that not include in this request. Use this token with the next request to retrieve additional object.
 








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


Serialized Fields


owner
String owner

 The owner defines whose images you wish to list. By default this request will only show images owned by your
 account. You may use this field to specify if you wish to view images owned by yourself, Amazon, or those images
 that have been shared with you by other customers.
 


filters
List<E> filters

 


maxResults
Integer maxResults

 The maximum items to return in a request.
 


nextToken
String nextToken

 A token to specify where to start paginating. This is the NextToken from a previously truncated response.
 








Class com.amazonaws.services.imagebuilder.model.ListImagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


imageVersionList
List<E> imageVersionList

 The list of image semantic versions.
 


nextToken
String nextToken

 The next token used for paginated responses. When this is not empty then there are additional elements that the
 service that not include in this request. Use this token with the next request to retrieve additional object.
 








Class com.amazonaws.services.imagebuilder.model.ListInfrastructureConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 


maxResults
Integer maxResults

 The maximum items to return in a request.
 


nextToken
String nextToken

 A token to specify where to start paginating. This is the NextToken from a previously truncated response.
 








Class com.amazonaws.services.imagebuilder.model.ListInfrastructureConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


infrastructureConfigurationSummaryList
List<E> infrastructureConfigurationSummaryList

 The list of infrastructure configurations.
 


nextToken
String nextToken

 The next token used for paginated responses. When this is not empty then there are additional elements that the
 service that not include in this request. Use this token with the next request to retrieve additional object.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource whose tags you wish to retrieve.
 








Class com.amazonaws.services.imagebuilder.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The tags for the specified resource.
 








Class com.amazonaws.services.imagebuilder.model.Logging extends Object implements Serializable


Serialized Fields


s3Logs
S3Logs s3Logs

 The S3 logging configuration.
 








Class com.amazonaws.services.imagebuilder.model.OutputResources extends Object implements Serializable


Serialized Fields


amis
List<E> amis

 The EC2 AMIs created by this image.
 








Class com.amazonaws.services.imagebuilder.model.PutComponentPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


componentArn
String componentArn

 The Amazon Resource Name (ARN) of the component that this policy should be applied to.
 


policy
String policy

 The policy to apply.
 








Class com.amazonaws.services.imagebuilder.model.PutComponentPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


componentArn
String componentArn

 The Amazon Resource Name (ARN) of the component that this policy was applied to.
 








Class com.amazonaws.services.imagebuilder.model.PutImagePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageArn
String imageArn

 The Amazon Resource Name (ARN) of the image that this policy should be applied to.
 


policy
String policy

 The policy to apply.
 








Class com.amazonaws.services.imagebuilder.model.PutImagePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


imageArn
String imageArn

 The Amazon Resource Name (ARN) of the image that this policy was applied to.
 








Class com.amazonaws.services.imagebuilder.model.PutImageRecipePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imageRecipeArn
String imageRecipeArn

 The Amazon Resource Name (ARN) of the image recipe that this policy should be applied to.
 


policy
String policy

 The policy to apply.
 








Class com.amazonaws.services.imagebuilder.model.PutImageRecipePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


imageRecipeArn
String imageRecipeArn

 The Amazon Resource Name (ARN) of the image recipe that this policy was applied to.
 








Class com.amazonaws.services.imagebuilder.model.ResourceAlreadyExistsException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.ResourceDependencyException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.ResourceInUseException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.ResourceNotFoundException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.S3Logs extends Object implements Serializable


Serialized Fields


s3BucketName
String s3BucketName

 The S3 bucket in which to store the logs.
 


s3KeyPrefix
String s3KeyPrefix

 The S3 path in which to store the logs.
 








Class com.amazonaws.services.imagebuilder.model.Schedule extends Object implements Serializable


Serialized Fields


scheduleExpression
String scheduleExpression

 The expression determines how often a pipeline starts the creation of new images.
 


pipelineExecutionStartCondition
String pipelineExecutionStartCondition

 The condition configures when the pipeline should trigger a new image build.
 








Class com.amazonaws.services.imagebuilder.model.ServiceException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.ServiceUnavailableException extends AWSimagebuilderException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.imagebuilder.model.StartImagePipelineExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imagePipelineArn
String imagePipelineArn

 The Amazon Resource Name (ARN) of the image pipeline that you wish to manually invoke.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 








Class com.amazonaws.services.imagebuilder.model.StartImagePipelineExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 


imageBuildVersionArn
String imageBuildVersionArn

 The Amazon Resource Name (ARN) of the image that was created by this request.
 








Class com.amazonaws.services.imagebuilder.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource that you wish to tag.
 


tags
Map<K,V> tags

 The tags to apply to the resource.
 








Class com.amazonaws.services.imagebuilder.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.imagebuilder.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource that you wish to untag.
 


tagKeys
List<E> tagKeys

 The tag keys to remove from the resource.
 








Class com.amazonaws.services.imagebuilder.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.imagebuilder.model.UpdateDistributionConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


distributionConfigurationArn
String distributionConfigurationArn

 The Amazon Resource Name (ARN) of the distribution configuration that you wish to update.
 


description
String description

 The description of the distribution configuration.
 


distributions
List<E> distributions

 The distributions of the distribution configuration.
 


clientToken
String clientToken

 The idempotency token of the distribution configuration.
 








Class com.amazonaws.services.imagebuilder.model.UpdateDistributionConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 


distributionConfigurationArn
String distributionConfigurationArn

 The Amazon Resource Name (ARN) of the distribution configuration that was updated by this request.
 








Class com.amazonaws.services.imagebuilder.model.UpdateImagePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


imagePipelineArn
String imagePipelineArn

 The Amazon Resource Name (ARN) of the image pipeline that you wish to update.
 


description
String description

 The description of the image pipeline.
 


imageRecipeArn
String imageRecipeArn

 The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image
 pipeline.
 


infrastructureConfigurationArn
String infrastructureConfigurationArn

 The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by
 this image pipeline.
 


distributionConfigurationArn
String distributionConfigurationArn

 The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute
 images updated by this image pipeline.
 


imageTestsConfiguration
ImageTestsConfiguration imageTestsConfiguration

 The image test configuration of the image pipeline.
 


schedule
Schedule schedule

 The schedule of the image pipeline.
 


status
String status

 The status of the image pipeline.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 








Class com.amazonaws.services.imagebuilder.model.UpdateImagePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 


imagePipelineArn
String imagePipelineArn

 The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.
 








Class com.amazonaws.services.imagebuilder.model.UpdateInfrastructureConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


infrastructureConfigurationArn
String infrastructureConfigurationArn

 The Amazon Resource Name (ARN) of the infrastructure configuration that you wish to update.
 


description
String description

 The description of the infrastructure configuration.
 


instanceTypes
List<E> instanceTypes

 The instance types of the infrastructure configuration. You may specify one or more instance types to use for
 this build, the service will pick one of these instance types based on availability.
 


instanceProfileName
String instanceProfileName

 The instance profile to associate with the instance used to customize your EC2 AMI.
 


securityGroupIds
List<E> securityGroupIds

 The security group IDs to associate with the instance used to customize your EC2 AMI.
 


subnetId
String subnetId

 The subnet ID to place the instance used to customize your EC2 AMI in.
 


logging
Logging logging

 The logging configuration of the infrastructure configuration.
 


keyPair
String keyPair

 The key pair of the infrastructure configuration. This can be used to log onto and debug the instance used to
 create your image.
 


terminateInstanceOnFailure
Boolean terminateInstanceOnFailure

 The terminate instance on failure setting of the infrastructure configuration. Set to false if you wish for Image
 Builder to retain the instance used to configure your AMI in the event that the build or test phase of your
 workflow failed.
 


snsTopicArn
String snsTopicArn

 The SNS topic on which to send image build events.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 








Class com.amazonaws.services.imagebuilder.model.UpdateInfrastructureConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestId
String requestId

 The request ID that uniquely identifies this request.
 


clientToken
String clientToken

 The idempotency token used to make this request idempotent.
 


infrastructureConfigurationArn
String infrastructureConfigurationArn

 The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.
 








Package com.amazonaws.services.importexport.model




Class com.amazonaws.services.importexport.model.AmazonImportExportException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.Artifact extends Object implements Serializable


Serialized Fields


description
String description


uRL
String uRL








Class com.amazonaws.services.importexport.model.BucketPermissionException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.CanceledJobIdException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId


aPIVersion
String aPIVersion








Class com.amazonaws.services.importexport.model.CancelJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


success
Boolean success








Class com.amazonaws.services.importexport.model.CreateJobQuotaExceededException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobType
String jobType


manifest
String manifest


manifestAddendum
String manifestAddendum


validateOnly
Boolean validateOnly


aPIVersion
String aPIVersion








Class com.amazonaws.services.importexport.model.CreateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId


jobType
String jobType


signature
String signature


signatureFileContents
String signatureFileContents


warningMessage
String warningMessage


artifactList
SdkInternalList<T> artifactList








Class com.amazonaws.services.importexport.model.ExpiredJobIdException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.GetShippingLabelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobIds
SdkInternalList<T> jobIds


name
String name


company
String company


phoneNumber
String phoneNumber


country
String country


stateOrProvince
String stateOrProvince


city
String city


postalCode
String postalCode


street1
String street1


street2
String street2


street3
String street3


aPIVersion
String aPIVersion








Class com.amazonaws.services.importexport.model.GetShippingLabelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


shippingLabelURL
String shippingLabelURL


warning
String warning








Class com.amazonaws.services.importexport.model.GetStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId


aPIVersion
String aPIVersion








Class com.amazonaws.services.importexport.model.GetStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobId
String jobId


jobType
String jobType


locationCode
String locationCode


locationMessage
String locationMessage


progressCode
String progressCode


progressMessage
String progressMessage


carrier
String carrier


trackingNumber
String trackingNumber


logBucket
String logBucket


logKey
String logKey


errorCount
Integer errorCount


signature
String signature


signatureFileContents
String signatureFileContents


currentManifest
String currentManifest


creationDate
Date creationDate


artifactList
SdkInternalList<T> artifactList








Class com.amazonaws.services.importexport.model.InvalidAccessKeyIdException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidAddressException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidCustomsException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidFileSystemException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidJobIdException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidManifestFieldException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidParameterException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidVersionException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.Job extends Object implements Serializable


Serialized Fields


jobId
String jobId


creationDate
Date creationDate


isCanceled
Boolean isCanceled


jobType
String jobType








Class com.amazonaws.services.importexport.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxJobs
Integer maxJobs


marker
String marker


aPIVersion
String aPIVersion








Class com.amazonaws.services.importexport.model.ListJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobs
SdkInternalList<T> jobs


isTruncated
Boolean isTruncated








Class com.amazonaws.services.importexport.model.MalformedManifestException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.MissingCustomsException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.MissingManifestFieldException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.MissingParameterException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.MultipleRegionsException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.NoSuchBucketException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.UnableToCancelJobIdException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.UnableToUpdateJobIdException extends AmazonImportExportException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.UpdateJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId


manifest
String manifest


jobType
String jobType


validateOnly
Boolean validateOnly


aPIVersion
String aPIVersion








Class com.amazonaws.services.importexport.model.UpdateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


success
Boolean success


warningMessage
String warningMessage


artifactList
SdkInternalList<T> artifactList








Package com.amazonaws.services.inspector.model




Class com.amazonaws.services.inspector.model.AccessDeniedException extends AmazonInspectorException implements Serializable

serialVersionUID:
1L



Serialized Fields


canRetry
Boolean canRetry

 You can immediately retry your request.
 


inspectorErrorCode
String inspectorErrorCode

 Code that indicates the type of error that is generated.
 








Class com.amazonaws.services.inspector.model.AddAttributesToFindingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


findingArns
List<E> findingArns

 The ARNs that specify the findings that you want to assign attributes to.
 


attributes
List<E> attributes

 The array of attributes that you want to assign to specified findings.
 








Class com.amazonaws.services.inspector.model.AddAttributesToFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedItems
Map<K,V> failedItems

 Attribute details that cannot be described. An error code is provided for each failed item.
 








Class com.amazonaws.services.inspector.model.AgentAlreadyRunningAssessment extends Object implements Serializable


Serialized Fields


agentId
String agentId

 ID of the agent that is running on an EC2 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 extends Object implements Serializable


Serialized Fields


agentHealths
List<E> agentHealths

 The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.
 


agentHealthCodes
List<E> agentHealthCodes

 The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN,
 UNHEALTHY, THROTTLED, and UNKNOWN.
 








Class com.amazonaws.services.inspector.model.AgentPreview extends Object implements Serializable


Serialized Fields


hostname
String hostname

 The hostname of the EC2 instance on which the Amazon Inspector Agent is installed.
 


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.
 


agentHealth
String agentHealth

 The health status of the Amazon Inspector Agent.
 


agentVersion
String agentVersion

 The version of the Amazon Inspector Agent.
 


operatingSystem
String operatingSystem

 The operating system running on the EC2 instance on which the Amazon Inspector Agent is installed.
 


kernelVersion
String kernelVersion

 The kernel version of the operating system running on the EC2 instance on which the Amazon Inspector Agent is
 installed.
 


ipv4Address
String ipv4Address

 The IP address of the EC2 instance on which the Amazon Inspector Agent is installed.
 








Class com.amazonaws.services.inspector.model.AgentsAlreadyRunningAssessmentException extends AmazonInspectorException implements Serializable

serialVersionUID:
1L



Serialized Fields


agents
List<E> agents



agentsTruncated
Boolean agentsTruncated



canRetry
Boolean canRetry

 You can immediately retry your request.
 








Class com.amazonaws.services.inspector.model.AmazonInspectorException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.inspector.model.AssessmentRun extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the assessment run.
 


name
String name

 The auto-generated name for the assessment run.
 


assessmentTemplateArn
String assessmentTemplateArn

 The ARN of the assessment template that is associated with the assessment run.
 


state
String state

 The state of the assessment run.
 


durationInSeconds
Integer durationInSeconds

 The duration of the assessment run.
 


rulesPackageArns
List<E> rulesPackageArns

 The rules packages selected for the assessment run.
 


userAttributesForFindings
List<E> userAttributesForFindings

 The user-defined attributes that are assigned to every generated finding.
 


createdAt
Date createdAt

 The time when StartAssessmentRun was called.
 


startedAt
Date startedAt

 The time when StartAssessmentRun was called.
 


completedAt
Date completedAt

 The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
 


stateChangedAt
Date stateChangedAt

 The last time when the assessment run's state changed.
 


dataCollected
Boolean dataCollected

 A Boolean value (true or false) that specifies whether the process of collecting data from the agents is
 completed.
 


stateChanges
List<E> stateChanges

 A list of the assessment run state changes.
 


notifications
List<E> notifications

 A list of notifications for the event subscriptions. A notification about a particular generated finding is added
 to this list only once.
 


findingCounts
Map<K,V> findingCounts

 Provides a total count of generated findings per severity.
 








Class com.amazonaws.services.inspector.model.AssessmentRunAgent extends Object implements Serializable


Serialized Fields


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.
 


agentHealth
String agentHealth

 The current health state of the agent.
 


agentHealthCode
String agentHealthCode

 The detailed health state of the agent.
 


agentHealthDetails
String agentHealthDetails

 The description for the agent health code.
 


autoScalingGroup
String autoScalingGroup

 The Auto Scaling group of the EC2 instance that is specified by the agent ID.
 


telemetryMetadata
List<E> telemetryMetadata

 The Amazon Inspector application data metrics that are collected by the agent.
 








Class com.amazonaws.services.inspector.model.AssessmentRunFilter extends Object implements Serializable


Serialized Fields


namePattern
String namePattern

 For a record to match a filter, an explicit value or a string containing a wildcard that is specified for this
 data type property must match the value of the assessmentRunName property of the AssessmentRun data
 type.
 


states
List<E> states

 For a record to match a filter, one of the values specified for this data type property must be the exact match
 of the value of the assessmentRunState property of the AssessmentRun data type.
 


durationRange
DurationRange durationRange

 For a record to match a filter, the value 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.
 


rulesPackageArns
List<E> 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.
 


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.
 


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.
 








Class com.amazonaws.services.inspector.model.AssessmentRunInProgressException extends AmazonInspectorException implements Serializable

serialVersionUID:
1L



Serialized Fields


assessmentRunArns
List<E> 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 extends Object implements Serializable


Serialized Fields


date
Date date

 The date of the notification.
 


event
String event

 The event for which a notification is sent.
 


message
String message

 The message included in the notification.
 


error
Boolean error

 The Boolean value that specifies whether the notification represents an error.
 


snsTopicArn
String snsTopicArn

 The SNS topic to which the SNS notification is sent.
 


snsPublishStatusCode
String snsPublishStatusCode

 The status code of the SNS notification.
 








Class com.amazonaws.services.inspector.model.AssessmentRunStateChange extends Object implements Serializable


Serialized Fields


stateChangedAt
Date stateChangedAt

 The last time the assessment run state changed.
 


state
String state

 The assessment run state.
 








Class com.amazonaws.services.inspector.model.AssessmentTarget extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN that specifies the Amazon Inspector assessment target.
 


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.
 


createdAt
Date createdAt

 The time at which the assessment target is created.
 


updatedAt
Date updatedAt

 The time at which UpdateAssessmentTarget is called.
 








Class com.amazonaws.services.inspector.model.AssessmentTargetFilter extends Object implements Serializable


Serialized Fields


assessmentTargetNamePattern
String assessmentTargetNamePattern

 For a record to match a filter, an explicit value or a string 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 extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the assessment template.
 


name
String name

 The name of the assessment template.
 


assessmentTargetArn
String assessmentTargetArn

 The ARN of the assessment target that corresponds to this assessment template.
 


durationInSeconds
Integer durationInSeconds

 The duration in seconds specified for this assessment template. The default value is 3600 seconds (one hour). The
 maximum value is 86400 seconds (one day).
 


rulesPackageArns
List<E> rulesPackageArns

 The rules packages that are specified for this assessment template.
 


userAttributesForFindings
List<E> userAttributesForFindings

 The user-defined attributes that are assigned to every generated finding from the assessment run that uses this
 assessment template.
 


lastAssessmentRunArn
String lastAssessmentRunArn

 The Amazon Resource Name (ARN) of the most recent assessment run associated with this assessment template. This
 value exists only when the value of assessmentRunCount is greaterpa than zero.
 


assessmentRunCount
Integer assessmentRunCount

 The number of existing assessment runs associated with this assessment template. This value can be zero or a
 positive integer.
 


createdAt
Date createdAt

 The time at which the assessment template is created.
 








Class com.amazonaws.services.inspector.model.AssessmentTemplateFilter extends Object implements Serializable


Serialized Fields


namePattern
String namePattern

 For a record to match a filter, an explicit value or a string 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.
 


durationRange
DurationRange durationRange

 For a record to match a filter, the value specified for this data type property must inclusively match any value
 between the specified minimum and maximum values of the durationInSeconds property of the
 AssessmentTemplate data type.
 


rulesPackageArns
List<E> rulesPackageArns

 For a record to match a filter, the 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 extends Object implements Serializable


Serialized Fields


schemaVersion
Integer schemaVersion

 The schema version of this data type.
 


agentId
String agentId

 The ID of the agent that is installed on the EC2 instance where the finding is generated.
 


autoScalingGroup
String autoScalingGroup

 The Auto Scaling group of the EC2 instance where the finding is generated.
 


amiId
String amiId

 The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance where the finding is generated.
 


hostname
String hostname

 The hostname of the EC2 instance where the finding is generated.
 


ipv4Addresses
List<E> ipv4Addresses

 The list of IP v4 addresses of the EC2 instance where the finding is generated.
 


tags
List<E> tags

 The tags related to the EC2 instance where the finding is generated.
 


networkInterfaces
List<E> networkInterfaces

 An array of the network interfaces interacting with the EC2 instance where the finding is generated.
 








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


Serialized Fields


key
String key

 The attribute key.
 


value
String value

 The value assigned to the attribute key.
 








Class com.amazonaws.services.inspector.model.CreateAssessmentTargetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentTargetName
String assessmentTargetName

 The user-defined name 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. If resourceGroupArn is
 not specified, all EC2 instances in the current AWS account and region are included in the assessment target.
 








Class com.amazonaws.services.inspector.model.CreateAssessmentTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assessmentTargetArn
String assessmentTargetArn

 The ARN that specifies the assessment target that is created.
 








Class com.amazonaws.services.inspector.model.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.
 


rulesPackageArns
List<E> rulesPackageArns

 The ARNs that specify the rules packages that you want to attach to the assessment template.
 


userAttributesForFindings
List<E> userAttributesForFindings

 The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses
 this assessment template. An attribute is a key and value pair (an Attribute object). Within an assessment
 template, each key must be unique.
 








Class com.amazonaws.services.inspector.model.CreateAssessmentTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assessmentTemplateArn
String assessmentTemplateArn

 The ARN that specifies the assessment template that is created.
 








Class com.amazonaws.services.inspector.model.CreateExclusionsPreviewRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentTemplateArn
String assessmentTemplateArn

 The ARN that specifies the assessment template for which you want to create an exclusions preview.
 








Class com.amazonaws.services.inspector.model.CreateExclusionsPreviewResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


previewToken
String previewToken

 Specifies the unique identifier of the requested exclusions preview. You can use the unique identifier to
 retrieve the exclusions preview when running the GetExclusionsPreview API.
 








Class com.amazonaws.services.inspector.model.CreateResourceGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceGroupTags
List<E> resourceGroupTags

 A collection of keys and an array of possible values,
 '[{"key":"key1","values":["Value1","Value2"]},{"key":"Key2","values":["Value3"]}]'.
 
 
 For example,'[{"key":"Name","values":["TestEC2Instance"]}]'.
 








Class com.amazonaws.services.inspector.model.CreateResourceGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceGroupArn
String resourceGroupArn

 The ARN that specifies the resource group that is created.
 








Class com.amazonaws.services.inspector.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.inspector.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.inspector.model.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.inspector.model.DescribeAssessmentRunsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentRunArns
List<E> assessmentRunArns

 The ARN that specifies the assessment run that you want to describe.
 








Class com.amazonaws.services.inspector.model.DescribeAssessmentRunsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assessmentRuns
List<E> assessmentRuns

 Information about the assessment run.
 


failedItems
Map<K,V> failedItems

 Assessment run details that cannot be described. An error code is provided for each failed item.
 








Class com.amazonaws.services.inspector.model.DescribeAssessmentTargetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentTargetArns
List<E> assessmentTargetArns

 The ARNs that specifies the assessment targets that you want to describe.
 








Class com.amazonaws.services.inspector.model.DescribeAssessmentTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assessmentTargets
List<E> assessmentTargets

 Information about the assessment targets.
 


failedItems
Map<K,V> failedItems

 Assessment target details that cannot be described. An error code is provided for each failed item.
 








Class com.amazonaws.services.inspector.model.DescribeAssessmentTemplatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentTemplateArns
List<E> assessmentTemplateArns








Class com.amazonaws.services.inspector.model.DescribeAssessmentTemplatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assessmentTemplates
List<E> assessmentTemplates

 Information about the assessment templates.
 


failedItems
Map<K,V> failedItems

 Assessment template details that cannot be described. An error code is provided for each failed item.
 








Class com.amazonaws.services.inspector.model.DescribeCrossAccountAccessRoleRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.inspector.model.DescribeCrossAccountAccessRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


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.
 


registeredAt
Date registeredAt

 The date when the cross-account access role was registered.
 








Class com.amazonaws.services.inspector.model.DescribeExclusionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


exclusionArns
List<E> exclusionArns

 The list of ARNs that specify the exclusions that you want to describe.
 


locale
String locale

 The locale into which you want to translate the exclusion's title, description, and recommendation.
 








Class com.amazonaws.services.inspector.model.DescribeExclusionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


exclusions
Map<K,V> exclusions

 Information about the exclusions.
 


failedItems
Map<K,V> failedItems

 Exclusion details that cannot be described. An error code is provided for each failed item.
 








Class com.amazonaws.services.inspector.model.DescribeFindingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


findingArns
List<E> 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


findings
List<E> findings

 Information about the finding.
 


failedItems
Map<K,V> failedItems

 Finding details that cannot be described. An error code is provided for each failed item.
 








Class com.amazonaws.services.inspector.model.DescribeResourceGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceGroupArns
List<E> resourceGroupArns

 The ARN that specifies the resource group that you want to describe.
 








Class com.amazonaws.services.inspector.model.DescribeResourceGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceGroups
List<E> resourceGroups

 Information about a resource group.
 


failedItems
Map<K,V> failedItems

 Resource group details that cannot be described. An error code is provided for each failed item.
 








Class com.amazonaws.services.inspector.model.DescribeRulesPackagesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rulesPackageArns
List<E> rulesPackageArns

 The ARN that specifies the rules package that you want to describe.
 


locale
String locale

 The locale that you want to translate a rules package description into.
 








Class com.amazonaws.services.inspector.model.DescribeRulesPackagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rulesPackages
List<E> rulesPackages

 Information about the rules package.
 


failedItems
Map<K,V> failedItems

 Rules package details that cannot be described. An error code is provided for each failed item.
 








Class com.amazonaws.services.inspector.model.DurationRange extends Object implements Serializable


Serialized Fields


minSeconds
Integer minSeconds

 The minimum value of the duration range. Must be greater than zero.
 


maxSeconds
Integer maxSeconds

 The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).
 








Class com.amazonaws.services.inspector.model.EventSubscription extends Object implements Serializable


Serialized Fields


event
String event

 The event for which Amazon Simple Notification Service (SNS) notifications are sent.
 


subscribedAt
Date subscribedAt

 The time at which SubscribeToEvent is called.
 








Class com.amazonaws.services.inspector.model.Exclusion extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN that specifies the exclusion.
 


title
String title

 The name of the exclusion.
 


description
String description

 The description of the exclusion.
 


recommendation
String recommendation

 The recommendation for the exclusion.
 


scopes
List<E> scopes

 The AWS resources for which the exclusion pertains.
 


attributes
List<E> attributes

 The system-defined attributes for the exclusion.
 








Class com.amazonaws.services.inspector.model.ExclusionPreview extends Object implements Serializable


Serialized Fields


title
String title

 The name of the exclusion preview.
 


description
String description

 The description of the exclusion preview.
 


recommendation
String recommendation

 The recommendation for the exclusion preview.
 


scopes
List<E> scopes

 The AWS resources for which the exclusion preview pertains.
 


attributes
List<E> attributes

 The system-defined attributes for the exclusion preview.
 








Class com.amazonaws.services.inspector.model.FailedItemDetails extends Object implements Serializable


Serialized Fields


failureCode
String failureCode

 The status code of a failed item.
 


retryable
Boolean retryable

 Indicates whether you can immediately retry a request for this item for a specified resource.
 








Class com.amazonaws.services.inspector.model.Finding extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN that specifies 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

 This data type is used in the Finding data type.
 


assetType
String assetType

 The type of the host from which the finding is generated.
 


assetAttributes
AssetAttributes assetAttributes

 A collection of attributes of the host from which the finding is generated.
 


id
String id

 The ID of the finding.
 


title
String title

 The name of the finding.
 


description
String description

 The description of the finding.
 


recommendation
String recommendation

 The recommendation for the finding.
 


severity
String severity

 The finding severity. Values can be set to High, Medium, Low, and Informational.
 


numericSeverity
Double numericSeverity

 The numeric value of the finding severity.
 


confidence
Integer confidence

 This data element is currently not used.
 


indicatorOfCompromise
Boolean indicatorOfCompromise

 This data element is currently not used.
 


attributes
List<E> attributes

 The system-defined attributes for the finding.
 


userAttributes
List<E> userAttributes

 The user-defined attributes that are assigned to the finding.
 


createdAt
Date createdAt

 The time when the finding was generated.
 


updatedAt
Date updatedAt

 The time when AddAttributesToFindings is called.
 








Class com.amazonaws.services.inspector.model.FindingFilter extends Object implements Serializable


Serialized Fields


agentIds
List<E> agentIds

 For a record to match a filter, one of the values 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.
 


autoScalingGroups
List<E> 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.
 


ruleNames
List<E> 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.
 


severities
List<E> 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.
 


rulesPackageArns
List<E> 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.
 


attributes
List<E> 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.
 


userAttributes
List<E> 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.
 


creationTimeRange
TimestampRange creationTimeRange

 The time range during which the finding is generated.
 








Class com.amazonaws.services.inspector.model.GetAssessmentReportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentRunArn
String assessmentRunArn

 The ARN that specifies the assessment run for which you want to generate a report.
 


reportFileFormat
String reportFileFormat

 Specifies the file format (html or pdf) of the assessment report that you want to generate.
 


reportType
String reportType

 Specifies the type of the assessment report that you want to generate. There are two types of assessment reports:
 a finding report and a full report. For more information, see Assessment Reports.
 








Class com.amazonaws.services.inspector.model.GetAssessmentReportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
String status

 Specifies the status of the request to generate an assessment report.
 


url
String url

 Specifies the URL where you can find the generated assessment report. This parameter is only returned if the
 report is successfully generated.
 








Class com.amazonaws.services.inspector.model.GetExclusionsPreviewRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentTemplateArn
String assessmentTemplateArn

 The ARN that specifies the assessment template for which the exclusions preview was requested.
 


previewToken
String previewToken

 The unique identifier associated of the exclusions preview.
 


nextToken
String nextToken

 You can use this parameter when paginating results. Set the value of this parameter to null on your first call to
 the GetExclusionsPreviewRequest action. Subsequent calls to the action fill nextToken in the request with the
 value of nextToken from the previous response to continue listing data.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 100. The maximum value is 500.
 


locale
String locale

 The locale into which you want to translate the exclusion's title, description, and recommendation.
 








Class com.amazonaws.services.inspector.model.GetExclusionsPreviewResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


previewStatus
String previewStatus

 Specifies the status of the request to generate an exclusions preview.
 


exclusionPreviews
List<E> exclusionPreviews

 Information about the exclusions included in the preview.
 


nextToken
String nextToken

 When a response is generated, if there is more data to be listed, this parameters 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.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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


telemetryMetadata
List<E> telemetryMetadata

 Telemetry details.
 








Class com.amazonaws.services.inspector.model.InspectorServiceAttributes extends Object implements Serializable


Serialized Fields


schemaVersion
Integer schemaVersion

 The schema version of this data type.
 


assessmentRunArn
String assessmentRunArn

 The ARN of the assessment run during which the finding is generated.
 


rulesPackageArn
String rulesPackageArn

 The ARN of the rules package that is used to generate the finding.
 








Class com.amazonaws.services.inspector.model.InternalException extends AmazonInspectorException implements Serializable

serialVersionUID:
1L



Serialized Fields


canRetry
Boolean canRetry

 You can immediately retry your request.
 








Class com.amazonaws.services.inspector.model.InvalidCrossAccountRoleException extends AmazonInspectorException implements Serializable

serialVersionUID:
1L



Serialized Fields


canRetry
Boolean canRetry

 You can immediately retry your request.
 


inspectorErrorCode
String inspectorErrorCode

 Code that indicates the type of error that is generated.
 








Class com.amazonaws.services.inspector.model.InvalidInputException extends AmazonInspectorException implements Serializable

serialVersionUID:
1L



Serialized Fields


canRetry
Boolean canRetry

 You can immediately retry your request.
 


inspectorErrorCode
String inspectorErrorCode

 Code that indicates the type of error that is generated.
 








Class com.amazonaws.services.inspector.model.LimitExceededException extends AmazonInspectorException implements Serializable

serialVersionUID:
1L



Serialized Fields


canRetry
Boolean canRetry

 You can immediately retry your request.
 


inspectorErrorCode
String inspectorErrorCode

 Code that indicates the type of error that is generated.
 








Class com.amazonaws.services.inspector.model.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.
 


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.
 


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.
 








Class com.amazonaws.services.inspector.model.ListAssessmentRunAgentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assessmentRunAgents
List<E> 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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentTemplateArns
List<E> 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.
 


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.
 


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.
 








Class com.amazonaws.services.inspector.model.ListAssessmentRunsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assessmentRunArns
List<E> 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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
AssessmentTargetFilter filter

 You can use this parameter to specify a subset of data to be included in the action's response.
 
 
 For a record to match a filter, all specified filter attributes must match. When multiple values are specified
 for a filter attribute, any of the values can match.
 


nextToken
String nextToken

 You can use this parameter when paginating results. Set the value of this parameter to null on your first call to
 the ListAssessmentTargets action. Subsequent calls to the action fill nextToken in the request with
 the value of NextToken from the previous response to continue listing data.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 10. The maximum value is 500.
 








Class com.amazonaws.services.inspector.model.ListAssessmentTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assessmentTargetArns
List<E> 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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentTargetArns
List<E> 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.
 


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.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 10. The maximum value is 500.
 








Class com.amazonaws.services.inspector.model.ListAssessmentTemplatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assessmentTemplateArns
List<E> 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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the assessment template for which you want to list the existing event subscriptions.
 


nextToken
String nextToken

 You can use this parameter when paginating results. Set the value of this parameter to null on your first call to
 the ListEventSubscriptions action. Subsequent calls to the action fill nextToken in the request
 with the value of NextToken from the previous response to continue listing data.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 10. The maximum value is 500.
 








Class com.amazonaws.services.inspector.model.ListEventSubscriptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


subscriptions
List<E> subscriptions

 Details of the returned event subscriptions.
 


nextToken
String nextToken

 When a response is generated, if there is more data to be listed, this parameter is present in the response and
 contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no
 more data to be listed, this parameter is set to null.
 








Class com.amazonaws.services.inspector.model.ListExclusionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentRunArn
String assessmentRunArn

 The ARN of the assessment run that generated the exclusions that you want to list.
 


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 ListExclusionsRequest action. Subsequent calls to the action fill nextToken in the request with the value of
 nextToken from the previous response to continue listing data.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 100. The maximum value is 500.
 








Class com.amazonaws.services.inspector.model.ListExclusionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


exclusionArns
List<E> exclusionArns

 A list of exclusions' ARNs returned by the action.
 


nextToken
String nextToken

 When a response is generated, if there is more data to be listed, this parameters is present in the response and
 contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more
 data to be listed, this parameter is set to null.
 








Class com.amazonaws.services.inspector.model.ListFindingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentRunArns
List<E> assessmentRunArns

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


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.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 10. The maximum value is 500.
 








Class com.amazonaws.services.inspector.model.ListFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


findingArns
List<E> 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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 You can use this parameter when paginating results. Set the value of this parameter to null on your first call to
 the ListRulesPackages action. Subsequent calls to the action fill nextToken in the request with the
 value of NextToken from the previous response to continue listing data.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 10. The maximum value is 500.
 








Class com.amazonaws.services.inspector.model.ListRulesPackagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rulesPackageArns
List<E> rulesPackageArns

 The list of ARNs that specifies the rules packages returned by the action.
 


nextToken
String nextToken

 When a response is generated, if there is more data to be listed, this parameter is present in the response and
 contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no
 more data to be listed, this parameter is set to null.
 








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


Serialized Fields


resourceArn
String resourceArn

 The ARN that specifies the assessment template whose tags you want to list.
 








Class com.amazonaws.services.inspector.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 A collection of key and value pairs.
 








Class com.amazonaws.services.inspector.model.NetworkInterface extends Object implements Serializable


Serialized Fields


networkInterfaceId
String networkInterfaceId

 The ID of the network interface.
 


subnetId
String subnetId

 The ID of a subnet associated with the network interface.
 


vpcId
String vpcId

 The ID of a VPC associated with the network interface.
 


privateDnsName
String privateDnsName

 The name of a private DNS associated with the network interface.
 


privateIpAddress
String privateIpAddress

 The private IP address associated with the network interface.
 


privateIpAddresses
List<E> privateIpAddresses

 A list of the private IP addresses associated with the network interface. Includes the privateDnsName and
 privateIpAddress.
 


publicDnsName
String publicDnsName

 The name of a public DNS associated with the network interface.
 


publicIp
String publicIp

 The public IP address from which the network interface is reachable.
 


ipv6Addresses
List<E> ipv6Addresses

 The IP addresses associated with the network interface.
 


securityGroups
List<E> securityGroups

 A list of the security groups associated with the network interface. Includes the groupId and groupName.
 








Class com.amazonaws.services.inspector.model.NoSuchEntityException extends AmazonInspectorException implements Serializable

serialVersionUID:
1L



Serialized Fields


canRetry
Boolean canRetry

 You can immediately retry your request.
 


inspectorErrorCode
String inspectorErrorCode

 Code that indicates the type of error that is generated.
 








Class com.amazonaws.services.inspector.model.PreviewAgentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


previewAgentsArn
String previewAgentsArn

 The ARN of the assessment target whose agents you want to preview.
 


nextToken
String nextToken

 You can use this parameter when paginating results. Set the value of this parameter to null on your first call to
 the PreviewAgents action. Subsequent calls to the action fill nextToken in the request with the
 value of NextToken from the previous response to continue listing data.
 


maxResults
Integer maxResults

 You can use this parameter to indicate the maximum number of items you want in the response. The default value is
 10. The maximum value is 500.
 








Class com.amazonaws.services.inspector.model.PreviewAgentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


agentPreviews
List<E> agentPreviews

 The resulting list of agents.
 


nextToken
String nextToken

 When a response is generated, if there is more data to be listed, this parameter is present in the response and
 contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no
 more data to be listed, this parameter is set to null.
 








Class com.amazonaws.services.inspector.model.PreviewGenerationInProgressException extends AmazonInspectorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.inspector.model.PrivateIp extends Object implements Serializable


Serialized Fields


privateDnsName
String privateDnsName

 The DNS name of the private IP address.
 


privateIpAddress
String privateIpAddress

 The full IP address of the network inteface.
 








Class com.amazonaws.services.inspector.model.RegisterCrossAccountAccessRoleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants Amazon Inspector access to AWS Services needed to perform security
 assessments.
 








Class com.amazonaws.services.inspector.model.RegisterCrossAccountAccessRoleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.inspector.model.RemoveAttributesFromFindingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


findingArns
List<E> findingArns

 The ARNs that specify the findings that you want to remove attributes from.
 


attributeKeys
List<E> attributeKeys

 The array of attribute keys that you want to remove from specified findings.
 








Class com.amazonaws.services.inspector.model.RemoveAttributesFromFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedItems
Map<K,V> failedItems

 Attributes details that cannot be described. An error code is provided for each failed item.
 








Class com.amazonaws.services.inspector.model.ResourceGroup extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the resource group.
 


tags
List<E> tags

 The tags (key and value pairs) of the resource group. This data type property is used in the
 CreateResourceGroup action.
 


createdAt
Date createdAt

 The time at which resource group is created.
 








Class com.amazonaws.services.inspector.model.ResourceGroupTag extends Object implements Serializable


Serialized Fields


key
String key

 A tag key.
 


value
String value

 The value assigned to a tag key.
 








Class com.amazonaws.services.inspector.model.RulesPackage extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the rules package.
 


name
String name

 The name of the rules package.
 


version
String version

 The version ID of the rules package.
 


provider
String provider

 The provider of the rules package.
 


description
String description

 The description of the rules package.
 








Class com.amazonaws.services.inspector.model.Scope extends Object implements Serializable


Serialized Fields


key
String key

 The type of the scope.
 


value
String value

 The resource identifier for the specified scope type.
 








Class com.amazonaws.services.inspector.model.SecurityGroup extends Object implements Serializable


Serialized Fields


groupName
String groupName

 The name of the security group.
 


groupId
String groupId

 The ID of the security group.
 








Class com.amazonaws.services.inspector.model.ServiceTemporarilyUnavailableException extends AmazonInspectorException implements Serializable

serialVersionUID:
1L



Serialized Fields


canRetry
Boolean canRetry

 You can wait and then retry your request.
 








Class com.amazonaws.services.inspector.model.SetTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the assessment template that you want to set tags to.
 


tags
List<E> tags

 A collection of key and value pairs that you want to set to the assessment template.
 








Class com.amazonaws.services.inspector.model.SetTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.inspector.model.StartAssessmentRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentTemplateArn
String assessmentTemplateArn

 The ARN of the assessment template of the assessment run that you want to start.
 


assessmentRunName
String assessmentRunName

 You can specify the name for the assessment run. The name must be unique for the assessment template whose ARN is
 used to start the assessment run.
 








Class com.amazonaws.services.inspector.model.StartAssessmentRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assessmentRunArn
String assessmentRunArn

 The ARN of the assessment run that has been started.
 








Class com.amazonaws.services.inspector.model.StopAssessmentRunRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentRunArn
String assessmentRunArn

 The ARN of the assessment run that you want to stop.
 


stopAction
String stopAction

 An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default
 value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation
 process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.
 








Class com.amazonaws.services.inspector.model.StopAssessmentRunResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.inspector.model.SubscribeToEventRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the assessment template that is used during the event for which you want to receive SNS notifications.
 


event
String event

 The event for which you want to receive SNS notifications.
 


topicArn
String topicArn

 The ARN of the SNS topic to which the SNS notifications are sent.
 








Class com.amazonaws.services.inspector.model.SubscribeToEventResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.inspector.model.Subscription extends Object implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the assessment template that is used during the event for which the SNS notification is sent.
 


topicArn
String topicArn

 The ARN of the Amazon Simple Notification Service (SNS) topic to which the SNS notifications are sent.
 


eventSubscriptions
List<E> eventSubscriptions

 The list of existing event subscriptions.
 








Class com.amazonaws.services.inspector.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A tag key.
 


value
String value

 A value assigned to a tag key.
 








Class com.amazonaws.services.inspector.model.TelemetryMetadata extends Object implements Serializable


Serialized Fields


messageType
String messageType

 A specific type of behavioral data that is collected by the agent.
 


count
Long count

 The count of messages that the agent sends to the Amazon Inspector service.
 


dataSize
Long dataSize

 The data size of messages that the agent sends to the Amazon Inspector service.
 








Class com.amazonaws.services.inspector.model.TimestampRange extends Object implements Serializable


Serialized Fields


beginDate
Date beginDate

 The minimum value of the timestamp range.
 


endDate
Date endDate

 The maximum value of the timestamp range.
 








Class com.amazonaws.services.inspector.model.UnsubscribeFromEventRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the assessment template that is used during the event for which you want to stop receiving SNS
 notifications.
 


event
String event

 The event for which you want to stop receiving SNS notifications.
 


topicArn
String topicArn

 The ARN of the SNS topic to which SNS notifications are sent.
 








Class com.amazonaws.services.inspector.model.UnsubscribeFromEventResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.inspector.model.UnsupportedFeatureException extends AmazonInspectorException implements Serializable

serialVersionUID:
1L



Serialized Fields


canRetry
Boolean canRetry








Class com.amazonaws.services.inspector.model.UpdateAssessmentTargetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assessmentTargetArn
String assessmentTargetArn

 The ARN of the assessment target that you want to update.
 


assessmentTargetName
String assessmentTargetName

 The name of the assessment target that you want to update.
 


resourceGroupArn
String resourceGroupArn

 The 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.iot.model




Class com.amazonaws.services.iot.model.AbortConfig extends Object implements Serializable


Serialized Fields


criteriaList
List<E> criteriaList

 The list of abort criteria to define rules to abort the job.
 








Class com.amazonaws.services.iot.model.AbortCriteria extends Object implements Serializable


Serialized Fields


failureType
String failureType

 The type of job execution failure to define a rule to initiate a job abort.
 


action
String action

 The type of abort action to initiate a job abort.
 


thresholdPercentage
Double thresholdPercentage

 The threshold as a percentage of the total number of executed things that will initiate a job abort.
 
 
 AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).
 


minNumberOfExecutedThings
Integer minNumberOfExecutedThings

 Minimum number of executed things before evaluating an abort rule.
 








Class com.amazonaws.services.iot.model.AcceptCertificateTransferRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateId
String certificateId

 The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
 


setAsActive
Boolean setAsActive

 Specifies whether the certificate is active.
 








Class com.amazonaws.services.iot.model.AcceptCertificateTransferResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.Action extends Object implements Serializable


Serialized Fields


dynamoDB
DynamoDBAction dynamoDB

 Write to a DynamoDB table.
 


dynamoDBv2
DynamoDBv2Action dynamoDBv2

 Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in
 an MQTT message payload into a separate DynamoDB column.
 


lambda
LambdaAction lambda

 Invoke a Lambda function.
 


sns
SnsAction sns

 Publish to an Amazon SNS topic.
 


sqs
SqsAction sqs

 Publish to an Amazon SQS queue.
 


kinesis
KinesisAction kinesis

 Write data to an Amazon Kinesis stream.
 


republish
RepublishAction republish

 Publish to another MQTT topic.
 


s3
S3Action s3

 Write to an Amazon S3 bucket.
 


firehose
FirehoseAction firehose

 Write to an Amazon Kinesis Firehose stream.
 


cloudwatchMetric
CloudwatchMetricAction cloudwatchMetric

 Capture a CloudWatch metric.
 


cloudwatchAlarm
CloudwatchAlarmAction cloudwatchAlarm

 Change the state of a CloudWatch alarm.
 


elasticsearch
ElasticsearchAction elasticsearch

 Write data to an Amazon Elasticsearch Service domain.
 


salesforce
SalesforceAction salesforce

 Send a message to a Salesforce IoT Cloud Input Stream.
 


iotAnalytics
IotAnalyticsAction iotAnalytics

 Sends message data to an AWS IoT Analytics channel.
 


iotEvents
IotEventsAction iotEvents

 Sends an input to an AWS IoT Events detector.
 


iotSiteWise
IotSiteWiseAction iotSiteWise

 Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
 


stepFunctions
StepFunctionsAction stepFunctions

 Starts execution of a Step Functions state machine.
 


http
HttpAction http

 Send data to an HTTPS endpoint.
 








Class com.amazonaws.services.iot.model.ActiveViolation extends Object implements Serializable


Serialized Fields


violationId
String violationId

 The ID of the active violation.
 


thingName
String thingName

 The name of the thing responsible for the active violation.
 


securityProfileName
String securityProfileName

 The security profile whose behavior is in violation.
 


behavior
Behavior behavior

 The behavior which is being violated.
 


lastViolationValue
MetricValue lastViolationValue

 The value of the metric (the measurement) which caused the most recent violation.
 


lastViolationTime
Date lastViolationTime

 The time the most recent violation occurred.
 


violationStartTime
Date violationStartTime

 The time the violation started.
 








Class com.amazonaws.services.iot.model.AddThingsToThingGroupParams extends Object implements Serializable


Serialized Fields


thingGroupNames
List<E> thingGroupNames

 The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing
 to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.
 


overrideDynamicGroups
Boolean overrideDynamicGroups

 Specifies if this mitigation action can move the things that triggered the mitigation action even if they are
 part of one or more dynamic things groups.
 








Class com.amazonaws.services.iot.model.AddThingToBillingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


billingGroupName
String billingGroupName

 The name of the billing group.
 


billingGroupArn
String billingGroupArn

 The ARN of the billing group.
 


thingName
String thingName

 The name of the thing to be added to the billing group.
 


thingArn
String thingArn

 The ARN of the thing to be added to the billing group.
 








Class com.amazonaws.services.iot.model.AddThingToBillingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.AddThingToThingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The name of the group to which you are adding a thing.
 


thingGroupArn
String thingGroupArn

 The ARN of the group to which you are adding a thing.
 


thingName
String thingName

 The name of the thing to add to a group.
 


thingArn
String thingArn

 The ARN of the thing to add to a group.
 


overrideDynamicGroups
Boolean overrideDynamicGroups

 Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10
 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes
 the thing from the last dynamic group.
 








Class com.amazonaws.services.iot.model.AddThingToThingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.AlertTarget extends Object implements Serializable


Serialized Fields


alertTargetArn
String alertTargetArn

 The ARN of the notification target to which alerts are sent.
 


roleArn
String roleArn

 The ARN of the role that grants permission to send alerts to the notification target.
 








Class com.amazonaws.services.iot.model.Allowed extends Object implements Serializable


Serialized Fields


policies
List<E> policies

 A list of policies that allowed the authentication.
 








Class com.amazonaws.services.iot.model.AssetPropertyTimestamp extends Object implements Serializable


Serialized Fields


timeInSeconds
String timeInSeconds

 A string that contains the time in seconds since epoch. Accepts substitution templates.
 


offsetInNanos
String offsetInNanos

 Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
 








Class com.amazonaws.services.iot.model.AssetPropertyValue extends Object implements Serializable


Serialized Fields


value
AssetPropertyVariant value

 The value of the asset property.
 


timestamp
AssetPropertyTimestamp timestamp

 The asset property value timestamp.
 


quality
String quality

 Optional. A string that describes the quality of the value. Accepts substitution templates. Must be
 GOOD, BAD, or UNCERTAIN.
 








Class com.amazonaws.services.iot.model.AssetPropertyVariant extends Object implements Serializable


Serialized Fields


stringValue
String stringValue

 Optional. The string value of the value entry. Accepts substitution templates.
 


integerValue
String integerValue

 Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
 


doubleValue
String doubleValue

 Optional. A string that contains the double value of the value entry. Accepts substitution templates.
 


booleanValue
String booleanValue

 Optional. A string that contains the boolean value (true or false) of the value entry.
 Accepts substitution templates.
 








Class com.amazonaws.services.iot.model.AssociateTargetsWithJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targets
List<E> targets

 A list of thing group ARNs that define the targets of the job.
 


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 


comment
String comment

 An optional comment string describing why the job was associated with the targets.
 








Class com.amazonaws.services.iot.model.AssociateTargetsWithJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobArn
String jobArn

 An ARN identifying the job.
 


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 


description
String description

 A short text description of the job.
 








Class com.amazonaws.services.iot.model.AttachPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The name of the policy to attach.
 


target
String target

 The identity to
 which the policy is attached.
 








Class com.amazonaws.services.iot.model.AttachPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.AttachPrincipalPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The policy name.
 


principal
String principal

 The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon
 Cognito ID.
 








Class com.amazonaws.services.iot.model.AttachPrincipalPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.AttachSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


securityProfileName
String securityProfileName

 The security profile that is attached.
 


securityProfileTargetArn
String securityProfileTargetArn

 The ARN of the target (thing group) to which the security profile is attached.
 








Class com.amazonaws.services.iot.model.AttachSecurityProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.AttachThingPrincipalRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing.
 


principal
String principal

 The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon
 Cognito ID.
 








Class com.amazonaws.services.iot.model.AttachThingPrincipalResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.AttributePayload extends Object implements Serializable


Serialized Fields


attributes
Map<K,V> attributes

 A JSON string containing up to three key-value pair in JSON format. For example:
 
 
 {\"attributes\":{\"string1\":\"string2\"}}
 


merge
Boolean merge

 Specifies whether the list of attributes provided in the AttributePayload is merged with the
 attributes stored in the registry, instead of overwriting them.
 
 
 To remove an attribute, call UpdateThing with an empty attribute value.
 
 
 
 The merge attribute is only valid when calling UpdateThing or
 UpdateThingGroup.
 
 








Class com.amazonaws.services.iot.model.AuditCheckConfiguration extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 True if this audit check is enabled for this account.
 








Class com.amazonaws.services.iot.model.AuditCheckDetails extends Object implements Serializable


Serialized Fields


checkRunStatus
String checkRunStatus

 The completion status of this check. One of "IN_PROGRESS", "WAITING_FOR_DATA_COLLECTION", "CANCELED",
 "COMPLETED_COMPLIANT", "COMPLETED_NON_COMPLIANT", or "FAILED".
 


checkCompliant
Boolean checkCompliant

 True if the check is complete and found all resources compliant.
 


totalResourcesCount
Long totalResourcesCount

 The number of resources on which the check was performed.
 


nonCompliantResourcesCount
Long nonCompliantResourcesCount

 The number of resources that were found noncompliant during the check.
 


errorCode
String errorCode

 The code of any error encountered when this check is performed during this audit. One of
 "INSUFFICIENT_PERMISSIONS" or "AUDIT_CHECK_DISABLED".
 


message
String message

 The message associated with any error encountered when this check is performed during this audit.
 








Class com.amazonaws.services.iot.model.AuditFinding extends Object implements Serializable


Serialized Fields


findingId
String findingId

 A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or
 more sets of findings.
 


taskId
String taskId

 The ID of the audit that generated this result (finding).
 


checkName
String checkName

 The audit check that generated this result.
 


taskStartTime
Date taskStartTime

 The time the audit started.
 


findingTime
Date findingTime

 The time the result (finding) was discovered.
 


severity
String severity

 The severity of the result (finding).
 


nonCompliantResource
NonCompliantResource nonCompliantResource

 The resource that was found to be noncompliant with the audit check.
 


relatedResources
List<E> relatedResources

 The list of related resources.
 


reasonForNonCompliance
String reasonForNonCompliance

 The reason the resource was noncompliant.
 


reasonForNonComplianceCode
String reasonForNonComplianceCode

 A code that indicates the reason that the resource was noncompliant.
 








Class com.amazonaws.services.iot.model.AuditMitigationActionExecutionMetadata extends Object implements Serializable


Serialized Fields


taskId
String taskId

 The unique identifier for the task that applies the mitigation action.
 


findingId
String findingId

 The unique identifier for the findings to which the task and associated mitigation action are applied.
 


actionName
String actionName

 The friendly name of the mitigation action being applied by the task.
 


actionId
String actionId

 The unique identifier for the mitigation action being applied by the task.
 


status
String status

 The current status of the task being executed.
 


startTime
Date startTime

 The date and time when the task was started.
 


endTime
Date endTime

 The date and time when the task was completed or canceled. Blank if the task is still running.
 


errorCode
String errorCode

 If an error occurred, the code that indicates which type of error occurred.
 


message
String message

 If an error occurred, a message that describes the error.
 








Class com.amazonaws.services.iot.model.AuditMitigationActionsTaskMetadata extends Object implements Serializable


Serialized Fields


taskId
String taskId

 The unique identifier for the task.
 


startTime
Date startTime

 The time at which the audit mitigation actions task was started.
 


taskStatus
String taskStatus

 The current state of the audit mitigation actions task.
 








Class com.amazonaws.services.iot.model.AuditMitigationActionsTaskTarget extends Object implements Serializable


Serialized Fields


auditTaskId
String auditTaskId

 If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the
 audit.
 


findingIds
List<E> findingIds

 If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those
 findings.
 


auditCheckToReasonCodeFilter
Map<K,V> auditCheckToReasonCodeFilter

 Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the
 audit to which the audit mitigation actions task apply.
 








Class com.amazonaws.services.iot.model.AuditNotificationTarget extends Object implements Serializable


Serialized Fields


targetArn
String targetArn

 The ARN of the target (SNS topic) to which audit notifications are sent.
 


roleArn
String roleArn

 The ARN of the role that grants permission to send notifications to the target.
 


enabled
Boolean enabled

 True if notifications to the target are enabled.
 








Class com.amazonaws.services.iot.model.AuditTaskMetadata extends Object implements Serializable


Serialized Fields


taskId
String taskId

 The ID of this audit.
 


taskStatus
String taskStatus

 The status of this audit. One of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
 


taskType
String taskType

 The type of this audit. One of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
 








Class com.amazonaws.services.iot.model.AuthInfo extends Object implements Serializable


Serialized Fields


actionType
String actionType

 The type of action for which the principal is being authorized.
 


resources
List<E> resources

 The resources for which the principal is being authorized to perform the specified action.
 








Class com.amazonaws.services.iot.model.AuthorizerConfig extends Object implements Serializable


Serialized Fields


defaultAuthorizerName
String defaultAuthorizerName

 The name of the authorization service for a domain configuration.
 


allowAuthorizerOverride
Boolean allowAuthorizerOverride

 A Boolean that specifies whether the domain configuration's authorization service can be overridden.
 








Class com.amazonaws.services.iot.model.AuthorizerDescription extends Object implements Serializable


Serialized Fields


authorizerName
String authorizerName

 The authorizer name.
 


authorizerArn
String authorizerArn

 The authorizer ARN.
 


authorizerFunctionArn
String authorizerFunctionArn

 The authorizer's Lambda function ARN.
 


tokenKeyName
String tokenKeyName

 The key used to extract the token from the HTTP headers.
 


tokenSigningPublicKeys
Map<K,V> tokenSigningPublicKeys

 The public keys used to validate the token signature returned by your custom authentication service.
 


status
String status

 The status of the authorizer.
 


creationDate
Date creationDate

 The UNIX timestamp of when the authorizer was created.
 


lastModifiedDate
Date lastModifiedDate

 The UNIX timestamp of when the authorizer was last updated.
 


signingDisabled
Boolean signingDisabled

 Specifies whether AWS IoT validates the token signature in an authorization request.
 








Class com.amazonaws.services.iot.model.AuthorizerSummary extends Object implements Serializable


Serialized Fields


authorizerName
String authorizerName

 The authorizer name.
 


authorizerArn
String authorizerArn

 The authorizer ARN.
 








Class com.amazonaws.services.iot.model.AuthResult extends Object implements Serializable


Serialized Fields


authInfo
AuthInfo authInfo

 Authorization information.
 


allowed
Allowed allowed

 The policies and statements that allowed the specified action.
 


denied
Denied denied

 The policies and statements that denied the specified action.
 


authDecision
String authDecision

 The final authorization decision of this scenario. Multiple statements are taken into account when determining
 the authorization decision. An explicit deny statement can override multiple allow statements.
 


missingContextValues
List<E> missingContextValues

 Contains any missing context values found while evaluating policy.
 








Class com.amazonaws.services.iot.model.AWSIotException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.AwsJobExecutionsRolloutConfig extends Object implements Serializable


Serialized Fields


maximumPerMinute
Integer maximumPerMinute

 The maximum number of OTA update job executions started per minute.
 








Class com.amazonaws.services.iot.model.AwsJobPresignedUrlConfig extends Object implements Serializable


Serialized Fields


expiresInSec
Long expiresInSec

 How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds.
 Pre-signed URLs are generated when a request for the job document is received.
 








Class com.amazonaws.services.iot.model.Behavior extends Object implements Serializable


Serialized Fields


name
String name

 The name you have given to the behavior.
 


metric
String metric

 What is measured by the behavior.
 


criteria
BehaviorCriteria criteria

 The criteria that determine if a device is behaving normally in regard to the metric.
 








Class com.amazonaws.services.iot.model.BehaviorCriteria extends Object implements Serializable


Serialized Fields


comparisonOperator
String comparisonOperator

 The operator that relates the thing measured (metric) to the criteria (containing a
 value or statisticalThreshold).
 


value
MetricValue value

 The value to be compared with the metric.
 


durationSeconds
Integer durationSeconds

 Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time
 dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric
 comparison, measurements from all devices are accumulated over this time duration before being used to calculate
 percentiles, and later, measurements from an individual device are also accumulated over this time duration
 before being given a percentile rank.
 


consecutiveDatapointsToAlarm
Integer consecutiveDatapointsToAlarm

 If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs.
 If not specified, the default is 1.
 


consecutiveDatapointsToClear
Integer consecutiveDatapointsToClear

 If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified
 number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
 


statisticalThreshold
StatisticalThreshold statisticalThreshold

 A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in
 compliance or in violation of the behavior.
 








Class com.amazonaws.services.iot.model.BillingGroupMetadata extends Object implements Serializable


Serialized Fields


creationDate
Date creationDate

 The date the billing group was created.
 








Class com.amazonaws.services.iot.model.BillingGroupProperties extends Object implements Serializable


Serialized Fields


billingGroupDescription
String billingGroupDescription

 The description of the billing group.
 








Class com.amazonaws.services.iot.model.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.
 


status
String status

 The status of the CA certificate.
 
 
 The status value REGISTER_INACTIVE is deprecated and should not be used.
 


creationDate
Date creationDate

 The date the CA certificate was created.
 








Class com.amazonaws.services.iot.model.CACertificateDescription extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn

 The CA certificate ARN.
 


certificateId
String certificateId

 The CA certificate ID.
 


status
String status

 The status of a CA certificate.
 


certificatePem
String certificatePem

 The CA certificate data, in PEM format.
 


ownedBy
String ownedBy

 The owner of the CA certificate.
 


creationDate
Date creationDate

 The date the CA certificate was created.
 


autoRegistrationStatus
String autoRegistrationStatus

 Whether the CA certificate configured for auto registration of device certificates. Valid values are "ENABLE" and
 "DISABLE"
 


lastModifiedDate
Date lastModifiedDate

 The date the CA certificate was last modified.
 


customerVersion
Integer customerVersion

 The customer version of the CA certificate.
 


generationId
String generationId

 The generation ID of the CA certificate.
 


validity
CertificateValidity validity

 When the CA certificate is valid.
 








Class com.amazonaws.services.iot.model.CancelAuditMitigationActionsTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 The unique identifier for the task that you want to cancel.
 








Class com.amazonaws.services.iot.model.CancelAuditMitigationActionsTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.CancelAuditTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 The ID of the audit you want to cancel. You can only cancel an audit that is "IN_PROGRESS".
 








Class com.amazonaws.services.iot.model.CancelAuditTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.CancelCertificateTransferRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateId
String certificateId

 The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
 








Class com.amazonaws.services.iot.model.CancelCertificateTransferResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.CancelJobExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The ID of the job to be canceled.
 


thingName
String thingName

 The name of the thing whose execution of the job will be canceled.
 


force
Boolean force

 (Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED,
 otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job
 execution that is IN_PROGRESS, and you do not set force to true, then an
 InvalidStateTransitionException will be thrown. The default is false.
 
 
 Canceling a job execution which is "IN_PROGRESS", will cause the device to be unable to update the job execution
 status. Use caution and ensure that the device is able to recover to a valid state.
 


expectedVersion
Long expectedVersion

 (Optional) The expected current version of the job execution. Each time you update the job execution, its version
 is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a
 VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned.
 (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job
 execution status data.)
 


statusDetails
Map<K,V> statusDetails

 A collection of name/value pairs that describe the status of the job execution. If not specified, the
 statusDetails are unchanged. You can specify at most 10 name/value pairs.
 








Class com.amazonaws.services.iot.model.CancelJobExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 


reasonCode
String reasonCode

 (Optional)A reason code string that explains why the job was canceled.
 


comment
String comment

 An optional comment string describing why the job was canceled.
 


force
Boolean force

 (Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise
 only job executions with status "QUEUED" are canceled. The default is false.
 
 
 Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the
 job execution status. Use caution and ensure that each device executing a job which is canceled is able to
 recover to a valid state.
 








Class com.amazonaws.services.iot.model.CancelJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobArn
String jobArn

 The job ARN.
 


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 


description
String description

 A short text description of the job.
 








Class com.amazonaws.services.iot.model.Certificate extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn

 The ARN of the certificate.
 


certificateId
String certificateId

 The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
 


status
String status

 The status of the certificate.
 
 
 The status value REGISTER_INACTIVE is deprecated and should not be used.
 


creationDate
Date creationDate

 The date and time the certificate was created.
 








Class com.amazonaws.services.iot.model.CertificateConflictException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.CertificateDescription extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn

 The ARN of the certificate.
 


certificateId
String certificateId

 The ID of the certificate.
 


caCertificateId
String caCertificateId

 The certificate ID of the CA certificate used to sign this certificate.
 


status
String status

 The status of the certificate.
 


certificatePem
String certificatePem

 The certificate data, in PEM format.
 


ownedBy
String ownedBy

 The ID of the AWS account that owns the certificate.
 


previousOwnedBy
String previousOwnedBy

 The ID of the AWS account of the previous owner of the certificate.
 


creationDate
Date creationDate

 The date and time the certificate was created.
 


lastModifiedDate
Date lastModifiedDate

 The date and time the certificate was last modified.
 


customerVersion
Integer customerVersion

 The customer version of the certificate.
 


transferData
TransferData transferData

 The transfer data.
 


generationId
String generationId

 The generation ID of the certificate.
 


validity
CertificateValidity validity

 When the certificate is valid.
 








Class com.amazonaws.services.iot.model.CertificateStateException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.CertificateValidationException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.CertificateValidity extends Object implements Serializable


Serialized Fields


notBefore
Date notBefore

 The certificate is not valid before this date.
 


notAfter
Date notAfter

 The certificate is not valid after this date.
 








Class com.amazonaws.services.iot.model.ClearDefaultAuthorizerRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.ClearDefaultAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.CloudwatchAlarmAction extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The IAM role that allows access to the CloudWatch alarm.
 


alarmName
String alarmName

 The CloudWatch alarm name.
 


stateReason
String stateReason

 The reason for the alarm change.
 


stateValue
String stateValue

 The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
 








Class com.amazonaws.services.iot.model.CloudwatchMetricAction extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The IAM role that allows access to the CloudWatch metric.
 


metricNamespace
String metricNamespace

 The CloudWatch metric namespace name.
 


metricName
String metricName

 The CloudWatch metric name.
 


metricValue
String metricValue

 The CloudWatch metric value.
 


metricUnit
String metricUnit

 The metric
 unit supported by CloudWatch.
 


metricTimestamp
String metricTimestamp

 An optional Unix timestamp.
 








Class com.amazonaws.services.iot.model.CodeSigning extends Object implements Serializable


Serialized Fields


awsSignerJobId
String awsSignerJobId

 The ID of the AWSSignerJob which was created to sign the file.
 


startSigningJobParameter
StartSigningJobParameter startSigningJobParameter

 Describes the code-signing job.
 


customCodeSigning
CustomCodeSigning customCodeSigning

 A custom method for code signing a file.
 








Class com.amazonaws.services.iot.model.CodeSigningCertificateChain extends Object implements Serializable


Serialized Fields


certificateName
String certificateName

 The name of the certificate.
 


inlineDocument
String inlineDocument

 A base64 encoded binary representation of the code signing certificate chain.
 








Class com.amazonaws.services.iot.model.CodeSigningSignature extends Object implements Serializable


Serialized Fields


inlineDocument
ByteBuffer inlineDocument

 A base64 encoded binary representation of the code signing signature.
 








Class com.amazonaws.services.iot.model.Configuration extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 True to enable the configuration.
 








Class com.amazonaws.services.iot.model.ConfirmTopicRuleDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


confirmationToken
String confirmationToken

 The token used to confirm ownership or access to the topic rule confirmation URL.
 








Class com.amazonaws.services.iot.model.ConfirmTopicRuleDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.ConflictingResourceUpdateException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.CreateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


authorizerName
String authorizerName

 The authorizer name.
 


authorizerFunctionArn
String authorizerFunctionArn

 The ARN of the authorizer's Lambda function.
 


tokenKeyName
String tokenKeyName

 The name of the token key used to extract the token from the HTTP headers.
 


tokenSigningPublicKeys
Map<K,V> tokenSigningPublicKeys

 The public keys used to verify the digital signature returned by your custom authentication service.
 


status
String status

 The status of the create authorizer request.
 


signingDisabled
Boolean signingDisabled

 Specifies whether AWS IoT validates the token signature in an authorization request.
 








Class com.amazonaws.services.iot.model.CreateAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


authorizerName
String authorizerName

 The authorizer's name.
 


authorizerArn
String authorizerArn

 The authorizer ARN.
 








Class com.amazonaws.services.iot.model.CreateBillingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


billingGroupName
String billingGroupName

 The name you wish to give to the billing group.
 


billingGroupProperties
BillingGroupProperties billingGroupProperties

 The properties of the billing group.
 


tags
List<E> tags

 Metadata which can be used to manage the billing group.
 








Class com.amazonaws.services.iot.model.CreateBillingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


billingGroupName
String billingGroupName

 The name you gave to the billing group.
 


billingGroupArn
String billingGroupArn

 The ARN of the billing group.
 


billingGroupId
String billingGroupId

 The ID of the billing group.
 








Class com.amazonaws.services.iot.model.CreateCertificateFromCsrRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateSigningRequest
String certificateSigningRequest

 The certificate signing request (CSR).
 


setAsActive
Boolean setAsActive

 Specifies whether the certificate is active.
 








Class com.amazonaws.services.iot.model.CreateCertificateFromCsrResult extends AmazonWebServiceResult<ResponseMetadata> 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.CreateDomainConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainConfigurationName
String domainConfigurationName

 The name of the domain configuration. This value must be unique to a region.
 


domainName
String domainName

 The name of the domain.
 


serverCertificateArns
List<E> serverCertificateArns

 The ARNs of the certificates that AWS IoT passes to the device during the TLS handshake. Currently you can
 specify only one certificate ARN. This value is not required for AWS-managed domains.
 


validationCertificateArn
String validationCertificateArn

 The certificate used to validate the server certificate and prove domain name ownership. This certificate must be
 signed by a public certificate authority. This value is not required for AWS-managed domains.
 


authorizerConfig
AuthorizerConfig authorizerConfig

 An object that specifies the authorization service for a domain.
 


serviceType
String serviceType

 The type of service delivered by the endpoint.
 








Class com.amazonaws.services.iot.model.CreateDomainConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainConfigurationName
String domainConfigurationName

 The name of the domain configuration.
 


domainConfigurationArn
String domainConfigurationArn

 The ARN of the domain configuration.
 








Class com.amazonaws.services.iot.model.CreateDynamicThingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The dynamic thing group name to create.
 


thingGroupProperties
ThingGroupProperties thingGroupProperties

 The dynamic thing group properties.
 


indexName
String indexName

 The dynamic thing group index name.
 
 
 
 Currently one index is supported: "AWS_Things".
 
 


queryString
String queryString

 The dynamic thing group search query string.
 
 
 See Query Syntax for
 information about query string syntax.
 


queryVersion
String queryVersion

 The dynamic thing group query version.
 
 
 
 Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this
 value.
 
 


tags
List<E> tags

 Metadata which can be used to manage the dynamic thing group.
 








Class com.amazonaws.services.iot.model.CreateDynamicThingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The dynamic thing group name.
 


thingGroupArn
String thingGroupArn

 The dynamic thing group ARN.
 


thingGroupId
String thingGroupId

 The dynamic thing group ID.
 


indexName
String indexName

 The dynamic thing group index name.
 


queryString
String queryString

 The dynamic thing group search query string.
 


queryVersion
String queryVersion

 The dynamic thing group query version.
 








Class com.amazonaws.services.iot.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters,
 "-" and "_" are valid for use here.
 


targets
List<E> targets

 A list of things and thing groups to which the job should be sent.
 


documentSource
String documentSource

 An S3 link to the job document.
 


document
String document

 The job document.
 
 
 
 If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
 
 
 The placeholder link is of the following form:
 
 
 ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
 
 
 where bucket is your bucket name and key is the object in the bucket to which you are linking.
 
 


description
String description

 A short text description of the job.
 


presignedUrlConfig
PresignedUrlConfig presignedUrlConfig

 Configuration information for pre-signed S3 URLs.
 


targetSelection
String targetSelection

 Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified
 as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is
 detected in a target. For example, a job will run on a thing when the thing is added to a target group, even
 after the job was completed by all things originally in the group.
 


jobExecutionsRolloutConfig
JobExecutionsRolloutConfig jobExecutionsRolloutConfig

 Allows you to create a staged rollout of the job.
 


abortConfig
AbortConfig abortConfig

 Allows you to create criteria to abort a job.
 


timeoutConfig
TimeoutConfig timeoutConfig

 Specifies the amount of time each device has to finish its execution of the job. The timer is started when the
 job execution status is set to IN_PROGRESS. If the job execution status is not set to another
 terminal state before the time expires, it will be automatically set to TIMED_OUT.
 


tags
List<E> tags

 Metadata which can be used to manage the job.
 








Class com.amazonaws.services.iot.model.CreateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobArn
String jobArn

 The job ARN.
 


jobId
String jobId

 The unique identifier you assigned to this job.
 


description
String description

 The job description.
 








Class com.amazonaws.services.iot.model.CreateKeysAndCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


setAsActive
Boolean setAsActive

 Specifies whether the certificate is active.
 








Class com.amazonaws.services.iot.model.CreateKeysAndCertificateResult extends AmazonWebServiceResult<ResponseMetadata> 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.CreateMitigationActionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


actionName
String actionName

 A friendly name for the action. Choose a friendly name that accurately describes the action (for example,
 EnableLoggingAction).
 


roleArn
String roleArn

 The ARN of the IAM role that is used to apply the mitigation action.
 


actionParams
MitigationActionParams actionParams

 Defines the type of action and the parameters for that action.
 


tags
List<E> tags

 Metadata that can be used to manage the mitigation action.
 








Class com.amazonaws.services.iot.model.CreateMitigationActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


actionArn
String actionArn

 The ARN for the new mitigation action.
 


actionId
String actionId

 A unique identifier for the new mitigation action.
 








Class com.amazonaws.services.iot.model.CreateOTAUpdateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


otaUpdateId
String otaUpdateId

 The ID of the OTA update to be created.
 


description
String description

 The description of the OTA update.
 


targets
List<E> targets

 The targeted devices to receive OTA updates.
 


protocols
List<E> protocols

 The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP
 and MQTT are specified, the target device can choose the protocol.
 


targetSelection
String targetSelection

 Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things
 specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing
 when a change is detected in a target. For example, an update will run on a thing when the thing is added to a
 target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS
 | SNAPSHOT.
 


awsJobExecutionsRolloutConfig
AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig

 Configuration for the rollout of OTA updates.
 


awsJobPresignedUrlConfig
AwsJobPresignedUrlConfig awsJobPresignedUrlConfig

 Configuration information for pre-signed URLs.
 


files
List<E> files

 The files to be streamed by the OTA update.
 


roleArn
String roleArn

 The IAM role that allows access to the AWS IoT Jobs service.
 


additionalParameters
Map<K,V> additionalParameters

 A list of additional OTA update parameters which are name-value pairs.
 


tags
List<E> tags

 Metadata which can be used to manage updates.
 








Class com.amazonaws.services.iot.model.CreateOTAUpdateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


otaUpdateId
String otaUpdateId

 The OTA update ID.
 


awsIotJobId
String awsIotJobId

 The AWS IoT job ID associated with the OTA update.
 


otaUpdateArn
String otaUpdateArn

 The OTA update ARN.
 


awsIotJobArn
String awsIotJobArn

 The AWS IoT job ARN associated with the OTA update.
 


otaUpdateStatus
String otaUpdateStatus

 The OTA update status.
 








Class com.amazonaws.services.iot.model.CreatePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The policy name.
 


policyDocument
String policyDocument

 The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a
 maximum length of 2048, excluding whitespace.
 








Class com.amazonaws.services.iot.model.CreatePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyName
String policyName

 The policy name.
 


policyArn
String policyArn

 The policy ARN.
 


policyDocument
String policyDocument

 The JSON document that describes the policy.
 


policyVersionId
String policyVersionId

 The policy version ID.
 








Class com.amazonaws.services.iot.model.CreatePolicyVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The policy name.
 


policyDocument
String policyDocument

 The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.
 


setAsDefault
Boolean setAsDefault

 Specifies whether the policy version is set as the default. When this parameter is true, the new policy version
 becomes the operative version (that is, the version that is in effect for the certificates to which the policy is
 attached).
 








Class com.amazonaws.services.iot.model.CreatePolicyVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyArn
String policyArn

 The policy ARN.
 


policyDocument
String policyDocument

 The JSON document that describes the policy.
 


policyVersionId
String policyVersionId

 The policy version ID.
 


isDefaultVersion
Boolean isDefaultVersion

 Specifies whether the policy version is the default.
 








Class com.amazonaws.services.iot.model.CreateProvisioningClaimRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateName
String templateName

 The name of the provisioning template to use.
 








Class com.amazonaws.services.iot.model.CreateProvisioningClaimResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificateId
String certificateId

 The ID of the certificate.
 


certificatePem
String certificatePem

 The provisioning claim certificate.
 


keyPair
KeyPair keyPair

 The provisioning claim key pair.
 


expiration
Date expiration

 The provisioning claim expiration time.
 








Class com.amazonaws.services.iot.model.CreateProvisioningTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateName
String templateName

 The name of the fleet provisioning template.
 


description
String description

 The description of the fleet provisioning template.
 


templateBody
String templateBody

 The JSON formatted contents of the fleet provisioning template.
 


enabled
Boolean enabled

 True to enable the fleet provisioning template, otherwise false.
 


provisioningRoleArn
String provisioningRoleArn

 The role ARN for the role associated with the fleet provisioning template. This IoT role grants permission to
 provision a device.
 


tags
List<E> tags

 Metadata which can be used to manage the fleet provisioning template.
 
 
 
 For URI Request parameters use format: ...key1=value1&key2=value2...
 
 
 For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
 
 
 For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
 
 








Class com.amazonaws.services.iot.model.CreateProvisioningTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


templateArn
String templateArn

 The ARN that identifies the provisioning template.
 


templateName
String templateName

 The name of the fleet provisioning template.
 


defaultVersionId
Integer defaultVersionId

 The default version of the fleet provisioning template.
 








Class com.amazonaws.services.iot.model.CreateProvisioningTemplateVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateName
String templateName

 The name of the fleet provisioning template.
 


templateBody
String templateBody

 The JSON formatted contents of the fleet provisioning template.
 


setAsDefault
Boolean setAsDefault

 Sets a fleet provision template version as the default version.
 








Class com.amazonaws.services.iot.model.CreateProvisioningTemplateVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


templateArn
String templateArn

 The ARN that identifies the provisioning template.
 


templateName
String templateName

 The name of the fleet provisioning template.
 


versionId
Integer versionId

 The version of the fleet provisioning template.
 


isDefaultVersion
Boolean isDefaultVersion

 True if the fleet provisioning template version is the default version, otherwise false.
 








Class com.amazonaws.services.iot.model.CreateRoleAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleAlias
String roleAlias

 The role alias that points to a role ARN. This allows you to change the role without having to update the device.
 


roleArn
String roleArn

 The role ARN.
 


credentialDurationSeconds
Integer credentialDurationSeconds

 How long (in seconds) the credentials will be valid.
 








Class com.amazonaws.services.iot.model.CreateRoleAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roleAlias
String roleAlias

 The role alias.
 


roleAliasArn
String roleAliasArn

 The role alias ARN.
 








Class com.amazonaws.services.iot.model.CreateScheduledAuditRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


frequency
String frequency

 How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY" or "MONTHLY". The start
 time of each audit is determined by the system.
 


dayOfMonth
String dayOfMonth

 The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is
 required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not
 have that many days, the audit takes place on the "LAST" day of the month.
 


dayOfWeek
String dayOfWeek

 The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU",
 "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
 


targetCheckNames
List<E> targetCheckNames

 Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
 DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or
 use UpdateAccountAuditConfiguration to select which checks are enabled.)
 


scheduledAuditName
String scheduledAuditName

 The name you want to give to the scheduled audit. (Max. 128 chars)
 


tags
List<E> tags

 Metadata that can be used to manage the scheduled audit.
 








Class com.amazonaws.services.iot.model.CreateScheduledAuditResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


scheduledAuditArn
String scheduledAuditArn

 The ARN of the scheduled audit.
 








Class com.amazonaws.services.iot.model.CreateSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


securityProfileName
String securityProfileName

 The name you are giving to the security profile.
 


securityProfileDescription
String securityProfileDescription

 A description of the security profile.
 


behaviors
List<E> behaviors

 Specifies the behaviors that, when violated by a device (thing), cause an alert.
 


alertTargets
Map<K,V> alertTargets

 Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are
 generated when a device (thing) violates a behavior.
 


additionalMetricsToRetain
List<E> additionalMetricsToRetain

 A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the
 profile's behaviors, but it is also retained for any metric specified here.
 


tags
List<E> tags

 Metadata that can be used to manage the security profile.
 








Class com.amazonaws.services.iot.model.CreateSecurityProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityProfileName
String securityProfileName

 The name you gave to the security profile.
 


securityProfileArn
String securityProfileArn

 The ARN of the security profile.
 








Class com.amazonaws.services.iot.model.CreateStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamId
String streamId

 The stream ID.
 


description
String description

 A description of the stream.
 


files
List<E> files

 The files to stream.
 


roleArn
String roleArn

 An IAM role that allows the IoT service principal assumes to access your S3 files.
 


tags
List<E> tags

 Metadata which can be used to manage streams.
 








Class com.amazonaws.services.iot.model.CreateStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamId
String streamId

 The stream ID.
 


streamArn
String streamArn

 The stream ARN.
 


description
String description

 A description of the stream.
 


streamVersion
Integer streamVersion

 The version of the stream.
 








Class com.amazonaws.services.iot.model.CreateThingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The thing group name to create.
 


parentGroupName
String parentGroupName

 The name of the parent thing group.
 


thingGroupProperties
ThingGroupProperties thingGroupProperties

 The thing group properties.
 


tags
List<E> tags

 Metadata which can be used to manage the thing group.
 








Class com.amazonaws.services.iot.model.CreateThingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The thing group name.
 


thingGroupArn
String thingGroupArn

 The thing group ARN.
 


thingGroupId
String thingGroupId

 The thing group ID.
 








Class com.amazonaws.services.iot.model.CreateThingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing to create.
 


thingTypeName
String thingTypeName

 The name of the thing type associated with the new thing.
 


attributePayload
AttributePayload attributePayload

 The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:
 
 
 {\"attributes\":{\"string1\":\"string2\"}}
 


billingGroupName
String billingGroupName

 The name of the billing group the thing will be added to.
 








Class com.amazonaws.services.iot.model.CreateThingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


thingName
String thingName

 The name of the new thing.
 


thingArn
String thingArn

 The ARN of the new thing.
 


thingId
String thingId

 The thing ID.
 








Class com.amazonaws.services.iot.model.CreateThingTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingTypeName
String thingTypeName

 The name of the thing type.
 


thingTypeProperties
ThingTypeProperties thingTypeProperties

 The ThingTypeProperties for the thing type to create. It contains information about the new thing type including
 a description, and a list of searchable thing attribute names.
 


tags
List<E> tags

 Metadata which can be used to manage the thing type.
 








Class com.amazonaws.services.iot.model.CreateThingTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


thingTypeName
String thingTypeName

 The name of the thing type.
 


thingTypeArn
String thingTypeArn

 The Amazon Resource Name (ARN) of the thing type.
 


thingTypeId
String thingTypeId

 The thing type ID.
 








Class com.amazonaws.services.iot.model.CreateTopicRuleDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationConfiguration
TopicRuleDestinationConfiguration destinationConfiguration

 The topic rule destination configuration.
 








Class com.amazonaws.services.iot.model.CreateTopicRuleDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


topicRuleDestination
TopicRuleDestination topicRuleDestination

 The topic rule destination.
 








Class com.amazonaws.services.iot.model.CreateTopicRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleName
String ruleName

 The name of the rule.
 


topicRulePayload
TopicRulePayload topicRulePayload

 The rule payload.
 


tags
String tags

 Metadata which can be used to manage the topic rule.
 
 
 
 For URI Request parameters use format: ...key1=value1&key2=value2...
 
 
 For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
 
 
 For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
 
 








Class com.amazonaws.services.iot.model.CreateTopicRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.CustomCodeSigning extends Object implements Serializable


Serialized Fields


signature
CodeSigningSignature signature

 The signature for the file.
 


certificateChain
CodeSigningCertificateChain certificateChain

 The certificate chain.
 


hashAlgorithm
String hashAlgorithm

 The hash algorithm used to code sign the file.
 


signatureAlgorithm
String signatureAlgorithm

 The signature algorithm used to code sign the file.
 








Class com.amazonaws.services.iot.model.DeleteAccountAuditConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deleteScheduledAudits
Boolean deleteScheduledAudits

 If true, all scheduled audits are deleted.
 








Class com.amazonaws.services.iot.model.DeleteAccountAuditConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteAuthorizerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


authorizerName
String authorizerName

 The name of the authorizer to delete.
 








Class com.amazonaws.services.iot.model.DeleteAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteBillingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


billingGroupName
String billingGroupName

 The name of the billing group.
 


expectedVersion
Long expectedVersion

 The expected version of the billing group. If the version of the billing group does not match the expected
 version specified in the request, the DeleteBillingGroup request is rejected with a
 VersionConflictException.
 








Class com.amazonaws.services.iot.model.DeleteBillingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteCACertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateId
String certificateId

 The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)
 








Class com.amazonaws.services.iot.model.DeleteCACertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateId
String certificateId

 The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
 


forceDelete
Boolean forceDelete

 Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.
 








Class com.amazonaws.services.iot.model.DeleteCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteConflictException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.DeleteDomainConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainConfigurationName
String domainConfigurationName

 The name of the domain configuration to be deleted.
 








Class com.amazonaws.services.iot.model.DeleteDomainConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteDynamicThingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The name of the dynamic thing group to delete.
 


expectedVersion
Long expectedVersion

 The expected version of the dynamic thing group to delete.
 








Class com.amazonaws.services.iot.model.DeleteDynamicThingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteJobExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The ID of the job whose execution on a particular device will be deleted.
 


thingName
String thingName

 The name of the thing whose job execution will be deleted.
 


executionNumber
Long executionNumber

 The ID of the job execution to be deleted. The executionNumber refers to the execution of a
 particular job on a particular device.
 
 
 Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you
 get and use the correct value here.
 


force
Boolean force

 (Optional) When true, you can delete a job execution which is "IN_PROGRESS". Otherwise, you can only delete a job
 execution which is in a terminal state ("SUCCEEDED", "FAILED", "REJECTED", "REMOVED" or "CANCELED") or an
 exception will occur. The default is false.
 
 
 
 Deleting a job execution which is "IN_PROGRESS", will cause the device to be unable to access job information or
 update the job execution status. Use caution and ensure that the device is able to recover to a valid state.
 
 








Class com.amazonaws.services.iot.model.DeleteJobExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The ID of the job to be deleted.
 
 
 After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not
 recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.
 


force
Boolean force

 (Optional) When true, you can delete a job which is "IN_PROGRESS". Otherwise, you can only delete a job which is
 in a terminal state ("COMPLETED" or "CANCELED") or an exception will occur. The default is false.
 
 
 
 Deleting a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to access job
 information or update the job execution status. Use caution and ensure that each device executing a job which is
 deleted is able to recover to a valid state.
 
 








Class com.amazonaws.services.iot.model.DeleteJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteMitigationActionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


actionName
String actionName

 The name of the mitigation action that you want to delete.
 








Class com.amazonaws.services.iot.model.DeleteMitigationActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteOTAUpdateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


otaUpdateId
String otaUpdateId

 The OTA update ID to delete.
 


deleteStream
Boolean deleteStream

 Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.
 


forceDeleteAWSJob
Boolean forceDeleteAWSJob

 Specifies if the AWS Job associated with the OTA update should be deleted with the OTA update is deleted.
 








Class com.amazonaws.services.iot.model.DeleteOTAUpdateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The name of the policy to delete.
 








Class com.amazonaws.services.iot.model.DeletePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeletePolicyVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The name of the policy.
 


policyVersionId
String policyVersionId

 The policy version ID.
 








Class com.amazonaws.services.iot.model.DeletePolicyVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteProvisioningTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateName
String templateName

 The name of the fleet provision template to delete.
 








Class com.amazonaws.services.iot.model.DeleteProvisioningTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteProvisioningTemplateVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateName
String templateName

 The name of the fleet provisioning template version to delete.
 


versionId
Integer versionId

 The fleet provisioning template version ID to delete.
 








Class com.amazonaws.services.iot.model.DeleteProvisioningTemplateVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteRegistrationCodeRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.DeleteRegistrationCodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteRoleAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleAlias
String roleAlias

 The role alias to delete.
 








Class com.amazonaws.services.iot.model.DeleteRoleAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteScheduledAuditRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


scheduledAuditName
String scheduledAuditName

 The name of the scheduled audit you want to delete.
 








Class com.amazonaws.services.iot.model.DeleteScheduledAuditResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


securityProfileName
String securityProfileName

 The name of the security profile to be deleted.
 


expectedVersion
Long expectedVersion

 The expected version of the security profile. A new version is generated whenever the security profile is
 updated. If you specify a value that is different from the actual version, a
 VersionConflictException is thrown.
 








Class com.amazonaws.services.iot.model.DeleteSecurityProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamId
String streamId

 The stream ID.
 








Class com.amazonaws.services.iot.model.DeleteStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteThingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The name of the thing group to delete.
 


expectedVersion
Long expectedVersion

 The expected version of the thing group to delete.
 








Class com.amazonaws.services.iot.model.DeleteThingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteThingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing to delete.
 


expectedVersion
Long expectedVersion

 The expected version of the thing record in the registry. If the version of the record in the registry does not
 match the expected version specified in the request, the DeleteThing request is rejected with a
 VersionConflictException.
 








Class com.amazonaws.services.iot.model.DeleteThingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteThingTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingTypeName
String thingTypeName

 The name of the thing type.
 








Class com.amazonaws.services.iot.model.DeleteThingTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteTopicRuleDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The ARN of the topic rule destination to delete.
 








Class com.amazonaws.services.iot.model.DeleteTopicRuleDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteTopicRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleName
String ruleName

 The name of the rule.
 








Class com.amazonaws.services.iot.model.DeleteTopicRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DeleteV2LoggingLevelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetType
String targetType

 The type of resource for which you are configuring logging. Must be THING_Group.
 


targetName
String targetName

 The name of the resource for which you are configuring logging.
 








Class com.amazonaws.services.iot.model.DeleteV2LoggingLevelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.Denied extends Object implements Serializable


Serialized Fields


implicitDeny
ImplicitDeny implicitDeny

 Information that implicitly denies the authorization. When a policy doesn't explicitly deny or allow an action on
 a resource it is considered an implicit deny.
 


explicitDeny
ExplicitDeny explicitDeny

 Information that explicitly denies the authorization.
 








Class com.amazonaws.services.iot.model.DeprecateThingTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingTypeName
String thingTypeName

 The name of the thing type to deprecate.
 


undoDeprecate
Boolean undoDeprecate

 Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and
 you can associate it with things.
 








Class com.amazonaws.services.iot.model.DeprecateThingTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DescribeAccountAuditConfigurationRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.DescribeAccountAuditConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the role that grants permission to AWS IoT to access information about your devices, policies,
 certificates, and other items as required when performing an audit.
 
 
 On the first call to UpdateAccountAuditConfiguration, this parameter is required.
 


auditNotificationTargetConfigurations
Map<K,V> auditNotificationTargetConfigurations

 Information about the targets to which audit notifications are sent for this account.
 


auditCheckConfigurations
Map<K,V> auditCheckConfigurations

 Which audit checks are enabled and disabled for this account.
 








Class com.amazonaws.services.iot.model.DescribeAuditFindingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


findingId
String findingId

 A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the
 finding.
 








Class com.amazonaws.services.iot.model.DescribeAuditFindingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


finding
AuditFinding finding








Class com.amazonaws.services.iot.model.DescribeAuditMitigationActionsTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 The unique identifier for the audit mitigation task.
 








Class com.amazonaws.services.iot.model.DescribeAuditMitigationActionsTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskStatus
String taskStatus

 The current status of the task.
 


startTime
Date startTime

 The date and time when the task was started.
 


endTime
Date endTime

 The date and time when the task was completed or canceled.
 


taskStatistics
Map<K,V> taskStatistics

 Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation
 actions task.
 


target
AuditMitigationActionsTaskTarget target

 Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task,
 or a set of findings.
 


auditCheckToActionsMapping
Map<K,V> auditCheckToActionsMapping

 Specifies the mitigation actions that should be applied to specific audit checks.
 


actionsDefinition
List<E> actionsDefinition

 Specifies the mitigation actions and their parameters that are applied as part of this task.
 








Class com.amazonaws.services.iot.model.DescribeAuditTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 The ID of the audit whose information you want to get.
 








Class com.amazonaws.services.iot.model.DescribeAuditTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskStatus
String taskStatus

 The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
 


taskType
String taskType

 The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
 


taskStartTime
Date taskStartTime

 The time the audit started.
 


taskStatistics
TaskStatistics taskStatistics

 Statistical information about the audit.
 


scheduledAuditName
String scheduledAuditName

 The name of the scheduled audit (only if the audit was a scheduled audit).
 


auditDetails
Map<K,V> auditDetails

 Detailed information about each check performed during this audit.
 








Class com.amazonaws.services.iot.model.DescribeAuthorizerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


authorizerName
String authorizerName

 The name of the authorizer to describe.
 








Class com.amazonaws.services.iot.model.DescribeAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


authorizerDescription
AuthorizerDescription authorizerDescription

 The authorizer description.
 








Class com.amazonaws.services.iot.model.DescribeBillingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


billingGroupName
String billingGroupName

 The name of the billing group.
 








Class com.amazonaws.services.iot.model.DescribeBillingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


billingGroupName
String billingGroupName

 The name of the billing group.
 


billingGroupId
String billingGroupId

 The ID of the billing group.
 


billingGroupArn
String billingGroupArn

 The ARN of the billing group.
 


version
Long version

 The version of the billing group.
 


billingGroupProperties
BillingGroupProperties billingGroupProperties

 The properties of the billing group.
 


billingGroupMetadata
BillingGroupMetadata billingGroupMetadata

 Additional information about the billing group.
 








Class com.amazonaws.services.iot.model.DescribeCACertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateId
String certificateId

 The CA certificate identifier.
 








Class com.amazonaws.services.iot.model.DescribeCACertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificateDescription
CACertificateDescription certificateDescription

 The CA certificate description.
 


registrationConfig
RegistrationConfig registrationConfig

 Information about the registration configuration.
 








Class com.amazonaws.services.iot.model.DescribeCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateId
String certificateId

 The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
 








Class com.amazonaws.services.iot.model.DescribeCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificateDescription
CertificateDescription certificateDescription

 The description of the certificate.
 








Class com.amazonaws.services.iot.model.DescribeDefaultAuthorizerRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.DescribeDefaultAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


authorizerDescription
AuthorizerDescription authorizerDescription

 The default authorizer's description.
 








Class com.amazonaws.services.iot.model.DescribeDomainConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainConfigurationName
String domainConfigurationName

 The name of the domain configuration.
 








Class com.amazonaws.services.iot.model.DescribeDomainConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainConfigurationName
String domainConfigurationName

 The name of the domain configuration.
 


domainConfigurationArn
String domainConfigurationArn

 The ARN of the domain configuration.
 


domainName
String domainName

 The name of the domain.
 


serverCertificates
List<E> serverCertificates

 A list containing summary information about the server certificate included in the domain configuration.
 


authorizerConfig
AuthorizerConfig authorizerConfig

 An object that specifies the authorization service for a domain.
 


domainConfigurationStatus
String domainConfigurationStatus

 A Boolean value that specifies the current state of the domain configuration.
 


serviceType
String serviceType

 The type of service delivered by the endpoint.
 


domainType
String domainType

 The type of the domain.
 








Class com.amazonaws.services.iot.model.DescribeEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endpointType
String endpointType

 The endpoint type. Valid endpoint types include:
 
 
 
 
 iot:Data - Returns a VeriSign signed data endpoint.
 
 
 
 
 
 
 iot:Data-ATS - Returns an ATS signed data endpoint.
 
 
 
 
 
 
 iot:CredentialProvider - Returns an AWS IoT credentials provider API endpoint.
 
 
 
 
 
 
 iot:Jobs - Returns an AWS IoT device management Jobs API endpoint.
 
 
 








Class com.amazonaws.services.iot.model.DescribeEndpointResult extends AmazonWebServiceResult<ResponseMetadata> 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.DescribeEventConfigurationsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.DescribeEventConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventConfigurations
Map<K,V> eventConfigurations

 The event configurations.
 


creationDate
Date creationDate

 The creation date of the event configuration.
 


lastModifiedDate
Date lastModifiedDate

 The date the event configurations were last modified.
 








Class com.amazonaws.services.iot.model.DescribeIndexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


indexName
String indexName

 The index name.
 








Class com.amazonaws.services.iot.model.DescribeIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


indexName
String indexName

 The index name.
 


indexStatus
String indexStatus

 The index status.
 


schema
String schema

 Contains a value that specifies the type of indexing performed. Valid values are:
 
 
 
 
 REGISTRY – Your thing index contains only registry data.
 
 
 
 
 REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.
 
 
 
 
 REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.
 
 
 
 
 REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing
 connectivity status data.
 
 
 








Class com.amazonaws.services.iot.model.DescribeJobExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 


thingName
String thingName

 The name of the thing on which the job execution is running.
 


executionNumber
Long executionNumber

 A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a
 particular device.
 








Class com.amazonaws.services.iot.model.DescribeJobExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


execution
JobExecution execution

 Information about the job execution.
 








Class com.amazonaws.services.iot.model.DescribeJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 








Class com.amazonaws.services.iot.model.DescribeJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


documentSource
String documentSource

 An S3 link to the job document.
 


job
Job job

 Information about the job.
 








Class com.amazonaws.services.iot.model.DescribeMitigationActionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


actionName
String actionName

 The friendly name that uniquely identifies the mitigation action.
 








Class com.amazonaws.services.iot.model.DescribeMitigationActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


actionName
String actionName

 The friendly name that uniquely identifies the mitigation action.
 


actionType
String actionType

 The type of mitigation action.
 


actionArn
String actionArn

 The ARN that identifies this migration action.
 


actionId
String actionId

 A unique identifier for this action.
 


roleArn
String roleArn

 The ARN of the IAM role used to apply this action.
 


actionParams
MitigationActionParams actionParams

 Parameters that control how the mitigation action is applied, specific to the type of mitigation action.
 


creationDate
Date creationDate

 The date and time when the mitigation action was added to your AWS account.
 


lastModifiedDate
Date lastModifiedDate

 The date and time when the mitigation action was last changed.
 








Class com.amazonaws.services.iot.model.DescribeProvisioningTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateName
String templateName

 The name of the fleet provisioning template.
 








Class com.amazonaws.services.iot.model.DescribeProvisioningTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


templateArn
String templateArn

 The ARN of the fleet provisioning template.
 


templateName
String templateName

 The name of the fleet provisioning template.
 


description
String description

 The description of the fleet provisioning template.
 


creationDate
Date creationDate

 The date when the fleet provisioning template was created.
 


lastModifiedDate
Date lastModifiedDate

 The date when the fleet provisioning template was last modified.
 


defaultVersionId
Integer defaultVersionId

 The default fleet template version ID.
 


templateBody
String templateBody

 The JSON formatted contents of the fleet provisioning template.
 


enabled
Boolean enabled

 True if the fleet provisioning template is enabled, otherwise false.
 


provisioningRoleArn
String provisioningRoleArn

 The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a
 device.
 








Class com.amazonaws.services.iot.model.DescribeProvisioningTemplateVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateName
String templateName

 The template name.
 


versionId
Integer versionId

 The fleet provisioning template version ID.
 








Class com.amazonaws.services.iot.model.DescribeProvisioningTemplateVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


versionId
Integer versionId

 The fleet provisioning template version ID.
 


creationDate
Date creationDate

 The date when the fleet provisioning template version was created.
 


templateBody
String templateBody

 The JSON formatted contents of the fleet provisioning template version.
 


isDefaultVersion
Boolean isDefaultVersion

 True if the fleet provisioning template version is the default version.
 








Class com.amazonaws.services.iot.model.DescribeRoleAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleAlias
String roleAlias

 The role alias to describe.
 








Class com.amazonaws.services.iot.model.DescribeRoleAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roleAliasDescription
RoleAliasDescription roleAliasDescription

 The role alias description.
 








Class com.amazonaws.services.iot.model.DescribeScheduledAuditRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


scheduledAuditName
String scheduledAuditName

 The name of the scheduled audit whose information you want to get.
 








Class com.amazonaws.services.iot.model.DescribeScheduledAuditResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


frequency
String frequency

 How often the scheduled audit takes place. One of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start time of
 each audit is determined by the system.
 


dayOfMonth
String dayOfMonth

 The day of the month on which the scheduled audit takes place. Will be "1" through "31" or "LAST". If days 29-31
 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the month.
 


dayOfWeek
String dayOfWeek

 The day of the week on which the scheduled audit takes place. One of "SUN", "MON", "TUE", "WED", "THU", "FRI", or
 "SAT".
 


targetCheckNames
List<E> targetCheckNames

 Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
 DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or
 use UpdateAccountAuditConfiguration to select which checks are enabled.)
 


scheduledAuditName
String scheduledAuditName

 The name of the scheduled audit.
 


scheduledAuditArn
String scheduledAuditArn

 The ARN of the scheduled audit.
 








Class com.amazonaws.services.iot.model.DescribeSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


securityProfileName
String securityProfileName

 The name of the security profile whose information you want to get.
 








Class com.amazonaws.services.iot.model.DescribeSecurityProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityProfileName
String securityProfileName

 The name of the security profile.
 


securityProfileArn
String securityProfileArn

 The ARN of the security profile.
 


securityProfileDescription
String securityProfileDescription

 A description of the security profile (associated with the security profile when it was created or updated).
 


behaviors
List<E> behaviors

 Specifies the behaviors that, when violated by a device (thing), cause an alert.
 


alertTargets
Map<K,V> alertTargets

 Where the alerts are sent. (Alerts are always sent to the console.)
 


additionalMetricsToRetain
List<E> additionalMetricsToRetain

 A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the
 profile's behaviors, but it is also retained for any metric specified here.
 


version
Long version

 The version of the security profile. A new version is generated whenever the security profile is updated.
 


creationDate
Date creationDate

 The time the security profile was created.
 


lastModifiedDate
Date lastModifiedDate

 The time the security profile was last modified.
 








Class com.amazonaws.services.iot.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamId
String streamId

 The stream ID.
 








Class com.amazonaws.services.iot.model.DescribeStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamInfo
StreamInfo streamInfo

 Information about the stream.
 








Class com.amazonaws.services.iot.model.DescribeThingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The name of the thing group.
 








Class com.amazonaws.services.iot.model.DescribeThingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The name of the thing group.
 


thingGroupId
String thingGroupId

 The thing group ID.
 


thingGroupArn
String thingGroupArn

 The thing group ARN.
 


version
Long version

 The version of the thing group.
 


thingGroupProperties
ThingGroupProperties thingGroupProperties

 The thing group properties.
 


thingGroupMetadata
ThingGroupMetadata thingGroupMetadata

 Thing group metadata.
 


indexName
String indexName

 The dynamic thing group index name.
 


queryString
String queryString

 The dynamic thing group search query string.
 


queryVersion
String queryVersion

 The dynamic thing group query version.
 


status
String status

 The dynamic thing group status.
 








Class com.amazonaws.services.iot.model.DescribeThingRegistrationTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 The task ID.
 








Class com.amazonaws.services.iot.model.DescribeThingRegistrationTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskId
String taskId

 The task ID.
 


creationDate
Date creationDate

 The task creation date.
 


lastModifiedDate
Date lastModifiedDate

 The date when the task was last modified.
 


templateBody
String templateBody

 The task's template.
 


inputFileBucket
String inputFileBucket

 The S3 bucket that contains the input file.
 


inputFileKey
String inputFileKey

 The input file key.
 


roleArn
String roleArn

 The role ARN that grants access to the input file bucket.
 


status
String status

 The status of the bulk thing provisioning task.
 


message
String message

 The message.
 


successCount
Integer successCount

 The number of things successfully provisioned.
 


failureCount
Integer failureCount

 The number of things that failed to be provisioned.
 


percentageProgress
Integer percentageProgress

 The progress of the bulk provisioning task expressed as a percentage.
 








Class com.amazonaws.services.iot.model.DescribeThingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing.
 








Class com.amazonaws.services.iot.model.DescribeThingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


defaultClientId
String defaultClientId

 The default client ID.
 


thingName
String thingName

 The name of the thing.
 


thingId
String thingId

 The ID of the thing to describe.
 


thingArn
String thingArn

 The ARN of the thing to describe.
 


thingTypeName
String thingTypeName

 The thing type name.
 


attributes
Map<K,V> attributes

 The thing attributes.
 


version
Long version

 The current version of the thing record in the registry.
 
 
 
 To avoid unintentional changes to the information in the registry, you can pass the version information in the
 expectedVersion parameter of the UpdateThing and DeleteThing calls.
 
 


billingGroupName
String billingGroupName

 The name of the billing group the thing belongs to.
 








Class com.amazonaws.services.iot.model.DescribeThingTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingTypeName
String thingTypeName

 The name of the thing type.
 








Class com.amazonaws.services.iot.model.DescribeThingTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


thingTypeName
String thingTypeName

 The name of the thing type.
 


thingTypeId
String thingTypeId

 The thing type ID.
 


thingTypeArn
String thingTypeArn

 The thing type ARN.
 


thingTypeProperties
ThingTypeProperties thingTypeProperties

 The ThingTypeProperties contains information about the thing type including description, and a list of searchable
 thing attribute names.
 


thingTypeMetadata
ThingTypeMetadata thingTypeMetadata

 The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a
 value indicating whether the thing type is deprecated, and a date and time when it was deprecated.
 








Class com.amazonaws.services.iot.model.Destination extends Object implements Serializable


Serialized Fields


s3Destination
S3Destination s3Destination

 Describes the location in S3 of the updated firmware.
 








Class com.amazonaws.services.iot.model.DetachPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The policy to detach.
 


target
String target

 The target from which the policy will be detached.
 








Class com.amazonaws.services.iot.model.DetachPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DetachPrincipalPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The name of the policy to detach.
 


principal
String principal

 The principal.
 
 
 If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity,
 specify the identity ID.
 








Class com.amazonaws.services.iot.model.DetachPrincipalPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DetachSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


securityProfileName
String securityProfileName

 The security profile that is detached.
 


securityProfileTargetArn
String securityProfileTargetArn

 The ARN of the thing group from which the security profile is detached.
 








Class com.amazonaws.services.iot.model.DetachSecurityProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DetachThingPrincipalRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing.
 


principal
String principal

 If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon
 Cognito identity, this value must be the ID of the Amazon Cognito identity.
 








Class com.amazonaws.services.iot.model.DetachThingPrincipalResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DisableTopicRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleName
String ruleName

 The name of the rule to disable.
 








Class com.amazonaws.services.iot.model.DisableTopicRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.DomainConfigurationSummary extends Object implements Serializable


Serialized Fields


domainConfigurationName
String domainConfigurationName

 The name of the domain configuration. This value must be unique to a region.
 


domainConfigurationArn
String domainConfigurationArn

 The ARN of the domain configuration.
 


serviceType
String serviceType

 The type of service delivered by the endpoint.
 








Class com.amazonaws.services.iot.model.DynamoDBAction extends Object implements Serializable


Serialized Fields


tableName
String tableName

 The name of the DynamoDB table.
 


roleArn
String roleArn

 The ARN of the IAM role that grants access to the DynamoDB table.
 


operation
String operation

 The type of operation to be performed. This follows the substitution template, so it can be
 ${operation}, but the substitution must result in one of the following: INSERT,
 UPDATE, or DELETE.
 


hashKeyField
String hashKeyField

 The hash key name.
 


hashKeyValue
String hashKeyValue

 The hash key value.
 


hashKeyType
String hashKeyType

 The hash key type. Valid values are "STRING" or "NUMBER"
 


rangeKeyField
String rangeKeyField

 The range key name.
 


rangeKeyValue
String rangeKeyValue

 The range key value.
 


rangeKeyType
String rangeKeyType

 The range key type. Valid values are "STRING" or "NUMBER"
 


payloadField
String payloadField

 The action payload. This name can be customized.
 








Class com.amazonaws.services.iot.model.DynamoDBv2Action extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access to the DynamoDB table.
 


putItem
PutItemInput putItem

 Specifies the DynamoDB table to which the message data will be written. For example:
 
 
 { "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }
 
 
 Each attribute in the message payload will be written to a separate column in the DynamoDB database.
 








Class com.amazonaws.services.iot.model.EffectivePolicy extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The policy name.
 


policyArn
String policyArn

 The policy ARN.
 


policyDocument
String policyDocument

 The IAM policy document.
 








Class com.amazonaws.services.iot.model.ElasticsearchAction extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The IAM role ARN that has access to Elasticsearch.
 


endpoint
String endpoint

 The endpoint of your Elasticsearch domain.
 


index
String index

 The Elasticsearch index where you want to store your data.
 


type
String type

 The type of document you are storing.
 


id
String id

 The unique identifier for the document you are storing.
 








Class com.amazonaws.services.iot.model.EnableIoTLoggingParams extends Object implements Serializable


Serialized Fields


roleArnForLogging
String roleArnForLogging

 The ARN of the IAM role used for logging.
 


logLevel
String logLevel

 Specifies the types of information to be logged.
 








Class com.amazonaws.services.iot.model.EnableTopicRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleName
String ruleName

 The name of the topic rule to enable.
 








Class com.amazonaws.services.iot.model.EnableTopicRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.ErrorInfo extends Object implements Serializable


Serialized Fields


code
String code

 The error code.
 


message
String message

 The error message.
 








Class com.amazonaws.services.iot.model.ExplicitDeny extends Object implements Serializable


Serialized Fields


policies
List<E> policies

 The policies that denied the authorization.
 








Class com.amazonaws.services.iot.model.ExponentialRolloutRate extends Object implements Serializable


Serialized Fields


baseRatePerMinute
Integer baseRatePerMinute

 The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This
 parameter allows you to define the initial rate of rollout.
 


incrementFactor
Double incrementFactor

 The exponential factor to increase the rate of rollout for a job.
 


rateIncreaseCriteria
RateIncreaseCriteria rateIncreaseCriteria

 The criteria to initiate the increase in rate of rollout for a job.
 
 
 AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).
 








Class com.amazonaws.services.iot.model.Field extends Object implements Serializable


Serialized Fields


name
String name

 The name of the field.
 


type
String type

 The datatype of the field.
 








Class com.amazonaws.services.iot.model.FileLocation extends Object implements Serializable


Serialized Fields


stream
Stream stream

 The stream that contains the OTA update.
 


s3Location
S3Location s3Location

 The location of the updated firmware in S3.
 








Class com.amazonaws.services.iot.model.FirehoseAction extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The IAM role that grants access to the Amazon Kinesis Firehose stream.
 


deliveryStreamName
String deliveryStreamName

 The delivery stream name.
 


separator
String separator

 A character separator that will be used to separate records written to the Firehose stream. Valid values are:
 '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
 








Class com.amazonaws.services.iot.model.GetCardinalityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


indexName
String indexName

 The name of the index to search.
 


queryString
String queryString

 The search query.
 


aggregationField
String aggregationField

 The field to aggregate.
 


queryVersion
String queryVersion

 The query version.
 








Class com.amazonaws.services.iot.model.GetCardinalityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cardinality
Integer cardinality

 The approximate count of unique values that match the query.
 








Class com.amazonaws.services.iot.model.GetEffectivePoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


principal
String principal

 The principal.
 


cognitoIdentityPoolId
String cognitoIdentityPoolId

 The Cognito identity pool ID.
 


thingName
String thingName

 The thing name.
 








Class com.amazonaws.services.iot.model.GetEffectivePoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


effectivePolicies
List<E> effectivePolicies

 The effective policies.
 








Class com.amazonaws.services.iot.model.GetIndexingConfigurationRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.GetIndexingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


thingIndexingConfiguration
ThingIndexingConfiguration thingIndexingConfiguration

 Thing indexing configuration.
 


thingGroupIndexingConfiguration
ThingGroupIndexingConfiguration thingGroupIndexingConfiguration

 The index configuration.
 








Class com.amazonaws.services.iot.model.GetJobDocumentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 








Class com.amazonaws.services.iot.model.GetJobDocumentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


document
String document

 The job document content.
 








Class com.amazonaws.services.iot.model.GetLoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.GetLoggingOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access.
 


logLevel
String logLevel

 The logging level.
 








Class com.amazonaws.services.iot.model.GetOTAUpdateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


otaUpdateId
String otaUpdateId

 The OTA update ID.
 








Class com.amazonaws.services.iot.model.GetOTAUpdateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


otaUpdateInfo
OTAUpdateInfo otaUpdateInfo

 The OTA update info.
 








Class com.amazonaws.services.iot.model.GetPercentilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


indexName
String indexName

 The name of the index to search.
 


queryString
String queryString

 The query string.
 


aggregationField
String aggregationField

 The field to aggregate.
 


queryVersion
String queryVersion

 The query version.
 


percents
List<E> percents

 The percentile groups returned.
 








Class com.amazonaws.services.iot.model.GetPercentilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


percentiles
List<E> percentiles

 The percentile values of the aggregated fields.
 








Class com.amazonaws.services.iot.model.GetPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The name of the policy.
 








Class com.amazonaws.services.iot.model.GetPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyName
String policyName

 The policy name.
 


policyArn
String policyArn

 The policy ARN.
 


policyDocument
String policyDocument

 The JSON document that describes the policy.
 


defaultVersionId
String defaultVersionId

 The default policy version ID.
 


creationDate
Date creationDate

 The date the policy was created.
 


lastModifiedDate
Date lastModifiedDate

 The date the policy was last modified.
 


generationId
String generationId

 The generation ID of the policy.
 








Class com.amazonaws.services.iot.model.GetPolicyVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The name of the policy.
 


policyVersionId
String policyVersionId

 The policy version ID.
 








Class com.amazonaws.services.iot.model.GetPolicyVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyArn
String policyArn

 The policy ARN.
 


policyName
String policyName

 The policy name.
 


policyDocument
String policyDocument

 The JSON document that describes the policy.
 


policyVersionId
String policyVersionId

 The policy version ID.
 


isDefaultVersion
Boolean isDefaultVersion

 Specifies whether the policy version is the default.
 


creationDate
Date creationDate

 The date the policy was created.
 


lastModifiedDate
Date lastModifiedDate

 The date the policy was last modified.
 


generationId
String generationId

 The generation ID of the policy version.
 








Class com.amazonaws.services.iot.model.GetRegistrationCodeRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.GetRegistrationCodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


registrationCode
String registrationCode

 The CA certificate registration code.
 








Class com.amazonaws.services.iot.model.GetStatisticsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


indexName
String indexName

 The name of the index to search. The default value is AWS_Things.
 


queryString
String queryString

 The query used to search. You can specify "*" for the query string to get the count of all indexed things in your
 AWS account.
 


aggregationField
String aggregationField

 The aggregation field name.
 


queryVersion
String queryVersion

 The version of the query used to search.
 








Class com.amazonaws.services.iot.model.GetStatisticsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


statistics
Statistics statistics

 The statistics returned by the Fleet Indexing service based on the query and aggregation field.
 








Class com.amazonaws.services.iot.model.GetTopicRuleDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The ARN of the topic rule destination.
 








Class com.amazonaws.services.iot.model.GetTopicRuleDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


topicRuleDestination
TopicRuleDestination topicRuleDestination

 The topic rule destination.
 








Class com.amazonaws.services.iot.model.GetTopicRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleName
String ruleName

 The name of the rule.
 








Class com.amazonaws.services.iot.model.GetTopicRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ruleArn
String ruleArn

 The rule ARN.
 


rule
TopicRule rule

 The rule.
 








Class com.amazonaws.services.iot.model.GetV2LoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.GetV2LoggingOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roleArn
String roleArn

 The IAM role ARN AWS IoT uses to write to your CloudWatch logs.
 


defaultLogLevel
String defaultLogLevel

 The default log level.
 


disableAllLogs
Boolean disableAllLogs

 Disables all logs.
 








Class com.amazonaws.services.iot.model.GroupNameAndArn extends Object implements Serializable


Serialized Fields


groupName
String groupName

 The group name.
 


groupArn
String groupArn

 The group ARN.
 








Class com.amazonaws.services.iot.model.HttpAction extends Object implements Serializable


Serialized Fields


url
String url

 The endpoint URL. If substitution templates are used in the URL, you must also specify a
 confirmationUrl. If this is a new destination, a new TopicRuleDestination is created if
 possible.
 


confirmationUrl
String confirmationUrl

 The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the
 endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If
 you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that
 match each possible value of the substituion template before traffic is allowed to your endpoint URL.
 


headers
List<E> headers

 The HTTP headers to send with the message data.
 


auth
HttpAuthorization auth

 The authentication method to use when sending data to an HTTPS endpoint.
 








Class com.amazonaws.services.iot.model.HttpActionHeader extends Object implements Serializable


Serialized Fields


key
String key

 The HTTP header key.
 


value
String value

 The HTTP header value. Substitution templates are supported.
 








Class com.amazonaws.services.iot.model.HttpAuthorization extends Object implements Serializable


Serialized Fields


sigv4
SigV4Authorization sigv4

 Use Sig V4 authorization. For more information, see Signature Version 4 Signing
 Process.
 








Class com.amazonaws.services.iot.model.HttpContext extends Object implements Serializable


Serialized Fields


headers
Map<K,V> headers

 The header keys and values in an HTTP authorization request.
 


queryString
String queryString

 The query string keys and values in an HTTP authorization request.
 








Class com.amazonaws.services.iot.model.HttpUrlDestinationConfiguration extends Object implements Serializable


Serialized Fields


confirmationUrl
String confirmationUrl

 The URL AWS IoT uses to confirm ownership of or access to the topic rule destination URL.
 








Class com.amazonaws.services.iot.model.HttpUrlDestinationProperties extends Object implements Serializable


Serialized Fields


confirmationUrl
String confirmationUrl

 The URL used to confirm the HTTP topic rule destination URL.
 








Class com.amazonaws.services.iot.model.HttpUrlDestinationSummary extends Object implements Serializable


Serialized Fields


confirmationUrl
String confirmationUrl

 The URL used to confirm ownership of or access to the HTTP topic rule destination URL.
 








Class com.amazonaws.services.iot.model.ImplicitDeny extends Object implements Serializable


Serialized Fields


policies
List<E> policies

 Policies that don't contain a matching allow or deny statement for the specified action on the specified
 resource.
 








Class com.amazonaws.services.iot.model.IndexNotReadyException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.InternalException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.InternalFailureException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.InvalidAggregationException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.InvalidQueryException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.InvalidRequestException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.InvalidResponseException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.InvalidStateTransitionException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.IotAnalyticsAction extends Object implements Serializable


Serialized Fields


channelArn
String channelArn

 (deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
 


channelName
String channelName

 The name of the IoT Analytics channel to which message data will be sent.
 


roleArn
String roleArn

 The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT
 Analytics (iotanalytics:BatchPutMessage).
 








Class com.amazonaws.services.iot.model.IotEventsAction extends Object implements Serializable


Serialized Fields


inputName
String inputName

 The name of the AWS IoT Events input.
 


messageId
String messageId

 [Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS
 IoT Events detector.
 


roleArn
String roleArn

 The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector.
 ("Action":"iotevents:BatchPutMessage").
 








Class com.amazonaws.services.iot.model.IotSiteWiseAction extends Object implements Serializable


Serialized Fields


putAssetPropertyValueEntries
List<E> putAssetPropertyValueEntries

 A list of asset property value entries.
 


roleArn
String roleArn

 The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoTSiteWise. (
 "Action": "iotsitewise:BatchPutAssetPropertyValue"). The trust policy can restrict access to
 specific asset hierarchy paths.
 








Class com.amazonaws.services.iot.model.Job extends Object implements Serializable


Serialized Fields


jobArn
String jobArn

 An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
 


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 


targetSelection
String targetSelection

 Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified
 as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is
 detected in a target. For example, a job will run on a device when the thing representing the device is added to
 a target group, even after the job was completed by all things originally in the group.
 


status
String status

 The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS
 or COMPLETED.
 


forceCanceled
Boolean forceCanceled

 Will be true if the job was canceled with the optional force parameter set to
 true.
 


reasonCode
String reasonCode

 If the job was updated, provides the reason code for the update.
 


comment
String comment

 If the job was updated, describes the reason for the update.
 


targets
List<E> targets

 A list of IoT things and thing groups to which the job should be sent.
 


description
String description

 A short text description of the job.
 


presignedUrlConfig
PresignedUrlConfig presignedUrlConfig

 Configuration for pre-signed S3 URLs.
 


jobExecutionsRolloutConfig
JobExecutionsRolloutConfig jobExecutionsRolloutConfig

 Allows you to create a staged rollout of a job.
 


abortConfig
AbortConfig abortConfig

 Configuration for criteria to abort the job.
 


createdAt
Date createdAt

 The time, in seconds since the epoch, when the job was created.
 


lastUpdatedAt
Date lastUpdatedAt

 The time, in seconds since the epoch, when the job was last updated.
 


completedAt
Date completedAt

 The time, in seconds since the epoch, when the job was completed.
 


jobProcessDetails
JobProcessDetails jobProcessDetails

 Details about the job process.
 


timeoutConfig
TimeoutConfig timeoutConfig

 Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job
 execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal
 state before the timer expires, it will be automatically set to TIMED_OUT.
 








Class com.amazonaws.services.iot.model.JobExecution extends Object implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier you assigned to the job when it was created.
 


status
String status

 The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
 


forceCanceled
Boolean forceCanceled

 Will be true if the job execution was canceled with the optional force parameter set to
 true.
 


statusDetails
JobExecutionStatusDetails statusDetails

 A collection of name/value pairs that describe the status of the job execution.
 


thingArn
String thingArn

 The ARN of the thing on which the job execution is running.
 


queuedAt
Date queuedAt

 The time, in seconds since the epoch, when the job execution was queued.
 


startedAt
Date startedAt

 The time, in seconds since the epoch, when the job execution started.
 


lastUpdatedAt
Date lastUpdatedAt

 The time, in seconds since the epoch, when the job execution was last updated.
 


executionNumber
Long executionNumber

 A string (consisting of the digits "0" through "9") which identifies this particular job execution on this
 particular device. It can be used in commands which return or update job execution information.
 


versionNumber
Long versionNumber

 The version of the job execution. Job execution versions are incremented each time they are updated by a device.
 


approximateSecondsBeforeTimedOut
Long approximateSecondsBeforeTimedOut

 The estimated number of seconds that remain before the job execution status will be changed to
 TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes).
 The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will
 not be included if the job execution has reached a terminal status.
 








Class com.amazonaws.services.iot.model.JobExecutionsRolloutConfig extends Object implements Serializable


Serialized Fields


maximumPerMinute
Integer maximumPerMinute

 The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to
 create a staged rollout.
 


exponentialRate
ExponentialRolloutRate exponentialRate

 The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job
 rollout.
 








Class com.amazonaws.services.iot.model.JobExecutionStatusDetails extends Object implements Serializable


Serialized Fields


detailsMap
Map<K,V> detailsMap

 The job execution status.
 








Class com.amazonaws.services.iot.model.JobExecutionSummary extends Object implements Serializable


Serialized Fields


status
String status

 The status of the job execution.
 


queuedAt
Date queuedAt

 The time, in seconds since the epoch, when the job execution was queued.
 


startedAt
Date startedAt

 The time, in seconds since the epoch, when the job execution started.
 


lastUpdatedAt
Date lastUpdatedAt

 The time, in seconds since the epoch, when the job execution was last updated.
 


executionNumber
Long executionNumber

 A string (consisting of the digits "0" through "9") which identifies this particular job execution on this
 particular device. It can be used later in commands which return or update job execution information.
 








Class com.amazonaws.services.iot.model.JobExecutionSummaryForJob extends Object implements Serializable


Serialized Fields


thingArn
String thingArn

 The ARN of the thing on which the job execution is running.
 


jobExecutionSummary
JobExecutionSummary jobExecutionSummary

 Contains a subset of information about a job execution.
 








Class com.amazonaws.services.iot.model.JobExecutionSummaryForThing extends Object implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 


jobExecutionSummary
JobExecutionSummary jobExecutionSummary

 Contains a subset of information about a job execution.
 








Class com.amazonaws.services.iot.model.JobProcessDetails extends Object implements Serializable


Serialized Fields


processingTargets
List<E> processingTargets

 The target devices to which the job execution is being rolled out. This value will be null after the job
 execution has finished rolling out to all the target devices.
 


numberOfCanceledThings
Integer numberOfCanceledThings

 The number of things that cancelled the job.
 


numberOfSucceededThings
Integer numberOfSucceededThings

 The number of things which successfully completed the job.
 


numberOfFailedThings
Integer numberOfFailedThings

 The number of things that failed executing the job.
 


numberOfRejectedThings
Integer numberOfRejectedThings

 The number of things that rejected the job.
 


numberOfQueuedThings
Integer numberOfQueuedThings

 The number of things that are awaiting execution of the job.
 


numberOfInProgressThings
Integer numberOfInProgressThings

 The number of things currently executing the job.
 


numberOfRemovedThings
Integer numberOfRemovedThings

 The number of things that are no longer scheduled to execute the job because they have been deleted or have been
 removed from the group that was a target of the job.
 


numberOfTimedOutThings
Integer numberOfTimedOutThings

 The number of things whose job execution status is TIMED_OUT.
 








Class com.amazonaws.services.iot.model.JobSummary extends Object implements Serializable


Serialized Fields


jobArn
String jobArn

 The job ARN.
 


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 


thingGroupId
String thingGroupId

 The ID of the thing group.
 


targetSelection
String targetSelection

 Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified
 as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is
 detected in a target. For example, a job will run on a thing when the thing is added to a target group, even
 after the job was completed by all things originally in the group.
 


status
String status

 The job summary status.
 


createdAt
Date createdAt

 The time, in seconds since the epoch, when the job was created.
 


lastUpdatedAt
Date lastUpdatedAt

 The time, in seconds since the epoch, when the job was last updated.
 


completedAt
Date completedAt

 The time, in seconds since the epoch, when the job completed.
 








Class com.amazonaws.services.iot.model.KeyPair extends Object implements Serializable


Serialized Fields


publicKey
String publicKey

 The public key.
 


privateKey
String privateKey

 The private key.
 








Class com.amazonaws.services.iot.model.KinesisAction extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access to the Amazon Kinesis stream.
 


streamName
String streamName

 The name of the Amazon Kinesis stream.
 


partitionKey
String partitionKey

 The partition key.
 








Class com.amazonaws.services.iot.model.LambdaAction extends Object implements Serializable


Serialized Fields


functionArn
String functionArn

 The ARN of the Lambda function.
 








Class com.amazonaws.services.iot.model.LimitExceededException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.ListActiveViolationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing whose active violations are listed.
 


securityProfileName
String securityProfileName

 The name of the Device Defender security profile for which violations are listed.
 


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.iot.model.ListActiveViolationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


activeViolations
List<E> activeViolations

 The list of active violations.
 


nextToken
String nextToken

 A token that can be used to retrieve the next set of results, or null if there are no additional
 results.
 








Class com.amazonaws.services.iot.model.ListAttachedPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


target
String target

 The group or principal for which the policies will be listed.
 


recursive
Boolean recursive

 When true, recursively list attached policies.
 


marker
String marker

 The token to retrieve the next set of results.
 


pageSize
Integer pageSize

 The maximum number of results to be returned per request.
 








Class com.amazonaws.services.iot.model.ListAttachedPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policies
List<E> policies

 The policies.
 


nextMarker
String nextMarker

 The token to retrieve the next set of results, or ``null`` if there are no more results.
 








Class com.amazonaws.services.iot.model.ListAuditFindingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime
 and endTime, but not both.
 


checkName
String checkName

 A filter to limit results to the findings for the specified audit check.
 


resourceIdentifier
ResourceIdentifier resourceIdentifier

 Information identifying the noncompliant resource.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time. The default is 25.
 


nextToken
String nextToken

 The token for the next set of results.
 


startTime
Date startTime

 A filter to limit results to those found after the specified time. You must specify either the startTime and
 endTime or the taskId, but not both.
 


endTime
Date endTime

 A filter to limit results to those found before the specified time. You must specify either the startTime and
 endTime or the taskId, but not both.
 








Class com.amazonaws.services.iot.model.ListAuditFindingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


findings
List<E> findings

 The findings (results) of the audit.
 


nextToken
String nextToken

 A token that can be used to retrieve the next set of results, or null if there are no additional
 results.
 








Class com.amazonaws.services.iot.model.ListAuditMitigationActionsExecutionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 Specify this filter to limit results to actions for a specific audit mitigation actions task.
 


actionStatus
String actionStatus

 Specify this filter to limit results to those with a specific status.
 


findingId
String findingId

 Specify this filter to limit results to those that were applied to a specific audit finding.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time. The default is 25.
 


nextToken
String nextToken

 The token for the next set of results.
 








Class com.amazonaws.services.iot.model.ListAuditMitigationActionsExecutionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


actionsExecutions
List<E> actionsExecutions

 A set of task execution results based on the input parameters. Details include the mitigation action applied,
 start time, and task status.
 


nextToken
String nextToken

 The token for the next set of results.
 








Class com.amazonaws.services.iot.model.ListAuditMitigationActionsTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


auditTaskId
String auditTaskId

 Specify this filter to limit results to tasks that were applied to results for a specific audit.
 


findingId
String findingId

 Specify this filter to limit results to tasks that were applied to a specific audit finding.
 


taskStatus
String taskStatus

 Specify this filter to limit results to tasks that are in a specific state.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time. The default is 25.
 


nextToken
String nextToken

 The token for the next set of results.
 


startTime
Date startTime

 Specify this filter to limit results to tasks that began on or after a specific date and time.
 


endTime
Date endTime

 Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and
 time.
 








Class com.amazonaws.services.iot.model.ListAuditMitigationActionsTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tasks
List<E> tasks

 The collection of audit mitigation tasks that matched the filter criteria.
 


nextToken
String nextToken

 The token for the next set of results.
 








Class com.amazonaws.services.iot.model.ListAuditTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


startTime
Date startTime

 The beginning of the time period. Audit information is retained for a limited time (180 days). Requesting a start
 time prior to what is retained results in an "InvalidRequestException".
 


endTime
Date endTime

 The end of the time period.
 


taskType
String taskType

 A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or
 "SCHEDULED__AUDIT_TASK".
 


taskStatus
String taskStatus

 A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS",
 "COMPLETED", "FAILED", or "CANCELED".
 


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time. The default is 25.
 








Class com.amazonaws.services.iot.model.ListAuditTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tasks
List<E> tasks

 The audits that were performed during the specified time period.
 


nextToken
String nextToken

 A token that can be used to retrieve the next set of results, or null if there are no additional
 results.
 








Class com.amazonaws.services.iot.model.ListAuthorizersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageSize
Integer pageSize

 The maximum number of results to return at one time.
 


marker
String marker

 A marker used to get the next set of results.
 


ascendingOrder
Boolean ascendingOrder

 Return the list of authorizers in ascending alphabetical order.
 


status
String status

 The status of the list authorizers request.
 








Class com.amazonaws.services.iot.model.ListAuthorizersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


authorizers
List<E> authorizers

 The authorizers.
 


nextMarker
String nextMarker

 A marker used to get the next set of results.
 








Class com.amazonaws.services.iot.model.ListBillingGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return per request.
 


namePrefixFilter
String namePrefixFilter

 Limit the results to billing groups whose names have the given prefix.
 








Class com.amazonaws.services.iot.model.ListBillingGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


billingGroups
List<E> billingGroups

 The list of billing groups.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListCACertificatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageSize
Integer pageSize

 The result page size.
 


marker
String marker

 The marker for the next set of results.
 


ascendingOrder
Boolean ascendingOrder

 Determines the order of the results.
 








Class com.amazonaws.services.iot.model.ListCACertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificates
List<E> 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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


caCertificateId
String caCertificateId

 The ID of the CA certificate. This operation will list all registered device certificate that were signed by this
 CA certificate.
 


pageSize
Integer pageSize

 The result page size.
 


marker
String marker

 The marker for the next set of results.
 


ascendingOrder
Boolean ascendingOrder

 Specifies the order for results. If True, the results are returned in ascending order, based on the creation
 date.
 








Class com.amazonaws.services.iot.model.ListCertificatesByCAResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificates
List<E> 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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageSize
Integer pageSize

 The result page size.
 


marker
String marker

 The marker for the next set of results.
 


ascendingOrder
Boolean ascendingOrder

 Specifies the order for results. If True, the results are returned in ascending order, based on the creation
 date.
 








Class com.amazonaws.services.iot.model.ListCertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificates
List<E> certificates

 The descriptions of the certificates.
 


nextMarker
String nextMarker

 The marker for the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListDomainConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


marker
String marker

 The marker for the next set of results.
 


pageSize
Integer pageSize

 The result page size.
 


serviceType
String serviceType

 The type of service delivered by the endpoint.
 








Class com.amazonaws.services.iot.model.ListDomainConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainConfigurations
List<E> domainConfigurations

 A list of objects that contain summary information about the user's domain configurations.
 


nextMarker
String nextMarker

 The marker for the next set of results.
 








Class com.amazonaws.services.iot.model.ListIndicesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.iot.model.ListIndicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


indexNames
List<E> indexNames

 The index names.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListJobExecutionsForJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 


status
String status

 The status of the job.
 


maxResults
Integer maxResults

 The maximum number of results to be returned per request.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 








Class com.amazonaws.services.iot.model.ListJobExecutionsForJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


executionSummaries
List<E> executionSummaries

 A list of job execution summaries.
 


nextToken
String nextToken

 The token for the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListJobExecutionsForThingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The thing name.
 


status
String status

 An optional filter that lets you search for jobs that have the specified status.
 


maxResults
Integer maxResults

 The maximum number of results to be returned per request.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 








Class com.amazonaws.services.iot.model.ListJobExecutionsForThingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


executionSummaries
List<E> executionSummaries

 A list of job execution summaries.
 


nextToken
String nextToken

 The token for the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


status
String status

 An optional filter that lets you search for jobs that have the specified status.
 


targetSelection
String targetSelection

 Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified
 as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is
 detected in a target. For example, a job will run on a thing when the thing is added to a target group, even
 after the job was completed by all things originally in the group.
 


maxResults
Integer maxResults

 The maximum number of results to return per request.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 


thingGroupName
String thingGroupName

 A filter that limits the returned jobs to those for the specified group.
 


thingGroupId
String thingGroupId

 A filter that limits the returned jobs to those for the specified group.
 








Class com.amazonaws.services.iot.model.ListJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobs
List<E> jobs

 A list of jobs.
 


nextToken
String nextToken

 The token for the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListMitigationActionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


actionType
String actionType

 Specify a value to limit the result to mitigation actions with a specific action type.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time. The default is 25.
 


nextToken
String nextToken

 The token for the next set of results.
 








Class com.amazonaws.services.iot.model.ListMitigationActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


actionIdentifiers
List<E> actionIdentifiers

 A set of actions that matched the specified filter criteria.
 


nextToken
String nextToken

 The token for the next set of results.
 








Class com.amazonaws.services.iot.model.ListOTAUpdatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 


nextToken
String nextToken

 A token used to retrieve the next set of results.
 


otaUpdateStatus
String otaUpdateStatus

 The OTA update job status.
 








Class com.amazonaws.services.iot.model.ListOTAUpdatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


otaUpdates
List<E> otaUpdates

 A list of OTA update jobs.
 


nextToken
String nextToken

 A token to use to get the next set of results.
 








Class com.amazonaws.services.iot.model.ListOutgoingCertificatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageSize
Integer pageSize

 The result page size.
 


marker
String marker

 The marker for the next set of results.
 


ascendingOrder
Boolean ascendingOrder

 Specifies the order for results. If True, the results are returned in ascending order, based on the creation
 date.
 








Class com.amazonaws.services.iot.model.ListOutgoingCertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


outgoingCertificates
List<E> outgoingCertificates

 The certificates that are being transferred but not yet accepted.
 


nextMarker
String nextMarker

 The marker for the next set of results.
 








Class com.amazonaws.services.iot.model.ListPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


marker
String marker

 The marker for the next set of results.
 


pageSize
Integer pageSize

 The result page size.
 


ascendingOrder
Boolean ascendingOrder

 Specifies the order for results. If true, the results are returned in ascending creation order.
 








Class com.amazonaws.services.iot.model.ListPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policies
List<E> policies

 The descriptions of the policies.
 


nextMarker
String nextMarker

 The marker for the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListPolicyPrincipalsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The policy name.
 


marker
String marker

 The marker for the next set of results.
 


pageSize
Integer pageSize

 The result page size.
 


ascendingOrder
Boolean ascendingOrder

 Specifies the order for results. If true, the results are returned in ascending creation order.
 








Class com.amazonaws.services.iot.model.ListPolicyPrincipalsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


principals
List<E> principals

 The descriptions of the principals.
 


nextMarker
String nextMarker

 The marker for the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListPolicyVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The policy name.
 








Class com.amazonaws.services.iot.model.ListPolicyVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyVersions
List<E> policyVersions

 The policy versions.
 








Class com.amazonaws.services.iot.model.ListPrincipalPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


principal
String principal

 The principal.
 


marker
String marker

 The marker for the next set of results.
 


pageSize
Integer pageSize

 The result page size.
 


ascendingOrder
Boolean ascendingOrder

 Specifies the order for results. If true, results are returned in ascending creation order.
 








Class com.amazonaws.services.iot.model.ListPrincipalPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policies
List<E> policies

 The policies.
 


nextMarker
String nextMarker

 The marker for the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListPrincipalThingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in this operation.
 


principal
String principal

 The principal.
 








Class com.amazonaws.services.iot.model.ListPrincipalThingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


things
List<E> things

 The things.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListProvisioningTemplatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 


nextToken
String nextToken

 A token to retrieve the next set of results.
 








Class com.amazonaws.services.iot.model.ListProvisioningTemplatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


templates
List<E> templates

 A list of fleet provisioning templates
 


nextToken
String nextToken

 A token to retrieve the next set of results.
 








Class com.amazonaws.services.iot.model.ListProvisioningTemplateVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateName
String templateName

 The name of the fleet provisioning template.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 


nextToken
String nextToken

 A token to retrieve the next set of results.
 








Class com.amazonaws.services.iot.model.ListProvisioningTemplateVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


versions
List<E> versions

 The list of fleet provisioning template versions.
 


nextToken
String nextToken

 A token to retrieve the next set of results.
 








Class com.amazonaws.services.iot.model.ListRoleAliasesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageSize
Integer pageSize

 The maximum number of results to return at one time.
 


marker
String marker

 A marker used to get the next set of results.
 


ascendingOrder
Boolean ascendingOrder

 Return the list of role aliases in ascending alphabetical order.
 








Class com.amazonaws.services.iot.model.ListRoleAliasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roleAliases
List<E> roleAliases

 The role aliases.
 


nextMarker
String nextMarker

 A marker used to get the next set of results.
 








Class com.amazonaws.services.iot.model.ListScheduledAuditsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time. The default is 25.
 








Class com.amazonaws.services.iot.model.ListScheduledAuditsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


scheduledAudits
List<E> scheduledAudits

 The list of scheduled audits.
 


nextToken
String nextToken

 A token that can be used to retrieve the next set of results, or null if there are no additional
 results.
 








Class com.amazonaws.services.iot.model.ListSecurityProfilesForTargetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 


recursive
Boolean recursive

 If true, return child groups too.
 


securityProfileTargetArn
String securityProfileTargetArn

 The ARN of the target (thing group) whose attached security profiles you want to get.
 








Class com.amazonaws.services.iot.model.ListSecurityProfilesForTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityProfileTargetMappings
List<E> securityProfileTargetMappings

 A list of security profiles and their associated targets.
 


nextToken
String nextToken

 A token that can be used to retrieve the next set of results, or null if there are no additional
 results.
 








Class com.amazonaws.services.iot.model.ListSecurityProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.iot.model.ListSecurityProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityProfileIdentifiers
List<E> securityProfileIdentifiers

 A list of security profile identifiers (names and ARNs).
 


nextToken
String nextToken

 A token that can be used to retrieve the next set of results, or null if there are no additional
 results.
 








Class com.amazonaws.services.iot.model.ListStreamsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results to return at a time.
 


nextToken
String nextToken

 A token used to get the next set of results.
 


ascendingOrder
Boolean ascendingOrder

 Set to true to return the list of streams in ascending order.
 








Class com.amazonaws.services.iot.model.ListStreamsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streams
List<E> streams

 A list of streams.
 


nextToken
String nextToken

 A token used to get the next set of results.
 








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


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 








Class com.amazonaws.services.iot.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The list of tags assigned to the resource.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListTargetsForPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The policy name.
 


marker
String marker

 A marker used to get the next set of results.
 


pageSize
Integer pageSize

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.iot.model.ListTargetsForPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


targets
List<E> targets

 The policy targets.
 


nextMarker
String nextMarker

 A marker used to get the next set of results.
 








Class com.amazonaws.services.iot.model.ListTargetsForSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


securityProfileName
String securityProfileName

 The security profile.
 


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.iot.model.ListTargetsForSecurityProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityProfileTargets
List<E> securityProfileTargets

 The thing groups to which the security profile is attached.
 


nextToken
String nextToken

 A token that can be used to retrieve the next set of results, or null if there are no additional
 results.
 








Class com.amazonaws.services.iot.model.ListThingGroupsForThingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The thing name.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.iot.model.ListThingGroupsForThingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


thingGroups
List<E> thingGroups

 The thing groups.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListThingGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 


parentGroup
String parentGroup

 A filter that limits the results to those with the specified parent group.
 


namePrefixFilter
String namePrefixFilter

 A filter that limits the results to those with the specified name prefix.
 


recursive
Boolean recursive

 If true, return child groups as well.
 








Class com.amazonaws.services.iot.model.ListThingGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


thingGroups
List<E> thingGroups

 The thing groups.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListThingPrincipalsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing.
 








Class com.amazonaws.services.iot.model.ListThingPrincipalsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


principals
List<E> principals

 The principals associated with the thing.
 








Class com.amazonaws.services.iot.model.ListThingRegistrationTaskReportsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 The id of the task.
 


reportType
String reportType

 The type of task report.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return per request.
 








Class com.amazonaws.services.iot.model.ListThingRegistrationTaskReportsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceLinks
List<E> resourceLinks

 Links to the task resources.
 


reportType
String reportType

 The type of task report.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListThingRegistrationTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 


status
String status

 The status of the bulk thing provisioning task.
 








Class com.amazonaws.services.iot.model.ListThingRegistrationTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskIds
List<E> taskIds

 A list of bulk thing provisioning task IDs.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListThingsInBillingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


billingGroupName
String billingGroupName

 The name of the billing group.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return per request.
 








Class com.amazonaws.services.iot.model.ListThingsInBillingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


things
List<E> things

 A list of things in the billing group.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListThingsInThingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The thing group name.
 


recursive
Boolean recursive

 When true, list things in this thing group and in all child groups as well.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.iot.model.ListThingsInThingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


things
List<E> things

 The things in the specified thing group.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListThingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in this operation.
 


attributeName
String attributeName

 The attribute name used to search for things.
 


attributeValue
String attributeValue

 The attribute value used to search for things.
 


thingTypeName
String thingTypeName

 The name of the thing type used to search for things.
 








Class com.amazonaws.services.iot.model.ListThingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


things
List<E> things

 The things.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListThingTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in this operation.
 


thingTypeName
String thingTypeName

 The name of the thing type.
 








Class com.amazonaws.services.iot.model.ListThingTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


thingTypes
List<E> thingTypes

 The thing types.
 


nextToken
String nextToken

 The token for the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListTopicRuleDestinationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 








Class com.amazonaws.services.iot.model.ListTopicRuleDestinationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


destinationSummaries
List<E> destinationSummaries

 Information about a topic rule destination.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 








Class com.amazonaws.services.iot.model.ListTopicRulesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


topic
String topic

 The topic.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 


nextToken
String nextToken

 A token used to retrieve the next value.
 


ruleDisabled
Boolean ruleDisabled

 Specifies whether the rule is disabled.
 








Class com.amazonaws.services.iot.model.ListTopicRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rules
List<E> rules

 The rules.
 


nextToken
String nextToken

 A token used to retrieve the next value.
 








Class com.amazonaws.services.iot.model.ListV2LoggingLevelsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetType
String targetType

 The type of resource for which you are configuring logging. Must be THING_Group.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.iot.model.ListV2LoggingLevelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


logTargetConfigurations
List<E> logTargetConfigurations

 The logging configuration for a target.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iot.model.ListViolationEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


startTime
Date startTime

 The start time for the alerts to be listed.
 


endTime
Date endTime

 The end time for the alerts to be listed.
 


thingName
String thingName

 A filter to limit results to those alerts caused by the specified thing.
 


securityProfileName
String securityProfileName

 A filter to limit results to those alerts generated by the specified security profile.
 


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.iot.model.ListViolationEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


violationEvents
List<E> violationEvents

 The security profile violation alerts issued for this account during the given time period, potentially filtered
 by security profile, behavior violated, or thing (device) violating.
 


nextToken
String nextToken

 A token that can be used to retrieve the next set of results, or null if there are no additional
 results.
 








Class com.amazonaws.services.iot.model.LoggingOptionsPayload extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access.
 


logLevel
String logLevel

 The log level.
 








Class com.amazonaws.services.iot.model.LogTarget extends Object implements Serializable


Serialized Fields


targetType
String targetType

 The target type.
 


targetName
String targetName

 The target name.
 








Class com.amazonaws.services.iot.model.LogTargetConfiguration extends Object implements Serializable


Serialized Fields


logTarget
LogTarget logTarget

 A log target
 


logLevel
String logLevel

 The logging level.
 








Class com.amazonaws.services.iot.model.MalformedPolicyException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.MetricValue extends Object implements Serializable


Serialized Fields


count
Long count

 If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be
 compared with the metric.
 


cidrs
List<E> cidrs

 If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with
 the metric.
 


ports
List<E> ports

 If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with
 the metric.
 








Class com.amazonaws.services.iot.model.MitigationAction extends Object implements Serializable


Serialized Fields


name
String name

 A user-friendly name for the mitigation action.
 


id
String id

 A unique identifier for the mitigation action.
 


roleArn
String roleArn

 The IAM role ARN used to apply this mitigation action.
 


actionParams
MitigationActionParams actionParams

 The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.
 








Class com.amazonaws.services.iot.model.MitigationActionIdentifier extends Object implements Serializable


Serialized Fields


actionName
String actionName

 The friendly name of the mitigation action.
 


actionArn
String actionArn

 The IAM role ARN used to apply this mitigation action.
 


creationDate
Date creationDate

 The date when this mitigation action was created.
 








Class com.amazonaws.services.iot.model.MitigationActionParams extends Object implements Serializable


Serialized Fields


updateDeviceCertificateParams
UpdateDeviceCertificateParams updateDeviceCertificateParams

 Parameters to define a mitigation action that changes the state of the device certificate to inactive.
 


updateCACertificateParams
UpdateCACertificateParams updateCACertificateParams

 Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
 


addThingsToThingGroupParams
AddThingsToThingGroupParams addThingsToThingGroupParams

 Parameters to define a mitigation action that moves devices associated with a certificate to one or more
 specified thing groups, typically for quarantine.
 


replaceDefaultPolicyVersionParams
ReplaceDefaultPolicyVersionParams replaceDefaultPolicyVersionParams

 Parameters to define a mitigation action that adds a blank policy to restrict permissions.
 


enableIoTLoggingParams
EnableIoTLoggingParams enableIoTLoggingParams

 Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.
 


publishFindingToSnsParams
PublishFindingToSnsParams publishFindingToSnsParams

 Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom
 actions in response to the Amazon SNS messages.
 








Class com.amazonaws.services.iot.model.MqttContext extends Object implements Serializable


Serialized Fields


username
String username

 The value of the username key in an MQTT authorization request.
 


password
ByteBuffer password

 The value of the password key in an MQTT authorization request.
 


clientId
String clientId

 The value of the clientId key in an MQTT authorization request.
 








Class com.amazonaws.services.iot.model.NonCompliantResource extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of the noncompliant resource.
 


resourceIdentifier
ResourceIdentifier resourceIdentifier

 Information that identifies the noncompliant resource.
 


additionalInfo
Map<K,V> additionalInfo

 Other information about the noncompliant resource.
 








Class com.amazonaws.services.iot.model.NotConfiguredException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.OTAUpdateFile extends Object implements Serializable


Serialized Fields


fileName
String fileName

 The name of the file.
 


fileVersion
String fileVersion

 The file version.
 


fileLocation
FileLocation fileLocation

 The location of the updated firmware.
 


codeSigning
CodeSigning codeSigning

 The code signing method of the file.
 


attributes
Map<K,V> attributes

 A list of name/attribute pairs.
 








Class com.amazonaws.services.iot.model.OTAUpdateInfo extends Object implements Serializable


Serialized Fields


otaUpdateId
String otaUpdateId

 The OTA update ID.
 


otaUpdateArn
String otaUpdateArn

 The OTA update ARN.
 


creationDate
Date creationDate

 The date when the OTA update was created.
 


lastModifiedDate
Date lastModifiedDate

 The date when the OTA update was last updated.
 


description
String description

 A description of the OTA update.
 


targets
List<E> targets

 The targets of the OTA update.
 


protocols
List<E> protocols

 The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP
 and MQTT are specified, the target device can choose the protocol.
 


awsJobExecutionsRolloutConfig
AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig

 Configuration for the rollout of OTA updates.
 


awsJobPresignedUrlConfig
AwsJobPresignedUrlConfig awsJobPresignedUrlConfig

 Configuration information for pre-signed URLs. Valid when protocols contains HTTP.
 


targetSelection
String targetSelection

 Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things
 specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a
 thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is
 added to a target group, even after the OTA update was completed by all things originally in the group.
 


otaUpdateFiles
List<E> otaUpdateFiles

 A list of files associated with the OTA update.
 


otaUpdateStatus
String otaUpdateStatus

 The status of the OTA update.
 


awsIotJobId
String awsIotJobId

 The AWS IoT job ID associated with the OTA update.
 


awsIotJobArn
String awsIotJobArn

 The AWS IoT job ARN associated with the OTA update.
 


errorInfo
ErrorInfo errorInfo

 Error information associated with the OTA update.
 


additionalParameters
Map<K,V> additionalParameters

 A collection of name/value pairs
 








Class com.amazonaws.services.iot.model.OTAUpdateSummary extends Object implements Serializable


Serialized Fields


otaUpdateId
String otaUpdateId

 The OTA update ID.
 


otaUpdateArn
String otaUpdateArn

 The OTA update ARN.
 


creationDate
Date creationDate

 The date when the OTA update was created.
 








Class com.amazonaws.services.iot.model.OutgoingCertificate extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn

 The certificate ARN.
 


certificateId
String certificateId

 The certificate ID.
 


transferredTo
String transferredTo

 The AWS account to which the transfer was made.
 


transferDate
Date transferDate

 The date the transfer was initiated.
 


transferMessage
String transferMessage

 The transfer message.
 


creationDate
Date creationDate

 The certificate creation date.
 








Class com.amazonaws.services.iot.model.PercentPair extends Object implements Serializable


Serialized Fields


percent
Double percent

 The percentile.
 


value
Double value

 The value of the percentile.
 








Class com.amazonaws.services.iot.model.Policy extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The policy name.
 


policyArn
String policyArn

 The policy ARN.
 








Class com.amazonaws.services.iot.model.PolicyVersion extends Object implements Serializable


Serialized Fields


versionId
String versionId

 The policy version ID.
 


isDefaultVersion
Boolean isDefaultVersion

 Specifies whether the policy version is the default.
 


createDate
Date createDate

 The date and time the policy was created.
 








Class com.amazonaws.services.iot.model.PolicyVersionIdentifier extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The name of the policy.
 


policyVersionId
String policyVersionId

 The ID of the version of the policy associated with the resource.
 








Class com.amazonaws.services.iot.model.PresignedUrlConfig extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job
 data/updates are stored. The role must also grant permission for IoT to download the files.
 


expiresInSec
Long expiresInSec

 How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds.
 Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
 








Class com.amazonaws.services.iot.model.ProvisioningTemplateSummary extends Object implements Serializable


Serialized Fields


templateArn
String templateArn

 The ARN of the fleet provisioning template.
 


templateName
String templateName

 The name of the fleet provisioning template.
 


description
String description

 The description of the fleet provisioning template.
 


creationDate
Date creationDate

 The date when the fleet provisioning template summary was created.
 


lastModifiedDate
Date lastModifiedDate

 The date when the fleet provisioning template summary was last modified.
 


enabled
Boolean enabled

 True if the fleet provision template is enabled, otherwise false.
 








Class com.amazonaws.services.iot.model.ProvisioningTemplateVersionSummary extends Object implements Serializable


Serialized Fields


versionId
Integer versionId

 The ID of the fleet privisioning template version.
 


creationDate
Date creationDate

 The date when the fleet provisioning template version was created
 


isDefaultVersion
Boolean isDefaultVersion

 True if the fleet provisioning template version is the default version, otherwise false.
 








Class com.amazonaws.services.iot.model.PublishFindingToSnsParams extends Object implements Serializable


Serialized Fields


topicArn
String topicArn

 The ARN of the topic to which you want to publish the findings.
 








Class com.amazonaws.services.iot.model.PutAssetPropertyValueEntry extends Object implements Serializable


Serialized Fields


entryId
String entryId

 Optional. A unique identifier for this entry that you can define to better track which message caused an error in
 case of failure. Accepts substitution templates. Defaults to a new UUID.
 


assetId
String assetId

 The ID of the AWS IoT SiteWise asset. You must specify either a propertyAlias or both an
 aliasId and a propertyId. Accepts substitution templates.
 


propertyId
String propertyId

 The ID of the asset's property. You must specify either a propertyAlias or both an
 aliasId and a propertyId. Accepts substitution templates.
 


propertyAlias
String propertyAlias

 The name of the property alias associated with your asset property. You must specify either a
 propertyAlias or both an aliasId and a propertyId. Accepts substitution
 templates.
 


propertyValues
List<E> propertyValues

 A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
 








Class com.amazonaws.services.iot.model.PutItemInput extends Object implements Serializable


Serialized Fields


tableName
String tableName

 The table where the message data will be written.
 








Class com.amazonaws.services.iot.model.RateIncreaseCriteria extends Object implements Serializable


Serialized Fields


numberOfNotifiedThings
Integer numberOfNotifiedThings

 The threshold for number of notified things that will initiate the increase in rate of rollout.
 


numberOfSucceededThings
Integer numberOfSucceededThings

 The threshold for number of succeeded things that will initiate the increase in rate of rollout.
 








Class com.amazonaws.services.iot.model.RegisterCACertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


caCertificate
String caCertificate

 The CA certificate.
 


verificationCertificate
String verificationCertificate

 The private key verification certificate.
 


setAsActive
Boolean setAsActive

 A boolean value that specifies if the CA certificate is set to active.
 


allowAutoRegistration
Boolean allowAutoRegistration

 Allows this CA certificate to be used for auto registration of device certificates.
 


registrationConfig
RegistrationConfig registrationConfig

 Information about the registration configuration.
 








Class com.amazonaws.services.iot.model.RegisterCACertificateResult extends AmazonWebServiceResult<ResponseMetadata> 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 extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificatePem
String certificatePem

 The certificate data, in PEM format.
 


caCertificatePem
String caCertificatePem

 The CA certificate used to sign the device certificate being registered.
 


setAsActive
Boolean setAsActive
Deprecated. 

 A boolean value that specifies if the certificate is set to active.
 


status
String status

 The status of the register certificate request.
 








Class com.amazonaws.services.iot.model.RegisterCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificateArn
String certificateArn

 The certificate ARN.
 


certificateId
String certificateId

 The certificate identifier.
 








Class com.amazonaws.services.iot.model.RegisterThingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateBody
String templateBody

 The provisioning template. See Programmatic
 Provisioning for more information.
 


parameters
Map<K,V> parameters

 The parameters for provisioning a thing. See Programmatic
 Provisioning for more information.
 








Class com.amazonaws.services.iot.model.RegisterThingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


certificatePem
String certificatePem

 .
 


resourceArns
Map<K,V> resourceArns

 ARNs for the generated resources.
 








Class com.amazonaws.services.iot.model.RegistrationCodeValidationException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.RegistrationConfig extends Object implements Serializable


Serialized Fields


templateBody
String templateBody

 The template body.
 


roleArn
String roleArn

 The ARN of the role.
 








Class com.amazonaws.services.iot.model.RejectCertificateTransferRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateId
String certificateId

 The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
 


rejectReason
String rejectReason

 The reason the certificate transfer was rejected.
 








Class com.amazonaws.services.iot.model.RejectCertificateTransferResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.RelatedResource extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The type of resource.
 


resourceIdentifier
ResourceIdentifier resourceIdentifier

 Information that identifies the resource.
 


additionalInfo
Map<K,V> additionalInfo

 Other information about the resource.
 








Class com.amazonaws.services.iot.model.RemoveThingFromBillingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


billingGroupName
String billingGroupName

 The name of the billing group.
 


billingGroupArn
String billingGroupArn

 The ARN of the billing group.
 


thingName
String thingName

 The name of the thing to be removed from the billing group.
 


thingArn
String thingArn

 The ARN of the thing to be removed from the billing group.
 








Class com.amazonaws.services.iot.model.RemoveThingFromBillingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.RemoveThingFromThingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The group name.
 


thingGroupArn
String thingGroupArn

 The group ARN.
 


thingName
String thingName

 The name of the thing to remove from the group.
 


thingArn
String thingArn

 The ARN of the thing to remove from the group.
 








Class com.amazonaws.services.iot.model.RemoveThingFromThingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.ReplaceDefaultPolicyVersionParams extends Object implements Serializable


Serialized Fields


templateName
String templateName

 The name of the template to be applied. The only supported value is BLANK_POLICY.
 








Class com.amazonaws.services.iot.model.ReplaceTopicRuleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ruleName
String ruleName

 The name of the rule.
 


topicRulePayload
TopicRulePayload topicRulePayload

 The rule payload.
 








Class com.amazonaws.services.iot.model.ReplaceTopicRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.RepublishAction extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access.
 


topic
String topic

 The name of the MQTT topic.
 


qos
Integer qos

 The Quality of Service (QoS) level to use when republishing messages. The default value is 0.
 








Class com.amazonaws.services.iot.model.ResourceAlreadyExistsException extends AWSIotException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceId
String resourceId

 The ID of the resource that caused the exception.
 


resourceArn
String resourceArn

 The ARN of the resource that caused the exception.
 








Class com.amazonaws.services.iot.model.ResourceIdentifier extends Object implements Serializable


Serialized Fields


deviceCertificateId
String deviceCertificateId

 The ID of the certificate attached to the resource.
 


caCertificateId
String caCertificateId

 The ID of the CA certificate used to authorize the certificate.
 


cognitoIdentityPoolId
String cognitoIdentityPoolId

 The ID of the Amazon Cognito identity pool.
 


clientId
String clientId

 The client ID.
 


policyVersionIdentifier
PolicyVersionIdentifier policyVersionIdentifier

 The version of the policy associated with the resource.
 


account
String account

 The account with which the resource is associated.
 


iamRoleArn
String iamRoleArn

 The ARN of the IAM role that has overly permissive actions.
 


roleAliasArn
String roleAliasArn

 The ARN of the role alias that has overly permissive actions.
 








Class com.amazonaws.services.iot.model.ResourceNotFoundException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.ResourceRegistrationFailureException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.RoleAliasDescription extends Object implements Serializable


Serialized Fields


roleAlias
String roleAlias

 The role alias.
 


roleAliasArn
String roleAliasArn

 The ARN of the role alias.
 


roleArn
String roleArn

 The role ARN.
 


owner
String owner

 The role alias owner.
 


credentialDurationSeconds
Integer credentialDurationSeconds

 The number of seconds for which the credential is valid.
 


creationDate
Date creationDate

 The UNIX timestamp of when the role alias was created.
 


lastModifiedDate
Date lastModifiedDate

 The UNIX timestamp of when the role alias was last modified.
 








Class com.amazonaws.services.iot.model.S3Action extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access.
 


bucketName
String bucketName

 The Amazon S3 bucket.
 


key
String key

 The object key.
 


cannedAcl
String cannedAcl

 The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information,
 see S3 canned ACLs.
 








Class com.amazonaws.services.iot.model.S3Destination extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The S3 bucket that contains the updated firmware.
 


prefix
String prefix

 The S3 prefix.
 








Class com.amazonaws.services.iot.model.S3Location extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The S3 bucket.
 


key
String key

 The S3 key.
 


version
String version

 The S3 bucket version.
 








Class com.amazonaws.services.iot.model.SalesforceAction extends Object implements Serializable


Serialized Fields


token
String token

 The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The token is available from the
 Salesforce IoT Cloud platform after creation of the Input Stream.
 


url
String url

 The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from the Salesforce IoT Cloud
 platform after creation of the Input Stream.
 








Class com.amazonaws.services.iot.model.ScheduledAuditMetadata extends Object implements Serializable


Serialized Fields


scheduledAuditName
String scheduledAuditName

 The name of the scheduled audit.
 


scheduledAuditArn
String scheduledAuditArn

 The ARN of the scheduled audit.
 


frequency
String frequency

 How often the scheduled audit occurs.
 


dayOfMonth
String dayOfMonth

 The day of the month on which the scheduled audit is run (if the frequency is "MONTHLY"). If days
 29-31 are specified, and the month does not have that many days, the audit takes place on the "LAST" day of the
 month.
 


dayOfWeek
String dayOfWeek

 The day of the week on which the scheduled audit is run (if the frequency is "WEEKLY" or
 "BIWEEKLY").
 








Class com.amazonaws.services.iot.model.SearchIndexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


indexName
String indexName

 The search index name.
 


queryString
String queryString

 The search query string.
 


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 


queryVersion
String queryVersion

 The query version.
 








Class com.amazonaws.services.iot.model.SearchIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 The token used to get the next set of results, or null if there are no additional results.
 


things
List<E> things

 The things that match the search query.
 


thingGroups
List<E> thingGroups

 The thing groups that match the search query.
 








Class com.amazonaws.services.iot.model.SecurityProfileIdentifier extends Object implements Serializable


Serialized Fields


name
String name

 The name you have given to the security profile.
 


arn
String arn

 The ARN of the security profile.
 








Class com.amazonaws.services.iot.model.SecurityProfileTarget extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the security profile.
 








Class com.amazonaws.services.iot.model.SecurityProfileTargetMapping extends Object implements Serializable


Serialized Fields


securityProfileIdentifier
SecurityProfileIdentifier securityProfileIdentifier

 Information that identifies the security profile.
 


target
SecurityProfileTarget target

 Information about the target (thing group) associated with the security profile.
 








Class com.amazonaws.services.iot.model.ServerCertificateSummary extends Object implements Serializable


Serialized Fields


serverCertificateArn
String serverCertificateArn

 The ARN of the server certificate.
 


serverCertificateStatus
String serverCertificateStatus

 The status of the server certificate.
 


serverCertificateStatusDetail
String serverCertificateStatusDetail

 Details that explain the status of the server certificate.
 








Class com.amazonaws.services.iot.model.ServiceUnavailableException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.SetDefaultAuthorizerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


authorizerName
String authorizerName

 The authorizer name.
 








Class com.amazonaws.services.iot.model.SetDefaultAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


authorizerName
String authorizerName

 The authorizer name.
 


authorizerArn
String authorizerArn

 The authorizer ARN.
 








Class com.amazonaws.services.iot.model.SetDefaultPolicyVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The policy name.
 


policyVersionId
String policyVersionId

 The policy version ID.
 








Class com.amazonaws.services.iot.model.SetDefaultPolicyVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.SetLoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loggingOptionsPayload
LoggingOptionsPayload loggingOptionsPayload

 The logging options payload.
 








Class com.amazonaws.services.iot.model.SetLoggingOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.SetV2LoggingLevelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logTarget
LogTarget logTarget

 The log target.
 


logLevel
String logLevel

 The log level.
 








Class com.amazonaws.services.iot.model.SetV2LoggingLevelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.SetV2LoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the role that allows IoT to write to Cloudwatch logs.
 


defaultLogLevel
String defaultLogLevel

 The default logging level.
 


disableAllLogs
Boolean disableAllLogs

 If true all logs are disabled. The default is false.
 








Class com.amazonaws.services.iot.model.SetV2LoggingOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.SigningProfileParameter extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn

 Certificate ARN.
 


platform
String platform

 The hardware platform of your device.
 


certificatePathOnDevice
String certificatePathOnDevice

 The location of the code-signing certificate on your device.
 








Class com.amazonaws.services.iot.model.SigV4Authorization extends Object implements Serializable


Serialized Fields


signingRegion
String signingRegion

 The signing region.
 


serviceName
String serviceName

 The service name to use while signing with Sig V4.
 


roleArn
String roleArn

 The ARN of the signing role.
 








Class com.amazonaws.services.iot.model.SnsAction extends Object implements Serializable


Serialized Fields


targetArn
String targetArn

 The ARN of the SNS topic.
 


roleArn
String roleArn

 The ARN of the IAM role that grants access.
 


messageFormat
String messageFormat

 (Optional) The message format of the message to publish. 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 https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
 








Class com.amazonaws.services.iot.model.SqlParseException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.SqsAction extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access.
 


queueUrl
String queueUrl

 The URL of the Amazon SQS queue.
 


useBase64
Boolean useBase64

 Specifies whether to use Base64 encoding.
 








Class com.amazonaws.services.iot.model.StartAuditMitigationActionsTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.
 


target
AuditMitigationActionsTaskTarget target

 Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit
 check, to all findings from an audit, or to a speecific set of findings.
 


auditCheckToActionsMapping
Map<K,V> auditCheckToActionsMapping

 For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS
 account.
 


clientRequestToken
String clientRequestToken

 Each audit mitigation task must have a unique client request token. If you try to start a new task with the same
 token as a task that already exists, an exception occurs. If you omit this value, a unique client request token
 is generated automatically.
 








Class com.amazonaws.services.iot.model.StartAuditMitigationActionsTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskId
String taskId

 The unique identifier for the audit mitigation task. This matches the taskId that you specified in
 the request.
 








Class com.amazonaws.services.iot.model.StartOnDemandAuditTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetCheckNames
List<E> targetCheckNames

 Which checks are performed during the audit. The checks you specify must be enabled for your account or an
 exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks, including
 those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.
 








Class com.amazonaws.services.iot.model.StartOnDemandAuditTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskId
String taskId

 The ID of the on-demand audit you started.
 








Class com.amazonaws.services.iot.model.StartSigningJobParameter extends Object implements Serializable


Serialized Fields


signingProfileParameter
SigningProfileParameter signingProfileParameter

 Describes the code-signing profile.
 


signingProfileName
String signingProfileName

 The code-signing profile name.
 


destination
Destination destination

 The location to write the code-signed file.
 








Class com.amazonaws.services.iot.model.StartThingRegistrationTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateBody
String templateBody

 The provisioning template.
 


inputFileBucket
String inputFileBucket

 The S3 bucket that contains the input file.
 


inputFileKey
String inputFileKey

 The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains
 the parameter values to provision one device (thing).
 


roleArn
String roleArn

 The IAM role ARN that grants permission the input file.
 








Class com.amazonaws.services.iot.model.StartThingRegistrationTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskId
String taskId

 The bulk thing provisioning task ID.
 








Class com.amazonaws.services.iot.model.StatisticalThreshold extends Object implements Serializable


Serialized Fields


statistic
String statistic

 The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are
 collected over the specified period (durationSeconds) from all reporting devices in your account and
 statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the
 accumulated measurements from the device fall above or below (comparisonOperator) the value
 associated with the percentile specified, then the device is considered to be in compliance with the behavior,
 otherwise a violation occurs.
 








Class com.amazonaws.services.iot.model.Statistics extends Object implements Serializable


Serialized Fields


count
Integer count

 The count of things that match the query.
 


average
Double average

 The average of the aggregated field values.
 


sum
Double sum

 The sum of the aggregated field values.
 


minimum
Double minimum

 The minimum aggregated field value.
 


maximum
Double maximum

 The maximum aggregated field value.
 


sumOfSquares
Double sumOfSquares

 The sum of the squares of the aggregated field values.
 


variance
Double variance

 The variance of the aggregated field values.
 


stdDeviation
Double stdDeviation

 The standard deviation of the aggregated field values.
 








Class com.amazonaws.services.iot.model.StepFunctionsAction extends Object implements Serializable


Serialized Fields


executionNamePrefix
String executionNamePrefix

 (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step
 Functions automatically creates a unique name for each state machine execution if one is not provided.
 


stateMachineName
String stateMachineName

 The name of the Step Functions state machine whose execution will be started.
 


roleArn
String roleArn

 The ARN of the role that grants IoT permission to start execution of a state machine
 ("Action":"states:StartExecution").
 








Class com.amazonaws.services.iot.model.StopThingRegistrationTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 The bulk thing provisioning task ID.
 








Class com.amazonaws.services.iot.model.StopThingRegistrationTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.Stream extends Object implements Serializable


Serialized Fields


streamId
String streamId

 The stream ID.
 


fileId
Integer fileId

 The ID of a file associated with a stream.
 








Class com.amazonaws.services.iot.model.StreamFile extends Object implements Serializable


Serialized Fields


fileId
Integer fileId

 The file ID.
 


s3Location
S3Location s3Location

 The location of the file in S3.
 








Class com.amazonaws.services.iot.model.StreamInfo extends Object implements Serializable


Serialized Fields


streamId
String streamId

 The stream ID.
 


streamArn
String streamArn

 The stream ARN.
 


streamVersion
Integer streamVersion

 The stream version.
 


description
String description

 The description of the stream.
 


files
List<E> files

 The files to stream.
 


createdAt
Date createdAt

 The date when the stream was created.
 


lastUpdatedAt
Date lastUpdatedAt

 The date when the stream was last updated.
 


roleArn
String roleArn

 An IAM role AWS IoT assumes to access your S3 files.
 








Class com.amazonaws.services.iot.model.StreamSummary extends Object implements Serializable


Serialized Fields


streamId
String streamId

 The stream ID.
 


streamArn
String streamArn

 The stream ARN.
 


streamVersion
Integer streamVersion

 The stream version.
 


description
String description

 A description of the stream.
 








Class com.amazonaws.services.iot.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The tag's key.
 


value
String value

 The tag's value.
 








Class com.amazonaws.services.iot.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource.
 


tags
List<E> tags

 The new or modified tags for the resource.
 








Class com.amazonaws.services.iot.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.TaskAlreadyExistsException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.TaskStatistics extends Object implements Serializable


Serialized Fields


totalChecks
Integer totalChecks

 The number of checks in this audit.
 


inProgressChecks
Integer inProgressChecks

 The number of checks in progress.
 


waitingForDataCollectionChecks
Integer waitingForDataCollectionChecks

 The number of checks waiting for data collection.
 


compliantChecks
Integer compliantChecks

 The number of checks that found compliant resources.
 


nonCompliantChecks
Integer nonCompliantChecks

 The number of checks that found noncompliant resources.
 


failedChecks
Integer failedChecks

 The number of checks.
 


canceledChecks
Integer canceledChecks

 The number of checks that did not run because the audit was canceled.
 








Class com.amazonaws.services.iot.model.TaskStatisticsForAuditCheck extends Object implements Serializable


Serialized Fields


totalFindingsCount
Long totalFindingsCount

 The total number of findings to which a task is being applied.
 


failedFindingsCount
Long failedFindingsCount

 The number of findings for which at least one of the actions failed when applied.
 


succeededFindingsCount
Long succeededFindingsCount

 The number of findings for which all mitigation actions succeeded when applied.
 


skippedFindingsCount
Long skippedFindingsCount

 The number of findings skipped because of filter conditions provided in the parameters to the command.
 


canceledFindingsCount
Long canceledFindingsCount

 The number of findings to which the mitigation action task was canceled when applied.
 








Class com.amazonaws.services.iot.model.TestAuthorizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


principal
String principal

 The principal.
 


cognitoIdentityPoolId
String cognitoIdentityPoolId

 The Cognito identity pool ID.
 


authInfos
List<E> authInfos

 A list of authorization info objects. Simulating authorization will create a response for each
 authInfo object in the list.
 


clientId
String clientId

 The MQTT client ID.
 


policyNamesToAdd
List<E> policyNamesToAdd

 When testing custom authorization, the policies specified here are treated as if they are attached to the
 principal being authorized.
 


policyNamesToSkip
List<E> policyNamesToSkip

 When testing custom authorization, the policies specified here are treated as if they are not attached to the
 principal being authorized.
 








Class com.amazonaws.services.iot.model.TestAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


authResults
List<E> authResults

 The authentication results.
 








Class com.amazonaws.services.iot.model.TestInvokeAuthorizerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


authorizerName
String authorizerName

 The custom authorizer name.
 


token
String token

 The token returned by your custom authentication service.
 


tokenSignature
String tokenSignature

 The signature made with the token and your custom authentication service's private key.
 


httpContext
HttpContext httpContext

 Specifies a test HTTP authorization request.
 


mqttContext
MqttContext mqttContext

 Specifies a test MQTT authorization request.
 


tlsContext
TlsContext tlsContext

 Specifies a test TLS authorization request.
 








Class com.amazonaws.services.iot.model.TestInvokeAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


isAuthenticated
Boolean isAuthenticated

 True if the token is authenticated, otherwise false.
 


principalId
String principalId

 The principal ID.
 


policyDocuments
List<E> policyDocuments

 IAM policy documents.
 


refreshAfterInSeconds
Integer refreshAfterInSeconds

 The number of seconds after which the temporary credentials are refreshed.
 


disconnectAfterInSeconds
Integer disconnectAfterInSeconds

 The number of seconds after which the connection is terminated.
 








Class com.amazonaws.services.iot.model.ThingAttribute extends Object implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing.
 


thingTypeName
String thingTypeName

 The name of the thing type, if the thing has been associated with a type.
 


thingArn
String thingArn

 The thing ARN.
 


attributes
Map<K,V> attributes

 A list of thing attributes which are name-value pairs.
 


version
Long version

 The version of the thing record in the registry.
 








Class com.amazonaws.services.iot.model.ThingConnectivity extends Object implements Serializable


Serialized Fields


connected
Boolean connected

 True if the thing is connected to the AWS IoT service; false if it is not connected.
 


timestamp
Long timestamp

 The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been
 disconnected for more than a few weeks, the time value might be missing.
 








Class com.amazonaws.services.iot.model.ThingDocument extends Object implements Serializable


Serialized Fields


thingName
String thingName

 The thing name.
 


thingId
String thingId

 The thing ID.
 


thingTypeName
String thingTypeName

 The thing type name.
 


thingGroupNames
List<E> thingGroupNames

 Thing group names.
 


attributes
Map<K,V> attributes

 The attributes.
 


shadow
String shadow

 The shadow.
 


connectivity
ThingConnectivity connectivity

 Indicates whether the thing is connected to the AWS IoT service.
 








Class com.amazonaws.services.iot.model.ThingGroupDocument extends Object implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The thing group name.
 


thingGroupId
String thingGroupId

 The thing group ID.
 


thingGroupDescription
String thingGroupDescription

 The thing group description.
 


attributes
Map<K,V> attributes

 The thing group attributes.
 


parentGroupNames
List<E> parentGroupNames

 Parent group names.
 








Class com.amazonaws.services.iot.model.ThingGroupIndexingConfiguration extends Object implements Serializable


Serialized Fields


thingGroupIndexingMode
String thingGroupIndexingMode

 Thing group indexing mode.
 


managedFields
List<E> managedFields

 Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
 


customFields
List<E> customFields

 A list of thing group fields to index. This list cannot contain any managed fields. Use the
 GetIndexingConfiguration API to get a list of managed fields.
 
 
 Contains custom field names and their data type.
 








Class com.amazonaws.services.iot.model.ThingGroupMetadata extends Object implements Serializable


Serialized Fields


parentGroupName
String parentGroupName

 The parent thing group name.
 


rootToParentThingGroups
List<E> rootToParentThingGroups

 The root parent thing group.
 


creationDate
Date creationDate

 The UNIX timestamp of when the thing group was created.
 








Class com.amazonaws.services.iot.model.ThingGroupProperties extends Object implements Serializable


Serialized Fields


thingGroupDescription
String thingGroupDescription

 The thing group description.
 


attributePayload
AttributePayload attributePayload

 The thing group attributes in JSON format.
 








Class com.amazonaws.services.iot.model.ThingIndexingConfiguration extends Object implements Serializable


Serialized Fields


thingIndexingMode
String thingIndexingMode

 Thing indexing mode. Valid values are:
 
 
 
 
 REGISTRY – Your thing index contains registry data only.
 
 
 
 
 REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.
 
 
 
 
 OFF - Thing indexing is disabled.
 
 
 


thingConnectivityIndexingMode
String thingConnectivityIndexingMode

 Thing connectivity indexing mode. Valid values are:
 
 
 
 
 STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode
 must not be set to OFF.
 
 
 
 
 OFF - Thing connectivity status indexing is disabled.
 
 
 


managedFields
List<E> managedFields

 Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
 


customFields
List<E> customFields

 Contains custom field names and their data type.
 








Class com.amazonaws.services.iot.model.ThingTypeDefinition extends Object implements Serializable


Serialized Fields


thingTypeName
String thingTypeName

 The name of the thing type.
 


thingTypeArn
String thingTypeArn

 The thing type ARN.
 


thingTypeProperties
ThingTypeProperties thingTypeProperties

 The ThingTypeProperties for the thing type.
 


thingTypeMetadata
ThingTypeMetadata thingTypeMetadata

 The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a
 value indicating whether the thing type is deprecated, and a date and time when it was deprecated.
 








Class com.amazonaws.services.iot.model.ThingTypeMetadata extends Object implements Serializable


Serialized Fields


deprecated
Boolean deprecated

 Whether the thing type is deprecated. If true, no new things could be associated with this type.
 


deprecationDate
Date deprecationDate

 The date and time when the thing type was deprecated.
 


creationDate
Date creationDate

 The date and time when the thing type was created.
 








Class com.amazonaws.services.iot.model.ThingTypeProperties extends Object implements Serializable


Serialized Fields


thingTypeDescription
String thingTypeDescription

 The description of the thing type.
 


searchableAttributes
List<E> searchableAttributes

 A list of searchable thing attribute names.
 








Class com.amazonaws.services.iot.model.ThrottlingException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.TimeoutConfig extends Object implements Serializable


Serialized Fields


inProgressTimeoutInMinutes
Long inProgressTimeoutInMinutes

 Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval
 can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will
 apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer
 than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.
 








Class com.amazonaws.services.iot.model.TlsContext extends Object implements Serializable


Serialized Fields


serverName
String serverName

 The value of the serverName key in a TLS authorization request.
 








Class com.amazonaws.services.iot.model.TopicRule extends Object implements Serializable


Serialized Fields


ruleName
String ruleName

 The name of the rule.
 


sql
String sql

 The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the
 newline characters.
 


description
String description

 The description of the rule.
 


createdAt
Date createdAt

 The date and time the rule was created.
 


actions
List<E> actions

 The actions associated with the rule.
 


ruleDisabled
Boolean ruleDisabled

 Specifies whether the rule is disabled.
 


awsIotSqlVersion
String awsIotSqlVersion

 The version of the SQL rules engine to use when evaluating the rule.
 


errorAction
Action errorAction

 The action to perform when an error occurs.
 








Class com.amazonaws.services.iot.model.TopicRuleDestination extends Object implements Serializable


Serialized Fields


arn
String arn

 The topic rule destination URL.
 


status
String status

 The status of the topic rule destination. Valid values are:
 
 
 IN_PROGRESS
 
 
 A topic rule destination was created but has not been confirmed. You can set status to
 IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
 UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation
 endpoint.
 
 
 ENABLED
 
 
 Confirmation was completed, and traffic to this destination is allowed. You can set status to
 DISABLED by calling UpdateTopicRuleDestination.
 
 
 DISABLED
 
 
 Confirmation was completed, and traffic to this destination is not allowed. You can set status to
 ENABLED by calling UpdateTopicRuleDestination.
 
 
 ERROR
 
 
 Confirmation could not be completed, for example if the confirmation timed out. You can call
 GetTopicRuleDestination for details about the error. You can set status to
 IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
 UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation
 endpoint.
 
 
 


statusReason
String statusReason

 Additional details or reason why the topic rule destination is in the current status.
 


httpUrlProperties
HttpUrlDestinationProperties httpUrlProperties

 Properties of the HTTP URL.
 








Class com.amazonaws.services.iot.model.TopicRuleDestinationConfiguration extends Object implements Serializable


Serialized Fields


httpUrlConfiguration
HttpUrlDestinationConfiguration httpUrlConfiguration

 Configuration of the HTTP URL.
 








Class com.amazonaws.services.iot.model.TopicRuleDestinationSummary extends Object implements Serializable


Serialized Fields


arn
String arn

 The topic rule destination ARN.
 


status
String status

 The status of the topic rule destination. Valid values are:
 
 
 IN_PROGRESS
 
 
 A topic rule destination was created but has not been confirmed. You can set status to
 IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
 UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation
 endpoint.
 
 
 ENABLED
 
 
 Confirmation was completed, and traffic to this destination is allowed. You can set status to
 DISABLED by calling UpdateTopicRuleDestination.
 
 
 DISABLED
 
 
 Confirmation was completed, and traffic to this destination is not allowed. You can set status to
 ENABLED by calling UpdateTopicRuleDestination.
 
 
 ERROR
 
 
 Confirmation could not be completed, for example if the confirmation timed out. You can call
 GetTopicRuleDestination for details about the error. You can set status to
 IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
 UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation
 endpoint.
 
 
 


statusReason
String statusReason

 The reason the topic rule destination is in the current status.
 


httpUrlSummary
HttpUrlDestinationSummary httpUrlSummary

 Information about the HTTP URL.
 








Class com.amazonaws.services.iot.model.TopicRuleListItem extends Object implements Serializable


Serialized Fields


ruleArn
String ruleArn

 The rule ARN.
 


ruleName
String ruleName

 The name of the rule.
 


topicPattern
String topicPattern

 The pattern for the topic names that apply.
 


createdAt
Date createdAt

 The date and time the rule was created.
 


ruleDisabled
Boolean ruleDisabled

 Specifies whether the rule is disabled.
 








Class com.amazonaws.services.iot.model.TopicRulePayload extends Object implements Serializable


Serialized Fields


sql
String sql

 The SQL statement used to query the topic. For more information, see AWS IoT SQL
 Reference in the AWS IoT Developer Guide.
 


description
String description

 The description of the rule.
 


actions
List<E> actions

 The actions associated with the rule.
 


ruleDisabled
Boolean ruleDisabled

 Specifies whether the rule is disabled.
 


awsIotSqlVersion
String awsIotSqlVersion

 The version of the SQL rules engine to use when evaluating the rule.
 


errorAction
Action errorAction

 The action to take when an error occurs.
 








Class com.amazonaws.services.iot.model.TransferAlreadyCompletedException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.TransferCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateId
String certificateId

 The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
 


targetAwsAccount
String targetAwsAccount

 The AWS account.
 


transferMessage
String transferMessage

 The transfer message.
 








Class com.amazonaws.services.iot.model.TransferCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transferredCertificateArn
String transferredCertificateArn

 The ARN of the certificate.
 








Class com.amazonaws.services.iot.model.TransferConflictException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.TransferData extends Object implements Serializable


Serialized Fields


transferMessage
String transferMessage

 The transfer message.
 


rejectReason
String rejectReason

 The reason why the transfer was rejected.
 


transferDate
Date transferDate

 The date the transfer took place.
 


acceptDate
Date acceptDate

 The date the transfer was accepted.
 


rejectDate
Date rejectDate

 The date the transfer was rejected.
 








Class com.amazonaws.services.iot.model.UnauthorizedException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource.
 


tagKeys
List<E> tagKeys

 A list of the keys of the tags to be removed from the resource.
 








Class com.amazonaws.services.iot.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.UpdateAccountAuditConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the role that grants permission to AWS IoT to access information about your devices, policies,
 certificates and other items as required when performing an audit.
 


auditNotificationTargetConfigurations
Map<K,V> auditNotificationTargetConfigurations

 Information about the targets to which audit notifications are sent.
 


auditCheckConfigurations
Map<K,V> auditCheckConfigurations

 Specifies which audit checks are enabled and disabled for this account. Use
 DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently
 enabled.
 
 
 Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data
 collected so far in relation to the check is deleted.
 
 
 You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the
 scheduled audit or delete the scheduled audit itself.
 
 
 On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at
 least one enabled check.
 








Class com.amazonaws.services.iot.model.UpdateAccountAuditConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.UpdateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


authorizerName
String authorizerName

 The authorizer name.
 


authorizerFunctionArn
String authorizerFunctionArn

 The ARN of the authorizer's Lambda function.
 


tokenKeyName
String tokenKeyName

 The key used to extract the token from the HTTP headers.
 


tokenSigningPublicKeys
Map<K,V> tokenSigningPublicKeys

 The public keys used to verify the token signature.
 


status
String status

 The status of the update authorizer request.
 








Class com.amazonaws.services.iot.model.UpdateAuthorizerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


authorizerName
String authorizerName

 The authorizer name.
 


authorizerArn
String authorizerArn

 The authorizer ARN.
 








Class com.amazonaws.services.iot.model.UpdateBillingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


billingGroupName
String billingGroupName

 The name of the billing group.
 


billingGroupProperties
BillingGroupProperties billingGroupProperties

 The properties of the billing group.
 


expectedVersion
Long expectedVersion

 The expected version of the billing group. If the version of the billing group does not match the expected
 version specified in the request, the UpdateBillingGroup request is rejected with a
 VersionConflictException.
 








Class com.amazonaws.services.iot.model.UpdateBillingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


version
Long version

 The latest version of the billing group.
 








Class com.amazonaws.services.iot.model.UpdateCACertificateParams extends Object implements Serializable


Serialized Fields


action
String action

 The action that you want to apply to the CA cerrtificate. The only supported value is DEACTIVATE.
 








Class com.amazonaws.services.iot.model.UpdateCACertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateId
String certificateId

 The CA certificate identifier.
 


newStatus
String newStatus

 The updated status of the CA certificate.
 
 
 Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
 


newAutoRegistrationStatus
String newAutoRegistrationStatus

 The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".
 


registrationConfig
RegistrationConfig registrationConfig

 Information about the registration configuration.
 


removeAutoRegistration
Boolean removeAutoRegistration

 If true, removes auto registration.
 








Class com.amazonaws.services.iot.model.UpdateCACertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.UpdateCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


certificateId
String certificateId

 The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)
 


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.
 
 
 Note: The status value REGISTER_INACTIVE is deprecated and should not be used.
 








Class com.amazonaws.services.iot.model.UpdateCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.UpdateDeviceCertificateParams extends Object implements Serializable


Serialized Fields


action
String action

 The action that you want to apply to the device cerrtificate. The only supported value is DEACTIVATE
 .
 








Class com.amazonaws.services.iot.model.UpdateDomainConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainConfigurationName
String domainConfigurationName

 The name of the domain configuration to be updated.
 


authorizerConfig
AuthorizerConfig authorizerConfig

 An object that specifies the authorization service for a domain.
 


domainConfigurationStatus
String domainConfigurationStatus

 The status to which the domain configuration should be updated.
 


removeAuthorizerConfig
Boolean removeAuthorizerConfig

 Removes the authorization configuration from a domain.
 








Class com.amazonaws.services.iot.model.UpdateDomainConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domainConfigurationName
String domainConfigurationName

 The name of the domain configuration that was updated.
 


domainConfigurationArn
String domainConfigurationArn

 The ARN of the domain configuration that was updated.
 








Class com.amazonaws.services.iot.model.UpdateDynamicThingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The name of the dynamic thing group to update.
 


thingGroupProperties
ThingGroupProperties thingGroupProperties

 The dynamic thing group properties to update.
 


expectedVersion
Long expectedVersion

 The expected version of the dynamic thing group to update.
 


indexName
String indexName

 The dynamic thing group index to update.
 
 
 
 Currently one index is supported: 'AWS_Things'.
 
 


queryString
String queryString

 The dynamic thing group search query string to update.
 


queryVersion
String queryVersion

 The dynamic thing group query version to update.
 
 
 
 Currently one query version is supported: "2017-09-30". If not specified, the query version defaults to this
 value.
 
 








Class com.amazonaws.services.iot.model.UpdateDynamicThingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


version
Long version

 The dynamic thing group version.
 








Class com.amazonaws.services.iot.model.UpdateEventConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventConfigurations
Map<K,V> eventConfigurations

 The new event configuration values.
 








Class com.amazonaws.services.iot.model.UpdateEventConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.UpdateIndexingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingIndexingConfiguration
ThingIndexingConfiguration thingIndexingConfiguration

 Thing indexing configuration.
 


thingGroupIndexingConfiguration
ThingGroupIndexingConfiguration thingGroupIndexingConfiguration

 Thing group indexing configuration.
 








Class com.amazonaws.services.iot.model.UpdateIndexingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.UpdateJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The ID of the job to be updated.
 


description
String description

 A short text description of the job.
 


presignedUrlConfig
PresignedUrlConfig presignedUrlConfig

 Configuration information for pre-signed S3 URLs.
 


jobExecutionsRolloutConfig
JobExecutionsRolloutConfig jobExecutionsRolloutConfig

 Allows you to create a staged rollout of the job.
 


abortConfig
AbortConfig abortConfig

 Allows you to create criteria to abort a job.
 


timeoutConfig
TimeoutConfig timeoutConfig

 Specifies the amount of time each device has to finish its execution of the job. The timer is started when the
 job execution status is set to IN_PROGRESS. If the job execution status is not set to another
 terminal state before the time expires, it will be automatically set to TIMED_OUT.
 








Class com.amazonaws.services.iot.model.UpdateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.UpdateMitigationActionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


actionName
String actionName

 The friendly name for the mitigation action. You can't change the name by using
 UpdateMitigationAction. Instead, you must delete and re-create the mitigation action with the new
 name.
 


roleArn
String roleArn

 The ARN of the IAM role that is used to apply the mitigation action.
 


actionParams
MitigationActionParams actionParams

 Defines the type of action and the parameters for that action.
 








Class com.amazonaws.services.iot.model.UpdateMitigationActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


actionArn
String actionArn

 The ARN for the new mitigation action.
 


actionId
String actionId

 A unique identifier for the mitigation action.
 








Class com.amazonaws.services.iot.model.UpdateProvisioningTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


templateName
String templateName

 The name of the fleet provisioning template.
 


description
String description

 The description of the fleet provisioning template.
 


enabled
Boolean enabled

 True to enable the fleet provisioning template, otherwise false.
 


defaultVersionId
Integer defaultVersionId

 The ID of the default provisioning template version.
 


provisioningRoleArn
String provisioningRoleArn

 The ARN of the role associated with the provisioning template. This IoT role grants permission to provision a
 device.
 








Class com.amazonaws.services.iot.model.UpdateProvisioningTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.UpdateRoleAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleAlias
String roleAlias

 The role alias to update.
 


roleArn
String roleArn

 The role ARN.
 


credentialDurationSeconds
Integer credentialDurationSeconds

 The number of seconds the credential will be valid.
 








Class com.amazonaws.services.iot.model.UpdateRoleAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roleAlias
String roleAlias

 The role alias.
 


roleAliasArn
String roleAliasArn

 The role alias ARN.
 








Class com.amazonaws.services.iot.model.UpdateScheduledAuditRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


frequency
String frequency

 How often the scheduled audit takes place. Can be one of "DAILY", "WEEKLY", "BIWEEKLY", or "MONTHLY". The start
 time of each audit is determined by the system.
 


dayOfMonth
String dayOfMonth

 The day of the month on which the scheduled audit takes place. Can be "1" through "31" or "LAST". This field is
 required if the "frequency" parameter is set to "MONTHLY". If days 29-31 are specified, and the month does not
 have that many days, the audit takes place on the "LAST" day of the month.
 


dayOfWeek
String dayOfWeek

 The day of the week on which the scheduled audit takes place. Can be one of "SUN", "MON", "TUE", "WED", "THU",
 "FRI", or "SAT". This field is required if the "frequency" parameter is set to "WEEKLY" or "BIWEEKLY".
 


targetCheckNames
List<E> targetCheckNames

 Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
 DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or
 use UpdateAccountAuditConfiguration to select which checks are enabled.)
 


scheduledAuditName
String scheduledAuditName

 The name of the scheduled audit. (Max. 128 chars)
 








Class com.amazonaws.services.iot.model.UpdateScheduledAuditResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


scheduledAuditArn
String scheduledAuditArn

 The ARN of the scheduled audit.
 








Class com.amazonaws.services.iot.model.UpdateSecurityProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


securityProfileName
String securityProfileName

 The name of the security profile you want to update.
 


securityProfileDescription
String securityProfileDescription

 A description of the security profile.
 


behaviors
List<E> behaviors

 Specifies the behaviors that, when violated by a device (thing), cause an alert.
 


alertTargets
Map<K,V> alertTargets

 Where the alerts are sent. (Alerts are always sent to the console.)
 


additionalMetricsToRetain
List<E> additionalMetricsToRetain

 A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the
 profile's behaviors, but it is also retained for any metric specified here.
 


deleteBehaviors
Boolean deleteBehaviors

 If true, delete all behaviors defined for this security profile. If any behaviors are
 defined in the current invocation, an exception occurs.
 


deleteAlertTargets
Boolean deleteAlertTargets

 If true, delete all alertTargets defined for this security profile. If any alertTargets
 are defined in the current invocation, an exception occurs.
 


deleteAdditionalMetricsToRetain
Boolean deleteAdditionalMetricsToRetain

 If true, delete all additionalMetricsToRetain defined for this security profile. If any
 additionalMetricsToRetain are defined in the current invocation, an exception occurs.
 


expectedVersion
Long expectedVersion

 The expected version of the security profile. A new version is generated whenever the security profile is
 updated. If you specify a value that is different from the actual version, a
 VersionConflictException is thrown.
 








Class com.amazonaws.services.iot.model.UpdateSecurityProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityProfileName
String securityProfileName

 The name of the security profile that was updated.
 


securityProfileArn
String securityProfileArn

 The ARN of the security profile that was updated.
 


securityProfileDescription
String securityProfileDescription

 The description of the security profile.
 


behaviors
List<E> behaviors

 Specifies the behaviors that, when violated by a device (thing), cause an alert.
 


alertTargets
Map<K,V> alertTargets

 Where the alerts are sent. (Alerts are always sent to the console.)
 


additionalMetricsToRetain
List<E> additionalMetricsToRetain

 A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the
 security profile's behaviors, but it is also retained for any metric specified here.
 


version
Long version

 The updated version of the security profile.
 


creationDate
Date creationDate

 The time the security profile was created.
 


lastModifiedDate
Date lastModifiedDate

 The time the security profile was last modified.
 








Class com.amazonaws.services.iot.model.UpdateStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamId
String streamId

 The stream ID.
 


description
String description

 The description of the stream.
 


files
List<E> files

 The files associated with the stream.
 


roleArn
String roleArn

 An IAM role that allows the IoT service principal assumes to access your S3 files.
 








Class com.amazonaws.services.iot.model.UpdateStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamId
String streamId

 The stream ID.
 


streamArn
String streamArn

 The stream ARN.
 


description
String description

 A description of the stream.
 


streamVersion
Integer streamVersion

 The stream version.
 








Class com.amazonaws.services.iot.model.UpdateThingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingGroupName
String thingGroupName

 The thing group to update.
 


thingGroupProperties
ThingGroupProperties thingGroupProperties

 The thing group properties.
 


expectedVersion
Long expectedVersion

 The expected version of the thing group. If this does not match the version of the thing group being updated, the
 update will fail.
 








Class com.amazonaws.services.iot.model.UpdateThingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


version
Long version

 The version of the updated thing group.
 








Class com.amazonaws.services.iot.model.UpdateThingGroupsForThingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The thing whose group memberships will be updated.
 


thingGroupsToAdd
List<E> thingGroupsToAdd

 The groups to which the thing will be added.
 


thingGroupsToRemove
List<E> thingGroupsToRemove

 The groups from which the thing will be removed.
 


overrideDynamicGroups
Boolean overrideDynamicGroups

 Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10
 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes
 the thing from the last dynamic group.
 








Class com.amazonaws.services.iot.model.UpdateThingGroupsForThingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.UpdateThingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing to update.
 


thingTypeName
String thingTypeName

 The name of the thing type.
 


attributePayload
AttributePayload attributePayload

 A list of thing attributes, a JSON string containing name-value pairs. For example:
 
 
 {\"attributes\":{\"name1\":\"value2\"}}
 
 
 This data is used to add new attributes or update existing attributes.
 


expectedVersion
Long expectedVersion

 The expected version of the thing record in the registry. If the version of the record in the registry does not
 match the expected version specified in the request, the UpdateThing request is rejected with a
 VersionConflictException.
 


removeThingType
Boolean removeThingType

 Remove a thing type association. If true, the association is removed.
 








Class com.amazonaws.services.iot.model.UpdateThingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.UpdateTopicRuleDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The ARN of the topic rule destination.
 


status
String status

 The status of the topic rule destination. Valid values are:
 
 
 IN_PROGRESS
 
 
 A topic rule destination was created but has not been confirmed. You can set status to
 IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
 UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation
 endpoint.
 
 
 ENABLED
 
 
 Confirmation was completed, and traffic to this destination is allowed. You can set status to
 DISABLED by calling UpdateTopicRuleDestination.
 
 
 DISABLED
 
 
 Confirmation was completed, and traffic to this destination is not allowed. You can set status to
 ENABLED by calling UpdateTopicRuleDestination.
 
 
 ERROR
 
 
 Confirmation could not be completed, for example if the confirmation timed out. You can call
 GetTopicRuleDestination for details about the error. You can set status to
 IN_PROGRESS by calling UpdateTopicRuleDestination. Calling
 UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation
 endpoint.
 
 
 








Class com.amazonaws.services.iot.model.UpdateTopicRuleDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot.model.ValidateSecurityProfileBehaviorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


behaviors
List<E> behaviors

 Specifies the behaviors that, when violated by a device (thing), cause an alert.
 








Class com.amazonaws.services.iot.model.ValidateSecurityProfileBehaviorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


valid
Boolean valid

 True if the behaviors were valid.
 


validationErrors
List<E> validationErrors

 The list of any errors found in the behaviors.
 








Class com.amazonaws.services.iot.model.ValidationError extends Object implements Serializable


Serialized Fields


errorMessage
String errorMessage

 The description of an error found in the behaviors.
 








Class com.amazonaws.services.iot.model.VersionConflictException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.VersionsLimitExceededException extends AWSIotException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.ViolationEvent extends Object implements Serializable


Serialized Fields


violationId
String violationId

 The ID of the violation event.
 


thingName
String thingName

 The name of the thing responsible for the violation event.
 


securityProfileName
String securityProfileName

 The name of the security profile whose behavior was violated.
 


behavior
Behavior behavior

 The behavior which was violated.
 


metricValue
MetricValue metricValue

 The value of the metric (the measurement).
 


violationEventType
String violationEventType

 The type of violation event.
 


violationEventTime
Date violationEventTime

 The time the violation event occurred.
 








Package com.amazonaws.services.iot1clickdevices.model




Class com.amazonaws.services.iot1clickdevices.model.Attributes extends Object implements Serializable




Class com.amazonaws.services.iot1clickdevices.model.AWSIoT1ClickDevicesException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot1clickdevices.model.ClaimDevicesByClaimCodeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


claimCode
String claimCode

 The claim code, starting with "C-", as provided by the device manufacturer.
 








Class com.amazonaws.services.iot1clickdevices.model.ClaimDevicesByClaimCodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


claimCode
String claimCode

 The claim code provided by the device manufacturer.
 


total
Integer total

 The total number of devices associated with the claim code that has been processed in the claim request.
 








Class com.amazonaws.services.iot1clickdevices.model.DescribeDeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceId
String deviceId

 The unique identifier of the device.
 








Class com.amazonaws.services.iot1clickdevices.model.DescribeDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deviceDescription
DeviceDescription deviceDescription

 Device details.
 








Class com.amazonaws.services.iot1clickdevices.model.Device extends Object implements Serializable


Serialized Fields


attributes
Attributes attributes

 The user specified attributes associated with the device for an event.
 


deviceId
String deviceId

 The unique identifier of the device.
 


type
String type

 The device type, such as "button".
 








Class com.amazonaws.services.iot1clickdevices.model.DeviceDescription extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the device.
 


attributes
Map<K,V> attributes

 An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
 


deviceId
String deviceId

 The unique identifier of the device.
 


enabled
Boolean enabled

 A Boolean value indicating whether or not the device is enabled.
 


remainingLife
Double remainingLife

 A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
 


type
String type

 The type of the device, such as "button".
 


tags
Map<K,V> tags

 The tags currently associated with the AWS IoT 1-Click device.
 








Class com.amazonaws.services.iot1clickdevices.model.DeviceEvent extends Object implements Serializable


Serialized Fields


device
Device device

 An object representing the device associated with the event.
 


stdEvent
String stdEvent

 A serialized JSON object representing the device-type specific event.
 








Class com.amazonaws.services.iot1clickdevices.model.DeviceMethod extends Object implements Serializable


Serialized Fields


deviceType
String deviceType

 The type of the device, such as "button".
 


methodName
String methodName

 The name of the method applicable to the deviceType.
 








Class com.amazonaws.services.iot1clickdevices.model.FinalizeDeviceClaimRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceId
String deviceId

 The unique identifier of the device.
 


tags
Map<K,V> tags

 A collection of key/value pairs defining the resource tags. For example, { "tags": {"key1": "value1", "key2":
 "value2"} }. For more information, see AWS Tagging Strategies.
 
 
 
 








Class com.amazonaws.services.iot1clickdevices.model.FinalizeDeviceClaimResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


state
String state

 The device's final claim state.
 








Class com.amazonaws.services.iot1clickdevices.model.ForbiddenException extends AWSIoT1ClickDevicesException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code

 403
 








Class com.amazonaws.services.iot1clickdevices.model.GetDeviceMethodsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceId
String deviceId

 The unique identifier of the device.
 








Class com.amazonaws.services.iot1clickdevices.model.GetDeviceMethodsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deviceMethods
List<E> deviceMethods

 List of available device APIs.
 








Class com.amazonaws.services.iot1clickdevices.model.InitiateDeviceClaimRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceId
String deviceId

 The unique identifier of the device.
 








Class com.amazonaws.services.iot1clickdevices.model.InitiateDeviceClaimResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


state
String state

 The device's final claim state.
 








Class com.amazonaws.services.iot1clickdevices.model.InternalFailureException extends AWSIoT1ClickDevicesException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code

 500
 








Class com.amazonaws.services.iot1clickdevices.model.InvalidRequestException extends AWSIoT1ClickDevicesException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code

 400
 








Class com.amazonaws.services.iot1clickdevices.model.InvokeDeviceMethodRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceId
String deviceId

 The unique identifier of the device.
 


deviceMethod
DeviceMethod deviceMethod

 The device method to invoke.
 


deviceMethodParameters
String deviceMethodParameters

 A JSON encoded string containing the device method request parameters.
 








Class com.amazonaws.services.iot1clickdevices.model.InvokeDeviceMethodResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deviceMethodResponse
String deviceMethodResponse

 A JSON encoded string containing the device method response.
 








Class com.amazonaws.services.iot1clickdevices.model.ListDeviceEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceId
String deviceId

 The unique identifier of the device.
 


fromTimeStamp
Date fromTimeStamp

 The start date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z
 


maxResults
Integer maxResults

 The maximum number of results to return per request. If not set, a default value of 100 is used.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 


toTimeStamp
Date toTimeStamp

 The end date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z
 








Class com.amazonaws.services.iot1clickdevices.model.ListDeviceEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


events
List<E> events

 An array of zero or more elements describing the event(s) associated with the device.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 








Class com.amazonaws.services.iot1clickdevices.model.ListDevicesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceType
String deviceType

 The type of the device, such as "button".
 


maxResults
Integer maxResults

 The maximum number of results to return per request. If not set, a default value of 100 is used.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 








Class com.amazonaws.services.iot1clickdevices.model.ListDevicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devices
List<E> devices

 A list of devices.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 








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


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource.
 








Class com.amazonaws.services.iot1clickdevices.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 A collection of key/value pairs defining the resource tags. For example, { "tags": {"key1": "value1", "key2":
 "value2"} }. For more information, see AWS Tagging Strategies.
 
 
 
 








Class com.amazonaws.services.iot1clickdevices.model.PreconditionFailedException extends AWSIoT1ClickDevicesException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code

 412
 








Class com.amazonaws.services.iot1clickdevices.model.RangeNotSatisfiableException extends AWSIoT1ClickDevicesException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code

 416
 








Class com.amazonaws.services.iot1clickdevices.model.ResourceConflictException extends AWSIoT1ClickDevicesException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code

 409
 








Class com.amazonaws.services.iot1clickdevices.model.ResourceNotFoundException extends AWSIoT1ClickDevicesException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code

 404
 








Class com.amazonaws.services.iot1clickdevices.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource.
 


tags
Map<K,V> tags

 A collection of key/value pairs defining the resource tags. For example, { "tags": {"key1": "value1", "key2":
 "value2"} }. For more information, see AWS Tagging Strategies.
 
 
 
 








Class com.amazonaws.services.iot1clickdevices.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot1clickdevices.model.UnclaimDeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceId
String deviceId

 The unique identifier of the device.
 








Class com.amazonaws.services.iot1clickdevices.model.UnclaimDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


state
String state

 The device's final claim state.
 








Class com.amazonaws.services.iot1clickdevices.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource.
 


tagKeys
List<E> tagKeys

 A collections of tag keys. For example, {"key1","key2"}
 








Class com.amazonaws.services.iot1clickdevices.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot1clickdevices.model.UpdateDeviceStateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceId
String deviceId

 The unique identifier of the device.
 


enabled
Boolean enabled

 If true, the device is enabled. If false, the device is disabled.
 








Class com.amazonaws.services.iot1clickdevices.model.UpdateDeviceStateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.iot1clickprojects.model




Class com.amazonaws.services.iot1clickprojects.model.AssociateDeviceWithPlacementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the project containing the placement in which to associate the device.
 


placementName
String placementName

 The name of the placement in which to associate the device.
 


deviceId
String deviceId

 The ID of the physical device to be associated with the given placement in the project. Note that a mandatory 4
 character prefix is required for all deviceId values.
 


deviceTemplateName
String deviceTemplateName

 The device template name to associate with the device ID.
 








Class com.amazonaws.services.iot1clickprojects.model.AssociateDeviceWithPlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot1clickprojects.model.AWSIoT1ClickProjectsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot1clickprojects.model.CreatePlacementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


placementName
String placementName

 The name of the placement to be created.
 


projectName
String projectName

 The name of the project in which to create the placement.
 


attributes
Map<K,V> attributes

 Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement.
 








Class com.amazonaws.services.iot1clickprojects.model.CreatePlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot1clickprojects.model.CreateProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the project to create.
 


description
String description

 An optional description for the project.
 


placementTemplate
PlacementTemplate placementTemplate

 The schema defining the placement to be created. A placement template defines placement default attributes and
 device templates. You cannot add or remove device templates after the project has been created. However, you can
 update callbackOverrides for the device templates using the UpdateProject API.
 


tags
Map<K,V> tags

 Optional tags (metadata key/value pairs) to be associated with the project. For example,
 { {"key1": "value1", "key2": "value2"} }. For more information, see AWS Tagging Strategies.
 








Class com.amazonaws.services.iot1clickprojects.model.CreateProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot1clickprojects.model.DeletePlacementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


placementName
String placementName

 The name of the empty placement to delete.
 


projectName
String projectName

 The project containing the empty placement to delete.
 








Class com.amazonaws.services.iot1clickprojects.model.DeletePlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot1clickprojects.model.DeleteProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the empty project to delete.
 








Class com.amazonaws.services.iot1clickprojects.model.DeleteProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot1clickprojects.model.DescribePlacementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


placementName
String placementName

 The name of the placement within a project.
 


projectName
String projectName

 The project containing the placement to be described.
 








Class com.amazonaws.services.iot1clickprojects.model.DescribePlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


placement
PlacementDescription placement

 An object describing the placement.
 








Class com.amazonaws.services.iot1clickprojects.model.DescribeProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the project to be described.
 








Class com.amazonaws.services.iot1clickprojects.model.DescribeProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


project
ProjectDescription project

 An object describing the project.
 








Class com.amazonaws.services.iot1clickprojects.model.DeviceTemplate extends Object implements Serializable


Serialized Fields


deviceType
String deviceType

 The device type, which currently must be "button".
 


callbackOverrides
Map<K,V> callbackOverrides

 An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.
 








Class com.amazonaws.services.iot1clickprojects.model.DisassociateDeviceFromPlacementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the project that contains the placement.
 


placementName
String placementName

 The name of the placement that the device should be removed from.
 


deviceTemplateName
String deviceTemplateName

 The device ID that should be removed from the placement.
 








Class com.amazonaws.services.iot1clickprojects.model.DisassociateDeviceFromPlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot1clickprojects.model.GetDevicesInPlacementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the project containing the placement.
 


placementName
String placementName

 The name of the placement to get the devices from.
 








Class com.amazonaws.services.iot1clickprojects.model.GetDevicesInPlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devices
Map<K,V> devices

 An object containing the devices (zero or more) within the placement.
 








Class com.amazonaws.services.iot1clickprojects.model.InternalFailureException extends AWSIoT1ClickProjectsException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.iot1clickprojects.model.InvalidRequestException extends AWSIoT1ClickProjectsException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.iot1clickprojects.model.ListPlacementsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The project containing the placements to be listed.
 


nextToken
String nextToken

 The token to retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return per request. If not set, a default value of 100 is used.
 








Class com.amazonaws.services.iot1clickprojects.model.ListPlacementsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


placements
List<E> placements

 An object listing the requested placements.
 


nextToken
String nextToken

 The token used to retrieve the next set of results - will be effectively empty if there are no further results.
 








Class com.amazonaws.services.iot1clickprojects.model.ListProjectsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token to retrieve the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return per request. If not set, a default value of 100 is used.
 








Class com.amazonaws.services.iot1clickprojects.model.ListProjectsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


projects
List<E> projects

 An object containing the list of projects.
 


nextToken
String nextToken

 The token used to retrieve the next set of results - will be effectively empty if there are no further results.
 








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


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource whose tags you want to list.
 








Class com.amazonaws.services.iot1clickprojects.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The tags (metadata key/value pairs) which you have assigned to the resource.
 








Class com.amazonaws.services.iot1clickprojects.model.PlacementDescription extends Object implements Serializable


Serialized Fields


projectName
String projectName

 The name of the project containing the placement.
 


placementName
String placementName

 The name of the placement.
 


attributes
Map<K,V> attributes

 The user-defined attributes associated with the placement.
 


createdDate
Date createdDate

 The date when the placement was initially created, in UNIX epoch time format.
 


updatedDate
Date updatedDate

 The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then
 createdDate and updatedDate are the same.
 








Class com.amazonaws.services.iot1clickprojects.model.PlacementSummary extends Object implements Serializable


Serialized Fields


projectName
String projectName

 The name of the project containing the placement.
 


placementName
String placementName

 The name of the placement being summarized.
 


createdDate
Date createdDate

 The date when the placement was originally created, in UNIX epoch time format.
 


updatedDate
Date updatedDate

 The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then
 createdDate and updatedDate are the same.
 








Class com.amazonaws.services.iot1clickprojects.model.PlacementTemplate extends Object implements Serializable


Serialized Fields


defaultAttributes
Map<K,V> defaultAttributes

 The default attributes (key/value pairs) to be applied to all placements using this template.
 


deviceTemplates
Map<K,V> deviceTemplates

 An object specifying the DeviceTemplate for all placements using this (PlacementTemplate) template.
 








Class com.amazonaws.services.iot1clickprojects.model.ProjectDescription extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the project.
 


projectName
String projectName

 The name of the project for which to obtain information from.
 


description
String description

 The description of the project.
 


createdDate
Date createdDate

 The date when the project was originally created, in UNIX epoch time format.
 


updatedDate
Date updatedDate

 The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then
 createdDate and updatedDate are the same.
 


placementTemplate
PlacementTemplate placementTemplate

 An object describing the project's placement specifications.
 


tags
Map<K,V> tags

 The tags (metadata key/value pairs) associated with the project.
 








Class com.amazonaws.services.iot1clickprojects.model.ProjectSummary extends Object implements Serializable


Serialized Fields


arn
String arn

 The ARN of the project.
 


projectName
String projectName

 The name of the project being summarized.
 


createdDate
Date createdDate

 The date when the project was originally created, in UNIX epoch time format.
 


updatedDate
Date updatedDate

 The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then
 createdDate and updatedDate are the same.
 


tags
Map<K,V> tags

 The tags (metadata key/value pairs) associated with the project.
 








Class com.amazonaws.services.iot1clickprojects.model.ResourceConflictException extends AWSIoT1ClickProjectsException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.iot1clickprojects.model.ResourceNotFoundException extends AWSIoT1ClickProjectsException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.iot1clickprojects.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resouce for which tag(s) should be added or modified.
 


tags
Map<K,V> tags

 The new or modifying tag(s) for the resource. See AWS IoT
 1-Click Service Limits for the maximum number of tags allowed per resource.
 








Class com.amazonaws.services.iot1clickprojects.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot1clickprojects.model.TooManyRequestsException extends AWSIoT1ClickProjectsException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.iot1clickprojects.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource whose tag you want to remove.
 


tagKeys
List<E> tagKeys

 The keys of those tags which you want to remove.
 








Class com.amazonaws.services.iot1clickprojects.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot1clickprojects.model.UpdatePlacementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


placementName
String placementName

 The name of the placement to update.
 


projectName
String projectName

 The name of the project containing the placement to be updated.
 


attributes
Map<K,V> attributes

 The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50.
 








Class com.amazonaws.services.iot1clickprojects.model.UpdatePlacementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iot1clickprojects.model.UpdateProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectName
String projectName

 The name of the project to be updated.
 


description
String description

 An optional user-defined description for the project.
 


placementTemplate
PlacementTemplate placementTemplate

 An object defining the project update. Once a project has been created, you cannot add device template names to
 the project. However, for a given placementTemplate, you can update the associated
 callbackOverrides for the device definition using this API.
 








Class com.amazonaws.services.iot1clickprojects.model.UpdateProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.iotanalytics.model




Class com.amazonaws.services.iotanalytics.model.AddAttributesActivity extends Object implements Serializable


Serialized Fields


name
String name

 The name of the 'addAttributes' activity.
 


attributes
Map<K,V> attributes

 A list of 1-50 "AttributeNameMapping" objects that map an existing attribute to a new attribute.
 
 
 
 The existing attributes remain in the message, so if you want to remove the originals, use
 "RemoveAttributeActivity".
 
 


next
String next

 The next activity in the pipeline.
 








Class com.amazonaws.services.iotanalytics.model.AWSIoTAnalyticsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotanalytics.model.BatchPutMessageErrorEntry extends Object implements Serializable


Serialized Fields


messageId
String messageId

 The ID of the message that caused the error. (See the value corresponding to the "messageId" key in the message
 object.)
 


errorCode
String errorCode

 The code associated with the error.
 


errorMessage
String errorMessage

 The message associated with the error.
 








Class com.amazonaws.services.iotanalytics.model.BatchPutMessageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelName
String channelName

 The name of the channel where the messages are sent.
 


messages
List<E> messages

 The list of messages to be sent. Each message has format: '{ "messageId": "string", "payload": "string"}'.
 
 
 Note that the field names of message payloads (data) that you send to AWS IoT Analytics:
 
 
 
 
 Must contain only alphanumeric characters and undescores (_); no other special characters are allowed.
 
 
 
 
 Must begin with an alphabetic character or single underscore (_).
 
 
 
 
 Cannot contain hyphens (-).
 
 
 
 
 In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
 
 
 
 
 Cannot be greater than 255 characters.
 
 
 
 
 Are case-insensitive. (Fields named "foo" and "FOO" in the same payload are considered duplicates.)
 
 
 
 
 For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01":
 29} are invalid in message payloads.
 








Class com.amazonaws.services.iotanalytics.model.BatchPutMessageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


batchPutMessageErrorEntries
List<E> batchPutMessageErrorEntries

 A list of any errors encountered when sending the messages to the channel.
 








Class com.amazonaws.services.iotanalytics.model.CancelPipelineReprocessingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of pipeline for which data reprocessing is canceled.
 


reprocessingId
String reprocessingId

 The ID of the reprocessing task (returned by "StartPipelineReprocessing").
 








Class com.amazonaws.services.iotanalytics.model.CancelPipelineReprocessingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.Channel extends Object implements Serializable


Serialized Fields


name
String name

 The name of the channel.
 


storage
ChannelStorage storage

 Where channel data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not
 specified, the default is "serviceManagedS3". This cannot be changed after creation of the channel.
 


arn
String arn

 The ARN of the channel.
 


status
String status

 The status of the channel.
 


retentionPeriod
RetentionPeriod retentionPeriod

 How long, in days, message data is kept for the channel.
 


creationTime
Date creationTime

 When the channel was created.
 


lastUpdateTime
Date lastUpdateTime

 When the channel was last updated.
 








Class com.amazonaws.services.iotanalytics.model.ChannelActivity extends Object implements Serializable


Serialized Fields


name
String name

 The name of the 'channel' activity.
 


channelName
String channelName

 The name of the channel from which the messages are processed.
 


next
String next

 The next activity in the pipeline.
 








Class com.amazonaws.services.iotanalytics.model.ChannelStatistics extends Object implements Serializable


Serialized Fields


size
EstimatedResourceSize size

 The estimated size of the channel.
 








Class com.amazonaws.services.iotanalytics.model.ChannelStorage extends Object implements Serializable


Serialized Fields


serviceManagedS3
ServiceManagedChannelS3Storage serviceManagedS3

 Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics service. The choice of
 service-managed or customer-managed S3 storage cannot be changed after creation of the channel.
 


customerManagedS3
CustomerManagedChannelS3Storage customerManagedS3

 Use this to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the
 "retentionPeriod" parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be
 changed after creation of the channel.
 








Class com.amazonaws.services.iotanalytics.model.ChannelStorageSummary extends Object implements Serializable


Serialized Fields


serviceManagedS3
ServiceManagedChannelS3StorageSummary serviceManagedS3

 Used to store channel data in an S3 bucket managed by the AWS IoT Analytics service.
 


customerManagedS3
CustomerManagedChannelS3StorageSummary customerManagedS3

 Used to store channel data in an S3 bucket that you manage.
 








Class com.amazonaws.services.iotanalytics.model.ChannelSummary extends Object implements Serializable


Serialized Fields


channelName
String channelName

 The name of the channel.
 


channelStorage
ChannelStorageSummary channelStorage

 Where channel data is stored.
 


status
String status

 The status of the channel.
 


creationTime
Date creationTime

 When the channel was created.
 


lastUpdateTime
Date lastUpdateTime

 The last time the channel was updated.
 








Class com.amazonaws.services.iotanalytics.model.ContainerDatasetAction extends Object implements Serializable


Serialized Fields


image
String image

 The ARN of the Docker container stored in your account. The Docker container contains an application and needed
 support libraries and is used to generate data set contents.
 


executionRoleArn
String executionRoleArn

 The ARN of the role which gives permission to the system to access needed resources in order to run the
 "containerAction". This includes, at minimum, permission to retrieve the data set contents which are the input to
 the containerized application.
 


resourceConfiguration
ResourceConfiguration resourceConfiguration

 Configuration of the resource which executes the "containerAction".
 


variables
List<E> variables

 The values of variables used within the context of the execution of the containerized application (basically,
 parameters passed to the application). Each variable must have a name and a value given by one of "stringValue",
 "datasetContentVersionValue", or "outputFileUriValue".
 








Class com.amazonaws.services.iotanalytics.model.CreateChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelName
String channelName

 The name of the channel.
 


channelStorage
ChannelStorage channelStorage

 Where channel data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not
 specified, the default is "serviceManagedS3". This cannot be changed after creation of the channel.
 


retentionPeriod
RetentionPeriod retentionPeriod

 How long, in days, message data is kept for the channel. When "customerManagedS3" storage is selected, this
 parameter is ignored.
 


tags
List<E> tags

 Metadata which can be used to manage the channel.
 








Class com.amazonaws.services.iotanalytics.model.CreateChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channelName
String channelName

 The name of the channel.
 


channelArn
String channelArn

 The ARN of the channel.
 


retentionPeriod
RetentionPeriod retentionPeriod

 How long, in days, message data is kept for the channel.
 








Class com.amazonaws.services.iotanalytics.model.CreateDatasetContentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetName
String datasetName

 The name of the data set.
 








Class com.amazonaws.services.iotanalytics.model.CreateDatasetContentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


versionId
String versionId

 The version ID of the data set contents which are being created.
 








Class com.amazonaws.services.iotanalytics.model.CreateDatasetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetName
String datasetName

 The name of the data set.
 


actions
List<E> actions

 A list of actions that create the data set contents.
 


triggers
List<E> triggers

 A list of triggers. A trigger causes data set contents to be populated at a specified time interval or when
 another data set's contents are created. The list of triggers can be empty or contain up to five
 DataSetTrigger objects.
 


contentDeliveryRules
List<E> contentDeliveryRules

 When data set contents are created they are delivered to destinations specified here.
 


retentionPeriod
RetentionPeriod retentionPeriod

 [Optional] How long, in days, versions of data set contents are kept for the data set. If not specified or set to
 null, versions of data set contents are retained for at most 90 days. The number of versions of data set contents
 retained is determined by the versioningConfiguration parameter. (For more information, see
 https://docs
 .aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
 


versioningConfiguration
VersioningConfiguration versioningConfiguration

 [Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest
 version plus the latest succeeded version (if they are different) are kept for the time period specified by the
 "retentionPeriod" parameter. (For more information, see
 https://docs.aws.amazon.com/iotanalytics/latest/userguide/
 getting-started.html#aws-iot-analytics-dataset-versions)
 


tags
List<E> tags

 Metadata which can be used to manage the data set.
 








Class com.amazonaws.services.iotanalytics.model.CreateDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetName
String datasetName

 The name of the data set.
 


datasetArn
String datasetArn

 The ARN of the data set.
 


retentionPeriod
RetentionPeriod retentionPeriod

 How long, in days, data set contents are kept for the data set.
 








Class com.amazonaws.services.iotanalytics.model.CreateDatastoreRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datastoreName
String datastoreName

 The name of the data store.
 


datastoreStorage
DatastoreStorage datastoreStorage

 Where data store data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not
 specified, the default is "serviceManagedS3". This cannot be changed after the data store is created.
 


retentionPeriod
RetentionPeriod retentionPeriod

 How long, in days, message data is kept for the data store. When "customerManagedS3" storage is selected, this
 parameter is ignored.
 


tags
List<E> tags

 Metadata which can be used to manage the data store.
 








Class com.amazonaws.services.iotanalytics.model.CreateDatastoreResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datastoreName
String datastoreName

 The name of the data store.
 


datastoreArn
String datastoreArn

 The ARN of the data store.
 


retentionPeriod
RetentionPeriod retentionPeriod

 How long, in days, message data is kept for the data store.
 








Class com.amazonaws.services.iotanalytics.model.CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline.
 


pipelineActivities
List<E> pipelineActivities

 A list of "PipelineActivity" objects. Activities perform transformations on your messages, such as removing,
 renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda
 functions on messages for advanced processing; or performing mathematical transformations to normalize device
 data.
 
 
 The list can be 2-25 PipelineActivity objects and must contain both a channel and a
 datastore activity. Each entry in the list must contain only one activity, for example:
 
 
 pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
 


tags
List<E> tags

 Metadata which can be used to manage the pipeline.
 








Class com.amazonaws.services.iotanalytics.model.CreatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline.
 


pipelineArn
String pipelineArn

 The ARN of the pipeline.
 








Class com.amazonaws.services.iotanalytics.model.CustomerManagedChannelS3Storage extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The name of the Amazon S3 bucket in which channel data is stored.
 


keyPrefix
String keyPrefix

 [Optional] The prefix used to create the keys of the channel data objects. Each object in an Amazon S3 bucket has
 a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix
 must end with a '/'.
 


roleArn
String roleArn

 The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
 








Class com.amazonaws.services.iotanalytics.model.CustomerManagedChannelS3StorageSummary extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The name of the Amazon S3 bucket in which channel data is stored.
 


keyPrefix
String keyPrefix

 [Optional] The prefix used to create the keys of the channel data objects. Each object in an Amazon S3 bucket has
 a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix
 must end with a '/'.
 


roleArn
String roleArn

 The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
 








Class com.amazonaws.services.iotanalytics.model.CustomerManagedDatastoreS3Storage extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The name of the Amazon S3 bucket in which data store data is stored.
 


keyPrefix
String keyPrefix

 [Optional] The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket
 has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The
 prefix must end with a '/'.
 


roleArn
String roleArn

 The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
 








Class com.amazonaws.services.iotanalytics.model.CustomerManagedDatastoreS3StorageSummary extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The name of the Amazon S3 bucket in which data store data is stored.
 


keyPrefix
String keyPrefix

 [Optional] The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket
 has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The
 prefix must end with a '/'.
 


roleArn
String roleArn

 The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
 








Class com.amazonaws.services.iotanalytics.model.Dataset extends Object implements Serializable


Serialized Fields


name
String name

 The name of the data set.
 


arn
String arn

 The ARN of the data set.
 


actions
List<E> actions

 The "DatasetAction" objects that automatically create the data set contents.
 


triggers
List<E> triggers

 The "DatasetTrigger" objects that specify when the data set is automatically updated.
 


contentDeliveryRules
List<E> contentDeliveryRules

 When data set contents are created they are delivered to destinations specified here.
 


status
String status

 The status of the data set.
 


creationTime
Date creationTime

 When the data set was created.
 


lastUpdateTime
Date lastUpdateTime

 The last time the data set was updated.
 


retentionPeriod
RetentionPeriod retentionPeriod

 [Optional] How long, in days, message data is kept for the data set.
 


versioningConfiguration
VersioningConfiguration versioningConfiguration

 [Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest
 version plus the latest succeeded version (if they are different) are kept for the time period specified by the
 "retentionPeriod" parameter. (For more information, see
 https://docs.aws.amazon.com/iotanalytics/latest/userguide/
 getting-started.html#aws-iot-analytics-dataset-versions)
 








Class com.amazonaws.services.iotanalytics.model.DatasetAction extends Object implements Serializable


Serialized Fields


actionName
String actionName

 The name of the data set action by which data set contents are automatically created.
 


queryAction
SqlQueryDatasetAction queryAction

 An "SqlQueryDatasetAction" object that uses an SQL query to automatically create data set contents.
 


containerAction
ContainerDatasetAction containerAction

 Information which allows the system to run a containerized application in order to create the data set contents.
 The application must be in a Docker container along with any needed support libraries.
 








Class com.amazonaws.services.iotanalytics.model.DatasetActionSummary extends Object implements Serializable


Serialized Fields


actionName
String actionName

 The name of the action which automatically creates the data set's contents.
 


actionType
String actionType

 The type of action by which the data set's contents are automatically created.
 








Class com.amazonaws.services.iotanalytics.model.DatasetContentDeliveryDestination extends Object implements Serializable


Serialized Fields


iotEventsDestinationConfiguration
IotEventsDestinationConfiguration iotEventsDestinationConfiguration

 Configuration information for delivery of data set contents to AWS IoT Events.
 


s3DestinationConfiguration
S3DestinationConfiguration s3DestinationConfiguration

 Configuration information for delivery of data set contents to Amazon S3.
 








Class com.amazonaws.services.iotanalytics.model.DatasetContentDeliveryRule extends Object implements Serializable


Serialized Fields


entryName
String entryName

 The name of the data set content delivery rules entry.
 


destination
DatasetContentDeliveryDestination destination

 The destination to which data set contents are delivered.
 








Class com.amazonaws.services.iotanalytics.model.DatasetContentStatus extends Object implements Serializable


Serialized Fields


state
String state

 The state of the data set contents. Can be one of "READY", "CREATING", "SUCCEEDED" or "FAILED".
 


reason
String reason

 The reason the data set contents are in this state.
 








Class com.amazonaws.services.iotanalytics.model.DatasetContentSummary extends Object implements Serializable


Serialized Fields


version
String version

 The version of the data set contents.
 


status
DatasetContentStatus status

 The status of the data set contents.
 


creationTime
Date creationTime

 The actual time the creation of the data set contents was started.
 


scheduleTime
Date scheduleTime

 The time the creation of the data set contents was scheduled to start.
 


completionTime
Date completionTime

 The time the dataset content status was updated to SUCCEEDED or FAILED.
 








Class com.amazonaws.services.iotanalytics.model.DatasetContentVersionValue extends Object implements Serializable


Serialized Fields


datasetName
String datasetName

 The name of the data set whose latest contents are used as input to the notebook or application.
 








Class com.amazonaws.services.iotanalytics.model.DatasetEntry extends Object implements Serializable


Serialized Fields


entryName
String entryName

 The name of the data set item.
 


dataURI
String dataURI

 The pre-signed URI of the data set item.
 








Class com.amazonaws.services.iotanalytics.model.DatasetSummary extends Object implements Serializable


Serialized Fields


datasetName
String datasetName

 The name of the data set.
 


status
String status

 The status of the data set.
 


creationTime
Date creationTime

 The time the data set was created.
 


lastUpdateTime
Date lastUpdateTime

 The last time the data set was updated.
 


triggers
List<E> triggers

 A list of triggers. A trigger causes data set content to be populated at a specified time interval or when
 another data set is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects
 


actions
List<E> actions

 A list of "DataActionSummary" objects.
 








Class com.amazonaws.services.iotanalytics.model.DatasetTrigger extends Object implements Serializable


Serialized Fields


schedule
Schedule schedule

 The "Schedule" when the trigger is initiated.
 


dataset
TriggeringDataset dataset

 The data set whose content creation triggers the creation of this data set's contents.
 








Class com.amazonaws.services.iotanalytics.model.Datastore extends Object implements Serializable


Serialized Fields


name
String name

 The name of the data store.
 


storage
DatastoreStorage storage

 Where data store data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not
 specified, the default is "serviceManagedS3". This cannot be changed after the data store is created.
 


arn
String arn

 The ARN of the data store.
 


status
String status

 The status of a data store:
 
 
 CREATING
 
 
 The data store is being created.
 
 
 ACTIVE
 
 
 The data store has been created and can be used.
 
 
 DELETING
 
 
 The data store is being deleted.
 
 
 


retentionPeriod
RetentionPeriod retentionPeriod

 How long, in days, message data is kept for the data store. When "customerManagedS3" storage is selected, this
 parameter is ignored.
 


creationTime
Date creationTime

 When the data store was created.
 


lastUpdateTime
Date lastUpdateTime

 The last time the data store was updated.
 








Class com.amazonaws.services.iotanalytics.model.DatastoreActivity extends Object implements Serializable


Serialized Fields


name
String name

 The name of the 'datastore' activity.
 


datastoreName
String datastoreName

 The name of the data store where processed messages are stored.
 








Class com.amazonaws.services.iotanalytics.model.DatastoreStatistics extends Object implements Serializable


Serialized Fields


size
EstimatedResourceSize size

 The estimated size of the data store.
 








Class com.amazonaws.services.iotanalytics.model.DatastoreStorage extends Object implements Serializable


Serialized Fields


serviceManagedS3
ServiceManagedDatastoreS3Storage serviceManagedS3

 Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of
 service-managed or customer-managed S3 storage cannot be changed after creation of the data store.
 


customerManagedS3
CustomerManagedDatastoreS3Storage customerManagedS3

 Use this to store data store data in an S3 bucket that you manage. When customer managed storage is selected, the
 "retentionPeriod" parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be
 changed after creation of the data store.
 








Class com.amazonaws.services.iotanalytics.model.DatastoreStorageSummary extends Object implements Serializable


Serialized Fields


serviceManagedS3
ServiceManagedDatastoreS3StorageSummary serviceManagedS3

 Used to store data store data in an S3 bucket managed by the AWS IoT Analytics service.
 


customerManagedS3
CustomerManagedDatastoreS3StorageSummary customerManagedS3

 Used to store data store data in an S3 bucket that you manage.
 








Class com.amazonaws.services.iotanalytics.model.DatastoreSummary extends Object implements Serializable


Serialized Fields


datastoreName
String datastoreName

 The name of the data store.
 


datastoreStorage
DatastoreStorageSummary datastoreStorage

 Where data store data is stored.
 


status
String status

 The status of the data store.
 


creationTime
Date creationTime

 When the data store was created.
 


lastUpdateTime
Date lastUpdateTime

 The last time the data store was updated.
 








Class com.amazonaws.services.iotanalytics.model.DeleteChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelName
String channelName

 The name of the channel to delete.
 








Class com.amazonaws.services.iotanalytics.model.DeleteChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.DeleteDatasetContentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetName
String datasetName

 The name of the data set whose content is deleted.
 


versionId
String versionId

 The version of the data set whose content is deleted. You can also use the strings "$LATEST" or
 "$LATEST_SUCCEEDED" to delete the latest or latest successfully completed data set. If not specified,
 "$LATEST_SUCCEEDED" is the default.
 








Class com.amazonaws.services.iotanalytics.model.DeleteDatasetContentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.DeleteDatasetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetName
String datasetName

 The name of the data set to delete.
 








Class com.amazonaws.services.iotanalytics.model.DeleteDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.DeleteDatastoreRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datastoreName
String datastoreName

 The name of the data store to delete.
 








Class com.amazonaws.services.iotanalytics.model.DeleteDatastoreResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline to delete.
 








Class com.amazonaws.services.iotanalytics.model.DeletePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.DeltaTime extends Object implements Serializable


Serialized Fields


offsetSeconds
Integer offsetSeconds

 The number of seconds of estimated "in flight" lag time of message data. When you create data set contents using
 message data from a specified time frame, some message data may still be "in flight" when processing begins, and
 so will not arrive in time to be processed. Use this field to make allowances for the "in flight" time of your
 message data, so that data not processed from a previous time frame will be included with the next time frame.
 Without this, missed message data would be excluded from processing during the next time frame as well, because
 its timestamp places it within the previous time frame.
 


timeExpression
String timeExpression

 An expression by which the time of the message data may be determined. This may be the name of a timestamp field,
 or a SQL expression which is used to derive the time the message data was generated.
 








Class com.amazonaws.services.iotanalytics.model.DescribeChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelName
String channelName

 The name of the channel whose information is retrieved.
 


includeStatistics
Boolean includeStatistics

 If true, additional statistical information about the channel is included in the response. This feature cannot be
 used with a channel whose S3 storage is customer-managed.
 








Class com.amazonaws.services.iotanalytics.model.DescribeChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channel
Channel channel

 An object that contains information about the channel.
 


statistics
ChannelStatistics statistics

 Statistics about the channel. Included if the 'includeStatistics' parameter is set to true in the request.
 








Class com.amazonaws.services.iotanalytics.model.DescribeDatasetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetName
String datasetName

 The name of the data set whose information is retrieved.
 








Class com.amazonaws.services.iotanalytics.model.DescribeDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataset
Dataset dataset

 An object that contains information about the data set.
 








Class com.amazonaws.services.iotanalytics.model.DescribeDatastoreRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datastoreName
String datastoreName

 The name of the data store
 


includeStatistics
Boolean includeStatistics

 If true, additional statistical information about the data store is included in the response. This feature cannot
 be used with a data store whose S3 storage is customer-managed.
 








Class com.amazonaws.services.iotanalytics.model.DescribeDatastoreResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datastore
Datastore datastore

 Information about the data store.
 


statistics
DatastoreStatistics statistics

 Additional statistical information about the data store. Included if the 'includeStatistics' parameter is set to
 true in the request.
 








Class com.amazonaws.services.iotanalytics.model.DescribeLoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iotanalytics.model.DescribeLoggingOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loggingOptions
LoggingOptions loggingOptions

 The current settings of the AWS IoT Analytics logging options.
 








Class com.amazonaws.services.iotanalytics.model.DescribePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline whose information is retrieved.
 








Class com.amazonaws.services.iotanalytics.model.DescribePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipeline
Pipeline pipeline

 A "Pipeline" object that contains information about the pipeline.
 








Class com.amazonaws.services.iotanalytics.model.DeviceRegistryEnrichActivity extends Object implements Serializable


Serialized Fields


name
String name

 The name of the 'deviceRegistryEnrich' activity.
 


attribute
String attribute

 The name of the attribute that is added to the message.
 


thingName
String thingName

 The name of the IoT device whose registry information is added to the message.
 


roleArn
String roleArn

 The ARN of the role that allows access to the device's registry information.
 


next
String next

 The next activity in the pipeline.
 








Class com.amazonaws.services.iotanalytics.model.DeviceShadowEnrichActivity extends Object implements Serializable


Serialized Fields


name
String name

 The name of the 'deviceShadowEnrich' activity.
 


attribute
String attribute

 The name of the attribute that is added to the message.
 


thingName
String thingName

 The name of the IoT device whose shadow information is added to the message.
 


roleArn
String roleArn

 The ARN of the role that allows access to the device's shadow.
 


next
String next

 The next activity in the pipeline.
 








Class com.amazonaws.services.iotanalytics.model.EstimatedResourceSize extends Object implements Serializable


Serialized Fields


estimatedSizeInBytes
Double estimatedSizeInBytes

 The estimated size of the resource in bytes.
 


estimatedOn
Date estimatedOn

 The time when the estimate of the size of the resource was made.
 








Class com.amazonaws.services.iotanalytics.model.FilterActivity extends Object implements Serializable


Serialized Fields


name
String name

 The name of the 'filter' activity.
 


filter
String filter

 An expression that looks like a SQL WHERE clause that must return a Boolean value.
 


next
String next

 The next activity in the pipeline.
 








Class com.amazonaws.services.iotanalytics.model.GetDatasetContentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetName
String datasetName

 The name of the data set whose contents are retrieved.
 


versionId
String versionId

 The version of the data set whose contents are retrieved. You can also use the strings "$LATEST" or
 "$LATEST_SUCCEEDED" to retrieve the contents of the latest or latest successfully completed data set. If not
 specified, "$LATEST_SUCCEEDED" is the default.
 








Class com.amazonaws.services.iotanalytics.model.GetDatasetContentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entries
List<E> entries

 A list of "DatasetEntry" objects.
 


timestamp
Date timestamp

 The time when the request was made.
 


status
DatasetContentStatus status

 The status of the data set content.
 








Class com.amazonaws.services.iotanalytics.model.GlueConfiguration extends Object implements Serializable


Serialized Fields


tableName
String tableName

 The name of the table in your AWS Glue Data Catalog which is used to perform the ETL (extract, transform and
 load) operations. (An AWS Glue Data Catalog table contains partitioned data and descriptions of data sources and
 targets.)
 


databaseName
String databaseName

 The name of the database in your AWS Glue Data Catalog in which the table is located. (An AWS Glue Data Catalog
 database contains Glue Data tables.)
 








Class com.amazonaws.services.iotanalytics.model.InternalFailureException extends AWSIoTAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotanalytics.model.InvalidRequestException extends AWSIoTAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotanalytics.model.IotEventsDestinationConfiguration extends Object implements Serializable


Serialized Fields


inputName
String inputName

 The name of the AWS IoT Events input to which data set contents are delivered.
 


roleArn
String roleArn

 The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents to an AWS IoT Events
 input.
 








Class com.amazonaws.services.iotanalytics.model.LambdaActivity extends Object implements Serializable


Serialized Fields


name
String name

 The name of the 'lambda' activity.
 


lambdaName
String lambdaName

 The name of the Lambda function that is run on the message.
 


batchSize
Integer batchSize

 The number of messages passed to the Lambda function for processing.
 
 
 The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum
 timeout duration for Lambda functions.
 


next
String next

 The next activity in the pipeline.
 








Class com.amazonaws.services.iotanalytics.model.LimitExceededException extends AWSIoTAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotanalytics.model.ListChannelsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in this request.
 
 
 The default value is 100.
 








Class com.amazonaws.services.iotanalytics.model.ListChannelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channelSummaries
List<E> channelSummaries

 A list of "ChannelSummary" objects.
 


nextToken
String nextToken

 The token to retrieve the next set of results, or null if there are no more results.
 








Class com.amazonaws.services.iotanalytics.model.ListDatasetContentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetName
String datasetName

 The name of the data set whose contents information you want to list.
 


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in this request.
 


scheduledOnOrAfter
Date scheduledOnOrAfter

 A filter to limit results to those data set contents whose creation is scheduled on or after the given time. See
 the field triggers.schedule in the CreateDataset request. (timestamp)
 


scheduledBefore
Date scheduledBefore

 A filter to limit results to those data set contents whose creation is scheduled before the given time. See the
 field triggers.schedule in the CreateDataset request. (timestamp)
 








Class com.amazonaws.services.iotanalytics.model.ListDatasetContentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetContentSummaries
List<E> datasetContentSummaries

 Summary information about data set contents that have been created.
 


nextToken
String nextToken

 The token to retrieve the next set of results, or null if there are no more results.
 








Class com.amazonaws.services.iotanalytics.model.ListDatasetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in this request.
 
 
 The default value is 100.
 








Class com.amazonaws.services.iotanalytics.model.ListDatasetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetSummaries
List<E> datasetSummaries

 A list of "DatasetSummary" objects.
 


nextToken
String nextToken

 The token to retrieve the next set of results, or null if there are no more results.
 








Class com.amazonaws.services.iotanalytics.model.ListDatastoresRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in this request.
 
 
 The default value is 100.
 








Class com.amazonaws.services.iotanalytics.model.ListDatastoresResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datastoreSummaries
List<E> datastoreSummaries

 A list of "DatastoreSummary" objects.
 


nextToken
String nextToken

 The token to retrieve the next set of results, or null if there are no more results.
 








Class com.amazonaws.services.iotanalytics.model.ListPipelinesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return in this request.
 
 
 The default value is 100.
 








Class com.amazonaws.services.iotanalytics.model.ListPipelinesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pipelineSummaries
List<E> pipelineSummaries

 A list of "PipelineSummary" objects.
 


nextToken
String nextToken

 The token to retrieve the next set of results, or null if there are no more results.
 








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


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource whose tags you want to list.
 








Class com.amazonaws.services.iotanalytics.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The tags (metadata) which you have assigned to the resource.
 








Class com.amazonaws.services.iotanalytics.model.LoggingOptions extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the role that grants permission to AWS IoT Analytics to perform logging.
 


level
String level

 The logging level. Currently, only "ERROR" is supported.
 


enabled
Boolean enabled

 If true, logging is enabled for AWS IoT Analytics.
 








Class com.amazonaws.services.iotanalytics.model.MathActivity extends Object implements Serializable


Serialized Fields


name
String name

 The name of the 'math' activity.
 


attribute
String attribute

 The name of the attribute that contains the result of the math operation.
 


math
String math

 An expression that uses one or more existing attributes and must return an integer value.
 


next
String next

 The next activity in the pipeline.
 








Class com.amazonaws.services.iotanalytics.model.Message extends Object implements Serializable


Serialized Fields


messageId
String messageId

 The ID you wish to assign to the message. Each "messageId" must be unique within each batch sent.
 


payload
ByteBuffer payload

 The payload of the message. This may be a JSON string or a Base64-encoded string representing binary data (in
 which case you must decode it by means of a pipeline activity).
 








Class com.amazonaws.services.iotanalytics.model.OutputFileUriValue extends Object implements Serializable


Serialized Fields


fileName
String fileName

 The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket.
 








Class com.amazonaws.services.iotanalytics.model.Pipeline extends Object implements Serializable


Serialized Fields


name
String name

 The name of the pipeline.
 


arn
String arn

 The ARN of the pipeline.
 


activities
List<E> activities

 The activities that perform transformations on the messages.
 


reprocessingSummaries
List<E> reprocessingSummaries

 A summary of information about the pipeline reprocessing.
 


creationTime
Date creationTime

 When the pipeline was created.
 


lastUpdateTime
Date lastUpdateTime

 The last time the pipeline was updated.
 








Class com.amazonaws.services.iotanalytics.model.PipelineActivity extends Object implements Serializable


Serialized Fields


channel
ChannelActivity channel

 Determines the source of the messages to be processed.
 


lambda
LambdaActivity lambda

 Runs a Lambda function to modify the message.
 


datastore
DatastoreActivity datastore

 Specifies where to store the processed message data.
 


addAttributes
AddAttributesActivity addAttributes

 Adds other attributes based on existing attributes in the message.
 


removeAttributes
RemoveAttributesActivity removeAttributes

 Removes attributes from a message.
 


selectAttributes
SelectAttributesActivity selectAttributes

 Creates a new message using only the specified attributes from the original message.
 


filter
FilterActivity filter

 Filters a message based on its attributes.
 


math
MathActivity math

 Computes an arithmetic expression using the message's attributes and adds it to the message.
 


deviceRegistryEnrich
DeviceRegistryEnrichActivity deviceRegistryEnrich

 Adds data from the AWS IoT device registry to your message.
 


deviceShadowEnrich
DeviceShadowEnrichActivity deviceShadowEnrich

 Adds information from the AWS IoT Device Shadows service to a message.
 








Class com.amazonaws.services.iotanalytics.model.PipelineSummary extends Object implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline.
 


reprocessingSummaries
List<E> reprocessingSummaries

 A summary of information about the pipeline reprocessing.
 


creationTime
Date creationTime

 When the pipeline was created.
 


lastUpdateTime
Date lastUpdateTime

 When the pipeline was last updated.
 








Class com.amazonaws.services.iotanalytics.model.PutLoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loggingOptions
LoggingOptions loggingOptions

 The new values of the AWS IoT Analytics logging options.
 








Class com.amazonaws.services.iotanalytics.model.PutLoggingOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.QueryFilter extends Object implements Serializable


Serialized Fields


deltaTime
DeltaTime deltaTime

 Used to limit data to that which has arrived since the last execution of the action.
 








Class com.amazonaws.services.iotanalytics.model.RemoveAttributesActivity extends Object implements Serializable


Serialized Fields


name
String name

 The name of the 'removeAttributes' activity.
 


attributes
List<E> attributes

 A list of 1-50 attributes to remove from the message.
 


next
String next

 The next activity in the pipeline.
 








Class com.amazonaws.services.iotanalytics.model.ReprocessingSummary extends Object implements Serializable


Serialized Fields


id
String id

 The 'reprocessingId' returned by "StartPipelineReprocessing".
 


status
String status

 The status of the pipeline reprocessing.
 


creationTime
Date creationTime

 The time the pipeline reprocessing was created.
 








Class com.amazonaws.services.iotanalytics.model.ResourceAlreadyExistsException extends AWSIoTAnalyticsException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceId
String resourceId

 The ID of the resource.
 


resourceArn
String resourceArn

 The ARN of the resource.
 








Class com.amazonaws.services.iotanalytics.model.ResourceConfiguration extends Object implements Serializable


Serialized Fields


computeType
String computeType

 The type of the compute resource used to execute the "containerAction". Possible values are: ACU_1 (vCPU=4,
 memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB).
 


volumeSizeInGB
Integer volumeSizeInGB

 The size (in GB) of the persistent storage available to the resource instance used to execute the
 "containerAction" (min: 1, max: 50).
 








Class com.amazonaws.services.iotanalytics.model.ResourceNotFoundException extends AWSIoTAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotanalytics.model.RetentionPeriod extends Object implements Serializable


Serialized Fields


unlimited
Boolean unlimited

 If true, message data is kept indefinitely.
 


numberOfDays
Integer numberOfDays

 The number of days that message data is kept. The "unlimited" parameter must be false.
 








Class com.amazonaws.services.iotanalytics.model.RunPipelineActivityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineActivity
PipelineActivity pipelineActivity

 The pipeline activity that is run. This must not be a 'channel' activity or a 'datastore' activity because these
 activities are used in a pipeline only to load the original message and to store the (possibly) transformed
 message. If a 'lambda' activity is specified, only short-running Lambda functions (those with a timeout of less
 than 30 seconds or less) can be used.
 


payloads
List<E> payloads

 The sample message payloads on which the pipeline activity is run.
 








Class com.amazonaws.services.iotanalytics.model.RunPipelineActivityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


payloads
List<E> payloads

 The enriched or transformed sample message payloads as base64-encoded strings. (The results of running the
 pipeline activity on each input sample message payload, encoded in base64.)
 


logResult
String logResult

 In case the pipeline activity fails, the log message that is generated.
 








Class com.amazonaws.services.iotanalytics.model.S3DestinationConfiguration extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The name of the Amazon S3 bucket to which data set contents are delivered.
 


key
String key

 The key of the data set contents object. Each object in an Amazon S3 bucket has a key that is its unique
 identifier within the bucket (each object in a bucket has exactly one key). To produce a unique key, you can use
 "!{iotanalytics:scheduledTime}" to insert the time of the scheduled SQL query run, or
 "!{iotanalytics:versioned} to insert a unique hash identifying the data set, for example: "
 /DataSet/!{iotanalytics:scheduledTime}/!{iotanalytics:versioned}.csv".
 


glueConfiguration
GlueConfiguration glueConfiguration

 Configuration information for coordination with the AWS Glue ETL (extract, transform and load) service.
 


roleArn
String roleArn

 The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue
 resources.
 








Class com.amazonaws.services.iotanalytics.model.SampleChannelDataRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelName
String channelName

 The name of the channel whose message samples are retrieved.
 


maxMessages
Integer maxMessages

 The number of sample messages to be retrieved. The limit is 10, the default is also 10.
 


startTime
Date startTime

 The start of the time window from which sample messages are retrieved.
 


endTime
Date endTime

 The end of the time window from which sample messages are retrieved.
 








Class com.amazonaws.services.iotanalytics.model.SampleChannelDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


payloads
List<E> payloads

 The list of message samples. Each sample message is returned as a base64-encoded string.
 








Class com.amazonaws.services.iotanalytics.model.Schedule extends Object implements Serializable


Serialized Fields


expression
String expression

 The expression that defines when to trigger an update. For more information, see  Schedule Expressions for
 Rules in the Amazon CloudWatch Events User Guide.
 








Class com.amazonaws.services.iotanalytics.model.SelectAttributesActivity extends Object implements Serializable


Serialized Fields


name
String name

 The name of the 'selectAttributes' activity.
 


attributes
List<E> attributes

 A list of the attributes to select from the message.
 


next
String next

 The next activity in the pipeline.
 








Class com.amazonaws.services.iotanalytics.model.ServiceManagedChannelS3Storage extends Object implements Serializable




Class com.amazonaws.services.iotanalytics.model.ServiceManagedChannelS3StorageSummary extends Object implements Serializable




Class com.amazonaws.services.iotanalytics.model.ServiceManagedDatastoreS3Storage extends Object implements Serializable




Class com.amazonaws.services.iotanalytics.model.ServiceManagedDatastoreS3StorageSummary extends Object implements Serializable




Class com.amazonaws.services.iotanalytics.model.ServiceUnavailableException extends AWSIoTAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotanalytics.model.SqlQueryDatasetAction extends Object implements Serializable


Serialized Fields


sqlQuery
String sqlQuery

 A SQL query string.
 


filters
List<E> filters

 Pre-filters applied to message data.
 








Class com.amazonaws.services.iotanalytics.model.StartPipelineReprocessingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline on which to start reprocessing.
 


startTime
Date startTime

 The start time (inclusive) of raw message data that is reprocessed.
 


endTime
Date endTime

 The end time (exclusive) of raw message data that is reprocessed.
 








Class com.amazonaws.services.iotanalytics.model.StartPipelineReprocessingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reprocessingId
String reprocessingId

 The ID of the pipeline reprocessing activity that was started.
 








Class com.amazonaws.services.iotanalytics.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The tag's key.
 


value
String value

 The tag's value.
 








Class com.amazonaws.services.iotanalytics.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource whose tags you want to modify.
 


tags
List<E> tags

 The new or modified tags for the resource.
 








Class com.amazonaws.services.iotanalytics.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.ThrottlingException extends AWSIoTAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotanalytics.model.TriggeringDataset extends Object implements Serializable


Serialized Fields


name
String name

 The name of the data set whose content generation triggers the new data set content generation.
 








Class com.amazonaws.services.iotanalytics.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource whose tags you want to remove.
 


tagKeys
List<E> tagKeys

 The keys of those tags which you want to remove.
 








Class com.amazonaws.services.iotanalytics.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.UpdateChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelName
String channelName

 The name of the channel to be updated.
 


channelStorage
ChannelStorage channelStorage

 Where channel data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not
 specified, the default is "serviceManagedS3". This cannot be changed after creation of the channel.
 


retentionPeriod
RetentionPeriod retentionPeriod

 How long, in days, message data is kept for the channel. The retention period cannot be updated if the channel's
 S3 storage is customer-managed.
 








Class com.amazonaws.services.iotanalytics.model.UpdateChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.UpdateDatasetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datasetName
String datasetName

 The name of the data set to update.
 


actions
List<E> actions

 A list of "DatasetAction" objects.
 


triggers
List<E> triggers

 A list of "DatasetTrigger" objects. The list can be empty or can contain up to five DataSetTrigger
 objects.
 


contentDeliveryRules
List<E> contentDeliveryRules

 When data set contents are created they are delivered to destinations specified here.
 


retentionPeriod
RetentionPeriod retentionPeriod

 How long, in days, data set contents are kept for the data set.
 


versioningConfiguration
VersioningConfiguration versioningConfiguration

 [Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest
 version plus the latest succeeded version (if they are different) are kept for the time period specified by the
 "retentionPeriod" parameter. (For more information, see
 https://docs.aws.amazon.com/iotanalytics/latest/userguide/
 getting-started.html#aws-iot-analytics-dataset-versions)
 








Class com.amazonaws.services.iotanalytics.model.UpdateDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.UpdateDatastoreRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


datastoreName
String datastoreName

 The name of the data store to be updated.
 


retentionPeriod
RetentionPeriod retentionPeriod

 How long, in days, message data is kept for the data store. The retention period cannot be updated if the data
 store's S3 storage is customer-managed.
 


datastoreStorage
DatastoreStorage datastoreStorage

 Where data store data is stored. You may choose one of "serviceManagedS3" or "customerManagedS3" storage. If not
 specified, the default is "serviceManagedS3". This cannot be changed after the data store is created.
 








Class com.amazonaws.services.iotanalytics.model.UpdateDatastoreResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.UpdatePipelineRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pipelineName
String pipelineName

 The name of the pipeline to update.
 


pipelineActivities
List<E> pipelineActivities

 A list of "PipelineActivity" objects. Activities perform transformations on your messages, such as removing,
 renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda
 functions on messages for advanced processing; or performing mathematical transformations to normalize device
 data.
 
 
 The list can be 2-25 PipelineActivity objects and must contain both a channel and a
 datastore activity. Each entry in the list must contain only one activity, for example:
 
 
 pipelineActivities = [ { "channel": { ... } }, { "lambda": { ... } }, ... ]
 








Class com.amazonaws.services.iotanalytics.model.UpdatePipelineResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotanalytics.model.Variable extends Object implements Serializable


Serialized Fields


name
String name

 The name of the variable.
 


stringValue
String stringValue

 The value of the variable as a string.
 


doubleValue
Double doubleValue

 The value of the variable as a double (numeric).
 


datasetContentVersionValue
DatasetContentVersionValue datasetContentVersionValue

 The value of the variable as a structure that specifies a data set content version.
 


outputFileUriValue
OutputFileUriValue outputFileUriValue

 The value of the variable as a structure that specifies an output file URI.
 








Class com.amazonaws.services.iotanalytics.model.VersioningConfiguration extends Object implements Serializable


Serialized Fields


unlimited
Boolean unlimited

 If true, unlimited versions of data set contents will be kept.
 


maxVersions
Integer maxVersions

 How many versions of data set contents will be kept. The "unlimited" parameter must be false.
 








Package com.amazonaws.services.iotdata.model




Class com.amazonaws.services.iotdata.model.AWSIotDataException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.ConflictException extends AWSIotDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.DeleteThingShadowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing.
 








Class com.amazonaws.services.iotdata.model.DeleteThingShadowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


payload
ByteBuffer payload

 The state information, in JSON format.
 








Class com.amazonaws.services.iotdata.model.GetThingShadowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing.
 








Class com.amazonaws.services.iotdata.model.GetThingShadowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


payload
ByteBuffer payload

 The state information, in JSON format.
 








Class com.amazonaws.services.iotdata.model.InternalFailureException extends AWSIotDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.InvalidRequestException extends AWSIotDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.MethodNotAllowedException extends AWSIotDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.PublishRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


topic
String topic

 The name of the MQTT topic.
 


qos
Integer qos

 The Quality of Service (QoS) level.
 


payload
ByteBuffer payload

 The state information, in JSON format.
 








Class com.amazonaws.services.iotdata.model.PublishResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotdata.model.RequestEntityTooLargeException extends AWSIotDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.ResourceNotFoundException extends AWSIotDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.ServiceUnavailableException extends AWSIotDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.ThrottlingException extends AWSIotDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.UnauthorizedException extends AWSIotDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.UnsupportedDocumentEncodingException extends AWSIotDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.UpdateThingShadowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing.
 


payload
ByteBuffer payload

 The state information, in JSON format.
 








Class com.amazonaws.services.iotdata.model.UpdateThingShadowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


payload
ByteBuffer payload

 The state information, in JSON format.
 








Package com.amazonaws.services.iotevents.model




Class com.amazonaws.services.iotevents.model.Action extends Object implements Serializable


Serialized Fields


setVariable
SetVariableAction setVariable

 Sets a variable to a specified value.
 


sns
SNSTopicPublishAction sns

 Sends an Amazon SNS message.
 


iotTopicPublish
IotTopicPublishAction iotTopicPublish

 Publishes an MQTT message with the given topic to the AWS IoT message broker.
 


setTimer
SetTimerAction setTimer

 Information needed to set the timer.
 


clearTimer
ClearTimerAction clearTimer

 Information needed to clear the timer.
 


resetTimer
ResetTimerAction resetTimer

 Information needed to reset the timer.
 


lambda
LambdaAction lambda

 Calls a Lambda function, passing in information about the detector model instance and the event that triggered
 the action.
 


iotEvents
IotEventsAction iotEvents

 Sends an IoT Events input, passing in information about the detector model instance and the event that triggered
 the action.
 


sqs
SqsAction sqs

 Sends information about the detector model instance and the event that triggered the action to an Amazon SQS
 queue.
 


firehose
FirehoseAction firehose

 Sends information about the detector model instance and the event that triggered the action to a Kinesis Data
 Firehose delivery stream.
 








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


Serialized Fields


jsonPath
String jsonPath

 An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from
 the JSON payload that is made available by the input. Inputs are derived from messages sent to the AWS IoT Events
 system (BatchPutMessage). Each such message contains a JSON payload, and the attribute (and its
 paired value) specified here are available for use in the "condition" expressions used by detectors.
 
 
 Syntax: <field-name>.<field-name>...
 








Class com.amazonaws.services.iotevents.model.AWSIoTEventsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotevents.model.ClearTimerAction extends Object implements Serializable


Serialized Fields


timerName
String timerName

 The name of the timer to clear.
 








Class com.amazonaws.services.iotevents.model.CreateDetectorModelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model.
 


detectorModelDefinition
DetectorModelDefinition detectorModelDefinition

 Information that defines how the detectors operate.
 


detectorModelDescription
String detectorModelDescription

 A brief description of the detector model.
 


key
String key

 The input attribute key used to identify a device or system in order to create a detector (an instance of the
 detector model) and then to route each input received to the appropriate detector (instance). This parameter uses
 a JSON-path expression to specify the attribute-value pair in the message payload of each input that is used to
 identify the device associated with the input.
 


roleArn
String roleArn

 The ARN of the role that grants permission to AWS IoT Events to perform its operations.
 


tags
List<E> tags

 Metadata that can be used to manage the detector model.
 


evaluationMethod
String evaluationMethod

 Information about the order in which events are evaluated and how actions are executed.
 








Class com.amazonaws.services.iotevents.model.CreateDetectorModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detectorModelConfiguration
DetectorModelConfiguration detectorModelConfiguration

 Information about how the detector model is configured.
 








Class com.amazonaws.services.iotevents.model.CreateInputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputName
String inputName

 The name you want to give to the input.
 


inputDescription
String inputDescription

 A brief description of the input.
 


inputDefinition
InputDefinition inputDefinition

 The definition of the input.
 


tags
List<E> tags

 Metadata that can be used to manage the input.
 








Class com.amazonaws.services.iotevents.model.CreateInputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


inputConfiguration
InputConfiguration inputConfiguration

 Information about the configuration of the input.
 








Class com.amazonaws.services.iotevents.model.DeleteDetectorModelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model to be deleted.
 








Class com.amazonaws.services.iotevents.model.DeleteDetectorModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotevents.model.DeleteInputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputName
String inputName

 The name of the input to delete.
 








Class com.amazonaws.services.iotevents.model.DeleteInputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotevents.model.DescribeDetectorModelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model.
 


detectorModelVersion
String detectorModelVersion

 The version of the detector model.
 








Class com.amazonaws.services.iotevents.model.DescribeDetectorModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detectorModel
DetectorModel detectorModel

 Information about the detector model.
 








Class com.amazonaws.services.iotevents.model.DescribeInputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputName
String inputName

 The name of the input.
 








Class com.amazonaws.services.iotevents.model.DescribeInputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


input
Input input

 Information about the input.
 








Class com.amazonaws.services.iotevents.model.DescribeLoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iotevents.model.DescribeLoggingOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loggingOptions
LoggingOptions loggingOptions

 The current settings of the AWS IoT Events logging options.
 








Class com.amazonaws.services.iotevents.model.DetectorDebugOption extends Object implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model.
 


keyValue
String keyValue

 The value of the input attribute key used to create the detector (the instance of the detector model).
 








Class com.amazonaws.services.iotevents.model.DetectorModel extends Object implements Serializable


Serialized Fields


detectorModelDefinition
DetectorModelDefinition detectorModelDefinition

 Information that defines how a detector operates.
 


detectorModelConfiguration
DetectorModelConfiguration detectorModelConfiguration

 Information about how the detector is configured.
 








Class com.amazonaws.services.iotevents.model.DetectorModelConfiguration extends Object implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model.
 


detectorModelVersion
String detectorModelVersion

 The version of the detector model.
 


detectorModelDescription
String detectorModelDescription

 A brief description of the detector model.
 


detectorModelArn
String detectorModelArn

 The ARN of the detector model.
 


roleArn
String roleArn

 The ARN of the role that grants permission to AWS IoT Events to perform its operations.
 


creationTime
Date creationTime

 The time the detector model was created.
 


lastUpdateTime
Date lastUpdateTime

 The time the detector model was last updated.
 


status
String status

 The status of the detector model.
 


key
String key

 The input attribute key used to identify a device or system in order to create a detector (an instance of the
 detector model) and then to route each input received to the appropriate detector (instance). This parameter uses
 a JSON-path expression to specify the attribute-value pair in the message payload of each input that is used to
 identify the device associated with the input.
 


evaluationMethod
String evaluationMethod

 Information about the order in which events are evaluated and how actions are executed.
 








Class com.amazonaws.services.iotevents.model.DetectorModelDefinition extends Object implements Serializable


Serialized Fields


states
List<E> states

 Information about the states of the detector.
 


initialStateName
String initialStateName

 The state that is entered at the creation of each detector (instance).
 








Class com.amazonaws.services.iotevents.model.DetectorModelSummary extends Object implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model.
 


detectorModelDescription
String detectorModelDescription

 A brief description of the detector model.
 


creationTime
Date creationTime

 The time the detector model was created.
 








Class com.amazonaws.services.iotevents.model.DetectorModelVersionSummary extends Object implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model.
 


detectorModelVersion
String detectorModelVersion

 The ID of the detector model version.
 


detectorModelArn
String detectorModelArn

 The ARN of the detector model version.
 


roleArn
String roleArn

 The ARN of the role that grants the detector model permission to perform its tasks.
 


creationTime
Date creationTime

 The time the detector model version was created.
 


lastUpdateTime
Date lastUpdateTime

 The last time the detector model version was updated.
 


status
String status

 The status of the detector model version.
 


evaluationMethod
String evaluationMethod

 Information about the order in which events are evaluated and how actions are executed.
 








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


Serialized Fields


eventName
String eventName

 The name of the event.
 


condition
String condition

 [Optional] The Boolean expression that when TRUE causes the "actions" to be performed. If not
 present, the actions are performed (=TRUE); if the expression result is not a Boolean value, the actions are NOT
 performed (=FALSE).
 


actions
List<E> actions

 The actions to be performed.
 








Class com.amazonaws.services.iotevents.model.FirehoseAction extends Object implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the Kinesis Data Firehose delivery stream where the data is written.
 


separator
String separator

 A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream.
 Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
 








Class com.amazonaws.services.iotevents.model.Input extends Object implements Serializable


Serialized Fields


inputConfiguration
InputConfiguration inputConfiguration

 Information about the configuration of an input.
 


inputDefinition
InputDefinition inputDefinition

 The definition of the input.
 








Class com.amazonaws.services.iotevents.model.InputConfiguration extends Object implements Serializable


Serialized Fields


inputName
String inputName

 The name of the input.
 


inputDescription
String inputDescription

 A brief description of the input.
 


inputArn
String inputArn

 The ARN of the input.
 


creationTime
Date creationTime

 The time the input was created.
 


lastUpdateTime
Date lastUpdateTime

 The last time the input was updated.
 


status
String status

 The status of the input.
 








Class com.amazonaws.services.iotevents.model.InputDefinition extends Object implements Serializable


Serialized Fields


attributes
List<E> attributes

 The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent
 to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and
 those attributes (and their paired values) specified here are available for use in the "condition"
 expressions used by detectors that monitor this input.
 








Class com.amazonaws.services.iotevents.model.InputSummary extends Object implements Serializable


Serialized Fields


inputName
String inputName

 The name of the input.
 


inputDescription
String inputDescription

 A brief description of the input.
 


inputArn
String inputArn

 The ARN of the input.
 


creationTime
Date creationTime

 The time the input was created.
 


lastUpdateTime
Date lastUpdateTime

 The last time the input was updated.
 


status
String status

 The status of the input.
 








Class com.amazonaws.services.iotevents.model.InternalFailureException extends AWSIoTEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotevents.model.InvalidRequestException extends AWSIoTEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotevents.model.IotEventsAction extends Object implements Serializable


Serialized Fields


inputName
String inputName

 The name of the AWS IoT Events input where the data is sent.
 








Class com.amazonaws.services.iotevents.model.IotTopicPublishAction extends Object implements Serializable


Serialized Fields


mqttTopic
String mqttTopic

 The MQTT topic of the message.
 








Class com.amazonaws.services.iotevents.model.LambdaAction extends Object implements Serializable


Serialized Fields


functionArn
String functionArn

 The ARN of the Lambda function that is executed.
 








Class com.amazonaws.services.iotevents.model.LimitExceededException extends AWSIoTEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotevents.model.ListDetectorModelsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.iotevents.model.ListDetectorModelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detectorModelSummaries
List<E> detectorModelSummaries

 Summary information about the detector models.
 


nextToken
String nextToken

 A token to retrieve the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iotevents.model.ListDetectorModelVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model whose versions are returned.
 


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.iotevents.model.ListDetectorModelVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detectorModelVersionSummaries
List<E> detectorModelVersionSummaries

 Summary information about the detector model versions.
 


nextToken
String nextToken

 A token to retrieve the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.iotevents.model.ListInputsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.iotevents.model.ListInputsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


inputSummaries
List<E> inputSummaries

 Summary information about the inputs.
 


nextToken
String nextToken

 A token to retrieve the next set of results, or null if there are no additional results.
 








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


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource.
 








Class com.amazonaws.services.iotevents.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The list of tags assigned to the resource.
 








Class com.amazonaws.services.iotevents.model.LoggingOptions extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The ARN of the role that grants permission to AWS IoT Events to perform logging.
 


level
String level

 The logging level.
 


enabled
Boolean enabled

 If TRUE, logging is enabled for AWS IoT Events.
 


detectorDebugOptions
List<E> detectorDebugOptions

 Information that identifies those detector models and their detectors (instances) for which the logging level is
 given.
 








Class com.amazonaws.services.iotevents.model.OnEnterLifecycle extends Object implements Serializable


Serialized Fields


events
List<E> events

 Specifies the actions that are performed when the state is entered and the "condition" is TRUE.
 








Class com.amazonaws.services.iotevents.model.OnExitLifecycle extends Object implements Serializable


Serialized Fields


events
List<E> events

 Specifies the "actions" that are performed when the state is exited and the "condition"
 is TRUE.
 








Class com.amazonaws.services.iotevents.model.OnInputLifecycle extends Object implements Serializable


Serialized Fields


events
List<E> events

 Specifies the actions performed when the "condition" evaluates to TRUE.
 


transitionEvents
List<E> transitionEvents

 Specifies the actions performed, and the next state entered, when a "condition" evaluates to TRUE.
 








Class com.amazonaws.services.iotevents.model.PutLoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loggingOptions
LoggingOptions loggingOptions

 The new values of the AWS IoT Events logging options.
 








Class com.amazonaws.services.iotevents.model.PutLoggingOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotevents.model.ResetTimerAction extends Object implements Serializable


Serialized Fields


timerName
String timerName

 The name of the timer to reset.
 








Class com.amazonaws.services.iotevents.model.ResourceAlreadyExistsException extends AWSIoTEventsException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceId
String resourceId

 The ID of the resource.
 


resourceArn
String resourceArn

 The ARN of the resource.
 








Class com.amazonaws.services.iotevents.model.ResourceInUseException extends AWSIoTEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotevents.model.ResourceNotFoundException extends AWSIoTEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotevents.model.ServiceUnavailableException extends AWSIoTEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotevents.model.SetTimerAction extends Object implements Serializable


Serialized Fields


timerName
String timerName

 The name of the timer.
 


seconds
Integer seconds

 The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy.
 








Class com.amazonaws.services.iotevents.model.SetVariableAction extends Object implements Serializable


Serialized Fields


variableName
String variableName

 The name of the variable.
 


value
String value

 The new value of the variable.
 








Class com.amazonaws.services.iotevents.model.SNSTopicPublishAction extends Object implements Serializable


Serialized Fields


targetArn
String targetArn

 The ARN of the Amazon SNS target where the message is sent.
 








Class com.amazonaws.services.iotevents.model.SqsAction extends Object implements Serializable


Serialized Fields


queueUrl
String queueUrl

 The URL of the SQS queue where the data is written.
 


useBase64
Boolean useBase64

 Set this to TRUE if you want the data to be Base-64 encoded before it is written to the queue. Otherwise, set
 this to FALSE.
 








Class com.amazonaws.services.iotevents.model.State extends Object implements Serializable


Serialized Fields


stateName
String stateName

 The name of the state.
 


onInput
OnInputLifecycle onInput

 When an input is received and the "condition" is TRUE, perform the specified "actions".
 


onEnter
OnEnterLifecycle onEnter

 When entering this state, perform these "actions" if the "condition" is TRUE.
 


onExit
OnExitLifecycle onExit

 When exiting this state, perform these "actions" if the specified "condition" is TRUE.
 








Class com.amazonaws.services.iotevents.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The tag's key.
 


value
String value

 The tag's value.
 








Class com.amazonaws.services.iotevents.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource.
 


tags
List<E> tags

 The new or modified tags for the resource.
 








Class com.amazonaws.services.iotevents.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotevents.model.ThrottlingException extends AWSIoTEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotevents.model.TransitionEvent extends Object implements Serializable


Serialized Fields


eventName
String eventName

 The name of the transition event.
 


condition
String condition

 [Required] A Boolean expression that when TRUE causes the actions to be performed and the
 "nextState" to be entered.
 


actions
List<E> actions

 The actions to be performed.
 


nextState
String nextState

 The next state to enter.
 








Class com.amazonaws.services.iotevents.model.UnsupportedOperationException extends AWSIoTEventsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotevents.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource.
 


tagKeys
List<E> tagKeys

 A list of the keys of the tags to be removed from the resource.
 








Class com.amazonaws.services.iotevents.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotevents.model.UpdateDetectorModelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model that is updated.
 


detectorModelDefinition
DetectorModelDefinition detectorModelDefinition

 Information that defines how a detector operates.
 


detectorModelDescription
String detectorModelDescription

 A brief description of the detector model.
 


roleArn
String roleArn

 The ARN of the role that grants permission to AWS IoT Events to perform its operations.
 


evaluationMethod
String evaluationMethod

 Information about the order in which events are evaluated and how actions are executed.
 








Class com.amazonaws.services.iotevents.model.UpdateDetectorModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detectorModelConfiguration
DetectorModelConfiguration detectorModelConfiguration

 Information about how the detector model is configured.
 








Class com.amazonaws.services.iotevents.model.UpdateInputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputName
String inputName

 The name of the input you want to update.
 


inputDescription
String inputDescription

 A brief description of the input.
 


inputDefinition
InputDefinition inputDefinition

 The definition of the input.
 








Class com.amazonaws.services.iotevents.model.UpdateInputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


inputConfiguration
InputConfiguration inputConfiguration

 Information about the configuration of the input.
 








Package com.amazonaws.services.ioteventsdata.model




Class com.amazonaws.services.ioteventsdata.model.AWSIoTEventsDataException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ioteventsdata.model.BatchPutMessageErrorEntry extends Object implements Serializable


Serialized Fields


messageId
String messageId

 The ID of the message that caused the error. (See the value corresponding to the "messageId" key in
 the "message" object.)
 


errorCode
String errorCode

 The code associated with the error.
 


errorMessage
String errorMessage

 More information about the error.
 








Class com.amazonaws.services.ioteventsdata.model.BatchPutMessageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


messages
List<E> messages

 The list of messages to send. Each message has the following format:
 '{ "messageId": "string", "inputName": "string", "payload": "string"}'
 








Class com.amazonaws.services.ioteventsdata.model.BatchPutMessageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


batchPutMessageErrorEntries
List<E> batchPutMessageErrorEntries

 A list of any errors encountered when sending the messages.
 








Class com.amazonaws.services.ioteventsdata.model.BatchUpdateDetectorErrorEntry extends Object implements Serializable


Serialized Fields


messageId
String messageId

 The "messageId" of the update request that caused the error. (The value of the
 "messageId" in the update request "Detector" object.)
 


errorCode
String errorCode

 The code of the error.
 


errorMessage
String errorMessage

 A message describing the error.
 








Class com.amazonaws.services.ioteventsdata.model.BatchUpdateDetectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectors
List<E> detectors

 The list of detectors (instances) to update, along with the values to update.
 








Class com.amazonaws.services.ioteventsdata.model.BatchUpdateDetectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


batchUpdateDetectorErrorEntries
List<E> batchUpdateDetectorErrorEntries

 A list of those detector updates that resulted in errors. (If an error is listed here, the specific update did
 not occur.)
 








Class com.amazonaws.services.ioteventsdata.model.DescribeDetectorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model whose detectors (instances) you want information about.
 


keyValue
String keyValue

 A filter used to limit results to detectors (instances) created because of the given key ID.
 








Class com.amazonaws.services.ioteventsdata.model.DescribeDetectorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detector
Detector detector

 Information about the detector (instance).
 








Class com.amazonaws.services.ioteventsdata.model.Detector extends Object implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model that created this detector (instance).
 


keyValue
String keyValue

 The value of the key (identifying the device or system) that caused the creation of this detector (instance).
 


detectorModelVersion
String detectorModelVersion

 The version of the detector model that created this detector (instance).
 


state
DetectorState state

 The current state of the detector (instance).
 


creationTime
Date creationTime

 The time the detector (instance) was created.
 


lastUpdateTime
Date lastUpdateTime

 The time the detector (instance) was last updated.
 








Class com.amazonaws.services.ioteventsdata.model.DetectorState extends Object implements Serializable


Serialized Fields


stateName
String stateName

 The name of the state.
 


variables
List<E> variables

 The current values of the detector's variables.
 


timers
List<E> timers

 The current state of the detector's timers.
 








Class com.amazonaws.services.ioteventsdata.model.DetectorStateDefinition extends Object implements Serializable


Serialized Fields


stateName
String stateName

 The name of the new state of the detector (instance).
 


variables
List<E> variables

 The new values of the detector's variables. Any variable whose value isn't specified is cleared.
 


timers
List<E> timers

 The new values of the detector's timers. Any timer whose value isn't specified is cleared, and its timeout event
 won't occur.
 








Class com.amazonaws.services.ioteventsdata.model.DetectorStateSummary extends Object implements Serializable


Serialized Fields


stateName
String stateName

 The name of the state.
 








Class com.amazonaws.services.ioteventsdata.model.DetectorSummary extends Object implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model that created this detector (instance).
 


keyValue
String keyValue

 The value of the key (identifying the device or system) that caused the creation of this detector (instance).
 


detectorModelVersion
String detectorModelVersion

 The version of the detector model that created this detector (instance).
 


state
DetectorStateSummary state

 The current state of the detector (instance).
 


creationTime
Date creationTime

 The time the detector (instance) was created.
 


lastUpdateTime
Date lastUpdateTime

 The time the detector (instance) was last updated.
 








Class com.amazonaws.services.ioteventsdata.model.InternalFailureException extends AWSIoTEventsDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ioteventsdata.model.InvalidRequestException extends AWSIoTEventsDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ioteventsdata.model.ListDetectorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


detectorModelName
String detectorModelName

 The name of the detector model whose detectors (instances) are listed.
 


stateName
String stateName

 A filter that limits results to those detectors (instances) in the given state.
 


nextToken
String nextToken

 The token for the next set of results.
 


maxResults
Integer maxResults

 The maximum number of results to return at one time.
 








Class com.amazonaws.services.ioteventsdata.model.ListDetectorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


detectorSummaries
List<E> detectorSummaries

 A list of summary information about the detectors (instances).
 


nextToken
String nextToken

 A token to retrieve the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.ioteventsdata.model.Message extends Object implements Serializable


Serialized Fields


messageId
String messageId

 The ID to assign to the message. Within each batch sent, each "messageId" must be unique.
 


inputName
String inputName

 The name of the input into which the message payload is transformed.
 


payload
ByteBuffer payload

 The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data (in
 which case you must decode it).
 








Class com.amazonaws.services.ioteventsdata.model.ResourceNotFoundException extends AWSIoTEventsDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ioteventsdata.model.ServiceUnavailableException extends AWSIoTEventsDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ioteventsdata.model.ThrottlingException extends AWSIoTEventsDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ioteventsdata.model.Timer extends Object implements Serializable


Serialized Fields


name
String name

 The name of the timer.
 


timestamp
Date timestamp

 The number of seconds which have elapsed on the timer.
 








Class com.amazonaws.services.ioteventsdata.model.TimerDefinition extends Object implements Serializable


Serialized Fields


name
String name

 The name of the timer.
 


seconds
Integer seconds

 The new setting of the timer (the number of seconds before the timer elapses).
 








Class com.amazonaws.services.ioteventsdata.model.UpdateDetectorRequest extends Object implements Serializable


Serialized Fields


messageId
String messageId

 The ID to assign to the detector update "message". Each "messageId" must be unique
 within each batch sent.
 


detectorModelName
String detectorModelName

 The name of the detector model that created the detectors (instances).
 


keyValue
String keyValue

 The value of the input key attribute (identifying the device or system) that caused the creation of this detector
 (instance).
 


state
DetectorStateDefinition state

 The new state, variable values, and timer settings of the detector (instance).
 








Class com.amazonaws.services.ioteventsdata.model.Variable extends Object implements Serializable


Serialized Fields


name
String name

 The name of the variable.
 


value
String value

 The current value of the variable.
 








Class com.amazonaws.services.ioteventsdata.model.VariableDefinition extends Object implements Serializable


Serialized Fields


name
String name

 The name of the variable.
 


value
String value

 The new value of the variable.
 








Package com.amazonaws.services.iotjobsdataplane.model




Class com.amazonaws.services.iotjobsdataplane.model.AWSIoTJobsDataPlaneException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotjobsdataplane.model.CertificateValidationException extends AWSIoTJobsDataPlaneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotjobsdataplane.model.DescribeJobExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier assigned to this job when it was created.
 


thingName
String thingName

 The thing name associated with the device the job execution is running on.
 


includeJobDocument
Boolean includeJobDocument

 Optional. When set to true, the response contains the job document. The default is false.
 


executionNumber
Long executionNumber

 Optional. A number that identifies a particular job execution on a particular device. If not specified, the
 latest job execution is returned.
 








Class com.amazonaws.services.iotjobsdataplane.model.DescribeJobExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


execution
JobExecution execution

 Contains data about a job execution.
 








Class com.amazonaws.services.iotjobsdataplane.model.GetPendingJobExecutionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing that is executing the job.
 








Class com.amazonaws.services.iotjobsdataplane.model.GetPendingJobExecutionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


inProgressJobs
List<E> inProgressJobs

 A list of JobExecutionSummary objects with status IN_PROGRESS.
 


queuedJobs
List<E> queuedJobs

 A list of JobExecutionSummary objects with status QUEUED.
 








Class com.amazonaws.services.iotjobsdataplane.model.InvalidRequestException extends AWSIoTJobsDataPlaneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotjobsdataplane.model.InvalidStateTransitionException extends AWSIoTJobsDataPlaneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotjobsdataplane.model.JobExecution extends Object implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 


thingName
String thingName

 The name of the thing that is executing the job.
 


status
String status

 The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
 "REJECTED", or "REMOVED".
 


statusDetails
Map<K,V> statusDetails

 A collection of name/value pairs that describe the status of the job execution.
 


queuedAt
Long queuedAt

 The time, in milliseconds since the epoch, when the job execution was enqueued.
 


startedAt
Long startedAt

 The time, in milliseconds since the epoch, when the job execution was started.
 


lastUpdatedAt
Long lastUpdatedAt

 The time, in milliseconds since the epoch, when the job execution was last updated.
 


approximateSecondsBeforeTimedOut
Long approximateSecondsBeforeTimedOut

 The estimated number of seconds that remain before the job execution status will be changed to
 TIMED_OUT.
 


versionNumber
Long versionNumber

 The version of the job execution. Job execution versions are incremented each time they are updated by a device.
 


executionNumber
Long executionNumber

 A number that identifies a particular job execution on a particular device. It can be used later in commands that
 return or update job execution information.
 


jobDocument
String jobDocument

 The content of the job document.
 








Class com.amazonaws.services.iotjobsdataplane.model.JobExecutionState extends Object implements Serializable


Serialized Fields


status
String status

 The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED",
 "REJECTED", or "REMOVED".
 


statusDetails
Map<K,V> statusDetails

 A collection of name/value pairs that describe the status of the job execution.
 


versionNumber
Long versionNumber

 The version of the job execution. Job execution versions are incremented each time they are updated by a device.
 








Class com.amazonaws.services.iotjobsdataplane.model.JobExecutionSummary extends Object implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier you assigned to this job when it was created.
 


queuedAt
Long queuedAt

 The time, in milliseconds since the epoch, when the job execution was enqueued.
 


startedAt
Long startedAt

 The time, in milliseconds since the epoch, when the job execution started.
 


lastUpdatedAt
Long lastUpdatedAt

 The time, in milliseconds since the epoch, when the job execution was last updated.
 


versionNumber
Long versionNumber

 The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an
 update from a device.
 


executionNumber
Long executionNumber

 A number that identifies a particular job execution on a particular device.
 








Class com.amazonaws.services.iotjobsdataplane.model.ResourceNotFoundException extends AWSIoTJobsDataPlaneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotjobsdataplane.model.ServiceUnavailableException extends AWSIoTJobsDataPlaneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotjobsdataplane.model.StartNextPendingJobExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing associated with the device.
 


statusDetails
Map<K,V> statusDetails

 A collection of name/value pairs that describe the status of the job execution. If not specified, the
 statusDetails are unchanged.
 


stepTimeoutInMinutes
Long stepTimeoutInMinutes

 Specifies the amount of time this device has to finish execution of this job. If the job execution status is not
 set to a terminal state before this timer expires, or before the timer is reset (by calling
 UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout
 value in field stepTimeoutInMinutes) the job execution status will be automatically set to
 TIMED_OUT. Note that setting this timeout has no effect on that job execution timeout which may have
 been specified when the job was created (CreateJob using field timeoutConfig).
 








Class com.amazonaws.services.iotjobsdataplane.model.StartNextPendingJobExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


execution
JobExecution execution

 A JobExecution object.
 








Class com.amazonaws.services.iotjobsdataplane.model.TerminalStateException extends AWSIoTJobsDataPlaneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotjobsdataplane.model.ThrottlingException extends AWSIoTJobsDataPlaneException implements Serializable

serialVersionUID:
1L



Serialized Fields


payload
ByteBuffer payload

 The payload associated with the exception.
 








Class com.amazonaws.services.iotjobsdataplane.model.UpdateJobExecutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobId
String jobId

 The unique identifier assigned to this job when it was created.
 


thingName
String thingName

 The name of the thing associated with the device.
 


status
String status

 The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every
 update.
 


statusDetails
Map<K,V> statusDetails

 Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the
 statusDetails are unchanged.
 


stepTimeoutInMinutes
Long stepTimeoutInMinutes

 Specifies the amount of time this device has to finish execution of this job. If the job execution status is not
 set to a terminal state before this timer expires, or before the timer is reset (by again calling
 UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout
 value in this field) the job execution status will be automatically set to TIMED_OUT. Note that
 setting or resetting this timeout has no effect on that job execution timeout which may have been specified when
 the job was created (CreateJob using field timeoutConfig).
 


expectedVersion
Long expectedVersion

 Optional. The expected current version of the job execution. Each time you update the job execution, its version
 is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a
 VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned.
 (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job
 execution status data.)
 


includeJobExecutionState
Boolean includeJobExecutionState

 Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
 


includeJobDocument
Boolean includeJobDocument

 Optional. When set to true, the response contains the job document. The default is false.
 


executionNumber
Long executionNumber

 Optional. A number that identifies a particular job execution on a particular device.
 








Class com.amazonaws.services.iotjobsdataplane.model.UpdateJobExecutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


executionState
JobExecutionState executionState

 A JobExecutionState object.
 


jobDocument
String jobDocument

 The contents of the Job Documents.
 








Package com.amazonaws.services.iotsecuretunneling.model




Class com.amazonaws.services.iotsecuretunneling.model.AWSIoTSecureTunnelingException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotsecuretunneling.model.CloseTunnelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tunnelId
String tunnelId

 The ID of the tunnel to close.
 


delete
Boolean delete

 When set to true, AWS IoT Secure Tunneling deletes the tunnel data immediately.
 








Class com.amazonaws.services.iotsecuretunneling.model.CloseTunnelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotsecuretunneling.model.ConnectionState extends Object implements Serializable


Serialized Fields


status
String status

 The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED.
 


lastUpdatedAt
Date lastUpdatedAt

 The last time the connection status was updated.
 








Class com.amazonaws.services.iotsecuretunneling.model.DescribeTunnelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tunnelId
String tunnelId

 The tunnel to describe.
 








Class com.amazonaws.services.iotsecuretunneling.model.DescribeTunnelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tunnel
Tunnel tunnel

 The tunnel being described.
 








Class com.amazonaws.services.iotsecuretunneling.model.DestinationConfig extends Object implements Serializable


Serialized Fields


thingName
String thingName

 The name of the IoT thing to which you want to connect.
 


services
List<E> services

 A list of service names that identity the target application. Currently, you can only specify a single name. The
 AWS IoT client running on the destination device reads this value and uses it to look up a port or an IP address
 and a port. The AWS IoT client instantiates the local proxy which uses this information to connect to the
 destination application.
 








Class com.amazonaws.services.iotsecuretunneling.model.LimitExceededException extends AWSIoTSecureTunnelingException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


resourceArn
String resourceArn

 The resource ARN.
 








Class com.amazonaws.services.iotsecuretunneling.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The tags for the specified resource.
 








Class com.amazonaws.services.iotsecuretunneling.model.ListTunnelsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the IoT thing associated with the destination device.
 


maxResults
Integer maxResults

 The maximum number of results to return at once.
 


nextToken
String nextToken

 A token to retrieve the next set of results.
 








Class com.amazonaws.services.iotsecuretunneling.model.ListTunnelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tunnelSummaries
List<E> tunnelSummaries

 A short description of the tunnels in an AWS account.
 


nextToken
String nextToken

 A token to used to retrieve the next set of results.
 








Class com.amazonaws.services.iotsecuretunneling.model.OpenTunnelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description

 A short text description of the tunnel.
 


tags
List<E> tags

 A collection of tag metadata.
 


destinationConfig
DestinationConfig destinationConfig

 The destination configuration for the OpenTunnel request.
 


timeoutConfig
TimeoutConfig timeoutConfig

 Timeout configuration for a tunnel.
 








Class com.amazonaws.services.iotsecuretunneling.model.OpenTunnelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tunnelId
String tunnelId

 A unique alpha-numeric tunnel ID.
 


tunnelArn
String tunnelArn

 The Amazon Resource Name for the tunnel. The tunnel ARN format is
 arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
 


sourceAccessToken
String sourceAccessToken

 The access token the source local proxy uses to connect to AWS IoT Secure Tunneling.
 


destinationAccessToken
String destinationAccessToken

 The access token the destination local proxy uses to connect to AWS IoT Secure Tunneling.
 








Class com.amazonaws.services.iotsecuretunneling.model.ResourceNotFoundException extends AWSIoTSecureTunnelingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotsecuretunneling.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key of the tag.
 


value
String value

 The value of the tag.
 








Class com.amazonaws.services.iotsecuretunneling.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The ARN of the resource.
 


tags
List<E> tags

 The tags for the resource.
 








Class com.amazonaws.services.iotsecuretunneling.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotsecuretunneling.model.TimeoutConfig extends Object implements Serializable


Serialized Fields


maxLifetimeTimeoutMinutes
Integer maxLifetimeTimeoutMinutes

 The maximum amount of time (in minutes) a tunnel can remain open. If not specified, maxLifetimeTimeoutMinutes
 defaults to 720 minutes. Valid values are from 1 minute to 12 hours (720 minutes)
 








Class com.amazonaws.services.iotsecuretunneling.model.Tunnel extends Object implements Serializable


Serialized Fields


tunnelId
String tunnelId

 A unique alpha-numeric ID that identifies a tunnel.
 


tunnelArn
String tunnelArn

 The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is
 arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
 


status
String status

 The status of a tunnel. Valid values are: Open and Closed.
 


sourceConnectionState
ConnectionState sourceConnectionState

 The connection state of the source application.
 


destinationConnectionState
ConnectionState destinationConnectionState

 The connection state of the destination application.
 


description
String description

 A description of the tunnel.
 


destinationConfig
DestinationConfig destinationConfig

 The destination configuration that specifies the thing name of the destination device and a service name that the
 local proxy uses to connect to the destination application.
 


timeoutConfig
TimeoutConfig timeoutConfig

 Timeout configuration for the tunnel.
 


tags
List<E> tags

 A list of tag metadata associated with the secure tunnel.
 


createdAt
Date createdAt

 The time when the tunnel was created.
 


lastUpdatedAt
Date lastUpdatedAt

 The last time the tunnel was updated.
 








Class com.amazonaws.services.iotsecuretunneling.model.TunnelSummary extends Object implements Serializable


Serialized Fields


tunnelId
String tunnelId

 The unique alpha-numeric identifier for the tunnel.
 


tunnelArn
String tunnelArn

 The Amazon Resource Name of the tunnel. The tunnel ARN format is
 arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
 


status
String status

 The status of a tunnel. Valid values are: Open and Closed.
 


description
String description

 A description of the tunnel.
 


createdAt
Date createdAt

 The time the tunnel was created.
 


lastUpdatedAt
Date lastUpdatedAt

 The time the tunnel was last updated.
 








Class com.amazonaws.services.iotsecuretunneling.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The resource ARN.
 


tagKeys
List<E> tagKeys

 The keys of the tags to remove.
 








Class com.amazonaws.services.iotsecuretunneling.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.iotthingsgraph.model




Class com.amazonaws.services.iotthingsgraph.model.AssociateEntityToThingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing to which the entity is to be associated.
 


entityId
String entityId

 The ID of the device to be associated with the thing.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
 


namespaceVersion
Long namespaceVersion

 The version of the user's namespace. Defaults to the latest version of the user's namespace.
 








Class com.amazonaws.services.iotthingsgraph.model.AssociateEntityToThingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotthingsgraph.model.AWSIoTThingsGraphException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotthingsgraph.model.CreateFlowTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


definition
DefinitionDocument definition

 The workflow DefinitionDocument.
 


compatibleNamespaceVersion
Long compatibleNamespaceVersion

 The namespace version in which the workflow is to be created.
 
 
 If no value is specified, the latest version is used by default.
 








Class com.amazonaws.services.iotthingsgraph.model.CreateFlowTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summary
FlowTemplateSummary summary

 The summary object that describes the created workflow.
 








Class com.amazonaws.services.iotthingsgraph.model.CreateSystemInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tags
List<E> tags

 Metadata, consisting of key-value pairs, that can be used to categorize your system instances.
 


definition
DefinitionDocument definition


target
String target

 The target type of the deployment. Valid values are GREENGRASS and CLOUD.
 


greengrassGroupName
String greengrassGroupName

 The name of the Greengrass group where the system instance will be deployed. This value is required if the value
 of the target parameter is GREENGRASS.
 


s3BucketName
String s3BucketName

 The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's
 resource file. This value is required if the value of the target parameter is
 GREENGRASS.
 


metricsConfiguration
MetricsConfiguration metricsConfiguration


flowActionsRoleArn
String flowActionsRoleArn

 The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have read
 and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This
 value is required if the value of the target parameter is CLOUD.
 








Class com.amazonaws.services.iotthingsgraph.model.CreateSystemInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summary
SystemInstanceSummary summary

 The summary object that describes the new system instance.
 








Class com.amazonaws.services.iotthingsgraph.model.CreateSystemTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


definition
DefinitionDocument definition

 The DefinitionDocument used to create the system.
 


compatibleNamespaceVersion
Long compatibleNamespaceVersion

 The namespace version in which the system is to be created.
 
 
 If no value is specified, the latest version is used by default.
 








Class com.amazonaws.services.iotthingsgraph.model.CreateSystemTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summary
SystemTemplateSummary summary

 The summary object that describes the created system.
 








Class com.amazonaws.services.iotthingsgraph.model.DefinitionDocument extends Object implements Serializable


Serialized Fields


language
String language

 The language used to define the entity. GRAPHQL is the only valid value.
 


text
String text

 The GraphQL text that defines the entity.
 








Class com.amazonaws.services.iotthingsgraph.model.DeleteFlowTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the workflow to be deleted.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
 








Class com.amazonaws.services.iotthingsgraph.model.DeleteFlowTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotthingsgraph.model.DeleteNamespaceRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iotthingsgraph.model.DeleteNamespaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


namespaceArn
String namespaceArn

 The ARN of the namespace to be deleted.
 


namespaceName
String namespaceName

 The name of the namespace to be deleted.
 








Class com.amazonaws.services.iotthingsgraph.model.DeleteSystemInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the system instance to be deleted.
 








Class com.amazonaws.services.iotthingsgraph.model.DeleteSystemInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotthingsgraph.model.DeleteSystemTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the system to be deleted.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
 








Class com.amazonaws.services.iotthingsgraph.model.DeleteSystemTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotthingsgraph.model.DependencyRevision extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the workflow or system.
 


revisionNumber
Long revisionNumber

 The revision number of the workflow or system.
 








Class com.amazonaws.services.iotthingsgraph.model.DeploySystemInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the system instance. This value is returned by the CreateSystemInstance action.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME
 








Class com.amazonaws.services.iotthingsgraph.model.DeploySystemInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summary
SystemInstanceSummary summary

 An object that contains summary information about a system instance that was deployed.
 


greengrassDeploymentId
String greengrassDeploymentId

 The ID of the Greengrass deployment used to deploy the system instance.
 








Class com.amazonaws.services.iotthingsgraph.model.DeprecateFlowTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the workflow to be deleted.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
 








Class com.amazonaws.services.iotthingsgraph.model.DeprecateFlowTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotthingsgraph.model.DeprecateSystemTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the system to delete.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
 








Class com.amazonaws.services.iotthingsgraph.model.DeprecateSystemTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotthingsgraph.model.DescribeNamespaceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


namespaceName
String namespaceName

 The name of the user's namespace. Set this to aws to get the public namespace.
 








Class com.amazonaws.services.iotthingsgraph.model.DescribeNamespaceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


namespaceArn
String namespaceArn

 The ARN of the namespace.
 


namespaceName
String namespaceName

 The name of the namespace.
 


trackingNamespaceName
String trackingNamespaceName

 The name of the public namespace that the latest namespace version is tracking.
 


trackingNamespaceVersion
Long trackingNamespaceVersion

 The version of the public namespace that the latest version is tracking.
 


namespaceVersion
Long namespaceVersion

 The version of the user's namespace to describe.
 








Class com.amazonaws.services.iotthingsgraph.model.DissociateEntityFromThingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


thingName
String thingName

 The name of the thing to disassociate.
 


entityType
String entityType

 The entity type from which to disassociate the thing.
 








Class com.amazonaws.services.iotthingsgraph.model.DissociateEntityFromThingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotthingsgraph.model.EntityDescription extends Object implements Serializable


Serialized Fields


id
String id

 The entity ID.
 


arn
String arn

 The entity ARN.
 


type
String type

 The entity type.
 


createdAt
Date createdAt

 The time at which the entity was created.
 


definition
DefinitionDocument definition

 The definition document of the entity.
 








Class com.amazonaws.services.iotthingsgraph.model.EntityFilter extends Object implements Serializable


Serialized Fields


name
String name

 The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used
 by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.
 


value
List<E> value

 An array of string values for the search filter field. Multiple values function as AND criteria in the search.
 








Class com.amazonaws.services.iotthingsgraph.model.FlowExecutionMessage extends Object implements Serializable


Serialized Fields


messageId
String messageId

 The unique identifier of the message.
 


eventType
String eventType

 The type of flow event .
 


timestamp
Date timestamp

 The date and time when the message was last updated.
 


payload
String payload

 A string containing information about the flow event.
 








Class com.amazonaws.services.iotthingsgraph.model.FlowExecutionSummary extends Object implements Serializable


Serialized Fields


flowExecutionId
String flowExecutionId

 The ID of the flow execution.
 


status
String status

 The current status of the flow execution.
 


systemInstanceId
String systemInstanceId

 The ID of the system instance that contains the flow.
 


flowTemplateId
String flowTemplateId

 The ID of the flow.
 


createdAt
Date createdAt

 The date and time when the flow execution summary was created.
 


updatedAt
Date updatedAt

 The date and time when the flow execution summary was last updated.
 








Class com.amazonaws.services.iotthingsgraph.model.FlowTemplateDescription extends Object implements Serializable


Serialized Fields


summary
FlowTemplateSummary summary

 An object that contains summary information about a workflow.
 


definition
DefinitionDocument definition

 A workflow's definition document.
 


validatedNamespaceVersion
Long validatedNamespaceVersion

 The version of the user's namespace against which the workflow was validated. Use this value in your system
 instance.
 








Class com.amazonaws.services.iotthingsgraph.model.FlowTemplateFilter extends Object implements Serializable


Serialized Fields


name
String name

 The name of the search filter field.
 


value
List<E> value

 An array of string values for the search filter field. Multiple values function as AND criteria in the search.
 








Class com.amazonaws.services.iotthingsgraph.model.FlowTemplateSummary extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the workflow.
 


arn
String arn

 The ARN of the workflow.
 


revisionNumber
Long revisionNumber

 The revision number of the workflow.
 


createdAt
Date createdAt

 The date when the workflow was created.
 








Class com.amazonaws.services.iotthingsgraph.model.GetEntitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ids
List<E> ids

 An array of entity IDs.
 
 
 The IDs should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
 


namespaceVersion
Long namespaceVersion

 The version of the user's namespace. Defaults to the latest version of the user's namespace.
 








Class com.amazonaws.services.iotthingsgraph.model.GetEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


descriptions
List<E> descriptions

 An array of descriptions for the specified entities.
 








Class com.amazonaws.services.iotthingsgraph.model.GetFlowTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the workflow.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
 


revisionNumber
Long revisionNumber

 The number of the workflow revision to retrieve.
 








Class com.amazonaws.services.iotthingsgraph.model.GetFlowTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


description
FlowTemplateDescription description

 The object that describes the specified workflow.
 








Class com.amazonaws.services.iotthingsgraph.model.GetFlowTemplateRevisionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the workflow.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
 


nextToken
String nextToken

 The string that specifies the next page of results. Use this when you're paginating results.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response.
 








Class com.amazonaws.services.iotthingsgraph.model.GetFlowTemplateRevisionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaries
List<E> summaries

 An array of objects that provide summary data about each revision.
 


nextToken
String nextToken

 The string to specify as nextToken when you request the next page of results.
 








Class com.amazonaws.services.iotthingsgraph.model.GetNamespaceDeletionStatusRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iotthingsgraph.model.GetNamespaceDeletionStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


namespaceArn
String namespaceArn

 The ARN of the namespace that is being deleted.
 


namespaceName
String namespaceName

 The name of the namespace that is being deleted.
 


status
String status

 The status of the deletion request.
 


errorCode
String errorCode

 An error code returned by the namespace deletion task.
 


errorMessage
String errorMessage

 An error code returned by the namespace deletion task.
 








Class com.amazonaws.services.iotthingsgraph.model.GetSystemInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the system deployment instance. This value is returned by CreateSystemInstance.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME
 








Class com.amazonaws.services.iotthingsgraph.model.GetSystemInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


description
SystemInstanceDescription description

 An object that describes the system instance.
 








Class com.amazonaws.services.iotthingsgraph.model.GetSystemTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the system to get. This ID must be in the user's namespace.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
 


revisionNumber
Long revisionNumber

 The number that specifies the revision of the system to get.
 








Class com.amazonaws.services.iotthingsgraph.model.GetSystemTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


description
SystemTemplateDescription description

 An object that contains summary data about the system.
 








Class com.amazonaws.services.iotthingsgraph.model.GetSystemTemplateRevisionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the system template.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
 


nextToken
String nextToken

 The string that specifies the next page of results. Use this when you're paginating results.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response.
 








Class com.amazonaws.services.iotthingsgraph.model.GetSystemTemplateRevisionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaries
List<E> summaries

 An array of objects that contain summary data about the system template revisions.
 


nextToken
String nextToken

 The string to specify as nextToken when you request the next page of results.
 








Class com.amazonaws.services.iotthingsgraph.model.GetUploadStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


uploadId
String uploadId

 The ID of the upload. This value is returned by the UploadEntityDefinitions action.
 








Class com.amazonaws.services.iotthingsgraph.model.GetUploadStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uploadId
String uploadId

 The ID of the upload.
 


uploadStatus
String uploadStatus

 The status of the upload. The initial status is IN_PROGRESS. The response show all validation
 failures if the upload fails.
 


namespaceArn
String namespaceArn

 The ARN of the upload.
 


namespaceName
String namespaceName

 The name of the upload's namespace.
 


namespaceVersion
Long namespaceVersion

 The version of the user's namespace. Defaults to the latest version of the user's namespace.
 


failureReason
List<E> failureReason

 The reason for an upload failure.
 


createdDate
Date createdDate

 The date at which the upload was created.
 








Class com.amazonaws.services.iotthingsgraph.model.InternalFailureException extends AWSIoTThingsGraphException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotthingsgraph.model.InvalidRequestException extends AWSIoTThingsGraphException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotthingsgraph.model.LimitExceededException extends AWSIoTThingsGraphException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotthingsgraph.model.ListFlowExecutionMessagesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowExecutionId
String flowExecutionId

 The ID of the flow execution.
 


nextToken
String nextToken

 The string that specifies the next page of results. Use this when you're paginating results.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response.
 








Class com.amazonaws.services.iotthingsgraph.model.ListFlowExecutionMessagesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


messages
List<E> messages

 A list of objects that contain information about events in the specified flow execution.
 


nextToken
String nextToken

 The string to specify as nextToken when you request the next page of results.
 








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


Serialized Fields


maxResults
Integer maxResults

 The maximum number of tags to return.
 


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource whose tags are to be returned.
 


nextToken
String nextToken

 The token that specifies the next page of results to return.
 








Class com.amazonaws.services.iotthingsgraph.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 List of tags returned by the ListTagsForResource operation.
 


nextToken
String nextToken

 The token that specifies the next page of results to return.
 








Class com.amazonaws.services.iotthingsgraph.model.MetricsConfiguration extends Object implements Serializable


Serialized Fields


cloudMetricEnabled
Boolean cloudMetricEnabled

 A Boolean that specifies whether cloud metrics are collected.
 


metricRuleRoleArn
String metricRuleRoleArn

 The ARN of the role that is used to collect cloud metrics.
 








Class com.amazonaws.services.iotthingsgraph.model.ResourceAlreadyExistsException extends AWSIoTThingsGraphException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotthingsgraph.model.ResourceInUseException extends AWSIoTThingsGraphException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotthingsgraph.model.ResourceNotFoundException extends AWSIoTThingsGraphException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotthingsgraph.model.SearchEntitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


entityTypes
List<E> entityTypes

 The entity types for which to search.
 


filters
List<E> filters

 Optional filter to apply to the search. Valid filters are NAME NAMESPACE,
 SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters
 on entities that are used by the entity in the result set. For example, you can filter on the ID of a property
 that is used in a state.
 
 
 Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND
 criteria.
 


nextToken
String nextToken

 The string that specifies the next page of results. Use this when you're paginating results.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response.
 


namespaceVersion
Long namespaceVersion

 The version of the user's namespace. Defaults to the latest version of the user's namespace.
 








Class com.amazonaws.services.iotthingsgraph.model.SearchEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


descriptions
List<E> descriptions

 An array of descriptions for each entity returned in the search result.
 


nextToken
String nextToken

 The string to specify as nextToken when you request the next page of results.
 








Class com.amazonaws.services.iotthingsgraph.model.SearchFlowExecutionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


systemInstanceId
String systemInstanceId

 The ID of the system instance that contains the flow.
 


flowExecutionId
String flowExecutionId

 The ID of a flow execution.
 


startTime
Date startTime

 The date and time of the earliest flow execution to return.
 


endTime
Date endTime

 The date and time of the latest flow execution to return.
 


nextToken
String nextToken

 The string that specifies the next page of results. Use this when you're paginating results.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response.
 








Class com.amazonaws.services.iotthingsgraph.model.SearchFlowExecutionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaries
List<E> summaries

 An array of objects that contain summary information about each workflow execution in the result set.
 


nextToken
String nextToken

 The string to specify as nextToken when you request the next page of results.
 








Class com.amazonaws.services.iotthingsgraph.model.SearchFlowTemplatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 An array of objects that limit the result set. The only valid filter is DEVICE_MODEL_ID.
 


nextToken
String nextToken

 The string that specifies the next page of results. Use this when you're paginating results.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response.
 








Class com.amazonaws.services.iotthingsgraph.model.SearchFlowTemplatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaries
List<E> summaries

 An array of objects that contain summary information about each workflow in the result set.
 


nextToken
String nextToken

 The string to specify as nextToken when you request the next page of results.
 








Class com.amazonaws.services.iotthingsgraph.model.SearchSystemInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, STATUS,
 and GREENGRASS_GROUP_NAME.
 
 
 Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND
 criteria.
 


nextToken
String nextToken

 The string that specifies the next page of results. Use this when you're paginating results.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response.
 








Class com.amazonaws.services.iotthingsgraph.model.SearchSystemInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaries
List<E> summaries

 An array of objects that contain summary data abour the system instances in the result set.
 


nextToken
String nextToken

 The string to specify as nextToken when you request the next page of results.
 








Class com.amazonaws.services.iotthingsgraph.model.SearchSystemTemplatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filters
List<E> filters

 An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.
 


nextToken
String nextToken

 The string that specifies the next page of results. Use this when you're paginating results.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response.
 








Class com.amazonaws.services.iotthingsgraph.model.SearchSystemTemplatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaries
List<E> summaries

 An array of objects that contain summary information about each system deployment in the result set.
 


nextToken
String nextToken

 The string to specify as nextToken when you request the next page of results.
 








Class com.amazonaws.services.iotthingsgraph.model.SearchThingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


entityId
String entityId

 The ID of the entity to which the things are associated.
 
 
 The IDs should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME
 


nextToken
String nextToken

 The string that specifies the next page of results. Use this when you're paginating results.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response.
 


namespaceVersion
Long namespaceVersion

 The version of the user's namespace. Defaults to the latest version of the user's namespace.
 








Class com.amazonaws.services.iotthingsgraph.model.SearchThingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


things
List<E> things

 An array of things in the result set.
 


nextToken
String nextToken

 The string to specify as nextToken when you request the next page of results.
 








Class com.amazonaws.services.iotthingsgraph.model.SystemInstanceDescription extends Object implements Serializable


Serialized Fields


summary
SystemInstanceSummary summary

 An object that contains summary information about a system instance.
 


definition
DefinitionDocument definition


s3BucketName
String s3BucketName

 The Amazon Simple Storage Service bucket where information about a system instance is stored.
 


metricsConfiguration
MetricsConfiguration metricsConfiguration


validatedNamespaceVersion
Long validatedNamespaceVersion

 The version of the user's namespace against which the system instance was validated.
 


validatedDependencyRevisions
List<E> validatedDependencyRevisions

 A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a
 system instance.
 


flowActionsRoleArn
String flowActionsRoleArn

 The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a
 cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS
 services that the flow uses.
 








Class com.amazonaws.services.iotthingsgraph.model.SystemInstanceFilter extends Object implements Serializable


Serialized Fields


name
String name

 The name of the search filter field.
 


value
List<E> value

 An array of string values for the search filter field. Multiple values function as AND criteria in the search.
 








Class com.amazonaws.services.iotthingsgraph.model.SystemInstanceSummary extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the system instance.
 


arn
String arn

 The ARN of the system instance.
 


status
String status

 The status of the system instance.
 


target
String target

 The target of the system instance.
 


greengrassGroupName
String greengrassGroupName

 The ID of the Greengrass group where the system instance is deployed.
 


createdAt
Date createdAt

 The date when the system instance was created.
 


updatedAt
Date updatedAt

 The date and time when the system instance was last updated.
 


greengrassGroupId
String greengrassGroupId

 The ID of the Greengrass group where the system instance is deployed.
 


greengrassGroupVersionId
String greengrassGroupVersionId

 The version of the Greengrass group where the system instance is deployed.
 








Class com.amazonaws.services.iotthingsgraph.model.SystemTemplateDescription extends Object implements Serializable


Serialized Fields


summary
SystemTemplateSummary summary

 An object that contains summary information about a system.
 


definition
DefinitionDocument definition

 The definition document of a system.
 


validatedNamespaceVersion
Long validatedNamespaceVersion

 The namespace version against which the system was validated. Use this value in your system instance.
 








Class com.amazonaws.services.iotthingsgraph.model.SystemTemplateFilter extends Object implements Serializable


Serialized Fields


name
String name

 The name of the system search filter field.
 


value
List<E> value

 An array of string values for the search filter field. Multiple values function as AND criteria in the search.
 








Class com.amazonaws.services.iotthingsgraph.model.SystemTemplateSummary extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the system.
 


arn
String arn

 The ARN of the system.
 


revisionNumber
Long revisionNumber

 The revision number of the system.
 


createdAt
Date createdAt

 The date when the system was created.
 








Class com.amazonaws.services.iotthingsgraph.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.
 


value
String value

 The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.
 








Class com.amazonaws.services.iotthingsgraph.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource whose tags are returned.
 


tags
List<E> tags

 A list of tags to add to the resource.>
 








Class com.amazonaws.services.iotthingsgraph.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotthingsgraph.model.Thing extends Object implements Serializable


Serialized Fields


thingArn
String thingArn

 The ARN of the thing.
 


thingName
String thingName

 The name of the thing.
 








Class com.amazonaws.services.iotthingsgraph.model.ThrottlingException extends AWSIoTThingsGraphException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotthingsgraph.model.UndeploySystemInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the system instance to remove from its target.
 








Class com.amazonaws.services.iotthingsgraph.model.UndeploySystemInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summary
SystemInstanceSummary summary

 An object that contains summary information about the system instance that was removed from its target.
 








Class com.amazonaws.services.iotthingsgraph.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource whose tags are to be removed.
 


tagKeys
List<E> tagKeys

 A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated
 value are removed.
 
 
 This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter
 for the various command line tool environments, see Using JSON
 for Parameters in the AWS CLI User Guide.
 








Class com.amazonaws.services.iotthingsgraph.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.iotthingsgraph.model.UpdateFlowTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the workflow to be updated.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME
 


definition
DefinitionDocument definition

 The DefinitionDocument that contains the updated workflow definition.
 


compatibleNamespaceVersion
Long compatibleNamespaceVersion

 The version of the user's namespace.
 
 
 If no value is specified, the latest version is used by default. Use the GetFlowTemplateRevisions if
 you want to find earlier revisions of the flow to update.
 








Class com.amazonaws.services.iotthingsgraph.model.UpdateFlowTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summary
FlowTemplateSummary summary

 An object containing summary information about the updated workflow.
 








Class com.amazonaws.services.iotthingsgraph.model.UpdateSystemTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The ID of the system to be updated.
 
 
 The ID should be in the following format.
 
 
 urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME
 


definition
DefinitionDocument definition

 The DefinitionDocument that contains the updated system definition.
 


compatibleNamespaceVersion
Long compatibleNamespaceVersion

 The version of the user's namespace. Defaults to the latest version of the user's namespace.
 
 
 If no value is specified, the latest version is used by default.
 








Class com.amazonaws.services.iotthingsgraph.model.UpdateSystemTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summary
SystemTemplateSummary summary

 An object containing summary information about the updated system.
 








Class com.amazonaws.services.iotthingsgraph.model.UploadEntityDefinitionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


document
DefinitionDocument document

 The DefinitionDocument that defines the updated entities.
 


syncWithPublicNamespace
Boolean syncWithPublicNamespace

 A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to
 true, the upload will create a new namespace version.
 


deprecateExistingEntities
Boolean deprecateExistingEntities

 A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new
 DefinitionDocument. If set to true, the upload will create a new namespace version.
 








Class com.amazonaws.services.iotthingsgraph.model.UploadEntityDefinitionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uploadId
String uploadId

 The ID that specifies the upload action. You can use this to track the status of the upload.
 








Package com.amazonaws.services.kafka.model




Class com.amazonaws.services.kafka.model.AWSKafkaException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kafka.model.BadRequestException extends AWSKafkaException implements Serializable

serialVersionUID:
1L



Serialized Fields


invalidParameter
String invalidParameter

 The parameter that caused the error.
 








Class com.amazonaws.services.kafka.model.BrokerEBSVolumeInfo extends Object implements Serializable


Serialized Fields


kafkaBrokerNodeId
String kafkaBrokerNodeId

 The ID of the broker to update.
 


volumeSizeGB
Integer volumeSizeGB

 Size of the EBS volume to update.
 








Class com.amazonaws.services.kafka.model.BrokerNodeGroupInfo extends Object implements Serializable


Serialized Fields


brokerAZDistribution
String brokerAZDistribution

 The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify
 it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No
 other values are currently allowed.
 
 
 Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you
 provide when you create the cluster.
 


clientSubnets
List<E> clientSubnets

 The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network
 interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data.
 Client subnets can't be in Availability Zone us-east-1e.
 


instanceType
String instanceType

 The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed:
 kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.
 


securityGroups
List<E> securityGroups

 The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to
 and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default
 security group associated with the VPC.
 


storageInfo
StorageInfo storageInfo

 Contains information about storage volumes attached to MSK broker nodes.
 








Class com.amazonaws.services.kafka.model.BrokerNodeInfo extends Object implements Serializable


Serialized Fields


attachedENIId
String attachedENIId

 The attached elastic network interface of the broker.
 


brokerId
Double brokerId

 The ID of the broker.
 


clientSubnet
String clientSubnet

 The client subnet to which this broker node belongs.
 


clientVpcIpAddress
String clientVpcIpAddress

 The virtual private cloud (VPC) of the client.
 


currentBrokerSoftwareInfo
BrokerSoftwareInfo currentBrokerSoftwareInfo

 Information about the version of software currently deployed on the Kafka brokers in the cluster.
 


endpoints
List<E> endpoints

 Endpoints for accessing the broker.
 








Class com.amazonaws.services.kafka.model.BrokerSoftwareInfo extends Object implements Serializable


Serialized Fields


configurationArn
String configurationArn

 The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this
 preview release.
 


configurationRevision
Long configurationRevision

 The revision of the configuration to use. This field isn't visible in this preview release.
 


kafkaVersion
String kafkaVersion

 The version of Apache Kafka.
 








Class com.amazonaws.services.kafka.model.ClientAuthentication extends Object implements Serializable


Serialized Fields


tls
Tls tls

 Details for ClientAuthentication using TLS.
 








Class com.amazonaws.services.kafka.model.ClusterInfo extends Object implements Serializable


Serialized Fields


activeOperationArn
String activeOperationArn

 Arn of active cluster operation.
 


brokerNodeGroupInfo
BrokerNodeGroupInfo brokerNodeGroupInfo

 Information about the broker nodes.
 


clientAuthentication
ClientAuthentication clientAuthentication

 Includes all client authentication information.
 


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) that uniquely identifies the cluster.
 


clusterName
String clusterName

 The name of the cluster.
 


creationTime
Date creationTime

 The time when the cluster was created.
 


currentBrokerSoftwareInfo
BrokerSoftwareInfo currentBrokerSoftwareInfo

 Information about the version of software currently deployed on the Kafka brokers in the cluster.
 


currentVersion
String currentVersion

 The current version of the MSK cluster.
 


encryptionInfo
EncryptionInfo encryptionInfo

 Includes all encryption-related information.
 


enhancedMonitoring
String enhancedMonitoring

 Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT,
 PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of
 monitoring, see Monitoring.
 


openMonitoring
OpenMonitoring openMonitoring

 Settings for open monitoring using Prometheus.
 


numberOfBrokerNodes
Integer numberOfBrokerNodes

 The number of broker nodes in the cluster.
 


state
String state

 The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
 


stateInfo
StateInfo stateInfo


tags
Map<K,V> tags

 Tags attached to the cluster.
 


zookeeperConnectString
String zookeeperConnectString

 The connection string to use to connect to the Apache ZooKeeper cluster.
 








Class com.amazonaws.services.kafka.model.ClusterOperationInfo extends Object implements Serializable


Serialized Fields


clientRequestId
String clientRequestId

 The ID of the API request that triggered this operation.
 


clusterArn
String clusterArn

 ARN of the cluster.
 


creationTime
Date creationTime

 The time that the operation was created.
 


endTime
Date endTime

 The time at which the operation finished.
 


errorInfo
ErrorInfo errorInfo

 Describes the error if the operation fails.
 


operationArn
String operationArn

 ARN of the cluster operation.
 


operationState
String operationState

 State of the cluster operation.
 


operationType
String operationType

 Type of the cluster operation.
 


sourceClusterInfo
MutableClusterInfo sourceClusterInfo

 Information about cluster attributes before a cluster is updated.
 


targetClusterInfo
MutableClusterInfo targetClusterInfo

 Information about cluster attributes after a cluster is updated.
 








Class com.amazonaws.services.kafka.model.Configuration extends Object implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the configuration.
 


creationTime
Date creationTime

 The time when the configuration was created.
 


description
String description

 The description of the configuration.
 


kafkaVersions
List<E> kafkaVersions

 An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this
 configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this
 array.
 


latestRevision
ConfigurationRevision latestRevision

 Latest revision of the configuration.
 


name
String name

 The name of the configuration.
 








Class com.amazonaws.services.kafka.model.ConfigurationInfo extends Object implements Serializable


Serialized Fields


arn
String arn

 ARN of the configuration to use.
 


revision
Long revision

 The revision of the configuration to use.
 








Class com.amazonaws.services.kafka.model.ConfigurationRevision extends Object implements Serializable


Serialized Fields


creationTime
Date creationTime

 The time when the configuration revision was created.
 


description
String description

 The description of the configuration revision.
 


revision
Long revision

 The revision number.
 








Class com.amazonaws.services.kafka.model.ConflictException extends AWSKafkaException implements Serializable

serialVersionUID:
1L



Serialized Fields


invalidParameter
String invalidParameter

 The parameter that caused the error.
 








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


Serialized Fields


brokerNodeGroupInfo
BrokerNodeGroupInfo brokerNodeGroupInfo

 Information about the broker nodes in the cluster.
 


clientAuthentication
ClientAuthentication clientAuthentication

 Includes all client authentication related information.
 


clusterName
String clusterName

 The name of the cluster.
 


configurationInfo
ConfigurationInfo configurationInfo

 Represents the configuration that you want MSK to use for the brokers in a cluster.
 


encryptionInfo
EncryptionInfo encryptionInfo

 Includes all encryption-related information.
 


enhancedMonitoring
String enhancedMonitoring

 Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and
 PER_TOPIC_PER_BROKER.
 


openMonitoring
OpenMonitoringInfo openMonitoring

 The settings for open monitoring.
 


kafkaVersion
String kafkaVersion

 The version of Apache Kafka.
 


numberOfBrokerNodes
Integer numberOfBrokerNodes

 The number of broker nodes in the cluster.
 


tags
Map<K,V> tags

 Create tags when creating the cluster.
 








Class com.amazonaws.services.kafka.model.CreateClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) of the cluster.
 


clusterName
String clusterName

 The name of the MSK cluster.
 


state
String state

 The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
 








Class com.amazonaws.services.kafka.model.CreateConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description

 The description of the configuration.
 


kafkaVersions
List<E> kafkaVersions

 The versions of Apache Kafka with which you can use this MSK configuration.
 


name
String name

 The name of the configuration.
 


serverProperties
ByteBuffer serverProperties

 Contents of the server.properties file. When using the API, you must ensure that the
 contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the
 contents of server.properties can be in plaintext.
 








Class com.amazonaws.services.kafka.model.CreateConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the configuration.
 


creationTime
Date creationTime

 The time when the configuration was created.
 


latestRevision
ConfigurationRevision latestRevision

 Latest revision of the configuration.
 


name
String name

 The name of the configuration.
 








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


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) that uniquely identifies the cluster.
 


currentVersion
String currentVersion

 The current version of the MSK cluster.
 








Class com.amazonaws.services.kafka.model.DeleteClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) of the cluster.
 


state
String state

 The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.
 








Class com.amazonaws.services.kafka.model.DescribeClusterOperationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterOperationArn
String clusterOperationArn

 The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.
 








Class com.amazonaws.services.kafka.model.DescribeClusterOperationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterOperationInfo
ClusterOperationInfo clusterOperationInfo

 Cluster operation information
 








Class com.amazonaws.services.kafka.model.DescribeClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) that uniquely identifies the cluster.
 








Class com.amazonaws.services.kafka.model.DescribeClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterInfo
ClusterInfo clusterInfo

 The cluster information.
 








Class com.amazonaws.services.kafka.model.DescribeConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
 








Class com.amazonaws.services.kafka.model.DescribeConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the configuration.
 


creationTime
Date creationTime

 The time when the configuration was created.
 


description
String description

 The description of the configuration.
 


kafkaVersions
List<E> kafkaVersions

 The versions of Apache Kafka with which you can use this MSK configuration.
 


latestRevision
ConfigurationRevision latestRevision

 Latest revision of the configuration.
 


name
String name

 The name of the configuration.
 








Class com.amazonaws.services.kafka.model.DescribeConfigurationRevisionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
 


revision
Long revision

 A string that uniquely identifies a revision of an MSK configuration.
 








Class com.amazonaws.services.kafka.model.DescribeConfigurationRevisionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the configuration.
 


creationTime
Date creationTime

 The time when the configuration was created.
 


description
String description

 The description of the configuration.
 


revision
Long revision

 The revision number.
 


serverProperties
ByteBuffer serverProperties

 Contents of the server.properties file. When using the API, you must ensure that the
 contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the
 contents of server.properties can be in plaintext.
 








Class com.amazonaws.services.kafka.model.EBSStorageInfo extends Object implements Serializable


Serialized Fields


volumeSize
Integer volumeSize

 The size in GiB of the EBS volume for the data drive on each broker node.
 








Class com.amazonaws.services.kafka.model.EncryptionAtRest extends Object implements Serializable


Serialized Fields


dataVolumeKMSKeyId
String dataVolumeKMSKeyId

 The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you
 and uses it.
 








Class com.amazonaws.services.kafka.model.EncryptionInfo extends Object implements Serializable


Serialized Fields


encryptionAtRest
EncryptionAtRest encryptionAtRest

 The data-volume encryption details.
 


encryptionInTransit
EncryptionInTransit encryptionInTransit

 The details for encryption in transit.
 








Class com.amazonaws.services.kafka.model.EncryptionInTransit extends Object implements Serializable


Serialized Fields


clientBroker
String clientBroker

 Indicates the encryption setting for data in transit between clients and brokers. The following are the possible
 values.
 
 
 TLS means that client-broker communication is enabled with TLS only.
 
 
 TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext
 data.
 
 
 PLAINTEXT means that client-broker communication is enabled in plaintext only.
 
 
 The default value is TLS_PLAINTEXT.
 


inCluster
Boolean inCluster

 When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When
 set to false, the communication happens in plaintext.
 
 
 The default value is true.
 








Class com.amazonaws.services.kafka.model.ErrorInfo extends Object implements Serializable


Serialized Fields


errorCode
String errorCode

 A number describing the error programmatically.
 


errorString
String errorString

 An optional field to provide more details about the error.
 








Class com.amazonaws.services.kafka.model.ForbiddenException extends AWSKafkaException implements Serializable

serialVersionUID:
1L



Serialized Fields


invalidParameter
String invalidParameter

 The parameter that caused the error.
 








Class com.amazonaws.services.kafka.model.GetBootstrapBrokersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) that uniquely identifies the cluster.
 








Class com.amazonaws.services.kafka.model.GetBootstrapBrokersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bootstrapBrokerString
String bootstrapBrokerString

 A string containing one or more hostname:port pairs.
 


bootstrapBrokerStringTls
String bootstrapBrokerStringTls

 A string containing one or more DNS names (or IP) and TLS port pairs.
 








Class com.amazonaws.services.kafka.model.InternalServerErrorException extends AWSKafkaException implements Serializable

serialVersionUID:
1L



Serialized Fields


invalidParameter
String invalidParameter

 The parameter that caused the error.
 








Class com.amazonaws.services.kafka.model.JmxExporter extends Object implements Serializable


Serialized Fields


enabledInBroker
Boolean enabledInBroker

 Indicates whether you want to enable or disable the JMX Exporter.
 








Class com.amazonaws.services.kafka.model.JmxExporterInfo extends Object implements Serializable


Serialized Fields


enabledInBroker
Boolean enabledInBroker

 Indicates whether you want to enable or disable the JMX Exporter.
 








Class com.amazonaws.services.kafka.model.KafkaVersion extends Object implements Serializable


Serialized Fields


version
String version


status
String status








Class com.amazonaws.services.kafka.model.ListClusterOperationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) that uniquely identifies the cluster.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response. If there are more results, the response includes a
 NextToken parameter.
 


nextToken
String nextToken

 The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the
 response. To get the next batch, provide this token in your next request.
 








Class com.amazonaws.services.kafka.model.ListClusterOperationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterOperationInfoList
List<E> clusterOperationInfoList

 An array of cluster operation information objects.
 


nextToken
String nextToken

 If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken
 should be sent in the subsequent request to ListClusterOperations.
 








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


Serialized Fields


clusterNameFilter
String clusterNameFilter

 Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose
 names start with this prefix.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response. If there are more results, the response includes a
 NextToken parameter.
 


nextToken
String nextToken

 The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the
 response. To get the next batch, provide this token in your next request.
 








Class com.amazonaws.services.kafka.model.ListClustersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterInfoList
List<E> clusterInfoList

 Information on each of the MSK clusters in the response.
 


nextToken
String nextToken

 The paginated results marker. When the result of a ListClusters operation is truncated, the call returns
 NextToken in the response. To get another batch of clusters, provide this token in your next request.
 








Class com.amazonaws.services.kafka.model.ListConfigurationRevisionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response. If there are more results, the response includes a
 NextToken parameter.
 


nextToken
String nextToken

 The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the
 response. To get the next batch, provide this token in your next request.
 








Class com.amazonaws.services.kafka.model.ListConfigurationRevisionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 Paginated results marker.
 


revisions
List<E> revisions

 List of ConfigurationRevision objects.
 








Class com.amazonaws.services.kafka.model.ListConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results to return in the response. If there are more results, the response includes a
 NextToken parameter.
 


nextToken
String nextToken

 The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the
 response. To get the next batch, provide this token in your next request.
 








Class com.amazonaws.services.kafka.model.ListConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurations
List<E> configurations

 An array of MSK configurations.
 


nextToken
String nextToken

 The paginated results marker. When the result of a ListConfigurations operation is truncated, the call returns
 NextToken in the response. To get another batch of configurations, provide this token in your next request.
 








Class com.amazonaws.services.kafka.model.ListKafkaVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of results to return in the response. If there are more results, the response includes a
 NextToken parameter.
 


nextToken
String nextToken

 The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the
 response. To get the next batch, provide this token in your next request.
 








Class com.amazonaws.services.kafka.model.ListKafkaVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


kafkaVersions
List<E> kafkaVersions


nextToken
String nextToken








Class com.amazonaws.services.kafka.model.ListNodesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) that uniquely identifies the cluster.
 


maxResults
Integer maxResults

 The maximum number of results to return in the response. If there are more results, the response includes a
 NextToken parameter.
 


nextToken
String nextToken

 The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the
 response. To get the next batch, provide this token in your next request.
 








Class com.amazonaws.services.kafka.model.ListNodesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken
 in the response. To get another batch of nodes, provide this token in your next request.
 


nodeInfoList
List<E> nodeInfoList

 List containing a NodeInfo object.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
 








Class com.amazonaws.services.kafka.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 The key-value pair for the resource tag.
 








Class com.amazonaws.services.kafka.model.MutableClusterInfo extends Object implements Serializable


Serialized Fields


brokerEBSVolumeInfo
List<E> brokerEBSVolumeInfo

 Specifies the size of the EBS volume and the ID of the associated broker.
 


configurationInfo
ConfigurationInfo configurationInfo

 Information about the changes in the configuration of the brokers.
 


numberOfBrokerNodes
Integer numberOfBrokerNodes

 The number of broker nodes in the cluster.
 


enhancedMonitoring
String enhancedMonitoring

 Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
 


openMonitoring
OpenMonitoring openMonitoring

 The settings for open monitoring.
 








Class com.amazonaws.services.kafka.model.NodeExporter extends Object implements Serializable


Serialized Fields


enabledInBroker
Boolean enabledInBroker

 Indicates whether you want to enable or disable the Node Exporter.
 








Class com.amazonaws.services.kafka.model.NodeExporterInfo extends Object implements Serializable


Serialized Fields


enabledInBroker
Boolean enabledInBroker

 Indicates whether you want to enable or disable the Node Exporter.
 








Class com.amazonaws.services.kafka.model.NodeInfo extends Object implements Serializable


Serialized Fields


addedToClusterTime
String addedToClusterTime

 The start time.
 


brokerNodeInfo
BrokerNodeInfo brokerNodeInfo

 The broker node info.
 


instanceType
String instanceType

 The instance type.
 


nodeARN
String nodeARN

 The Amazon Resource Name (ARN) of the node.
 


nodeType
String nodeType

 The node type.
 


zookeeperNodeInfo
ZookeeperNodeInfo zookeeperNodeInfo

 The ZookeeperNodeInfo.
 








Class com.amazonaws.services.kafka.model.NotFoundException extends AWSKafkaException implements Serializable

serialVersionUID:
1L



Serialized Fields


invalidParameter
String invalidParameter

 The parameter that caused the error.
 








Class com.amazonaws.services.kafka.model.OpenMonitoring extends Object implements Serializable


Serialized Fields


prometheus
Prometheus prometheus

 Prometheus settings.
 








Class com.amazonaws.services.kafka.model.OpenMonitoringInfo extends Object implements Serializable


Serialized Fields


prometheus
PrometheusInfo prometheus

 Prometheus settings.
 








Class com.amazonaws.services.kafka.model.Prometheus extends Object implements Serializable


Serialized Fields


jmxExporter
JmxExporter jmxExporter

 Indicates whether you want to enable or disable the JMX Exporter.
 


nodeExporter
NodeExporter nodeExporter

 Indicates whether you want to enable or disable the Node Exporter.
 








Class com.amazonaws.services.kafka.model.PrometheusInfo extends Object implements Serializable


Serialized Fields


jmxExporter
JmxExporterInfo jmxExporter

 Indicates whether you want to enable or disable the JMX Exporter.
 


nodeExporter
NodeExporterInfo nodeExporter

 Indicates whether you want to enable or disable the Node Exporter.
 








Class com.amazonaws.services.kafka.model.ServiceUnavailableException extends AWSKafkaException implements Serializable

serialVersionUID:
1L



Serialized Fields


invalidParameter
String invalidParameter

 The parameter that caused the error.
 








Class com.amazonaws.services.kafka.model.StateInfo extends Object implements Serializable


Serialized Fields


code
String code


message
String message








Class com.amazonaws.services.kafka.model.StorageInfo extends Object implements Serializable


Serialized Fields


ebsStorageInfo
EBSStorageInfo ebsStorageInfo

 EBS volume information.
 








Class com.amazonaws.services.kafka.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
 


tags
Map<K,V> tags

 The key-value pair for the resource tag.
 








Class com.amazonaws.services.kafka.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kafka.model.Tls extends Object implements Serializable


Serialized Fields


certificateAuthorityArnList
List<E> certificateAuthorityArnList

 List of ACM Certificate Authority ARNs.
 








Class com.amazonaws.services.kafka.model.TooManyRequestsException extends AWSKafkaException implements Serializable

serialVersionUID:
1L



Serialized Fields


invalidParameter
String invalidParameter

 The parameter that caused the error.
 








Class com.amazonaws.services.kafka.model.UnauthorizedException extends AWSKafkaException implements Serializable

serialVersionUID:
1L



Serialized Fields


invalidParameter
String invalidParameter

 The parameter that caused the error.
 








Class com.amazonaws.services.kafka.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.
 


tagKeys
List<E> tagKeys

 Tag keys must be unique for a given cluster. In addition, the following restrictions apply:
 
 
 
 
 Each tag key must be unique. If you add a tag with a key that's already in use, your new tag overwrites the
 existing key-value pair.
 
 
 
 
 You can't start a tag key with aws: because this prefix is reserved for use by AWS. AWS creates tags that begin
 with this prefix on your behalf, but you can't edit or delete them.
 
 
 
 
 Tag keys must be between 1 and 128 Unicode characters in length.
 
 
 
 
 Tag keys must consist of the following characters: Unicode letters, digits, white space, and the following
 special characters: _ . / = + -








Class com.amazonaws.services.kafka.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kafka.model.UpdateBrokerCountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) that uniquely identifies the cluster.
 


currentVersion
String currentVersion

 The version of cluster to update from. A successful operation will then generate a new version.
 


targetNumberOfBrokerNodes
Integer targetNumberOfBrokerNodes

 The number of broker nodes that you want the cluster to have after this operation completes successfully.
 








Class com.amazonaws.services.kafka.model.UpdateBrokerCountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) of the cluster.
 


clusterOperationArn
String clusterOperationArn

 The Amazon Resource Name (ARN) of the cluster operation.
 








Class com.amazonaws.services.kafka.model.UpdateBrokerStorageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) that uniquely identifies the cluster.
 


currentVersion
String currentVersion

 The version of cluster to update from. A successful operation will then generate a new version.
 


targetBrokerEBSVolumeInfo
List<E> targetBrokerEBSVolumeInfo

 Describes the target volume size and the ID of the broker to apply the update to.
 








Class com.amazonaws.services.kafka.model.UpdateBrokerStorageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) of the cluster.
 


clusterOperationArn
String clusterOperationArn

 The Amazon Resource Name (ARN) of the cluster operation.
 








Class com.amazonaws.services.kafka.model.UpdateClusterConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) that uniquely identifies the cluster.
 


configurationInfo
ConfigurationInfo configurationInfo

 Represents the configuration that you want MSK to use for the brokers in a cluster.
 


currentVersion
String currentVersion

 The version of the cluster that needs to be updated.
 








Class com.amazonaws.services.kafka.model.UpdateClusterConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) of the cluster.
 


clusterOperationArn
String clusterOperationArn

 The Amazon Resource Name (ARN) of the cluster operation.
 








Class com.amazonaws.services.kafka.model.UpdateMonitoringRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) that uniquely identifies the cluster.
 


currentVersion
String currentVersion

 The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster
 to find its version. When this update operation is successful, it generates a new cluster version.
 


enhancedMonitoring
String enhancedMonitoring

 Specifies which Apache Kafka metrics Amazon MSK gathers and sends to Amazon CloudWatch for this cluster.
 


openMonitoring
OpenMonitoringInfo openMonitoring

 The settings for open monitoring.
 








Class com.amazonaws.services.kafka.model.UpdateMonitoringResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) of the cluster.
 


clusterOperationArn
String clusterOperationArn

 The Amazon Resource Name (ARN) of the cluster operation.
 








Class com.amazonaws.services.kafka.model.ZookeeperNodeInfo extends Object implements Serializable


Serialized Fields


attachedENIId
String attachedENIId

 The attached elastic network interface of the broker.
 


clientVpcIpAddress
String clientVpcIpAddress

 The virtual private cloud (VPC) IP address of the client.
 


endpoints
List<E> endpoints

 Endpoints for accessing the ZooKeeper.
 


zookeeperId
Double zookeeperId

 The role-specific ID for Zookeeper.
 


zookeeperVersion
String zookeeperVersion

 The version of Zookeeper.
 








Package com.amazonaws.services.kendra.model




Class com.amazonaws.services.kendra.model.AccessControlListConfiguration extends Object implements Serializable


Serialized Fields


keyPath
String keyPath

 Path to the AWS S3 bucket that contains the ACL files.
 








Class com.amazonaws.services.kendra.model.AccessDeniedException extends AWSkendraException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kendra.model.AclConfiguration extends Object implements Serializable


Serialized Fields


allowedGroupsColumnName
String allowedGroupsColumnName

 A list of groups, separated by semi-colons, that filters a query response based on user context. The document is
 only returned to users that are in one of the groups specified in the UserContext field of the
 Query operation.
 








Class com.amazonaws.services.kendra.model.AdditionalResultAttribute extends Object implements Serializable


Serialized Fields


key
String key



valueType
String valueType



value
AdditionalResultAttributeValue value









Class com.amazonaws.services.kendra.model.AdditionalResultAttributeValue extends Object implements Serializable


Serialized Fields


textWithHighlightsValue
TextWithHighlights textWithHighlightsValue

 The text associated with the attribute and information about the highlight to apply to the text.
 








Class com.amazonaws.services.kendra.model.AttributeFilter extends Object implements Serializable


Serialized Fields


andAllFilters
List<E> andAllFilters

 Performs a logical AND operation on all supplied filters.
 


orAllFilters
List<E> orAllFilters

 Performs a logical OR operation on all supplied filters.
 


notFilter
AttributeFilter notFilter

 Performs a logical NOT operation on all supplied filters.
 


equalsTo
DocumentAttribute equalsTo

 Performs an equals operation on two document attributes.
 


containsAll
DocumentAttribute containsAll

 Returns true when a document contains all of the specified document attributes.
 


containsAny
DocumentAttribute containsAny

 Returns true when a document contains any of the specified document attributes.
 


greaterThan
DocumentAttribute greaterThan

 Performs a greater than operation on two document attributes. Use with a document attribute of type
 Integer or Long.
 


greaterThanOrEquals
DocumentAttribute greaterThanOrEquals

 Performs a greater or equals than operation on two document attributes. Use with a document attribute of type
 Integer or Long.
 


lessThan
DocumentAttribute lessThan

 Performs a less than operation on two document attributes. Use with a document attribute of type
 Integer or Long.
 


lessThanOrEquals
DocumentAttribute lessThanOrEquals

 Performs a less than or equals operation on two document attributes. Use with a document attribute of type
 Integer or Long.
 








Class com.amazonaws.services.kendra.model.AWSkendraException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kendra.model.BatchDeleteDocumentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


indexId
String indexId

 The identifier of the index that contains the documents to delete.
 


documentIdList
List<E> documentIdList

 One or more identifiers for documents to delete from the index.
 








Class com.amazonaws.services.kendra.model.BatchDeleteDocumentResponseFailedDocument extends Object implements Serializable


Serialized Fields


id
String id

 The identifier of the document that couldn't be removed from the index.
 


errorCode
String errorCode

 The error code for why the document couldn't be removed from the index.
 


errorMessage
String errorMessage

 An explanation for why the document couldn't be removed from the index.
 








Class com.amazonaws.services.kendra.model.BatchDeleteDocumentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedDocuments
List<E> failedDocuments

 A list of documents that could not be removed from the index. Each entry contains an error message that indicates
 why the document couldn't be removed from the index.
 








Class com.amazonaws.services.kendra.model.BatchPutDocumentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


indexId
String indexId

 The identifier of the index to add the documents to. You need to create the index first using the
 CreateIndex operation.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument operation. For
 more information, see IAM Roles for Amazon
 Kendra.
 


documents
List<E> documents

 One or more documents to add to the index.
 
 
 Each document is limited to 5 Mb, the total size of the list is limited to 50 Mb.
 








Class com.amazonaws.services.kendra.model.BatchPutDocumentResponseFailedDocument extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier of the document.
 


errorCode
String errorCode

 The type of error that caused the document to fail to be indexed.
 


errorMessage
String errorMessage

 A description of the reason why the document could not be indexed.
 








Class com.amazonaws.services.kendra.model.BatchPutDocumentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedDocuments
List<E> failedDocuments

 A list of documents that were not added to the index because the document failed a validation check. Each
 document contains an error message that indicates why the document couldn't be added to the index.
 
 
 If there was an error adding a document to an index the error is reported in your AWS CloudWatch log.
 








Class com.amazonaws.services.kendra.model.ClickFeedback extends Object implements Serializable


Serialized Fields


resultId
String resultId

 The unique identifier of the search result that was clicked.
 


clickTime
Date clickTime

 The Unix timestamp of the data and time that the result was clicked.
 








Class com.amazonaws.services.kendra.model.ColumnConfiguration extends Object implements Serializable


Serialized Fields


documentIdColumnName
String documentIdColumnName

 The column that provides the document's unique identifier.
 


documentDataColumnName
String documentDataColumnName

 The column that contains the contents of the document.
 


documentTitleColumnName
String documentTitleColumnName

 The column that contains the title of the document.
 


fieldMappings
List<E> fieldMappings

 An array of objects that map database column names to the corresponding fields in an index. You must first create
 the fields in the index using the UpdateIndex operation.
 


changeDetectingColumns
List<E> changeDetectingColumns

 One to five columns that indicate when a document in the database has changed.
 








Class com.amazonaws.services.kendra.model.ConflictException extends AWSkendraException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kendra.model.ConnectionConfiguration extends Object implements Serializable


Serialized Fields


databaseHost
String databaseHost

 The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6
 address.
 


databasePort
Integer databasePort

 The port that the database uses for connections.
 


databaseName
String databaseName

 The name of the database containing the document data.
 


tableName
String tableName

 The name of the table that contains the document data.
 


secretArn
String secretArn

 The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a
 user/password pair. For more information, see Using a Database Data Source.
 For more information about AWS Secrets Manager, see  What Is AWS Secrets Manager 
 in the AWS Secrets Manager user guide.
 








Class com.amazonaws.services.kendra.model.CreateDataSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A unique name for the data source. A data source name can't be changed without deleting and recreating the data
 source.
 


indexId
String indexId

 The identifier of the index that should be associated with this data source.
 


type
String type

 The type of repository that contains the data source.
 


configuration
DataSourceConfiguration configuration

 The connector configuration information that is required to access the repository.
 


description
String description

 A description for the data source.
 


schedule
String schedule

 Sets the frequency that Amazon Kendra will check the documents in your repository and update the index. If you
 don't set a schedule Amazon Kendra will not periodically update the index. You can call the
 StartDataSourceSyncJob operation to update the index.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of a role with permission to access the data source. For more information, see IAM Roles for Amazon Kendra.
 








Class com.amazonaws.services.kendra.model.CreateDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 A unique identifier for the data source.
 








Class com.amazonaws.services.kendra.model.CreateFaqRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


indexId
String indexId

 The identifier of the index that contains the FAQ.
 


name
String name

 The name that should be associated with the FAQ.
 


description
String description

 A description of the FAQ.
 


s3Path
S3Path s3Path

 The S3 location of the FAQ input data.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more
 information, see IAM Roles for Amazon
 Kendra.
 








Class com.amazonaws.services.kendra.model.CreateFaqResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The unique identifier of the FAQ.
 








Class com.amazonaws.services.kendra.model.CreateIndexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name for the new index.
 


roleArn
String roleArn

 An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also
 the role used when you use the BatchPutDocument operation to index documents from an Amazon S3
 bucket.
 


serverSideEncryptionConfiguration
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration

 The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon
 Kendra doesn't support asymmetric CMKs.
 


description
String description

 A description for the index.
 








Class com.amazonaws.services.kendra.model.CreateIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The unique identifier of the index. Use this identifier when you query an index, set up a data source, or index a
 document.
 








Class com.amazonaws.services.kendra.model.DatabaseConfiguration extends Object implements Serializable


Serialized Fields


databaseEngineType
String databaseEngineType

 The type of database engine that runs the database.
 


connectionConfiguration
ConnectionConfiguration connectionConfiguration

 The information necessary to connect to a database.
 


vpcConfiguration
DataSourceVpcConfiguration vpcConfiguration


columnConfiguration
ColumnConfiguration columnConfiguration

 Information about where the index should get the document information from the database.
 


aclConfiguration
AclConfiguration aclConfiguration

 Information about the database column that provides information for user context filtering.
 








Class com.amazonaws.services.kendra.model.DataSourceConfiguration extends Object implements Serializable


Serialized Fields


s3Configuration
S3DataSourceConfiguration s3Configuration

 Provides information to create a connector for a document repository in an Amazon S3 bucket.
 


sharePointConfiguration
SharePointConfiguration sharePointConfiguration

 Provides information necessary to create a connector for a Microsoft SharePoint site.
 


databaseConfiguration
DatabaseConfiguration databaseConfiguration

 Provides information necessary to create a connector for a database.
 








Class com.amazonaws.services.kendra.model.DataSourceSummary extends Object implements Serializable


Serialized Fields


name
String name

 The name of the data source.
 


id
String id

 The unique identifier for the data source.
 


type
String type

 The type of the data source.
 


createdAt
Date createdAt

 The UNIX datetime that the data source was created.
 


updatedAt
Date updatedAt

 The UNIX datetime that the data source was lasted updated.
 


status
String status

 The status of the data source. When the status is ATIVE the data source is ready to use.
 








Class com.amazonaws.services.kendra.model.DataSourceSyncJob extends Object implements Serializable


Serialized Fields


executionId
String executionId

 A unique identifier for the synchronization job.
 


startTime
Date startTime

 The UNIX datetime that the synchronization job was started.
 


endTime
Date endTime

 The UNIX datetime that the synchronization job was completed.
 


status
String status

 The execution status of the synchronization job. When the Status field is set to
 SUCCEEDED, the synchronization job is done. If the status code is set to FAILED, the
 ErrorCode and ErrorMessage fields give you the reason for the failure.
 


errorMessage
String errorMessage

 If the Status field is set to ERROR, the ErrorMessage field contains a
 description of the error that caused the synchronization to fail.
 


errorCode
String errorCode

 If the Status field is set to FAILED, the ErrorCode field contains a the
 reason that the synchronization failed.
 


dataSourceErrorCode
String dataSourceErrorCode

 If the reason that the synchronization failed is due to an error with the underlying data source, this field
 contains a code that identifies the error.
 








Class com.amazonaws.services.kendra.model.DataSourceToIndexFieldMapping extends Object implements Serializable


Serialized Fields


dataSourceFieldName
String dataSourceFieldName

 The name of the column or attribute in the data source.
 


dateFieldFormat
String dateFieldFormat

 The type of data stored in the column or attribute.
 


indexFieldName
String indexFieldName

 The name of the field in the index.
 








Class com.amazonaws.services.kendra.model.DataSourceVpcConfiguration extends Object implements Serializable


Serialized Fields


subnetIds
List<E> subnetIds

 A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in
 the VPC, and they should have outgoing access to the Internet through a NAT device.
 


securityGroupIds
List<E> securityGroupIds

 A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra
 to connect to the data source.
 








Class com.amazonaws.services.kendra.model.DeleteFaqRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the FAQ to remove.
 


indexId
String indexId

 The index to remove the FAQ from.
 








Class com.amazonaws.services.kendra.model.DeleteFaqResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kendra.model.DeleteIndexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the index to delete.
 








Class com.amazonaws.services.kendra.model.DeleteIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kendra.model.DescribeDataSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The unique identifier of the data source to describe.
 


indexId
String indexId

 The identifier of the index that contains the data source.
 








Class com.amazonaws.services.kendra.model.DescribeDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The identifier of the data source.
 


indexId
String indexId

 The identifier of the index that contains the data source.
 


name
String name

 The name that you gave the data source when it was created.
 


type
String type

 The type of the data source.
 


configuration
DataSourceConfiguration configuration

 Information that describes where the data source is located and how the data source is configured. The specific
 information in the description depends on the data source provider.
 


createdAt
Date createdAt

 The Unix timestamp of when the data source was created.
 


updatedAt
Date updatedAt

 The Unix timestamp of when the data source was last updated.
 


description
String description

 The description of the data source.
 


status
String status

 The current status of the data source. When the status is ACTIVE the data source is ready to use.
 When the status is FAILED, the ErrorMessage field contains the reason that the data
 source failed.
 


schedule
String schedule

 The schedule that Amazon Kendra will update the data source.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
 


errorMessage
String errorMessage

 When the Status field value is FAILED, the ErrorMessage field contains a
 description of the error that caused the data source to fail.
 








Class com.amazonaws.services.kendra.model.DescribeFaqRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The unique identifier of the FAQ.
 


indexId
String indexId

 The identifier of the index that contains the FAQ.
 








Class com.amazonaws.services.kendra.model.DescribeFaqResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


id
String id

 The identifier of the FAQ.
 


indexId
String indexId

 The identifier of the index that contains the FAQ.
 


name
String name

 The name that you gave the FAQ when it was created.
 


description
String description

 The description of the FAQ that you provided when it was created.
 


createdAt
Date createdAt

 The date and time that the FAQ was created.
 


updatedAt
Date updatedAt

 The date and time that the FAQ was last updated.
 


s3Path
S3Path s3Path


status
String status

 The status of the FAQ. It is ready to use when the status is ACTIVE.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for
 the FAQ.
 


errorMessage
String errorMessage

 If the Status field is FAILED, the ErrorMessage field contains the reason
 why the FAQ failed.
 








Class com.amazonaws.services.kendra.model.DescribeIndexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The name of the index to describe.
 








Class com.amazonaws.services.kendra.model.DescribeIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the index.
 


id
String id

 the name of the index.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon
 Cloudwatch logs.
 


serverSideEncryptionConfiguration
ServerSideEncryptionConfiguration serverSideEncryptionConfiguration

 The identifier of the AWS KMS customer master key (CMK) used to encrypt your data. Amazon Kendra doesn't support
 asymmetric CMKs.
 


status
String status

 The current status of the index. When the value is ACTIVE, the index is ready for use. If the
 Status field value is FAILED, the ErrorMessage field contains a message
 that explains why.
 


description
String description

 The description of the index.
 


createdAt
Date createdAt

 The Unix datetime that the index was created.
 


updatedAt
Date updatedAt

 The Unix datetime that the index was last updated.
 


documentMetadataConfigurations
List<E> documentMetadataConfigurations

 Configuration settings for any metadata applied to the documents in the index.
 


indexStatistics
IndexStatistics indexStatistics

 Provides information about the number of FAQ questions and answers and the number of text documents indexed.
 


errorMessage
String errorMessage

 When th eStatus field value is FAILED, the ErrorMessage field contains a
 message that explains why.
 








Class com.amazonaws.services.kendra.model.Document extends Object implements Serializable


Serialized Fields


id
String id

 A unique identifier of the document in the index.
 


title
String title

 The title of the document.
 


blob
ByteBuffer blob

 The contents of the document as a base-64 encoded string.
 


s3Path
S3Path s3Path


attributes
List<E> attributes

 Custom attributes to apply to the document. Use the custom attributes to provide additional information for
 searching, to provide facets for refining searches, and to provide additional information in the query response.
 


accessControlList
List<E> accessControlList

 Information to use for user context filtering.
 


contentType
String contentType

 The file type of the document in the Blob field.
 








Class com.amazonaws.services.kendra.model.DocumentAttribute extends Object implements Serializable


Serialized Fields


key
String key

 The identifier for the attribute.
 


value
DocumentAttributeValue value

 The value of the attribute.
 








Class com.amazonaws.services.kendra.model.DocumentAttributeValue extends Object implements Serializable


Serialized Fields


stringValue
String stringValue

 A string, such as "department".
 


stringListValue
List<E> stringListValue

 A list of strings.
 


longValue
Long longValue

 A long integer value.
 


dateValue
Date dateValue

 A date value expressed as seconds from the Unix epoch.
 








Class com.amazonaws.services.kendra.model.DocumentAttributeValueCountPair extends Object implements Serializable


Serialized Fields


documentAttributeValue
DocumentAttributeValue documentAttributeValue

 The value of the attribute. For example, "HR."
 


count
Integer count

 The number of documents in the response that have the attribute value for the key.
 








Class com.amazonaws.services.kendra.model.DocumentMetadataConfiguration extends Object implements Serializable


Serialized Fields


name
String name

 The name of the index field.
 


type
String type

 The data type of the index field.
 


relevance
Relevance relevance

 Provides manual tuning parameters to determine how the field affects the search results.
 


search
Search search

 Provides information about how the field is used during a search.
 








Class com.amazonaws.services.kendra.model.DocumentsMetadataConfiguration extends Object implements Serializable


Serialized Fields


s3Prefix
String s3Prefix

 A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple
 metadata files. Use S3Prefix to include only the desired metadata files.
 








Class com.amazonaws.services.kendra.model.Facet extends Object implements Serializable


Serialized Fields


documentAttributeKey
String documentAttributeKey

 The unique key for the document attribute.
 








Class com.amazonaws.services.kendra.model.FacetResult extends Object implements Serializable


Serialized Fields


documentAttributeKey
String documentAttributeKey

 The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.
 


documentAttributeValueCountPairs
List<E> documentAttributeValueCountPairs

 An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents
 that share the key value.
 








Class com.amazonaws.services.kendra.model.FaqStatistics extends Object implements Serializable


Serialized Fields


indexedQuestionAnswersCount
Integer indexedQuestionAnswersCount

 The total number of FAQ questions and answers contained in the index.
 








Class com.amazonaws.services.kendra.model.FaqSummary extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier of the FAQ.
 


name
String name

 The name that you assigned the FAQ when you created or updated the FAQ.
 


status
String status

 The current status of the FAQ. When the status is ACTIVE the FAQ is ready for use.
 


createdAt
Date createdAt

 The UNIX datetime that the FAQ was added to the index.
 


updatedAt
Date updatedAt

 The UNIX datetime that the FAQ was last updated.
 








Class com.amazonaws.services.kendra.model.Highlight extends Object implements Serializable


Serialized Fields


beginOffset
Integer beginOffset

 The zero-based location in the response string where the highlight starts.
 


endOffset
Integer endOffset

 The zero-based location in the response string where the highlight ends.
 


topAnswer
Boolean topAnswer

 Indicates whether the response is the best response. True if this is the best response; otherwise, false.
 








Class com.amazonaws.services.kendra.model.IndexConfigurationSummary extends Object implements Serializable


Serialized Fields


name
String name

 The name of the index.
 


id
String id

 A unique identifier for the index. Use this to identify the index when you are using operations such as
 Query, DescribeIndex, UpdateIndex, and DeleteIndex.
 


createdAt
Date createdAt

 The Unix timestamp when the index was created.
 


updatedAt
Date updatedAt

 The Unix timestamp when the index was last updated by the UpdateIndex operation.
 


status
String status

 The current status of the index. When the status is ACTIVE, the index is ready to search.
 








Class com.amazonaws.services.kendra.model.IndexStatistics extends Object implements Serializable


Serialized Fields


faqStatistics
FaqStatistics faqStatistics

 The number of question and answer topics in the index.
 


textDocumentStatistics
TextDocumentStatistics textDocumentStatistics

 The number of text documents indexed.
 








Class com.amazonaws.services.kendra.model.InternalServerException extends AWSkendraException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kendra.model.ListDataSourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


indexId
String indexId

 The identifier of the index that contains the data source.
 


nextToken
String nextToken

 If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a
 pagination token in the response. You can use this pagination token to retrieve the next set of data sources (
 DataSourceSummaryItems).
 


maxResults
Integer maxResults

 The maximum number of data sources to return.
 








Class com.amazonaws.services.kendra.model.ListDataSourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


summaryItems
List<E> summaryItems

 An array of summary information for one or more data sources.
 


nextToken
String nextToken

 If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to
 retrieve the next set of data sources.
 








Class com.amazonaws.services.kendra.model.ListDataSourceSyncJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the data source.
 


indexId
String indexId

 The identifier of the index that contains the data source.
 


nextToken
String nextToken

 If the result of the previous request to GetDataSourceSyncJobHistory was truncated, include the
 NextToken to fetch the next set of jobs.
 


maxResults
Integer maxResults

 The maximum number of synchronization jobs to return in the response. If there are fewer results in the list,
 this response contains only the actual results.
 


startTimeFilter
TimeRange startTimeFilter

 When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
 


statusFilter
String statusFilter

 When specified, only returns synchronization jobs with the Status field equal to the specified
 status.
 








Class com.amazonaws.services.kendra.model.ListDataSourceSyncJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


history
List<E> history

 A history of synchronization jobs for the data source.
 


nextToken
String nextToken

 The GetDataSourceSyncJobHistory operation returns a page of vocabularies at a time. The maximum size
 of the page is set by the MaxResults parameter. If there are more jobs in the list than the page
 size, Amazon Kendra returns the NextPage token. Include the token in the next request to the
 GetDataSourceSyncJobHistory operation to return in the next page of jobs.
 








Class com.amazonaws.services.kendra.model.ListFaqsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


indexId
String indexId

 The index that contains the FAQ lists.
 


nextToken
String nextToken

 If the result of the previous request to ListFaqs was truncated, include the NextToken
 to fetch the next set of FAQs.
 


maxResults
Integer maxResults

 The maximum number of FAQs to return in the response. If there are fewer results in the list, this response
 contains only the actual results.
 








Class com.amazonaws.services.kendra.model.ListFaqsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 The ListFaqs operation returns a page of FAQs at a time. The maximum size of the page is set by the
 MaxResults parameter. If there are more jobs in the list than the page size, Amazon Kendra returns
 the NextPage token. Include the token in the next request to the ListFaqs operation to
 return the next page of FAQs.
 


faqSummaryItems
List<E> faqSummaryItems

 information about the FAQs associated with the specified index.
 








Class com.amazonaws.services.kendra.model.ListIndicesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a
 pagination token in the response. You can use this pagination token to retrieve the next set of indexes (
 DataSourceSummaryItems).
 


maxResults
Integer maxResults

 The maximum number of data sources to return.
 








Class com.amazonaws.services.kendra.model.ListIndicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


indexConfigurationSummaryItems
List<E> indexConfigurationSummaryItems

 An array of summary information for one or more indexes.
 


nextToken
String nextToken

 If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to
 retrieve the next set of indexes.
 








Class com.amazonaws.services.kendra.model.Principal extends Object implements Serializable


Serialized Fields


name
String name

 The name of the user or group.
 


type
String type

 The type of principal.
 


access
String access

 Whether to allow or deny access to the principal.
 








Class com.amazonaws.services.kendra.model.QueryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


indexId
String indexId

 The unique identifier of the index to search. The identifier is returned in the response from the operation.
 


queryText
String queryText

 The text to search for.
 


attributeFilter
AttributeFilter attributeFilter

 Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the
 AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of
 other filters.
 
 
 The AttributeFilter parameter enables you to create a set of filtering rules that a document must
 satisfy to be included in the query results.
 


facets
List<E> facets

 An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use
 this information to help narrow the search for your user.
 


requestedDocumentAttributes
List<E> requestedDocumentAttributes

 An array of document attributes to include in the response. No other document attributes are included in the
 response. By default all document attributes are included in the response.
 


queryResultTypeFilter
String queryResultTypeFilter

 Sets the type of query. Only results for the specified query type are returned.
 


pageNumber
Integer pageNumber

 Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra
 returns the first page of results. Use this parameter to get result pages after the first one.
 


pageSize
Integer pageSize

 Sets the number of results that are returned in each page of results. The default page size is 100.
 








Class com.amazonaws.services.kendra.model.QueryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


queryId
String queryId

 The unique identifier for the search. You use QueryId to identify the search when using the feedback
 API.
 


resultItems
List<E> resultItems

 The results of the search.
 


facetResults
List<E> facetResults

 Contains the facet results. A FacetResult contains the counts for each attribute key that was
 specified in the Facets input parameter.
 


totalNumberOfResults
Integer totalNumberOfResults

 The number of items returned by the search. Use this to determine when you have requested the last set of
 results.
 








Class com.amazonaws.services.kendra.model.QueryResultItem extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier for the query result.
 


type
String type

 The type of document.
 


additionalAttributes
List<E> additionalAttributes



documentId
String documentId

 The unique identifier for the document.
 


documentTitle
TextWithHighlights documentTitle

 The title of the document. Contains the text of the title and information for highlighting the relevant terms in
 the title.
 


documentExcerpt
TextWithHighlights documentExcerpt

 An extract of the text in the document. Contains information about highlighting the relevant terms in the
 excerpt.
 


documentURI
String documentURI

 The URI of the original location of the document.
 


documentAttributes
List<E> documentAttributes

 An array of document attributes for the document that the query result maps to. For example, the document author
 (Author) or the source URI (SourceUri) of the document.
 








Class com.amazonaws.services.kendra.model.Relevance extends Object implements Serializable


Serialized Fields


freshness
Boolean freshness

 Indicates that this field determines how "fresh" a document is. For example, if document 1 was created on
 November 5, and document 2 was created on October 31, document 1 is "fresher" than document 2. You can only set
 the Freshness field on one DATE type field. Only applies to DATE fields.
 


importance
Integer importance

 The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
 


duration
String duration

 Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the
 field value within the last month, you would use "2628000s". Once the field value is beyond the specified range,
 the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't
 specify a value, the default is 3 months. The value of the field is a numeric string followed by the character
 "s", for example "86400s" for one day, or "604800s" for one week.
 
 
 Only applies to DATE fields.
 


rankOrder
String rankOrder

 Determines how values should be interpreted.
 
 
 When the RankOrder field is ASCENDING, higher numbers are better. For example, a
 document with a rating score of 10 is higher ranking than a document with a rating score of 1.
 
 
 When the RankOrder field is DESCENDING, lower numbers are better. For example, in a
 task tracking application, a priority 1 task is more important than a priority 5 task.
 
 
 Only applies to LONG and DOUBLE fields.
 


valueImportanceMap
Map<K,V> valueImportanceMap

 A list of values that should be given a different boost when they appear in the result list. For example, if you
 are boosting a field called "department," query terms that match the department field are boosted in the result.
 However, you can add entries from the department field to boost documents with those values higher.
 
 
 For example, you can add entries to the map with names of departments. If you add "HR",5 and "Legal",3 those
 departments are given special attention when they appear in the metadata of a document. When those terms appear
 they are given the specified importance instead of the regular importance for the boost.
 








Class com.amazonaws.services.kendra.model.RelevanceFeedback extends Object implements Serializable


Serialized Fields


resultId
String resultId

 The unique identifier of the search result that the user provided relevance feedback for.
 


relevanceValue
String relevanceValue

 Whether to document was relevant or not relevant to the search.
 








Class com.amazonaws.services.kendra.model.ResourceAlreadyExistException extends AWSkendraException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kendra.model.ResourceInUseException extends AWSkendraException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kendra.model.ResourceNotFoundException extends AWSkendraException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kendra.model.ResourceUnavailableException extends AWSkendraException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kendra.model.S3DataSourceConfiguration extends Object implements Serializable


Serialized Fields


bucketName
String bucketName

 The name of the bucket that contains the documents.
 


inclusionPrefixes
List<E> inclusionPrefixes

 A list of S3 prefixes for the documents that should be included in the index.
 


exclusionPatterns
List<E> exclusionPatterns

 A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix
 also matches an exclusion pattern, the document is not indexed.
 
 
 For more information about glob patterns, see glob
 (programming) in Wikipedia.
 


documentsMetadataConfiguration
DocumentsMetadataConfiguration documentsMetadataConfiguration


accessControlListConfiguration
AccessControlListConfiguration accessControlListConfiguration

 Provides the path to the S3 bucket that contains the user context filtering files for the data source.
 








Class com.amazonaws.services.kendra.model.S3Path extends Object implements Serializable


Serialized Fields


bucket
String bucket

 The name of the S3 bucket that contains the file.
 


key
String key

 The name of the file.
 








Class com.amazonaws.services.kendra.model.Search extends Object implements Serializable


Serialized Fields


facetable
Boolean facetable

 Indicates that the field can be used to create search facets, a count of results for each value in the field. The
 default is false .
 


searchable
Boolean searchable

 Determines whether the field is used in the search. If the Searchable field is true,
 you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is
 true for string fields and false for number and date fields.
 


displayable
Boolean displayable

 Determines whether the field is returned in the query response. The default is true.
 








Class com.amazonaws.services.kendra.model.ServerSideEncryptionConfiguration extends Object implements Serializable


Serialized Fields


kmsKeyId
String kmsKeyId

 The identifier of the AWS KMS customer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.
 








Class com.amazonaws.services.kendra.model.ServiceQuotaExceededException extends AWSkendraException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kendra.model.SharePointConfiguration extends Object implements Serializable


Serialized Fields


sharePointVersion
String sharePointVersion

 The version of Microsoft SharePoint that you are using as a data source.
 


urls
List<E> urls

 The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
 


secretArn
String secretArn

 The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a
 user/password pair. For more information, see Using a Microsoft SharePoint Data
 Source. For more information about AWS Secrets Manager, see  What Is AWS Secrets Manager 
 in the AWS Secrets Manager user guide.
 


crawlAttachments
Boolean crawlAttachments

 TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index;
 otherwise, FALSE.
 


vpcConfiguration
DataSourceVpcConfiguration vpcConfiguration


fieldMappings
List<E> fieldMappings

 A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom
 fields in the Amazon Kendra index. You must first create the index fields using the operation before you map
 SharePoint attributes. For more information, see Mapping Data Source Fields.
 


documentTitleFieldName
String documentTitleFieldName

 The Microsoft SharePoint attribute field that contains the title of the document.
 








Class com.amazonaws.services.kendra.model.StartDataSourceSyncJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the data source to synchronize.
 


indexId
String indexId

 The identifier of the index that contains the data source.
 








Class com.amazonaws.services.kendra.model.StartDataSourceSyncJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


executionId
String executionId

 Identifies a particular synchronization job.
 








Class com.amazonaws.services.kendra.model.StopDataSourceSyncJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the data source for which to stop the synchronization jobs.
 


indexId
String indexId

 The identifier of the index that contains the data source.
 








Class com.amazonaws.services.kendra.model.StopDataSourceSyncJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kendra.model.SubmitFeedbackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


indexId
String indexId

 The identifier of the index that was queried.
 


queryId
String queryId

 The identifier of the specific query for which you are submitting feedback. The query ID is returned in the
 response to the operation.
 


clickFeedbackItems
List<E> clickFeedbackItems

 Tells Amazon Kendra that a particular search result link was chosen by the user.
 


relevanceFeedbackItems
List<E> relevanceFeedbackItems

 Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the
 search.
 








Class com.amazonaws.services.kendra.model.SubmitFeedbackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kendra.model.TextDocumentStatistics extends Object implements Serializable


Serialized Fields


indexedTextDocumentsCount
Integer indexedTextDocumentsCount

 The number of text documents indexed.
 








Class com.amazonaws.services.kendra.model.TextWithHighlights extends Object implements Serializable


Serialized Fields


text
String text

 The text to display to the user.
 


highlights
List<E> highlights

 The beginning and end of the text that should be highlighted.
 








Class com.amazonaws.services.kendra.model.ThrottlingException extends AWSkendraException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kendra.model.TimeRange extends Object implements Serializable


Serialized Fields


startTime
Date startTime

 The UNIX datetime of the beginning of the time range.
 


endTime
Date endTime

 The UNIX datetime of the end of the time range.
 








Class com.amazonaws.services.kendra.model.UpdateDataSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The unique identifier of the data source to update.
 


name
String name

 The name of the data source to update. The name of the data source can't be updated. To rename a data source you
 must delete the data source and re-create it.
 


indexId
String indexId

 The identifier of the index that contains the data source to update.
 


configuration
DataSourceConfiguration configuration


description
String description

 The new description for the data source.
 


schedule
String schedule

 The new update schedule for the data source.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the new role to use when the data source is accessing resources on your behalf.
 








Class com.amazonaws.services.kendra.model.UpdateDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kendra.model.UpdateIndexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id

 The identifier of the index to update.
 


name
String name

 The name of the index to update.
 


roleArn
String roleArn

 A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.
 


description
String description

 A new description for the index.
 


documentMetadataConfigurationUpdates
List<E> documentMetadataConfigurationUpdates

 The document metadata to update.
 








Class com.amazonaws.services.kendra.model.UpdateIndexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kendra.model.ValidationException extends AWSkendraException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.kinesis.model




Class com.amazonaws.services.kinesis.model.AddTagsToStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream.
 


tags
SdkInternalMap<K,V> tags

 A set of up to 10 key-value pairs to use to create the tags.
 








Class com.amazonaws.services.kinesis.model.AddTagsToStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesis.model.AmazonKinesisException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.Consumer extends Object implements Serializable


Serialized Fields


consumerName
String consumerName

 The name of the consumer is something you choose when you register the consumer.
 


consumerARN
String consumerARN

 When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call
 SubscribeToShard.
 
 
 If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because
 consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that
 reference consumer ARNs.
 


consumerStatus
String consumerStatus

 A consumer can't read data while in the CREATING or DELETING states.
 


consumerCreationTimestamp
Date consumerCreationTimestamp









Class com.amazonaws.services.kinesis.model.ConsumerDescription extends Object implements Serializable


Serialized Fields


consumerName
String consumerName

 The name of the consumer is something you choose when you register the consumer.
 


consumerARN
String consumerARN

 When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call
 SubscribeToShard.
 
 
 If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because
 consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that
 reference consumer ARNs.
 


consumerStatus
String consumerStatus

 A consumer can't read data while in the CREATING or DELETING states.
 


consumerCreationTimestamp
Date consumerCreationTimestamp



streamARN
String streamARN

 The ARN of the stream with which you registered the consumer.
 








Class com.amazonaws.services.kinesis.model.CreateStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates
 the stream. It is also scoped by AWS Region. That is, two streams in two different AWS accounts can have the same
 name. Two streams in the same AWS account but in two different Regions can also have the same name.
 


shardCount
Integer shardCount

 The number of shards that the stream will use. The throughput of the stream is a function of the number of
 shards; more shards are required for greater provisioned throughput.
 
 
 DefaultShardLimit;
 








Class com.amazonaws.services.kinesis.model.CreateStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesis.model.DecreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream to modify.
 


retentionPeriodHours
Integer retentionPeriodHours

 The new retention period of the stream, in hours. Must be less than the current retention period.
 








Class com.amazonaws.services.kinesis.model.DecreaseStreamRetentionPeriodResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesis.model.DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream to delete.
 


enforceConsumerDeletion
Boolean enforceConsumerDeletion

 If this parameter is unset (null) or if you set it to false, and the stream has
 registered consumers, the call to DeleteStream fails with a ResourceInUseException.
 








Class com.amazonaws.services.kinesis.model.DeleteStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesis.model.DeregisterStreamConsumerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamARN
String streamARN

 The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
 


consumerName
String consumerName

 The name that you gave to the consumer.
 


consumerARN
String consumerARN

 The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the
 consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the
 descriptions of all the consumers that are currently registered with a given data stream. The description of a
 consumer contains its ARN.
 








Class com.amazonaws.services.kinesis.model.DeregisterStreamConsumerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesis.model.DescribeLimitsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.kinesis.model.DescribeLimitsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


shardLimit
Integer shardLimit

 The maximum number of shards.
 


openShardCount
Integer openShardCount

 The number of open shards.
 








Class com.amazonaws.services.kinesis.model.DescribeStreamConsumerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamARN
String streamARN

 The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
 


consumerName
String consumerName

 The name that you gave to the consumer.
 


consumerARN
String consumerARN

 The ARN returned by Kinesis Data Streams when you registered the consumer.
 








Class com.amazonaws.services.kinesis.model.DescribeStreamConsumerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


consumerDescription
ConsumerDescription consumerDescription

 An object that represents the details of the consumer.
 








Class com.amazonaws.services.kinesis.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream to describe.
 


limit
Integer limit

 The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater
 than 100, at most 100 shards are returned.
 


exclusiveStartShardId
String exclusiveStartShardId

 The shard ID of the shard to start with.
 








Class com.amazonaws.services.kinesis.model.DescribeStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamDescription
StreamDescription streamDescription

 The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise
 the stream, and whether there are more shards available.
 








Class com.amazonaws.services.kinesis.model.DescribeStreamSummaryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream to describe.
 








Class com.amazonaws.services.kinesis.model.DescribeStreamSummaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamDescriptionSummary
StreamDescriptionSummary streamDescriptionSummary

 A StreamDescriptionSummary containing information about the stream.
 








Class com.amazonaws.services.kinesis.model.DisableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the Kinesis data stream for which to disable enhanced monitoring.
 


shardLevelMetrics
SdkInternalList<T> shardLevelMetrics

 List of shard-level metrics to disable.
 
 
 The following are the valid shard-level metrics. The value "ALL" disables every metric.
 
 
 
 
 IncomingBytes
 
 
 
 
 IncomingRecords
 
 
 
 
 OutgoingBytes
 
 
 
 
 OutgoingRecords
 
 
 
 
 WriteProvisionedThroughputExceeded
 
 
 
 
 ReadProvisionedThroughputExceeded
 
 
 
 
 IteratorAgeMilliseconds
 
 
 
 
 ALL
 
 
 
 
 For more information, see Monitoring the Amazon
 Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer
 Guide.
 








Class com.amazonaws.services.kinesis.model.DisableEnhancedMonitoringResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamName
String streamName

 The name of the Kinesis data stream.
 


currentShardLevelMetrics
SdkInternalList<T> currentShardLevelMetrics

 Represents the current state of the metrics that are in the enhanced state before the operation.
 


desiredShardLevelMetrics
SdkInternalList<T> desiredShardLevelMetrics

 Represents the list of all the metrics that would be in the enhanced state after the operation.
 








Class com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream for which to enable enhanced monitoring.
 


shardLevelMetrics
SdkInternalList<T> shardLevelMetrics

 List of shard-level metrics to enable.
 
 
 The following are the valid shard-level metrics. The value "ALL" enables every metric.
 
 
 
 
 IncomingBytes
 
 
 
 
 IncomingRecords
 
 
 
 
 OutgoingBytes
 
 
 
 
 OutgoingRecords
 
 
 
 
 WriteProvisionedThroughputExceeded
 
 
 
 
 ReadProvisionedThroughputExceeded
 
 
 
 
 IteratorAgeMilliseconds
 
 
 
 
 ALL
 
 
 
 
 For more information, see Monitoring the Amazon
 Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer
 Guide.
 








Class com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamName
String streamName

 The name of the Kinesis data stream.
 


currentShardLevelMetrics
SdkInternalList<T> currentShardLevelMetrics

 Represents the current state of the metrics that are in the enhanced state before the operation.
 


desiredShardLevelMetrics
SdkInternalList<T> desiredShardLevelMetrics

 Represents the list of all the metrics that would be in the enhanced state after the operation.
 








Class com.amazonaws.services.kinesis.model.EnhancedMetrics extends Object implements Serializable


Serialized Fields


shardLevelMetrics
SdkInternalList<T> shardLevelMetrics

 List of shard-level metrics.
 
 
 The following are the valid shard-level metrics. The value "ALL" enhances every metric.
 
 
 
 
 IncomingBytes
 
 
 
 
 IncomingRecords
 
 
 
 
 OutgoingBytes
 
 
 
 
 OutgoingRecords
 
 
 
 
 WriteProvisionedThroughputExceeded
 
 
 
 
 ReadProvisionedThroughputExceeded
 
 
 
 
 IteratorAgeMilliseconds
 
 
 
 
 ALL
 
 
 
 
 For more information, see Monitoring the Amazon
 Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer
 Guide.
 








Class com.amazonaws.services.kinesis.model.ExpiredIteratorException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.ExpiredNextTokenException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.GetRecordsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


shardIterator
String shardIterator

 The position in the shard from which you want to start sequentially reading data records. A shard iterator
 specifies this position using the sequence number of a data record in the shard.
 


limit
Integer limit

 The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater
 than 10,000, GetRecords throws InvalidArgumentException.
 








Class com.amazonaws.services.kinesis.model.GetRecordsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


records
SdkInternalList<T> records

 The data records retrieved from the shard.
 


nextShardIterator
String nextShardIterator

 The next position in the shard from which to start sequentially reading data records. If set to null
 , the shard has been closed and the requested iterator does not return any more data.
 


millisBehindLatest
Long millisBehindLatest

 The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far
 behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are
 no new records to process at this moment.
 








Class com.amazonaws.services.kinesis.model.GetShardIteratorRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the Amazon Kinesis data stream.
 


shardId
String shardId

 The shard ID of the Kinesis Data Streams 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 time stamp, provided in the value
 Timestamp.
 
 
 
 
 TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data
 record in the shard.
 
 
 
 
 LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent
 data in the shard.
 
 
 


startingSequenceNumber
String startingSequenceNumber

 The sequence number of the data record in the shard from which to start reading. Used with shard iterator type
 AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.
 


timestamp
Date timestamp

 The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time
 stamp 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 time stamp
 does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current
 trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).
 








Class com.amazonaws.services.kinesis.model.GetShardIteratorResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


shardIterator
String shardIterator

 The position in the shard from which to start reading data records sequentially. A shard iterator specifies this
 position using the sequence number of a data record in a shard.
 








Class com.amazonaws.services.kinesis.model.HashKeyRange extends Object implements Serializable


Serialized Fields


startingHashKey
String startingHashKey

 The starting hash key of the hash key range.
 


endingHashKey
String endingHashKey

 The ending hash key of the hash key range.
 








Class com.amazonaws.services.kinesis.model.IncreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream to modify.
 


retentionPeriodHours
Integer retentionPeriodHours

 The new retention period of the stream, in hours. Must be more than the current retention period.
 








Class com.amazonaws.services.kinesis.model.IncreaseStreamRetentionPeriodResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesis.model.InvalidArgumentException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.KMSAccessDeniedException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.KMSDisabledException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.KMSInvalidStateException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.KMSNotFoundException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.KMSOptInRequiredException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.KMSThrottlingException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.LimitExceededException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.ListShardsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the data stream whose shards you want to list.
 
 
 You cannot specify this parameter if you specify the NextToken parameter.
 


nextToken
String nextToken

 When the number of shards in the data stream is greater than the default value for the MaxResults
 parameter, or if you explicitly specify a value for MaxResults that is less than the number of
 shards in the data stream, the response includes a pagination token named NextToken. You can specify
 this NextToken value in a subsequent call to ListShards to list the next set of shards.
 
 
 Don't specify StreamName or StreamCreationTimestamp if you specify
 NextToken because the latter unambiguously identifies the stream.
 
 
 You can optionally specify a value for the MaxResults parameter when you specify
 NextToken. If you specify a MaxResults value that is less than the number of shards
 that the operation returns if you don't specify MaxResults, the response will contain a new
 NextToken value. You can use the new NextToken value in a subsequent call to the
 ListShards operation.
 
 
 
 Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to
 ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to
 ListShards, you get ExpiredNextTokenException.
 
 


exclusiveStartShardId
String exclusiveStartShardId

 Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately
 follows ExclusiveStartShardId.
 
 
 If you don't specify this parameter, the default behavior is for ListShards to list the shards
 starting with the first one in the stream.
 
 
 You cannot specify this parameter if you specify NextToken.
 


maxResults
Integer maxResults

 The maximum number of shards to return in a single call to ListShards. The minimum value you can
 specify for this parameter is 1, and the maximum is 1,000, which is also the default.
 
 
 When the number of shards to be listed is greater than the value of MaxResults, the response
 contains a NextToken value that you can use in a subsequent call to ListShards to list
 the next set of shards.
 


streamCreationTimestamp
Date streamCreationTimestamp

 Specify this input parameter to distinguish data streams that have the same name. For example, if you create a
 data stream and then delete it, and you later create another data stream with the same name, you can use this
 input parameter to specify which of the two streams you want to list the shards for.
 
 
 You cannot specify this parameter if you specify the NextToken parameter.
 








Class com.amazonaws.services.kinesis.model.ListShardsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


shards
SdkInternalList<T> shards

 An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's
 parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending
 hash keys and the starting and ending sequence numbers for the shard.
 


nextToken
String nextToken

 When the number of shards in the data stream is greater than the default value for the MaxResults
 parameter, or if you explicitly specify a value for MaxResults that is less than the number of
 shards in the data stream, the response includes a pagination token named NextToken. You can specify
 this NextToken value in a subsequent call to ListShards to list the next set of shards.
 For more information about the use of this pagination token when calling the ListShards operation,
 see ListShardsInput$NextToken.
 
 
 
 Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to
 ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to
 ListShards, you get ExpiredNextTokenException.
 
 








Class com.amazonaws.services.kinesis.model.ListStreamConsumersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamARN
String streamARN

 The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see
 
 Amazon Resource Names (ARNs) and AWS Service Namespaces.
 


nextToken
String nextToken

 When the number of consumers that are registered with the data stream is greater than the default value for the
 MaxResults parameter, or if you explicitly specify a value for MaxResults that is less
 than the number of consumers that are registered with the data stream, the response includes a pagination token
 named NextToken. You can specify this NextToken value in a subsequent call to
 ListStreamConsumers to list the next set of registered consumers.
 
 
 Don't specify StreamName or StreamCreationTimestamp if you specify
 NextToken because the latter unambiguously identifies the stream.
 
 
 You can optionally specify a value for the MaxResults parameter when you specify
 NextToken. If you specify a MaxResults value that is less than the number of consumers
 that the operation returns if you don't specify MaxResults, the response will contain a new
 NextToken value. You can use the new NextToken value in a subsequent call to the
 ListStreamConsumers operation to list the next set of consumers.
 
 
 
 Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to
 ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a
 call to ListStreamConsumers, you get ExpiredNextTokenException.
 
 


maxResults
Integer maxResults

 The maximum number of consumers that you want a single call of ListStreamConsumers to return.
 


streamCreationTimestamp
Date streamCreationTimestamp

 Specify this input parameter to distinguish data streams that have the same name. For example, if you create a
 data stream and then delete it, and you later create another data stream with the same name, you can use this
 input parameter to specify which of the two streams you want to list the consumers for.
 
 
 You can't specify this parameter if you specify the NextToken parameter.
 








Class com.amazonaws.services.kinesis.model.ListStreamConsumersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


consumers
SdkInternalList<T> consumers

 An array of JSON objects. Each object represents one registered consumer.
 


nextToken
String nextToken

 When the number of consumers that are registered with the data stream is greater than the default value for the
 MaxResults parameter, or if you explicitly specify a value for MaxResults that is less
 than the number of registered consumers, the response includes a pagination token named NextToken.
 You can specify this NextToken value in a subsequent call to ListStreamConsumers to
 list the next set of registered consumers. For more information about the use of this pagination token when
 calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.
 
 
 
 Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to
 ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a
 call to ListStreamConsumers, you get ExpiredNextTokenException.
 
 








Class com.amazonaws.services.kinesis.model.ListStreamsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


limit
Integer limit

 The maximum number of streams to list.
 


exclusiveStartStreamName
String exclusiveStartStreamName

 The name of the stream to start the list with.
 








Class com.amazonaws.services.kinesis.model.ListStreamsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamNames
SdkInternalList<T> streamNames

 The names of the streams that are associated with the AWS account making the ListStreams request.
 


hasMoreStreams
Boolean hasMoreStreams

 If set to true, there are more streams available to list.
 








Class com.amazonaws.services.kinesis.model.ListTagsForStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream.
 


exclusiveStartTagKey
String exclusiveStartTagKey

 The key to use as the starting point for the list of tags. If this parameter is set,
 ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.
 


limit
Integer limit

 The number of tags to return. If this number is less than the total number of tags associated with the stream,
 HasMoreTags is set to true. To list additional tags, set
 ExclusiveStartTagKey to the last key in the response.
 








Class com.amazonaws.services.kinesis.model.ListTagsForStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 A list of tags associated with StreamName, starting with the first tag after
 ExclusiveStartTagKey and up to the specified Limit.
 


hasMoreTags
Boolean hasMoreTags

 If set to true, more tags are available. To request additional tags, set
 ExclusiveStartTagKey to the key of the last tag returned.
 








Class com.amazonaws.services.kinesis.model.MergeShardsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream for the merge.
 


shardToMerge
String shardToMerge

 The shard ID of the shard to combine with the adjacent shard for the merge.
 


adjacentShardToMerge
String adjacentShardToMerge

 The shard ID of the adjacent shard for the merge.
 








Class com.amazonaws.services.kinesis.model.MergeShardsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesis.model.ProvisionedThroughputExceededException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.PutRecordRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream to put the data record into.
 


data
ByteBuffer data

 The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob
 (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the
 maximum record size (1 MB).
 


partitionKey
String partitionKey

 Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a
 maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input
 to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash
 function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As
 a result of this hashing mechanism, all data records with the same partition key map to the same shard within the
 stream.
 


explicitHashKey
String explicitHashKey

 The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition
 key hash.
 


sequenceNumberForOrdering
String sequenceNumberForOrdering

 Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key.
 Usage: set the SequenceNumberForOrdering of record n to the sequence number of record
 n-1 (as returned in the result when putting record n-1). If this parameter is not set, records are
 coarsely ordered based on arrival time.
 








Class com.amazonaws.services.kinesis.model.PutRecordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


shardId
String shardId

 The shard ID of the shard where the data record was placed.
 


sequenceNumber
String sequenceNumber

 The sequence number identifier that was assigned to the put data record. The sequence number for the record is
 unique across all records in the stream. A sequence number is the identifier associated with every record put
 into the stream.
 


encryptionType
String encryptionType

 The encryption type to use on the record. This parameter can be one of the following values:
 
 
 
 
 NONE: Do not encrypt the records in the stream.
 
 
 
 
 KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.
 
 
 








Class com.amazonaws.services.kinesis.model.PutRecordsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


records
SdkInternalList<T> records

 The records associated with the request.
 


streamName
String streamName

 The stream name associated with the request.
 








Class com.amazonaws.services.kinesis.model.PutRecordsRequestEntry extends Object implements Serializable


Serialized Fields


data
ByteBuffer data

 The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob
 (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the
 maximum record size (1 MB).
 


explicitHashKey
String explicitHashKey

 The hash value used to determine explicitly the shard that the data record is assigned to by overriding the
 partition key hash.
 


partitionKey
String partitionKey

 Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a
 maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input
 to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash
 function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As
 a result of this hashing mechanism, all data records with the same partition key map to the same shard within the
 stream.
 








Class com.amazonaws.services.kinesis.model.PutRecordsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedRecordCount
Integer failedRecordCount

 The number of unsuccessfully processed records in a PutRecords request.
 


records
SdkInternalList<T> records

 An array of successfully and unsuccessfully processed record results, correlated with the request by natural
 ordering. A record that is successfully added to a stream includes SequenceNumber and
 ShardId in the result. A record that fails to be added to a stream includes ErrorCode
 and ErrorMessage in the result.
 


encryptionType
String encryptionType

 The encryption type used on the records. This parameter can be one of the following values:
 
 
 
 
 NONE: Do not encrypt the records.
 
 
 
 
 KMS: Use server-side encryption on the records using a customer-managed AWS KMS key.
 
 
 








Class com.amazonaws.services.kinesis.model.PutRecordsResultEntry extends Object implements Serializable


Serialized Fields


sequenceNumber
String sequenceNumber

 The sequence number for an individual record result.
 


shardId
String shardId

 The shard ID for an individual record result.
 


errorCode
String errorCode

 The error code for an individual record result. ErrorCodes can be either
 ProvisionedThroughputExceededException or InternalFailure.
 


errorMessage
String errorMessage

 The error message for an individual record result. An ErrorCode value of
 ProvisionedThroughputExceededException has an error message that includes the account ID, stream
 name, and shard ID. An ErrorCode value of InternalFailure has the error message
 "Internal Service Failure".
 








Class com.amazonaws.services.kinesis.model.Record extends Object implements Serializable


Serialized Fields


sequenceNumber
String sequenceNumber

 The unique identifier of the record within its shard.
 


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 Kinesis Data Streams, 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.
 


encryptionType
String encryptionType

 The encryption type used on the record. This parameter can be one of the following values:
 
 
 
 
 NONE: Do not encrypt the records in the stream.
 
 
 
 
 KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.
 
 
 








Class com.amazonaws.services.kinesis.model.RegisterStreamConsumerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamARN
String streamARN

 The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
 


consumerName
String consumerName

 For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be
 unique across data streams.
 








Class com.amazonaws.services.kinesis.model.RegisterStreamConsumerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


consumer
Consumer consumer

 An object that represents the details of the consumer you registered. When you register a consumer, it gets an
 ARN that is generated by Kinesis Data Streams.
 








Class com.amazonaws.services.kinesis.model.RemoveTagsFromStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream.
 


tagKeys
SdkInternalList<T> tagKeys

 A list of tag keys. Each corresponding tag is removed from the stream.
 








Class com.amazonaws.services.kinesis.model.RemoveTagsFromStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesis.model.ResourceInUseException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.ResourceNotFoundException extends AmazonKinesisException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.SequenceNumberRange extends Object implements Serializable


Serialized Fields


startingSequenceNumber
String startingSequenceNumber

 The starting sequence number for the range.
 


endingSequenceNumber
String endingSequenceNumber

 The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of
 null.
 








Class com.amazonaws.services.kinesis.model.Shard extends Object implements Serializable


Serialized Fields


shardId
String shardId

 The unique identifier of the shard within the stream.
 


parentShardId
String parentShardId

 The shard ID of the shard's parent.
 


adjacentParentShardId
String adjacentParentShardId

 The shard ID of the shard adjacent to the shard's parent.
 


hashKeyRange
HashKeyRange hashKeyRange

 The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.
 


sequenceNumberRange
SequenceNumberRange sequenceNumberRange

 The range of possible sequence numbers for the shard.
 








Class com.amazonaws.services.kinesis.model.SplitShardRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream for the shard split.
 


shardToSplit
String shardToSplit

 The shard ID of the shard to split.
 


newStartingHashKey
String newStartingHashKey

 A hash key value for the starting hash key of one of the child shards created by the split. The hash key range
 for a given shard constitutes a set of ordered contiguous positive integers. The value for
 NewStartingHashKey must be in the range of hash keys being mapped into the shard. The
 NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed
 to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.
 








Class com.amazonaws.services.kinesis.model.SplitShardResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesis.model.StartStreamEncryptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream for which to start encrypting records.
 


encryptionType
String encryptionType

 The encryption type to use. The only valid value is KMS.
 


keyId
String keyId

 The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique
 identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed
 by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias
 aws/kinesis.
 
 
 
 
 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
 
 
 
 
 Master key owned by Kinesis Data Streams: alias/aws/kinesis
 
 
 








Class com.amazonaws.services.kinesis.model.StartStreamEncryptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesis.model.StopStreamEncryptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream on which to stop encrypting records.
 


encryptionType
String encryptionType

 The encryption type. The only valid value is KMS.
 


keyId
String keyId

 The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique
 identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed
 by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias
 aws/kinesis.
 
 
 
 
 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
 
 
 
 
 Master key owned by Kinesis Data Streams: alias/aws/kinesis
 
 
 








Class com.amazonaws.services.kinesis.model.StopStreamEncryptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesis.model.StreamDescription extends Object implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream being described.
 


streamARN
String streamARN

 The Amazon Resource Name (ARN) for the stream being described.
 


streamStatus
String streamStatus

 The current status of the stream being described. The stream status is one of the following states:
 
 
 
 
 CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets
 StreamStatus to CREATING.
 
 
 
 
 DELETING - The stream is being deleted. The specified stream is in the DELETING state
 until Kinesis Data Streams completes the deletion.
 
 
 
 
 ACTIVE - The stream exists and is ready for read and write operations or deletion. You should
 perform read and write operations only on an ACTIVE stream.
 
 
 
 
 UPDATING - Shards in the stream are being merged or split. Read and write operations continue to
 work while the stream is in the UPDATING state.
 
 
 


shards
SdkInternalList<T> shards

 The shards that comprise the stream.
 


hasMoreShards
Boolean hasMoreShards

 If set to true, more shards in the stream are available to describe.
 


retentionPeriodHours
Integer retentionPeriodHours

 The current retention period, in hours.
 


streamCreationTimestamp
Date streamCreationTimestamp

 The approximate time that the stream was created.
 


enhancedMonitoring
SdkInternalList<T> enhancedMonitoring

 Represents the current enhanced monitoring settings of the stream.
 


encryptionType
String encryptionType

 The server-side encryption type used on the stream. This parameter can be one of the following values:
 
 
 
 
 NONE: Do not encrypt the records in the stream.
 
 
 
 
 KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.
 
 
 


keyId
String keyId

 The GUID for the customer-managed AWS KMS key to use for encryption. 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/".You can also
 use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
 
 
 
 
 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
 
 
 
 
 Master key owned by Kinesis Data Streams: alias/aws/kinesis
 
 
 








Class com.amazonaws.services.kinesis.model.StreamDescriptionSummary extends Object implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream being described.
 


streamARN
String streamARN

 The Amazon Resource Name (ARN) for the stream being described.
 


streamStatus
String streamStatus

 The current status of the stream being described. The stream status is one of the following states:
 
 
 
 
 CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets
 StreamStatus to CREATING.
 
 
 
 
 DELETING - The stream is being deleted. The specified stream is in the DELETING state
 until Kinesis Data Streams 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.
 
 
 


retentionPeriodHours
Integer retentionPeriodHours

 The current retention period, in hours.
 


streamCreationTimestamp
Date streamCreationTimestamp

 The approximate time that the stream was created.
 


enhancedMonitoring
SdkInternalList<T> enhancedMonitoring

 Represents the current enhanced monitoring settings of the stream.
 


encryptionType
String encryptionType

 The encryption type used. This value is one of the following:
 
 
 
 
 KMS
 
 
 
 
 NONE
 
 
 


keyId
String keyId

 The GUID for the customer-managed AWS KMS key to use for encryption. 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/".You can also
 use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
 
 
 
 
 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
 
 
 
 
 Master key owned by Kinesis Data Streams: alias/aws/kinesis
 
 
 


openShardCount
Integer openShardCount

 The number of open shards in the stream.
 


consumerCount
Integer consumerCount

 The number of enhanced fan-out consumers registered with the stream.
 








Class com.amazonaws.services.kinesis.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white
 space, _ . / = + - % @
 


value
String value

 An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid
 characters: Unicode letters, digits, white space, _ . / = + - % @
 








Class com.amazonaws.services.kinesis.model.UpdateShardCountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream.
 


targetShardCount
Integer targetShardCount

 The new number of shards.
 


scalingType
String scalingType

 The scaling type. Uniform scaling creates shards of equal size.
 








Class com.amazonaws.services.kinesis.model.UpdateShardCountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream.
 


currentShardCount
Integer currentShardCount

 The current number of shards.
 


targetShardCount
Integer targetShardCount

 The updated number of shards.
 








Package com.amazonaws.services.kinesisanalytics.model




Class com.amazonaws.services.kinesisanalytics.model.AddApplicationCloudWatchLoggingOptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The Kinesis Analytics application name.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The version ID of the Kinesis Analytics application.
 


cloudWatchLoggingOption
CloudWatchLoggingOption cloudWatchLoggingOption

 Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN. Note: To write application
 messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled.
 








Class com.amazonaws.services.kinesisanalytics.model.AddApplicationCloudWatchLoggingOptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.AddApplicationInputProcessingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of the application to which you want to add the input processing configuration.
 


currentApplicationVersionId
Long currentApplicationVersionId

 Version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the
 current version, the ConcurrentModificationException is returned.
 


inputId
String inputId

 The ID of the input configuration to add the input processing configuration to. You can get a list of the input
 IDs for an application using the DescribeApplication operation.
 


inputProcessingConfiguration
InputProcessingConfiguration inputProcessingConfiguration

 The 
 InputProcessingConfiguration to add to the application.
 








Class com.amazonaws.services.kinesisanalytics.model.AddApplicationInputProcessingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.AddApplicationInputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.
 


currentApplicationVersionId
Long currentApplicationVersionId

 Current version of your Amazon Kinesis Analytics application. You can use the DescribeApplication operation to find the current application version.
 


input
Input input

 The Input to add.
 








Class com.amazonaws.services.kinesisanalytics.model.AddApplicationInputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.AddApplicationOutputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of the application to which you want to add the output configuration.
 


currentApplicationVersionId
Long currentApplicationVersionId

 Version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the
 current version, the ConcurrentModificationException is returned.
 


output
Output output

 An array of objects, each describing one output configuration. In the output configuration, you specify the name
 of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose
 delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.
 








Class com.amazonaws.services.kinesisanalytics.model.AddApplicationOutputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.AddApplicationReferenceDataSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of an existing application.
 


currentApplicationVersionId
Long currentApplicationVersionId

 Version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the
 current version, the ConcurrentModificationException is returned.
 


referenceDataSource
ReferenceDataSource referenceDataSource

 The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object
 and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and
 the resulting in-application table that is created. You must also provide an IAM role with the necessary
 permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.
 








Class com.amazonaws.services.kinesisanalytics.model.AddApplicationReferenceDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.AmazonKinesisAnalyticsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalytics.model.ApplicationDetail extends Object implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of the application.
 


applicationDescription
String applicationDescription

 Description of the application.
 


applicationARN
String applicationARN

 ARN of the application.
 


applicationStatus
String applicationStatus

 Status of the application.
 


createTimestamp
Date createTimestamp

 Time stamp when the application version was created.
 


lastUpdateTimestamp
Date lastUpdateTimestamp

 Time stamp when the application was last updated.
 


inputDescriptions
List<E> inputDescriptions

 Describes the application input configuration. For more information, see Configuring Application
 Input.
 


outputDescriptions
List<E> outputDescriptions

 Describes the application output configuration. For more information, see Configuring Application
 Output.
 


referenceDataSourceDescriptions
List<E> referenceDataSourceDescriptions

 Describes reference data sources configured for the application. For more information, see Configuring Application
 Input.
 


cloudWatchLoggingOptionDescriptions
List<E> cloudWatchLoggingOptionDescriptions

 Describes the CloudWatch log streams that are configured to receive application messages. For more information
 about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon
 CloudWatch Logs.
 


applicationCode
String applicationCode

 Returns the application code that you provided to perform data analysis on any of the in-application streams in
 your application.
 


applicationVersionId
Long applicationVersionId

 Provides the current application version.
 








Class com.amazonaws.services.kinesisanalytics.model.ApplicationSummary extends Object implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of the application.
 


applicationARN
String applicationARN

 ARN of the application.
 


applicationStatus
String applicationStatus

 Status of the application.
 








Class com.amazonaws.services.kinesisanalytics.model.ApplicationUpdate extends Object implements Serializable


Serialized Fields


inputUpdates
List<E> inputUpdates

 Describes application input configuration updates.
 


applicationCodeUpdate
String applicationCodeUpdate

 Describes application code updates.
 


outputUpdates
List<E> outputUpdates

 Describes application output configuration updates.
 


referenceDataSourceUpdates
List<E> referenceDataSourceUpdates

 Describes application reference data source updates.
 


cloudWatchLoggingOptionUpdates
List<E> cloudWatchLoggingOptionUpdates

 Describes application CloudWatch logging option updates.
 








Class com.amazonaws.services.kinesisanalytics.model.CloudWatchLoggingOption extends Object implements Serializable


Serialized Fields


logStreamARN
String logStreamARN

 ARN of the CloudWatch log to receive application messages.
 


roleARN
String roleARN

 IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the
 IAM role that is used must have the PutLogEvents policy action enabled.
 








Class com.amazonaws.services.kinesisanalytics.model.CloudWatchLoggingOptionDescription extends Object implements Serializable


Serialized Fields


cloudWatchLoggingOptionId
String cloudWatchLoggingOptionId

 ID of the CloudWatch logging option description.
 


logStreamARN
String logStreamARN

 ARN of the CloudWatch log to receive application messages.
 


roleARN
String roleARN

 IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the
 IAM role used must have the PutLogEvents policy action enabled.
 








Class com.amazonaws.services.kinesisanalytics.model.CloudWatchLoggingOptionUpdate extends Object implements Serializable


Serialized Fields


cloudWatchLoggingOptionId
String cloudWatchLoggingOptionId

 ID of the CloudWatch logging option to update
 


logStreamARNUpdate
String logStreamARNUpdate

 ARN of the CloudWatch log to receive application messages.
 


roleARNUpdate
String roleARNUpdate

 IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the
 IAM role used must have the PutLogEvents policy action enabled.
 








Class com.amazonaws.services.kinesisanalytics.model.CodeValidationException extends AmazonKinesisAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalytics.model.ConcurrentModificationException extends AmazonKinesisAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalytics.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of your Amazon Kinesis Analytics application (for example, sample-app).
 


applicationDescription
String applicationDescription

 Summary description of the application.
 


inputs
List<E> inputs

 Use this parameter to configure the application input.
 
 
 You can configure your application to receive input from a single streaming source. In this configuration, you
 map this streaming source to an in-application stream that is created. Your application code can then query the
 in-application stream like a table (you can think of it as a constantly updating table).
 
 
 For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for
 example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read
 this stream on your behalf.
 
 
 To create the in-application stream, you need to specify a schema to transform your data into a schematized
 version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming
 source to record columns in the in-app stream.
 


outputs
List<E> outputs

 You can configure application output to write data from any of the in-application streams to up to three
 destinations.
 
 
 These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda
 destinations, or any combination of the three.
 
 
 In the configuration, you specify the in-application stream name, the destination stream or Lambda function
 Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that
 Amazon Kinesis Analytics can assume to write to the destination stream or Lambda function on your behalf.
 
 
 In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations,
 you provide the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that
 Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.
 


cloudWatchLoggingOptions
List<E> cloudWatchLoggingOptions

 Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more
 information, see Working
 with Amazon CloudWatch Logs.
 


applicationCode
String applicationCode

 One or more SQL statements that read input data, transform it, and generate output. For example, you can write a
 SQL statement that reads data from one in-application stream, generates a running average of the number of
 advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more
 information about the typical pattern, see Application Code.
 
 
 You can provide such series of SQL statements, where output of one statement can be used as the input for the
 next statement. You store intermediate results by creating in-application streams and pumps.
 
 
 Note that the application code must create the streams with names specified in the Outputs. For
 example, if your Outputs defines output streams named ExampleOutputStream1 and
 ExampleOutputStream2, then your application code must create these streams.
 


tags
List<E> tags

 A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an
 application. Note that the maximum number of application tags includes system tags. The maximum number of
 user-defined application tags is 50. For more information, see Using Tagging.
 








Class com.amazonaws.services.kinesisanalytics.model.CreateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationSummary
ApplicationSummary applicationSummary

 In response to your CreateApplication request, Amazon Kinesis Analytics returns a response with a
 summary of the application it created, including the application Amazon Resource Name (ARN), name, and status.
 








Class com.amazonaws.services.kinesisanalytics.model.CSVMappingParameters extends Object implements Serializable


Serialized Fields


recordRowDelimiter
String recordRowDelimiter

 Row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.
 


recordColumnDelimiter
String recordColumnDelimiter

 Column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
 








Class com.amazonaws.services.kinesisanalytics.model.DeleteApplicationCloudWatchLoggingOptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The Kinesis Analytics application name.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The version ID of the Kinesis Analytics application.
 


cloudWatchLoggingOptionId
String cloudWatchLoggingOptionId

 The CloudWatchLoggingOptionId of the CloudWatch logging option to delete. You can get the
 CloudWatchLoggingOptionId by using the DescribeApplication operation.
 








Class com.amazonaws.services.kinesisanalytics.model.DeleteApplicationCloudWatchLoggingOptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.DeleteApplicationInputProcessingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The Kinesis Analytics application name.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The version ID of the Kinesis Analytics application.
 


inputId
String inputId

 The ID of the input configuration from which to delete the input processing configuration. You can get a list of
 the input IDs for an application by using the DescribeApplication operation.
 








Class com.amazonaws.services.kinesisanalytics.model.DeleteApplicationInputProcessingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.DeleteApplicationOutputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Amazon Kinesis Analytics application name.
 


currentApplicationVersionId
Long currentApplicationVersionId

 Amazon Kinesis Analytics application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the
 current version, the ConcurrentModificationException is returned.
 


outputId
String outputId

 The ID of the configuration to delete. Each output configuration that is added to the application, either when
 the application is created or later using the AddApplicationOutput operation, has a unique ID. You need to provide the ID to uniquely identify the output
 configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId.
 








Class com.amazonaws.services.kinesisanalytics.model.DeleteApplicationOutputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.DeleteApplicationReferenceDataSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of an existing application.
 


currentApplicationVersionId
Long currentApplicationVersionId

 Version of the application. You can use the DescribeApplication operation to get the current application version. If the version specified is not the
 current version, the ConcurrentModificationException is returned.
 


referenceId
String referenceId

 ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Amazon Kinesis Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.
 








Class com.amazonaws.services.kinesisanalytics.model.DeleteApplicationReferenceDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of the Amazon Kinesis Analytics application to delete.
 


createTimestamp
Date createTimestamp

 You can use the DescribeApplication operation to get this value.
 








Class com.amazonaws.services.kinesisanalytics.model.DeleteApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.DescribeApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of the application.
 








Class com.amazonaws.services.kinesisanalytics.model.DescribeApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationDetail
ApplicationDetail applicationDetail

 Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest
 version, and input and output configuration details.
 








Class com.amazonaws.services.kinesisanalytics.model.DestinationSchema extends Object implements Serializable


Serialized Fields


recordFormatType
String recordFormatType

 Specifies the format of the records on the output stream.
 








Class com.amazonaws.services.kinesisanalytics.model.DiscoverInputSchemaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 Amazon Resource Name (ARN) of the streaming source.
 


roleARN
String roleARN

 ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.
 


inputStartingPositionConfiguration
InputStartingPositionConfiguration inputStartingPositionConfiguration

 Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source
 discovery purposes.
 


s3Configuration
S3Configuration s3Configuration

 Specify this parameter to discover a schema from data in an Amazon S3 object.
 


inputProcessingConfiguration
InputProcessingConfiguration inputProcessingConfiguration

 The 
 InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.
 








Class com.amazonaws.services.kinesisanalytics.model.DiscoverInputSchemaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


inputSchema
SourceSchema inputSchema

 Schema inferred from the streaming source. It identifies the format of the data in the streaming source and how
 each data element maps to corresponding columns in the in-application stream that you can create.
 


parsedInputRecords
List<E> parsedInputRecords

 An array of elements, where each element corresponds to a row in a stream record (a stream record can have more
 than one row).
 


processedInputRecords
List<E> processedInputRecords

 Stream data that was modified by the processor specified in the InputProcessingConfiguration
 parameter.
 


rawInputRecords
List<E> rawInputRecords

 Raw stream data that was sampled to infer the schema.
 








Class com.amazonaws.services.kinesisanalytics.model.Input extends Object implements Serializable


Serialized Fields


namePrefix
String namePrefix

 Name prefix to use when creating an in-application stream. Suppose that you specify a prefix
 "MyInApplicationStream." Amazon Kinesis Analytics then creates one or more (as per the
 InputParallelism count you specified) in-application streams with names "MyInApplicationStream_001,"
 "MyInApplicationStream_002," and so on.
 


inputProcessingConfiguration
InputProcessingConfiguration inputProcessingConfiguration

 The 
 InputProcessingConfiguration for the input. An input processor transforms records as they are received from
 the stream, before the application's SQL code executes. Currently, the only input processing configuration
 available is 
 InputLambdaProcessor.
 


kinesisStreamsInput
KinesisStreamsInput kinesisStreamsInput

 If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an
 IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
 
 
 Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.
 


kinesisFirehoseInput
KinesisFirehoseInput kinesisFirehoseInput

 If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and
 an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
 
 
 Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.
 


inputParallelism
InputParallelism inputParallelism

 Describes the number of in-application streams to create.
 
 
 Data from your source is routed to these in-application input streams.
 
 
 (see Configuring
 Application Input.
 


inputSchema
SourceSchema inputSchema

 Describes the format of the data in the streaming source, and how each data element maps to corresponding columns
 in the in-application stream that is being created.
 
 
 Also used to describe the format of the reference data source.
 








Class com.amazonaws.services.kinesisanalytics.model.InputConfiguration extends Object implements Serializable


Serialized Fields


id
String id

 Input source ID. You can get this ID by calling the DescribeApplication operation.
 


inputStartingPositionConfiguration
InputStartingPositionConfiguration inputStartingPositionConfiguration

 Point at which you want the application to start processing records from the streaming source.
 








Class com.amazonaws.services.kinesisanalytics.model.InputDescription extends Object implements Serializable


Serialized Fields


inputId
String inputId

 Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each
 input configuration you add to your application.
 


namePrefix
String namePrefix

 In-application name prefix.
 


inAppStreamNames
List<E> inAppStreamNames

 Returns the in-application stream names that are mapped to the stream source.
 


inputProcessingConfigurationDescription
InputProcessingConfigurationDescription inputProcessingConfigurationDescription

 The description of the preprocessor that executes on records in this input before the application's code is run.
 


kinesisStreamsInputDescription
KinesisStreamsInputDescription kinesisStreamsInputDescription

 If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource
 Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
 


kinesisFirehoseInputDescription
KinesisFirehoseInputDescription kinesisFirehoseInputDescription

 If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's
 ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
 


inputSchema
SourceSchema inputSchema

 Describes the format of the data in the streaming source, and how each data element maps to corresponding columns
 in the in-application stream that is being created.
 


inputParallelism
InputParallelism inputParallelism

 Describes the configured parallelism (number of in-application streams mapped to the streaming source).
 


inputStartingPositionConfiguration
InputStartingPositionConfiguration inputStartingPositionConfiguration

 Point at which the application is configured to read from the input stream.
 








Class com.amazonaws.services.kinesisanalytics.model.InputLambdaProcessor extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the AWS Lambda function that operates on records in
 the stream.
 
 
 
 To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the
 Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
 
 


roleARN
String roleARN

 The ARN of the IAM role that is used to access the AWS Lambda function.
 








Class com.amazonaws.services.kinesisanalytics.model.InputLambdaProcessorDescription extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the AWS Lambda function that is used to preprocess
 the records in the stream.
 


roleARN
String roleARN

 The ARN of the IAM role that is used to access the AWS Lambda function.
 








Class com.amazonaws.services.kinesisanalytics.model.InputLambdaProcessorUpdate extends Object implements Serializable


Serialized Fields


resourceARNUpdate
String resourceARNUpdate

 The Amazon Resource Name (ARN) of the new AWS Lambda function
 that is used to preprocess the records in the stream.
 
 
 
 To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the
 Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
 
 


roleARNUpdate
String roleARNUpdate

 The ARN of the new IAM role that is used to access the AWS Lambda function.
 








Class com.amazonaws.services.kinesisanalytics.model.InputParallelism extends Object implements Serializable


Serialized Fields


count
Integer count

 Number of in-application streams to create. For more information, see Limits.
 








Class com.amazonaws.services.kinesisanalytics.model.InputParallelismUpdate extends Object implements Serializable


Serialized Fields


countUpdate
Integer countUpdate

 Number of in-application streams to create for the specified streaming source.
 








Class com.amazonaws.services.kinesisanalytics.model.InputProcessingConfiguration extends Object implements Serializable


Serialized Fields


inputLambdaProcessor
InputLambdaProcessor inputLambdaProcessor

 The 
 InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your
 application code.
 








Class com.amazonaws.services.kinesisanalytics.model.InputProcessingConfigurationDescription extends Object implements Serializable


Serialized Fields


inputLambdaProcessorDescription
InputLambdaProcessorDescription inputLambdaProcessorDescription

 Provides configuration information about the associated InputLambdaProcessorDescription.
 








Class com.amazonaws.services.kinesisanalytics.model.InputProcessingConfigurationUpdate extends Object implements Serializable


Serialized Fields


inputLambdaProcessorUpdate
InputLambdaProcessorUpdate inputLambdaProcessorUpdate

 Provides update information for an InputLambdaProcessor.
 








Class com.amazonaws.services.kinesisanalytics.model.InputSchemaUpdate extends Object implements Serializable


Serialized Fields


recordFormatUpdate
RecordFormat recordFormatUpdate

 Specifies the format of the records on the streaming source.
 


recordEncodingUpdate
String recordEncodingUpdate

 Specifies the encoding of the records in the streaming source. For example, UTF-8.
 


recordColumnUpdates
List<E> recordColumnUpdates

 A list of RecordColumn objects. Each object describes the mapping of the streaming source element to
 the corresponding column in the in-application stream.
 








Class com.amazonaws.services.kinesisanalytics.model.InputStartingPositionConfiguration extends Object implements Serializable


Serialized Fields


inputStartingPosition
String inputStartingPosition

 The starting position on the stream.
 
 
 
 
 NOW - Start reading just after the most recent record in the stream, start at the request time stamp
 that the customer issued.
 
 
 
 
 TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record
 available in the stream. This option is not available for an Amazon Kinesis Firehose delivery stream.
 
 
 
 
 LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
 
 
 








Class com.amazonaws.services.kinesisanalytics.model.InputUpdate extends Object implements Serializable


Serialized Fields


inputId
String inputId

 Input ID of the application input to be updated.
 


namePrefixUpdate
String namePrefixUpdate

 Name prefix for in-application streams that Amazon Kinesis Analytics creates for the specific streaming source.
 


inputProcessingConfigurationUpdate
InputProcessingConfigurationUpdate inputProcessingConfigurationUpdate

 Describes updates for an input processing configuration.
 


kinesisStreamsInputUpdate
KinesisStreamsInputUpdate kinesisStreamsInputUpdate

 If an Amazon Kinesis stream is the streaming source to be updated, provides an updated stream Amazon Resource
 Name (ARN) and IAM role ARN.
 


kinesisFirehoseInputUpdate
KinesisFirehoseInputUpdate kinesisFirehoseInputUpdate

 If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream
 ARN and IAM role ARN.
 


inputSchemaUpdate
InputSchemaUpdate inputSchemaUpdate

 Describes the data format on the streaming source, and how record elements on the streaming source map to columns
 of the in-application stream that is created.
 


inputParallelismUpdate
InputParallelismUpdate inputParallelismUpdate

 Describes the parallelism updates (the number in-application streams Amazon Kinesis Analytics creates for the
 specific streaming source).
 








Class com.amazonaws.services.kinesisanalytics.model.InvalidApplicationConfigurationException extends AmazonKinesisAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalytics.model.InvalidArgumentException extends AmazonKinesisAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalytics.model.JSONMappingParameters extends Object implements Serializable


Serialized Fields


recordRowPath
String recordRowPath

 Path to the top-level parent that contains the records.
 








Class com.amazonaws.services.kinesisanalytics.model.KinesisFirehoseInput extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 ARN of the input delivery stream.
 


roleARN
String roleARN

 ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to
 make sure that the role has the necessary permissions to access the stream.
 








Class com.amazonaws.services.kinesisanalytics.model.KinesisFirehoseInputDescription extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.
 


roleARN
String roleARN

 ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.
 








Class com.amazonaws.services.kinesisanalytics.model.KinesisFirehoseInputUpdate extends Object implements Serializable


Serialized Fields


resourceARNUpdate
String resourceARNUpdate

 Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery stream to read.
 


roleARNUpdate
String roleARNUpdate

 ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to
 grant the necessary permissions to this role.
 








Class com.amazonaws.services.kinesisanalytics.model.KinesisFirehoseOutput extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 ARN of the destination Amazon Kinesis Firehose delivery stream to write to.
 


roleARN
String roleARN

 ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf.
 You need to grant the necessary permissions to this role.
 








Class com.amazonaws.services.kinesisanalytics.model.KinesisFirehoseOutputDescription extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.
 


roleARN
String roleARN

 ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.
 








Class com.amazonaws.services.kinesisanalytics.model.KinesisFirehoseOutputUpdate extends Object implements Serializable


Serialized Fields


resourceARNUpdate
String resourceARNUpdate

 Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.
 


roleARNUpdate
String roleARNUpdate

 ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to
 grant the necessary permissions to this role.
 








Class com.amazonaws.services.kinesisanalytics.model.KinesisStreamsInput extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 ARN of the input Amazon Kinesis stream to read.
 


roleARN
String roleARN

 ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to
 grant the necessary permissions to this role.
 








Class com.amazonaws.services.kinesisanalytics.model.KinesisStreamsInputDescription extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 Amazon Resource Name (ARN) of the Amazon Kinesis stream.
 


roleARN
String roleARN

 ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.
 








Class com.amazonaws.services.kinesisanalytics.model.KinesisStreamsInputUpdate extends Object implements Serializable


Serialized Fields


resourceARNUpdate
String resourceARNUpdate

 Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.
 


roleARNUpdate
String roleARNUpdate

 ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to
 grant the necessary permissions to this role.
 








Class com.amazonaws.services.kinesisanalytics.model.KinesisStreamsOutput extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 ARN of the destination Amazon Kinesis stream to write to.
 


roleARN
String roleARN

 ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf.
 You need to grant the necessary permissions to this role.
 








Class com.amazonaws.services.kinesisanalytics.model.KinesisStreamsOutputDescription extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 Amazon Resource Name (ARN) of the Amazon Kinesis stream.
 


roleARN
String roleARN

 ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.
 








Class com.amazonaws.services.kinesisanalytics.model.KinesisStreamsOutputUpdate extends Object implements Serializable


Serialized Fields


resourceARNUpdate
String resourceARNUpdate

 Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.
 


roleARNUpdate
String roleARNUpdate

 ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to
 grant the necessary permissions to this role.
 








Class com.amazonaws.services.kinesisanalytics.model.LambdaOutput extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 Amazon Resource Name (ARN) of the destination Lambda function to write to.
 
 
 
 To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the
 Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
 
 


roleARN
String roleARN

 ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf.
 You need to grant the necessary permissions to this role.
 








Class com.amazonaws.services.kinesisanalytics.model.LambdaOutputDescription extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 Amazon Resource Name (ARN) of the destination Lambda function.
 


roleARN
String roleARN

 ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function.
 








Class com.amazonaws.services.kinesisanalytics.model.LambdaOutputUpdate extends Object implements Serializable


Serialized Fields


resourceARNUpdate
String resourceARNUpdate

 Amazon Resource Name (ARN) of the destination Lambda function.
 
 
 
 To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the
 Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
 
 


roleARNUpdate
String roleARNUpdate

 ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf.
 You need to grant the necessary permissions to this role.
 








Class com.amazonaws.services.kinesisanalytics.model.LimitExceededException extends AmazonKinesisAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalytics.model.ListApplicationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


limit
Integer limit

 Maximum number of applications to list.
 


exclusiveStartApplicationName
String exclusiveStartApplicationName

 Name of the application to start the list with. When using pagination to retrieve the list, you don't need to
 specify this parameter in the first request. However, in subsequent requests, you add the last application name
 from the previous response to get the next page of applications.
 








Class com.amazonaws.services.kinesisanalytics.model.ListApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationSummaries
List<E> applicationSummaries

 List of ApplicationSummary objects.
 


hasMoreApplications
Boolean hasMoreApplications

 Returns true if there are more applications to retrieve.
 








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


Serialized Fields


resourceARN
String resourceARN

 The ARN of the application for which to retrieve tags.
 








Class com.amazonaws.services.kinesisanalytics.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The key-value tags assigned to the application.
 








Class com.amazonaws.services.kinesisanalytics.model.MappingParameters extends Object implements Serializable


Serialized Fields


jSONMappingParameters
JSONMappingParameters jSONMappingParameters

 Provides additional mapping information when JSON is the record format on the streaming source.
 


cSVMappingParameters
CSVMappingParameters cSVMappingParameters

 Provides additional mapping information when the record format uses delimiters (for example, CSV).
 








Class com.amazonaws.services.kinesisanalytics.model.Output extends Object implements Serializable


Serialized Fields


name
String name

 Name of the in-application stream.
 


kinesisStreamsOutput
KinesisStreamsOutput kinesisStreamsOutput

 Identifies an Amazon Kinesis stream as the destination.
 


kinesisFirehoseOutput
KinesisFirehoseOutput kinesisFirehoseOutput

 Identifies an Amazon Kinesis Firehose delivery stream as the destination.
 


lambdaOutput
LambdaOutput lambdaOutput

 Identifies an AWS Lambda function as the destination.
 


destinationSchema
DestinationSchema destinationSchema

 Describes the data format when records are written to the destination. For more information, see Configuring Application
 Output.
 








Class com.amazonaws.services.kinesisanalytics.model.OutputDescription extends Object implements Serializable


Serialized Fields


outputId
String outputId

 A unique identifier for the output configuration.
 


name
String name

 Name of the in-application stream configured as output.
 


kinesisStreamsOutputDescription
KinesisStreamsOutputDescription kinesisStreamsOutputDescription

 Describes Amazon Kinesis stream configured as the destination where output is written.
 


kinesisFirehoseOutputDescription
KinesisFirehoseOutputDescription kinesisFirehoseOutputDescription

 Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.
 


lambdaOutputDescription
LambdaOutputDescription lambdaOutputDescription

 Describes the AWS Lambda function configured as the destination where output is written.
 


destinationSchema
DestinationSchema destinationSchema

 Data format used for writing data to the destination.
 








Class com.amazonaws.services.kinesisanalytics.model.OutputUpdate extends Object implements Serializable


Serialized Fields


outputId
String outputId

 Identifies the specific output configuration that you want to update.
 


nameUpdate
String nameUpdate

 If you want to specify a different in-application stream for this output configuration, use this field to specify
 the new in-application stream name.
 


kinesisStreamsOutputUpdate
KinesisStreamsOutputUpdate kinesisStreamsOutputUpdate

 Describes an Amazon Kinesis stream as the destination for the output.
 


kinesisFirehoseOutputUpdate
KinesisFirehoseOutputUpdate kinesisFirehoseOutputUpdate

 Describes an Amazon Kinesis Firehose delivery stream as the destination for the output.
 


lambdaOutputUpdate
LambdaOutputUpdate lambdaOutputUpdate

 Describes an AWS Lambda function as the destination for the output.
 


destinationSchemaUpdate
DestinationSchema destinationSchemaUpdate

 Describes the data format when records are written to the destination. For more information, see Configuring Application
 Output.
 








Class com.amazonaws.services.kinesisanalytics.model.RecordColumn extends Object implements Serializable


Serialized Fields


name
String name

 Name of the column created in the in-application input stream or reference table.
 


mapping
String mapping

 Reference to the data element in the streaming input or the reference data source. This element is required if
 the RecordFormatType is JSON.
 


sqlType
String sqlType

 Type of column created in the in-application input stream or reference table.
 








Class com.amazonaws.services.kinesisanalytics.model.RecordFormat extends Object implements Serializable


Serialized Fields


recordFormatType
String recordFormatType

 The type of record format.
 


mappingParameters
MappingParameters mappingParameters

 When configuring application input at the time of creating or updating an application, provides additional
 mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some
 delimiter) on the streaming source.
 








Class com.amazonaws.services.kinesisanalytics.model.ReferenceDataSource extends Object implements Serializable


Serialized Fields


tableName
String tableName

 Name of the in-application table to create.
 


s3ReferenceDataSource
S3ReferenceDataSource s3ReferenceDataSource

 Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis
 Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference
 data only once. If the data changes, you call the UpdateApplication operation to trigger reloading
 of data into your application.
 


referenceSchema
SourceSchema referenceSchema

 Describes the format of the data in the streaming source, and how each data element maps to corresponding columns
 created in the in-application stream.
 








Class com.amazonaws.services.kinesisanalytics.model.ReferenceDataSourceDescription extends Object implements Serializable


Serialized Fields


referenceId
String referenceId

 ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference
 data source to your application using the AddApplicationReferenceDataSource operation.
 


tableName
String tableName

 The in-application table name created by the specific reference data source configuration.
 


s3ReferenceDataSourceDescription
S3ReferenceDataSourceDescription s3ReferenceDataSourceDescription

 Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon
 Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and
 populate the in-application reference table.
 


referenceSchema
SourceSchema referenceSchema

 Describes the format of the data in the streaming source, and how each data element maps to corresponding columns
 created in the in-application stream.
 








Class com.amazonaws.services.kinesisanalytics.model.ReferenceDataSourceUpdate extends Object implements Serializable


Serialized Fields


referenceId
String referenceId

 ID of the reference data source being updated. You can use the DescribeApplication operation to get this value.
 


tableNameUpdate
String tableNameUpdate

 In-application table name that is created by this update.
 


s3ReferenceDataSourceUpdate
S3ReferenceDataSourceUpdate s3ReferenceDataSourceUpdate

 Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the
 Amazon S3 object on your behalf and populate the in-application reference table.
 


referenceSchemaUpdate
SourceSchema referenceSchemaUpdate

 Describes the format of the data in the streaming source, and how each data element maps to corresponding columns
 created in the in-application stream.
 








Class com.amazonaws.services.kinesisanalytics.model.ResourceInUseException extends AmazonKinesisAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalytics.model.ResourceNotFoundException extends AmazonKinesisAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalytics.model.ResourceProvisionedThroughputExceededException extends AmazonKinesisAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalytics.model.S3Configuration extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 IAM ARN of the role used to access the data.
 


bucketARN
String bucketARN

 ARN of the S3 bucket that contains the data.
 


fileKey
String fileKey

 The name of the object that contains the data.
 








Class com.amazonaws.services.kinesisanalytics.model.S3ReferenceDataSource extends Object implements Serializable


Serialized Fields


bucketARN
String bucketARN

 Amazon Resource Name (ARN) of the S3 bucket.
 


fileKey
String fileKey

 Object key name containing reference data.
 


referenceRoleARN
String referenceRoleARN

 ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for
 the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service
 principal to assume this role.
 








Class com.amazonaws.services.kinesisanalytics.model.S3ReferenceDataSourceDescription extends Object implements Serializable


Serialized Fields


bucketARN
String bucketARN

 Amazon Resource Name (ARN) of the S3 bucket.
 


fileKey
String fileKey

 Amazon S3 object key name.
 


referenceRoleARN
String referenceRoleARN

 ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf to
 populate the in-application reference table.
 








Class com.amazonaws.services.kinesisanalytics.model.S3ReferenceDataSourceUpdate extends Object implements Serializable


Serialized Fields


bucketARNUpdate
String bucketARNUpdate

 Amazon Resource Name (ARN) of the S3 bucket.
 


fileKeyUpdate
String fileKeyUpdate

 Object key name.
 


referenceRoleARNUpdate
String referenceRoleARNUpdate

 ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the
 in-application.
 








Class com.amazonaws.services.kinesisanalytics.model.ServiceUnavailableException extends AmazonKinesisAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalytics.model.SourceSchema extends Object implements Serializable


Serialized Fields


recordFormat
RecordFormat recordFormat

 Specifies the format of the records on the streaming source.
 


recordEncoding
String recordEncoding

 Specifies the encoding of the records in the streaming source. For example, UTF-8.
 


recordColumns
List<E> recordColumns

 A list of RecordColumn objects.
 








Class com.amazonaws.services.kinesisanalytics.model.StartApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of the application.
 


inputConfigurations
List<E> inputConfigurations

 Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts
 reading the streaming source associated with the input. You can also specify where in the streaming source you
 want Amazon Kinesis Analytics to start reading.
 








Class com.amazonaws.services.kinesisanalytics.model.StartApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.StopApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of the running application to stop.
 








Class com.amazonaws.services.kinesisanalytics.model.StopApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key of the key-value tag.
 


value
String value

 The value of the key-value tag. The value is optional.
 








Class com.amazonaws.services.kinesisanalytics.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the application to assign the tags.
 


tags
List<E> tags

 The key-value tags to assign to the application.
 








Class com.amazonaws.services.kinesisanalytics.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.TooManyTagsException extends AmazonKinesisAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalytics.model.UnableToDetectSchemaException extends AmazonKinesisAnalyticsException implements Serializable

serialVersionUID:
1L



Serialized Fields


rawInputRecords
List<E> rawInputRecords


processedInputRecords
List<E> processedInputRecords








Class com.amazonaws.services.kinesisanalytics.model.UnsupportedOperationException extends AmazonKinesisAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalytics.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the Kinesis Analytics application from which to remove the tags.
 


tagKeys
List<E> tagKeys

 A list of keys of tags to remove from the specified application.
 








Class com.amazonaws.services.kinesisanalytics.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalytics.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 Name of the Amazon Kinesis Analytics application to update.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The current application version ID. You can use the DescribeApplication operation to get this value.
 


applicationUpdate
ApplicationUpdate applicationUpdate

 Describes application updates.
 








Class com.amazonaws.services.kinesisanalytics.model.UpdateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.kinesisanalyticsv2.model




Class com.amazonaws.services.kinesisanalyticsv2.model.AddApplicationCloudWatchLoggingOptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The Kinesis Data Analytics application name.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The version ID of the Kinesis Data Analytics application. You can retrieve the application version ID using
 DescribeApplication.
 


cloudWatchLoggingOption
CloudWatchLoggingOption cloudWatchLoggingOption

 Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).
 








Class com.amazonaws.services.kinesisanalyticsv2.model.AddApplicationCloudWatchLoggingOptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationARN
String applicationARN

 The application's ARN.
 


applicationVersionId
Long applicationVersionId

 The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics updates the
 ApplicationVersionId each time you change the CloudWatch logging options.
 


cloudWatchLoggingOptionDescriptions
List<E> cloudWatchLoggingOptionDescriptions

 The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.AddApplicationInputProcessingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application to which you want to add the input processing configuration.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The version of the application to which you want to add the input processing configuration. You can use the
 DescribeApplication operation to get the current application version. If the version specified is not the
 current version, the ConcurrentModificationException is returned.
 


inputId
String inputId

 The ID of the input configuration to add the input processing configuration to. You can get a list of the input
 IDs for an application using the DescribeApplication operation.
 


inputProcessingConfiguration
InputProcessingConfiguration inputProcessingConfiguration

 The InputProcessingConfiguration to add to the application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.AddApplicationInputProcessingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationARN
String applicationARN

 The Amazon Resource Name (ARN) of the application.
 


applicationVersionId
Long applicationVersionId

 Provides the current application version.
 


inputId
String inputId

 The input ID that is associated with the application input. This is the ID that Amazon Kinesis Data Analytics
 assigns to each input configuration that you add to your application.
 


inputProcessingConfigurationDescription
InputProcessingConfigurationDescription inputProcessingConfigurationDescription

 The description of the preprocessor that executes on records in this input before the application's code is run.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.AddApplicationInputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of your existing application to which you want to add the streaming source.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The current version of your application. You can use the DescribeApplication operation to find the current
 application version.
 


input
Input input

 The Input to add.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.AddApplicationInputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationARN
String applicationARN

 The Amazon Resource Name (ARN) of the application.
 


applicationVersionId
Long applicationVersionId

 Provides the current application version.
 


inputDescriptions
List<E> inputDescriptions

 Describes the application input configuration.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.AddApplicationOutputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application to which you want to add the output configuration.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The version of the application to which you want to add the output configuration. You can use the
 DescribeApplication operation to get the current application version. If the version specified is not the
 current version, the ConcurrentModificationException is returned.
 


output
Output output

 An array of objects, each describing one output configuration. In the output configuration, you specify the name
 of an in-application stream, a destination (that is, a Kinesis data stream, a Kinesis Data Firehose delivery
 stream, or an AWS Lambda function), and record the formation to use when writing to the destination.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.AddApplicationOutputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationARN
String applicationARN

 The application Amazon Resource Name (ARN).
 


applicationVersionId
Long applicationVersionId

 The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.
 


outputDescriptions
List<E> outputDescriptions

 Describes the application output configuration. For more information, see Configuring Application
 Output.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.AddApplicationReferenceDataSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an existing application.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The version of the application for which you are adding the reference data source. You can use the
 DescribeApplication operation to get the current application version. If the version specified is not the
 current version, the ConcurrentModificationException is returned.
 


referenceDataSource
ReferenceDataSource referenceDataSource

 The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and
 copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the
 resulting in-application table that is created.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.AddApplicationReferenceDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationARN
String applicationARN

 The application Amazon Resource Name (ARN).
 


applicationVersionId
Long applicationVersionId

 The updated application version ID. Amazon Kinesis Data Analytics increments this ID when the application is
 updated.
 


referenceDataSourceDescriptions
List<E> referenceDataSourceDescriptions

 Describes reference data sources configured for the application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.AddApplicationVpcConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an existing application.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The version of the application to which you want to add the input processing configuration. You can use the
 DescribeApplication operation to get the current application version. If the version specified is not the
 current version, the ConcurrentModificationException is returned.
 


vpcConfiguration
VpcConfiguration vpcConfiguration

 Description of the VPC to add to the application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.AddApplicationVpcConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationARN
String applicationARN

 The ARN of the application.
 


applicationVersionId
Long applicationVersionId

 Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you
 update the application.
 


vpcConfigurationDescription
VpcConfigurationDescription vpcConfigurationDescription

 The parameters of the new VPC configuration.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.AmazonKinesisAnalyticsV2Exception extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.ApplicationCodeConfiguration extends Object implements Serializable


Serialized Fields


codeContent
CodeContent codeContent

 The location and type of the application code.
 


codeContentType
String codeContentType

 Specifies whether the code content is in text or zip format.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ApplicationCodeConfigurationDescription extends Object implements Serializable


Serialized Fields


codeContentType
String codeContentType

 Specifies whether the code content is in text or zip format.
 


codeContentDescription
CodeContentDescription codeContentDescription

 Describes details about the location and format of the application code.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ApplicationCodeConfigurationUpdate extends Object implements Serializable


Serialized Fields


codeContentTypeUpdate
String codeContentTypeUpdate

 Describes updates to the code content type.
 


codeContentUpdate
CodeContentUpdate codeContentUpdate

 Describes updates to the code content of an application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ApplicationConfiguration extends Object implements Serializable


Serialized Fields


sqlApplicationConfiguration
SqlApplicationConfiguration sqlApplicationConfiguration

 The creation and update parameters for an SQL-based Kinesis Data Analytics application.
 


flinkApplicationConfiguration
FlinkApplicationConfiguration flinkApplicationConfiguration

 The creation and update parameters for a Java-based Kinesis Data Analytics application.
 


environmentProperties
EnvironmentProperties environmentProperties

 Describes execution properties for a Java-based Kinesis Data Analytics application.
 


applicationCodeConfiguration
ApplicationCodeConfiguration applicationCodeConfiguration

 The code location and type parameters for a Java-based Kinesis Data Analytics application.
 


applicationSnapshotConfiguration
ApplicationSnapshotConfiguration applicationSnapshotConfiguration

 Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
 


vpcConfigurations
List<E> vpcConfigurations

 The array of descriptions of VPC configurations available to the application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ApplicationConfigurationDescription extends Object implements Serializable


Serialized Fields


sqlApplicationConfigurationDescription
SqlApplicationConfigurationDescription sqlApplicationConfigurationDescription

 The details about inputs, outputs, and reference data sources for an SQL-based Kinesis Data Analytics
 application.
 


applicationCodeConfigurationDescription
ApplicationCodeConfigurationDescription applicationCodeConfigurationDescription

 The details about the application code for a Java-based Kinesis Data Analytics application.
 


runConfigurationDescription
RunConfigurationDescription runConfigurationDescription

 The details about the starting properties for a Kinesis Data Analytics application.
 


flinkApplicationConfigurationDescription
FlinkApplicationConfigurationDescription flinkApplicationConfigurationDescription

 The details about a Java-based Kinesis Data Analytics application.
 


environmentPropertyDescriptions
EnvironmentPropertyDescriptions environmentPropertyDescriptions

 Describes execution properties for a Java-based Kinesis Data Analytics application.
 


applicationSnapshotConfigurationDescription
ApplicationSnapshotConfigurationDescription applicationSnapshotConfigurationDescription

 Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
 


vpcConfigurationDescriptions
List<E> vpcConfigurationDescriptions

 The array of descriptions of VPC configurations available to the application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ApplicationConfigurationUpdate extends Object implements Serializable


Serialized Fields


sqlApplicationConfigurationUpdate
SqlApplicationConfigurationUpdate sqlApplicationConfigurationUpdate

 Describes updates to an SQL-based Kinesis Data Analytics application's configuration.
 


applicationCodeConfigurationUpdate
ApplicationCodeConfigurationUpdate applicationCodeConfigurationUpdate

 Describes updates to a Java-based Kinesis Data Analytics application's code configuration.
 


flinkApplicationConfigurationUpdate
FlinkApplicationConfigurationUpdate flinkApplicationConfigurationUpdate

 Describes updates to a Java-based Kinesis Data Analytics application's configuration.
 


environmentPropertyUpdates
EnvironmentPropertyUpdates environmentPropertyUpdates

 Describes updates to the environment properties for a Java-based Kinesis Data Analytics application.
 


applicationSnapshotConfigurationUpdate
ApplicationSnapshotConfigurationUpdate applicationSnapshotConfigurationUpdate

 Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
 


vpcConfigurationUpdates
List<E> vpcConfigurationUpdates

 Updates to the array of descriptions of VPC configurations available to the application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ApplicationDetail extends Object implements Serializable


Serialized Fields


applicationARN
String applicationARN

 The ARN of the application.
 


applicationDescription
String applicationDescription

 The description of the application.
 


applicationName
String applicationName

 The name of the application.
 


runtimeEnvironment
String runtimeEnvironment

 The runtime environment for the application (SQL-1.0 or FLINK-1_6).
 


serviceExecutionRole
String serviceExecutionRole

 Specifies the IAM role that the application uses to access external resources.
 


applicationStatus
String applicationStatus

 The status of the application.
 


applicationVersionId
Long applicationVersionId

 Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId
 each time you update the application.
 


createTimestamp
Date createTimestamp

 The current timestamp when the application was created.
 


lastUpdateTimestamp
Date lastUpdateTimestamp

 The current timestamp when the application was last updated.
 


applicationConfigurationDescription
ApplicationConfigurationDescription applicationConfigurationDescription

 Provides details about the application's SQL or Java code and starting parameters.
 


cloudWatchLoggingOptionDescriptions
List<E> cloudWatchLoggingOptionDescriptions

 Describes the application Amazon CloudWatch logging options.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ApplicationRestoreConfiguration extends Object implements Serializable


Serialized Fields


applicationRestoreType
String applicationRestoreType

 Specifies how the application should be restored.
 


snapshotName
String snapshotName

 The identifier of an existing snapshot of application state to use to restart an application. The application
 uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the
 ApplicationRestoreType.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ApplicationSnapshotConfiguration extends Object implements Serializable


Serialized Fields


snapshotsEnabled
Boolean snapshotsEnabled

 Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ApplicationSnapshotConfigurationDescription extends Object implements Serializable


Serialized Fields


snapshotsEnabled
Boolean snapshotsEnabled

 Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ApplicationSnapshotConfigurationUpdate extends Object implements Serializable


Serialized Fields


snapshotsEnabledUpdate
Boolean snapshotsEnabledUpdate

 Describes updates to whether snapshots are enabled for a Java-based Kinesis Data Analytics application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ApplicationSummary extends Object implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application.
 


applicationARN
String applicationARN

 The ARN of the application.
 


applicationStatus
String applicationStatus

 The status of the application.
 


applicationVersionId
Long applicationVersionId

 Provides the current application version.
 


runtimeEnvironment
String runtimeEnvironment

 The runtime environment for the application (SQL-1.0 or FLINK-1_6).
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CheckpointConfiguration extends Object implements Serializable


Serialized Fields


configurationType
String configurationType

 Describes whether the application uses Amazon Kinesis Data Analytics' default checkpointing behavior. You must
 set this property to CUSTOM in order to set the CheckpointingEnabled,
 CheckpointInterval, or MinPauseBetweenCheckpoints parameters.
 
 
 
 If this value is set to DEFAULT, the application will use the following values, even if they are set
 to other values using APIs or application code:
 
 
 
 
 CheckpointingEnabled: true
 
 
 
 
 CheckpointInterval: 60000
 
 
 
 
 MinPauseBetweenCheckpoints: 5000
 
 
 
 


checkpointingEnabled
Boolean checkpointingEnabled

 Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application.
 
 
 
 If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a
 CheckpointingEnabled value of true, even if this value is set to another value using
 this API or in application code.
 
 


checkpointInterval
Long checkpointInterval

 Describes the interval in milliseconds between checkpoint operations.
 
 
 
 If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a
 CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in
 application code.
 
 


minPauseBetweenCheckpoints
Long minPauseBetweenCheckpoints

 Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation
 can start. If a checkpoint operation takes longer than the CheckpointInterval, the application
 otherwise performs continual checkpoint operations. For more information, see 
 Tuning Checkpointing in the Apache
 Flink Documentation.
 
 
 
 If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a
 MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application
 code.
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CheckpointConfigurationDescription extends Object implements Serializable


Serialized Fields


configurationType
String configurationType

 Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.
 
 
 
 If this value is set to DEFAULT, the application will use the following values, even if they are set
 to other values using APIs or application code:
 
 
 
 
 CheckpointingEnabled: true
 
 
 
 
 CheckpointInterval: 60000
 
 
 
 
 MinPauseBetweenCheckpoints: 5000
 
 
 
 


checkpointingEnabled
Boolean checkpointingEnabled

 Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application.
 
 
 
 If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a
 CheckpointingEnabled value of true, even if this value is set to another value using
 this API or in application code.
 
 


checkpointInterval
Long checkpointInterval

 Describes the interval in milliseconds between checkpoint operations.
 
 
 
 If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a
 CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in
 application code.
 
 


minPauseBetweenCheckpoints
Long minPauseBetweenCheckpoints

 Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation
 can start.
 
 
 
 If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a
 MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application
 code.
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CheckpointConfigurationUpdate extends Object implements Serializable


Serialized Fields


configurationTypeUpdate
String configurationTypeUpdate

 Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics.
 You must set this property to CUSTOM in order to set the CheckpointingEnabled,
 CheckpointInterval, or MinPauseBetweenCheckpoints parameters.
 
 
 
 If this value is set to DEFAULT, the application will use the following values, even if they are set
 to other values using APIs or application code:
 
 
 
 
 CheckpointingEnabled: true
 
 
 
 
 CheckpointInterval: 60000
 
 
 
 
 MinPauseBetweenCheckpoints: 5000
 
 
 
 


checkpointingEnabledUpdate
Boolean checkpointingEnabledUpdate

 Describes updates to whether checkpointing is enabled for an application.
 
 
 
 If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a
 CheckpointingEnabled value of true, even if this value is set to another value using
 this API or in application code.
 
 


checkpointIntervalUpdate
Long checkpointIntervalUpdate

 Describes updates to the interval in milliseconds between checkpoint operations.
 
 
 
 If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a
 CheckpointInterval vaue of 60000, even if this value is set to another value using this API or in
 application code.
 
 


minPauseBetweenCheckpointsUpdate
Long minPauseBetweenCheckpointsUpdate

 Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new
 checkpoint operation can start.
 
 
 
 If CheckpointConfiguration.ConfigurationType is DEFAULT, the application will use a
 MinPauseBetweenCheckpoints value of 5000, even if this value is set using this API or in application
 code.
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CloudWatchLoggingOption extends Object implements Serializable


Serialized Fields


logStreamARN
String logStreamARN

 The ARN of the CloudWatch log to receive application messages.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CloudWatchLoggingOptionDescription extends Object implements Serializable


Serialized Fields


cloudWatchLoggingOptionId
String cloudWatchLoggingOptionId

 The ID of the CloudWatch logging option description.
 


logStreamARN
String logStreamARN

 The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
 


roleARN
String roleARN

 The IAM ARN of the role to use to send application messages.
 
 
 
 Provided for backward compatibility. Applications created with the current API version have an application-level
 service execution role rather than a resource-level role.
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CloudWatchLoggingOptionUpdate extends Object implements Serializable


Serialized Fields


cloudWatchLoggingOptionId
String cloudWatchLoggingOptionId

 The ID of the CloudWatch logging option to update
 


logStreamARNUpdate
String logStreamARNUpdate

 The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CodeContent extends Object implements Serializable


Serialized Fields


textContent
String textContent

 The text-format code for a Java-based Kinesis Data Analytics application.
 


zipFileContent
ByteBuffer zipFileContent

 The zip-format code for a Java-based Kinesis Data Analytics application.
 


s3ContentLocation
S3ContentLocation s3ContentLocation

 Information about the Amazon S3 bucket containing the application code.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CodeContentDescription extends Object implements Serializable


Serialized Fields


textContent
String textContent

 The text-format code
 


codeMD5
String codeMD5

 The checksum that can be used to validate zip-format code.
 


codeSize
Long codeSize

 The size in bytes of the application code. Can be used to validate zip-format code.
 


s3ApplicationCodeLocationDescription
S3ApplicationCodeLocationDescription s3ApplicationCodeLocationDescription

 The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon
 S3.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CodeContentUpdate extends Object implements Serializable


Serialized Fields


textContentUpdate
String textContentUpdate

 Describes an update to the text code for an application.
 


zipFileContentUpdate
ByteBuffer zipFileContentUpdate

 Describes an update to the zipped code for an application.
 


s3ContentLocationUpdate
S3ContentLocationUpdate s3ContentLocationUpdate

 Describes an update to the location of code for an application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CodeValidationException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.ConcurrentModificationException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of your application (for example, sample-app).
 


applicationDescription
String applicationDescription

 A summary description of the application.
 


runtimeEnvironment
String runtimeEnvironment

 The runtime environment for the application (SQL-1.0 or FLINK-1_6).
 


serviceExecutionRole
String serviceExecutionRole

 The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams,
 Amazon S3 objects, and other external resources.
 


applicationConfiguration
ApplicationConfiguration applicationConfiguration

 Use this parameter to configure the application.
 


cloudWatchLoggingOptions
List<E> cloudWatchLoggingOptions

 Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.
 


tags
List<E> tags

 A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an
 application. Note that the maximum number of application tags includes system tags. The maximum number of
 user-defined application tags is 50. For more information, see Using Tagging.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CreateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationDetail
ApplicationDetail applicationDetail

 In response to your CreateApplication request, Kinesis Data Analytics returns a response with
 details of the application it created.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CreateApplicationSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an existing application
 


snapshotName
String snapshotName

 An identifier for the application snapshot.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.CreateApplicationSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalyticsv2.model.CSVMappingParameters extends Object implements Serializable


Serialized Fields


recordRowDelimiter
String recordRowDelimiter

 The row delimiter. For example, in a CSV format, '\n' is the typical row delimiter.
 


recordColumnDelimiter
String recordColumnDelimiter

 The column delimiter. For example, in a CSV format, a comma (",") is the typical column delimiter.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationCloudWatchLoggingOptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The application name.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The version ID of the application. You can retrieve the application version ID using DescribeApplication.
 


cloudWatchLoggingOptionId
String cloudWatchLoggingOptionId

 The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to delete. You can get the
 CloudWatchLoggingOptionId by using the DescribeApplication operation.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationCloudWatchLoggingOptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationARN
String applicationARN

 The application's Amazon Resource Name (ARN).
 


applicationVersionId
Long applicationVersionId

 The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId each time
 you change the CloudWatch logging options.
 


cloudWatchLoggingOptionDescriptions
List<E> cloudWatchLoggingOptionDescriptions

 The descriptions of the remaining CloudWatch logging options for the application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationInputProcessingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The application version. You can use the DescribeApplication operation to get the current application
 version. If the version specified is not the current version, the ConcurrentModificationException is
 returned.
 


inputId
String inputId

 The ID of the input configuration from which to delete the input processing configuration. You can get a list of
 the input IDs for an application by using the DescribeApplication operation.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationInputProcessingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationARN
String applicationARN

 The Amazon Resource Name (ARN) of the application.
 


applicationVersionId
Long applicationVersionId

 The current application version ID.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationOutputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The application name.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The application version. You can use the DescribeApplication operation to get the current application
 version. If the version specified is not the current version, the ConcurrentModificationException is
 returned.
 


outputId
String outputId

 The ID of the configuration to delete. Each output configuration that is added to the application (either when
 the application is created or later) using the AddApplicationOutput operation has a unique ID. You need to
 provide the ID to uniquely identify the output configuration that you want to delete from the application
 configuration. You can use the DescribeApplication operation to get the specific OutputId.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationOutputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationARN
String applicationARN

 The application Amazon Resource Name (ARN).
 


applicationVersionId
Long applicationVersionId

 The current application version ID.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationReferenceDataSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an existing application.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The current application version. You can use the DescribeApplication operation to get the current
 application version. If the version specified is not the current version, the
 ConcurrentModificationException is returned.
 


referenceId
String referenceId

 The ID of the reference data source. When you add a reference data source to your application using the
 AddApplicationReferenceDataSource, Kinesis Data Analytics assigns an ID. You can use the
 DescribeApplication operation to get the reference ID.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationReferenceDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationARN
String applicationARN

 The application Amazon Resource Name (ARN).
 


applicationVersionId
Long applicationVersionId

 The updated version ID of the application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application to delete.
 


createTimestamp
Date createTimestamp

 Use the DescribeApplication operation to get this value.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an existing application.
 


snapshotName
String snapshotName

 The identifier for the snapshot delete.
 


snapshotCreationTimestamp
Date snapshotCreationTimestamp

 The creation timestamp of the application snapshot to delete. You can retrieve this value using or .
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationVpcConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an existing application.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The current application version ID. You can retrieve the application version ID using DescribeApplication.
 


vpcConfigurationId
String vpcConfigurationId

 The ID of the VPC configuration to delete.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DeleteApplicationVpcConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationARN
String applicationARN

 The ARN of the Kinesis Data Analytics application.
 


applicationVersionId
Long applicationVersionId

 The updated version ID of the application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DescribeApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application.
 


includeAdditionalDetails
Boolean includeAdditionalDetails

 Displays verbose information about a Kinesis Data Analytics application, including the application's job plan.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DescribeApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationDetail
ApplicationDetail applicationDetail

 Provides a description of the application, such as the application's Amazon Resource Name (ARN), status, and
 latest version.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DescribeApplicationSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an existing application.
 


snapshotName
String snapshotName

 The identifier of an application snapshot. You can retrieve this value using .
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DescribeApplicationSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


snapshotDetails
SnapshotDetails snapshotDetails

 An object containing information about the application snapshot.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DestinationSchema extends Object implements Serializable


Serialized Fields


recordFormatType
String recordFormatType

 Specifies the format of the records on the output stream.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DiscoverInputSchemaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the streaming source.
 


serviceExecutionRole
String serviceExecutionRole

 The ARN of the role that is used to access the streaming source.
 


inputStartingPositionConfiguration
InputStartingPositionConfiguration inputStartingPositionConfiguration

 The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source
 discovery purposes.
 


s3Configuration
S3Configuration s3Configuration

 Specify this parameter to discover a schema from data in an Amazon S3 object.
 


inputProcessingConfiguration
InputProcessingConfiguration inputProcessingConfiguration

 The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the
 records.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.DiscoverInputSchemaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


inputSchema
SourceSchema inputSchema

 The schema inferred from the streaming source. It identifies the format of the data in the streaming source and
 how each data element maps to corresponding columns in the in-application stream that you can create.
 


parsedInputRecords
List<E> parsedInputRecords

 An array of elements, where each element corresponds to a row in a stream record (a stream record can have more
 than one row).
 


processedInputRecords
List<E> processedInputRecords

 The stream data that was modified by the processor specified in the InputProcessingConfiguration
 parameter.
 


rawInputRecords
List<E> rawInputRecords

 The raw stream data that was sampled to infer the schema.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.EnvironmentProperties extends Object implements Serializable


Serialized Fields


propertyGroups
List<E> propertyGroups

 Describes the execution property groups.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.EnvironmentPropertyDescriptions extends Object implements Serializable


Serialized Fields


propertyGroupDescriptions
List<E> propertyGroupDescriptions

 Describes the execution property groups.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.EnvironmentPropertyUpdates extends Object implements Serializable


Serialized Fields


propertyGroups
List<E> propertyGroups

 Describes updates to the execution property groups.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.FlinkApplicationConfiguration extends Object implements Serializable


Serialized Fields


checkpointConfiguration
CheckpointConfiguration checkpointConfiguration

 Describes an application's checkpointing configuration. Checkpointing is the process of persisting application
 state for fault tolerance. For more information, see  Checkpoints for Fault Tolerance in the Apache Flink Documentation.
 


monitoringConfiguration
MonitoringConfiguration monitoringConfiguration

 Describes configuration parameters for Amazon CloudWatch logging for an application.
 


parallelismConfiguration
ParallelismConfiguration parallelismConfiguration

 Describes parameters for how an application executes multiple tasks simultaneously.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.FlinkApplicationConfigurationDescription extends Object implements Serializable


Serialized Fields


checkpointConfigurationDescription
CheckpointConfigurationDescription checkpointConfigurationDescription

 Describes an application's checkpointing configuration. Checkpointing is the process of persisting application
 state for fault tolerance.
 


monitoringConfigurationDescription
MonitoringConfigurationDescription monitoringConfigurationDescription

 Describes configuration parameters for Amazon CloudWatch logging for an application.
 


parallelismConfigurationDescription
ParallelismConfigurationDescription parallelismConfigurationDescription

 Describes parameters for how an application executes multiple tasks simultaneously.
 


jobPlanDescription
String jobPlanDescription

 The job plan for an application. For more information about the job plan, see Jobs and
 Scheduling in the Apache Flink
 Documentation. To retrieve the job plan for the application, use the
 DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.FlinkApplicationConfigurationUpdate extends Object implements Serializable


Serialized Fields


checkpointConfigurationUpdate
CheckpointConfigurationUpdate checkpointConfigurationUpdate

 Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting
 application state for fault tolerance.
 


monitoringConfigurationUpdate
MonitoringConfigurationUpdate monitoringConfigurationUpdate

 Describes updates to the configuration parameters for Amazon CloudWatch logging for an application.
 


parallelismConfigurationUpdate
ParallelismConfigurationUpdate parallelismConfigurationUpdate

 Describes updates to the parameters for how an application executes multiple tasks simultaneously.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.FlinkRunConfiguration extends Object implements Serializable


Serialized Fields


allowNonRestoredState
Boolean allowNonRestoredState

 When restoring from a savepoint, specifies whether the runtime is allowed to skip a state that cannot be mapped
 to the new program. This will happen if the program is updated between savepoints to remove stateful parameters,
 and state data in the savepoint no longer corresponds to valid application data. For more information, see  Allowing Non-Restored State in the Apache Flink documentation.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.Input extends Object implements Serializable


Serialized Fields


namePrefix
String namePrefix

 The name prefix to use when creating an in-application stream. Suppose that you specify a prefix "
 MyInApplicationStream." Kinesis Data Analytics then creates one or more (as per the
 InputParallelism count you specified) in-application streams with the names "
 MyInApplicationStream_001," "MyInApplicationStream_002," and so on.
 


inputProcessingConfiguration
InputProcessingConfiguration inputProcessingConfiguration

 The InputProcessingConfiguration for the input. An input processor transforms records as they are received
 from the stream, before the application's SQL code executes. Currently, the only input processing configuration
 available is InputLambdaProcessor.
 


kinesisStreamsInput
KinesisStreamsInput kinesisStreamsInput

 If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).
 


kinesisFirehoseInput
KinesisFirehoseInput kinesisFirehoseInput

 If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.
 


inputParallelism
InputParallelism inputParallelism

 Describes the number of in-application streams to create.
 


inputSchema
SourceSchema inputSchema

 Describes the format of the data in the streaming source, and how each data element maps to corresponding columns
 in the in-application stream that is being created.
 
 
 Also used to describe the format of the reference data source.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InputDescription extends Object implements Serializable


Serialized Fields


inputId
String inputId

 The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to
 each input configuration that you add to your application.
 


namePrefix
String namePrefix

 The in-application name prefix.
 


inAppStreamNames
List<E> inAppStreamNames

 Returns the in-application stream names that are mapped to the stream source.
 


inputProcessingConfigurationDescription
InputProcessingConfigurationDescription inputProcessingConfigurationDescription

 The description of the preprocessor that executes on records in this input before the application's code is run.
 


kinesisStreamsInputDescription
KinesisStreamsInputDescription kinesisStreamsInputDescription

 If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource
 Name (ARN).
 


kinesisFirehoseInputDescription
KinesisFirehoseInputDescription kinesisFirehoseInputDescription

 If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's
 ARN.
 


inputSchema
SourceSchema inputSchema

 Describes the format of the data in the streaming source, and how each data element maps to corresponding columns
 in the in-application stream that is being created.
 


inputParallelism
InputParallelism inputParallelism

 Describes the configured parallelism (number of in-application streams mapped to the streaming source).
 


inputStartingPositionConfiguration
InputStartingPositionConfiguration inputStartingPositionConfiguration

 The point at which the application is configured to read from the input stream.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InputLambdaProcessor extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the AWS Lambda function that operates on records in the stream.
 
 
 
 To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the
 Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InputLambdaProcessorDescription extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the AWS Lambda function that is used to preprocess the records in the stream.
 
 
 
 To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the
 Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
 
 


roleARN
String roleARN

 The ARN of the IAM role that is used to access the AWS Lambda function.
 
 
 
 Provided for backward compatibility. Applications that are created with the current API version have an
 application-level service execution role rather than a resource-level role.
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InputLambdaProcessorUpdate extends Object implements Serializable


Serialized Fields


resourceARNUpdate
String resourceARNUpdate

 The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess the records in the
 stream.
 
 
 
 To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the
 Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InputParallelism extends Object implements Serializable


Serialized Fields


count
Integer count

 The number of in-application streams to create.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InputParallelismUpdate extends Object implements Serializable


Serialized Fields


countUpdate
Integer countUpdate

 The number of in-application streams to create for the specified streaming source.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InputProcessingConfiguration extends Object implements Serializable


Serialized Fields


inputLambdaProcessor
InputLambdaProcessor inputLambdaProcessor

 The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by
 your application code.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InputProcessingConfigurationDescription extends Object implements Serializable


Serialized Fields


inputLambdaProcessorDescription
InputLambdaProcessorDescription inputLambdaProcessorDescription

 Provides configuration information about the associated InputLambdaProcessorDescription
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InputProcessingConfigurationUpdate extends Object implements Serializable


Serialized Fields


inputLambdaProcessorUpdate
InputLambdaProcessorUpdate inputLambdaProcessorUpdate

 Provides update information for an InputLambdaProcessor.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InputSchemaUpdate extends Object implements Serializable


Serialized Fields


recordFormatUpdate
RecordFormat recordFormatUpdate

 Specifies the format of the records on the streaming source.
 


recordEncodingUpdate
String recordEncodingUpdate

 Specifies the encoding of the records in the streaming source; for example, UTF-8.
 


recordColumnUpdates
List<E> recordColumnUpdates

 A list of RecordColumn objects. Each object describes the mapping of the streaming source element to
 the corresponding column in the in-application stream.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InputStartingPositionConfiguration extends Object implements Serializable


Serialized Fields


inputStartingPosition
String inputStartingPosition

 The starting position on the stream.
 
 
 
 
 NOW - Start reading just after the most recent record in the stream, and start at the request
 timestamp that the customer issued.
 
 
 
 
 TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record
 available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.
 
 
 
 
 LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.
 
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InputUpdate extends Object implements Serializable


Serialized Fields


inputId
String inputId

 The input ID of the application input to be updated.
 


namePrefixUpdate
String namePrefixUpdate

 The name prefix for in-application streams that Kinesis Data Analytics creates for the specific streaming source.
 


inputProcessingConfigurationUpdate
InputProcessingConfigurationUpdate inputProcessingConfigurationUpdate

 Describes updates to an InputProcessingConfiguration.
 


kinesisStreamsInputUpdate
KinesisStreamsInputUpdate kinesisStreamsInputUpdate

 If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name
 (ARN).
 


kinesisFirehoseInputUpdate
KinesisFirehoseInputUpdate kinesisFirehoseInputUpdate

 If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN.
 


inputSchemaUpdate
InputSchemaUpdate inputSchemaUpdate

 Describes the data format on the streaming source, and how record elements on the streaming source map to columns
 of the in-application stream that is created.
 


inputParallelismUpdate
InputParallelismUpdate inputParallelismUpdate

 Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the
 specific streaming source).
 








Class com.amazonaws.services.kinesisanalyticsv2.model.InvalidApplicationConfigurationException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.InvalidArgumentException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.InvalidRequestException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.JSONMappingParameters extends Object implements Serializable


Serialized Fields


recordRowPath
String recordRowPath

 The path to the top-level parent that contains the records.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.KinesisFirehoseInput extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the delivery stream.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.KinesisFirehoseInputDescription extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the delivery stream.
 


roleARN
String roleARN

 The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.
 
 
 
 Provided for backward compatibility. Applications that are created with the current API version have an
 application-level service execution role rather than a resource-level role.
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.KinesisFirehoseInputUpdate extends Object implements Serializable


Serialized Fields


resourceARNUpdate
String resourceARNUpdate

 The Amazon Resource Name (ARN) of the input delivery stream to read.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.KinesisFirehoseOutput extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the destination delivery stream to write to.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.KinesisFirehoseOutputDescription extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the delivery stream.
 


roleARN
String roleARN

 The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
 
 
 
 Provided for backward compatibility. Applications that are created with the current API version have an
 application-level service execution role rather than a resource-level role.
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.KinesisFirehoseOutputUpdate extends Object implements Serializable


Serialized Fields


resourceARNUpdate
String resourceARNUpdate

 The Amazon Resource Name (ARN) of the delivery stream to write to.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.KinesisStreamsInput extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the input Kinesis data stream to read.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.KinesisStreamsInputDescription extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the Kinesis data stream.
 


roleARN
String roleARN

 The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
 
 
 
 Provided for backward compatibility. Applications that are created with the current API version have an
 application-level service execution role rather than a resource-level role.
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.KinesisStreamsInputUpdate extends Object implements Serializable


Serialized Fields


resourceARNUpdate
String resourceARNUpdate

 The Amazon Resource Name (ARN) of the input Kinesis data stream to read.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.KinesisStreamsOutput extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the destination Kinesis data stream to write to.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.KinesisStreamsOutputDescription extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the Kinesis data stream.
 


roleARN
String roleARN

 The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.
 
 
 
 Provided for backward compatibility. Applications that are created with the current API version have an
 application-level service execution role rather than a resource-level role.
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.KinesisStreamsOutputUpdate extends Object implements Serializable


Serialized Fields


resourceARNUpdate
String resourceARNUpdate

 The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the output.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.LambdaOutput extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the destination Lambda function to write to.
 
 
 
 To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the
 Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.LambdaOutputDescription extends Object implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The Amazon Resource Name (ARN) of the destination Lambda function.
 


roleARN
String roleARN

 The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.
 
 
 
 Provided for backward compatibility. Applications that are created with the current API version have an
 application-level service execution role rather than a resource-level role.
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.LambdaOutputUpdate extends Object implements Serializable


Serialized Fields


resourceARNUpdate
String resourceARNUpdate

 The Amazon Resource Name (ARN) of the destination AWS Lambda function.
 
 
 
 To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the
 Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.LimitExceededException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.ListApplicationSnapshotsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of an existing application.
 


limit
Integer limit

 The maximum number of application snapshots to list.
 


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ListApplicationSnapshotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


snapshotSummaries
List<E> snapshotSummaries

 A collection of objects containing information about the application snapshots.
 


nextToken
String nextToken

 The token for the next set of results, or null if there are no additional results.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ListApplicationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


limit
Integer limit

 The maximum number of applications to list.
 


nextToken
String nextToken

 If a previous command returned a pagination token, pass it into this value to retrieve the next set of results.
 For more information about pagination, see Using the AWS Command Line Interface's
 Pagination Options.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ListApplicationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationSummaries
List<E> applicationSummaries

 A list of ApplicationSummary objects.
 


nextToken
String nextToken

 The pagination token for the next set of results, or null if there are no additional results. Pass
 this token into a subsequent command to retrieve the next set of items For more information about pagination, see
 Using the AWS Command Line Interface's
 Pagination Options.
 








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


Serialized Fields


resourceARN
String resourceARN

 The ARN of the application for which to retrieve tags.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The key-value tags assigned to the application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.MappingParameters extends Object implements Serializable


Serialized Fields


jSONMappingParameters
JSONMappingParameters jSONMappingParameters

 Provides additional mapping information when JSON is the record format on the streaming source.
 


cSVMappingParameters
CSVMappingParameters cSVMappingParameters

 Provides additional mapping information when the record format uses delimiters (for example, CSV).
 








Class com.amazonaws.services.kinesisanalyticsv2.model.MonitoringConfiguration extends Object implements Serializable


Serialized Fields


configurationType
String configurationType

 Describes whether to use the default CloudWatch logging configuration for an application. You must set this
 property to CUSTOM in order to set the LogLevel or MetricsLevel
 parameters.
 


metricsLevel
String metricsLevel

 Describes the granularity of the CloudWatch Logs for an application.
 


logLevel
String logLevel

 Describes the verbosity of the CloudWatch Logs for an application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.MonitoringConfigurationDescription extends Object implements Serializable


Serialized Fields


configurationType
String configurationType

 Describes whether to use the default CloudWatch logging configuration for an application.
 


metricsLevel
String metricsLevel

 Describes the granularity of the CloudWatch Logs for an application.
 


logLevel
String logLevel

 Describes the verbosity of the CloudWatch Logs for an application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.MonitoringConfigurationUpdate extends Object implements Serializable


Serialized Fields


configurationTypeUpdate
String configurationTypeUpdate

 Describes updates to whether to use the default CloudWatch logging configuration for an application. You must set
 this property to CUSTOM in order to set the LogLevel or MetricsLevel
 parameters.
 


metricsLevelUpdate
String metricsLevelUpdate

 Describes updates to the granularity of the CloudWatch Logs for an application.
 


logLevelUpdate
String logLevelUpdate

 Describes updates to the verbosity of the CloudWatch Logs for an application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.Output extends Object implements Serializable


Serialized Fields


name
String name

 The name of the in-application stream.
 


kinesisStreamsOutput
KinesisStreamsOutput kinesisStreamsOutput

 Identifies an Amazon Kinesis data stream as the destination.
 


kinesisFirehoseOutput
KinesisFirehoseOutput kinesisFirehoseOutput

 Identifies an Amazon Kinesis Data Firehose delivery stream as the destination.
 


lambdaOutput
LambdaOutput lambdaOutput

 Identifies an AWS Lambda function as the destination.
 


destinationSchema
DestinationSchema destinationSchema

 Describes the data format when records are written to the destination.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.OutputDescription extends Object implements Serializable


Serialized Fields


outputId
String outputId

 A unique identifier for the output configuration.
 


name
String name

 The name of the in-application stream that is configured as output.
 


kinesisStreamsOutputDescription
KinesisStreamsOutputDescription kinesisStreamsOutputDescription

 Describes the Kinesis data stream that is configured as the destination where output is written.
 


kinesisFirehoseOutputDescription
KinesisFirehoseOutputDescription kinesisFirehoseOutputDescription

 Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is
 written.
 


lambdaOutputDescription
LambdaOutputDescription lambdaOutputDescription

 Describes the Lambda function that is configured as the destination where output is written.
 


destinationSchema
DestinationSchema destinationSchema

 The data format used for writing data to the destination.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.OutputUpdate extends Object implements Serializable


Serialized Fields


outputId
String outputId

 Identifies the specific output configuration that you want to update.
 


nameUpdate
String nameUpdate

 If you want to specify a different in-application stream for this output configuration, use this field to specify
 the new in-application stream name.
 


kinesisStreamsOutputUpdate
KinesisStreamsOutputUpdate kinesisStreamsOutputUpdate

 Describes a Kinesis data stream as the destination for the output.
 


kinesisFirehoseOutputUpdate
KinesisFirehoseOutputUpdate kinesisFirehoseOutputUpdate

 Describes a Kinesis Data Firehose delivery stream as the destination for the output.
 


lambdaOutputUpdate
LambdaOutputUpdate lambdaOutputUpdate

 Describes an AWS Lambda function as the destination for the output.
 


destinationSchemaUpdate
DestinationSchema destinationSchemaUpdate

 Describes the data format when records are written to the destination.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ParallelismConfiguration extends Object implements Serializable


Serialized Fields


configurationType
String configurationType

 Describes whether the application uses the default parallelism for the Kinesis Data Analytics service. You must
 set this property to CUSTOM in order to change your application's AutoScalingEnabled,
 Parallelism, or ParallelismPerKPU properties.
 


parallelism
Integer parallelism

 Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform.
 If AutoScalingEnabled is set to True, Kinesis Data Analytics increases the
 CurrentParallelism value in response to application load. The service can increase the
 CurrentParallelism value up to the maximum parallelism, which is ParalellismPerKPU
 times the maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be
 increased by requesting a limit increase. If application load is reduced, the service can reduce the
 CurrentParallelism value down to the Parallelism setting.
 


parallelismPerKPU
Integer parallelismPerKPU

 Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per
 Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.
 


autoScalingEnabled
Boolean autoScalingEnabled

 Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response
 to increased throughput.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ParallelismConfigurationDescription extends Object implements Serializable


Serialized Fields


configurationType
String configurationType

 Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.
 


parallelism
Integer parallelism

 Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform.
 If AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the
 CurrentParallelism value in response to application load. The service can increase
 CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the
 maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by
 requesting a limit increase. If application load is reduced, the service can reduce the
 CurrentParallelism value down to the Parallelism setting.
 


parallelismPerKPU
Integer parallelismPerKPU

 Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per
 Kinesis Processing Unit (KPU) used by the application.
 


currentParallelism
Integer currentParallelism

 Describes the current number of parallel tasks that a Java-based Kinesis Data Analytics application can perform.
 If AutoScalingEnabled is set to True, Kinesis Data Analytics can increase this value in response to
 application load. The service can increase this value up to the maximum parallelism, which is
 ParalellismPerKPU times the maximum KPUs for the application. The maximum KPUs for an application is
 32 by default, and can be increased by requesting a limit increase. If application load is reduced, the service
 can reduce the CurrentParallelism value down to the Parallelism setting.
 


autoScalingEnabled
Boolean autoScalingEnabled

 Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response
 to increased throughput.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ParallelismConfigurationUpdate extends Object implements Serializable


Serialized Fields


configurationTypeUpdate
String configurationTypeUpdate

 Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service,
 or if a custom parallelism is used. You must set this property to CUSTOM in order to change your
 application's AutoScalingEnabled, Parallelism, or ParallelismPerKPU
 properties.
 


parallelismUpdate
Integer parallelismUpdate

 Describes updates to the initial number of parallel tasks an application can perform. If
 AutoScalingEnabled is set to True, then Kinesis Data Analytics can increase the
 CurrentParallelism value in response to application load. The service can increase
 CurrentParallelism up to the maximum parallelism, which is ParalellismPerKPU times the
 maximum KPUs for the application. The maximum KPUs for an application is 32 by default, and can be increased by
 requesting a limit increase. If application load is reduced, the service will reduce
 CurrentParallelism down to the Parallelism setting.
 


parallelismPerKPUUpdate
Integer parallelismPerKPUUpdate

 Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU)
 used by the application.
 


autoScalingEnabledUpdate
Boolean autoScalingEnabledUpdate

 Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of the application
 in response to increased throughput.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.PropertyGroup extends Object implements Serializable


Serialized Fields


propertyGroupId
String propertyGroupId

 Describes the key of an application execution property key-value pair.
 


propertyMap
Map<K,V> propertyMap

 Describes the value of an application execution property key-value pair.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.RecordColumn extends Object implements Serializable


Serialized Fields


name
String name

 The name of the column that is created in the in-application input stream or reference table.
 


mapping
String mapping

 A reference to the data element in the streaming input or the reference data source.
 


sqlType
String sqlType

 The type of column created in the in-application input stream or reference table.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.RecordFormat extends Object implements Serializable


Serialized Fields


recordFormatType
String recordFormatType

 The type of record format.
 


mappingParameters
MappingParameters mappingParameters

 When you configure application input at the time of creating or updating an application, provides additional
 mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some
 delimiter) on the streaming source.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ReferenceDataSource extends Object implements Serializable


Serialized Fields


tableName
String tableName

 The name of the in-application table to create.
 


s3ReferenceDataSource
S3ReferenceDataSource s3ReferenceDataSource

 Identifies the S3 bucket and object that contains the reference data. A Kinesis Data Analytics application loads
 reference data only once. If the data changes, you call the UpdateApplication operation to trigger
 reloading of data into your application.
 


referenceSchema
SourceSchema referenceSchema

 Describes the format of the data in the streaming source, and how each data element maps to corresponding columns
 created in the in-application stream.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ReferenceDataSourceDescription extends Object implements Serializable


Serialized Fields


referenceId
String referenceId

 The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the
 reference data source to your application using the CreateApplication or UpdateApplication
 operation.
 


tableName
String tableName

 The in-application table name created by the specific reference data source configuration.
 


s3ReferenceDataSourceDescription
S3ReferenceDataSourceDescription s3ReferenceDataSourceDescription

 Provides the Amazon S3 bucket name, the object key name that contains the reference data.
 


referenceSchema
SourceSchema referenceSchema

 Describes the format of the data in the streaming source, and how each data element maps to corresponding columns
 created in the in-application stream.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ReferenceDataSourceUpdate extends Object implements Serializable


Serialized Fields


referenceId
String referenceId

 The ID of the reference data source that is being updated. You can use the DescribeApplication operation
 to get this value.
 


tableNameUpdate
String tableNameUpdate

 The in-application table name that is created by this update.
 


s3ReferenceDataSourceUpdate
S3ReferenceDataSourceUpdate s3ReferenceDataSourceUpdate

 Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the
 Amazon S3 object on your behalf and populate the in-application reference table.
 


referenceSchemaUpdate
SourceSchema referenceSchemaUpdate

 Describes the format of the data in the streaming source, and how each data element maps to corresponding columns
 created in the in-application stream.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ResourceInUseException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.ResourceNotFoundException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.ResourceProvisionedThroughputExceededException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.RunConfiguration extends Object implements Serializable


Serialized Fields


flinkRunConfiguration
FlinkRunConfiguration flinkRunConfiguration

 Describes the starting parameters for an Apache Flink-based Kinesis Data Analytics application.
 


sqlRunConfigurations
List<E> sqlRunConfigurations

 Describes the starting parameters for an SQL-based Kinesis Data Analytics application.
 


applicationRestoreConfiguration
ApplicationRestoreConfiguration applicationRestoreConfiguration

 Describes the restore behavior of a restarting application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.RunConfigurationDescription extends Object implements Serializable


Serialized Fields


applicationRestoreConfigurationDescription
ApplicationRestoreConfiguration applicationRestoreConfigurationDescription

 Describes the restore behavior of a restarting application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.RunConfigurationUpdate extends Object implements Serializable


Serialized Fields


flinkRunConfiguration
FlinkRunConfiguration flinkRunConfiguration

 Describes the starting parameters for an Apache Flink-based Kinesis Data Analytics application.
 


applicationRestoreConfiguration
ApplicationRestoreConfiguration applicationRestoreConfiguration

 Describes updates to the restore behavior of a restarting application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.S3ApplicationCodeLocationDescription extends Object implements Serializable


Serialized Fields


bucketARN
String bucketARN

 The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
 


fileKey
String fileKey

 The file key for the object containing the application code.
 


objectVersion
String objectVersion

 The version of the object containing the application code.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.S3Configuration extends Object implements Serializable


Serialized Fields


bucketARN
String bucketARN

 The ARN of the S3 bucket that contains the data.
 


fileKey
String fileKey

 The name of the object that contains the data.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.S3ContentLocation extends Object implements Serializable


Serialized Fields


bucketARN
String bucketARN

 The Amazon Resource Name (ARN) for the S3 bucket containing the application code.
 


fileKey
String fileKey

 The file key for the object containing the application code.
 


objectVersion
String objectVersion

 The version of the object containing the application code.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.S3ContentLocationUpdate extends Object implements Serializable


Serialized Fields


bucketARNUpdate
String bucketARNUpdate

 The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.
 


fileKeyUpdate
String fileKeyUpdate

 The new file key for the object containing the application code.
 


objectVersionUpdate
String objectVersionUpdate

 The new version of the object containing the application code.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.S3ReferenceDataSource extends Object implements Serializable


Serialized Fields


bucketARN
String bucketARN

 The Amazon Resource Name (ARN) of the S3 bucket.
 


fileKey
String fileKey

 The object key name containing the reference data.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.S3ReferenceDataSourceDescription extends Object implements Serializable


Serialized Fields


bucketARN
String bucketARN

 The Amazon Resource Name (ARN) of the S3 bucket.
 


fileKey
String fileKey

 Amazon S3 object key name.
 


referenceRoleARN
String referenceRoleARN

 The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to
 populate the in-application reference table.
 
 
 
 Provided for backward compatibility. Applications that are created with the current API version have an
 application-level service execution role rather than a resource-level role.
 
 








Class com.amazonaws.services.kinesisanalyticsv2.model.S3ReferenceDataSourceUpdate extends Object implements Serializable


Serialized Fields


bucketARNUpdate
String bucketARNUpdate

 The Amazon Resource Name (ARN) of the S3 bucket.
 


fileKeyUpdate
String fileKeyUpdate

 The object key name.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.ServiceUnavailableException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.SnapshotDetails extends Object implements Serializable


Serialized Fields


snapshotName
String snapshotName

 The identifier for the application snapshot.
 


snapshotStatus
String snapshotStatus

 The status of the application snapshot.
 


applicationVersionId
Long applicationVersionId

 The current application version ID when the snapshot was created.
 


snapshotCreationTimestamp
Date snapshotCreationTimestamp

 The timestamp of the application snapshot.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.SourceSchema extends Object implements Serializable


Serialized Fields


recordFormat
RecordFormat recordFormat

 Specifies the format of the records on the streaming source.
 


recordEncoding
String recordEncoding

 Specifies the encoding of the records in the streaming source. For example, UTF-8.
 


recordColumns
List<E> recordColumns

 A list of RecordColumn objects.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.SqlApplicationConfiguration extends Object implements Serializable


Serialized Fields


inputs
List<E> inputs

 The array of Input objects describing the input streams used by the application.
 


outputs
List<E> outputs

 The array of Output objects describing the destination streams used by the application.
 


referenceDataSources
List<E> referenceDataSources

 The array of ReferenceDataSource objects describing the reference data sources used by the application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.SqlApplicationConfigurationDescription extends Object implements Serializable


Serialized Fields


inputDescriptions
List<E> inputDescriptions

 The array of InputDescription objects describing the input streams used by the application.
 


outputDescriptions
List<E> outputDescriptions

 The array of OutputDescription objects describing the destination streams used by the application.
 


referenceDataSourceDescriptions
List<E> referenceDataSourceDescriptions

 The array of ReferenceDataSourceDescription objects describing the reference data sources used by the
 application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.SqlApplicationConfigurationUpdate extends Object implements Serializable


Serialized Fields


inputUpdates
List<E> inputUpdates

 The array of InputUpdate objects describing the new input streams used by the application.
 


outputUpdates
List<E> outputUpdates

 The array of OutputUpdate objects describing the new destination streams used by the application.
 


referenceDataSourceUpdates
List<E> referenceDataSourceUpdates

 The array of ReferenceDataSourceUpdate objects describing the new reference data sources used by the
 application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.SqlRunConfiguration extends Object implements Serializable


Serialized Fields


inputId
String inputId

 The input source ID. You can get this ID by calling the DescribeApplication operation.
 


inputStartingPositionConfiguration
InputStartingPositionConfiguration inputStartingPositionConfiguration

 The point at which you want the application to start processing records from the streaming source.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.StartApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application.
 


runConfiguration
RunConfiguration runConfiguration

 Identifies the run configuration (start parameters) of a Kinesis Data Analytics application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.StartApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalyticsv2.model.StopApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the running application to stop.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.StopApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalyticsv2.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key of the key-value tag.
 


value
String value

 The value of the key-value tag. The value is optional.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the application to assign the tags.
 


tags
List<E> tags

 The key-value tags to assign to the application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalyticsv2.model.TooManyTagsException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.UnableToDetectSchemaException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L



Serialized Fields


rawInputRecords
List<E> rawInputRecords

 Raw stream data that was sampled to infer the schema.
 


processedInputRecords
List<E> processedInputRecords

 Stream data that was modified by the processor specified in the InputProcessingConfiguration
 parameter.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.UnsupportedOperationException extends AmazonKinesisAnalyticsV2Exception implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisanalyticsv2.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the Kinesis Analytics application from which to remove the tags.
 


tagKeys
List<E> tagKeys

 A list of keys of tags to remove from the specified application.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisanalyticsv2.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationName
String applicationName

 The name of the application to update.
 


currentApplicationVersionId
Long currentApplicationVersionId

 The current application version ID. You can retrieve the application version ID using DescribeApplication.
 


applicationConfigurationUpdate
ApplicationConfigurationUpdate applicationConfigurationUpdate

 Describes application configuration updates.
 


serviceExecutionRoleUpdate
String serviceExecutionRoleUpdate

 Describes updates to the service execution role.
 


runConfigurationUpdate
RunConfigurationUpdate runConfigurationUpdate

 Describes updates to the application's starting parameters.
 


cloudWatchLoggingOptionUpdates
List<E> cloudWatchLoggingOptionUpdates

 Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging
 options with this action. To add a new CloudWatch logging option, use
 AddApplicationCloudWatchLoggingOption.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.UpdateApplicationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationDetail
ApplicationDetail applicationDetail

 Describes application updates.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.VpcConfiguration extends Object implements Serializable


Serialized Fields


subnetIds
List<E> subnetIds

 The array of Subnet IDs used
 by the VPC configuration.
 


securityGroupIds
List<E> securityGroupIds

 The array of SecurityGroup IDs used
 by the VPC configuration.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.VpcConfigurationDescription extends Object implements Serializable


Serialized Fields


vpcConfigurationId
String vpcConfigurationId

 The ID of the VPC configuration.
 


vpcId
String vpcId

 The ID of the associated VPC.
 


subnetIds
List<E> subnetIds

 The array of Subnet IDs used
 by the VPC configuration.
 


securityGroupIds
List<E> securityGroupIds

 The array of SecurityGroup IDs used
 by the VPC configuration.
 








Class com.amazonaws.services.kinesisanalyticsv2.model.VpcConfigurationUpdate extends Object implements Serializable


Serialized Fields


vpcConfigurationId
String vpcConfigurationId

 Describes an update to the ID of the VPC configuration.
 


subnetIdUpdates
List<E> subnetIdUpdates

 Describes updates to the array of Subnet IDs used by the VPC
 configuration.
 


securityGroupIdUpdates
List<E> securityGroupIdUpdates

 Describes updates to the array of SecurityGroup IDs used
 by the VPC configuration.
 








Package com.amazonaws.services.kinesisfirehose.model




Class com.amazonaws.services.kinesisfirehose.model.AmazonKinesisFirehoseException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.BufferingHints extends Object implements Serializable


Serialized Fields


sizeInMBs
Integer sizeInMBs

 Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value
 is 5. This parameter is optional but if you specify a value for it, you must also specify a value for
 IntervalInSeconds, and vice versa.
 
 
 We recommend setting this parameter 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 MiB/sec, the value should be 10 MiB
 or higher.
 


intervalInSeconds
Integer intervalInSeconds

 Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The
 default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value
 for SizeInMBs, and vice versa.
 








Class com.amazonaws.services.kinesisfirehose.model.CloudWatchLoggingOptions extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Enables or disables CloudWatch logging.
 


logGroupName
String logGroupName

 The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
 


logStreamName
String logStreamName

 The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
 








Class com.amazonaws.services.kinesisfirehose.model.ConcurrentModificationException extends AmazonKinesisFirehoseException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.CopyCommand extends Object implements Serializable


Serialized Fields


dataTableName
String dataTableName

 The name of the target table. The table must already exist in the database.
 


dataTableColumns
String dataTableColumns

 A comma-separated list of column names.
 


copyOptions
String copyOptions

 Optional parameters to use with the Amazon Redshift COPY command. For more information, see the
 "Optional Parameters" section of Amazon
 Redshift COPY command. Some possible examples that would apply to Kinesis Data Firehose are as follows:
 
 
 delimiter '\t' lzop; - fields are delimited with "\t" (TAB character) and compressed using lzop.
 
 
 delimiter '|' - fields are delimited with "|" (this is the default delimiter).
 
 
 delimiter '|' escape - the delimiter should be escaped.
 
 
 fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width
 in the source, with each width specified after every column in the table.
 
 
 JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of
 the data.
 
 
 For more examples, see Amazon Redshift COPY command
 examples.
 








Class com.amazonaws.services.kinesisfirehose.model.CreateDeliveryStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream. This name must be unique per AWS account in the same AWS Region. If the delivery
 streams are in different accounts or different Regions, you can have multiple delivery streams with the same
 name.
 


deliveryStreamType
String deliveryStreamType

 The delivery stream type. This parameter can be one of the following values:
 
 
 
 
 DirectPut: Provider applications access the delivery stream directly.
 
 
 
 
 KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.
 
 
 


kinesisStreamSourceConfiguration
KinesisStreamSourceConfiguration kinesisStreamSourceConfiguration

 When a Kinesis data stream is used as the source for the delivery stream, a
 KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the
 role ARN for the source stream.
 


deliveryStreamEncryptionConfigurationInput
DeliveryStreamEncryptionConfigurationInput deliveryStreamEncryptionConfigurationInput

 Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
 


s3DestinationConfiguration
S3DestinationConfiguration s3DestinationConfiguration
Deprecated. 

 [Deprecated] The destination in Amazon S3. You can specify only one destination.
 


extendedS3DestinationConfiguration
ExtendedS3DestinationConfiguration extendedS3DestinationConfiguration

 The destination in Amazon S3. You can specify only one destination.
 


redshiftDestinationConfiguration
RedshiftDestinationConfiguration redshiftDestinationConfiguration

 The destination in Amazon Redshift. You can specify only one destination.
 


elasticsearchDestinationConfiguration
ElasticsearchDestinationConfiguration elasticsearchDestinationConfiguration

 The destination in Amazon ES. You can specify only one destination.
 


splunkDestinationConfiguration
SplunkDestinationConfiguration splunkDestinationConfiguration

 The destination in Splunk. You can specify only one destination.
 


tags
List<E> tags

 A set of tags to assign to the delivery stream. A tag is a key-value pair that you can define and assign to AWS
 resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of
 information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation
 Tags in the AWS Billing and Cost Management User Guide.
 
 
 You can specify up to 50 tags when creating a delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.CreateDeliveryStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deliveryStreamARN
String deliveryStreamARN

 The ARN of the delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.DataFormatConversionConfiguration extends Object implements Serializable


Serialized Fields


schemaConfiguration
SchemaConfiguration schemaConfiguration

 Specifies the AWS Glue Data Catalog table that contains the column information.
 


inputFormatConfiguration
InputFormatConfiguration inputFormatConfiguration

 Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from
 JSON.
 


outputFormatConfiguration
OutputFormatConfiguration outputFormatConfiguration

 Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the
 Parquet or ORC format.
 


enabled
Boolean enabled

 Defaults to true. Set it to false if you want to disable format conversion while
 preserving the configuration details.
 








Class com.amazonaws.services.kinesisfirehose.model.DeleteDeliveryStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


allowForceDelete
Boolean allowForceDelete

 Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the
 grant for the CMK. Kinesis Data Firehose might be unable to retire the grant due to a customer error, such as
 when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to
 revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant happens due to an AWS KMS
 issue, Kinesis Data Firehose keeps retrying the delete operation.
 
 
 The default value is false.
 








Class com.amazonaws.services.kinesisfirehose.model.DeleteDeliveryStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisfirehose.model.DeliveryStreamDescription extends Object implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


deliveryStreamARN
String deliveryStreamARN

 The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


deliveryStreamStatus
String deliveryStreamStatus

 The status of the delivery stream. If the status of a delivery stream is CREATING_FAILED, this
 status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can
 invoke the DeleteDeliveryStream operation to delete it.
 


failureDescription
FailureDescription failureDescription

 Provides details in case one of the following operations fails due to an error related to KMS:
 CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption,
 StopDeliveryStreamEncryption.
 


deliveryStreamEncryptionConfiguration
DeliveryStreamEncryptionConfiguration deliveryStreamEncryptionConfiguration

 Indicates the server-side encryption (SSE) status for the delivery stream.
 


deliveryStreamType
String deliveryStreamType

 The delivery stream type. This can be one of the following values:
 
 
 
 
 DirectPut: Provider applications access the delivery stream directly.
 
 
 
 
 KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.
 
 
 


versionId
String versionId

 Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID
 is required when updating the destination. This is so that the service knows it is applying the changes to the
 correct version of the delivery stream.
 


createTimestamp
Date createTimestamp

 The date and time that the delivery stream was created.
 


lastUpdateTimestamp
Date lastUpdateTimestamp

 The date and time that the delivery stream was last updated.
 


source
SourceDescription source

 If the DeliveryStreamType parameter is KinesisStreamAsSource, a
 SourceDescription object describing the source Kinesis data stream.
 


destinations
List<E> destinations

 The destinations.
 


hasMoreDestinations
Boolean hasMoreDestinations

 Indicates whether there are more destinations available to list.
 








Class com.amazonaws.services.kinesisfirehose.model.DeliveryStreamEncryptionConfiguration extends Object implements Serializable


Serialized Fields


keyARN
String keyARN

 If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed
 CMK. If KeyType is AWS_OWNED_CMK, DeliveryStreamEncryptionConfiguration
 doesn't contain a value for KeyARN.
 


keyType
String keyType

 Indicates the type of customer master key (CMK) that is used for encryption. The default setting is
 AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys
 (CMKs).
 


status
String status

 This is the server-side encryption (SSE) status for the delivery stream. For a full description of the different
 values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption. If this
 status is ENABLING_FAILED or DISABLING_FAILED, it is the status of the most recent
 attempt to enable or disable SSE, respectively.
 


failureDescription
FailureDescription failureDescription

 Provides details in case one of the following operations fails due to an error related to KMS:
 CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption,
 StopDeliveryStreamEncryption.
 








Class com.amazonaws.services.kinesisfirehose.model.DeliveryStreamEncryptionConfigurationInput extends Object implements Serializable


Serialized Fields


keyARN
String keyARN

 If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name
 (ARN) of the CMK. If you set KeyType to AWS_OWNED_CMK, Kinesis Data Firehose uses a
 service-account CMK.
 


keyType
String keyType

 Indicates the type of customer master key (CMK) to use for encryption. The default setting is
 AWS_OWNED_CMK. For more information about CMKs, see Customer Master Keys
 (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with
 KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant
 that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and
 decryption. Kinesis Data Firehose manages that grant.
 
 
 When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is already
 encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for
 retirement.
 








Class com.amazonaws.services.kinesisfirehose.model.DescribeDeliveryStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


limit
Integer limit

 The limit on the number of destinations to return. You can have one destination per delivery stream.
 


exclusiveStartDestinationId
String exclusiveStartDestinationId

 The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one
 destination per delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.DescribeDeliveryStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deliveryStreamDescription
DeliveryStreamDescription deliveryStreamDescription

 Information about the delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.Deserializer extends Object implements Serializable


Serialized Fields


openXJsonSerDe
OpenXJsonSerDe openXJsonSerDe

 The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON
 format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can
 choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog
 JsonSerDe.
 


hiveJsonSerDe
HiveJsonSerDe hiveJsonSerDe

 The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means
 converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of
 two deserializers you can choose, depending on which one offers the functionality you need. The other option is
 the OpenX SerDe.
 








Class com.amazonaws.services.kinesisfirehose.model.DestinationDescription extends Object implements Serializable


Serialized Fields


destinationId
String destinationId

 The ID of the destination.
 


s3DestinationDescription
S3DestinationDescription s3DestinationDescription

 [Deprecated] The destination in Amazon S3.
 


extendedS3DestinationDescription
ExtendedS3DestinationDescription extendedS3DestinationDescription

 The destination in Amazon S3.
 


redshiftDestinationDescription
RedshiftDestinationDescription redshiftDestinationDescription

 The destination in Amazon Redshift.
 


elasticsearchDestinationDescription
ElasticsearchDestinationDescription elasticsearchDestinationDescription

 The destination in Amazon ES.
 


splunkDestinationDescription
SplunkDestinationDescription splunkDestinationDescription

 The destination in Splunk.
 








Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchBufferingHints extends Object implements Serializable


Serialized Fields


intervalInSeconds
Integer intervalInSeconds

 Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The
 default value is 300 (5 minutes).
 


sizeInMBs
Integer sizeInMBs

 Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is
 5.
 
 
 We recommend setting this parameter 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, the value should be 10 MB
 or higher.
 








Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchDestinationConfiguration extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES
 Configuration API and for indexing documents. For more information, see Grant Kinesis Data
 Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


domainARN
String domainARN

 The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain,
 DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the
 role specified in RoleARN. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 
 
 Specify either ClusterEndpoint or DomainARN.
 


clusterEndpoint
String clusterEndpoint

 The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the
 DomainARN field.
 


indexName
String indexName

 The Elasticsearch index name.
 


typeName
String typeName

 The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a
 new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run
 time.
 
 
 For Elasticsearch 7.x, don't specify a TypeName.
 


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
 the Amazon ES Destination. The default value is OneDay.
 


bufferingHints
ElasticsearchBufferingHints bufferingHints

 The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints
 are used.
 


retryOptions
ElasticsearchRetryOptions retryOptions

 The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value
 is 300 (5 minutes).
 


s3BackupMode
String s3BackupMode

 Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly,
 Kinesis Data 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,
 Kinesis Data 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 the
 Amazon ES Destination. Default value is FailedDocumentsOnly.
 


s3Configuration
S3DestinationConfiguration s3Configuration

 The configuration for the backup Amazon S3 location.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 The data processing configuration.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The Amazon CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchDestinationDescription extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


domainARN
String domainARN

 The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 
 
 Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon
 ES.
 


clusterEndpoint
String clusterEndpoint

 The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this
 ClusterEndpoint or the DomainARN field to send data to Amazon ES.
 


indexName
String indexName

 The Elasticsearch index name.
 


typeName
String typeName

 The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x, there's
 no value for TypeName.
 


indexRotationPeriod
String indexRotationPeriod

 The Elasticsearch index rotation period
 


bufferingHints
ElasticsearchBufferingHints bufferingHints

 The buffering options.
 


retryOptions
ElasticsearchRetryOptions retryOptions

 The Amazon ES retry options.
 


s3BackupMode
String s3BackupMode

 The Amazon S3 backup mode.
 


s3DestinationDescription
S3DestinationDescription s3DestinationDescription

 The Amazon S3 destination.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 The data processing configuration.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The Amazon CloudWatch logging options.
 








Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchDestinationUpdate extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES
 Configuration API and for indexing documents. For more information, see Grant Kinesis Data
 Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


domainARN
String domainARN

 The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain,
 DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the
 IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 
 
 Specify either ClusterEndpoint or DomainARN.
 


clusterEndpoint
String clusterEndpoint

 The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the
 DomainARN field.
 


indexName
String indexName

 The Elasticsearch index name.
 


typeName
String typeName

 The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a
 new type for an existing index that already has another type, Kinesis Data Firehose returns an error during
 runtime.
 
 
 If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still
 delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream
 with a new index name, provide an empty string for TypeName.
 


indexRotationPeriod
String indexRotationPeriod

 The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to
 facilitate the expiration of old data. For more information, see Index Rotation for
 the Amazon ES Destination. Default value is OneDay.
 


bufferingHints
ElasticsearchBufferingHints bufferingHints

 The buffering options. If no value is specified, ElasticsearchBufferingHints object default values
 are used.
 


retryOptions
ElasticsearchRetryOptions retryOptions

 The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value
 is 300 (5 minutes).
 


s3Update
S3DestinationUpdate s3Update

 The Amazon S3 destination.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 The data processing configuration.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchRetryOptions extends Object implements Serializable


Serialized Fields


durationInSeconds
Integer durationInSeconds

 After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose
 retries 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 extends Object implements Serializable


Serialized Fields


noEncryptionConfig
String noEncryptionConfig

 Specifically override existing encryption information to ensure that no encryption is used.
 


kMSEncryptionConfig
KMSEncryptionConfig kMSEncryptionConfig

 The encryption key.
 








Class com.amazonaws.services.kinesisfirehose.model.ExtendedS3DestinationConfiguration extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


bucketARN
String bucketARN

 The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


prefix
String prefix

 The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify
 a custom prefix, as described in Custom Prefixes for Amazon S3
 Objects.
 


errorOutputPrefix
String errorOutputPrefix

 A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix
 appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3
 Objects.
 


bufferingHints
BufferingHints bufferingHints

 The buffering option.
 


compressionFormat
String compressionFormat

 The compression format. If no value is specified, the default is UNCOMPRESSED.
 


encryptionConfiguration
EncryptionConfiguration encryptionConfiguration

 The encryption configuration. If no value is specified, the default is no encryption.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The Amazon CloudWatch logging options for your delivery stream.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 The data processing configuration.
 


s3BackupMode
String s3BackupMode

 The Amazon S3 backup mode.
 


s3BackupConfiguration
S3DestinationConfiguration s3BackupConfiguration

 The configuration for backup in Amazon S3.
 


dataFormatConversionConfiguration
DataFormatConversionConfiguration dataFormatConversionConfiguration

 The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format
 before writing it to Amazon S3.
 








Class com.amazonaws.services.kinesisfirehose.model.ExtendedS3DestinationDescription extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


bucketARN
String bucketARN

 The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


prefix
String prefix

 The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify
 a custom prefix, as described in Custom Prefixes for Amazon S3
 Objects.
 


errorOutputPrefix
String errorOutputPrefix

 A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix
 appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3
 Objects.
 


bufferingHints
BufferingHints bufferingHints

 The buffering option.
 


compressionFormat
String compressionFormat

 The compression format. If no value is specified, the default is UNCOMPRESSED.
 


encryptionConfiguration
EncryptionConfiguration encryptionConfiguration

 The encryption configuration. If no value is specified, the default is no encryption.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The Amazon CloudWatch logging options for your delivery stream.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 The data processing configuration.
 


s3BackupMode
String s3BackupMode

 The Amazon S3 backup mode.
 


s3BackupDescription
S3DestinationDescription s3BackupDescription

 The configuration for backup in Amazon S3.
 


dataFormatConversionConfiguration
DataFormatConversionConfiguration dataFormatConversionConfiguration

 The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format
 before writing it to Amazon S3.
 








Class com.amazonaws.services.kinesisfirehose.model.ExtendedS3DestinationUpdate extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


bucketARN
String bucketARN

 The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


prefix
String prefix

 The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify
 a custom prefix, as described in Custom Prefixes for Amazon S3
 Objects.
 


errorOutputPrefix
String errorOutputPrefix

 A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix
 appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3
 Objects.
 


bufferingHints
BufferingHints bufferingHints

 The buffering option.
 


compressionFormat
String compressionFormat

 The compression format. If no value is specified, the default is UNCOMPRESSED.
 


encryptionConfiguration
EncryptionConfiguration encryptionConfiguration

 The encryption configuration. If no value is specified, the default is no encryption.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The Amazon CloudWatch logging options for your delivery stream.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 The data processing configuration.
 


s3BackupMode
String s3BackupMode

 Enables or disables Amazon S3 backup mode.
 


s3BackupUpdate
S3DestinationUpdate s3BackupUpdate

 The Amazon S3 destination for backup.
 


dataFormatConversionConfiguration
DataFormatConversionConfiguration dataFormatConversionConfiguration

 The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format
 before writing it to Amazon S3.
 








Class com.amazonaws.services.kinesisfirehose.model.FailureDescription extends Object implements Serializable


Serialized Fields


type
String type

 The type of error that caused the failure.
 


details
String details

 A message providing details about the error that caused the failure.
 








Class com.amazonaws.services.kinesisfirehose.model.HiveJsonSerDe extends Object implements Serializable


Serialized Fields


timestampFormats
List<E> timestampFormats

 Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input
 data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format
 strings. For more information, see Class DateTimeFormat.
 You can also use the special value millis to parse timestamps in epoch milliseconds. If you don't
 specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.
 








Class com.amazonaws.services.kinesisfirehose.model.InputFormatConfiguration extends Object implements Serializable


Serialized Fields


deserializer
Deserializer deserializer

 Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If
 both are non-null, the server rejects the request.
 








Class com.amazonaws.services.kinesisfirehose.model.InvalidArgumentException extends AmazonKinesisFirehoseException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.InvalidKMSResourceException extends AmazonKinesisFirehoseException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code








Class com.amazonaws.services.kinesisfirehose.model.KinesisStreamSourceConfiguration extends Object implements Serializable


Serialized Fields


kinesisStreamARN
String kinesisStreamARN

 The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.
 


roleARN
String roleARN

 The ARN of the role that provides access to the source Kinesis data stream. For more information, see AWS Identity and
 Access Management (IAM) ARN Format.
 








Class com.amazonaws.services.kinesisfirehose.model.KinesisStreamSourceDescription extends Object implements Serializable


Serialized Fields


kinesisStreamARN
String kinesisStreamARN

 The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.
 


roleARN
String roleARN

 The ARN of the role used by the source Kinesis data stream. For more information, see AWS Identity and
 Access Management (IAM) ARN Format.
 


deliveryStartTimestamp
Date deliveryStartTimestamp

 Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.
 








Class com.amazonaws.services.kinesisfirehose.model.KMSEncryptionConfig extends Object implements Serializable


Serialized Fields


aWSKMSKeyARN
String aWSKMSKeyARN

 The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination
 Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 








Class com.amazonaws.services.kinesisfirehose.model.LimitExceededException extends AmazonKinesisFirehoseException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.ListDeliveryStreamsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


limit
Integer limit

 The maximum number of delivery streams to list. The default value is 10.
 


deliveryStreamType
String deliveryStreamType

 The delivery stream type. This can be one of the following values:
 
 
 
 
 DirectPut: Provider applications access the delivery stream directly.
 
 
 
 
 KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.
 
 
 
 
 This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.
 


exclusiveStartDeliveryStreamName
String exclusiveStartDeliveryStreamName

 The list of delivery streams returned by this call to ListDeliveryStreams will start with the
 delivery stream whose name comes alphabetically immediately after the name you specify in
 ExclusiveStartDeliveryStreamName.
 








Class com.amazonaws.services.kinesisfirehose.model.ListDeliveryStreamsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deliveryStreamNames
List<E> deliveryStreamNames

 The names of the delivery streams.
 


hasMoreDeliveryStreams
Boolean hasMoreDeliveryStreams

 Indicates whether there are more delivery streams available to list.
 








Class com.amazonaws.services.kinesisfirehose.model.ListTagsForDeliveryStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream whose tags you want to list.
 


exclusiveStartTagKey
String exclusiveStartTagKey

 The key to use as the starting point for the list of tags. If you set this parameter,
 ListTagsForDeliveryStream 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 delivery
 stream, HasMoreTags is set to true in the response. To list additional tags, set
 ExclusiveStartTagKey to the last key in the response.
 








Class com.amazonaws.services.kinesisfirehose.model.ListTagsForDeliveryStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 A list of tags associated with DeliveryStreamName, starting with the first tag after
 ExclusiveStartTagKey and up to the specified Limit.
 


hasMoreTags
Boolean hasMoreTags

 If this is true in the response, more tags are available. To list the remaining tags, set
 ExclusiveStartTagKey to the key of the last tag returned and call
 ListTagsForDeliveryStream again.
 








Class com.amazonaws.services.kinesisfirehose.model.OpenXJsonSerDe extends Object implements Serializable


Serialized Fields


convertDotsInJsonKeysToUnderscores
Boolean convertDotsInJsonKeysToUnderscores

 When set to true, specifies that the names of the keys include dots and that you want Kinesis Data
 Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column
 names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b"
 when using this option.
 
 
 The default is false.
 


caseInsensitive
Boolean caseInsensitive

 When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before
 deserializing them.
 


columnToJsonKeyMappings
Map<K,V> columnToJsonKeyMappings

 Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains
 keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named
 timestamp, set this parameter to {"ts": "timestamp"} to map this key to a column named
 ts.
 








Class com.amazonaws.services.kinesisfirehose.model.OrcSerDe extends Object implements Serializable


Serialized Fields


stripeSizeBytes
Integer stripeSizeBytes

 The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.
 


blockSizeBytes
Integer blockSizeBytes

 The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon
 S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this
 value for padding calculations.
 


rowIndexStride
Integer rowIndexStride

 The number of rows between index entries. The default is 10,000 and the minimum is 1,000.
 


enablePadding
Boolean enablePadding

 Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This
 is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is
 false.
 


paddingTolerance
Double paddingTolerance

 A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The
 default value is 0.05, which means 5 percent of stripe size.
 
 
 For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5
 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size
 within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures
 that no stripe crosses block boundaries and causes remote reads within a node-local task.
 
 
 Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false.
 


compression
String compression

 The compression code to use over data blocks. The default is SNAPPY.
 


bloomFilterColumns
List<E> bloomFilterColumns

 The column names for which you want Kinesis Data Firehose to create bloom filters. The default is
 null.
 


bloomFilterFalsePositiveProbability
Double bloomFilterFalsePositiveProbability

 The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default
 value is 0.05, the minimum is 0, and the maximum is 1.
 


dictionaryKeyThreshold
Double dictionaryKeyThreshold

 Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction
 to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set
 this threshold to 1.
 


formatVersion
String formatVersion

 The version of the file to write. The possible values are V0_11 and V0_12. The default
 is V0_12.
 








Class com.amazonaws.services.kinesisfirehose.model.OutputFormatConfiguration extends Object implements Serializable


Serialized Fields


serializer
Serializer serializer

 Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are
 non-null, the server rejects the request.
 








Class com.amazonaws.services.kinesisfirehose.model.ParquetSerDe extends Object implements Serializable


Serialized Fields


blockSizeBytes
Integer blockSizeBytes

 The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon
 S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this
 value for padding calculations.
 


pageSizeBytes
Integer pageSizeBytes

 The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms
 of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.
 


compression
String compression

 The compression code to use over data blocks. The possible values are UNCOMPRESSED,
 SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY
 for higher decompression speed. Use GZIP if the compression ratio is more important than speed.
 


enableDictionaryCompression
Boolean enableDictionaryCompression

 Indicates whether to enable dictionary compression.
 


maxPaddingBytes
Integer maxPaddingBytes

 The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS
 before querying. The default is 0.
 


writerVersion
String writerVersion

 Indicates the version of row format to output. The possible values are V1 and V2. The
 default is V1.
 








Class com.amazonaws.services.kinesisfirehose.model.ProcessingConfiguration extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Enables or disables data processing.
 


processors
List<E> processors

 The data processors.
 








Class com.amazonaws.services.kinesisfirehose.model.Processor extends Object implements Serializable


Serialized Fields


type
String type

 The type of processor.
 


parameters
List<E> parameters

 The processor parameters.
 








Class com.amazonaws.services.kinesisfirehose.model.ProcessorParameter extends Object implements Serializable


Serialized Fields


parameterName
String parameterName

 The name of the parameter.
 


parameterValue
String parameterValue

 The parameter value.
 








Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


records
List<E> records

 One or more records.
 








Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchResponseEntry extends Object implements Serializable


Serialized Fields


recordId
String recordId

 The ID of the record.
 


errorCode
String errorCode

 The error code for an individual record result.
 


errorMessage
String errorMessage

 The error message for an individual record result.
 








Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedPutCount
Integer failedPutCount

 The number of records that might have failed processing. This number might be greater than 0 even if the
 PutRecordBatch call succeeds. Check FailedPutCount to determine whether there are records
 that you need to resend.
 


encrypted
Boolean encrypted

 Indicates whether server-side encryption (SSE) was enabled during this operation.
 


requestResponses
List<E> requestResponses

 The results array. For each record, the index of the response element is the same as the index used in the
 request array.
 








Class com.amazonaws.services.kinesisfirehose.model.PutRecordRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


record
Record record

 The record.
 








Class com.amazonaws.services.kinesisfirehose.model.PutRecordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


recordId
String recordId

 The ID of the record.
 


encrypted
Boolean encrypted

 Indicates whether server-side encryption (SSE) was enabled during this operation.
 








Class com.amazonaws.services.kinesisfirehose.model.Record extends Object implements Serializable


Serialized Fields


data
ByteBuffer data

 The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before
 base64-encoding, is 1,000 KiB.
 








Class com.amazonaws.services.kinesisfirehose.model.RedshiftDestinationConfiguration extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


clusterJDBCURL
String clusterJDBCURL

 The database connection string.
 


copyCommand
CopyCommand copyCommand

 The COPY command.
 


username
String username

 The name of the user.
 


password
String password

 The user password.
 


retryOptions
RedshiftRetryOptions retryOptions

 The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value
 is 3600 (60 minutes).
 


s3Configuration
S3DestinationConfiguration s3Configuration

 The configuration for the intermediate Amazon S3 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.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 The data processing configuration.
 


s3BackupMode
String s3BackupMode

 The Amazon S3 backup mode.
 


s3BackupConfiguration
S3DestinationConfiguration s3BackupConfiguration

 The configuration for backup in Amazon S3.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.RedshiftDestinationDescription extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


clusterJDBCURL
String clusterJDBCURL

 The database connection string.
 


copyCommand
CopyCommand copyCommand

 The COPY command.
 


username
String username

 The name of the user.
 


retryOptions
RedshiftRetryOptions retryOptions

 The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value
 is 3600 (60 minutes).
 


s3DestinationDescription
S3DestinationDescription s3DestinationDescription

 The Amazon S3 destination.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 The data processing configuration.
 


s3BackupMode
String s3BackupMode

 The Amazon S3 backup mode.
 


s3BackupDescription
S3DestinationDescription s3BackupDescription

 The configuration for backup in Amazon S3.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The Amazon CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.RedshiftDestinationUpdate extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


clusterJDBCURL
String clusterJDBCURL

 The database connection string.
 


copyCommand
CopyCommand copyCommand

 The COPY command.
 


username
String username

 The name of the user.
 


password
String password

 The user password.
 


retryOptions
RedshiftRetryOptions retryOptions

 The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value
 is 3600 (60 minutes).
 


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.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 The data processing configuration.
 


s3BackupMode
String s3BackupMode

 The Amazon S3 backup mode.
 


s3BackupUpdate
S3DestinationUpdate s3BackupUpdate

 The Amazon S3 destination for backup.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The Amazon CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.RedshiftRetryOptions extends Object implements Serializable


Serialized Fields


durationInSeconds
Integer durationInSeconds

 The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial
 request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Data Firehose
 does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes
 longer than the current value.
 








Class com.amazonaws.services.kinesisfirehose.model.ResourceInUseException extends AmazonKinesisFirehoseException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.ResourceNotFoundException extends AmazonKinesisFirehoseException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.S3DestinationConfiguration extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


bucketARN
String bucketARN

 The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


prefix
String prefix

 The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify
 a custom prefix, as described in Custom Prefixes for Amazon S3
 Objects.
 


errorOutputPrefix
String errorOutputPrefix

 A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix
 appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3
 Objects.
 


bufferingHints
BufferingHints bufferingHints

 The buffering option. If no value is specified, BufferingHints object default values are used.
 


compressionFormat
String compressionFormat

 The compression format. If no value is specified, the default is UNCOMPRESSED.
 
 
 The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift
 destinations because they are not supported by the Amazon Redshift COPY operation that reads from
 the S3 bucket.
 


encryptionConfiguration
EncryptionConfiguration encryptionConfiguration

 The encryption configuration. If no value is specified, the default is no encryption.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.S3DestinationDescription extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


bucketARN
String bucketARN

 The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


prefix
String prefix

 The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify
 a custom prefix, as described in Custom Prefixes for Amazon S3
 Objects.
 


errorOutputPrefix
String errorOutputPrefix

 A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix
 appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3
 Objects.
 


bufferingHints
BufferingHints bufferingHints

 The buffering option. If no value is specified, BufferingHints object default values are used.
 


compressionFormat
String compressionFormat

 The compression format. If no value is specified, the default is UNCOMPRESSED.
 


encryptionConfiguration
EncryptionConfiguration encryptionConfiguration

 The encryption configuration. If no value is specified, the default is no encryption.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The Amazon CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.S3DestinationUpdate extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


bucketARN
String bucketARN

 The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs)
 and AWS Service Namespaces.
 


prefix
String prefix

 The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered Amazon S3 files. You can also specify
 a custom prefix, as described in Custom Prefixes for Amazon S3
 Objects.
 


errorOutputPrefix
String errorOutputPrefix

 A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix
 appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3
 Objects.
 


bufferingHints
BufferingHints bufferingHints

 The buffering option. If no value is specified, BufferingHints object default values are used.
 


compressionFormat
String compressionFormat

 The compression format. If no value is specified, the default is UNCOMPRESSED.
 
 
 The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift
 destinations because they are not supported by the Amazon Redshift COPY operation that reads from
 the S3 bucket.
 


encryptionConfiguration
EncryptionConfiguration encryptionConfiguration

 The encryption configuration. If no value is specified, the default is no encryption.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.SchemaConfiguration extends Object implements Serializable


Serialized Fields


roleARN
String roleARN

 The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for
 Kinesis Data Firehose. Cross-account roles aren't allowed.
 


catalogId
String catalogId

 The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.
 


databaseName
String databaseName

 Specifies the name of the AWS Glue database that contains the schema for the output data.
 


tableName
String tableName

 Specifies the AWS Glue table that contains the column information that constitutes your data schema.
 


region
String region

 If you don't specify an AWS Region, the default is the current Region.
 


versionId
String versionId

 Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to
 LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table
 are automatically picked up.
 








Class com.amazonaws.services.kinesisfirehose.model.Serializer extends Object implements Serializable


Serialized Fields


parquetSerDe
ParquetSerDe parquetSerDe

 A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more
 information, see Apache Parquet.
 


orcSerDe
OrcSerDe orcSerDe

 A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information,
 see Apache ORC.
 








Class com.amazonaws.services.kinesisfirehose.model.ServiceUnavailableException extends AmazonKinesisFirehoseException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.SourceDescription extends Object implements Serializable


Serialized Fields


kinesisStreamSourceDescription
KinesisStreamSourceDescription kinesisStreamSourceDescription

 The KinesisStreamSourceDescription value for the source Kinesis data stream.
 








Class com.amazonaws.services.kinesisfirehose.model.SplunkDestinationConfiguration extends Object implements Serializable


Serialized Fields


hECEndpoint
String hECEndpoint

 The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
 


hECEndpointType
String hECEndpointType

 This type can be either "Raw" or "Event."
 


hECToken
String hECToken

 This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
 


hECAcknowledgmentTimeoutInSeconds
Integer hECAcknowledgmentTimeoutInSeconds

 The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it
 data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it
 an error, based on your retry settings.
 


retryOptions
SplunkRetryOptions retryOptions

 The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an
 acknowledgment of receipt from Splunk.
 


s3BackupMode
String s3BackupMode

 Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis
 Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to
 AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes
 failed documents to Amazon S3. Default value is FailedDocumentsOnly.
 


s3Configuration
S3DestinationConfiguration s3Configuration

 The configuration for the backup Amazon S3 location.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 The data processing configuration.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The Amazon CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.SplunkDestinationDescription extends Object implements Serializable


Serialized Fields


hECEndpoint
String hECEndpoint

 The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
 


hECEndpointType
String hECEndpointType

 This type can be either "Raw" or "Event."
 


hECToken
String hECToken

 A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
 


hECAcknowledgmentTimeoutInSeconds
Integer hECAcknowledgmentTimeoutInSeconds

 The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it
 data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it
 an error, based on your retry settings.
 


retryOptions
SplunkRetryOptions retryOptions

 The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an
 acknowledgment of receipt from Splunk.
 


s3BackupMode
String s3BackupMode

 Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis
 Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to
 AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes
 failed documents to Amazon S3. Default value is FailedDocumentsOnly.
 


s3DestinationDescription
S3DestinationDescription s3DestinationDescription

 The Amazon S3 destination.>
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 The data processing configuration.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The Amazon CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.SplunkDestinationUpdate extends Object implements Serializable


Serialized Fields


hECEndpoint
String hECEndpoint

 The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
 


hECEndpointType
String hECEndpointType

 This type can be either "Raw" or "Event."
 


hECToken
String hECToken

 A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
 


hECAcknowledgmentTimeoutInSeconds
Integer hECAcknowledgmentTimeoutInSeconds

 The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data.
 At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an
 error, based on your retry settings.
 


retryOptions
SplunkRetryOptions retryOptions

 The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an
 acknowledgment of receipt from Splunk.
 


s3BackupMode
String s3BackupMode

 Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis
 Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to
 AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes
 failed documents to Amazon S3. Default value is FailedDocumentsOnly.
 


s3Update
S3DestinationUpdate s3Update

 Your update to the configuration of the backup Amazon S3 location.
 


processingConfiguration
ProcessingConfiguration processingConfiguration

 The data processing configuration.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 The Amazon CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.SplunkRetryOptions extends Object implements Serializable


Serialized Fields


durationInSeconds
Integer durationInSeconds

 The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial
 attempt to send data to Splunk fails. It doesn't include the periods during which Kinesis Data Firehose waits for
 acknowledgment from Splunk after each attempt.
 








Class com.amazonaws.services.kinesisfirehose.model.StartDeliveryStreamEncryptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream for which you want to enable server-side encryption (SSE).
 


deliveryStreamEncryptionConfigurationInput
DeliveryStreamEncryptionConfigurationInput deliveryStreamEncryptionConfigurationInput

 Used to specify the type and Amazon Resource Name (ARN) of the KMS key needed for Server-Side Encryption (SSE).
 








Class com.amazonaws.services.kinesisfirehose.model.StartDeliveryStreamEncryptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisfirehose.model.StopDeliveryStreamEncryptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream for which you want to disable server-side encryption (SSE).
 








Class com.amazonaws.services.kinesisfirehose.model.StopDeliveryStreamEncryptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisfirehose.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white
 space, _ . / = + - % @
 


value
String value

 An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid
 characters: Unicode letters, digits, white space, _ . / = + - % @
 








Class com.amazonaws.services.kinesisfirehose.model.TagDeliveryStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream to which you want to add the tags.
 


tags
List<E> tags

 A set of key-value pairs to use to create the tags.
 








Class com.amazonaws.services.kinesisfirehose.model.TagDeliveryStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisfirehose.model.UntagDeliveryStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


tagKeys
List<E> tagKeys

 A list of tag keys. Each corresponding tag is removed from the delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.UntagDeliveryStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisfirehose.model.UpdateDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


currentDeliveryStreamVersionId
String currentDeliveryStreamVersionId

 Obtain this value from the VersionId result of DeliveryStreamDescription. This value is
 required, and helps the service perform conditional operations. For example, if there is an interleaving update
 and this value is null, then the update destination fails. After the update is successful, the
 VersionId value is updated. The service then performs a merge of the old configuration with the new
 configuration.
 


destinationId
String destinationId

 The ID of the destination.
 


s3DestinationUpdate
S3DestinationUpdate s3DestinationUpdate
Deprecated. 

 [Deprecated] Describes an update for a destination in Amazon S3.
 


extendedS3DestinationUpdate
ExtendedS3DestinationUpdate extendedS3DestinationUpdate

 Describes an update for a destination in Amazon S3.
 


redshiftDestinationUpdate
RedshiftDestinationUpdate redshiftDestinationUpdate

 Describes an update for a destination in Amazon Redshift.
 


elasticsearchDestinationUpdate
ElasticsearchDestinationUpdate elasticsearchDestinationUpdate

 Describes an update for a destination in Amazon ES.
 


splunkDestinationUpdate
SplunkDestinationUpdate splunkDestinationUpdate

 Describes an update for a destination in Splunk.
 








Class com.amazonaws.services.kinesisfirehose.model.UpdateDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.kinesisvideo.model




Class com.amazonaws.services.kinesisvideo.model.AccessDeniedException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.AccountChannelLimitExceededException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.AccountStreamLimitExceededException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.AckEvent extends Object implements Serializable


Serialized Fields


ackEventType
AckEventType ackEventType


fragmentTimecode
Long fragmentTimecode


fragmentNumber
String fragmentNumber


errorCode
AckErrorCode errorCode


errorId
Integer errorId








Class com.amazonaws.services.kinesisvideo.model.AmazonKinesisVideoException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.ChannelInfo extends Object implements Serializable


Serialized Fields


channelName
String channelName

 The name of the signaling channel.
 


channelARN
String channelARN

 The ARN of the signaling channel.
 


channelType
String channelType

 The type of the signaling channel.
 


channelStatus
String channelStatus

 Current status of the signaling channel.
 


creationTime
Date creationTime

 The time at which the signaling channel was created.
 


singleMasterConfiguration
SingleMasterConfiguration singleMasterConfiguration

 A structure that contains the configuration for the SINGLE_MASTER channel type.
 


version
String version

 The current version of the signaling channel.
 








Class com.amazonaws.services.kinesisvideo.model.ChannelNameCondition extends Object implements Serializable


Serialized Fields


comparisonOperator
String comparisonOperator

 A comparison operator. Currently, you can only specify the BEGINS_WITH operator, which finds
 signaling channels whose names begin with a given prefix.
 


comparisonValue
String comparisonValue

 A value to compare.
 








Class com.amazonaws.services.kinesisvideo.model.ClientLimitExceededException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.ConnectionLimitExceededException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.CreateSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelName
String channelName

 A name for the signaling channel that you are creating. It must be unique for each account and region.
 


channelType
String channelType

 A type of the signaling channel that you are creating. Currently, SINGLE_MASTER is the only
 supported channel type.
 


singleMasterConfiguration
SingleMasterConfiguration singleMasterConfiguration

 A structure containing the configuration for the SINGLE_MASTER channel type.
 


tags
List<E> tags

 A set of tags (key/value pairs) that you want to associate with this channel.
 








Class com.amazonaws.services.kinesisvideo.model.CreateSignalingChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channelARN
String channelARN

 The ARN of the created channel.
 








Class com.amazonaws.services.kinesisvideo.model.CreateStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deviceName
String deviceName

 The name of the device that is writing to the stream.
 
 
 
 In the current implementation, Kinesis Video Streams does not use this name.
 
 


streamName
String streamName

 A name for the stream that you are creating.
 
 
 The stream name is an identifier for the stream, and must be unique for each account and region.
 


mediaType
String mediaType

 The media type of the stream. Consumers of the stream can use this information when processing the stream. For
 more information about media types, see Media Types. If you choose to specify
 the MediaType, see Naming Requirements
 for guidelines.
 
 
 Example valid values include "video/h264" and "video/h264,audio/aac".
 
 
 This parameter is optional; the default value is null (or empty in JSON).
 


kmsKeyId
String kmsKeyId

 The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt
 stream data.
 
 
 If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.
 
 
 For more information, see DescribeKey.
 


dataRetentionInHours
Integer dataRetentionInHours

 The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a
 data store that is associated with the stream.
 
 
 The default value is 0, indicating that the stream does not persist data.
 
 
 When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in
 the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB.
 Fragments are removed from the buffer when either limit is reached.
 


tags
Map<K,V> tags

 A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
 








Class com.amazonaws.services.kinesisvideo.model.CreateStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamARN
String streamARN

 The Amazon Resource Name (ARN) of the stream.
 








Class com.amazonaws.services.kinesisvideo.model.DASHFragmentSelector extends Object implements Serializable


Serialized Fields


fragmentSelectorType
String fragmentSelectorType

 The source of the timestamps for the requested media.
 
 
 When FragmentSelectorType is set to PRODUCER_TIMESTAMP and
 GetDASHStreamingSessionURLInput$PlaybackMode is ON_DEMAND or LIVE_REPLAY, the
 first fragment ingested with a producer timestamp within the specified FragmentSelector$TimestampRange is
 included in the media playlist. In addition, the fragments with producer timestamps within the
 TimestampRange ingested immediately following the first fragment (up to the
 GetDASHStreamingSessionURLInput$MaxManifestFragmentResults value) are included.
 
 
 Fragments that have duplicate producer timestamps are deduplicated. This means that if producers are producing a
 stream of fragments with producer timestamps that are approximately equal to the true clock time, the MPEG-DASH
 manifest will contain all of the fragments within the requested timestamp range. If some fragments are ingested
 within the same time range and very different points in time, only the oldest ingested collection of fragments
 are returned.
 
 
 When FragmentSelectorType is set to PRODUCER_TIMESTAMP and
 GetDASHStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps are used in the
 MP4 fragments and for deduplication. But the most recently ingested fragments based on server timestamps are
 included in the MPEG-DASH manifest. This means that even if fragments ingested in the past have producer
 timestamps with values now, they are not included in the HLS media playlist.
 
 
 The default is SERVER_TIMESTAMP.
 


timestampRange
DASHTimestampRange timestampRange

 The start and end of the timestamp range for the requested media.
 
 
 This value should not be present if PlaybackType is LIVE.
 








Class com.amazonaws.services.kinesisvideo.model.DASHTimestampRange extends Object implements Serializable


Serialized Fields


startTimestamp
Date startTimestamp

 The start of the timestamp range for the requested media.
 
 
 If the DASHTimestampRange value is specified, the StartTimestamp value is required.
 
 
 
 This value is inclusive. Fragments that start before the StartTimestamp and continue past it are
 included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the
 StartTimestamp must be later than the stream head.
 
 


endTimestamp
Date endTimestamp

 The end of the timestamp range for the requested media. This value must be within 3 hours of the specified
 StartTimestamp, and it must be later than the StartTimestamp value.
 
 
 If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the
 past.
 
 
 The EndTimestamp value is required for ON_DEMAND mode, but optional for
 LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then
 the session will continue to include newly ingested fragments until the session expires.
 
 
 
 This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment.
 Fragments that start before the EndTimestamp value and continue past it are included in the session.
 
 








Class com.amazonaws.services.kinesisvideo.model.DeleteSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelARN
String channelARN

 The ARN of the signaling channel that you want to delete.
 


currentVersion
String currentVersion

 The current version of the signaling channel that you want to delete. You can obtain the current version by
 invoking the DescribeSignalingChannel or ListSignalingChannels APIs.
 








Class com.amazonaws.services.kinesisvideo.model.DeleteSignalingChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisvideo.model.DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamARN
String streamARN

 The Amazon Resource Name (ARN) of the stream that you want to delete.
 


currentVersion
String currentVersion

 Optional: The version of the stream that you want to delete.
 
 
 Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream
 version, use the DescribeStream API.
 
 
 If not specified, only the CreationTime is checked before deleting the stream.
 








Class com.amazonaws.services.kinesisvideo.model.DeleteStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisvideo.model.DescribeSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelName
String channelName

 The name of the signaling channel that you want to describe.
 


channelARN
String channelARN

 The ARN of the signaling channel that you want to describe.
 








Class com.amazonaws.services.kinesisvideo.model.DescribeSignalingChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channelInfo
ChannelInfo channelInfo

 A structure that encapsulates the specified signaling channel's metadata and properties.
 








Class com.amazonaws.services.kinesisvideo.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream.
 


streamARN
String streamARN

 The Amazon Resource Name (ARN) of the stream.
 








Class com.amazonaws.services.kinesisvideo.model.DescribeStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamInfo
StreamInfo streamInfo

 An object that describes the stream.
 








Class com.amazonaws.services.kinesisvideo.model.DeviceStreamLimitExceededException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.Fragment extends Object implements Serializable


Serialized Fields


fragmentNumber
String fragmentNumber

 The unique identifier of the fragment. This value monotonically increases based on the ingestion order.
 


fragmentSizeInBytes
Long fragmentSizeInBytes

 The total fragment size, including information about the fragment and contained media data.
 


producerTimestamp
Date producerTimestamp

 The timestamp from the producer corresponding to the fragment.
 


serverTimestamp
Date serverTimestamp

 The timestamp from the AWS server corresponding to the fragment.
 


fragmentLengthInMilliseconds
Long fragmentLengthInMilliseconds

 The playback duration or other time value associated with the fragment.
 








Class com.amazonaws.services.kinesisvideo.model.FragmentSelector extends Object implements Serializable


Serialized Fields


fragmentSelectorType
String fragmentSelectorType

 The origin of the timestamps to use (Server or Producer).
 


timestampRange
TimestampRange timestampRange

 The range of timestamps to return.
 








Class com.amazonaws.services.kinesisvideo.model.GetDASHStreamingSessionURLRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream for which to retrieve the MPEG-DASH manifest URL.
 
 
 You must specify either the StreamName or the StreamARN.
 


streamARN
String streamARN

 The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.
 
 
 You must specify either the StreamName or the StreamARN.
 


playbackMode
String playbackMode

 Whether to retrieve live, live replay, or archived, on-demand data.
 
 
 Features of the three types of sessions include the following:
 
 
 
 
  LIVE : For sessions of this type, the MPEG-DASH manifest is continually updated with the
 latest fragments as they become available. We recommend that the media player retrieve a new manifest on a
 one-second interval. When this type of session is played in a media player, the user interface typically displays
 a "live" notification, with no scrubber control for choosing the position in the playback window to display.
 
 
 
 In LIVE mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is
 a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt
 or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older
 than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment
 is added to the manifest, the older fragment is not added, and the gap is not filled.
 
 
 
 
  LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated similarly to how
 it is updated for LIVE mode except that it starts by including fragments from a given start time.
 Instead of fragments being added as they are ingested, fragments are added as the duration of the next fragment
 elapses. For example, if the fragments in the session are two seconds long, then a new fragment is added to the
 manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and
 continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is
 also useful to stream previously archived media without being limited by the 1,000 fragment limit in the
 ON_DEMAND mode.
 
 
 
 
  ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains all the fragments for
 the session, up to the number that is specified in MaxMediaPlaylistFragmentResults. The manifest
 must be retrieved only once for each session. When this type of session is played in a media player, the user
 interface typically displays a scrubber control for choosing the position in the playback window to display.
 
 
 
 
 In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and if there are
 multiple fragments with the same start timestamp, the fragment that has the larger fragment number (that is, the
 newer fragment) is included in the MPEG-DASH manifest. The other fragments are not included. Fragments that have
 different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead
 to unexpected behavior in the media player.
 
 
 The default is LIVE.
 


displayFragmentTimestamp
String displayFragmentTimestamp

 Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using
 attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle
 gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable
 playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be
 inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is added
 to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is
 necessary to leverage this custom attribute.
 
 
 The default value is NEVER. When DASHFragmentSelector is SERVER_TIMESTAMP, the
 timestamps will be the server start timestamps. Similarly, when DASHFragmentSelector is
 PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.
 


displayFragmentNumber
String displayFragmentNumber

 Fragments are identified in the manifest file based on their sequence number in the session. If
 DisplayFragmentNumber is set to ALWAYS, the Kinesis Video Streams fragment number is added to each S
 element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or
 for use with other APIs (e.g. GetMedia and GetMediaForFragmentList). A custom MPEG-DASH
 media player is necessary to leverage these this custom attribute.
 
 
 The default value is NEVER.
 


dASHFragmentSelector
DASHFragmentSelector dASHFragmentSelector

 The time range of the requested fragment and the source of the timestamps.
 
 
 This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY.
 This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is
 LIVE, the FragmentSelectorType can be set, but the TimestampRange should
 not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both
 FragmentSelectorType and TimestampRange must be set.
 



expires
Integer expires

 The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and 43200 (12
 hours).
 
 
 When a session expires, no new calls to GetDashManifest, GetMP4InitFragment, or
 GetMP4MediaFragment can be made for that session.
 
 
 The default is 300 (5 minutes).
 


maxManifestFragmentResults
Long maxManifestFragmentResults

 The maximum number of fragments that are returned in the MPEG-DASH manifest.
 
 
 When the PlaybackMode is LIVE, the most recent fragments are returned up to this value.
 When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up to this
 maximum number.
 
 
 When there are a higher number of fragments available in a live MPEG-DASH manifest, video players often buffer
 content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the
 likelihood that rebuffering will occur during playback. We recommend that a live MPEG-DASH manifest have a
 minimum of 3 fragments and a maximum of 10 fragments.
 
 
 The default is 5 fragments if PlaybackMode is LIVE or LIVE_REPLAY, and
 1,000 if PlaybackMode is ON_DEMAND.
 
 
 The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on streams with 1-second
 fragments, and more than 2 1/2 hours of video on streams with 10-second fragments.
 








Class com.amazonaws.services.kinesisvideo.model.GetDASHStreamingSessionURLResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dASHStreamingSessionURL
String dASHStreamingSessionURL

 The URL (containing the session token) that a media player can use to retrieve the MPEG-DASH manifest.
 








Class com.amazonaws.services.kinesisvideo.model.GetDataEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream that you want to get the endpoint for. You must specify either this parameter or a
 StreamARN in the request.
 


streamARN
String streamARN

 The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this
 parameter or a StreamName in the request.
 


aPIName
String aPIName

 The name of the API action for which to get an endpoint.
 








Class com.amazonaws.services.kinesisvideo.model.GetDataEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataEndpoint
String dataEndpoint

 The endpoint value. To read data from the stream or to write data to it, specify this endpoint in your
 application.
 








Class com.amazonaws.services.kinesisvideo.model.GetHLSStreamingSessionURLRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream for which to retrieve the HLS master playlist URL.
 
 
 You must specify either the StreamName or the StreamARN.
 


streamARN
String streamARN

 The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master playlist URL.
 
 
 You must specify either the StreamName or the StreamARN.
 


playbackMode
String playbackMode

 Whether to retrieve live, live replay, or archived, on-demand data.
 
 
 Features of the three types of sessions include the following:
 
 
 
 
  LIVE : For sessions of this type, the HLS media playlist is continually updated with the
 latest fragments as they become available. We recommend that the media player retrieve a new playlist on a
 one-second interval. When this type of session is played in a media player, the user interface typically displays
 a "live" notification, with no scrubber control for choosing the position in the playback window to display.
 
 
 
 In LIVE mode, the newest available fragments are included in an HLS media playlist, even if there is
 a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt
 or cause a jump in playback. In this mode, fragments are not added to the HLS media playlist if they are older
 than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment
 is added to the playlist, the older fragment is not added, and the gap is not filled.
 
 
 
 
  LIVE_REPLAY : For sessions of this type, the HLS media playlist is updated similarly to how
 it is updated for LIVE mode except that it starts by including fragments from a given start time.
 Instead of fragments being added as they are ingested, fragments are added as the duration of the next fragment
 elapses. For example, if the fragments in the session are two seconds long, then a new fragment is added to the
 media playlist every two seconds. This mode is useful to be able to start playback from when an event is detected
 and continue live streaming media that has not yet been ingested as of the time of the session creation. This
 mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in the
 ON_DEMAND mode.
 
 
 
 
  ON_DEMAND : For sessions of this type, the HLS media playlist contains all the fragments for
 the session, up to the number that is specified in MaxMediaPlaylistFragmentResults. The playlist
 must be retrieved only once for each session. When this type of session is played in a media player, the user
 interface typically displays a scrubber control for choosing the position in the playback window to display.
 
 
 
 
 In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and if there are
 multiple fragments with the same start timestamp, the fragment that has the larger fragment number (that is, the
 newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have
 different timestamps but have overlapping durations are still included in the HLS media playlist. This can lead
 to unexpected behavior in the media player.
 
 
 The default is LIVE.
 


hLSFragmentSelector
HLSFragmentSelector hLSFragmentSelector

 The time range of the requested fragment and the source of the timestamps.
 
 
 This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY.
 This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is
 LIVE, the FragmentSelectorType can be set, but the TimestampRange should
 not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both
 FragmentSelectorType and TimestampRange must be set.
 



containerFormat
String containerFormat

 Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4
 container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because
 there is minimal packaging overhead. The other container format option is MPEG_TS. HLS has supported
 MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS
 typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more
 bandwidth and cost than fMP4.
 
 
 The default is FRAGMENTED_MP4.
 


discontinuityMode
String discontinuityMode

 Specifies when flags marking discontinuities between fragments are added to the media playlists.
 
 
 Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This
 means that if there is any overlap or gap between fragments (as is typical if HLSFragmentSelector is set
 to SERVER_TIMESTAMP), the media player timeline will also have small gaps between fragments in some
 places, and will overwrite frames in other places. Gaps in the media player timeline can cause playback to stall
 and overlaps can cause playback to be jittery. When there are discontinuity flags between fragments, the media
 player is expected to reset the timeline, resulting in the next fragment being played immediately after the
 previous fragment.
 
 
 The following modes are supported:
 
 
 
 
 ALWAYS: a discontinuity marker is placed between every fragment in the HLS media playlist. It is
 recommended to use a value of ALWAYS if the fragment timestamps are not accurate.
 
 
 
 
 NEVER: no discontinuity markers are placed anywhere. It is recommended to use a value of
 NEVER to ensure the media player timeline most accurately maps to the producer timestamps.
 
 
 
 
 ON_DISCONTIUNITY: a discontinuity marker is placed between fragments that have a gap or overlap of
 more than 50 milliseconds. For most playback scenarios, it is recommended to use a value of
 ON_DISCONTINUITY so that the media player timeline is only reset when there is a significant issue
 with the media timeline (e.g. a missing fragment).
 
 
 
 
 The default is ALWAYS when HLSFragmentSelector is set to SERVER_TIMESTAMP, and
 NEVER when it is set to PRODUCER_TIMESTAMP.
 


displayFragmentTimestamp
String displayFragmentTimestamp

 Specifies when the fragment start timestamps should be included in the HLS media playlist. Typically, media
 players report the playhead position as a time relative to the start of the first fragment in the playback
 session. However, when the start timestamps are included in the HLS media playlist, some media players might
 report the current playhead as an absolute time based on the fragment timestamps. This can be useful for creating
 a playback experience that shows viewers the wall-clock time of the media.
 
 
 The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the
 timestamps will be the server start timestamps. Similarly, when HLSFragmentSelector is
 PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.
 


expires
Integer expires

 The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and 43200 (12
 hours).
 
 
 When a session expires, no new calls to GetHLSMasterPlaylist, GetHLSMediaPlaylist,
 GetMP4InitFragment, GetMP4MediaFragment, or GetTSFragment can be made for
 that session.
 
 
 The default is 300 (5 minutes).
 


maxMediaPlaylistFragmentResults
Long maxMediaPlaylistFragmentResults

 The maximum number of fragments that are returned in the HLS media playlists.
 
 
 When the PlaybackMode is LIVE, the most recent fragments are returned up to this value.
 When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up to this
 maximum number.
 
 
 When there are a higher number of fragments available in a live HLS media playlist, video players often buffer
 content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the
 likelihood that rebuffering will occur during playback. We recommend that a live HLS media playlist have a
 minimum of 3 fragments and a maximum of 10 fragments.
 
 
 The default is 5 fragments if PlaybackMode is LIVE or LIVE_REPLAY, and
 1,000 if PlaybackMode is ON_DEMAND.
 
 
 The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on streams with 1-second
 fragments, and more than 2 1/2 hours of video on streams with 10-second fragments.
 








Class com.amazonaws.services.kinesisvideo.model.GetHLSStreamingSessionURLResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hLSStreamingSessionURL
String hLSStreamingSessionURL

 The URL (containing the session token) that a media player can use to retrieve the HLS master playlist.
 








Class com.amazonaws.services.kinesisvideo.model.GetMediaForFragmentListRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream from which to retrieve fragment media.
 


fragments
List<E> fragments

 A list of the numbers of fragments for which to retrieve media. You retrieve these values with
 ListFragments.
 








Class com.amazonaws.services.kinesisvideo.model.GetMediaForFragmentListResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contentType
String contentType

 The content type of the requested media.
 


payload
InputStream payload

 The payload that Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information
 about the chunks, see PutMedia. The
 chunks that Kinesis Video Streams returns in the GetMediaForFragmentList call also include the
 following additional Matroska (MKV) tags:
 
 
 
 
 AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.
 
 
 
 
 AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the fragment.
 
 
 
 
 AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the fragment.
 
 
 
 
 The following tags will be included if an exception occurs:
 
 
 
 
 AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception
 
 
 
 
 AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception
 
 
 
 
 AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception
 
 
 








Class com.amazonaws.services.kinesisvideo.model.GetMediaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The Kinesis video stream name from where you want to get the media content. If you don't specify the
 streamName, you must specify the streamARN.
 


streamARN
String streamARN

 The ARN of the stream from where you want to get the media content. If you don't specify the
 streamARN, you must specify the streamName.
 


startSelector
StartSelector startSelector

 Identifies the starting chunk to get from the specified stream.
 








Class com.amazonaws.services.kinesisvideo.model.GetMediaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contentType
String contentType

 The content type of the requested media.
 


payload
InputStream payload

 The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information
 about the chunks, see . The chunks that Kinesis Video Streams returns in the GetMedia call also
 include the following additional Matroska (MKV) tags:
 
 
 
 
 AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your GetMedia call terminates, you
 can use this continuation token in your next request to get the next chunk where the last request terminated.
 
 
 
 
 AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how
 far behind the chunk returned in the response is from the latest chunk on the stream.
 
 
 
 
 AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.
 
 
 
 
 AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment.
 
 
 
 
 AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment.
 
 
 
 
 The following tags will be present if an error occurs:
 
 
 
 
 AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop.
 
 
 
 
 AWS_KINESISVIDEO_ERROR_ID: Integer code of the error.
 
 
 
 
 The error codes are as follows:
 
 
 
 
 3002 - Error writing to the stream
 
 
 
 
 4000 - Requested fragment is not found
 
 
 
 
 4500 - Access denied for the stream's KMS key
 
 
 
 
 4501 - Stream's KMS key is disabled
 
 
 
 
 4502 - Validation error on the stream's KMS key
 
 
 
 
 4503 - KMS key specified in the stream is unavailable
 
 
 
 
 4504 - Invalid usage of the KMS key specified in the stream
 
 
 
 
 4505 - Invalid state of the KMS key specified in the stream
 
 
 
 
 4506 - Unable to find the KMS key specified in the stream
 
 
 
 
 5000 - Internal error
 
 
 








Class com.amazonaws.services.kinesisvideo.model.GetSignalingChannelEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelARN
String channelARN

 The ARN of the signalling channel for which you want to get an endpoint.
 


singleMasterChannelEndpointConfiguration
SingleMasterChannelEndpointConfiguration singleMasterChannelEndpointConfiguration

 A structure containing the endpoint configuration for the SINGLE_MASTER channel type.
 








Class com.amazonaws.services.kinesisvideo.model.GetSignalingChannelEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceEndpointList
List<E> resourceEndpointList

 A list of endpoints for the specified signaling channel.
 








Class com.amazonaws.services.kinesisvideo.model.HLSFragmentSelector extends Object implements Serializable


Serialized Fields


fragmentSelectorType
String fragmentSelectorType

 The source of the timestamps for the requested media.
 
 
 When FragmentSelectorType is set to PRODUCER_TIMESTAMP and
 GetHLSStreamingSessionURLInput$PlaybackMode is ON_DEMAND or LIVE_REPLAY, the
 first fragment ingested with a producer timestamp within the specified FragmentSelector$TimestampRange is
 included in the media playlist. In addition, the fragments with producer timestamps within the
 TimestampRange ingested immediately following the first fragment (up to the
 GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults value) are included.
 
 
 Fragments that have duplicate producer timestamps are deduplicated. This means that if producers are producing a
 stream of fragments with producer timestamps that are approximately equal to the true clock time, the HLS media
 playlists will contain all of the fragments within the requested timestamp range. If some fragments are ingested
 within the same time range and very different points in time, only the oldest ingested collection of fragments
 are returned.
 
 
 When FragmentSelectorType is set to PRODUCER_TIMESTAMP and
 GetHLSStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps are used in the
 MP4 fragments and for deduplication. But the most recently ingested fragments based on server timestamps are
 included in the HLS media playlist. This means that even if fragments ingested in the past have producer
 timestamps with values now, they are not included in the HLS media playlist.
 
 
 The default is SERVER_TIMESTAMP.
 


timestampRange
HLSTimestampRange timestampRange

 The start and end of the timestamp range for the requested media.
 
 
 This value should not be present if PlaybackType is LIVE.
 








Class com.amazonaws.services.kinesisvideo.model.HLSTimestampRange extends Object implements Serializable


Serialized Fields


startTimestamp
Date startTimestamp

 The start of the timestamp range for the requested media.
 
 
 If the HLSTimestampRange value is specified, the StartTimestamp value is required.
 
 
 
 This value is inclusive. Fragments that start before the StartTimestamp and continue past it are
 included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the
 StartTimestamp must be later than the stream head.
 
 


endTimestamp
Date endTimestamp

 The end of the timestamp range for the requested media. This value must be within 3 hours of the specified
 StartTimestamp, and it must be later than the StartTimestamp value.
 
 
 If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the
 past.
 
 
 The EndTimestamp value is required for ON_DEMAND mode, but optional for
 LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then
 the session will continue to include newly ingested fragments until the session expires.
 
 
 
 This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment.
 Fragments that start before the EndTimestamp value and continue past it are included in the session.
 
 








Class com.amazonaws.services.kinesisvideo.model.InvalidArgumentException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.InvalidCodecPrivateDataException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.InvalidDeviceException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.InvalidEndpointException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.InvalidResourceFormatException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.ListFragmentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream from which to retrieve a fragment list.
 


maxResults
Long maxResults

 The total number of fragments to return. If the total number of fragments available is more than the value
 specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that
 you can use to resume pagination.
 


nextToken
String nextToken

 A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously
 truncated response.
 


fragmentSelector
FragmentSelector fragmentSelector

 Describes the timestamp range and timestamp origin for the range of fragments to return.
 








Class com.amazonaws.services.kinesisvideo.model.ListFragmentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fragments
List<E> fragments

 A list of archived Fragment objects from the stream that meet the selector criteria. Results are in no
 specific order, even across pages.
 


nextToken
String nextToken

 If the returned list is truncated, the operation returns this 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.kinesisvideo.model.ListSignalingChannelsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of channels to return in the response. The default is 500.
 


nextToken
String nextToken

 If you specify this parameter, when the result of a ListSignalingChannels operation is truncated,
 the call returns the NextToken in the response. To get another batch of channels, provide this token
 in your next request.
 


channelNameCondition
ChannelNameCondition channelNameCondition

 Optional: Returns only the channels that satisfy a specific condition.
 








Class com.amazonaws.services.kinesisvideo.model.ListSignalingChannelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channelInfoList
List<E> channelInfoList

 An array of ChannelInfo objects.
 


nextToken
String nextToken

 If the response is truncated, the call returns this element with a token. To get the next batch of streams, use
 this token in your next request.
 








Class com.amazonaws.services.kinesisvideo.model.ListStreamsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of streams to return in the response. The default is 10,000.
 


nextToken
String nextToken

 If you specify this parameter, when the result of a ListStreams operation is truncated, the call
 returns the NextToken in the response. To get another batch of streams, provide this token in your
 next request.
 


streamNameCondition
StreamNameCondition streamNameCondition

 Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a
 stream name as a condition.
 








Class com.amazonaws.services.kinesisvideo.model.ListStreamsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


streamInfoList
List<E> streamInfoList

 An array of StreamInfo objects.
 


nextToken
String nextToken

 If the response is truncated, the call returns this element with a token. To get the next batch of streams, use
 this token in your next request.
 








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


Serialized Fields


nextToken
String nextToken

 If you specify this parameter and the result of a ListTagsForResource call is truncated, the response includes a
 token that you can use in the next request to fetch the next batch of tags.
 


resourceARN
String resourceARN

 The ARN of the signaling channel for which you want to list tags.
 








Class com.amazonaws.services.kinesisvideo.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 If you specify this parameter and the result of a ListTagsForResource call is truncated, the response includes a
 token that you can use in the next request to fetch the next set of tags.
 


tags
Map<K,V> tags

 A map of tag keys and values associated with the specified signaling channel.
 








Class com.amazonaws.services.kinesisvideo.model.ListTagsForStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If you specify this parameter and the result of a ListTagsForStream call is truncated, the response
 includes a token that you can use in the next request to fetch the next batch of tags.
 


streamARN
String streamARN

 The Amazon Resource Name (ARN) of the stream that you want to list tags for.
 


streamName
String streamName

 The name of the stream that you want to list tags for.
 








Class com.amazonaws.services.kinesisvideo.model.ListTagsForStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 If you specify this parameter and the result of a ListTags call is truncated, the response includes
 a token that you can use in the next request to fetch the next set of tags.
 


tags
Map<K,V> tags

 A map of tag keys and values associated with the specified stream.
 








Class com.amazonaws.services.kinesisvideo.model.MissingCodecPrivateDataException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.NoDataRetentionException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.NotAuthorizedException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.PutMediaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 You pass this value as the x-amzn-stream-name HTTP header.
 
 
 Name of the Kinesis video stream where you want to write the media content. If you don't specify the
 streamName, you must specify the streamARN.
 


streamARN
String streamARN

 You pass this value as the x-amzn-stream-arn HTTP header.
 
 
 Amazon Resource Name (ARN) of the Kinesis video stream where you want to write the media content. If you don't
 specify the streamARN, you must specify the streamName.
 


fragmentTimecodeType
String fragmentTimecodeType

 You pass this value as the x-amzn-fragment-timecode-type HTTP header.
 
 
 Indicates whether timecodes in the fragments (payload, HTTP request body) are absolute or relative to
 producerStartTimestamp. Kinesis Video Streams uses this information to compute the
 producer_timestamp for the fragment received in the request, as described in the API overview.
 


producerStartTimestamp
Date producerStartTimestamp

 You pass this value as the x-amzn-producer-start-timestamp HTTP header.
 
 
 This is the producer time stamp at which the producer started recording the media (not the time stamp of the
 specific fragments in the request).
 


payload
InputStream payload

 The media content to write to the Kinesis video stream. In the current implementation, Kinesis Video Streams
 supports only the Matroska (MKV) container format with a single MKV segment. A segment can contain one or more
 clusters.
 
 
 
 Each MKV cluster maps to a Kinesis video stream fragment. Whatever cluster duration you choose becomes the
 fragment duration.
 
 








Class com.amazonaws.services.kinesisvideo.model.PutMediaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


payload
InputStream payload

 After Kinesis Video Streams successfully receives a PutMedia request, the service validates the
 request headers. The service then starts reading the payload and first sends an HTTP 200 response.
 
 
 The service then returns a stream containing a series of JSON objects (Acknowledgement objects)
 separated by newlines. The acknowledgements are received on the same connection on which the media data is sent.
 There can be many acknowledgements for a PutMedia request. Each Acknowledgement
 consists of the following key-value pairs:
 
 
 
 
 AckEventType - Event type the acknowledgement represents.
 
 
 
 
 Buffering: Kinesis Video Streams has started receiving the fragment. Kinesis Video Streams sends the first
 Buffering acknowledgement when the first byte of fragment data is received.
 
 
 
 
 Received: Kinesis Video Streams received the entire fragment. If you did not configure the stream to
 persist the data, the producer can stop buffering the fragment upon receiving this acknowledgement.
 
 
 
 
 Persisted: Kinesis Video Streams has persisted the fragment (for example, to Amazon S3). You get this
 acknowledgement if you configured the stream to persist the data. After you receive this acknowledgement, the
 producer can stop buffering the fragment.
 
 
 
 
 Error: Kinesis Video Streams ran into an error while processing the fragment. You can review the error
 code and determine the next course of action.
 
 
 
 
 Idle: The PutMedia session is in-progress. However, Kinesis Video Streams is currently not
 receiving data. Kinesis Video Streams sends this acknowledgement periodically for up to 30 seconds after the last
 received data. If no data is received within the 30 seconds, Kinesis Video Streams closes the request.
 
 
 
 This acknowledgement can help a producer determine if the PutMedia connection is alive, even if it
 is not sending any data.
 
 
 
 
 
 
 FragmentTimeCode - Fragment timecode for which acknowledgement is sent.
 
 
 The element can be missing if the AckEventType is Idle.
 
 
 
 
 FragmentNumber - Kinesis Video Streams-generated fragment number for which the acknowledgement is
 sent.
 
 
 
 
 ErrorId and ErrorCode - If the AckEventType is ErrorId, this field
 provides corresponding error code. The following is the list of error codes:
 
 
 
 
 4000 - Error reading the data stream.
 
 
 
 
 4001 - Fragment size is greater than maximum limit, 50 MB, allowed.
 
 
 
 
 4002 - Fragment duration is greater than maximum limit, 10 seconds, allowed.
 
 
 
 
 4003 - Connection duration is greater than maximum allowed threshold.
 
 
 
 
 4004 - Fragment timecode is less than the timecode previous time code (within a PutMedia call, you
 cannot send fragments out of order).
 
 
 
 
 4005 - More than one track is found in MKV.
 
 
 
 
 4006 - Failed to parse the input stream as valid MKV format.
 
 
 
 
 4007 - Invalid producer timestamp.
 
 
 
 
 4008 - Stream no longer exists (deleted).
 
 
 
 
 4500 - Access to the stream's specified KMS key is denied.
 
 
 
 
 4501 - The stream's specified KMS key is disabled.
 
 
 
 
 4502 - The stream's specified KMS key failed validation.
 
 
 
 
 4503 - The stream's specified KMS key is unavailable.
 
 
 
 
 4504 - Invalid usage of the stream's specified KMS key.
 
 
 
 
 4505 - The stream's specified KMS key is in an invalid state.
 
 
 
 
 4506 - The stream's specified KMS key is not found.
 
 
 
 
 5000 - Internal service error
 
 
 
 
 5001 - Kinesis Video Streams failed to persist fragments to the data store.
 
 
 
 
 
 
 
 The producer, while sending the payload for a long running PutMedia request, should read the
 response for acknowledgements. A producer might receive chunks of acknowledgements at the same time, due to
 buffering on an intermediate proxy server. A producer that wants to receive timely acknowledgements can send
 fewer fragments in each PutMedia request.
 
 








Class com.amazonaws.services.kinesisvideo.model.ResourceEndpointListItem extends Object implements Serializable


Serialized Fields


protocol
String protocol

 The protocol of the signaling channel returned by the GetSignalingChannelEndpoint API.
 


resourceEndpoint
String resourceEndpoint

 The endpoint of the signaling channel returned by the GetSignalingChannelEndpoint API.
 








Class com.amazonaws.services.kinesisvideo.model.ResourceInUseException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.ResourceNotFoundException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.SingleMasterChannelEndpointConfiguration extends Object implements Serializable


Serialized Fields


protocols
List<E> protocols

 This property is used to determine the nature of communication over this SINGLE_MASTER signaling
 channel. If WSS is specified, this API returns a websocket endpoint. If HTTPS is
 specified, this API returns an HTTPS endpoint.
 


role
String role

 This property is used to determine messaging permissions in this SINGLE_MASTER signaling channel. If
 MASTER is specified, this API returns an endpoint that a client can use to receive offers from and
 send answers to any of the viewers on this signaling channel. If VIEWER is specified, this API
 returns an endpoint that a client can use only to send offers to another MASTER client on this
 signaling channel.
 








Class com.amazonaws.services.kinesisvideo.model.SingleMasterConfiguration extends Object implements Serializable


Serialized Fields


messageTtlSeconds
Integer messageTtlSeconds

 The period of time a signaling channel retains underlivered messages before they are discarded.
 








Class com.amazonaws.services.kinesisvideo.model.StartSelector extends Object implements Serializable


Serialized Fields


startSelectorType
String startSelectorType

 Identifies the fragment on the Kinesis video stream where you want to start getting the data from.
 
 
 
 
 NOW - Start with the latest chunk on the stream.
 
 
 
 
 EARLIEST - Start with earliest available chunk on the stream.
 
 
 
 
 FRAGMENT_NUMBER - Start with the chunk after a specific fragment. You must also specify the
 AfterFragmentNumber parameter.
 
 
 
 
 PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer
 or server timestamp. You specify the timestamp by adding StartTimestamp.
 
 
 
 
 CONTINUATION_TOKEN - Read using the specified continuation token.
 
 
 
 
 
 If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide
 any additional information in the startSelector.
 
 


afterFragmentNumber
String afterFragmentNumber

 Specifies the fragment number from where you want the GetMedia API to start returning the fragments.
 


startTimestamp
Date startTimestamp

 A timestamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the
 startSelectorType. The GetMedia API then starts with the chunk containing the fragment
 that has the specified timestamp.
 


continuationToken
String continuationToken

 Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The
 GetMedia API then starts with the chunk identified by the continuation token.
 








Class com.amazonaws.services.kinesisvideo.model.StreamInfo extends Object implements Serializable


Serialized Fields


deviceName
String deviceName

 The name of the device that is associated with the stream.
 


streamName
String streamName

 The name of the stream.
 


streamARN
String streamARN

 The Amazon Resource Name (ARN) of the stream.
 


mediaType
String mediaType

 The MediaType of the stream.
 


kmsKeyId
String kmsKeyId

 The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams uses to encrypt data on the
 stream.
 


version
String version

 The version of the stream.
 


status
String status

 The status of the stream.
 


creationTime
Date creationTime

 A time stamp that indicates when the stream was created.
 


dataRetentionInHours
Integer dataRetentionInHours

 How long the stream retains data, in hours.
 








Class com.amazonaws.services.kinesisvideo.model.StreamNameCondition extends Object implements Serializable


Serialized Fields


comparisonOperator
String comparisonOperator

 A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams
 whose names start with a given prefix.
 


comparisonValue
String comparisonValue

 A value to compare.
 








Class com.amazonaws.services.kinesisvideo.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key of the tag that is associated with the specified signaling channel.
 


value
String value

 The value of the tag that is associated with the specified signaling channel.
 








Class com.amazonaws.services.kinesisvideo.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the signaling channel to which you want to add tags.
 


tags
List<E> tags

 A list of tags to associate with the specified signaling channel. Each tag is a key-value pair.
 








Class com.amazonaws.services.kinesisvideo.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisvideo.model.TagsPerResourceExceededLimitException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.TagStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamARN
String streamARN

 The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.
 


streamName
String streamName

 The name of the stream that you want to add the tag or tags to.
 


tags
Map<K,V> tags

 A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
 








Class com.amazonaws.services.kinesisvideo.model.TagStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisvideo.model.TimestampRange extends Object implements Serializable


Serialized Fields


startTimestamp
Date startTimestamp

 The starting timestamp in the range of timestamps for which to return fragments.
 


endTimestamp
Date endTimestamp

 The ending timestamp in the range of timestamps for which to return fragments.
 








Class com.amazonaws.services.kinesisvideo.model.UnsupportedStreamMediaTypeException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideo.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceARN
String resourceARN

 The ARN of the signaling channel from which you want to remove tags.
 


tagKeyList
List<E> tagKeyList

 A list of the keys of the tags that you want to remove.
 








Class com.amazonaws.services.kinesisvideo.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisvideo.model.UntagStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamARN
String streamARN

 The Amazon Resource Name (ARN) of the stream that you want to remove tags from.
 


streamName
String streamName

 The name of the stream that you want to remove tags from.
 


tagKeyList
List<E> tagKeyList

 A list of the keys of the tags that you want to remove.
 








Class com.amazonaws.services.kinesisvideo.model.UntagStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisvideo.model.UpdateDataRetentionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream whose retention period you want to change.
 


streamARN
String streamARN

 The Amazon Resource Name (ARN) of the stream whose retention period you want to change.
 


currentVersion
String currentVersion

 The version of the stream whose retention period you want to change. To get the version, call either the
 DescribeStream or the ListStreams API.
 


operation
String operation

 Indicates whether you want to increase or decrease the retention period.
 


dataRetentionChangeInHours
Integer dataRetentionChangeInHours

 The retention period, in hours. The value you specify replaces the current value. The maximum value for this
 parameter is 87600 (ten years).
 








Class com.amazonaws.services.kinesisvideo.model.UpdateDataRetentionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisvideo.model.UpdateSignalingChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelARN
String channelARN

 The ARN of the signaling channel that you want to update.
 


currentVersion
String currentVersion

 The current version of the signaling channel that you want to update.
 


singleMasterConfiguration
SingleMasterConfiguration singleMasterConfiguration

 The structure containing the configuration for the SINGLE_MASTER type of the signaling channel that
 you want to update.
 








Class com.amazonaws.services.kinesisvideo.model.UpdateSignalingChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisvideo.model.UpdateStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


streamName
String streamName

 The name of the stream whose metadata you want to update.
 
 
 The stream name is an identifier for the stream, and must be unique for each account and region.
 


streamARN
String streamARN

 The ARN of the stream whose metadata you want to update.
 


currentVersion
String currentVersion

 The version of the stream whose metadata you want to update.
 


deviceName
String deviceName

 The name of the device that is writing to the stream.
 
 
 
 In the current implementation, Kinesis Video Streams does not use this name.
 
 


mediaType
String mediaType

 The stream's media type. Use MediaType to specify the type of content that the stream contains to
 the consumers of the stream. For more information about media types, see Media Types. If you choose to specify
 the MediaType, see Naming
 Requirements.
 
 
 To play video on the console, you must specify the correct video type. For example, if the video in the stream is
 H.264, specify video/h264 as the MediaType.
 








Class com.amazonaws.services.kinesisvideo.model.UpdateStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kinesisvideo.model.VersionMismatchException extends AmazonKinesisVideoException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.kinesisvideosignalingchannels.model




Class com.amazonaws.services.kinesisvideosignalingchannels.model.AmazonKinesisVideoSignalingChannelsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideosignalingchannels.model.ClientLimitExceededException extends AmazonKinesisVideoSignalingChannelsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideosignalingchannels.model.GetIceServerConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelARN
String channelARN

 The ARN of the signaling channel to be used for the peer-to-peer connection between configured peers.
 


clientId
String clientId

 Unique identifier for the viewer. Must be unique within the signaling channel.
 


service
String service

 Specifies the desired service. Currently, TURN is the only valid value.
 


username
String username

 An optional user ID to be associated with the credentials.
 








Class com.amazonaws.services.kinesisvideosignalingchannels.model.GetIceServerConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


iceServerList
List<E> iceServerList

 The list of ICE server information objects.
 








Class com.amazonaws.services.kinesisvideosignalingchannels.model.IceServer extends Object implements Serializable


Serialized Fields


uris
List<E> uris

 An array of URIs, in the form specified in the I-D.petithuguenin-behave-turn-uris
 spec. These URIs provide the different addresses and/or protocols that can be used to reach the TURN server.
 


username
String username

 A username to login to the ICE server.
 


password
String password

 A password to login to the ICE server.
 


ttl
Integer ttl

 The period of time, in seconds, during which the username and password are valid.
 








Class com.amazonaws.services.kinesisvideosignalingchannels.model.InvalidArgumentException extends AmazonKinesisVideoSignalingChannelsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideosignalingchannels.model.InvalidClientException extends AmazonKinesisVideoSignalingChannelsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideosignalingchannels.model.NotAuthorizedException extends AmazonKinesisVideoSignalingChannelsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideosignalingchannels.model.ResourceNotFoundException extends AmazonKinesisVideoSignalingChannelsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisvideosignalingchannels.model.SendAlexaOfferToMasterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelARN
String channelARN

 The ARN of the signaling channel by which Alexa and the master peer communicate.
 


senderClientId
String senderClientId

 The unique identifier for the sender client.
 


messagePayload
String messagePayload

 The base64-encoded SDP offer content.
 








Class com.amazonaws.services.kinesisvideosignalingchannels.model.SendAlexaOfferToMasterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


answer
String answer

 The base64-encoded SDP answer content.
 








Class com.amazonaws.services.kinesisvideosignalingchannels.model.SessionExpiredException extends AmazonKinesisVideoSignalingChannelsException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.kms.model




Class com.amazonaws.services.kms.model.AliasListEntry extends Object implements Serializable


Serialized Fields


aliasName
String aliasName

 String that contains the alias. This value begins with alias/.
 


aliasArn
String aliasArn

 String that contains the key ARN.
 


targetKeyId
String targetKeyId

 String that contains the key identifier referred to by the alias.
 








Class com.amazonaws.services.kms.model.AlreadyExistsException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.AWSKMSException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.CancelKeyDeletionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 The unique identifier for the customer master key (CMK) for which to cancel deletion.
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 








Class com.amazonaws.services.kms.model.CancelKeyDeletionResult extends AmazonWebServiceResult<ResponseMetadata> 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.CloudHsmClusterInUseException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.CloudHsmClusterInvalidConfigurationException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.CloudHsmClusterNotActiveException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.CloudHsmClusterNotFoundException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.CloudHsmClusterNotRelatedException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.ConnectCustomKeyStoreRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


customKeyStoreId
String customKeyStoreId

 Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store,
 use the DescribeCustomKeyStores operation.
 








Class com.amazonaws.services.kms.model.ConnectCustomKeyStoreResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


aliasName
String aliasName

 Specifies the alias name. This value must begin with alias/ followed by a name, such as
 alias/ExampleAlias. The alias name cannot begin with alias/aws/. The
 alias/aws/ prefix is reserved for AWS managed CMKs.
 


targetKeyId
String targetKeyId

 Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID
 and ARN in the AWS Key Management Service Developer Guide.
 








Class com.amazonaws.services.kms.model.CreateAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.CreateCustomKeyStoreRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


customKeyStoreName
String customKeyStoreName

 Specifies a friendly name for the custom key store. The name must be unique in your AWS account.
 


cloudHsmClusterId
String cloudHsmClusterId

 Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM
 cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters
 operation.
 


trustAnchorCertificate
String trustAnchorCertificate

 Enter the content of the trust anchor certificate for the cluster. This is the content of the
 customerCA.crt file that you created when you initialized the cluster.
 


keyStorePassword
String keyStorePassword

 Enter the password of the 
 kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the
 cluster as this user to manage key material on your behalf.
 
 
 The password must be a string of 7 to 32 characters. Its value is case sensitive.
 
 
 This parameter tells AWS KMS the kmsuser account password; it does not change the password in the
 AWS CloudHSM cluster.
 








Class com.amazonaws.services.kms.model.CreateCustomKeyStoreResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


customKeyStoreId
String customKeyStoreId

 A unique identifier for the new custom key store.
 








Class com.amazonaws.services.kms.model.CreateGrantRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 The unique identifier for the customer master key (CMK) that the grant applies to.
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you
 must use the key ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 


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, IAM roles, federated users, and
 assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and
 Access Management (IAM) in the Example ARNs section of the AWS General Reference.
 


retiringPrincipal
String retiringPrincipal

 The principal that is given permission to retire the grant by using RetireGrant operation.
 
 
 To specify the principal, use the Amazon Resource Name (ARN)
 of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed
 role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and
 Access Management (IAM) in the Example ARNs section of the AWS General Reference.
 


operations
SdkInternalList<T> operations

 A list of operations that the grant permits.
 


constraints
GrantConstraints constraints

 Allows a cryptographic operation only when the encryption context matches or includes the encryption context
 specified in this structure. For more information about encryption context, see Encryption Context
 in the  AWS Key Management Service Developer Guide .
 


grantTokens
SdkInternalList<T> grantTokens

 A list of grant tokens.
 
 
 For more information, see Grant Tokens in the
 AWS Key Management Service Developer Guide.
 


name
String name

 A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants
 when retrying this request.
 
 
 When this value is absent, all CreateGrant requests result in a new grant with a unique
 GrantId even if all the supplied parameters are identical. This can result in unintended duplicates
 when you retry the CreateGrant request.
 
 
 When this value is present, you can retry a CreateGrant request with identical parameters; if the
 grant already exists, the original GrantId is returned without creating a new grant. Note that the
 returned grant token is unique with every CreateGrant request, even when a duplicate
 GrantId is returned. All grant tokens obtained in this way can be used interchangeably.
 








Class com.amazonaws.services.kms.model.CreateGrantResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


grantToken
String grantToken

 The grant token.
 
 
 For more information, see Grant Tokens in the
 AWS Key Management Service Developer Guide.
 


grantId
String grantId

 The unique identifier for the grant.
 
 
 You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.
 








Class com.amazonaws.services.kms.model.CreateKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policy
String policy

 The key policy to attach to the CMK.
 
 
 If you provide a key policy, it must meet the following criteria:
 
 
 
 
 If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal
 that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK.
 This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the  AWS Key Management Service Developer Guide .
 
 
 
 
 Each statement in the key policy must contain one or more principals. The principals 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 including the new principal in a key policy because the new principal might not be
 immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User
 Guide.
 
 
 
 
 If you do not provide a key 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 key policy size quota is 32 kilobytes (32768 bytes).
 


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

 Determines the cryptographic operations for which you can use the CMK. The default value is
 ENCRYPT_DECRYPT. This parameter is required only for asymmetric CMKs. You can't change the
 KeyUsage value after the CMK is created.
 
 
 Select only one valid value.
 
 
 
 
 For symmetric CMKs, omit the parameter or specify ENCRYPT_DECRYPT.
 
 
 
 
 For asymmetric CMKs with RSA key material, specify ENCRYPT_DECRYPT or SIGN_VERIFY.
 
 
 
 
 For asymmetric CMKs with ECC key material, specify SIGN_VERIFY.
 
 
 


customerMasterKeySpec
String customerMasterKeySpec

 Specifies the type of CMK to create. The default value, SYMMETRIC_DEFAULT, creates a CMK with a
 256-bit symmetric key for encryption and decryption. For help choosing a key spec for your CMK, see How to Choose Your CMK
 Configuration in the AWS Key Management Service Developer Guide.
 
 
 The CustomerMasterKeySpec determines whether the CMK contains a symmetric key or an asymmetric key
 pair. It also determines the encryption algorithms or signing algorithms that the CMK supports. You can't change
 the CustomerMasterKeySpec after the CMK is created. To further restrict the algorithms that can be
 used with the CMK, use a condition key in its key policy or IAM policy. For more information, see kms:EncryptionAlgorithm or kms:Signing Algorithm in the AWS Key Management Service Developer Guide.
 
 
 
 AWS services that are integrated with AWS
 KMS use symmetric CMKs to protect your data. These services do not support asymmetric CMKs. For help
 determining whether a CMK is symmetric or asymmetric, see Identifying Symmetric and
 Asymmetric CMKs in the AWS Key Management Service Developer Guide.
 
 
 
 AWS KMS supports the following key specs for CMKs:
 
 
 
 
 Symmetric key (default)
 
 
 
 
 SYMMETRIC_DEFAULT (AES-256-GCM)
 
 
 
 
 
 
 Asymmetric RSA key pairs
 
 
 
 
 RSA_2048
 
 
 
 
 RSA_3072
 
 
 
 
 RSA_4096
 
 
 
 
 
 
 Asymmetric NIST-recommended elliptic curve key pairs
 
 
 
 
 ECC_NIST_P256 (secp256r1)
 
 
 
 
 ECC_NIST_P384 (secp384r1)
 
 
 
 
 ECC_NIST_P521 (secp521r1)
 
 
 
 
 
 
 Other asymmetric elliptic curve key pairs
 
 
 
 
 ECC_SECG_P256K1 (secp256k1), commonly used for cryptocurrencies.
 
 
 
 
 


origin
String origin

 The source of the key material for the CMK. You cannot change the origin after you create the CMK. The default is
 AWS_KMS, which means AWS KMS creates the key material.
 
 
 When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can
 import key material from your existing key management infrastructure. For more information about importing key
 material into AWS KMS, see Importing Key Material in
 the AWS Key Management Service Developer Guide. This value is valid only for symmetric CMKs.
 
 
 When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store
 and creates its key material in the associated AWS CloudHSM cluster. You must also use the
 CustomKeyStoreId parameter to identify the custom key store. This value is valid only for symmetric
 CMKs.
 


customKeyStoreId
String customKeyStoreId

 Creates the CMK in the specified custom key store
 and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also
 specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster
 that is associated with the custom key store must have at least two active HSMs, each in a different Availability
 Zone in the Region.
 
 
 This parameter is valid only for symmetric CMKs. You cannot create an asymmetric CMK in a custom key store.
 
 
 To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
 
 
 The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.
 
 
 This operation is part of the Custom Key Store
 feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the
 isolation and control of a single-tenant key store.
 


bypassPolicyLockoutSafetyCheck
Boolean bypassPolicyLockoutSafetyCheck

 A flag to indicate whether to bypass the key policy lockout safety check.
 
 
 
 Setting this value to true increases the risk 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 that is
 making the request from making a subsequent PutKeyPolicy request on the CMK.
 
 
 The default value is false.
 


tags
SdkInternalList<T> tags

 One or more tags. Each tag consists of a tag key and a tag value. Both the tag key and the tag value are
 required, but the tag value can be an empty (null) string.
 
 
 When you add tags to an AWS resource, AWS generates a cost allocation report with usage and costs aggregated by
 tags. For information about adding, changing, deleting and listing tags for CMKs, see Tagging Keys.
 
 
 Use this parameter to tag the CMK when it is created. To add tags to an existing CMK, use the TagResource
 operation.
 








Class com.amazonaws.services.kms.model.CreateKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyMetadata
KeyMetadata keyMetadata

 Metadata associated with the CMK.
 








Class com.amazonaws.services.kms.model.CustomKeyStoreHasCMKsException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.CustomKeyStoreInvalidStateException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.CustomKeyStoreNameInUseException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.CustomKeyStoreNotFoundException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.CustomKeyStoresListEntry extends Object implements Serializable


Serialized Fields


customKeyStoreId
String customKeyStoreId

 A unique identifier for the custom key store.
 


customKeyStoreName
String customKeyStoreName

 The user-specified friendly name for the custom key store.
 


cloudHsmClusterId
String cloudHsmClusterId

 A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.
 


trustAnchorCertificate
String trustAnchorCertificate

 The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the
 cluster, you create this certificate and save it in the customerCA.crt file.
 


connectionState
String connectionState

 Indicates whether the custom key store is connected to its AWS CloudHSM cluster.
 
 
 You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.
 
 
 The value is DISCONNECTED if the key store has never been connected or you use the
 DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are
 having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and
 contains at least one active HSM.
 
 
 A value of FAILED indicates that an attempt to connect was unsuccessful. The
 ConnectionErrorCode field in the response indicates the cause of the failure. For help resolving a
 connection failure, see Troubleshooting a Custom Key
 Store in the AWS Key Management Service Developer Guide.
 


connectionErrorCode
String connectionErrorCode

 Describes the connection error. This field appears in the response only when the ConnectionState is
 FAILED. For help resolving these errors, see How to Fix a
 Connection Failure in AWS Key Management Service Developer Guide.
 
 
 Valid values are:
 
 
 
 
 CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.
 
 
 
 
 INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs.
 To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.
 
 
 
 
 INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request.
 For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.
 
 
 
 
 INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto
 user in the AWS CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you
 must change the kmsuser account password and update the key store password value for the custom key
 store.
 
 
 
 
 NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.
 
 
 
 
 USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM
 cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS
 CloudHSM cluster, you must change the kmsuser account password and update the key store password
 value for the custom key store.
 
 
 
 
 USER_LOGGED_IN - The kmsuser CU account is logged into the the associated AWS CloudHSM
 cluster. This prevents AWS KMS from rotating the kmsuser account password and logging into the
 cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must log the
 kmsuser CU out of the cluster. If you changed the kmsuser password to log into the
 cluster, you must also and update the key store password value for the custom key store. For help, see How to Log Out and
 Reconnect in the AWS Key Management Service Developer Guide.
 
 
 
 
 USER_NOT_FOUND - AWS KMS cannot find a kmsuser CU account in the associated AWS
 CloudHSM cluster. Before you can connect your custom key store to its AWS CloudHSM cluster, you must create a
 kmsuser CU account in the cluster, and then update the key store password value for the custom key
 store.
 
 
 


creationDate
Date creationDate

 The date and time when the custom key store was created.
 








Class com.amazonaws.services.kms.model.DecryptRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ciphertextBlob
ByteBuffer ciphertextBlob

 Ciphertext to be decrypted. The blob includes metadata.
 


encryptionContext
SdkInternalMap<K,V> encryptionContext

 Specifies the encryption context to use when decrypting the data. An encryption context is valid only for
 cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do
 not support an encryption context.
 
 
 An encryption context is a collection of non-secret key-value pairs that represents additional
 authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact
 case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting
 with a symmetric CMK, but it is highly recommended.
 
 
 For more information, see Encryption Context
 in the AWS Key Management Service Developer Guide.
 


grantTokens
SdkInternalList<T> grantTokens

 A list of grant tokens.
 
 
 For more information, see Grant Tokens in the
 AWS Key Management Service Developer Guide.
 


keyId
String keyId

 Specifies the customer master key (CMK) that AWS KMS will use to decrypt the ciphertext. Enter a key ID of the
 CMK that was used to encrypt the ciphertext.
 
 
 If you specify a KeyId value, the Decrypt operation succeeds only if the specified CMK
 was used to encrypt the ciphertext.
 
 
 This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS
 uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext.
 However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the
 ciphertext.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/".
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


encryptionAlgorithm
String encryptionAlgorithm

 Specifies the encryption algorithm that will be used to decrypt the ciphertext. Specify the same algorithm that
 was used to encrypt the data. If you specify a different algorithm, the Decrypt operation fails.
 
 
 This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. The default value,
 SYMMETRIC_DEFAULT, represents the only supported algorithm that is valid for symmetric CMKs.
 








Class com.amazonaws.services.kms.model.DecryptResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyId
String keyId

 The ARN of the customer master key that was used to perform the decryption.
 


plaintext
ByteBuffer plaintext

 Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is
 not Base64-encoded.
 


encryptionAlgorithm
String encryptionAlgorithm

 The encryption algorithm that was used to decrypt the ciphertext.
 








Class com.amazonaws.services.kms.model.DeleteAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


aliasName
String aliasName

 The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as
 alias/ExampleAlias.
 








Class com.amazonaws.services.kms.model.DeleteAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.DeleteCustomKeyStoreRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


customKeyStoreId
String customKeyStoreId

 Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the
 DescribeCustomKeyStores operation.
 








Class com.amazonaws.services.kms.model.DeleteCustomKeyStoreResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.DeleteImportedKeyMaterialRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be
 EXTERNAL.
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 








Class com.amazonaws.services.kms.model.DeleteImportedKeyMaterialResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.DependencyTimeoutException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.DescribeCustomKeyStoresRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


customKeyStoreId
String customKeyStoreId

 Gets only information about the specified custom key store. Enter the key store ID.
 
 
 By default, this operation gets information about all custom key stores in the account and region. To limit the
 output to a particular custom key store, you can use either the CustomKeyStoreId or
 CustomKeyStoreName parameter, but not both.
 


customKeyStoreName
String customKeyStoreName

 Gets only information about the specified custom key store. Enter the friendly name of the custom key store.
 
 
 By default, this operation gets information about all custom key stores in the account and region. To limit the
 output to a particular custom key store, you can use either the CustomKeyStoreId or
 CustomKeyStoreName parameter, but not both.
 


limit
Integer limit

 Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not
 return more than the specified number of items, but it might return fewer.
 


marker
String marker

 Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
 value of NextMarker from the truncated response you just received.
 








Class com.amazonaws.services.kms.model.DescribeCustomKeyStoresResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


customKeyStores
SdkInternalList<T> customKeyStores

 Contains metadata about each custom key store.
 


nextMarker
String nextMarker

 When Truncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent request.
 


truncated
Boolean truncated

 A flag that indicates whether there are more items in the list. When this value is true, the list in this
 response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
 to the Marker parameter in a subsequent request.
 








Class com.amazonaws.services.kms.model.DescribeKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 Describes the specified customer master key (CMK).
 
 
 If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and
 returns its KeyId and Arn in the response.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or
 alias ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


grantTokens
SdkInternalList<T> 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.DescribeKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyMetadata
KeyMetadata keyMetadata

 Metadata associated with the key.
 








Class com.amazonaws.services.kms.model.DisabledException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.DisableKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 A unique identifier for the customer master key (CMK).
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 








Class com.amazonaws.services.kms.model.DisableKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.DisableKeyRotationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric
 CMKs, CMKs with imported
 key material, or CMKs in a custom key store.
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 








Class com.amazonaws.services.kms.model.DisableKeyRotationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.DisconnectCustomKeyStoreRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


customKeyStoreId
String customKeyStoreId

 Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the
 DescribeCustomKeyStores operation.
 








Class com.amazonaws.services.kms.model.DisconnectCustomKeyStoreResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.EnableKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 A unique identifier for the customer master key (CMK).
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 








Class com.amazonaws.services.kms.model.EnableKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.EnableKeyRotationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 Identifies a symmetric customer master key (CMK). You cannot enable automatic rotation of asymmetric CMKs, CMKs
 with imported key material, or CMKs in a custom key store.
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 








Class com.amazonaws.services.kms.model.EnableKeyRotationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.EncryptRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 A unique identifier for the customer master key (CMK).
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or
 alias ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


plaintext
ByteBuffer plaintext

 Data to be encrypted.
 


encryptionContext
SdkInternalMap<K,V> encryptionContext

 Specifies the encryption context that will be used to encrypt the data. An encryption context is valid only for
 cryptographic operations with a symmetric CMK. The standard asymmetric encryption algorithms that AWS KMS uses do
 not support an encryption context.
 
 
 An encryption context is a collection of non-secret key-value pairs that represents additional
 authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact
 case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting
 with a symmetric CMK, but it is highly recommended.
 
 
 For more information, see Encryption Context
 in the AWS Key Management Service Developer Guide.
 


grantTokens
SdkInternalList<T> grantTokens

 A list of grant tokens.
 
 
 For more information, see Grant Tokens in the
 AWS Key Management Service Developer Guide.
 


encryptionAlgorithm
String encryptionAlgorithm

 Specifies the encryption algorithm that AWS KMS will use to encrypt the plaintext message. The algorithm must be
 compatible with the CMK that you specify.
 
 
 This parameter is required only for asymmetric CMKs. The default value, SYMMETRIC_DEFAULT, is the
 algorithm used for symmetric CMKs. If you are using an asymmetric CMK, we recommend RSAES_OAEP_SHA_256.
 








Class com.amazonaws.services.kms.model.EncryptResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ciphertextBlob
ByteBuffer ciphertextBlob

 The encrypted plaintext. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is
 not Base64-encoded.
 


keyId
String keyId

 The ID of the key used during encryption.
 


encryptionAlgorithm
String encryptionAlgorithm

 The encryption algorithm that was used to encrypt the plaintext.
 








Class com.amazonaws.services.kms.model.ExpiredImportTokenException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.GenerateDataKeyPairRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


encryptionContext
SdkInternalMap<K,V> encryptionContext

 Specifies the encryption context that will be used when encrypting the private key in the data key pair.
 
 
 An encryption context is a collection of non-secret key-value pairs that represents additional
 authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact
 case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting
 with a symmetric CMK, but it is highly recommended.
 
 
 For more information, see Encryption Context
 in the AWS Key Management Service Developer Guide.
 


keyId
String keyId

 Specifies the symmetric CMK that encrypts the private key in the data key pair. You cannot specify an asymmetric
 CMKs.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or
 alias ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


keyPairSpec
String keyPairSpec

 Determines the type of data key pair that is generated.
 
 
 The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but
 not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of
 AWS KMS.
 


grantTokens
SdkInternalList<T> 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.GenerateDataKeyPairResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


privateKeyCiphertextBlob
ByteBuffer privateKeyCiphertextBlob

 The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded.
 Otherwise, it is not Base64-encoded.
 


privateKeyPlaintext
ByteBuffer privateKeyPlaintext

 The plaintext copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded.
 Otherwise, it is not Base64-encoded.
 


publicKey
ByteBuffer publicKey

 The public key (in plaintext).
 


keyId
String keyId

 The identifier of the CMK that encrypted the private key.
 


keyPairSpec
String keyPairSpec

 The type of data key pair that was generated.
 








Class com.amazonaws.services.kms.model.GenerateDataKeyPairWithoutPlaintextRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


encryptionContext
SdkInternalMap<K,V> encryptionContext

 Specifies the encryption context that will be used when encrypting the private key in the data key pair.
 
 
 An encryption context is a collection of non-secret key-value pairs that represents additional
 authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact
 case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting
 with a symmetric CMK, but it is highly recommended.
 
 
 For more information, see Encryption Context
 in the AWS Key Management Service Developer Guide.
 


keyId
String keyId

 Specifies the CMK that encrypts the private key in the data key pair. You must specify a symmetric CMK. You
 cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/".
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


keyPairSpec
String keyPairSpec

 Determines the type of data key pair that is generated.
 
 
 The AWS KMS rule that restricts the use of asymmetric RSA CMKs to encrypt and decrypt or to sign and verify (but
 not both), and the rule that permits you to use ECC CMKs only to sign and verify, are not effective outside of
 AWS KMS.
 


grantTokens
SdkInternalList<T> 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.GenerateDataKeyPairWithoutPlaintextResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


privateKeyCiphertextBlob
ByteBuffer privateKeyCiphertextBlob

 The encrypted copy of the private key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded.
 Otherwise, it is not Base64-encoded.
 


publicKey
ByteBuffer publicKey

 The public key (in plaintext).
 


keyId
String keyId

 Specifies the CMK that encrypted the private key in the data key pair. You must specify a symmetric CMK. You
 cannot use an asymmetric CMK. To get the type of your CMK, use the DescribeKey operation.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/".
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


keyPairSpec
String keyPairSpec

 The type of data key pair that was generated.
 








Class com.amazonaws.services.kms.model.GenerateDataKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 Identifies the symmetric CMK that encrypts the data key.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or
 alias ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


encryptionContext
SdkInternalMap<K,V> encryptionContext

 Specifies the encryption context that will be used when encrypting the data key.
 
 
 An encryption context is a collection of non-secret key-value pairs that represents additional
 authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact
 case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting
 with a symmetric CMK, but it is highly recommended.
 
 
 For more information, see Encryption Context
 in the AWS Key Management Service Developer Guide.
 


numberOfBytes
Integer numberOfBytes

 Specifies the length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64
 bytes is 512 bits). For 128-bit (16-byte) and 256-bit (32-byte) data keys, use the KeySpec
 parameter.
 
 
 You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in
 every GenerateDataKey request.
 


keySpec
String keySpec

 Specifies the length of the data key. Use AES_128 to generate a 128-bit symmetric key, or
 AES_256 to generate a 256-bit symmetric key.
 
 
 You must specify either the KeySpec or the NumberOfBytes parameter (but not both) in
 every GenerateDataKey request.
 


grantTokens
SdkInternalList<T> 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.GenerateDataKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ciphertextBlob
ByteBuffer ciphertextBlob

 The encrypted copy of the data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded.
 Otherwise, it is not Base64-encoded.
 


plaintext
ByteBuffer plaintext

 The plaintext data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is
 not Base64-encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as
 possible.
 


keyId
String keyId

 The identifier of the CMK that encrypted the data key.
 








Class com.amazonaws.services.kms.model.GenerateDataKeyWithoutPlaintextRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 The identifier of the symmetric customer master key (CMK) that encrypts the data key.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or
 alias ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


encryptionContext
SdkInternalMap<K,V> encryptionContext

 Specifies the encryption context that will be used when encrypting the data key.
 
 
 An encryption context is a collection of non-secret key-value pairs that represents additional
 authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact
 case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting
 with a symmetric CMK, but it is highly recommended.
 
 
 For more information, see Encryption Context
 in the AWS Key Management Service Developer Guide.
 


keySpec
String keySpec

 The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256
 to generate a 256-bit symmetric key.
 


numberOfBytes
Integer numberOfBytes

 The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is
 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the
 KeySpec field instead of this one.
 


grantTokens
SdkInternalList<T> 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.GenerateDataKeyWithoutPlaintextResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ciphertextBlob
ByteBuffer ciphertextBlob

 The encrypted data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is
 not Base64-encoded.
 


keyId
String keyId

 The identifier of the CMK that encrypted the data key.
 








Class com.amazonaws.services.kms.model.GenerateRandomRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


numberOfBytes
Integer numberOfBytes

 The length of the byte string.
 


customKeyStoreId
String customKeyStoreId

 Generates the random byte string in the AWS CloudHSM cluster that is associated with the specified custom key store.
 To find the ID of a custom key store, use the DescribeCustomKeyStores operation.
 








Class com.amazonaws.services.kms.model.GenerateRandomResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


plaintext
ByteBuffer plaintext

 The random byte string. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is
 not Base64-encoded.
 








Class com.amazonaws.services.kms.model.GetKeyPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 A unique identifier for the customer master key (CMK).
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 


policyName
String policyName

 Specifies the name of the key policy. The only valid name is default. To get the names of key
 policies, use ListKeyPolicies.
 








Class com.amazonaws.services.kms.model.GetKeyPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
String policy

 A key policy document in JSON format.
 








Class com.amazonaws.services.kms.model.GetKeyRotationStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 A unique identifier for the customer master key (CMK).
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you
 must use the key ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 








Class com.amazonaws.services.kms.model.GetKeyRotationStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyRotationEnabled
Boolean keyRotationEnabled

 A Boolean value that specifies whether key rotation is enabled.
 








Class com.amazonaws.services.kms.model.GetParametersForImportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 The identifier of the symmetric CMK into which you will import key material. The Origin of the CMK
 must be EXTERNAL.
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 


wrappingAlgorithm
String wrappingAlgorithm

 The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For
 more information, see Encrypt the
 Key Material in the AWS Key Management Service Developer Guide.
 


wrappingKeySpec
String wrappingKeySpec

 The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.
 








Class com.amazonaws.services.kms.model.GetParametersForImportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyId
String keyId

 The identifier of the CMK to use in a subsequent ImportKeyMaterial request. This is the same CMK specified
 in the GetParametersForImport request.
 


importToken
ByteBuffer importToken

 The import token to send in a subsequent ImportKeyMaterial request.
 


publicKey
ByteBuffer publicKey

 The public key to use to encrypt the key material before importing it with ImportKeyMaterial.
 


parametersValidTo
Date parametersValidTo

 The time at which the import token and public key are no longer valid. After this time, you cannot use them to
 make an ImportKeyMaterial request and you must send another GetParametersForImport request to
 get new ones.
 








Class com.amazonaws.services.kms.model.GetPublicKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 Identifies the asymmetric CMK that includes the public key.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or
 alias ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


grantTokens
SdkInternalList<T> 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.GetPublicKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyId
String keyId

 The identifier of the asymmetric CMK from which the public key was downloaded.
 


publicKey
ByteBuffer publicKey

 The exported public key.
 
 
 This value is returned as a binary Distinguished Encoding Rules
 (DER)-encoded object. To decode it, use an ASN.1 parsing tool, such as OpenSSL asn1parse.
 


customerMasterKeySpec
String customerMasterKeySpec

 The type of the of the public key that was downloaded.
 


keyUsage
String keyUsage

 The permitted use of the public key. Valid values are ENCRYPT_DECRYPT or SIGN_VERIFY.
 
 
 This information is critical. If a public key with SIGN_VERIFY key usage encrypts data outside of
 AWS KMS, the ciphertext cannot be decrypted.
 


encryptionAlgorithms
SdkInternalList<T> encryptionAlgorithms

 The encryption algorithms that AWS KMS supports for this key.
 
 
 This information is critical. If a public key encrypts data outside of AWS KMS by using an unsupported encryption
 algorithm, the ciphertext cannot be decrypted.
 
 
 This field appears in the response only when the KeyUsage of the public key is
 ENCRYPT_DECRYPT.
 


signingAlgorithms
SdkInternalList<T> signingAlgorithms

 The signing algorithms that AWS KMS supports for this key.
 
 
 This field appears in the response only when the KeyUsage of the public key is
 SIGN_VERIFY.
 








Class com.amazonaws.services.kms.model.GrantConstraints extends Object implements Serializable


Serialized Fields


encryptionContextSubset
SdkInternalMap<K,V> encryptionContextSubset

 A list of key-value pairs that must be included in the encryption context of the cryptographic operation request.
 The grant allows the cryptographic operation only when the encryption context in the request includes the
 key-value pairs specified in this constraint, although it can include additional key-value pairs.
 


encryptionContextEquals
SdkInternalMap<K,V> encryptionContextEquals

 A list of key-value pairs that must match the encryption context in the cryptographic operation request. The
 grant allows the operation only when the encryption context in the request is the same as the encryption context
 specified in this constraint.
 








Class com.amazonaws.services.kms.model.GrantListEntry extends Object implements Serializable


Serialized Fields


keyId
String keyId

 The unique identifier for the customer master key (CMK) to which the grant applies.
 


grantId
String grantId

 The unique identifier for the grant.
 


name
String name

 The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name
 is returned. Otherwise this value is null.
 


creationDate
Date creationDate

 The date and time when the grant was created.
 


granteePrincipal
String granteePrincipal

 The principal that receives the grant's permissions.
 


retiringPrincipal
String retiringPrincipal

 The principal that can retire the grant.
 


issuingAccount
String issuingAccount

 The AWS account under which the grant was issued.
 


operations
SdkInternalList<T> operations

 The list of operations permitted by the grant.
 


constraints
GrantConstraints constraints

 A list of key-value pairs that must be present in the encryption context of certain subsequent operations that
 the grant allows.
 








Class com.amazonaws.services.kms.model.ImportKeyMaterialRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 The identifier of the symmetric CMK that receives the imported key material. The CMK's Origin must
 be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the
 corresponding GetParametersForImport request.
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 


importToken
ByteBuffer importToken

 The import token that you received in the response to a previous GetParametersForImport request. It must
 be from the same response that contained the public key that you used to encrypt the key material.
 


encryptedKeyMaterial
ByteBuffer encryptedKeyMaterial

 The encrypted key material to import. The key material must be encrypted with the public wrapping key that
 GetParametersForImport returned, using the wrapping algorithm that you specified in the same
 GetParametersForImport request.
 


validTo
Date validTo

 The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key
 material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel
 parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.
 


expirationModel
String expirationModel

 Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you
 must include the ValidTo parameter. When this parameter is set to
 KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.
 








Class com.amazonaws.services.kms.model.ImportKeyMaterialResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.IncorrectKeyException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.IncorrectKeyMaterialException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.IncorrectTrustAnchorException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidAliasNameException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidArnException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidCiphertextException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidGrantIdException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidGrantTokenException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidImportTokenException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidKeyUsageException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidMarkerException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.KeyListEntry extends Object implements Serializable


Serialized Fields


keyId
String keyId

 Unique identifier of the key.
 


keyArn
String keyArn

 ARN of the key.
 








Class com.amazonaws.services.kms.model.KeyMetadata extends Object implements Serializable


Serialized Fields


aWSAccountId
String aWSAccountId

 The twelve-digit account ID of the AWS account that owns the CMK.
 


keyId
String keyId

 The globally unique identifier for the CMK.
 


arn
String arn

 The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key
 Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.
 


creationDate
Date creationDate

 The date and time when the CMK was created.
 


enabled
Boolean enabled

 Specifies whether the CMK is enabled. When KeyState is Enabled this value is true,
 otherwise it is false.
 


description
String description

 The description of the CMK.
 


keyUsage
String keyUsage

 The cryptographic operations for which you can use the CMK.
 


keyState
String keyState

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


deletionDate
Date deletionDate

 The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is
 PendingDeletion.
 


validTo
Date validTo

 The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key
 material and the CMK becomes unusable. This value is present only for CMKs whose Origin is
 EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this
 value is omitted.
 


origin
String origin

 The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material.
 When this value is EXTERNAL, the key material was imported from your existing key management
 infrastructure or the CMK lacks key material. When this value is AWS_CLOUDHSM, the key material was
 created in the AWS CloudHSM cluster associated with a custom key store.
 


customKeyStoreId
String customKeyStoreId

 A unique identifier for the custom key store
 that contains the CMK. This value is present only when the CMK is created in a custom key store.
 


cloudHsmClusterId
String cloudHsmClusterId

 The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a
 custom key
 store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is
 present only when the CMK is created in a custom key store.
 


expirationModel
String expirationModel

 Specifies whether the CMK's key material expires. This value is present only when Origin is
 EXTERNAL, otherwise this value is omitted.
 


keyManager
String keyManager

 The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information
 about the difference, see Customer Master Keys
 in the AWS Key Management Service Developer Guide.
 


customerMasterKeySpec
String customerMasterKeySpec

 Describes the type of key material in the CMK.
 


encryptionAlgorithms
SdkInternalList<T> encryptionAlgorithms

 A list of encryption algorithms that the CMK supports. You cannot use the CMK with other encryption algorithms
 within AWS KMS.
 
 
 This field appears only when the KeyUsage of the CMK is ENCRYPT_DECRYPT.
 


signingAlgorithms
SdkInternalList<T> signingAlgorithms

 A list of signing algorithms that the CMK supports. You cannot use the CMK with other signing algorithms within
 AWS KMS.
 
 
 This field appears only when the KeyUsage of the CMK is SIGN_VERIFY.
 








Class com.amazonaws.services.kms.model.KeyUnavailableException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.KMSInternalException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.KMSInvalidSignatureException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.KMSInvalidStateException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.LimitExceededException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.ListAliasesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource
 Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.
 
 
 This parameter is optional. If you omit it, ListAliases returns all aliases in the account and
 region.
 


limit
Integer limit

 Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not
 return more than the specified number of items, but it might return fewer.
 
 
 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 in a subsequent request after you receive a response with truncated results. Set it to the
 value of NextMarker from the truncated response you just received.
 








Class com.amazonaws.services.kms.model.ListAliasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


aliases
SdkInternalList<T> aliases

 A list of aliases.
 


nextMarker
String nextMarker

 When Truncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent request.
 


truncated
Boolean truncated

 A flag that indicates whether there are more items in the list. When this value is true, the list in this
 response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
 to the Marker parameter in a subsequent request.
 








Class com.amazonaws.services.kms.model.ListGrantsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


limit
Integer limit

 Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not
 return more than the specified number of items, but it might return fewer.
 
 
 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 in a subsequent request after you receive a response with truncated results. Set it to the
 value of NextMarker from the truncated response you just received.
 


keyId
String keyId

 A unique identifier for the customer master key (CMK).
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you
 must use the key ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 








Class com.amazonaws.services.kms.model.ListGrantsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


grants
SdkInternalList<T> grants

 A list of grants.
 


nextMarker
String nextMarker

 When Truncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent request.
 


truncated
Boolean truncated

 A flag that indicates whether there are more items in the list. When this value is true, the list in this
 response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
 to the Marker parameter in a subsequent request.
 








Class com.amazonaws.services.kms.model.ListKeyPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 A unique identifier for the customer master key (CMK).
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 


limit
Integer limit

 Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not
 return more than the specified number of items, but it might return fewer.
 
 
 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.
 
 
 Only one policy can be attached to a key.
 


marker
String marker

 Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
 value of NextMarker from the truncated response you just received.
 








Class com.amazonaws.services.kms.model.ListKeyPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policyNames
SdkInternalList<T> policyNames

 A list of key policy names. The only valid value is default.
 


nextMarker
String nextMarker

 When Truncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent request.
 


truncated
Boolean truncated

 A flag that indicates whether there are more items in the list. When this value is true, the list in this
 response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
 to the Marker parameter in a subsequent request.
 








Class com.amazonaws.services.kms.model.ListKeysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


limit
Integer limit

 Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not
 return more than the specified number of items, but it might return fewer.
 
 
 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 in a subsequent request after you receive a response with truncated results. Set it to the
 value of NextMarker from the truncated response you just received.
 








Class com.amazonaws.services.kms.model.ListKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keys
SdkInternalList<T> keys

 A list of customer master keys (CMKs).
 


nextMarker
String nextMarker

 When Truncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent request.
 


truncated
Boolean truncated

 A flag that indicates whether there are more items in the list. When this value is true, the list in this
 response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
 to the Marker parameter in a subsequent request.
 








Class com.amazonaws.services.kms.model.ListResourceTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 A unique identifier for the customer master key (CMK).
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 


limit
Integer limit

 Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not
 return more than the specified number of items, but it might return fewer.
 
 
 This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a
 value, it defaults to 50.
 


marker
String marker

 Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
 value of NextMarker from the truncated response you just received.
 
 
 Do not attempt to construct this value. Use only the value of NextMarker from the truncated response
 you just received.
 








Class com.amazonaws.services.kms.model.ListResourceTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 A list of tags. Each tag consists of a tag key and a tag value.
 


nextMarker
String nextMarker

 When Truncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent request.
 
 
 Do not assume or infer any information from this value.
 


truncated
Boolean truncated

 A flag that indicates whether there are more items in the list. When this value is true, the list in this
 response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
 to the Marker parameter in a subsequent request.
 








Class com.amazonaws.services.kms.model.ListRetirableGrantsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


limit
Integer limit

 Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not
 return more than the specified number of items, but it might return fewer.
 
 
 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 in a subsequent request after you receive a response with truncated results. Set it to the
 value of NextMarker from the truncated 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


grants
SdkInternalList<T> grants

 A list of grants.
 


nextMarker
String nextMarker

 When Truncated is true, this element is present and contains the value to use for the
 Marker parameter in a subsequent request.
 


truncated
Boolean truncated

 A flag that indicates whether there are more items in the list. When this value is true, the list in this
 response is truncated. To get more items, pass the value of the NextMarker element in thisresponse
 to the Marker parameter in a subsequent request.
 








Class com.amazonaws.services.kms.model.MalformedPolicyDocumentException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.NotFoundException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.PutKeyPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 A unique identifier for the customer master key (CMK).
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 


policyName
String policyName

 The name of the key policy. The only valid value is default.
 


policy
String policy

 The key policy to attach to the CMK.
 
 
 The key policy must meet the following criteria:
 
 
 
 
 If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal
 that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on
 the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in
 the Default Key Policy section of the AWS Key Management Service Developer Guide.
 
 
 
 
 Each statement in the key policy must contain one or more principals. The principals 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 including the new principal in a key policy because the new principal might not be
 immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User
 Guide.
 
 
 
 
 The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the
 AWS Key Management Service Developer Guide.
 


bypassPolicyLockoutSafetyCheck
Boolean bypassPolicyLockoutSafetyCheck

 A flag to indicate whether to bypass the key policy lockout safety check.
 
 
 
 Setting this value to true increases the risk 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 that is making the request from making a
 subsequent PutKeyPolicy request on the CMK.
 
 
 The default value is false.
 








Class com.amazonaws.services.kms.model.PutKeyPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.ReEncryptRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ciphertextBlob
ByteBuffer ciphertextBlob

 Ciphertext of the data to reencrypt.
 


sourceEncryptionContext
SdkInternalMap<K,V> sourceEncryptionContext

 Specifies the encryption context to use to decrypt the ciphertext. Enter the same encryption context that was
 used to encrypt the ciphertext.
 
 
 An encryption context is a collection of non-secret key-value pairs that represents additional
 authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact
 case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting
 with a symmetric CMK, but it is highly recommended.
 
 
 For more information, see Encryption Context
 in the AWS Key Management Service Developer Guide.
 


sourceKeyId
String sourceKeyId

 A unique identifier for the CMK that is used to decrypt the ciphertext before it reencrypts it using the
 destination CMK.
 
 
 This parameter is required only when the ciphertext was encrypted under an asymmetric CMK. Otherwise, AWS KMS
 uses the metadata that it adds to the ciphertext blob to determine which CMK was used to encrypt the ciphertext.
 However, you can use this parameter to ensure that a particular CMK (of any kind) is used to decrypt the
 ciphertext before it is reencrypted.
 
 
 If you specify a KeyId value, the decrypt part of the ReEncrypt operation succeeds only
 if the specified CMK was used to encrypt the ciphertext.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/".
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


destinationKeyId
String destinationKeyId

 A unique identifier for the CMK that is used to reencrypt the data. Specify a symmetric or asymmetric CMK with a
 KeyUsage value of ENCRYPT_DECRYPT. To find the KeyUsage value of a CMK,
 use the DescribeKey operation.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or
 alias ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


destinationEncryptionContext
SdkInternalMap<K,V> destinationEncryptionContext

 Specifies that encryption context to use when the reencrypting the data.
 
 
 A destination encryption context is valid only when the destination CMK is a symmetric CMK. The standard
 ciphertext format for asymmetric CMKs does not include fields for metadata.
 
 
 An encryption context is a collection of non-secret key-value pairs that represents additional
 authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact
 case-sensitive match) encryption context to decrypt the data. An encryption context is optional when encrypting
 with a symmetric CMK, but it is highly recommended.
 
 
 For more information, see Encryption Context
 in the AWS Key Management Service Developer Guide.
 


sourceEncryptionAlgorithm
String sourceEncryptionAlgorithm

 Specifies the encryption algorithm that AWS KMS will use to decrypt the ciphertext before it is reencrypted. The
 default value, SYMMETRIC_DEFAULT, represents the algorithm used for symmetric CMKs.
 
 
 Specify the same algorithm that was used to encrypt the ciphertext. If you specify a different algorithm, the
 decrypt attempt fails.
 
 
 This parameter is required only when the ciphertext was encrypted under an asymmetric CMK.
 


destinationEncryptionAlgorithm
String destinationEncryptionAlgorithm

 Specifies the encryption algorithm that AWS KMS will use to reecrypt the data after it has decrypted it. The
 default value, SYMMETRIC_DEFAULT, represents the encryption algorithm used for symmetric CMKs.
 
 
 This parameter is required only when the destination CMK is an asymmetric CMK.
 


grantTokens
SdkInternalList<T> 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.ReEncryptResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ciphertextBlob
ByteBuffer ciphertextBlob

 The reencrypted data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not
 Base64-encoded.
 


sourceKeyId
String sourceKeyId

 Unique identifier of the CMK used to originally encrypt the data.
 


keyId
String keyId

 Unique identifier of the CMK used to reencrypt the data.
 


sourceEncryptionAlgorithm
String sourceEncryptionAlgorithm

 The encryption algorithm that was used to decrypt the ciphertext before it was reencrypted.
 


destinationEncryptionAlgorithm
String destinationEncryptionAlgorithm

 The encryption algorithm that was used to reencrypt the data.
 








Class com.amazonaws.services.kms.model.RetireGrantRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


grantToken
String grantToken

 Token that identifies the grant to be retired.
 


keyId
String keyId

 The Amazon Resource Name (ARN) of the CMK associated with the grant.
 
 
 For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
 


grantId
String grantId

 Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant
 operation.
 
 
 
 
 Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
 
 
 








Class com.amazonaws.services.kms.model.RetireGrantResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.RevokeGrantRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 A unique identifier for the customer master key associated with the grant.
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you
 must use the key ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 


grantId
String grantId

 Identifier of the grant to be revoked.
 








Class com.amazonaws.services.kms.model.RevokeGrantResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.ScheduleKeyDeletionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 The unique identifier of the customer master key (CMK) to delete.
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 


pendingWindowInDays
Integer pendingWindowInDays

 The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer
 master key (CMK).
 
 
 This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a
 value, it defaults to 30.
 








Class com.amazonaws.services.kms.model.ScheduleKeyDeletionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyId
String keyId

 The unique identifier of the customer master key (CMK) for which deletion is scheduled.
 


deletionDate
Date deletionDate

 The date and time after which AWS KMS deletes the customer master key (CMK).
 








Class com.amazonaws.services.kms.model.SignRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 Identifies an asymmetric CMK. AWS KMS uses the private key in the asymmetric CMK to sign the message. The
 KeyUsage type of the CMK must be SIGN_VERIFY. To find the KeyUsage of a
 CMK, use the DescribeKey operation.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or
 alias ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


message
ByteBuffer message

 Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide
 the message digest.
 
 
 If you provide a message, AWS KMS generates a hash digest of the message and then signs it.
 


messageType
String messageType

 Tells AWS KMS whether the value of the Message parameter is a message or message digest. To indicate
 a message, enter RAW. To indicate a message digest, enter DIGEST.
 


grantTokens
SdkInternalList<T> grantTokens

 A list of grant tokens.
 
 
 For more information, see Grant Tokens in the
 AWS Key Management Service Developer Guide.
 


signingAlgorithm
String signingAlgorithm

 Specifies the signing algorithm to use when signing the message.
 
 
 Choose an algorithm that is compatible with the type and size of the specified asymmetric CMK.
 








Class com.amazonaws.services.kms.model.SignResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyId
String keyId

 The Amazon Resource Name (ARN) of the asymmetric CMK that was used to sign the message.
 


signature
ByteBuffer signature

 The cryptographic signature that was generated for the message.
 


signingAlgorithm
String signingAlgorithm

 The signing algorithm that was used to sign the message.
 








Class com.amazonaws.services.kms.model.Tag extends Object implements Serializable


Serialized Fields


tagKey
String tagKey

 The key of the tag.
 


tagValue
String tagValue

 The value of the tag.
 








Class com.amazonaws.services.kms.model.TagException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 A unique identifier for the CMK you are tagging.
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 


tags
SdkInternalList<T> tags

 One or more tags. Each tag consists of a tag key and a tag value.
 








Class com.amazonaws.services.kms.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.UnsupportedOperationException extends AWSKMSException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 A unique identifier for the CMK from which you are removing tags.
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 


tagKeys
SdkInternalList<T> tagKeys

 One or more tag keys. Specify only the tag keys, not the tag values.
 








Class com.amazonaws.services.kms.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.UpdateAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


aliasName
String aliasName

 Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the
 alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.
 


targetKeyId
String targetKeyId

 Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this
 CMK.
 
 
 The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type
 as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 
 
 To verify that the alias is mapped to the correct CMK, use ListAliases.
 








Class com.amazonaws.services.kms.model.UpdateAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.UpdateCustomKeyStoreRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


customKeyStoreId
String customKeyStoreId

 Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of
 a custom key store, use the DescribeCustomKeyStores operation.
 


newCustomKeyStoreName
String newCustomKeyStoreName

 Changes the friendly name of the custom key store to the value that you specify. The custom key store name must
 be unique in the AWS account.
 


keyStorePassword
String keyStorePassword

 Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is
 associated with the custom key store.
 
 
 This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set
 or change the password of any users in the AWS CloudHSM cluster.
 


cloudHsmClusterId
String cloudHsmClusterId

 Associates the custom key store with a related AWS CloudHSM cluster.
 
 
 Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a
 backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to
 associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the
 requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster,
 use the DescribeClusters
 operation.
 








Class com.amazonaws.services.kms.model.UpdateCustomKeyStoreResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.UpdateKeyDescriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 A unique identifier for the customer master key (CMK).
 
 
 Specify the key ID or the Amazon Resource Name (ARN) of the CMK.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
 


description
String description

 New description for the CMK.
 








Class com.amazonaws.services.kms.model.UpdateKeyDescriptionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.kms.model.VerifyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyId
String keyId

 Identifies the asymmetric CMK that will be used to verify the signature. This must be the same CMK that was used
 to generate the signature. If you specify a different CMK, the signature verification fails.
 
 
 To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name,
 prefix it with "alias/". To specify a CMK in a different AWS account, you must use the key ARN or
 alias ARN.
 
 
 For example:
 
 
 
 
 Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
 
 
 
 
 Alias name: alias/ExampleAlias
 
 
 
 
 Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
 
 
 
 
 To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and
 alias ARN, use ListAliases.
 


message
ByteBuffer message

 Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the
 message. If you submit a digest, use the MessageType parameter with a value of DIGEST.
 
 
 If the message specified here is different from the message that was signed, the signature verification fails. A
 message and its hash digest are considered to be the same message.
 


messageType
String messageType

 Tells AWS KMS whether the value of the Message parameter is a message or message digest. The default
 value, RAW, indicates a message. To indicate a message digest, enter DIGEST.
 
 
 
 Use the DIGEST value only when the value of the Message parameter is a message digest.
 If you use the DIGEST value with a raw message, the security of the verification operation can be
 compromised.
 
 


signature
ByteBuffer signature

 The signature that the Sign operation generated.
 


signingAlgorithm
String signingAlgorithm

 The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature
 verification fails.
 


grantTokens
SdkInternalList<T> 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.VerifyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyId
String keyId

 The unique identifier for the asymmetric CMK that was used to verify the signature.
 


signatureValid
Boolean signatureValid

 A Boolean value that indicates whether the signature was verified. A value of True indicates that
 the Signature was produced by signing the Message with the specified KeyID
 and SigningAlgorithm. If the signature is not verified, the Verify operation fails with
 a KMSInvalidSignatureException exception.
 


signingAlgorithm
String signingAlgorithm

 The signing algorithm that was used to verify the signature.
 








Package com.amazonaws.services.lakeformation.model




Class com.amazonaws.services.lakeformation.model.AlreadyExistsException extends AWSLakeFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lakeformation.model.AWSLakeFormationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lakeformation.model.BatchGrantPermissionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata
 store. It contains database definitions, table definitions, and other control information to manage your AWS Lake
 Formation environment.
 


entries
List<E> entries

 A list of up to 20 entries for resource permissions to be granted by batch operation to the principal.
 








Class com.amazonaws.services.lakeformation.model.BatchGrantPermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failures
List<E> failures

 A list of failures to grant permissions to the resources.
 








Class com.amazonaws.services.lakeformation.model.BatchPermissionsFailureEntry extends Object implements Serializable


Serialized Fields


requestEntry
BatchPermissionsRequestEntry requestEntry

 An identifier for an entry of the batch request.
 


error
ErrorDetail error

 An error message that applies to the failure of the entry.
 








Class com.amazonaws.services.lakeformation.model.BatchPermissionsRequestEntry extends Object implements Serializable


Serialized Fields


id
String id

 A unique identifier for the batch permissions request entry.
 


principal
DataLakePrincipal principal

 The principal to be granted a permission.
 


resource
Resource resource

 The resource to which the principal is to be granted a permission.
 


permissions
List<E> permissions

 The permissions to be granted.
 


permissionsWithGrantOption
List<E> permissionsWithGrantOption

 Indicates if the option to pass permissions is granted.
 








Class com.amazonaws.services.lakeformation.model.BatchRevokePermissionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata
 store. It contains database definitions, table definitions, and other control information to manage your AWS Lake
 Formation environment.
 


entries
List<E> entries

 A list of up to 20 entries for resource permissions to be revoked by batch operation to the principal.
 








Class com.amazonaws.services.lakeformation.model.BatchRevokePermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failures
List<E> failures

 A list of failures to revoke permissions to the resources.
 








Class com.amazonaws.services.lakeformation.model.CatalogResource extends Object implements Serializable




Class com.amazonaws.services.lakeformation.model.ColumnWildcard extends Object implements Serializable


Serialized Fields


excludedColumnNames
List<E> excludedColumnNames

 Excludes column names. Any column with this name will be excluded.
 








Class com.amazonaws.services.lakeformation.model.ConcurrentModificationException extends AWSLakeFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lakeformation.model.DatabaseResource extends Object implements Serializable


Serialized Fields


name
String name

 The name of the database resource. Unique to the Data Catalog.
 








Class com.amazonaws.services.lakeformation.model.DataLakePrincipal extends Object implements Serializable


Serialized Fields


dataLakePrincipalIdentifier
String dataLakePrincipalIdentifier

 An identifier for the AWS Lake Formation principal.
 








Class com.amazonaws.services.lakeformation.model.DataLakeSettings extends Object implements Serializable


Serialized Fields


dataLakeAdmins
List<E> dataLakeAdmins

 A list of AWS Lake Formation principals.
 


createDatabaseDefaultPermissions
List<E> createDatabaseDefaultPermissions

 A list of up to three principal permissions entries for default create database permissions.
 


createTableDefaultPermissions
List<E> createTableDefaultPermissions

 A list of up to three principal permissions entries for default create table permissions.
 








Class com.amazonaws.services.lakeformation.model.DataLocationResource extends Object implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) that uniquely identifies the data location resource.
 








Class com.amazonaws.services.lakeformation.model.DeregisterResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource that you want to deregister.
 








Class com.amazonaws.services.lakeformation.model.DeregisterResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lakeformation.model.DescribeResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The resource ARN.
 








Class com.amazonaws.services.lakeformation.model.DescribeResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceInfo
ResourceInfo resourceInfo

 A structure containing information about an AWS Lake Formation resource.
 








Class com.amazonaws.services.lakeformation.model.EntityNotFoundException extends AWSLakeFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lakeformation.model.ErrorDetail extends Object implements Serializable


Serialized Fields


errorCode
String errorCode

 The code associated with this error.
 


errorMessage
String errorMessage

 A message describing the error.
 








Class com.amazonaws.services.lakeformation.model.FilterCondition extends Object implements Serializable


Serialized Fields


field
String field

 The field to filter in the filter condition.
 


comparisonOperator
String comparisonOperator

 The comparison operator used in the filter condition.
 


stringValueList
List<E> stringValueList

 A string with values used in evaluating the filter condition.
 








Class com.amazonaws.services.lakeformation.model.GetDataLakeSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata
 store. It contains database definitions, table definitions, and other control information to manage your AWS Lake
 Formation environment.
 








Class com.amazonaws.services.lakeformation.model.GetDataLakeSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataLakeSettings
DataLakeSettings dataLakeSettings

 A list of AWS Lake Formation principals.
 








Class com.amazonaws.services.lakeformation.model.GetEffectivePermissionsForPathRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata
 store. It contains database definitions, table definitions, and other control information to manage your AWS Lake
 Formation environment.
 


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource for which you want to get permissions.
 


nextToken
String nextToken

 A continuation token, if this is not the first call to retrieve this list.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 








Class com.amazonaws.services.lakeformation.model.GetEffectivePermissionsForPathResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


permissions
List<E> permissions

 A list of the permissions for the specified table or database resource located at the path in Amazon S3.
 


nextToken
String nextToken

 A continuation token, if this is not the first call to retrieve this list.
 








Class com.amazonaws.services.lakeformation.model.GrantPermissionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata
 store. It contains database definitions, table definitions, and other control information to manage your AWS Lake
 Formation environment.
 


principal
DataLakePrincipal principal

 The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and
 they are defined by their principal type and their ARN.
 
 
 Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that
 same ARN, the resource maintains the permissions already granted.
 


resource
Resource resource

 The resource to which permissions are to be granted. Resources in AWS Lake Formation are the Data Catalog,
 databases, and tables.
 


permissions
List<E> permissions

 The permissions granted to the principal on the resource. AWS Lake Formation defines privileges to grant and
 revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.
 AWS Lake Formation requires that each principal be authorized to perform a specific task on AWS Lake Formation
 resources.
 


permissionsWithGrantOption
List<E> permissionsWithGrantOption

 Indicates a list of the granted permissions that the principal may pass to other users. These permissions may
 only be a subset of the permissions granted in the Privileges.
 








Class com.amazonaws.services.lakeformation.model.GrantPermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lakeformation.model.InternalServiceException extends AWSLakeFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lakeformation.model.InvalidInputException extends AWSLakeFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lakeformation.model.ListPermissionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata
 store. It contains database definitions, table definitions, and other control information to manage your AWS Lake
 Formation environment.
 


principal
DataLakePrincipal principal

 Specifies a principal to filter the permissions returned.
 


resourceType
String resourceType

 Specifies a resource type to filter the permissions returned.
 


resource
Resource resource

 A resource where you will get a list of the principal permissions.
 
 
 This operation does not support getting privileges on a table with columns. Instead, call this operation on the
 table, and the operation returns the table and the table w columns.
 


nextToken
String nextToken

 A continuation token, if this is not the first call to retrieve this list.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 








Class com.amazonaws.services.lakeformation.model.ListPermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


principalResourcePermissions
List<E> principalResourcePermissions

 A list of principals and their permissions on the resource for the specified principal and resource types.
 


nextToken
String nextToken

 A continuation token, if this is not the first call to retrieve this list.
 








Class com.amazonaws.services.lakeformation.model.ListResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filterConditionList
List<E> filterConditionList

 Any applicable row-level and/or column-level filtering conditions for the resources.
 


maxResults
Integer maxResults

 The maximum number of resource results.
 


nextToken
String nextToken

 A continuation token, if this is not the first call to retrieve these resources.
 








Class com.amazonaws.services.lakeformation.model.ListResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceInfoList
List<E> resourceInfoList

 A summary of the data lake resources.
 


nextToken
String nextToken

 A continuation token, if this is not the first call to retrieve these resources.
 








Class com.amazonaws.services.lakeformation.model.OperationTimeoutException extends AWSLakeFormationException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lakeformation.model.PrincipalPermissions extends Object implements Serializable


Serialized Fields


principal
DataLakePrincipal principal

 The principal who is granted permissions.
 


permissions
List<E> permissions

 The permissions that are granted to the principal.
 








Class com.amazonaws.services.lakeformation.model.PrincipalResourcePermissions extends Object implements Serializable


Serialized Fields


principal
DataLakePrincipal principal

 The Data Lake principal to be granted or revoked permissions.
 


resource
Resource resource

 The resource where permissions are to be granted or revoked.
 


permissions
List<E> permissions

 The permissions to be granted or revoked on the resource.
 


permissionsWithGrantOption
List<E> permissionsWithGrantOption

 Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).
 








Class com.amazonaws.services.lakeformation.model.PutDataLakeSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata
 store. It contains database definitions, table definitions, and other control information to manage your AWS Lake
 Formation environment.
 


dataLakeSettings
DataLakeSettings dataLakeSettings

 A list of AWS Lake Formation principals.
 








Class com.amazonaws.services.lakeformation.model.PutDataLakeSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lakeformation.model.RegisterResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource that you want to register.
 


useServiceLinkedRole
Boolean useServiceLinkedRole

 Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog.
 


roleArn
String roleArn

 The identifier for the role.
 








Class com.amazonaws.services.lakeformation.model.RegisterResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


catalog
CatalogResource catalog

 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata
 store. It contains database definitions, table definitions, and other control information to manage your AWS Lake
 Formation environment.
 


database
DatabaseResource database

 The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions
 organized into a logical group. You can Grant and Revoke database permissions to a principal.
 


table
TableResource table

 The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke
 table privileges to a principal.
 


tableWithColumns
TableWithColumnsResource tableWithColumns

 The table with columns for the resource. A principal with permissions to this resource can select metadata from
 the columns of a table in the Data Catalog and the underlying data in Amazon S3.
 


dataLocation
DataLocationResource dataLocation

 The location of an Amazon S3 path where permissions are granted or revoked.
 








Class com.amazonaws.services.lakeformation.model.ResourceInfo extends Object implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 


roleArn
String roleArn

 The IAM role that registered a resource.
 


lastModified
Date lastModified

 The date and time the resource was last modified.
 








Class com.amazonaws.services.lakeformation.model.RevokePermissionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalogId
String catalogId

 The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata
 store. It contains database definitions, table definitions, and other control information to manage your AWS Lake
 Formation environment.
 


principal
DataLakePrincipal principal

 The principal to be revoked permissions on the resource.
 


resource
Resource resource

 The resource to which permissions are to be revoked.
 


permissions
List<E> permissions

 The permissions revoked to the principal on the resource. For information about permissions, see Security and Access Control to
 Metadata and Data.
 


permissionsWithGrantOption
List<E> permissionsWithGrantOption

 Indicates a list of permissions for which to revoke the grant option allowing the principal to pass permissions
 to other principals.
 








Class com.amazonaws.services.lakeformation.model.RevokePermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lakeformation.model.TableResource extends Object implements Serializable


Serialized Fields


databaseName
String databaseName

 The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table
 definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.
 


name
String name

 The name of the table.
 








Class com.amazonaws.services.lakeformation.model.TableWithColumnsResource extends Object implements Serializable


Serialized Fields


databaseName
String databaseName

 The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of
 associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a
 principal.
 


name
String name

 The name of the table resource. A table is a metadata definition that represents your data. You can Grant and
 Revoke table privileges to a principal.
 


columnNames
List<E> columnNames

 The list of column names for the table. At least one of ColumnNames or ColumnWildcard
 is required.
 


columnWildcard
ColumnWildcard columnWildcard

 A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or
 ColumnWildcard is required.
 








Class com.amazonaws.services.lakeformation.model.UpdateResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


roleArn
String roleArn

 The new role to use for the given resource registered in AWS Lake Formation.
 


resourceArn
String resourceArn

 The resource ARN.
 








Class com.amazonaws.services.lakeformation.model.UpdateResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.lambda.invoke




Class com.amazonaws.services.lambda.invoke.LambdaFunctionException extends AmazonClientException implements Serializable


Serialized Fields


errorType
String errorType


stackTraces
List<E> stackTraces


functionError
String functionError








Class com.amazonaws.services.lambda.invoke.LambdaSerializationException extends RuntimeException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.lambda.model




Class com.amazonaws.services.lambda.model.AccountLimit extends Object implements Serializable


Serialized Fields


totalCodeSize
Long totalCodeSize

 The amount of storage space that you can use for all deployment packages and layer archives.
 


codeSizeUnzipped
Long codeSizeUnzipped

 The maximum size of a function's deployment package and layers when they're extracted.
 


codeSizeZipped
Long codeSizeZipped

 The maximum size of a deployment package when it's uploaded directly to AWS Lambda. Use Amazon S3 for larger
 files.
 


concurrentExecutions
Integer concurrentExecutions

 The maximum number of simultaneous function executions.
 


unreservedConcurrentExecutions
Integer unreservedConcurrentExecutions

 The maximum number of simultaneous function executions, minus the capacity that's reserved for individual
 functions with PutFunctionConcurrency.
 








Class com.amazonaws.services.lambda.model.AccountUsage extends Object implements Serializable


Serialized Fields


totalCodeSize
Long totalCodeSize

 The amount of storage space, in bytes, that's being used by deployment packages and layer archives.
 


functionCount
Long functionCount

 The number of Lambda functions.
 








Class com.amazonaws.services.lambda.model.AddLayerVersionPermissionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


layerName
String layerName

 The name or Amazon Resource Name (ARN) of the layer.
 


versionNumber
Long versionNumber

 The version number.
 


statementId
String statementId

 An identifier that distinguishes the policy from others on the same layer version.
 


action
String action

 The API action that grants access to the layer. For example, lambda:GetLayerVersion.
 


principal
String principal

 An account ID, or * to grant permission to all AWS accounts.
 


organizationId
String organizationId

 With the principal set to *, grant permission to all accounts in the specified organization.
 


revisionId
String revisionId

 Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy
 that has changed since you last read it.
 








Class com.amazonaws.services.lambda.model.AddLayerVersionPermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


statement
String statement

 The permission statement.
 


revisionId
String revisionId

 A unique identifier for the current revision of the policy.
 








Class com.amazonaws.services.lambda.model.AddPermissionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function, version, or alias.
 
 
 Name formats
 
 
 
 
 Function name - my-function (name-only), my-function:v1 (with alias).
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 You can append a version number or alias to any of the formats. The length constraint applies only to the full
 ARN. If you specify only the function name, it is limited to 64 characters in length.
 


statementId
String statementId

 A statement identifier that differentiates the statement from others in the same policy.
 


action
String action

 The action that the principal can use on the function. For example, lambda:InvokeFunction or
 lambda:GetFunction.
 


principal
String principal

 The AWS service or account that invokes the function. If you specify a service, use SourceArn or
 SourceAccount to limit who can invoke the function through that service.
 


sourceArn
String sourceArn

 For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or
 Amazon SNS topic.
 


sourceAccount
String sourceAccount

 For AWS services, the ID of the account that owns the resource. Use this instead of SourceArn to
 grant permission to resources that are owned by another account (for example, all of an account's Amazon S3
 buckets). Or use it together with SourceArn to ensure that the resource is owned by the specified
 account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account.
 


eventSourceToken
String eventSourceToken

 For Alexa Smart Home functions, a token that must be supplied by the invoker.
 


qualifier
String qualifier

 Specify a version or alias to add permissions to a published version of the function.
 


revisionId
String revisionId

 Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a
 policy that has changed since you last read it.
 








Class com.amazonaws.services.lambda.model.AddPermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


statement
String statement

 The permission statement that's added to the function policy.
 








Class com.amazonaws.services.lambda.model.AliasConfiguration extends Object implements Serializable


Serialized Fields


aliasArn
String aliasArn

 The Amazon Resource Name (ARN) of the alias.
 


name
String name

 The name of the alias.
 


functionVersion
String functionVersion

 The function version that the alias invokes.
 


description
String description

 A description of the alias.
 


routingConfig
AliasRoutingConfiguration routingConfig

 The routing
 configuration of the alias.
 


revisionId
String revisionId

 A unique identifier that changes when you update the alias.
 








Class com.amazonaws.services.lambda.model.AliasRoutingConfiguration extends Object implements Serializable


Serialized Fields


additionalVersionWeights
SdkInternalMap<K,V> additionalVersionWeights

 The name of the second alias, and the percentage of traffic that's routed to it.
 








Class com.amazonaws.services.lambda.model.AWSLambdaException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lambda.model.CodeStorageExceededException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 The exception type.
 








Class com.amazonaws.services.lambda.model.Concurrency extends Object implements Serializable


Serialized Fields


reservedConcurrentExecutions
Integer reservedConcurrentExecutions

 The number of concurrent executions that are reserved for this function. For more information, see Managing Concurrency.
 








Class com.amazonaws.services.lambda.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - MyFunction.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
 
 
 
 
 Partial ARN - 123456789012:function:MyFunction.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


name
String name

 The name of the alias.
 


functionVersion
String functionVersion

 The function version that the alias invokes.
 


description
String description

 A description of the alias.
 


routingConfig
AliasRoutingConfiguration routingConfig

 The routing
 configuration of the alias.
 








Class com.amazonaws.services.lambda.model.CreateAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


aliasArn
String aliasArn

 The Amazon Resource Name (ARN) of the alias.
 


name
String name

 The name of the alias.
 


functionVersion
String functionVersion

 The function version that the alias invokes.
 


description
String description

 A description of the alias.
 


routingConfig
AliasRoutingConfiguration routingConfig

 The routing
 configuration of the alias.
 


revisionId
String revisionId

 A unique identifier that changes when you update the alias.
 








Class com.amazonaws.services.lambda.model.CreateEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventSourceArn
String eventSourceArn

 The Amazon Resource Name (ARN) of the event source.
 
 
 
 
 Amazon Kinesis - The ARN of the data stream or a stream consumer.
 
 
 
 
 Amazon DynamoDB Streams - The ARN of the stream.
 
 
 
 
 Amazon Simple Queue Service - The ARN of the queue.
 
 
 


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - MyFunction.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
 
 
 
 
 Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
 
 
 
 
 Partial ARN - 123456789012:function:MyFunction.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64
 characters in length.
 


enabled
Boolean enabled

 Disables the event source mapping to pause polling and invocation.
 


batchSize
Integer batchSize

 The maximum number of items to retrieve in a single batch.
 
 
 
 
 Amazon Kinesis - Default 100. Max 10,000.
 
 
 
 
 Amazon DynamoDB Streams - Default 100. Max 1,000.
 
 
 
 
 Amazon Simple Queue Service - Default 10. Max 10.
 
 
 


maximumBatchingWindowInSeconds
Integer maximumBatchingWindowInSeconds

 The maximum amount of time to gather records before invoking the function, in seconds.
 


parallelizationFactor
Integer parallelizationFactor

 (Streams) The number of batches to process from each shard concurrently.
 


startingPosition
String startingPosition

 The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams
 sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
 


startingPositionTimestamp
Date startingPositionTimestamp

 With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.
 


destinationConfig
DestinationConfig destinationConfig

 (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
 


maximumRecordAgeInSeconds
Integer maximumRecordAgeInSeconds

 (Streams) The maximum age of a record that Lambda sends to a function for processing.
 


bisectBatchOnFunctionError
Boolean bisectBatchOnFunctionError

 (Streams) If the function returns an error, split the batch in two and retry.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 (Streams) The maximum number of times to retry when the function returns an error.
 








Class com.amazonaws.services.lambda.model.CreateEventSourceMappingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uUID
String uUID

 The identifier of the event source mapping.
 


batchSize
Integer batchSize

 The maximum number of items to retrieve in a single batch.
 


maximumBatchingWindowInSeconds
Integer maximumBatchingWindowInSeconds

 The maximum amount of time to gather records before invoking the function, in seconds.
 


parallelizationFactor
Integer parallelizationFactor

 (Streams) The number of batches to process from each shard concurrently.
 


eventSourceArn
String eventSourceArn

 The Amazon Resource Name (ARN) of the event source.
 


functionArn
String functionArn

 The ARN of the Lambda function.
 


lastModified
Date lastModified

 The date that the event source mapping was last updated, or its state changed.
 


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 one of the following: Creating,
 Enabling, Enabled, Disabling, Disabled, Updating
 , or Deleting.
 


stateTransitionReason
String stateTransitionReason

 Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
 


destinationConfig
DestinationConfig destinationConfig

 (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
 


maximumRecordAgeInSeconds
Integer maximumRecordAgeInSeconds

 (Streams) The maximum age of a record that Lambda sends to a function for processing.
 


bisectBatchOnFunctionError
Boolean bisectBatchOnFunctionError

 (Streams) If the function returns an error, split the batch in two and retry.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 (Streams) The maximum number of times to retry when the function returns an error.
 








Class com.amazonaws.services.lambda.model.CreateFunctionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - my-function.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


runtime
String runtime

 The identifier of the function's runtime.
 


role
String role

 The Amazon Resource Name (ARN) of the function's execution role.
 


handler
String handler

 The name of the method within your code that Lambda calls to execute your function. The format includes the file
 name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
 


code
FunctionCode code

 The code for the function.
 


description
String description

 A description of the function.
 


timeout
Integer timeout

 The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum
 allowed value is 900 seconds.
 


memorySize
Integer memorySize

 The amount of memory that your function has access to. Increasing the function's memory also increases its CPU
 allocation. The default value is 128 MB. The value must be a multiple of 64 MB.
 


publish
Boolean publish

 Set to true to publish the first version of the function during creation.
 


vpcConfig
VpcConfig vpcConfig

 For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.
 When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more
 information, see VPC Settings.
 


deadLetterConfig
DeadLetterConfig deadLetterConfig

 A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when
 they fail processing. For more information, see Dead Letter Queues.
 


environment
Environment environment

 Environment variables that are accessible from function code during execution.
 


kMSKeyArn
String kMSKeyArn

 The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment
 variables. If it's not provided, AWS Lambda uses a default service key.
 


tracingConfig
TracingConfig tracingConfig

 Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
 


tags
SdkInternalMap<K,V> tags

 A list of tags to apply to the function.
 


layers
SdkInternalList<T> layers

 A list of function layers to
 add to the function's execution environment. Specify each layer by its ARN, including the version.
 








Class com.amazonaws.services.lambda.model.CreateFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


functionName
String functionName

 The name of the function.
 


functionArn
String functionArn

 The function's Amazon Resource Name (ARN).
 


runtime
String runtime

 The runtime environment for the Lambda function.
 


role
String role

 The function's execution role.
 


handler
String handler

 The function that Lambda calls to begin executing your function.
 


codeSize
Long codeSize

 The size of the function's deployment package, in bytes.
 


description
String description

 The function's description.
 


timeout
Integer timeout

 The amount of time that Lambda allows a function to run before stopping it.
 


memorySize
Integer memorySize

 The memory that's allocated to the function.
 


lastModified
String lastModified

 The date and time that the function was last updated, in ISO-8601
 format (YYYY-MM-DDThh:mm:ss.sTZD).
 


codeSha256
String codeSha256

 The SHA256 hash of the function's deployment package.
 


version
String version

 The version of the Lambda function.
 


vpcConfig
VpcConfigResponse vpcConfig

 The function's networking configuration.
 


deadLetterConfig
DeadLetterConfig deadLetterConfig

 The function's dead letter queue.
 


environment
EnvironmentResponse environment

 The function's environment variables.
 


kMSKeyArn
String kMSKeyArn

 The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've
 configured a customer managed CMK.
 


tracingConfig
TracingConfigResponse tracingConfig

 The function's AWS X-Ray tracing configuration.
 


masterArn
String masterArn

 For Lambda@Edge functions, the ARN of the master function.
 


revisionId
String revisionId

 The latest updated revision of the function or alias.
 


layers
SdkInternalList<T> layers

 The function's  layers.
 


state
String state

 The current state of the function. When the state is Inactive, you can reactivate the function by
 invoking it.
 


stateReason
String stateReason

 The reason for the function's current state.
 


stateReasonCode
String stateReasonCode

 The reason code for the function's current state. When the code is Creating, you can't invoke or
 modify the function.
 


lastUpdateStatus
String lastUpdateStatus

 The status of the last update that was performed on the function. This is first set to Successful
 after function creation completes.
 


lastUpdateStatusReason
String lastUpdateStatusReason

 The reason for the last update that was performed on the function.
 


lastUpdateStatusReasonCode
String lastUpdateStatusReasonCode

 The reason code for the last update that was performed on the function.
 








Class com.amazonaws.services.lambda.model.DeadLetterConfig extends Object implements Serializable


Serialized Fields


targetArn
String targetArn

 The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.
 








Class com.amazonaws.services.lambda.model.DeleteAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - MyFunction.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
 
 
 
 
 Partial ARN - 123456789012:function:MyFunction.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


name
String name

 The name of the alias.
 








Class com.amazonaws.services.lambda.model.DeleteAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lambda.model.DeleteEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


uUID
String uUID

 The identifier of the event source mapping.
 








Class com.amazonaws.services.lambda.model.DeleteEventSourceMappingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uUID
String uUID

 The identifier of the event source mapping.
 


batchSize
Integer batchSize

 The maximum number of items to retrieve in a single batch.
 


maximumBatchingWindowInSeconds
Integer maximumBatchingWindowInSeconds

 The maximum amount of time to gather records before invoking the function, in seconds.
 


parallelizationFactor
Integer parallelizationFactor

 (Streams) The number of batches to process from each shard concurrently.
 


eventSourceArn
String eventSourceArn

 The Amazon Resource Name (ARN) of the event source.
 


functionArn
String functionArn

 The ARN of the Lambda function.
 


lastModified
Date lastModified

 The date that the event source mapping was last updated, or its state changed.
 


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 one of the following: Creating,
 Enabling, Enabled, Disabling, Disabled, Updating
 , or Deleting.
 


stateTransitionReason
String stateTransitionReason

 Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
 


destinationConfig
DestinationConfig destinationConfig

 (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
 


maximumRecordAgeInSeconds
Integer maximumRecordAgeInSeconds

 (Streams) The maximum age of a record that Lambda sends to a function for processing.
 


bisectBatchOnFunctionError
Boolean bisectBatchOnFunctionError

 (Streams) If the function returns an error, split the batch in two and retry.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 (Streams) The maximum number of times to retry when the function returns an error.
 








Class com.amazonaws.services.lambda.model.DeleteFunctionConcurrencyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - my-function.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 








Class com.amazonaws.services.lambda.model.DeleteFunctionConcurrencyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lambda.model.DeleteFunctionEventInvokeConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function, version, or alias.
 
 
 Name formats
 
 
 
 
 Function name - my-function (name-only), my-function:v1 (with alias).
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 You can append a version number or alias to any of the formats. The length constraint applies only to the full
 ARN. If you specify only the function name, it is limited to 64 characters in length.
 


qualifier
String qualifier

 A version number or alias name.
 








Class com.amazonaws.services.lambda.model.DeleteFunctionEventInvokeConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lambda.model.DeleteFunctionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function or version.
 
 
 Name formats
 
 
 
 
 Function name - my-function (name-only), my-function:1 (with version).
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 You can append a version number or alias to any of the formats. The length constraint applies only to the full
 ARN. If you specify only the function name, it is limited to 64 characters in length.
 


qualifier
String qualifier

 Specify a version to delete. You can't delete a version that's referenced by an alias.
 








Class com.amazonaws.services.lambda.model.DeleteFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lambda.model.DeleteLayerVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


layerName
String layerName

 The name or Amazon Resource Name (ARN) of the layer.
 


versionNumber
Long versionNumber

 The version number.
 








Class com.amazonaws.services.lambda.model.DeleteLayerVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lambda.model.DeleteProvisionedConcurrencyConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - my-function.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


qualifier
String qualifier

 The version number or alias name.
 








Class com.amazonaws.services.lambda.model.DeleteProvisionedConcurrencyConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lambda.model.DestinationConfig extends Object implements Serializable


Serialized Fields


onSuccess
OnSuccess onSuccess

 The destination configuration for successful invocations.
 


onFailure
OnFailure onFailure

 The destination configuration for failed invocations.
 








Class com.amazonaws.services.lambda.model.EC2AccessDeniedException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.EC2ThrottledException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.EC2UnexpectedException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type


eC2ErrorCode
String eC2ErrorCode








Class com.amazonaws.services.lambda.model.ENILimitReachedException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.Environment extends Object implements Serializable


Serialized Fields


variables
SdkInternalMap<K,V> variables

 Environment variable key-value pairs.
 








Class com.amazonaws.services.lambda.model.EnvironmentError extends Object implements Serializable


Serialized Fields


errorCode
String errorCode

 The error code.
 


message
String message

 The error message.
 








Class com.amazonaws.services.lambda.model.EnvironmentResponse extends Object implements Serializable


Serialized Fields


variables
SdkInternalMap<K,V> variables

 Environment variable key-value pairs.
 


error
EnvironmentError error

 Error messages for environment variables that couldn't be applied.
 








Class com.amazonaws.services.lambda.model.EventSourceMappingConfiguration extends Object implements Serializable


Serialized Fields


uUID
String uUID

 The identifier of the event source mapping.
 


batchSize
Integer batchSize

 The maximum number of items to retrieve in a single batch.
 


maximumBatchingWindowInSeconds
Integer maximumBatchingWindowInSeconds

 The maximum amount of time to gather records before invoking the function, in seconds.
 


parallelizationFactor
Integer parallelizationFactor

 (Streams) The number of batches to process from each shard concurrently.
 


eventSourceArn
String eventSourceArn

 The Amazon Resource Name (ARN) of the event source.
 


functionArn
String functionArn

 The ARN of the Lambda function.
 


lastModified
Date lastModified

 The date that the event source mapping was last updated, or its state changed.
 


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 one of the following: Creating,
 Enabling, Enabled, Disabling, Disabled, Updating
 , or Deleting.
 


stateTransitionReason
String stateTransitionReason

 Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
 


destinationConfig
DestinationConfig destinationConfig

 (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
 


maximumRecordAgeInSeconds
Integer maximumRecordAgeInSeconds

 (Streams) The maximum age of a record that Lambda sends to a function for processing.
 


bisectBatchOnFunctionError
Boolean bisectBatchOnFunctionError

 (Streams) If the function returns an error, split the batch in two and retry.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 (Streams) The maximum number of times to retry when the function returns an error.
 








Class com.amazonaws.services.lambda.model.FunctionCode extends Object implements Serializable


Serialized Fields


zipFile
ByteBuffer zipFile

 The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
 


s3Bucket
String s3Bucket

 An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
 


s3Key
String s3Key

 The Amazon S3 key of the deployment package.
 


s3ObjectVersion
String s3ObjectVersion

 For versioned objects, the version of the deployment package object to use.
 








Class com.amazonaws.services.lambda.model.FunctionCodeLocation extends Object implements Serializable


Serialized Fields


repositoryType
String repositoryType

 The service that's hosting the file.
 


location
String location

 A presigned URL that you can use to download the deployment package.
 








Class com.amazonaws.services.lambda.model.FunctionConfiguration extends Object implements Serializable


Serialized Fields


functionName
String functionName

 The name of the function.
 


functionArn
String functionArn

 The function's Amazon Resource Name (ARN).
 


runtime
String runtime

 The runtime environment for the Lambda function.
 


role
String role

 The function's execution role.
 


handler
String handler

 The function that Lambda calls to begin executing your function.
 


codeSize
Long codeSize

 The size of the function's deployment package, in bytes.
 


description
String description

 The function's description.
 


timeout
Integer timeout

 The amount of time that Lambda allows a function to run before stopping it.
 


memorySize
Integer memorySize

 The memory that's allocated to the function.
 


lastModified
String lastModified

 The date and time that the function was last updated, in ISO-8601
 format (YYYY-MM-DDThh:mm:ss.sTZD).
 


codeSha256
String codeSha256

 The SHA256 hash of the function's deployment package.
 


version
String version

 The version of the Lambda function.
 


vpcConfig
VpcConfigResponse vpcConfig

 The function's networking configuration.
 


deadLetterConfig
DeadLetterConfig deadLetterConfig

 The function's dead letter queue.
 


environment
EnvironmentResponse environment

 The function's environment variables.
 


kMSKeyArn
String kMSKeyArn

 The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've
 configured a customer managed CMK.
 


tracingConfig
TracingConfigResponse tracingConfig

 The function's AWS X-Ray tracing configuration.
 


masterArn
String masterArn

 For Lambda@Edge functions, the ARN of the master function.
 


revisionId
String revisionId

 The latest updated revision of the function or alias.
 


layers
SdkInternalList<T> layers

 The function's  layers.
 


state
String state

 The current state of the function. When the state is Inactive, you can reactivate the function by
 invoking it.
 


stateReason
String stateReason

 The reason for the function's current state.
 


stateReasonCode
String stateReasonCode

 The reason code for the function's current state. When the code is Creating, you can't invoke or
 modify the function.
 


lastUpdateStatus
String lastUpdateStatus

 The status of the last update that was performed on the function. This is first set to Successful
 after function creation completes.
 


lastUpdateStatusReason
String lastUpdateStatusReason

 The reason for the last update that was performed on the function.
 


lastUpdateStatusReasonCode
String lastUpdateStatusReasonCode

 The reason code for the last update that was performed on the function.
 








Class com.amazonaws.services.lambda.model.FunctionEventInvokeConfig extends Object implements Serializable


Serialized Fields


lastModified
Date lastModified

 The date and time that the configuration was last updated.
 


functionArn
String functionArn

 The Amazon Resource Name (ARN) of the function.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 The maximum number of times to retry when the function returns an error.
 


maximumEventAgeInSeconds
Integer maximumEventAgeInSeconds

 The maximum age of a request that Lambda sends to a function for processing.
 


destinationConfig
DestinationConfig destinationConfig

 A destination for events after they have been sent to a function for processing.
 
 
 Destinations
 
 
 
 
 Function - The Amazon Resource Name (ARN) of a Lambda function.
 
 
 
 
 Queue - The ARN of an SQS queue.
 
 
 
 
 Topic - The ARN of an SNS topic.
 
 
 
 
 Event Bus - The ARN of an Amazon EventBridge event bus.
 
 
 








Class com.amazonaws.services.lambda.model.GetAccountSettingsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.lambda.model.GetAccountSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accountLimit
AccountLimit accountLimit

 Limits that are related to concurrency and code storage.
 


accountUsage
AccountUsage accountUsage

 The number of functions and amount of storage in use.
 








Class com.amazonaws.services.lambda.model.GetAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - MyFunction.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
 
 
 
 
 Partial ARN - 123456789012:function:MyFunction.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


name
String name

 The name of the alias.
 








Class com.amazonaws.services.lambda.model.GetAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


aliasArn
String aliasArn

 The Amazon Resource Name (ARN) of the alias.
 


name
String name

 The name of the alias.
 


functionVersion
String functionVersion

 The function version that the alias invokes.
 


description
String description

 A description of the alias.
 


routingConfig
AliasRoutingConfiguration routingConfig

 The routing
 configuration of the alias.
 


revisionId
String revisionId

 A unique identifier that changes when you update the alias.
 








Class com.amazonaws.services.lambda.model.GetEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


uUID
String uUID

 The identifier of the event source mapping.
 








Class com.amazonaws.services.lambda.model.GetEventSourceMappingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uUID
String uUID

 The identifier of the event source mapping.
 


batchSize
Integer batchSize

 The maximum number of items to retrieve in a single batch.
 


maximumBatchingWindowInSeconds
Integer maximumBatchingWindowInSeconds

 The maximum amount of time to gather records before invoking the function, in seconds.
 


parallelizationFactor
Integer parallelizationFactor

 (Streams) The number of batches to process from each shard concurrently.
 


eventSourceArn
String eventSourceArn

 The Amazon Resource Name (ARN) of the event source.
 


functionArn
String functionArn

 The ARN of the Lambda function.
 


lastModified
Date lastModified

 The date that the event source mapping was last updated, or its state changed.
 


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 one of the following: Creating,
 Enabling, Enabled, Disabling, Disabled, Updating
 , or Deleting.
 


stateTransitionReason
String stateTransitionReason

 Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
 


destinationConfig
DestinationConfig destinationConfig

 (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
 


maximumRecordAgeInSeconds
Integer maximumRecordAgeInSeconds

 (Streams) The maximum age of a record that Lambda sends to a function for processing.
 


bisectBatchOnFunctionError
Boolean bisectBatchOnFunctionError

 (Streams) If the function returns an error, split the batch in two and retry.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 (Streams) The maximum number of times to retry when the function returns an error.
 








Class com.amazonaws.services.lambda.model.GetFunctionConcurrencyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - my-function.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 








Class com.amazonaws.services.lambda.model.GetFunctionConcurrencyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservedConcurrentExecutions
Integer reservedConcurrentExecutions

 The number of simultaneous executions that are reserved for the function.
 








Class com.amazonaws.services.lambda.model.GetFunctionConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function, version, or alias.
 
 
 Name formats
 
 
 
 
 Function name - my-function (name-only), my-function:v1 (with alias).
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 You can append a version number or alias to any of the formats. The length constraint applies only to the full
 ARN. If you specify only the function name, it is limited to 64 characters in length.
 


qualifier
String qualifier

 Specify a version or alias to get details about a published version of the function.
 








Class com.amazonaws.services.lambda.model.GetFunctionConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


functionName
String functionName

 The name of the function.
 


functionArn
String functionArn

 The function's Amazon Resource Name (ARN).
 


runtime
String runtime

 The runtime environment for the Lambda function.
 


role
String role

 The function's execution role.
 


handler
String handler

 The function that Lambda calls to begin executing your function.
 


codeSize
Long codeSize

 The size of the function's deployment package, in bytes.
 


description
String description

 The function's description.
 


timeout
Integer timeout

 The amount of time that Lambda allows a function to run before stopping it.
 


memorySize
Integer memorySize

 The memory that's allocated to the function.
 


lastModified
String lastModified

 The date and time that the function was last updated, in ISO-8601
 format (YYYY-MM-DDThh:mm:ss.sTZD).
 


codeSha256
String codeSha256

 The SHA256 hash of the function's deployment package.
 


version
String version

 The version of the Lambda function.
 


vpcConfig
VpcConfigResponse vpcConfig

 The function's networking configuration.
 


deadLetterConfig
DeadLetterConfig deadLetterConfig

 The function's dead letter queue.
 


environment
EnvironmentResponse environment

 The function's environment variables.
 


kMSKeyArn
String kMSKeyArn

 The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've
 configured a customer managed CMK.
 


tracingConfig
TracingConfigResponse tracingConfig

 The function's AWS X-Ray tracing configuration.
 


masterArn
String masterArn

 For Lambda@Edge functions, the ARN of the master function.
 


revisionId
String revisionId

 The latest updated revision of the function or alias.
 


layers
SdkInternalList<T> layers

 The function's  layers.
 


state
String state

 The current state of the function. When the state is Inactive, you can reactivate the function by
 invoking it.
 


stateReason
String stateReason

 The reason for the function's current state.
 


stateReasonCode
String stateReasonCode

 The reason code for the function's current state. When the code is Creating, you can't invoke or
 modify the function.
 


lastUpdateStatus
String lastUpdateStatus

 The status of the last update that was performed on the function. This is first set to Successful
 after function creation completes.
 


lastUpdateStatusReason
String lastUpdateStatusReason

 The reason for the last update that was performed on the function.
 


lastUpdateStatusReasonCode
String lastUpdateStatusReasonCode

 The reason code for the last update that was performed on the function.
 








Class com.amazonaws.services.lambda.model.GetFunctionEventInvokeConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function, version, or alias.
 
 
 Name formats
 
 
 
 
 Function name - my-function (name-only), my-function:v1 (with alias).
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 You can append a version number or alias to any of the formats. The length constraint applies only to the full
 ARN. If you specify only the function name, it is limited to 64 characters in length.
 


qualifier
String qualifier

 A version number or alias name.
 








Class com.amazonaws.services.lambda.model.GetFunctionEventInvokeConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


lastModified
Date lastModified

 The date and time that the configuration was last updated.
 


functionArn
String functionArn

 The Amazon Resource Name (ARN) of the function.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 The maximum number of times to retry when the function returns an error.
 


maximumEventAgeInSeconds
Integer maximumEventAgeInSeconds

 The maximum age of a request that Lambda sends to a function for processing.
 


destinationConfig
DestinationConfig destinationConfig

 A destination for events after they have been sent to a function for processing.
 
 
 Destinations
 
 
 
 
 Function - The Amazon Resource Name (ARN) of a Lambda function.
 
 
 
 
 Queue - The ARN of an SQS queue.
 
 
 
 
 Topic - The ARN of an SNS topic.
 
 
 
 
 Event Bus - The ARN of an Amazon EventBridge event bus.
 
 
 








Class com.amazonaws.services.lambda.model.GetFunctionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function, version, or alias.
 
 
 Name formats
 
 
 
 
 Function name - my-function (name-only), my-function:v1 (with alias).
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 You can append a version number or alias to any of the formats. The length constraint applies only to the full
 ARN. If you specify only the function name, it is limited to 64 characters in length.
 


qualifier
String qualifier

 Specify a version or alias to get details about a published version of the function.
 








Class com.amazonaws.services.lambda.model.GetFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configuration
FunctionConfiguration configuration

 The configuration of the function or version.
 


code
FunctionCodeLocation code

 The deployment package of the function or version.
 


tags
SdkInternalMap<K,V> tags

 The function's tags.
 


concurrency
Concurrency concurrency

 The function's reserved
 concurrency.
 








Class com.amazonaws.services.lambda.model.GetLayerVersionByArnRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn

 The ARN of the layer version.
 








Class com.amazonaws.services.lambda.model.GetLayerVersionByArnResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


content
LayerVersionContentOutput content

 Details about the layer version.
 


layerArn
String layerArn

 The ARN of the layer.
 


layerVersionArn
String layerVersionArn

 The ARN of the layer version.
 


description
String description

 The description of the version.
 


createdDate
String createdDate

 The date that the layer version was created, in ISO-8601 format
 (YYYY-MM-DDThh:mm:ss.sTZD).
 


version
Long version

 The version number.
 


compatibleRuntimes
SdkInternalList<T> compatibleRuntimes

 The layer's compatible runtimes.
 


licenseInfo
String licenseInfo

 The layer's software license.
 








Class com.amazonaws.services.lambda.model.GetLayerVersionPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


layerName
String layerName

 The name or Amazon Resource Name (ARN) of the layer.
 


versionNumber
Long versionNumber

 The version number.
 








Class com.amazonaws.services.lambda.model.GetLayerVersionPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
String policy

 The policy document.
 


revisionId
String revisionId

 A unique identifier for the current revision of the policy.
 








Class com.amazonaws.services.lambda.model.GetLayerVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


layerName
String layerName

 The name or Amazon Resource Name (ARN) of the layer.
 


versionNumber
Long versionNumber

 The version number.
 








Class com.amazonaws.services.lambda.model.GetLayerVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


content
LayerVersionContentOutput content

 Details about the layer version.
 


layerArn
String layerArn

 The ARN of the layer.
 


layerVersionArn
String layerVersionArn

 The ARN of the layer version.
 


description
String description

 The description of the version.
 


createdDate
String createdDate

 The date that the layer version was created, in ISO-8601 format
 (YYYY-MM-DDThh:mm:ss.sTZD).
 


version
Long version

 The version number.
 


compatibleRuntimes
SdkInternalList<T> compatibleRuntimes

 The layer's compatible runtimes.
 


licenseInfo
String licenseInfo

 The layer's software license.
 








Class com.amazonaws.services.lambda.model.GetPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function, version, or alias.
 
 
 Name formats
 
 
 
 
 Function name - my-function (name-only), my-function:v1 (with alias).
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 You can append a version number or alias to any of the formats. The length constraint applies only to the full
 ARN. If you specify only the function name, it is limited to 64 characters in length.
 


qualifier
String qualifier

 Specify a version or alias to get the policy for that resource.
 








Class com.amazonaws.services.lambda.model.GetPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
String policy

 The resource-based policy.
 


revisionId
String revisionId

 A unique identifier for the current revision of the policy.
 








Class com.amazonaws.services.lambda.model.GetProvisionedConcurrencyConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - my-function.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


qualifier
String qualifier

 The version number or alias name.
 








Class com.amazonaws.services.lambda.model.GetProvisionedConcurrencyConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestedProvisionedConcurrentExecutions
Integer requestedProvisionedConcurrentExecutions

 The amount of provisioned concurrency requested.
 


availableProvisionedConcurrentExecutions
Integer availableProvisionedConcurrentExecutions

 The amount of provisioned concurrency available.
 


allocatedProvisionedConcurrentExecutions
Integer allocatedProvisionedConcurrentExecutions

 The amount of provisioned concurrency allocated.
 


status
String status

 The status of the allocation process.
 


statusReason
String statusReason

 For failed allocations, the reason that provisioned concurrency could not be allocated.
 


lastModified
String lastModified

 The date and time that a user last updated the configuration, in ISO 8601 format.
 








Class com.amazonaws.services.lambda.model.InvalidParameterValueException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 The exception type.
 








Class com.amazonaws.services.lambda.model.InvalidRequestContentException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 The exception type.
 








Class com.amazonaws.services.lambda.model.InvalidRuntimeException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.InvalidSecurityGroupIDException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.InvalidSubnetIDException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.InvalidZipFileException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.InvokeAsyncRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - my-function.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


invokeArgs
InputStream invokeArgs

 The JSON that you want to provide to your Lambda function as input.
 








Class com.amazonaws.services.lambda.model.InvokeAsyncResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


status
Integer status
Deprecated. 

 The status code.
 








Class com.amazonaws.services.lambda.model.InvokeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function, version, or alias.
 
 
 Name formats
 
 
 
 
 Function name - my-function (name-only), my-function:v1 (with alias).
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 You can append a version number or alias to any of the formats. The length constraint applies only to the full
 ARN. If you specify only the function name, it is limited to 64 characters in length.
 


invocationType
String invocationType

 Choose from the following options.
 
 
 
 
 RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the
 function returns a response or times out. The API response includes the function response and additional data.
 
 
 
 
 Event - Invoke the function asynchronously. Send events that fail multiple times to the function's
 dead-letter queue (if it's configured). The API response only includes a status code.
 
 
 
 
 DryRun - Validate parameter values and verify that the user or role has permission to invoke the
 function.
 
 
 


logType
String logType

 Set to Tail to include the execution log in the response.
 


clientContext
String clientContext

 Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.
 


payload
ByteBuffer payload

 The JSON that you want to provide to your Lambda function as input.
 


qualifier
String qualifier

 Specify a version or alias to invoke a published version of the function.
 








Class com.amazonaws.services.lambda.model.InvokeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


statusCode
Integer statusCode

 The HTTP status code is in the 200 range for a successful request. For the RequestResponse
 invocation type, this status code is 200. For the Event invocation type, this status code is 202.
 For the DryRun invocation type, the status code is 204.
 


functionError
String functionError

 If present, indicates that an error occurred during function execution. Details about the error are included in
 the response payload.
 


logResult
String logResult

 The last 4 KB of the execution log, which is base64 encoded.
 


payload
ByteBuffer payload

 The response from the function, or an error object.
 


executedVersion
String executedVersion

 The version of the function that executed. When you invoke a function with an alias, this indicates which version
 the alias resolved to.
 








Class com.amazonaws.services.lambda.model.KMSAccessDeniedException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.KMSDisabledException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.KMSInvalidStateException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.KMSNotFoundException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








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


Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the function layer.
 


codeSize
Long codeSize

 The size of the layer archive in bytes.
 








Class com.amazonaws.services.lambda.model.LayersListItem extends Object implements Serializable


Serialized Fields


layerName
String layerName

 The name of the layer.
 


layerArn
String layerArn

 The Amazon Resource Name (ARN) of the function layer.
 


latestMatchingVersion
LayerVersionsListItem latestMatchingVersion

 The newest version of the layer.
 








Class com.amazonaws.services.lambda.model.LayerVersionContentInput extends Object implements Serializable


Serialized Fields


s3Bucket
String s3Bucket

 The Amazon S3 bucket of the layer archive.
 


s3Key
String s3Key

 The Amazon S3 key of the layer archive.
 


s3ObjectVersion
String s3ObjectVersion

 For versioned objects, the version of the layer archive object to use.
 


zipFile
ByteBuffer zipFile

 The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients handle the encoding for you.
 








Class com.amazonaws.services.lambda.model.LayerVersionContentOutput extends Object implements Serializable


Serialized Fields


location
String location

 A link to the layer archive in Amazon S3 that is valid for 10 minutes.
 


codeSha256
String codeSha256

 The SHA-256 hash of the layer archive.
 


codeSize
Long codeSize

 The size of the layer archive in bytes.
 








Class com.amazonaws.services.lambda.model.LayerVersionsListItem extends Object implements Serializable


Serialized Fields


layerVersionArn
String layerVersionArn

 The ARN of the layer version.
 


version
Long version

 The version number.
 


description
String description

 The description of the version.
 


createdDate
String createdDate

 The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000
 .
 


compatibleRuntimes
SdkInternalList<T> compatibleRuntimes

 The layer's compatible runtimes.
 


licenseInfo
String licenseInfo

 The layer's open-source license.
 








Class com.amazonaws.services.lambda.model.ListAliasesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - MyFunction.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
 
 
 
 
 Partial ARN - 123456789012:function:MyFunction.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


functionVersion
String functionVersion

 Specify a function version to only list aliases that invoke that version.
 


marker
String marker

 Specify the pagination token that's returned by a previous request to retrieve the next page of results.
 


maxItems
Integer maxItems

 Limit the number of aliases returned.
 








Class com.amazonaws.services.lambda.model.ListAliasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextMarker
String nextMarker

 The pagination token that's included if more results are available.
 


aliases
SdkInternalList<T> aliases

 A list of aliases.
 








Class com.amazonaws.services.lambda.model.ListEventSourceMappingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


eventSourceArn
String eventSourceArn

 The Amazon Resource Name (ARN) of the event source.
 
 
 
 
 Amazon Kinesis - The ARN of the data stream or a stream consumer.
 
 
 
 
 Amazon DynamoDB Streams - The ARN of the stream.
 
 
 
 
 Amazon Simple Queue Service - The ARN of the queue.
 
 
 


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - MyFunction.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
 
 
 
 
 Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
 
 
 
 
 Partial ARN - 123456789012:function:MyFunction.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64
 characters in length.
 


marker
String marker

 A pagination token returned by a previous call.
 


maxItems
Integer maxItems

 The maximum number of event source mappings to return.
 








Class com.amazonaws.services.lambda.model.ListEventSourceMappingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextMarker
String nextMarker

 A pagination token that's returned when the response doesn't contain all event source mappings.
 


eventSourceMappings
SdkInternalList<T> eventSourceMappings

 A list of event source mappings.
 








Class com.amazonaws.services.lambda.model.ListFunctionEventInvokeConfigsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - my-function.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


marker
String marker

 Specify the pagination token that's returned by a previous request to retrieve the next page of results.
 


maxItems
Integer maxItems

 The maximum number of configurations to return.
 








Class com.amazonaws.services.lambda.model.ListFunctionEventInvokeConfigsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


functionEventInvokeConfigs
SdkInternalList<T> functionEventInvokeConfigs

 A list of configurations.
 


nextMarker
String nextMarker

 The pagination token that's included if more results are available.
 








Class com.amazonaws.services.lambda.model.ListFunctionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


masterRegion
String masterRegion

 For Lambda@Edge functions, the AWS Region of the master function. For example, us-east-1 filters the
 list of functions to only include Lambda@Edge functions replicated from a master function in US East (N.
 Virginia). If specified, you must set FunctionVersion to ALL.
 


functionVersion
String functionVersion

 Set to ALL to include entries for all published versions of each function.
 


marker
String marker

 Specify the pagination token that's returned by a previous request to retrieve the next page of results.
 


maxItems
Integer maxItems

 Specify a value between 1 and 50 to limit the number of functions in the response.
 








Class com.amazonaws.services.lambda.model.ListFunctionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextMarker
String nextMarker

 The pagination token that's included if more results are available.
 


functions
SdkInternalList<T> functions

 A list of Lambda functions.
 








Class com.amazonaws.services.lambda.model.ListLayersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


compatibleRuntime
String compatibleRuntime

 A runtime identifier. For example, go1.x.
 


marker
String marker

 A pagination token returned by a previous call.
 


maxItems
Integer maxItems

 The maximum number of layers to return.
 








Class com.amazonaws.services.lambda.model.ListLayersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextMarker
String nextMarker

 A pagination token returned when the response doesn't contain all layers.
 


layers
SdkInternalList<T> layers

 A list of function layers.
 








Class com.amazonaws.services.lambda.model.ListLayerVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


compatibleRuntime
String compatibleRuntime

 A runtime identifier. For example, go1.x.
 


layerName
String layerName

 The name or Amazon Resource Name (ARN) of the layer.
 


marker
String marker

 A pagination token returned by a previous call.
 


maxItems
Integer maxItems

 The maximum number of versions to return.
 








Class com.amazonaws.services.lambda.model.ListLayerVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextMarker
String nextMarker

 A pagination token returned when the response doesn't contain all versions.
 


layerVersions
SdkInternalList<T> layerVersions

 A list of versions.
 








Class com.amazonaws.services.lambda.model.ListProvisionedConcurrencyConfigsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - my-function.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


marker
String marker

 Specify the pagination token that's returned by a previous request to retrieve the next page of results.
 


maxItems
Integer maxItems

 Specify a number to limit the number of configurations returned.
 








Class com.amazonaws.services.lambda.model.ListProvisionedConcurrencyConfigsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


provisionedConcurrencyConfigs
SdkInternalList<T> provisionedConcurrencyConfigs

 A list of provisioned concurrency configurations.
 


nextMarker
String nextMarker

 The pagination token that's included if more results are available.
 








Class com.amazonaws.services.lambda.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resource
String resource

 The function's Amazon Resource Name (ARN).
 








Class com.amazonaws.services.lambda.model.ListTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalMap<K,V> tags

 The function's tags.
 








Class com.amazonaws.services.lambda.model.ListVersionsByFunctionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - MyFunction.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
 
 
 
 
 Partial ARN - 123456789012:function:MyFunction.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


marker
String marker

 Specify the pagination token that's returned by a previous request to retrieve the next page of results.
 


maxItems
Integer maxItems

 Limit the number of versions that are returned.
 








Class com.amazonaws.services.lambda.model.ListVersionsByFunctionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextMarker
String nextMarker

 The pagination token that's included if more results are available.
 


versions
SdkInternalList<T> versions

 A list of Lambda function versions.
 








Class com.amazonaws.services.lambda.model.OnFailure extends Object implements Serializable


Serialized Fields


destination
String destination

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








Class com.amazonaws.services.lambda.model.OnSuccess extends Object implements Serializable


Serialized Fields


destination
String destination

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








Class com.amazonaws.services.lambda.model.PolicyLengthExceededException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.PreconditionFailedException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 The exception type.
 








Class com.amazonaws.services.lambda.model.ProvisionedConcurrencyConfigListItem extends Object implements Serializable


Serialized Fields


functionArn
String functionArn

 The Amazon Resource Name (ARN) of the alias or version.
 


requestedProvisionedConcurrentExecutions
Integer requestedProvisionedConcurrentExecutions

 The amount of provisioned concurrency requested.
 


availableProvisionedConcurrentExecutions
Integer availableProvisionedConcurrentExecutions

 The amount of provisioned concurrency available.
 


allocatedProvisionedConcurrentExecutions
Integer allocatedProvisionedConcurrentExecutions

 The amount of provisioned concurrency allocated.
 


status
String status

 The status of the allocation process.
 


statusReason
String statusReason

 For failed allocations, the reason that provisioned concurrency could not be allocated.
 


lastModified
String lastModified

 The date and time that a user last updated the configuration, in ISO 8601 format.
 








Class com.amazonaws.services.lambda.model.ProvisionedConcurrencyConfigNotFoundException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.PublishLayerVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


layerName
String layerName

 The name or Amazon Resource Name (ARN) of the layer.
 


description
String description

 The description of the version.
 


content
LayerVersionContentInput content

 The function layer archive.
 


compatibleRuntimes
SdkInternalList<T> compatibleRuntimes

 A list of compatible function
 runtimes. Used for filtering with ListLayers and ListLayerVersions.
 


licenseInfo
String licenseInfo

 The layer's software license. It can be any of the following:
 
 
 
 
 An SPDX license identifier. For example, MIT.
 
 
 
 
 The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.
 
 
 
 
 The full text of the license.
 
 
 








Class com.amazonaws.services.lambda.model.PublishLayerVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


content
LayerVersionContentOutput content

 Details about the layer version.
 


layerArn
String layerArn

 The ARN of the layer.
 


layerVersionArn
String layerVersionArn

 The ARN of the layer version.
 


description
String description

 The description of the version.
 


createdDate
String createdDate

 The date that the layer version was created, in ISO-8601 format
 (YYYY-MM-DDThh:mm:ss.sTZD).
 


version
Long version

 The version number.
 


compatibleRuntimes
SdkInternalList<T> compatibleRuntimes

 The layer's compatible runtimes.
 


licenseInfo
String licenseInfo

 The layer's software license.
 








Class com.amazonaws.services.lambda.model.PublishVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - MyFunction.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
 
 
 
 
 Partial ARN - 123456789012:function:MyFunction.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


codeSha256
String codeSha256

 Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing
 a version if the function code has changed since you last updated it. You can get the hash for the version that
 you uploaded from the output of UpdateFunctionCode.
 


description
String description

 A description for the version to override the description in the function configuration.
 


revisionId
String revisionId

 Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing
 a version if the function configuration has changed since you last updated it.
 








Class com.amazonaws.services.lambda.model.PublishVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


functionName
String functionName

 The name of the function.
 


functionArn
String functionArn

 The function's Amazon Resource Name (ARN).
 


runtime
String runtime

 The runtime environment for the Lambda function.
 


role
String role

 The function's execution role.
 


handler
String handler

 The function that Lambda calls to begin executing your function.
 


codeSize
Long codeSize

 The size of the function's deployment package, in bytes.
 


description
String description

 The function's description.
 


timeout
Integer timeout

 The amount of time that Lambda allows a function to run before stopping it.
 


memorySize
Integer memorySize

 The memory that's allocated to the function.
 


lastModified
String lastModified

 The date and time that the function was last updated, in ISO-8601
 format (YYYY-MM-DDThh:mm:ss.sTZD).
 


codeSha256
String codeSha256

 The SHA256 hash of the function's deployment package.
 


version
String version

 The version of the Lambda function.
 


vpcConfig
VpcConfigResponse vpcConfig

 The function's networking configuration.
 


deadLetterConfig
DeadLetterConfig deadLetterConfig

 The function's dead letter queue.
 


environment
EnvironmentResponse environment

 The function's environment variables.
 


kMSKeyArn
String kMSKeyArn

 The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've
 configured a customer managed CMK.
 


tracingConfig
TracingConfigResponse tracingConfig

 The function's AWS X-Ray tracing configuration.
 


masterArn
String masterArn

 For Lambda@Edge functions, the ARN of the master function.
 


revisionId
String revisionId

 The latest updated revision of the function or alias.
 


layers
SdkInternalList<T> layers

 The function's  layers.
 


state
String state

 The current state of the function. When the state is Inactive, you can reactivate the function by
 invoking it.
 


stateReason
String stateReason

 The reason for the function's current state.
 


stateReasonCode
String stateReasonCode

 The reason code for the function's current state. When the code is Creating, you can't invoke or
 modify the function.
 


lastUpdateStatus
String lastUpdateStatus

 The status of the last update that was performed on the function. This is first set to Successful
 after function creation completes.
 


lastUpdateStatusReason
String lastUpdateStatusReason

 The reason for the last update that was performed on the function.
 


lastUpdateStatusReasonCode
String lastUpdateStatusReasonCode

 The reason code for the last update that was performed on the function.
 








Class com.amazonaws.services.lambda.model.PutFunctionConcurrencyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - my-function.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


reservedConcurrentExecutions
Integer reservedConcurrentExecutions

 The number of simultaneous executions to reserve for the function.
 








Class com.amazonaws.services.lambda.model.PutFunctionConcurrencyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservedConcurrentExecutions
Integer reservedConcurrentExecutions

 The number of concurrent executions that are reserved for this function. For more information, see Managing Concurrency.
 








Class com.amazonaws.services.lambda.model.PutFunctionEventInvokeConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function, version, or alias.
 
 
 Name formats
 
 
 
 
 Function name - my-function (name-only), my-function:v1 (with alias).
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 You can append a version number or alias to any of the formats. The length constraint applies only to the full
 ARN. If you specify only the function name, it is limited to 64 characters in length.
 


qualifier
String qualifier

 A version number or alias name.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 The maximum number of times to retry when the function returns an error.
 


maximumEventAgeInSeconds
Integer maximumEventAgeInSeconds

 The maximum age of a request that Lambda sends to a function for processing.
 


destinationConfig
DestinationConfig destinationConfig

 A destination for events after they have been sent to a function for processing.
 
 
 Destinations
 
 
 
 
 Function - The Amazon Resource Name (ARN) of a Lambda function.
 
 
 
 
 Queue - The ARN of an SQS queue.
 
 
 
 
 Topic - The ARN of an SNS topic.
 
 
 
 
 Event Bus - The ARN of an Amazon EventBridge event bus.
 
 
 








Class com.amazonaws.services.lambda.model.PutFunctionEventInvokeConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


lastModified
Date lastModified

 The date and time that the configuration was last updated.
 


functionArn
String functionArn

 The Amazon Resource Name (ARN) of the function.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 The maximum number of times to retry when the function returns an error.
 


maximumEventAgeInSeconds
Integer maximumEventAgeInSeconds

 The maximum age of a request that Lambda sends to a function for processing.
 


destinationConfig
DestinationConfig destinationConfig

 A destination for events after they have been sent to a function for processing.
 
 
 Destinations
 
 
 
 
 Function - The Amazon Resource Name (ARN) of a Lambda function.
 
 
 
 
 Queue - The ARN of an SQS queue.
 
 
 
 
 Topic - The ARN of an SNS topic.
 
 
 
 
 Event Bus - The ARN of an Amazon EventBridge event bus.
 
 
 








Class com.amazonaws.services.lambda.model.PutProvisionedConcurrencyConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - my-function.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


qualifier
String qualifier

 The version number or alias name.
 


provisionedConcurrentExecutions
Integer provisionedConcurrentExecutions

 The amount of provisioned concurrency to allocate for the version or alias.
 








Class com.amazonaws.services.lambda.model.PutProvisionedConcurrencyConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


requestedProvisionedConcurrentExecutions
Integer requestedProvisionedConcurrentExecutions

 The amount of provisioned concurrency requested.
 


availableProvisionedConcurrentExecutions
Integer availableProvisionedConcurrentExecutions

 The amount of provisioned concurrency available.
 


allocatedProvisionedConcurrentExecutions
Integer allocatedProvisionedConcurrentExecutions

 The amount of provisioned concurrency allocated.
 


status
String status

 The status of the allocation process.
 


statusReason
String statusReason

 For failed allocations, the reason that provisioned concurrency could not be allocated.
 


lastModified
String lastModified

 The date and time that a user last updated the configuration, in ISO 8601 format.
 








Class com.amazonaws.services.lambda.model.RemoveLayerVersionPermissionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


layerName
String layerName

 The name or Amazon Resource Name (ARN) of the layer.
 


versionNumber
Long versionNumber

 The version number.
 


statementId
String statementId

 The identifier that was specified when the statement was added.
 


revisionId
String revisionId

 Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy
 that has changed since you last read it.
 








Class com.amazonaws.services.lambda.model.RemoveLayerVersionPermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lambda.model.RemovePermissionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function, version, or alias.
 
 
 Name formats
 
 
 
 
 Function name - my-function (name-only), my-function:v1 (with alias).
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 You can append a version number or alias to any of the formats. The length constraint applies only to the full
 ARN. If you specify only the function name, it is limited to 64 characters in length.
 


statementId
String statementId

 Statement ID of the permission to remove.
 


qualifier
String qualifier

 Specify a version or alias to remove permissions from a published version of the function.
 


revisionId
String revisionId

 Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a
 policy that has changed since you last read it.
 








Class com.amazonaws.services.lambda.model.RemovePermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lambda.model.RequestTooLargeException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.ResourceConflictException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 The exception type.
 








Class com.amazonaws.services.lambda.model.ResourceInUseException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.ResourceNotFoundException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.ResourceNotReadyException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type

 The exception type.
 








Class com.amazonaws.services.lambda.model.ServiceException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.SubnetIPAddressLimitReachedException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resource
String resource

 The function's Amazon Resource Name (ARN).
 


tags
SdkInternalMap<K,V> tags

 A list of tags to apply to the function.
 








Class com.amazonaws.services.lambda.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lambda.model.TooManyRequestsException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


retryAfterSeconds
String retryAfterSeconds

 The number of seconds the caller should wait before retrying.
 


type
String type


reason
String reason








Class com.amazonaws.services.lambda.model.TracingConfig extends Object implements Serializable


Serialized Fields


mode
String mode

 The tracing mode.
 








Class com.amazonaws.services.lambda.model.TracingConfigResponse extends Object implements Serializable


Serialized Fields


mode
String mode

 The tracing mode.
 








Class com.amazonaws.services.lambda.model.UnsupportedMediaTypeException extends AWSLambdaException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resource
String resource

 The function's Amazon Resource Name (ARN).
 


tagKeys
SdkInternalList<T> tagKeys

 A list of tag keys to remove from the function.
 








Class com.amazonaws.services.lambda.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lambda.model.UpdateAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - MyFunction.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
 
 
 
 
 Partial ARN - 123456789012:function:MyFunction.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


name
String name

 The name of the alias.
 


functionVersion
String functionVersion

 The function version that the alias invokes.
 


description
String description

 A description of the alias.
 


routingConfig
AliasRoutingConfiguration routingConfig

 The routing
 configuration of the alias.
 


revisionId
String revisionId

 Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an
 alias that has changed since you last read it.
 








Class com.amazonaws.services.lambda.model.UpdateAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


aliasArn
String aliasArn

 The Amazon Resource Name (ARN) of the alias.
 


name
String name

 The name of the alias.
 


functionVersion
String functionVersion

 The function version that the alias invokes.
 


description
String description

 A description of the alias.
 


routingConfig
AliasRoutingConfiguration routingConfig

 The routing
 configuration of the alias.
 


revisionId
String revisionId

 A unique identifier that changes when you update the alias.
 








Class com.amazonaws.services.lambda.model.UpdateEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


uUID
String uUID

 The identifier of the event source mapping.
 


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - MyFunction.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
 
 
 
 
 Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.
 
 
 
 
 Partial ARN - 123456789012:function:MyFunction.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64
 characters in length.
 


enabled
Boolean enabled

 Disables the event source mapping to pause polling and invocation.
 


batchSize
Integer batchSize

 The maximum number of items to retrieve in a single batch.
 
 
 
 
 Amazon Kinesis - Default 100. Max 10,000.
 
 
 
 
 Amazon DynamoDB Streams - Default 100. Max 1,000.
 
 
 
 
 Amazon Simple Queue Service - Default 10. Max 10.
 
 
 


maximumBatchingWindowInSeconds
Integer maximumBatchingWindowInSeconds

 The maximum amount of time to gather records before invoking the function, in seconds.
 


destinationConfig
DestinationConfig destinationConfig

 (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
 


maximumRecordAgeInSeconds
Integer maximumRecordAgeInSeconds

 (Streams) The maximum age of a record that Lambda sends to a function for processing.
 


bisectBatchOnFunctionError
Boolean bisectBatchOnFunctionError

 (Streams) If the function returns an error, split the batch in two and retry.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 (Streams) The maximum number of times to retry when the function returns an error.
 


parallelizationFactor
Integer parallelizationFactor

 (Streams) The number of batches to process from each shard concurrently.
 








Class com.amazonaws.services.lambda.model.UpdateEventSourceMappingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


uUID
String uUID

 The identifier of the event source mapping.
 


batchSize
Integer batchSize

 The maximum number of items to retrieve in a single batch.
 


maximumBatchingWindowInSeconds
Integer maximumBatchingWindowInSeconds

 The maximum amount of time to gather records before invoking the function, in seconds.
 


parallelizationFactor
Integer parallelizationFactor

 (Streams) The number of batches to process from each shard concurrently.
 


eventSourceArn
String eventSourceArn

 The Amazon Resource Name (ARN) of the event source.
 


functionArn
String functionArn

 The ARN of the Lambda function.
 


lastModified
Date lastModified

 The date that the event source mapping was last updated, or its state changed.
 


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 one of the following: Creating,
 Enabling, Enabled, Disabling, Disabled, Updating
 , or Deleting.
 


stateTransitionReason
String stateTransitionReason

 Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
 


destinationConfig
DestinationConfig destinationConfig

 (Streams) An Amazon SQS queue or Amazon SNS topic destination for discarded records.
 


maximumRecordAgeInSeconds
Integer maximumRecordAgeInSeconds

 (Streams) The maximum age of a record that Lambda sends to a function for processing.
 


bisectBatchOnFunctionError
Boolean bisectBatchOnFunctionError

 (Streams) If the function returns an error, split the batch in two and retry.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 (Streams) The maximum number of times to retry when the function returns an error.
 








Class com.amazonaws.services.lambda.model.UpdateFunctionCodeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - my-function.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


zipFile
ByteBuffer zipFile

 The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.
 


s3Bucket
String s3Bucket

 An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.
 


s3Key
String s3Key

 The Amazon S3 key of the deployment package.
 


s3ObjectVersion
String s3ObjectVersion

 For versioned objects, the version of the deployment package object to use.
 


publish
Boolean publish

 Set to true to publish a new version of the function after updating the code. This has the same effect as calling
 PublishVersion separately.
 


dryRun
Boolean dryRun

 Set to true to validate the request parameters and access permissions without modifying the function code.
 


revisionId
String revisionId

 Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a
 function that has changed since you last read it.
 








Class com.amazonaws.services.lambda.model.UpdateFunctionCodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


functionName
String functionName

 The name of the function.
 


functionArn
String functionArn

 The function's Amazon Resource Name (ARN).
 


runtime
String runtime

 The runtime environment for the Lambda function.
 


role
String role

 The function's execution role.
 


handler
String handler

 The function that Lambda calls to begin executing your function.
 


codeSize
Long codeSize

 The size of the function's deployment package, in bytes.
 


description
String description

 The function's description.
 


timeout
Integer timeout

 The amount of time that Lambda allows a function to run before stopping it.
 


memorySize
Integer memorySize

 The memory that's allocated to the function.
 


lastModified
String lastModified

 The date and time that the function was last updated, in ISO-8601
 format (YYYY-MM-DDThh:mm:ss.sTZD).
 


codeSha256
String codeSha256

 The SHA256 hash of the function's deployment package.
 


version
String version

 The version of the Lambda function.
 


vpcConfig
VpcConfigResponse vpcConfig

 The function's networking configuration.
 


deadLetterConfig
DeadLetterConfig deadLetterConfig

 The function's dead letter queue.
 


environment
EnvironmentResponse environment

 The function's environment variables.
 


kMSKeyArn
String kMSKeyArn

 The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've
 configured a customer managed CMK.
 


tracingConfig
TracingConfigResponse tracingConfig

 The function's AWS X-Ray tracing configuration.
 


masterArn
String masterArn

 For Lambda@Edge functions, the ARN of the master function.
 


revisionId
String revisionId

 The latest updated revision of the function or alias.
 


layers
SdkInternalList<T> layers

 The function's  layers.
 


state
String state

 The current state of the function. When the state is Inactive, you can reactivate the function by
 invoking it.
 


stateReason
String stateReason

 The reason for the function's current state.
 


stateReasonCode
String stateReasonCode

 The reason code for the function's current state. When the code is Creating, you can't invoke or
 modify the function.
 


lastUpdateStatus
String lastUpdateStatus

 The status of the last update that was performed on the function. This is first set to Successful
 after function creation completes.
 


lastUpdateStatusReason
String lastUpdateStatusReason

 The reason for the last update that was performed on the function.
 


lastUpdateStatusReasonCode
String lastUpdateStatusReasonCode

 The reason code for the last update that was performed on the function.
 








Class com.amazonaws.services.lambda.model.UpdateFunctionConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function.
 
 
 Name formats
 
 
 
 
 Function name - my-function.
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64
 characters in length.
 


role
String role

 The Amazon Resource Name (ARN) of the function's execution role.
 


handler
String handler

 The name of the method within your code that Lambda calls to execute your function. The format includes the file
 name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.
 


description
String description

 A description of the function.
 


timeout
Integer timeout

 The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum
 allowed value is 900 seconds.
 


memorySize
Integer memorySize

 The amount of memory that your function has access to. Increasing the function's memory also increases its CPU
 allocation. The default value is 128 MB. The value must be a multiple of 64 MB.
 


vpcConfig
VpcConfig vpcConfig

 For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC.
 When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more
 information, see VPC Settings.
 


environment
Environment environment

 Environment variables that are accessible from function code during execution.
 


runtime
String runtime

 The identifier of the function's runtime.
 


deadLetterConfig
DeadLetterConfig deadLetterConfig

 A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when
 they fail processing. For more information, see Dead Letter Queues.
 


kMSKeyArn
String kMSKeyArn

 The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment
 variables. If it's not provided, AWS Lambda uses a default service key.
 


tracingConfig
TracingConfig tracingConfig

 Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.
 


revisionId
String revisionId

 Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a
 function that has changed since you last read it.
 


layers
SdkInternalList<T> layers

 A list of function layers to
 add to the function's execution environment. Specify each layer by its ARN, including the version.
 








Class com.amazonaws.services.lambda.model.UpdateFunctionConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


functionName
String functionName

 The name of the function.
 


functionArn
String functionArn

 The function's Amazon Resource Name (ARN).
 


runtime
String runtime

 The runtime environment for the Lambda function.
 


role
String role

 The function's execution role.
 


handler
String handler

 The function that Lambda calls to begin executing your function.
 


codeSize
Long codeSize

 The size of the function's deployment package, in bytes.
 


description
String description

 The function's description.
 


timeout
Integer timeout

 The amount of time that Lambda allows a function to run before stopping it.
 


memorySize
Integer memorySize

 The memory that's allocated to the function.
 


lastModified
String lastModified

 The date and time that the function was last updated, in ISO-8601
 format (YYYY-MM-DDThh:mm:ss.sTZD).
 


codeSha256
String codeSha256

 The SHA256 hash of the function's deployment package.
 


version
String version

 The version of the Lambda function.
 


vpcConfig
VpcConfigResponse vpcConfig

 The function's networking configuration.
 


deadLetterConfig
DeadLetterConfig deadLetterConfig

 The function's dead letter queue.
 


environment
EnvironmentResponse environment

 The function's environment variables.
 


kMSKeyArn
String kMSKeyArn

 The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've
 configured a customer managed CMK.
 


tracingConfig
TracingConfigResponse tracingConfig

 The function's AWS X-Ray tracing configuration.
 


masterArn
String masterArn

 For Lambda@Edge functions, the ARN of the master function.
 


revisionId
String revisionId

 The latest updated revision of the function or alias.
 


layers
SdkInternalList<T> layers

 The function's  layers.
 


state
String state

 The current state of the function. When the state is Inactive, you can reactivate the function by
 invoking it.
 


stateReason
String stateReason

 The reason for the function's current state.
 


stateReasonCode
String stateReasonCode

 The reason code for the function's current state. When the code is Creating, you can't invoke or
 modify the function.
 


lastUpdateStatus
String lastUpdateStatus

 The status of the last update that was performed on the function. This is first set to Successful
 after function creation completes.
 


lastUpdateStatusReason
String lastUpdateStatusReason

 The reason for the last update that was performed on the function.
 


lastUpdateStatusReasonCode
String lastUpdateStatusReasonCode

 The reason code for the last update that was performed on the function.
 








Class com.amazonaws.services.lambda.model.UpdateFunctionEventInvokeConfigRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


functionName
String functionName

 The name of the Lambda function, version, or alias.
 
 
 Name formats
 
 
 
 
 Function name - my-function (name-only), my-function:v1 (with alias).
 
 
 
 
 Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.
 
 
 
 
 Partial ARN - 123456789012:function:my-function.
 
 
 
 
 You can append a version number or alias to any of the formats. The length constraint applies only to the full
 ARN. If you specify only the function name, it is limited to 64 characters in length.
 


qualifier
String qualifier

 A version number or alias name.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 The maximum number of times to retry when the function returns an error.
 


maximumEventAgeInSeconds
Integer maximumEventAgeInSeconds

 The maximum age of a request that Lambda sends to a function for processing.
 


destinationConfig
DestinationConfig destinationConfig

 A destination for events after they have been sent to a function for processing.
 
 
 Destinations
 
 
 
 
 Function - The Amazon Resource Name (ARN) of a Lambda function.
 
 
 
 
 Queue - The ARN of an SQS queue.
 
 
 
 
 Topic - The ARN of an SNS topic.
 
 
 
 
 Event Bus - The ARN of an Amazon EventBridge event bus.
 
 
 








Class com.amazonaws.services.lambda.model.UpdateFunctionEventInvokeConfigResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


lastModified
Date lastModified

 The date and time that the configuration was last updated.
 


functionArn
String functionArn

 The Amazon Resource Name (ARN) of the function.
 


maximumRetryAttempts
Integer maximumRetryAttempts

 The maximum number of times to retry when the function returns an error.
 


maximumEventAgeInSeconds
Integer maximumEventAgeInSeconds

 The maximum age of a request that Lambda sends to a function for processing.
 


destinationConfig
DestinationConfig destinationConfig

 A destination for events after they have been sent to a function for processing.
 
 
 Destinations
 
 
 
 
 Function - The Amazon Resource Name (ARN) of a Lambda function.
 
 
 
 
 Queue - The ARN of an SQS queue.
 
 
 
 
 Topic - The ARN of an SNS topic.
 
 
 
 
 Event Bus - The ARN of an Amazon EventBridge event bus.
 
 
 








Class com.amazonaws.services.lambda.model.VpcConfig extends Object implements Serializable


Serialized Fields


subnetIds
SdkInternalList<T> subnetIds

 A list of VPC subnet IDs.
 


securityGroupIds
SdkInternalList<T> securityGroupIds

 A list of VPC security groups IDs.
 








Class com.amazonaws.services.lambda.model.VpcConfigResponse extends Object implements Serializable


Serialized Fields


subnetIds
SdkInternalList<T> subnetIds

 A list of VPC subnet IDs.
 


securityGroupIds
SdkInternalList<T> securityGroupIds

 A list of VPC security groups IDs.
 


vpcId
String vpcId

 The ID of the VPC.
 








Package com.amazonaws.services.lexmodelbuilding.model




Class com.amazonaws.services.lexmodelbuilding.model.AmazonLexModelBuildingException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexmodelbuilding.model.BadRequestException extends AmazonLexModelBuildingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexmodelbuilding.model.BotAliasMetadata extends Object implements Serializable


Serialized Fields


name
String name

 The name of the bot alias.
 


description
String description

 A description of the bot alias.
 


botVersion
String botVersion

 The version of the Amazon Lex bot to which the alias points.
 


botName
String botName

 The name of the bot to which the alias points.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the bot alias was updated. When you create a resource, the creation date and last updated date are
 the same.
 


createdDate
Date createdDate

 The date that the bot alias was created.
 


checksum
String checksum

 Checksum of the bot alias.
 


conversationLogs
ConversationLogsResponse conversationLogs

 Settings that determine how Amazon Lex uses conversation logs for the alias.
 








Class com.amazonaws.services.lexmodelbuilding.model.BotChannelAssociation extends Object implements Serializable


Serialized Fields


name
String name

 The name of the association between the bot and the channel.
 


description
String description

 A text description of the association you are creating.
 


botAlias
String botAlias

 An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
 


botName
String botName

 The name of the Amazon Lex bot to which this association is being made.
 
 
 
 Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.
 
 


createdDate
Date createdDate

 The date that the association between the Amazon Lex bot and the channel was created.
 


type
String type

 Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot
 and the external messaging platform.
 


botConfiguration
Map<K,V> botConfiguration

 Provides information necessary to communicate with the messaging platform.
 


status
String status

 The status of the bot channel.
 
 
 
 
 CREATED - The channel has been created and is ready for use.
 
 
 
 
 IN_PROGRESS - Channel creation is in progress.
 
 
 
 
 FAILED - There was an error creating the channel. For information about the reason for the failure,
 see the failureReason field.
 
 
 


failureReason
String failureReason

 If status is FAILED, Amazon Lex provides the reason that it failed to create the
 association.
 








Class com.amazonaws.services.lexmodelbuilding.model.BotMetadata extends Object implements Serializable


Serialized Fields


name
String name

 The name of the bot.
 


description
String description

 A description of the bot.
 


status
String status

 The status of the bot.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.
 


createdDate
Date createdDate

 The date that the bot was created.
 


version
String version

 The version of the bot. For a new bot, the version is always $LATEST.
 








Class com.amazonaws.services.lexmodelbuilding.model.BuiltinIntentMetadata extends Object implements Serializable


Serialized Fields


signature
String signature

 A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
 


supportedLocales
List<E> supportedLocales

 A list of identifiers for the locales that the intent supports.
 








Class com.amazonaws.services.lexmodelbuilding.model.BuiltinIntentSlot extends Object implements Serializable


Serialized Fields


name
String name

 A list of the slots defined for the intent.
 








Class com.amazonaws.services.lexmodelbuilding.model.BuiltinSlotTypeMetadata extends Object implements Serializable


Serialized Fields


signature
String signature

 A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type Reference in the Alexa Skills Kit.
 


supportedLocales
List<E> supportedLocales

 A list of target locales for the slot.
 








Class com.amazonaws.services.lexmodelbuilding.model.CodeHook extends Object implements Serializable


Serialized Fields


uri
String uri

 The Amazon Resource Name (ARN) of the Lambda function.
 


messageVersion
String messageVersion

 The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more
 information, see using-lambda.
 








Class com.amazonaws.services.lexmodelbuilding.model.ConflictException extends AmazonLexModelBuildingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexmodelbuilding.model.ConversationLogsRequest extends Object implements Serializable


Serialized Fields


logSettings
List<E> logSettings

 The settings for your conversation logs. You can log the conversation text, conversation audio, or both.
 


iamRoleArn
String iamRoleArn

 The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch Logs for text logs and
 your S3 bucket for audio logs. If audio encryption is enabled, this role also provides access permission for the
 AWS KMS key used for encrypting audio logs. For more information, see Creating an IAM Role and
 Policy for Conversation Logs.
 








Class com.amazonaws.services.lexmodelbuilding.model.ConversationLogsResponse extends Object implements Serializable


Serialized Fields


logSettings
List<E> logSettings

 The settings for your conversation logs. You can log text, audio, or both.
 


iamRoleArn
String iamRoleArn

 The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket.
 








Class com.amazonaws.services.lexmodelbuilding.model.CreateBotVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the bot that you want to create a new version of. The name is case sensitive.
 


checksum
String checksum

 Identifies a specific revision of the $LATEST version of the bot. If you specify a checksum and the
 $LATEST version of the bot has a different checksum, a PreconditionFailedException
 exception is returned and Amazon Lex doesn't publish a new version. If you don't specify a checksum, Amazon Lex
 publishes the $LATEST version.
 








Class com.amazonaws.services.lexmodelbuilding.model.CreateBotVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the bot.
 


description
String description

 A description of the bot.
 


intents
List<E> intents

 An array of Intent objects. For more information, see PutBot.
 


clarificationPrompt
Prompt clarificationPrompt

 The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see
 PutBot.
 


abortStatement
Statement abortStatement

 The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
 


status
String status

 When you send a request to create or update a bot, Amazon Lex sets the status response element to
 BUILDING. After Amazon Lex builds the bot, it sets status to READY. If
 Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason
 for the failure in the failureReason response element.
 


failureReason
String failureReason

 If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
 


lastUpdatedDate
Date lastUpdatedDate

 The date when the $LATEST version of this bot was updated.
 


createdDate
Date createdDate

 The date when the bot version was created.
 


idleSessionTTLInSeconds
Integer idleSessionTTLInSeconds

 The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information,
 see PutBot.
 


voiceId
String voiceId

 The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.
 


checksum
String checksum

 Checksum identifying the version of the bot that was created.
 


version
String version

 The version of the bot.
 


locale
String locale

 Specifies the target locale for the bot.
 


childDirected
Boolean childDirected

 For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of
 Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in
 part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
 true or false in the childDirected field. By specifying true
 in the childDirected field, you confirm that your use of Amazon Lex is related to a website,
 program, or other application that is directed or targeted, in whole or in part, to children under age 13 and
 subject to COPPA. By specifying false in the childDirected field, you confirm that your
 use of Amazon Lex is not related to a website, program, or other application that is directed or targeted,
 in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the
 childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a
 website, program, or other application that is directed or targeted, in whole or in part, to children under age
 13 and subject to COPPA.
 
 
 If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in
 part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For
 information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are
 directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
 


detectSentiment
Boolean detectSentiment

 Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
 








Class com.amazonaws.services.lexmodelbuilding.model.CreateIntentVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the intent that you want to create a new version of. The name is case sensitive.
 


checksum
String checksum

 Checksum of the $LATEST version of the intent that should be used to create the new version. If you
 specify a checksum and the $LATEST version of the intent has a different checksum, Amazon Lex
 returns a PreconditionFailedException exception and doesn't publish a new version. If you don't
 specify a checksum, Amazon Lex publishes the $LATEST version.
 








Class com.amazonaws.services.lexmodelbuilding.model.CreateIntentVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the intent.
 


description
String description

 A description of the intent.
 


slots
List<E> slots

 An array of slot types that defines the information required to fulfill the intent.
 


sampleUtterances
List<E> sampleUtterances

 An array of sample utterances configured for the intent.
 


confirmationPrompt
Prompt confirmationPrompt

 If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it.
 


rejectionStatement
Statement rejectionStatement

 If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with
 this statement to acknowledge that the intent was canceled.
 


followUpPrompt
FollowUpPrompt followUpPrompt

 If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.
 


conclusionStatement
Statement conclusionStatement

 After the Lambda function specified in the fulfillmentActivity field fulfills the intent, Amazon Lex
 conveys this statement to the user.
 


dialogCodeHook
CodeHook dialogCodeHook

 If defined, Amazon Lex invokes this Lambda function for each user input.
 


fulfillmentActivity
FulfillmentActivity fulfillmentActivity

 Describes how the intent is fulfilled.
 


parentIntentSignature
String parentIntentSignature

 A unique identifier for a built-in intent.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the intent was updated.
 


createdDate
Date createdDate

 The date that the intent was created.
 


version
String version

 The version number assigned to the new version of the intent.
 


checksum
String checksum

 Checksum of the intent version created.
 








Class com.amazonaws.services.lexmodelbuilding.model.CreateSlotTypeVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the slot type that you want to create a new version for. The name is case sensitive.
 


checksum
String checksum

 Checksum for the $LATEST version of the slot type that you want to publish. If you specify a
 checksum and the $LATEST version of the slot type has a different checksum, Amazon Lex returns a
 PreconditionFailedException exception and doesn't publish the new version. If you don't specify a
 checksum, Amazon Lex publishes the $LATEST version.
 








Class com.amazonaws.services.lexmodelbuilding.model.CreateSlotTypeVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the slot type.
 


description
String description

 A description of the slot type.
 


enumerationValues
List<E> enumerationValues

 A list of EnumerationValue objects that defines the values that the slot type can take.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the slot type was updated. When you create a resource, the creation date and last update date are
 the same.
 


createdDate
Date createdDate

 The date that the slot type was created.
 


version
String version

 The version assigned to the new slot type version.
 


checksum
String checksum

 Checksum of the $LATEST version of the slot type.
 


valueSelectionStrategy
String valueSelectionStrategy

 The strategy that Amazon Lex uses to determine the value of the slot. For more information, see
 PutSlotType.
 








Class com.amazonaws.services.lexmodelbuilding.model.DeleteBotAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the alias to delete. The name is case sensitive.
 


botName
String botName

 The name of the bot that the alias points to.
 








Class com.amazonaws.services.lexmodelbuilding.model.DeleteBotAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lexmodelbuilding.model.DeleteBotChannelAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the association. The name is case sensitive.
 


botName
String botName

 The name of the Amazon Lex bot.
 


botAlias
String botAlias

 An alias that points to the specific version of the Amazon Lex bot to which this association is being made.
 








Class com.amazonaws.services.lexmodelbuilding.model.DeleteBotChannelAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lexmodelbuilding.model.DeleteBotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the bot. The name is case sensitive.
 








Class com.amazonaws.services.lexmodelbuilding.model.DeleteBotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lexmodelbuilding.model.DeleteBotVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the bot.
 


version
String version

 The version of the bot to delete. You cannot delete the $LATEST version of the bot. To delete the
 $LATEST version, use the DeleteBot operation.
 








Class com.amazonaws.services.lexmodelbuilding.model.DeleteBotVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lexmodelbuilding.model.DeleteIntentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the intent. The name is case sensitive.
 








Class com.amazonaws.services.lexmodelbuilding.model.DeleteIntentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lexmodelbuilding.model.DeleteIntentVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the intent.
 


version
String version

 The version of the intent to delete. You cannot delete the $LATEST version of the intent. To delete
 the $LATEST version, use the DeleteIntent operation.
 








Class com.amazonaws.services.lexmodelbuilding.model.DeleteIntentVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lexmodelbuilding.model.DeleteSlotTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the slot type. The name is case sensitive.
 








Class com.amazonaws.services.lexmodelbuilding.model.DeleteSlotTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lexmodelbuilding.model.DeleteSlotTypeVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the slot type.
 


version
String version

 The version of the slot type to delete. You cannot delete the $LATEST version of the slot type. To
 delete the $LATEST version, use the DeleteSlotType operation.
 








Class com.amazonaws.services.lexmodelbuilding.model.DeleteSlotTypeVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lexmodelbuilding.model.DeleteUtterancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


botName
String botName

 The name of the bot that stored the utterances.
 


userId
String userId

 The unique identifier for the user that made the utterances. This is the user ID that was sent in the PostContent or PostText operation request that
 contained the utterance.
 








Class com.amazonaws.services.lexmodelbuilding.model.DeleteUtterancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.lexmodelbuilding.model.EnumerationValue extends Object implements Serializable


Serialized Fields


value
String value

 The value of the slot type.
 


synonyms
List<E> synonyms

 Additional values related to the slot type value.
 








Class com.amazonaws.services.lexmodelbuilding.model.FollowUpPrompt extends Object implements Serializable


Serialized Fields


prompt
Prompt prompt

 Prompts for information from the user.
 


rejectionStatement
Statement rejectionStatement

 If the user answers "no" to the question defined in the prompt field, Amazon Lex responds with this
 statement to acknowledge that the intent was canceled.
 








Class com.amazonaws.services.lexmodelbuilding.model.FulfillmentActivity extends Object implements Serializable


Serialized Fields


type
String type

 How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the
 client application.
 


codeHook
CodeHook codeHook

 A description of the Lambda function that is run to fulfill the intent.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotAliasesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


botName
String botName

 The name of the bot.
 


nextToken
String nextToken

 A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex
 returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in
 the next request.
 


maxResults
Integer maxResults

 The maximum number of aliases to return in the response. The default is 50. .
 


nameContains
String nameContains

 Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring.
 For example, "xyz" matches both "xyzabc" and "abcxyz."
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotAliasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


botAliases
List<E> botAliases

 An array of BotAliasMetadata objects, each describing a bot alias.
 


nextToken
String nextToken

 A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex
 returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in
 the next request.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the bot alias. The name is case sensitive.
 


botName
String botName

 The name of the bot.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the bot alias.
 


description
String description

 A description of the bot alias.
 


botVersion
String botVersion

 The version of the bot that the alias points to.
 


botName
String botName

 The name of the bot that the alias points to.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the bot alias was updated. When you create a resource, the creation date and the last updated date
 are the same.
 


createdDate
Date createdDate

 The date that the bot alias was created.
 


checksum
String checksum

 Checksum of the bot alias.
 


conversationLogs
ConversationLogsResponse conversationLogs

 The settings that determine how Amazon Lex uses conversation logs for the alias.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotChannelAssociationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the association between the bot and the channel. The name is case sensitive.
 


botName
String botName

 The name of the Amazon Lex bot.
 


botAlias
String botAlias

 An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotChannelAssociationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the association between the bot and the channel.
 


description
String description

 A description of the association between the bot and the channel.
 


botAlias
String botAlias

 An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
 


botName
String botName

 The name of the Amazon Lex bot.
 


createdDate
Date createdDate

 The date that the association between the bot and the channel was created.
 


type
String type

 The type of the messaging platform.
 


botConfiguration
Map<K,V> botConfiguration

 Provides information that the messaging platform needs to communicate with the Amazon Lex bot.
 


status
String status

 The status of the bot channel.
 
 
 
 
 CREATED - The channel has been created and is ready for use.
 
 
 
 
 IN_PROGRESS - Channel creation is in progress.
 
 
 
 
 FAILED - There was an error creating the channel. For information about the reason for the failure,
 see the failureReason field.
 
 
 


failureReason
String failureReason

 If status is FAILED, Amazon Lex provides the reason that it failed to create the
 association.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotChannelAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


botName
String botName

 The name of the Amazon Lex bot in the association.
 


botAlias
String botAlias

 An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
 


nextToken
String nextToken

 A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon
 Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination
 token in the next request.
 


maxResults
Integer maxResults

 The maximum number of associations to return in the response. The default is 50.
 


nameContains
String nameContains

 Substring to match in channel association names. An association will be returned if any part of its name matches
 the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To return all bot channel associations, use
 a hyphen ("-") as the nameContains parameter.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotChannelAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


botChannelAssociations
List<E> botChannelAssociations

 An array of objects, one for each association, that provides information about the Amazon Lex bot and its
 association with the channel.
 


nextToken
String nextToken

 A pagination token that fetches the next page of associations. If the response to this call is truncated, Amazon
 Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination
 token in the next request.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the bot. The name is case sensitive.
 


versionOrAlias
String versionOrAlias

 The version or alias of the bot.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the bot.
 


description
String description

 A description of the bot.
 


intents
List<E> intents

 An array of intent objects. For more information, see PutBot.
 


clarificationPrompt
Prompt clarificationPrompt

 The message Amazon Lex uses when it doesn't understand the user's request. For more information, see
 PutBot.
 


abortStatement
Statement abortStatement

 The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more
 information, see PutBot.
 


status
String status

 The status of the bot.
 
 
 When the status is BUILDING Amazon Lex is building the bot for testing and use.
 
 
 If the status of the bot is READY_BASIC_TESTING, you can test the bot using the exact utterances
 specified in the bot's intents. When the bot is ready for full testing or to run, the status is
 READY.
 
 
 If there was a problem with building the bot, the status is FAILED and the
 failureReason field explains why the bot did not build.
 
 
 If the bot was saved but not built, the status is NOT_BUILT.
 


failureReason
String failureReason

 If status is FAILED, Amazon Lex explains why it failed to build the bot.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the bot was updated. When you create a resource, the creation date and last updated date are the
 same.
 


createdDate
Date createdDate

 The date that the bot was created.
 


idleSessionTTLInSeconds
Integer idleSessionTTLInSeconds

 The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information,
 see PutBot.
 


voiceId
String voiceId

 The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see
 PutBot.
 


checksum
String checksum

 Checksum of the bot used to identify a specific revision of the bot's $LATEST version.
 


version
String version

 The version of the bot. For a new bot, the version is always $LATEST.
 


locale
String locale

 The target locale for the bot.
 


childDirected
Boolean childDirected

 For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of
 Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in
 part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
 true or false in the childDirected field. By specifying true
 in the childDirected field, you confirm that your use of Amazon Lex is related to a website,
 program, or other application that is directed or targeted, in whole or in part, to children under age 13 and
 subject to COPPA. By specifying false in the childDirected field, you confirm that your
 use of Amazon Lex is not related to a website, program, or other application that is directed or targeted,
 in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the
 childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a
 website, program, or other application that is directed or targeted, in whole or in part, to children under age
 13 and subject to COPPA.
 
 
 If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in
 part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For
 information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are
 directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
 


detectSentiment
Boolean detectSentiment

 Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex
 returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the
 next request.
 


maxResults
Integer maxResults

 The maximum number of bots to return in the response that the request will return. The default is 10.
 


nameContains
String nameContains

 Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For
 example, "xyz" matches both "xyzabc" and "abcxyz."
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bots
List<E> bots

 An array of botMetadata objects, with one entry for each bot.
 


nextToken
String nextToken

 If the response is truncated, it includes a pagination token that you can specify in your next request to fetch
 the next page of bots.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the bot for which versions should be returned.
 


nextToken
String nextToken

 A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon
 Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token
 in the next request.
 


maxResults
Integer maxResults

 The maximum number of bot versions to return in the response. The default is 10.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBotVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bots
List<E> bots

 An array of BotMetadata objects, one for each numbered version of the bot plus one for the
 $LATEST version.
 


nextToken
String nextToken

 A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon
 Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token
 in the next request.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBuiltinIntentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


signature
String signature

 The unique identifier for a built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBuiltinIntentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


signature
String signature

 The unique identifier for a built-in intent.
 


supportedLocales
List<E> supportedLocales

 A list of locales that the intent supports.
 


slots
List<E> slots

 An array of BuiltinIntentSlot objects, one entry for each slot type in the intent.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBuiltinIntentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


locale
String locale

 A list of locales that the intent supports.
 


signatureContains
String signatureContains

 Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches
 the substring. For example, "xyz" matches both "xyzabc" and "abcxyz." To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
 


nextToken
String nextToken

 A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a
 pagination token in the response. To fetch the next page of intents, use the pagination token in the next
 request.
 


maxResults
Integer maxResults

 The maximum number of intents to return in the response. The default is 10.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBuiltinIntentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


intents
List<E> intents

 An array of builtinIntentMetadata objects, one for each intent in the response.
 


nextToken
String nextToken

 A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon
 Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token
 in the next request.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBuiltinSlotTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


locale
String locale

 A list of locales that the slot type supports.
 


signatureContains
String signatureContains

 Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature
 matches the substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
 


nextToken
String nextToken

 A pagination token that fetches the next page of slot types. If the response to this API call is truncated,
 Amazon Lex returns a pagination token in the response. To fetch the next page of slot types, specify the
 pagination token in the next request.
 


maxResults
Integer maxResults

 The maximum number of slot types to return in the response. The default is 10.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetBuiltinSlotTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


slotTypes
List<E> slotTypes

 An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.
 


nextToken
String nextToken

 If the response is truncated, the response includes a pagination token that you can use in your next request to
 fetch the next page of slot types.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetExportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the bot to export.
 


version
String version

 The version of the bot to export.
 


resourceType
String resourceType

 The type of resource to export.
 


exportType
String exportType

 The format of the exported data.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetExportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the bot being exported.
 


version
String version

 The version of the bot being exported.
 


resourceType
String resourceType

 The type of the exported resource.
 


exportType
String exportType

 The format of the exported data.
 


exportStatus
String exportStatus

 The status of the export.
 
 
 
 
 IN_PROGRESS - The export is in progress.
 
 
 
 
 READY - The export is complete.
 
 
 
 
 FAILED - The export could not be completed.
 
 
 


failureReason
String failureReason

 If status is FAILED, Amazon Lex provides the reason that it failed to export the
 resource.
 


url
String url

 An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive
 that contains the exported resource in JSON format. The structure of the archive may change. Your code should not
 rely on the archive structure.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetImportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


importId
String importId

 The identifier of the import job information to return.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetImportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name given to the import job.
 


resourceType
String resourceType

 The type of resource imported.
 


mergeStrategy
String mergeStrategy

 The action taken when there was a conflict between an existing resource and a resource in the import file.
 


importId
String importId

 The identifier for the specific import job.
 


importStatus
String importStatus

 The status of the import job. If the status is FAILED, you can get the reason for the failure from
 the failureReason field.
 


failureReason
List<E> failureReason

 A string that describes why an import job failed to complete.
 


createdDate
Date createdDate

 A timestamp for the date and time that the import job was created.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetIntentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the intent. The name is case sensitive.
 


version
String version

 The version of the intent.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetIntentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the intent.
 


description
String description

 A description of the intent.
 


slots
List<E> slots

 An array of intent slots configured for the intent.
 


sampleUtterances
List<E> sampleUtterances

 An array of sample utterances configured for the intent.
 


confirmationPrompt
Prompt confirmationPrompt

 If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For
 more information, see PutIntent.
 


rejectionStatement
Statement rejectionStatement

 If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with
 this statement to acknowledge that the intent was canceled.
 


followUpPrompt
FollowUpPrompt followUpPrompt

 If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is
 fulfilled. For more information, see PutIntent.
 


conclusionStatement
Statement conclusionStatement

 After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon
 Lex conveys this statement to the user.
 


dialogCodeHook
CodeHook dialogCodeHook

 If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information,
 see PutIntent.
 


fulfillmentActivity
FulfillmentActivity fulfillmentActivity

 Describes how the intent is fulfilled. For more information, see PutIntent.
 


parentIntentSignature
String parentIntentSignature

 A unique identifier for a built-in intent.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the intent was updated. When you create a resource, the creation date and the last updated date are
 the same.
 


createdDate
Date createdDate

 The date that the intent was created.
 


version
String version

 The version of the intent.
 


checksum
String checksum

 Checksum of the intent.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetIntentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon
 Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token
 in the next request.
 


maxResults
Integer maxResults

 The maximum number of intents to return in the response. The default is 10.
 


nameContains
String nameContains

 Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For
 example, "xyz" matches both "xyzabc" and "abcxyz."
 








Class com.amazonaws.services.lexmodelbuilding.model.GetIntentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


intents
List<E> intents

 An array of Intent objects. For more information, see PutBot.
 


nextToken
String nextToken

 If the response is truncated, the response includes a pagination token that you can specify in your next request
 to fetch the next page of intents.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetIntentVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the intent for which versions should be returned.
 


nextToken
String nextToken

 A pagination token for fetching the next page of intent versions. If the response to this call is truncated,
 Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination
 token in the next request.
 


maxResults
Integer maxResults

 The maximum number of intent versions to return in the response. The default is 10.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetIntentVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


intents
List<E> intents

 An array of IntentMetadata objects, one for each numbered version of the intent plus one for the
 $LATEST version.
 


nextToken
String nextToken

 A pagination token for fetching the next page of intent versions. If the response to this call is truncated,
 Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination
 token in the next request.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetSlotTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the slot type. The name is case sensitive.
 


version
String version

 The version of the slot type.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetSlotTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the slot type.
 


description
String description

 A description of the slot type.
 


enumerationValues
List<E> enumerationValues

 A list of EnumerationValue objects that defines the values that the slot type can take.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the slot type was updated. When you create a resource, the creation date and last update date are
 the same.
 


createdDate
Date createdDate

 The date that the slot type was created.
 


version
String version

 The version of the slot type.
 


checksum
String checksum

 Checksum of the $LATEST version of the slot type.
 


valueSelectionStrategy
String valueSelectionStrategy

 The strategy that Amazon Lex uses to determine the value of the slot. For more information, see
 PutSlotType.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetSlotTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 A pagination token that fetches the next page of slot types. If the response to this API call is truncated,
 Amazon Lex returns a pagination token in the response. To fetch next page of slot types, specify the pagination
 token in the next request.
 


maxResults
Integer maxResults

 The maximum number of slot types to return in the response. The default is 10.
 


nameContains
String nameContains

 Substring to match in slot type names. A slot type will be returned if any part of its name matches the
 substring. For example, "xyz" matches both "xyzabc" and "abcxyz."
 








Class com.amazonaws.services.lexmodelbuilding.model.GetSlotTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


slotTypes
List<E> slotTypes

 An array of objects, one for each slot type, that provides information such as the name of the slot type, the
 version, and a description.
 


nextToken
String nextToken

 If the response is truncated, it includes a pagination token that you can specify in your next request to fetch
 the next page of slot types.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetSlotTypeVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the slot type for which versions should be returned.
 


nextToken
String nextToken

 A pagination token for fetching the next page of slot type versions. If the response to this call is truncated,
 Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination
 token in the next request.
 


maxResults
Integer maxResults

 The maximum number of slot type versions to return in the response. The default is 10.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetSlotTypeVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


slotTypes
List<E> slotTypes

 An array of SlotTypeMetadata objects, one for each numbered version of the slot type plus one for
 the $LATEST version.
 


nextToken
String nextToken

 A pagination token for fetching the next page of slot type versions. If the response to this call is truncated,
 Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination
 token in the next request.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetUtterancesViewRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


botName
String botName

 The name of the bot for which utterance information should be returned.
 


botVersions
List<E> botVersions

 An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.
 


statusType
String statusType

 To return utterances that were recognized and handled, use Detected. To return utterances that were
 not recognized, use Missed.
 








Class com.amazonaws.services.lexmodelbuilding.model.GetUtterancesViewResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


botName
String botName

 The name of the bot for which utterance information was returned.
 


utterances
List<E> utterances

 An array of UtteranceList objects, each containing a list of UtteranceData objects describing the
 utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData
 objects for each version. Amazon Lex returns the most frequent utterances received by the bot in the last 15
 days.
 








Class com.amazonaws.services.lexmodelbuilding.model.Intent extends Object implements Serializable


Serialized Fields


intentName
String intentName

 The name of the intent.
 


intentVersion
String intentVersion

 The version of the intent.
 








Class com.amazonaws.services.lexmodelbuilding.model.IntentMetadata extends Object implements Serializable


Serialized Fields


name
String name

 The name of the intent.
 


description
String description

 A description of the intent.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the intent was updated. When you create an intent, the creation date and last updated date are the
 same.
 


createdDate
Date createdDate

 The date that the intent was created.
 


version
String version

 The version of the intent.
 








Class com.amazonaws.services.lexmodelbuilding.model.InternalFailureException extends AmazonLexModelBuildingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexmodelbuilding.model.LimitExceededException extends AmazonLexModelBuildingException implements Serializable

serialVersionUID:
1L



Serialized Fields


retryAfterSeconds
String retryAfterSeconds








Class com.amazonaws.services.lexmodelbuilding.model.LogSettingsRequest extends Object implements Serializable


Serialized Fields


logType
String logType

 The type of logging to enable. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered
 to an S3 bucket.
 


destination
String destination

 Where the logs will be delivered. Text logs are delivered to a CloudWatch Logs log group. Audio logs are
 delivered to an S3 bucket.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name (ARN) of the AWS KMS customer managed key for encrypting audio logs delivered to an S3
 bucket. The key does not apply to CloudWatch Logs and is optional for S3 buckets.
 


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs should be delivered.
 








Class com.amazonaws.services.lexmodelbuilding.model.LogSettingsResponse extends Object implements Serializable


Serialized Fields


logType
String logType

 The type of logging that is enabled.
 


destination
String destination

 The destination where logs are delivered.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket.
 


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered.
 


resourcePrefix
String resourcePrefix

 The resource prefix is the first part of the S3 object key within the S3 bucket that you specified to contain
 audio logs. For CloudWatch Logs it is the prefix of the log stream name within the log group that you specified.
 








Class com.amazonaws.services.lexmodelbuilding.model.Message extends Object implements Serializable


Serialized Fields


contentType
String contentType

 The content type of the message string.
 


content
String content

 The text of the message.
 


groupNumber
Integer groupNumber

 Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex
 returns one message from each group in the response.
 








Class com.amazonaws.services.lexmodelbuilding.model.NotFoundException extends AmazonLexModelBuildingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexmodelbuilding.model.PreconditionFailedException extends AmazonLexModelBuildingException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexmodelbuilding.model.Prompt extends Object implements Serializable


Serialized Fields


messages
List<E> messages

 An array of objects, each of which provides a message string and its type. You can specify the message string in
 plain text or in Speech Synthesis Markup Language (SSML).
 


maxAttempts
Integer maxAttempts

 The number of times to prompt the user for information.
 


responseCard
String responseCard

 A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It
 substitutes session attributes and slot values for placeholders in the response card. For more information, see
 ex-resp-card.
 








Class com.amazonaws.services.lexmodelbuilding.model.PutBotAliasRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the alias. The name is not case sensitive.
 


description
String description

 A description of the alias.
 


botVersion
String botVersion

 The version of the bot.
 


botName
String botName

 The name of the bot.
 


checksum
String checksum

 Identifies a specific revision of the $LATEST version.
 
 
 When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a
 BadRequestException exception.
 
 
 When you want to update a bot alias, set the checksum field to the checksum of the most recent
 revision of the $LATEST version. If you don't specify the  checksum field, or if the
 checksum does not match the $LATEST version, you get a PreconditionFailedException
 exception.
 


conversationLogs
ConversationLogsRequest conversationLogs

 Settings for conversation logs for the alias.
 








Class com.amazonaws.services.lexmodelbuilding.model.PutBotAliasResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the alias.
 


description
String description

 A description of the alias.
 


botVersion
String botVersion

 The version of the bot that the alias points to.
 


botName
String botName

 The name of the bot that the alias points to.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the bot alias was updated. When you create a resource, the creation date and the last updated date
 are the same.
 


createdDate
Date createdDate

 The date that the bot alias was created.
 


checksum
String checksum

 The checksum for the current version of the alias.
 


conversationLogs
ConversationLogsResponse conversationLogs

 The settings that determine how Amazon Lex uses conversation logs for the alias.
 








Class com.amazonaws.services.lexmodelbuilding.model.PutBotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the bot. The name is not case sensitive.
 


description
String description

 A description of the bot.
 


intents
List<E> intents

 An array of Intent objects. Each intent represents a command that a user can express. For example, a
 pizza ordering bot might support an OrderPizza intent. For more information, see how-it-works.
 


clarificationPrompt
Prompt clarificationPrompt

 When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how
 many times Amazon Lex should repeat the clarification prompt, use the maxAttempts field. If Amazon
 Lex still doesn't understand, it sends the message in the abortStatement field.
 
 
 When you create a clarification prompt, make sure that it suggests the correct response from the user. for
 example, for a bot that orders pizza and drinks, you might create this clarification prompt:
 "What would you like to do? You can say 'Order a pizza' or 'Order a drink.'"
 
 
 If you have defined a fallback intent, it will be invoked if the clarification prompt is repeated the number of
 times defined in the maxAttempts field. For more information, see  AMAZON.FallbackIntent.
 
 
 If you don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request exception in
 three cases:
 
 
 
 
 Follow-up prompt - When the user responds to a follow-up prompt but does not provide an intent. For example, in
 response to a follow-up prompt that says "Would you like anything else today?" the user says "Yes." Amazon Lex
 will return a 400 Bad Request exception because it does not have a clarification prompt to send to the user to
 get an intent.
 
 
 
 
 Lambda function - When using a Lambda function, you return an ElicitIntent dialog type. Since Amazon
 Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception.
 
 
 
 
 PutSession operation - When using the PutSession operation, you send an ElicitIntent
 dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a
 400 Bad Request exception.
 
 
 


abortStatement
Statement abortStatement

 When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times.
 After that, Amazon Lex sends the message defined in abortStatement to the user, and then aborts the
 conversation. To set the number of retries, use the valueElicitationPrompt field for the slot type.
 
 
 For example, in a pizza ordering bot, Amazon Lex might ask a user "What type of crust would you like?" If the
 user's response is not one of the expected responses (for example, "thin crust, "deep dish," etc.), Amazon Lex
 tries to elicit a correct response a few more times.
 
 
 For example, in a pizza ordering application, OrderPizza might be one of the intents. This intent
 might require the CrustType slot. You specify the valueElicitationPrompt field when you
 create the CrustType slot.
 
 
 If you have defined a fallback intent the abort statement will not be sent to the user, the fallback intent is
 used instead. For more information, see  AMAZON.FallbackIntent.
 


idleSessionTTLInSeconds
Integer idleSessionTTLInSeconds

 The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
 
 
 A user interaction session remains active for the amount of time specified. If no conversation occurs during this
 time, the session expires and Amazon Lex deletes any data provided before the timeout.
 
 
 For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an
 order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information
 that it gathered, and the user must start over.
 
 
 If you don't include the idleSessionTTLInSeconds element in a PutBot operation request,
 Amazon Lex uses the default value. This is also true if the request replaces an existing bot.
 
 
 The default is 300 seconds (5 minutes).
 


voiceId
String voiceId

 The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale
 configured for the voice must match the locale of the bot. For more information, see Voices in Amazon Polly in the Amazon
 Polly Developer Guide.
 


checksum
String checksum

 Identifies a specific revision of the $LATEST version.
 
 
 When you create a new bot, leave the checksum field blank. If you specify a checksum you get a
 BadRequestException exception.
 
 
 When you want to update a bot, set the checksum field to the checksum of the most recent revision of
 the $LATEST version. If you don't specify the  checksum field, or if the checksum does
 not match the $LATEST version, you get a PreconditionFailedException exception.
 


processBehavior
String processBehavior

 If you set the processBehavior element to BUILD, Amazon Lex builds the bot so that it
 can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it.
 
 
 If you don't specify this value, the default value is BUILD.
 


locale
String locale

 Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the
 bot.
 
 
 The default is en-US.
 


childDirected
Boolean childDirected

 For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of
 Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in
 part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
 true or false in the childDirected field. By specifying true
 in the childDirected field, you confirm that your use of Amazon Lex is related to a website,
 program, or other application that is directed or targeted, in whole or in part, to children under age 13 and
 subject to COPPA. By specifying false in the childDirected field, you confirm that your
 use of Amazon Lex is not related to a website, program, or other application that is directed or targeted,
 in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the
 childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a
 website, program, or other application that is directed or targeted, in whole or in part, to children under age
 13 and subject to COPPA.
 
 
 If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in
 part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For
 information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are
 directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
 


detectSentiment
Boolean detectSentiment

 When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't
 specify detectSentiment, the default is false.
 


createVersion
Boolean createVersion

 When set to true a new numbered version of the bot is created. This is the same as calling the
 CreateBotVersion operation. If you don't specify createVersion, the default is
 false.
 








Class com.amazonaws.services.lexmodelbuilding.model.PutBotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the bot.
 


description
String description

 A description of the bot.
 


intents
List<E> intents

 An array of Intent objects. For more information, see PutBot.
 


clarificationPrompt
Prompt clarificationPrompt

 The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see
 PutBot.
 


abortStatement
Statement abortStatement

 The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
 


status
String status

 When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex
 sets the status response element to BUILDING.
 
 
 In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the
 utterances configured for the bot's intents and values in the slot types.
 
 
 If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns
 the reason for the failure in the failureReason response element.
 
 
 When you set processBehavior to SAVE, Amazon Lex sets the status code to
 NOT BUILT.
 
 
 When the bot is in the READY state you can test and publish the bot.
 


failureReason
String failureReason

 If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the bot was updated. When you create a resource, the creation date and last updated date are the
 same.
 


createdDate
Date createdDate

 The date that the bot was created.
 


idleSessionTTLInSeconds
Integer idleSessionTTLInSeconds

 The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see
 PutBot.
 


voiceId
String voiceId

 The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see
 PutBot.
 


checksum
String checksum

 Checksum of the bot that you created.
 


version
String version

 The version of the bot. For a new bot, the version is always $LATEST.
 


locale
String locale

 The target locale for the bot.
 


childDirected
Boolean childDirected

 For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of
 Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in
 part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying
 true or false in the childDirected field. By specifying true
 in the childDirected field, you confirm that your use of Amazon Lex is related to a website,
 program, or other application that is directed or targeted, in whole or in part, to children under age 13 and
 subject to COPPA. By specifying false in the childDirected field, you confirm that your
 use of Amazon Lex is not related to a website, program, or other application that is directed or targeted,
 in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the
 childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a
 website, program, or other application that is directed or targeted, in whole or in part, to children under age
 13 and subject to COPPA.
 
 
 If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in
 part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For
 information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are
 directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.
 


createVersion
Boolean createVersion

 True if a new version of the bot was created. If the createVersion field was not
 specified in the request, the createVersion field is set to false in the response.
 


detectSentiment
Boolean detectSentiment

 true if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis.
 If the detectSentiment field was not specified in the request, the detectSentiment
 field is false in the response.
 








Class com.amazonaws.services.lexmodelbuilding.model.PutIntentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the intent. The name is not case sensitive.
 
 
 The name can't match a built-in intent name, or a built-in intent name with "AMAZON." removed. For example,
 because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called
 HelpIntent.
 
 
 For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.
 


description
String description

 A description of the intent.
 


slots
List<E> slots

 An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined
 in the slots. For more information, see how-it-works.
 


sampleUtterances
List<E> sampleUtterances

 An array of utterances (strings) that a user might say to signal the intent. For example,
 "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas".
 
 
 In each utterance, a slot name is enclosed in curly braces.
 


confirmationPrompt
Prompt confirmationPrompt

 Prompts the user to confirm the intent. This question should have a yes or no answer.
 
 
 Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For
 example, with the OrderPizza intent, you might want to confirm that the order is correct before
 placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask
 the user for confirmation before providing the information.
 
 
 
 You you must provide both the rejectionStatement and the confirmationPrompt, or
 neither.
 
 


rejectionStatement
Statement rejectionStatement

 When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with
 this statement to acknowledge that the intent was canceled.
 
 
 
 You must provide both the rejectionStatement and the confirmationPrompt, or neither.
 
 


followUpPrompt
FollowUpPrompt followUpPrompt

 Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the
 OrderPizza intent is fulfilled, you might prompt the user to order a drink.
 
 
 The action that Amazon Lex takes depends on the user's response, as follows:
 
 
 
 
 If the user says "Yes" it responds with the clarification prompt that is configured for the bot.
 
 
 
 
 if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the
 intent.
 
 
 
 
 If the user says "No" it responds with the rejection statement configured for the the follow-up prompt.
 
 
 
 
 If it doesn't recognize the utterance it repeats the follow-up prompt again.
 
 
 
 
 The followUpPrompt field and the conclusionStatement field are mutually exclusive. You
 can specify only one.
 


conclusionStatement
Statement conclusionStatement

 The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the
 Lambda function.
 
 
 This element is relevant only if you provide a Lambda function in the fulfillmentActivity. If you
 return the intent to the client application, you can't specify this element.
 
 
 
 The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only
 one.
 
 


dialogCodeHook
CodeHook dialogCodeHook

 Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize
 user interaction.
 
 
 For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's
 information from a backend database and prepopulate some of the values. For example, if you find that John is
 gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant, to true. You might
 find John's phone number and set the corresponding session attribute.
 


fulfillmentActivity
FulfillmentActivity fulfillmentActivity

 Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a
 pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store.
 
 
 You might configure Amazon Lex to return all of the intent information to the client application, or direct it to
 invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).
 


parentIntentSignature
String parentIntentSignature

 A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
 


checksum
String checksum

 Identifies a specific revision of the $LATEST version.
 
 
 When you create a new intent, leave the checksum field blank. If you specify a checksum you get a
 BadRequestException exception.
 
 
 When you want to update a intent, set the checksum field to the checksum of the most recent revision
 of the $LATEST version. If you don't specify the  checksum field, or if the checksum
 does not match the $LATEST version, you get a PreconditionFailedException exception.
 


createVersion
Boolean createVersion

 When set to true a new numbered version of the intent is created. This is the same as calling the
 CreateIntentVersion operation. If you do not specify createVersion, the default is
 false.
 








Class com.amazonaws.services.lexmodelbuilding.model.PutIntentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the intent.
 


description
String description

 A description of the intent.
 


slots
List<E> slots

 An array of intent slots that are configured for the intent.
 


sampleUtterances
List<E> sampleUtterances

 An array of sample utterances that are configured for the intent.
 


confirmationPrompt
Prompt confirmationPrompt

 If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.
 


rejectionStatement
Statement rejectionStatement

 If the user answers "no" to the question defined in confirmationPrompt Amazon Lex responds with this
 statement to acknowledge that the intent was canceled.
 


followUpPrompt
FollowUpPrompt followUpPrompt

 If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is
 fulfilled.
 


conclusionStatement
Statement conclusionStatement

 After the Lambda function specified in thefulfillmentActivityintent fulfills the intent, Amazon Lex
 conveys this statement to the user.
 


dialogCodeHook
CodeHook dialogCodeHook

 If defined in the intent, Amazon Lex invokes this Lambda function for each user input.
 


fulfillmentActivity
FulfillmentActivity fulfillmentActivity

 If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent after the user provides
 all of the information required by the intent.
 


parentIntentSignature
String parentIntentSignature

 A unique identifier for the built-in intent that this intent is based on.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the intent was updated. When you create a resource, the creation date and last update dates are the
 same.
 


createdDate
Date createdDate

 The date that the intent was created.
 


version
String version

 The version of the intent. For a new intent, the version is always $LATEST.
 


checksum
String checksum

 Checksum of the $LATESTversion of the intent created or updated.
 


createVersion
Boolean createVersion

 True if a new version of the intent was created. If the createVersion field was not
 specified in the request, the createVersion field is set to false in the response.
 








Class com.amazonaws.services.lexmodelbuilding.model.PutSlotTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the slot type. The name is not case sensitive.
 
 
 The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For example,
 because there is a built-in slot type called AMAZON.DATE, you can't create a custom slot type called
 DATE.
 
 
 For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
 


description
String description

 A description of the slot type.
 


enumerationValues
List<E> enumerationValues

 A list of EnumerationValue objects that defines the values that the slot type can take. Each value
 can have a list of synonyms, which are additional values that help train the machine learning model
 about the values that it resolves for a slot.
 
 
 When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values
 for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not
 using a Lambda function you can choose to return the value that the user entered or the first value in the
 resolution list as the slot value. The valueSelectionStrategy field indicates the option to use.
 


checksum
String checksum

 Identifies a specific revision of the $LATEST version.
 
 
 When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a
 BadRequestException exception.
 
 
 When you want to update a slot type, set the checksum field to the checksum of the most recent
 revision of the $LATEST version. If you don't specify the  checksum field, or if the
 checksum does not match the $LATEST version, you get a PreconditionFailedException
 exception.
 


valueSelectionStrategy
String valueSelectionStrategy

 Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to
 one of the following values:
 
 
 
 
 ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot
 value.
 
 
 
 
 TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the
 resolution list as the slot type value. If there is no resolution list, null is returned.
 
 
 
 
 If you don't specify the valueSelectionStrategy, the default is ORIGINAL_VALUE.
 


createVersion
Boolean createVersion

 When set to true a new numbered version of the slot type is created. This is the same as calling the
 CreateSlotTypeVersion operation. If you do not specify createVersion, the default is
 false.
 








Class com.amazonaws.services.lexmodelbuilding.model.PutSlotTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name of the slot type.
 


description
String description

 A description of the slot type.
 


enumerationValues
List<E> enumerationValues

 A list of EnumerationValue objects that defines the values that the slot type can take.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the slot type was updated. When you create a slot type, the creation date and last update date are
 the same.
 


createdDate
Date createdDate

 The date that the slot type was created.
 


version
String version

 The version of the slot type. For a new slot type, the version is always $LATEST.
 


checksum
String checksum

 Checksum of the $LATEST version of the slot type.
 


valueSelectionStrategy
String valueSelectionStrategy

 The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see
 PutSlotType.
 


createVersion
Boolean createVersion

 True if a new version of the slot type was created. If the createVersion field was not
 specified in the request, the createVersion field is set to false in the response.
 








Class com.amazonaws.services.lexmodelbuilding.model.ResourceInUseException extends AmazonLexModelBuildingException implements Serializable

serialVersionUID:
1L



Serialized Fields


referenceType
String referenceType


exampleReference
ResourceReference exampleReference








Class com.amazonaws.services.lexmodelbuilding.model.ResourceReference extends Object implements Serializable


Serialized Fields


name
String name

 The name of the resource that is using the resource that you are trying to delete.
 


version
String version

 The version of the resource that is using the resource that you are trying to delete.
 








Class com.amazonaws.services.lexmodelbuilding.model.Slot extends Object implements Serializable


Serialized Fields


name
String name

 The name of the slot.
 


description
String description

 A description of the slot.
 


slotConstraint
String slotConstraint

 Specifies whether the slot is required or optional.
 


slotType
String slotType

 The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
 


slotTypeVersion
String slotTypeVersion

 The version of the slot type.
 


valueElicitationPrompt
Prompt valueElicitationPrompt

 The prompt that Amazon Lex uses to elicit the slot value from the user.
 


priority
Integer priority

 Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots
 with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1.
 
 
 If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.
 


sampleUtterances
List<E> sampleUtterances

 If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can
 provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of
 understanding user utterances.
 


responseCard
String responseCard

 A set of possible responses for the slot type used by text-based clients. A user chooses an option from the
 response card, instead of using text to reply.
 


obfuscationSetting
String obfuscationSetting

 Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot,
 the value is replaced by the slot name in curly braces ({}). For example, if the slot name is "full_name",
 obfuscated values are replaced with "{full_name}". For more information, see  Slot Obfuscation .
 








Class com.amazonaws.services.lexmodelbuilding.model.SlotTypeMetadata extends Object implements Serializable


Serialized Fields


name
String name

 The name of the slot type.
 


description
String description

 A description of the slot type.
 


lastUpdatedDate
Date lastUpdatedDate

 The date that the slot type was updated. When you create a resource, the creation date and last updated date are
 the same.
 


createdDate
Date createdDate

 The date that the slot type was created.
 


version
String version

 The version of the slot type.
 








Class com.amazonaws.services.lexmodelbuilding.model.StartImportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


payload
ByteBuffer payload

 A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to
 import. The resource should match the type specified in the resourceType field.
 


resourceType
String resourceType

 Specifies the type of resource to export. Each resource also exports any resources that it depends on.
 
 
 
 
 A bot exports dependent intents.
 
 
 
 
 An intent exports dependent slot types.
 
 
 


mergeStrategy
String mergeStrategy

 Specifies the action that the StartImport operation should take when there is an existing resource
 with the same name.
 
 
 
 
 FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file
 and an existing resource. The name of the resource causing the conflict is in the failureReason
 field of the response to the GetImport operation.
 
 
 OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The
 $LASTEST version of the existing resource is overwritten with the data from the import file.
 
 
 








Class com.amazonaws.services.lexmodelbuilding.model.StartImportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


name
String name

 The name given to the import job.
 


resourceType
String resourceType

 The type of resource to import.
 


mergeStrategy
String mergeStrategy

 The action to take when there is a merge conflict.
 


importId
String importId

 The identifier for the specific import job.
 


importStatus
String importStatus

 The status of the import job. If the status is FAILED, you can get the reason for the failure using
 the GetImport operation.
 


createdDate
Date createdDate

 A timestamp for the date and time that the import job was requested.
 








Class com.amazonaws.services.lexmodelbuilding.model.Statement extends Object implements Serializable


Serialized Fields


messages
List<E> messages

 A collection of message objects.
 


responseCard
String responseCard

 At runtime, if the client is using the PostText API, Amazon Lex includes
 the response card in the response. It substitutes all of the session attributes and slot values for placeholders
 in the response card.
 








Class com.amazonaws.services.lexmodelbuilding.model.UtteranceData extends Object implements Serializable


Serialized Fields


utteranceString
String utteranceString

 The text that was entered by the user or the text representation of an audio clip.
 


count
Integer count

 The number of times that the utterance was processed.
 


distinctUsers
Integer distinctUsers

 The total number of individuals that used the utterance.
 


firstUtteredDate
Date firstUtteredDate

 The date that the utterance was first recorded.
 


lastUtteredDate
Date lastUtteredDate

 The date that the utterance was last recorded.
 








Class com.amazonaws.services.lexmodelbuilding.model.UtteranceList extends Object implements Serializable


Serialized Fields


botVersion
String botVersion

 The version of the bot that processed the list.
 


utterances
List<E> utterances

 One or more UtteranceData objects that contain information about the utterances that have been made to a
 bot. The maximum number of object is 100.
 








Package com.amazonaws.services.lexruntime.model




Class com.amazonaws.services.lexruntime.model.AmazonLexRuntimeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexruntime.model.BadGatewayException extends AmazonLexRuntimeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexruntime.model.BadRequestException extends AmazonLexRuntimeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexruntime.model.Button extends Object implements Serializable


Serialized Fields


text
String text

 Text that is visible to the user on the button.
 


value
String value

 The value sent to Amazon Lex when a user chooses the button. For example, consider button text "NYC." When the
 user chooses the button, the value sent can be "New York City."
 








Class com.amazonaws.services.lexruntime.model.ConflictException extends AmazonLexRuntimeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexruntime.model.DeleteSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


botName
String botName

 The name of the bot that contains the session data.
 


botAlias
String botAlias

 The alias in use for the bot that contains the session data.
 


userId
String userId

 The identifier of the user associated with the session data.
 








Class com.amazonaws.services.lexruntime.model.DeleteSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


botName
String botName

 The name of the bot associated with the session data.
 


botAlias
String botAlias

 The alias in use for the bot associated with the session data.
 


userId
String userId

 The ID of the client application user.
 


sessionId
String sessionId

 The unique identifier for the session.
 








Class com.amazonaws.services.lexruntime.model.DependencyFailedException extends AmazonLexRuntimeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexruntime.model.DialogAction extends Object implements Serializable


Serialized Fields


type
String type

 The next action that the bot should take in its interaction with the user. The possible values are:
 
 
 
 
 ConfirmIntent - The next action is asking the user if the intent is complete and ready to be
 fulfilled. This is a yes/no question such as "Place the order?"
 
 
 
 
 Close - Indicates that the there will not be a response from the user. For example, the statement
 "Your order has been placed" does not require a response.
 
 
 
 
 Delegate - The next action is determined by Amazon Lex.
 
 
 
 
 ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
 
 
 
 
 ElicitSlot - The next action is to elicit a slot value from the user.
 
 
 


intentName
String intentName

 The name of the intent.
 


slots
Map<K,V> slots

 Map of the slots that have been gathered and their values.
 


slotToElicit
String slotToElicit

 The name of the slot that should be elicited from the user.
 


fulfillmentState
String fulfillmentState

 The fulfillment state of the intent. The possible values are:
 
 
 
 
 Failed - The Lambda function associated with the intent failed to fulfill the intent.
 
 
 
 
 Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
 
 
 
 
 ReadyForFulfillment - All of the information necessary for the intent is present and the intent
 ready to be fulfilled by the client application.
 
 
 


message
String message

 The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message
 configured for the intent.
 


messageFormat
String messageFormat

 
 
 PlainText - The message contains plain UTF-8 text.
 
 
 
 
 CustomPayload - The message is a custom format for the client.
 
 
 
 
 SSML - The message contains text formatted for voice output.
 
 
 
 
 Composite - The message contains an escaped JSON object containing one or more messages. For more
 information, see Message
 Groups.
 
 
 








Class com.amazonaws.services.lexruntime.model.GenericAttachment extends Object implements Serializable


Serialized Fields


title
String title

 The title of the option.
 


subTitle
String subTitle

 The subtitle shown below the title.
 


attachmentLinkUrl
String attachmentLinkUrl

 The URL of an attachment to the response card.
 


imageUrl
String imageUrl

 The URL of an image that is displayed to the user.
 


buttons
List<E> buttons

 The list of options to show to the user.
 








Class com.amazonaws.services.lexruntime.model.GetSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


botName
String botName

 The name of the bot that contains the session data.
 


botAlias
String botAlias

 The alias in use for the bot that contains the session data.
 


userId
String userId

 The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.
 


checkpointLabelFilter
String checkpointLabelFilter

 A string used to filter the intents returned in the recentIntentSummaryView structure.
 
 
 When you specify a filter, only intents with their checkpointLabel field set to that string are
 returned.
 








Class com.amazonaws.services.lexruntime.model.GetSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


recentIntentSummaryView
List<E> recentIntentSummaryView

 An array of information about the intents used in the session. The array can contain a maximum of three
 summaries. If more than three intents are used in the session, the recentIntentSummaryView operation
 contains information about the last three intents used.
 
 
 If you set the checkpointLabelFilter parameter in the request, the array contains only the intents
 with the specified label.
 


sessionAttributes
Map<K,V> sessionAttributes

 Map of key/value pairs representing the session-specific context information. It contains application information
 passed between Amazon Lex and a client application.
 


sessionId
String sessionId

 A unique identifier for the session.
 


dialogAction
DialogAction dialogAction

 Describes the current state of the bot.
 








Class com.amazonaws.services.lexruntime.model.IntentSummary extends Object implements Serializable


Serialized Fields


intentName
String intentName

 The name of the intent.
 


checkpointLabel
String checkpointLabel

 A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.
 
 
 Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter
 the intents returned by the operation to those with only the specified label.
 


slots
Map<K,V> slots

 Map of the slots that have been gathered and their values.
 


confirmationStatus
String confirmationStatus

 The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent,
 Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value
 to Denied. The possible values are:
 
 
 
 
 Confirmed - The user has responded "Yes" to the confirmation prompt, confirming that the intent is
 complete and that it is ready to be fulfilled.
 
 
 
 
 Denied - The user has responded "No" to the confirmation prompt.
 
 
 
 
 None - The user has never been prompted for confirmation; or, the user was prompted but did not
 confirm or deny the prompt.
 
 
 


dialogActionType
String dialogActionType

 The next action that the bot should take in its interaction with the user. The possible values are:
 
 
 
 
 ConfirmIntent - The next action is asking the user if the intent is complete and ready to be
 fulfilled. This is a yes/no question such as "Place the order?"
 
 
 
 
 Close - Indicates that the there will not be a response from the user. For example, the statement
 "Your order has been placed" does not require a response.
 
 
 
 
 ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
 
 
 
 
 ElicitSlot - The next action is to elicit a slot value from the user.
 
 
 


fulfillmentState
String fulfillmentState

 The fulfillment state of the intent. The possible values are:
 
 
 
 
 Failed - The Lambda function associated with the intent failed to fulfill the intent.
 
 
 
 
 Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
 
 
 
 
 ReadyForFulfillment - All of the information necessary for the intent is present and the intent
 ready to be fulfilled by the client application.
 
 
 


slotToElicit
String slotToElicit

 The next slot to elicit from the user. If there is not slot to elicit, the field is blank.
 








Class com.amazonaws.services.lexruntime.model.InternalFailureException extends AmazonLexRuntimeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexruntime.model.LimitExceededException extends AmazonLexRuntimeException implements Serializable

serialVersionUID:
1L



Serialized Fields


retryAfterSeconds
String retryAfterSeconds








Class com.amazonaws.services.lexruntime.model.LoopDetectedException extends AmazonLexRuntimeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexruntime.model.NotAcceptableException extends AmazonLexRuntimeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexruntime.model.NotFoundException extends AmazonLexRuntimeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexruntime.model.PostContentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


botName
String botName

 Name of the Amazon Lex bot.
 


botAlias
String botAlias

 Alias of the Amazon Lex bot.
 


userId
String userId

 The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At
 runtime, each request must contain the userID field.
 
 
 To decide the user ID to use for your application, consider the following factors.
 
 
 
 
 The userID field must not contain any personally identifiable information of the user, for example,
 name, personal identification numbers, or other end user personal information.
 
 
 
 
 If you want a user to start a conversation on one device and continue on another device, use a user-specific
 identifier.
 
 
 
 
 If you want the same user to be able to have two independent conversations on two different devices, choose a
 device-specific identifier.
 
 
 
 
 A user can't have two independent conversations with two different versions of the same bot. For example, a user
 can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will
 need to have conversation with two different versions, for example, while testing, include the bot alias in the
 user ID to separate the two conversations.
 
 
 


sessionAttributes
String sessionAttributes

 You pass this value as the x-amz-lex-session-attributes HTTP header.
 
 
 Application-specific information passed between Amazon Lex and a client application. The value must be a JSON
 serialized and base64 encoded map with string keys and values. The total size of the
 sessionAttributes and requestAttributes headers is limited to 12 KB.
 
 
 For more information, see Setting Session
 Attributes.
 


requestAttributes
String requestAttributes

 You pass this value as the x-amz-lex-request-attributes HTTP header.
 
 
 Request-specific information passed between Amazon Lex and a client application. The value must be a JSON
 serialized and base64 encoded map with string keys and values. The total size of the
 requestAttributes and sessionAttributes headers is limited to 12 KB.
 
 
 The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes
 with the prefix x-amz-lex:.
 
 
 For more information, see Setting Request
 Attributes.
 


contentType
String contentType

 You pass this value as the Content-Type HTTP header.
 
 
 Indicates the audio format or text. The header value must start with one of the following prefixes:
 
 
 
 
 PCM format, audio data must be in little-endian byte order.
 
 
 
 
 audio/l16; rate=16000; channels=1
 
 
 
 
 audio/x-l16; sample-rate=16000; channel-count=1
 
 
 
 
 audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
 
 
 
 
 
 
 Opus format
 
 
 
 
 audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4
 
 
 
 
 
 
 Text format
 
 
 
 
 text/plain; charset=utf-8
 
 
 
 
 


accept
String accept

 You pass this value as the Accept HTTP header.
 
 
 The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP
 header value in the request.
 
 
 
 
 If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.
 
 
 
 
 If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon
 Polly to generate the speech (using the configuration you specified in the Accept header). For
 example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.
 
 
 
 
 If the value is audio/pcm, the speech returned is audio/pcm in 16-bit, little endian
 format.
 
 
 
 
 The following are the accepted values:
 
 
 
 
 audio/mpeg
 
 
 
 
 audio/ogg
 
 
 
 
 audio/pcm
 
 
 
 
 text/plain; charset=utf-8
 
 
 
 
 audio/* (defaults to mpeg)
 
 
 
 
 


inputStream
InputStream inputStream

 User input in PCM or Opus audio format or text format as described in the Content-Type HTTP header.
 
 
 You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data
 before sending. In general, you get better performance if you stream audio data rather than buffering the data
 locally.
 








Class com.amazonaws.services.lexruntime.model.PostContentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contentType
String contentType

 Content type as specified in the Accept HTTP header in the request.
 


intentName
String intentName

 Current user intent that Amazon Lex is aware of.
 


slots
String slots

 Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the
 conversation. The field is base-64 encoded.
 
 
 Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined
 by the valueSelectionStrategy selected when the slot type was created or updated. If
 valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is
 returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to
 TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no
 resolution list, null. If you don't specify a valueSelectionStrategy, the default is
 ORIGINAL_VALUE.
 


sessionAttributes
String sessionAttributes

 Map of key/value pairs representing the session-specific context information.
 


sentimentResponse
String sentimentResponse

 The sentiment expressed in and utterance.
 
 
 When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains
 the result of the analysis.
 


message
String message

 The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
 
 
 If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate
 as the dialogAction.type in its response, Amazon Lex decides on the next course of action and
 selects an appropriate message from the bot's configuration based on the current interaction context. For
 example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
 
 
 When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex
 returns one message from each group in the response. The message field is an escaped JSON string containing the
 messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
 
 
 If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
 


messageFormat
String messageFormat

 The format of the response message. One of the following values:
 
 
 
 
 PlainText - The message contains plain UTF-8 text.
 
 
 
 
 CustomPayload - The message is a custom format for the client.
 
 
 
 
 SSML - The message contains text formatted for voice output.
 
 
 
 
 Composite - The message contains an escaped JSON object containing one or more messages from the
 groups that messages were assigned to when the intent was created.
 
 
 


dialogState
String dialogState

 Identifies the current state of the user interaction. Amazon Lex returns one of the following values as
 dialogState. The client can optionally use this information to customize the user interface.
 
 
 
 
 ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the following examples:
 
 
 For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent
 from this utterance, it will return this dialog state.
 
 
 
 
 ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
 
 
 For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple "yes" or "no"
 response, a user might respond with additional information. For example, "yes, but make it a thick crust pizza"
 or "no, I want to order a drink." Amazon Lex can process such additional information (in these examples, update
 the crust type slot or change the intent from OrderPizza to OrderDrink).
 
 
 
 
 ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
 
 
 For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A
 user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the
 response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
 
 
 
 
 Fulfilled - Conveys that the Lambda function has successfully fulfilled the intent.
 
 
 
 
 ReadyForFulfillment - Conveys that the client has to fulfill the request.
 
 
 
 
 Failed - Conveys that the conversation with the user failed.
 
 
 This can happen for various reasons, including that the user does not provide an appropriate response to prompts
 from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if
 the Lambda function fails to fulfill the intent.
 
 
 


slotToElicit
String slotToElicit

 If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon
 Lex is eliciting a value.
 


inputTranscript
String inputTranscript

 The text used to process the request.
 
 
 If the input was an audio stream, the inputTranscript field contains the text extracted from the
 audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this
 information to determine if Amazon Lex is correctly processing the audio that you send.
 


audioStream
InputStream audioStream

 The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For example,
 if Amazon Lex did not understand the user intent, it sends the clarificationPrompt configured for
 the bot. If the intent requires confirmation before taking the fulfillment action, it sends the
 confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the
 intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the response.
 


sessionId
String sessionId

 The unique identifier for the session.
 








Class com.amazonaws.services.lexruntime.model.PostTextRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


botName
String botName

 The name of the Amazon Lex bot.
 


botAlias
String botAlias

 The alias of the Amazon Lex bot.
 


userId
String userId

 The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At
 runtime, each request must contain the userID field.
 
 
 To decide the user ID to use for your application, consider the following factors.
 
 
 
 
 The userID field must not contain any personally identifiable information of the user, for example,
 name, personal identification numbers, or other end user personal information.
 
 
 
 
 If you want a user to start a conversation on one device and continue on another device, use a user-specific
 identifier.
 
 
 
 
 If you want the same user to be able to have two independent conversations on two different devices, choose a
 device-specific identifier.
 
 
 
 
 A user can't have two independent conversations with two different versions of the same bot. For example, a user
 can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will
 need to have conversation with two different versions, for example, while testing, include the bot alias in the
 user ID to separate the two conversations.
 
 
 


sessionAttributes
Map<K,V> sessionAttributes

 Application-specific information passed between Amazon Lex and a client application.
 
 
 For more information, see Setting Session
 Attributes.
 


requestAttributes
Map<K,V> requestAttributes

 Request-specific information passed between Amazon Lex and a client application.
 
 
 The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes
 with the prefix x-amz-lex:.
 
 
 For more information, see Setting Request
 Attributes.
 


inputText
String inputText

 The text that the user entered (Amazon Lex interprets this text).
 








Class com.amazonaws.services.lexruntime.model.PostTextResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


intentName
String intentName

 The current user intent that Amazon Lex is aware of.
 


slots
Map<K,V> slots

 The intent slots that Amazon Lex detected from the user input in the conversation.
 
 
 Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined
 by the valueSelectionStrategy selected when the slot type was created or updated. If
 valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is
 returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to
 TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no
 resolution list, null. If you don't specify a valueSelectionStrategy, the default is
 ORIGINAL_VALUE.
 


sessionAttributes
Map<K,V> sessionAttributes

 A map of key-value pairs representing the session-specific context information.
 


message
String message

 The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
 
 
 If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate
 as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects
 an appropriate message from the bot's configuration based on the current interaction context. For example, if
 Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
 
 
 When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex
 returns one message from each group in the response. The message field is an escaped JSON string containing the
 messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
 
 
 If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
 


sentimentResponse
SentimentResponse sentimentResponse

 The sentiment expressed in and utterance.
 
 
 When the bot is configured to send utterances to Amazon Comprehend for sentiment analysis, this field contains
 the result of the analysis.
 


messageFormat
String messageFormat

 The format of the response message. One of the following values:
 
 
 
 
 PlainText - The message contains plain UTF-8 text.
 
 
 
 
 CustomPayload - The message is a custom format defined by the Lambda function.
 
 
 
 
 SSML - The message contains text formatted for voice output.
 
 
 
 
 Composite - The message contains an escaped JSON object containing one or more messages from the
 groups that messages were assigned to when the intent was created.
 
 
 


dialogState
String dialogState

 Identifies the current state of the user interaction. Amazon Lex returns one of the following values as
 dialogState. The client can optionally use this information to customize the user interface.
 
 
 
 
 ElicitIntent - Amazon Lex wants to elicit user intent.
 
 
 For example, a user might utter an intent ("I want to order a pizza"). If Amazon Lex cannot infer the user intent
 from this utterance, it will return this dialogState.
 
 
 
 
 ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response.
 
 
 For example, Amazon Lex wants user confirmation before fulfilling an intent.
 
 
 Instead of a simple "yes" or "no," a user might respond with additional information. For example,
 "yes, but make it thick crust pizza" or "no, I want to order a drink". Amazon Lex can process such additional
 information (in these examples, update the crust type slot value, or change intent from OrderPizza to
 OrderDrink).
 
 
 
 
 ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
 
 
 For example, suppose that in the response Amazon Lex sends this message: "What size pizza would you like?". A
 user might reply with the slot value (e.g., "medium"). The user might also provide additional information in the
 response (e.g., "medium thick crust pizza"). Amazon Lex can process such additional information appropriately.
 
 
 
 
 Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled
 the intent.
 
 
 
 
 ReadyForFulfillment - Conveys that the client has to fulfill the intent.
 
 
 
 
 Failed - Conveys that the conversation with the user failed.
 
 
 This can happen for various reasons including that the user did not provide an appropriate response to prompts
 from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the
 Lambda function failed to fulfill the intent.
 
 
 


slotToElicit
String slotToElicit

 If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon
 Lex is eliciting a value.
 


responseCard
ResponseCard responseCard

 Represents the options that the user has to respond to the current prompt. Response Card can come from the bot
 configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda
 function).
 


sessionId
String sessionId

 A unique identifier for the session.
 








Class com.amazonaws.services.lexruntime.model.PutSessionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


botName
String botName

 The name of the bot that contains the session data.
 


botAlias
String botAlias

 The alias in use for the bot that contains the session data.
 


userId
String userId

 The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.
 


sessionAttributes
Map<K,V> sessionAttributes

 Map of key/value pairs representing the session-specific context information. It contains application information
 passed between Amazon Lex and a client application.
 


dialogAction
DialogAction dialogAction

 Sets the next action that the bot should take to fulfill the conversation.
 


recentIntentSummaryView
List<E> recentIntentSummaryView

 A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an
 intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.
 
 
 An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be
 valid for the bot. You must provide valid values for:
 
 
 
 
 intentName
 
 
 
 
 slot names
 
 
 
 
 slotToElict
 
 
 
 
 If you send the recentIntentSummaryView parameter in a PutSession request, the contents
 of the new summary view replaces the old summary view. For example, if a GetSession request returns
 three intents in the summary view and you call PutSession with one intent in the summary view, the
 next call to GetSession will only return one intent.
 


accept
String accept

 The message that Amazon Lex returns in the response can be either text or speech based depending on the value of
 this field.
 
 
 
 
 If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.
 
 
 
 
 If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon
 Polly to generate the speech in the configuration that you specify. For example, if you specify
 audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.
 
 
 
 
 If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian
 format.
 
 
 
 
 The following are the accepted values:
 
 
 
 
 audio/mpeg
 
 
 
 
 audio/ogg
 
 
 
 
 audio/pcm
 
 
 
 
 audio/* (defaults to mpeg)
 
 
 
 
 text/plain; charset=utf-8
 
 
 
 
 








Class com.amazonaws.services.lexruntime.model.PutSessionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contentType
String contentType

 Content type as specified in the Accept HTTP header in the request.
 


intentName
String intentName

 The name of the current intent.
 


slots
String slots

 Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.
 
 
 Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined
 by the valueSelectionStrategy selected when the slot type was created or updated. If
 valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is
 returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to
 TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no
 resolution list, null. If you don't specify a valueSelectionStrategy the default is
 ORIGINAL_VALUE.
 


sessionAttributes
String sessionAttributes

 Map of key/value pairs representing session-specific context information.
 


message
String message

 The next message that should be presented to the user.
 


messageFormat
String messageFormat

 The format of the response message. One of the following values:
 
 
 
 
 PlainText - The message contains plain UTF-8 text.
 
 
 
 
 CustomPayload - The message is a custom format for the client.
 
 
 
 
 SSML - The message contains text formatted for voice output.
 
 
 
 
 Composite - The message contains an escaped JSON object containing one or more messages from the
 groups that messages were assigned to when the intent was created.
 
 
 


dialogState
String dialogState

 

 
 
 ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to confirm the intent before
 fulfilling an intent.
 
 
 
 
 ElicitIntent - Amazon Lex wants to elicit the user's intent.
 
 
 
 
 ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
 
 
 
 
 Failed - Conveys that the conversation with the user has failed. This can happen for various
 reasons, including the user does not provide an appropriate response to prompts from the service, or if the
 Lambda function fails to fulfill the intent.
 
 
 
 
 Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.
 
 
 
 
 ReadyForFulfillment - Conveys that the client has to fulfill the intent.
 
 
 


slotToElicit
String slotToElicit

 If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is
 eliciting a value.
 


audioStream
InputStream audioStream

 The audio version of the message to convey to the user.
 


sessionId
String sessionId

 A unique identifier for the session.
 








Class com.amazonaws.services.lexruntime.model.RequestTimeoutException extends AmazonLexRuntimeException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lexruntime.model.ResponseCard extends Object implements Serializable


Serialized Fields


version
String version

 The version of the response card format.
 


contentType
String contentType

 The content type of the response.
 


genericAttachments
List<E> genericAttachments

 An array of attachment objects representing options.
 








Class com.amazonaws.services.lexruntime.model.SentimentResponse extends Object implements Serializable


Serialized Fields


sentimentLabel
String sentimentLabel

 The inferred sentiment that Amazon Comprehend has the highest confidence in.
 


sentimentScore
String sentimentScore

 The likelihood that the sentiment was correctly inferred.
 








Class com.amazonaws.services.lexruntime.model.UnsupportedMediaTypeException extends AmazonLexRuntimeException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.licensemanager.model




Class com.amazonaws.services.licensemanager.model.AccessDeniedException extends AWSLicenseManagerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.licensemanager.model.AuthorizationException extends AWSLicenseManagerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.licensemanager.model.AutomatedDiscoveryInformation extends Object implements Serializable


Serialized Fields


lastRunTime
Date lastRunTime

 Time that automated discovery last ran.
 








Class com.amazonaws.services.licensemanager.model.AWSLicenseManagerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.licensemanager.model.ConsumedLicenseSummary extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 Resource type of the resource consuming a license.
 


consumedLicenses
Long consumedLicenses

 Number of licenses consumed by the resource.
 








Class com.amazonaws.services.licensemanager.model.CreateLicenseConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the license configuration.
 


description
String description

 Description of the license configuration.
 


licenseCountingType
String licenseCountingType

 Dimension used to track the license inventory.
 


licenseCount
Long licenseCount

 Number of licenses managed by the license configuration.
 


licenseCountHardLimit
Boolean licenseCountHardLimit

 Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new
 instances.
 


licenseRules
List<E> licenseRules

 License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). Available rules vary
 by dimension.
 
 
 
 
 Cores dimension: allowedTenancy | maximumCores | minimumCores
 
 
 
 
 Instances dimension: allowedTenancy | maximumCores |
 minimumCores | maximumSockets | minimumSockets | maximumVcpus
 | minimumVcpus
 
 
 
 
 Sockets dimension: allowedTenancy | maximumSockets |
 minimumSockets
 
 
 
 
 vCPUs dimension: allowedTenancy | honorVcpuOptimization |
 maximumVcpus | minimumVcpus
 
 
 


tags
List<E> tags

 Tags to add to the license configuration.
 


productInformationList
List<E> productInformationList

 Product information.
 








Class com.amazonaws.services.licensemanager.model.CreateLicenseConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

 Amazon Resource Name (ARN) of the license configuration.
 








Class com.amazonaws.services.licensemanager.model.DeleteLicenseConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

 ID of the license configuration.
 








Class com.amazonaws.services.licensemanager.model.DeleteLicenseConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.licensemanager.model.FailedDependencyException extends AWSLicenseManagerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.licensemanager.model.Filter extends Object implements Serializable


Serialized Fields


name
String name

 Name of the filter. Filter names are case-sensitive.
 


values
List<E> values

 Filter values. Filter values are case-sensitive.
 








Class com.amazonaws.services.licensemanager.model.FilterLimitExceededException extends AWSLicenseManagerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.licensemanager.model.GetLicenseConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

 Amazon Resource Name (ARN) of the license configuration.
 








Class com.amazonaws.services.licensemanager.model.GetLicenseConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


licenseConfigurationId
String licenseConfigurationId

 Unique ID for the license configuration.
 


licenseConfigurationArn
String licenseConfigurationArn

 Amazon Resource Name (ARN) of the license configuration.
 


name
String name

 Name of the license configuration.
 


description
String description

 Description of the license configuration.
 


licenseCountingType
String licenseCountingType

 Dimension on which the licenses are counted.
 


licenseRules
List<E> licenseRules

 License rules.
 


licenseCount
Long licenseCount

 Number of available licenses.
 


licenseCountHardLimit
Boolean licenseCountHardLimit

 Sets the number of available licenses as a hard limit.
 


consumedLicenses
Long consumedLicenses

 Number of licenses assigned to resources.
 


status
String status

 License configuration status.
 


ownerAccountId
String ownerAccountId

 Account ID of the owner of the license configuration.
 


consumedLicenseSummaryList
List<E> consumedLicenseSummaryList

 Summaries of the licenses consumed by resources.
 


managedResourceSummaryList
List<E> managedResourceSummaryList

 Summaries of the managed resources.
 


tags
List<E> tags

 Tags for the license configuration.
 


productInformationList
List<E> productInformationList

 Product information.
 


automatedDiscoveryInformation
AutomatedDiscoveryInformation automatedDiscoveryInformation

 Automated discovery information.
 








Class com.amazonaws.services.licensemanager.model.GetServiceSettingsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.licensemanager.model.GetServiceSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


s3BucketArn
String s3BucketArn

 Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.
 


snsTopicArn
String snsTopicArn

 SNS topic configured to receive notifications from License Manager.
 


organizationConfiguration
OrganizationConfiguration organizationConfiguration

 Indicates whether AWS Organizations has been integrated with License Manager for cross-account discovery.
 


enableCrossAccountsDiscovery
Boolean enableCrossAccountsDiscovery

 Indicates whether cross-account discovery has been enabled.
 


licenseManagerResourceShareArn
String licenseManagerResourceShareArn

 Amazon Resource Name (ARN) of the AWS resource share. The License Manager master account will provide member
 accounts with access to this share.
 








Class com.amazonaws.services.licensemanager.model.InvalidParameterValueException extends AWSLicenseManagerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.licensemanager.model.InvalidResourceStateException extends AWSLicenseManagerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.licensemanager.model.InventoryFilter extends Object implements Serializable


Serialized Fields


name
String name

 Name of the filter.
 


condition
String condition

 Condition of the filter.
 


value
String value

 Value of the filter.
 








Class com.amazonaws.services.licensemanager.model.LicenseConfiguration extends Object implements Serializable


Serialized Fields


licenseConfigurationId
String licenseConfigurationId

 Unique ID of the license configuration.
 


licenseConfigurationArn
String licenseConfigurationArn

 Amazon Resource Name (ARN) of the license configuration.
 


name
String name

 Name of the license configuration.
 


description
String description

 Description of the license configuration.
 


licenseCountingType
String licenseCountingType

 Dimension to use to track the license inventory.
 


licenseRules
List<E> licenseRules

 License rules.
 


licenseCount
Long licenseCount

 Number of licenses managed by the license configuration.
 


licenseCountHardLimit
Boolean licenseCountHardLimit

 Number of available licenses as a hard limit.
 


consumedLicenses
Long consumedLicenses

 Number of licenses consumed.
 


status
String status

 Status of the license configuration.
 


ownerAccountId
String ownerAccountId

 Account ID of the license configuration's owner.
 


consumedLicenseSummaryList
List<E> consumedLicenseSummaryList

 Summaries for licenses consumed by various resources.
 


managedResourceSummaryList
List<E> managedResourceSummaryList

 Summaries for managed resources.
 


productInformationList
List<E> productInformationList

 Product information.
 


automatedDiscoveryInformation
AutomatedDiscoveryInformation automatedDiscoveryInformation

 Automated discovery information.
 








Class com.amazonaws.services.licensemanager.model.LicenseConfigurationAssociation extends Object implements Serializable


Serialized Fields


resourceArn
String resourceArn

 Amazon Resource Name (ARN) of the resource.
 


resourceType
String resourceType

 Type of server resource.
 


resourceOwnerId
String resourceOwnerId

 ID of the AWS account that owns the resource consuming licenses.
 


associationTime
Date associationTime

 Time when the license configuration was associated with the resource.
 








Class com.amazonaws.services.licensemanager.model.LicenseConfigurationUsage extends Object implements Serializable


Serialized Fields


resourceArn
String resourceArn

 Amazon Resource Name (ARN) of the resource.
 


resourceType
String resourceType

 Type of resource.
 


resourceStatus
String resourceStatus

 Status of the resource.
 


resourceOwnerId
String resourceOwnerId

 ID of the account that owns the resource.
 


associationTime
Date associationTime

 Time when the license configuration was initially associated with the resource.
 


consumedLicenses
Long consumedLicenses

 Number of licenses consumed by the resource.
 








Class com.amazonaws.services.licensemanager.model.LicenseOperationFailure extends Object implements Serializable


Serialized Fields


resourceArn
String resourceArn

 Amazon Resource Name (ARN) of the resource.
 


resourceType
String resourceType

 Resource type.
 


errorMessage
String errorMessage

 Error message.
 


failureTime
Date failureTime

 Failure time.
 


operationName
String operationName

 Name of the operation.
 


resourceOwnerId
String resourceOwnerId

 ID of the AWS account that owns the resource.
 


operationRequestedBy
String operationRequestedBy

 The requester is "License Manager Automated Discovery".
 


metadataList
List<E> metadataList

 Reserved.
 








Class com.amazonaws.services.licensemanager.model.LicenseSpecification extends Object implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

 Amazon Resource Name (ARN) of the license configuration.
 








Class com.amazonaws.services.licensemanager.model.LicenseUsageException extends AWSLicenseManagerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.licensemanager.model.ListAssociationsForLicenseConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

 Amazon Resource Name (ARN) of a license configuration.
 


maxResults
Integer maxResults

 Maximum number of results to return in a single call.
 


nextToken
String nextToken

 Token for the next set of results.
 








Class com.amazonaws.services.licensemanager.model.ListAssociationsForLicenseConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


licenseConfigurationAssociations
List<E> licenseConfigurationAssociations

 Information about the associations for the license configuration.
 


nextToken
String nextToken

 Token for the next set of results.
 








Class com.amazonaws.services.licensemanager.model.ListFailuresForLicenseConfigurationOperationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

 Amazon Resource Name of the license configuration.
 


maxResults
Integer maxResults

 Maximum number of results to return in a single call.
 


nextToken
String nextToken

 Token for the next set of results.
 








Class com.amazonaws.services.licensemanager.model.ListFailuresForLicenseConfigurationOperationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


licenseOperationFailureList
List<E> licenseOperationFailureList

 License configuration operations that failed.
 


nextToken
String nextToken

 Token for the next set of results.
 








Class com.amazonaws.services.licensemanager.model.ListLicenseConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


licenseConfigurationArns
List<E> licenseConfigurationArns

 Amazon Resource Names (ARN) of the license configurations.
 


maxResults
Integer maxResults

 Maximum number of results to return in a single call.
 


nextToken
String nextToken

 Token for the next set of results.
 


filters
List<E> filters

 Filters to scope the results. The following filters and logical operators are supported:
 
 
 
 
 licenseCountingType - The dimension on which licenses are counted (vCPU). Logical operators are
 EQUALS | NOT_EQUALS.
 
 
 
 
 enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used.
 Logical operators are EQUALS | NOT_EQUALS.
 
 
 
 
 usagelimitExceeded - A Boolean value that indicates whether the available licenses have been
 exceeded. Logical operators are EQUALS | NOT_EQUALS.
 
 
 








Class com.amazonaws.services.licensemanager.model.ListLicenseConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


licenseConfigurations
List<E> licenseConfigurations

 Information about the license configurations.
 


nextToken
String nextToken

 Token for the next set of results.
 








Class com.amazonaws.services.licensemanager.model.ListLicenseSpecificationsForResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 Amazon Resource Name (ARN) of a resource that has an associated license configuration.
 


maxResults
Integer maxResults

 Maximum number of results to return in a single call.
 


nextToken
String nextToken

 Token for the next set of results.
 








Class com.amazonaws.services.licensemanager.model.ListLicenseSpecificationsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


licenseSpecifications
List<E> licenseSpecifications

 License configurations associated with a resource.
 


nextToken
String nextToken

 Token for the next set of results.
 








Class com.amazonaws.services.licensemanager.model.ListResourceInventoryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 Maximum number of results to return in a single call.
 


nextToken
String nextToken

 Token for the next set of results.
 


filters
List<E> filters

 Filters to scope the results. The following filters and logical operators are supported:
 
 
 
 
 account_id - The ID of the AWS account that owns the resource. Logical operators are
 EQUALS | NOT_EQUALS.
 
 
 
 
 application_name - The name of the application. Logical operators are EQUALS |
 BEGINS_WITH.
 
 
 
 
 license_included - The type of license included. Logical operators are EQUALS |
 NOT_EQUALS. Possible values are sql-server-enterprise |
 sql-server-standard | sql-server-web | windows-server-datacenter.
 
 
 
 
 platform - The platform of the resource. Logical operators are EQUALS |
 BEGINS_WITH.
 
 
 
 
 resource_id - The ID of the resource. Logical operators are EQUALS |
 NOT_EQUALS.
 
 
 








Class com.amazonaws.services.licensemanager.model.ListResourceInventoryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceInventoryList
List<E> resourceInventoryList

 Information about the resources.
 


nextToken
String nextToken

 Token for the next set of results.
 








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


Serialized Fields


resourceArn
String resourceArn

 Amazon Resource Name (ARN) of the license configuration.
 








Class com.amazonaws.services.licensemanager.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 Information about the tags.
 








Class com.amazonaws.services.licensemanager.model.ListUsageForLicenseConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

 Amazon Resource Name (ARN) of the license configuration.
 


maxResults
Integer maxResults

 Maximum number of results to return in a single call.
 


nextToken
String nextToken

 Token for the next set of results.
 


filters
List<E> filters

 Filters to scope the results. The following filters and logical operators are supported:
 
 
 
 
 resourceArn - The ARN of the license configuration resource. Logical operators are
 EQUALS | NOT_EQUALS.
 
 
 
 
 resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI |
 SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS.
 
 
 
 
 resourceAccount - The ID of the account that owns the resource. Logical operators are
 EQUALS | NOT_EQUALS.
 
 
 








Class com.amazonaws.services.licensemanager.model.ListUsageForLicenseConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


licenseConfigurationUsageList
List<E> licenseConfigurationUsageList

 Information about the license configurations.
 


nextToken
String nextToken

 Token for the next set of results.
 








Class com.amazonaws.services.licensemanager.model.ManagedResourceSummary extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 Type of resource associated with a license.
 


associationCount
Long associationCount

 Number of resources associated with licenses.
 








Class com.amazonaws.services.licensemanager.model.Metadata extends Object implements Serializable


Serialized Fields


name
String name

 Reserved.
 


value
String value

 Reserved.
 








Class com.amazonaws.services.licensemanager.model.OrganizationConfiguration extends Object implements Serializable


Serialized Fields


enableIntegration
Boolean enableIntegration

 Enables AWS Organization integration.
 








Class com.amazonaws.services.licensemanager.model.ProductInformation extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 Resource type. The value is SSM_MANAGED.
 


productInformationFilterList
List<E> productInformationFilterList

 Product information filters. The following filters and logical operators are supported:
 
 
 
 
 Application Name - The name of the application. Logical operator is EQUALS.
 
 
 
 
 Application Publisher - The publisher of the application. Logical operator is EQUALS.
 
 
 
 
 Application Version - The version of the application. Logical operator is EQUALS.
 
 
 
 
 Platform Name - The name of the platform. Logical operator is EQUALS.
 
 
 
 
 Platform Type - The platform type. Logical operator is EQUALS.
 
 
 
 
 License Included - The type of license included. Logical operators are EQUALS and
 NOT_EQUALS. Possible values are sql-server-enterprise |
 sql-server-standard | sql-server-web | windows-server-datacenter.
 
 
 








Class com.amazonaws.services.licensemanager.model.ProductInformationFilter extends Object implements Serializable


Serialized Fields


productInformationFilterName
String productInformationFilterName

 Filter name.
 


productInformationFilterValue
List<E> productInformationFilterValue

 Filter value.
 


productInformationFilterComparator
String productInformationFilterComparator

 Logical operator.
 








Class com.amazonaws.services.licensemanager.model.RateLimitExceededException extends AWSLicenseManagerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.licensemanager.model.ResourceInventory extends Object implements Serializable


Serialized Fields


resourceId
String resourceId

 ID of the resource.
 


resourceType
String resourceType

 Type of resource.
 


resourceArn
String resourceArn

 Amazon Resource Name (ARN) of the resource.
 


platform
String platform

 Platform of the resource.
 


platformVersion
String platformVersion

 Platform version of the resource in the inventory.
 


resourceOwningAccountId
String resourceOwningAccountId

 ID of the account that owns the resource.
 








Class com.amazonaws.services.licensemanager.model.ResourceLimitExceededException extends AWSLicenseManagerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.licensemanager.model.ServerInternalException extends AWSLicenseManagerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.licensemanager.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 Tag key.
 


value
String value

 Tag value.
 








Class com.amazonaws.services.licensemanager.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 Amazon Resource Name (ARN) of the license configuration.
 


tags
List<E> tags

 One or more tags.
 








Class com.amazonaws.services.licensemanager.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.licensemanager.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 Amazon Resource Name (ARN) of the license configuration.
 


tagKeys
List<E> tagKeys

 Keys identifying the tags to remove.
 








Class com.amazonaws.services.licensemanager.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.licensemanager.model.UpdateLicenseConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


licenseConfigurationArn
String licenseConfigurationArn

 Amazon Resource Name (ARN) of the license configuration.
 


licenseConfigurationStatus
String licenseConfigurationStatus

 New status of the license configuration.
 


licenseRules
List<E> licenseRules

 New license rules.
 


licenseCount
Long licenseCount

 New number of licenses managed by the license configuration.
 


licenseCountHardLimit
Boolean licenseCountHardLimit

 New hard limit of the number of available licenses.
 


name
String name

 New name of the license configuration.
 


description
String description

 New description of the license configuration.
 


productInformationList
List<E> productInformationList

 New product information.
 








Class com.amazonaws.services.licensemanager.model.UpdateLicenseConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.licensemanager.model.UpdateLicenseSpecificationsForResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 Amazon Resource Name (ARN) of the AWS resource.
 


addLicenseSpecifications
List<E> addLicenseSpecifications

 ARNs of the license configurations to add.
 


removeLicenseSpecifications
List<E> removeLicenseSpecifications

 ARNs of the license configurations to remove.
 








Class com.amazonaws.services.licensemanager.model.UpdateLicenseSpecificationsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.licensemanager.model.UpdateServiceSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


s3BucketArn
String s3BucketArn

 Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.
 


snsTopicArn
String snsTopicArn

 Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.
 


organizationConfiguration
OrganizationConfiguration organizationConfiguration

 Enables integration with AWS Organizations for cross-account discovery.
 


enableCrossAccountsDiscovery
Boolean enableCrossAccountsDiscovery

 Activates cross-account discovery.
 








Class com.amazonaws.services.licensemanager.model.UpdateServiceSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.lightsail.model




Class com.amazonaws.services.lightsail.model.AccessDeniedException extends AmazonLightsailException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code


docs
String docs


tip
String tip








Class com.amazonaws.services.lightsail.model.AccountSetupInProgressException extends AmazonLightsailException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code


docs
String docs


tip
String tip








Class com.amazonaws.services.lightsail.model.AddOn extends Object implements Serializable


Serialized Fields


name
String name

 The name of the add-on.
 


status
String status

 The status of the add-on.
 


snapshotTimeOfDay
String snapshotTimeOfDay

 The daily time when an automatic snapshot is created.
 
 
 The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
 
 
 The snapshot is automatically created between the time shown and up to 45 minutes after.
 


nextSnapshotTimeOfDay
String nextSnapshotTimeOfDay

 The next daily time an automatic snapshot will be created.
 
 
 The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).
 
 
 The snapshot is automatically created between the time shown and up to 45 minutes after.
 








Class com.amazonaws.services.lightsail.model.AddOnRequest extends Object implements Serializable


Serialized Fields


addOnType
String addOnType

 The add-on type.
 


autoSnapshotAddOnRequest
AutoSnapshotAddOnRequest autoSnapshotAddOnRequest

 An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.
 








Class com.amazonaws.services.lightsail.model.AllocateStaticIpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


staticIpName
String staticIpName

 The name of the static IP address.
 








Class com.amazonaws.services.lightsail.model.AllocateStaticIpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the static IP address you allocated.
 








Class com.amazonaws.services.lightsail.model.AmazonLightsailException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.lightsail.model.AttachDiskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


diskName
String diskName

 The unique Lightsail disk name (e.g., my-disk).
 


instanceName
String instanceName

 The name of the Lightsail instance where you want to utilize the storage disk.
 


diskPath
String diskPath

 The disk path to expose to the instance (e.g., /dev/xvdf).
 








Class com.amazonaws.services.lightsail.model.AttachDiskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the API operations.
 








Class com.amazonaws.services.lightsail.model.AttachedDisk extends Object implements Serializable


Serialized Fields


path
String path

 The path of the disk (e.g., /dev/xvdf).
 


sizeInGb
Integer sizeInGb

 The size of the disk in GB.
 








Class com.amazonaws.services.lightsail.model.AttachInstancesToLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


instanceNames
List<E> instanceNames

 An array of strings representing the instance name(s) you want to attach to your load balancer.
 
 
 An instance must be running before you can attach it to your load balancer.
 
 
 There are no additional limits on the number of instances you can attach to your load balancer, aside from the
 limit of Lightsail instances you can create in your account (20).
 








Class com.amazonaws.services.lightsail.model.AttachInstancesToLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object representing the API operations.
 








Class com.amazonaws.services.lightsail.model.AttachLoadBalancerTlsCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer to which you want to associate the SSL/TLS certificate.
 


certificateName
String certificateName

 The name of your SSL/TLS certificate.
 








Class com.amazonaws.services.lightsail.model.AttachLoadBalancerTlsCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object representing the API operations.
 
 
 These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get the certificate and use it
 for another purpose.
 








Class com.amazonaws.services.lightsail.model.AttachStaticIpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


staticIpName
String staticIpName

 The name of the static IP.
 


instanceName
String instanceName

 The instance name to which you want to attach the static IP address.
 








Class com.amazonaws.services.lightsail.model.AttachStaticIpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about your API operations.
 








Class com.amazonaws.services.lightsail.model.AutoSnapshotAddOnRequest extends Object implements Serializable


Serialized Fields


snapshotTimeOfDay
String snapshotTimeOfDay

 The daily time when an automatic snapshot will be created.
 
 
 Constraints:
 
 
 
 
 Must be in HH:00 format, and in an hourly increment.
 
 
 
 
 Specified in Coordinated Universal Time (UTC).
 
 
 
 
 The snapshot will be automatically created between the time specified and up to 45 minutes after.
 
 
 








Class com.amazonaws.services.lightsail.model.AutoSnapshotDetails extends Object implements Serializable


Serialized Fields


date
String date

 The date of the automatic snapshot in YYYY-MM-DD format.
 


createdAt
Date createdAt

 The timestamp when the automatic snapshot was created.
 


status
String status

 The status of the automatic snapshot.
 


fromAttachedDisks
List<E> fromAttachedDisks

 An array of objects that describe the block storage disks attached to the instance when the automatic snapshot
 was created.
 








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


Serialized Fields


zoneName
String zoneName

 The name of the Availability Zone. The format is us-east-2a (case-sensitive).
 


state
String state

 The state of the Availability Zone.
 








Class com.amazonaws.services.lightsail.model.Blueprint extends Object implements Serializable


Serialized Fields


blueprintId
String blueprintId

 The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
 


name
String name

 The friendly name of the blueprint (e.g., Amazon Linux).
 


group
String group

 The group name of the blueprint (e.g., amazon-linux).
 


type
String type

 The type of the blueprint (e.g., os or app).
 


description
String description

 The description of the blueprint.
 


isActive
Boolean isActive

 A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers
 with existing instances but are not necessarily available for launch of new instances. Blueprints are marked
 inactive when they become outdated due to operating system updates or new application releases.
 


minPower
Integer minPower

 The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500
 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates
 that the blueprint runs on all instance sizes.
 


version
String version

 The version number of the operating system, application, or stack (e.g., 2016.03.0).
 


versionCode
String versionCode

 The version code.
 


productUrl
String productUrl

 The product URL to learn more about the image or blueprint.
 


licenseUrl
String licenseUrl

 The end-user license agreement URL for the image or blueprint.
 


platform
String platform

 The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
 








Class com.amazonaws.services.lightsail.model.Bundle extends Object implements Serializable


Serialized Fields


price
Float price

 The price in US dollars (e.g., 5.0).
 


cpuCount
Integer cpuCount

 The number of vCPUs included in the bundle (e.g., 2).
 


diskSizeInGb
Integer diskSizeInGb

 The size of the SSD (e.g., 30).
 


bundleId
String bundleId

 The bundle ID (e.g., micro_1_0).
 


instanceType
String instanceType

 The Amazon EC2 instance type (e.g., t2.micro).
 


isActive
Boolean isActive

 A Boolean value indicating whether the bundle is active.
 


name
String name

 A friendly name for the bundle (e.g., Micro).
 


power
Integer power

 A numeric value that represents the power of the bundle (e.g., 500). You can use the bundle's power
 value in conjunction with a blueprint's minimum power value to determine whether the blueprint will run on the
 bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a
 blueprint with a minimum power value of 500.
 


ramSizeInGb
Float ramSizeInGb

 The amount of RAM in GB (e.g., 2.0).
 


transferPerMonthInGb
Integer transferPerMonthInGb

 The data transfer rate per month in GB (e.g., 2000).
 


supportedPlatforms
List<E> supportedPlatforms

 The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only
 launch a WINDOWS bundle on a blueprint that supports the WINDOWS platform.
 LINUX_UNIX blueprints require a LINUX_UNIX bundle.
 








Class com.amazonaws.services.lightsail.model.CloseInstancePublicPortsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


portInfo
PortInfo portInfo

 Information about the public port you are trying to close.
 


instanceName
String instanceName

 The name of the instance on which you're attempting to close the public ports.
 








Class com.amazonaws.services.lightsail.model.CloseInstancePublicPortsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operation
Operation operation

 An array of key-value pairs that contains information about the operation.
 








Class com.amazonaws.services.lightsail.model.CloudFormationStackRecord extends Object implements Serializable


Serialized Fields


name
String name

 The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a
 GUID.
 


arn
String arn

 The Amazon Resource Name (ARN) of the CloudFormation stack record.
 


createdAt
Date createdAt

 The date when the CloudFormation stack record was created.
 


location
ResourceLocation location

 A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record.
 


resourceType
String resourceType

 The Lightsail resource type (e.g., CloudFormationStackRecord).
 


state
String state

 The current state of the CloudFormation stack record.
 


sourceInfo
List<E> sourceInfo

 A list of objects describing the source of the CloudFormation stack record.
 


destinationInfo
DestinationInfo destinationInfo

 A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name
 (ARN) of the AWS CloudFormation stack.
 








Class com.amazonaws.services.lightsail.model.CloudFormationStackRecordSourceInfo extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The Lightsail resource type (e.g., ExportSnapshotRecord).
 


name
String name

 The name of the record.
 


arn
String arn

 The Amazon Resource Name (ARN) of the export snapshot record.
 








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


Serialized Fields


sourceSnapshotName
String sourceSnapshotName

 The name of the source manual snapshot to copy.
 
 
 Constraint:
 
 
 
 
 Define this parameter only when copying a manual snapshot as another manual snapshot.
 
 
 


sourceResourceName
String sourceResourceName

 The name of the source instance or disk from which the source automatic snapshot was created.
 
 
 Constraint:
 
 
 
 
 Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the
 
 Lightsail Dev Guide.
 
 
 


restoreDate
String restoreDate

 The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify
 the dates of the available automatic snapshots.
 
 
 Constraints:
 
 
 
 
 Must be specified in YYYY-MM-DD format.
 
 
 
 
 This parameter cannot be defined together with the use latest restorable auto snapshot parameter.
 The restore date and use latest restorable auto snapshot parameters are mutually
 exclusive.
 
 
 
 
 Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the
 
 Lightsail Dev Guide.
 
 
 


useLatestRestorableAutoSnapshot
Boolean useLatestRestorableAutoSnapshot

 A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source
 instance or disk.
 
 
 Constraints:
 
 
 
 
 This parameter cannot be defined together with the restore date parameter. The
 use latest restorable auto snapshot and restore date parameters are mutually exclusive.
 
 
 
 
 Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the
 
 Lightsail Dev Guide.
 
 
 


targetSnapshotName
String targetSnapshotName

 The name of the new manual snapshot to be created as a copy.
 


sourceRegion
String sourceRegion

 The AWS Region where the source manual or automatic snapshot is located.
 








Class com.amazonaws.services.lightsail.model.CopySnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 A list of objects describing the API operation.
 








Class com.amazonaws.services.lightsail.model.CreateCloudFormationStackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instances
List<E> instances

 An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance
 entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry
 in this array.
 








Class com.amazonaws.services.lightsail.model.CreateCloudFormationStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 A list of objects describing the API operation.
 








Class com.amazonaws.services.lightsail.model.CreateDiskFromSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


diskName
String diskName

 The unique Lightsail disk name (e.g., my-disk).
 


diskSnapshotName
String diskSnapshotName

 The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk.
 
 
 Constraint:
 
 
 
 
 This parameter cannot be defined together with the source disk name parameter. The
 disk snapshot name and source disk name parameters are mutually exclusive.
 
 
 


availabilityZone
String availabilityZone

 The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same
 Availability Zone as the Lightsail instance where you want to create the disk.
 
 
 Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
 


sizeInGb
Integer sizeInGb

 The size of the disk in GB (e.g., 32).
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 


addOns
List<E> addOns

 An array of objects that represent the add-ons to enable for the new disk.
 


sourceDiskName
String sourceDiskName

 The name of the source disk from which the source automatic snapshot was created.
 
 
 Constraints:
 
 
 
 
 This parameter cannot be defined together with the disk snapshot name parameter. The
 source disk name and disk snapshot name parameters are mutually exclusive.
 
 
 
 
 Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the 
 Lightsail Dev Guide.
 
 
 


restoreDate
String restoreDate

 The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to
 identify the dates of the available automatic snapshots.
 
 
 Constraints:
 
 
 
 
 Must be specified in YYYY-MM-DD format.
 
 
 
 
 This parameter cannot be defined together with the use latest restorable auto snapshot parameter.
 The restore date and use latest restorable auto snapshot parameters are mutually
 exclusive.
 
 
 
 
 Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the 
 Lightsail Dev Guide.
 
 
 


useLatestRestorableAutoSnapshot
Boolean useLatestRestorableAutoSnapshot

 A Boolean value to indicate whether to use the latest available automatic snapshot.
 
 
 Constraints:
 
 
 
 
 This parameter cannot be defined together with the restore date parameter. The
 use latest restorable auto snapshot and restore date parameters are mutually exclusive.
 
 
 
 
 Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the 
 Lightsail Dev Guide.
 
 
 








Class com.amazonaws.services.lightsail.model.CreateDiskFromSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the API operations.
 








Class com.amazonaws.services.lightsail.model.CreateDiskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


diskName
String diskName

 The unique Lightsail disk name (e.g., my-disk).
 


availabilityZone
String availabilityZone

 The Availability Zone where you want to create the disk (e.g., us-east-2a). Use the same
 Availability Zone as the Lightsail instance to which you want to attach the disk.
 
 
 Use the get regions operation to list the Availability Zones where Lightsail is currently available.
 


sizeInGb
Integer sizeInGb

 The size of the disk in GB (e.g., 32).
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 


addOns
List<E> addOns

 An array of objects that represent the add-ons to enable for the new disk.
 








Class com.amazonaws.services.lightsail.model.CreateDiskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the API operations.
 








Class com.amazonaws.services.lightsail.model.CreateDiskSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


diskName
String diskName

 The unique name of the source disk (e.g., Disk-Virginia-1).
 
 
 
 This parameter cannot be defined together with the instance name parameter. The
 disk name and instance name parameters are mutually exclusive.
 
 


diskSnapshotName
String diskSnapshotName

 The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the source disk.
 


instanceName
String instanceName

 The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). When this is defined,
 a snapshot of the instance's system volume is created.
 
 
 
 This parameter cannot be defined together with the disk name parameter. The
 instance name and disk name parameters are mutually exclusive.
 
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 








Class com.amazonaws.services.lightsail.model.CreateDiskSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the API operations.
 








Class com.amazonaws.services.lightsail.model.CreateDomainEntryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The domain name (e.g., example.com) for which you want to create the domain entry.
 


domainEntry
DomainEntry domainEntry

 An array of key-value pairs containing information about the domain entry request.
 








Class com.amazonaws.services.lightsail.model.CreateDomainEntryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operation
Operation operation

 An array of key-value pairs containing information about the operation.
 








Class com.amazonaws.services.lightsail.model.CreateDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The domain name to manage (e.g., example.com).
 
 
 
 You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or
 another domain name registrar. If you have already registered your domain, you can enter its name in this
 parameter to manage the DNS records for that domain.
 
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 








Class com.amazonaws.services.lightsail.model.CreateDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operation
Operation operation

 An array of key-value pairs containing information about the domain resource you created.
 








Class com.amazonaws.services.lightsail.model.CreateInstancesFromSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceNames
List<E> instanceNames

 The names for your new instances.
 


attachedDiskMapping
Map<K,V> attachedDiskMapping

 An object containing information about one or more disk mappings.
 


availabilityZone
String availabilityZone

 The Availability Zone where you want to create your instances. Use the following formatting:
 us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions
 operation. Be sure to add the include Availability Zones parameter to your request.
 


instanceSnapshotName
String instanceSnapshotName

 The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots
 operation to return information about your existing snapshots.
 
 
 Constraint:
 
 
 
 
 This parameter cannot be defined together with the source instance name parameter. The
 instance snapshot name and source instance name parameters are mutually exclusive.
 
 
 


bundleId
String bundleId

 The bundle of specification information for your virtual private server (or instance), including the
 pricing plan (e.g., micro_1_0).
 


userData
String userData

 You can create a launch script that configures a server with additional user data. For example,
 apt-get -y update.
 
 
 
 Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and
 CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a
 complete list, see the Dev Guide.
 
 


keyPairName
String keyPairName

 The name for your key pair.
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 


addOns
List<E> addOns

 An array of objects representing the add-ons to enable for the new instance.
 


sourceInstanceName
String sourceInstanceName

 The name of the source instance from which the source automatic snapshot was created.
 
 
 Constraints:
 
 
 
 
 This parameter cannot be defined together with the instance snapshot name parameter. The
 source instance name and instance snapshot name parameters are mutually exclusive.
 
 
 
 
 Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the
 Lightsail Dev Guide.
 
 
 


restoreDate
String restoreDate

 The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation
 to identify the dates of the available automatic snapshots.
 
 
 Constraints:
 
 
 
 
 Must be specified in YYYY-MM-DD format.
 
 
 
 
 This parameter cannot be defined together with the use latest restorable auto snapshot parameter.
 The restore date and use latest restorable auto snapshot parameters are mutually
 exclusive.
 
 
 
 
 Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the
 Lightsail Dev Guide.
 
 
 


useLatestRestorableAutoSnapshot
Boolean useLatestRestorableAutoSnapshot

 A Boolean value to indicate whether to use the latest available automatic snapshot.
 
 
 Constraints:
 
 
 
 
 This parameter cannot be defined together with the restore date parameter. The
 use latest restorable auto snapshot and restore date parameters are mutually exclusive.
 
 
 
 
 Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the
 Lightsail Dev Guide.
 
 
 








Class com.amazonaws.services.lightsail.model.CreateInstancesFromSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the results of your create instances from snapshot
 request.
 








Class com.amazonaws.services.lightsail.model.CreateInstanceSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceSnapshotName
String instanceSnapshotName

 The name for your new snapshot.
 


instanceName
String instanceName

 The Lightsail instance on which to base your snapshot.
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 








Class com.amazonaws.services.lightsail.model.CreateInstanceSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the results of your create instances snapshot request.
 








Class com.amazonaws.services.lightsail.model.CreateInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceNames
List<E> instanceNames

 The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for
 example: ["MyFirstInstance","MySecondInstance"]
 


availabilityZone
String availabilityZone

 The Availability Zone in which to create your instance. Use the following format: us-east-2a (case
 sensitive). You can get a list of Availability Zones by using the get regions
 operation. Be sure to add the include Availability Zones parameter to your request.
 


customImageName
String customImageName
Deprecated. 

 (Deprecated) The name for your custom image.
 
 
 
 In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.
 
 


blueprintId
String blueprintId

 The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
 Use the get blueprints operation to return a list of available images (or blueprints).
 
 
 
 Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with
 existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when
 they become outdated due to operating system updates or new application releases.
 
 


bundleId
String bundleId

 The bundle of specification information for your virtual private server (or instance), including the
 pricing plan (e.g., micro_1_0).
 


userData
String userData

 A launch script you can create that configures a server with additional user data. For example, you might want to
 run apt-get -y update.
 
 
 
 Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and
 CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a
 complete list, see the Dev Guide.
 
 


keyPairName
String keyPairName

 The name of your key pair.
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 


addOns
List<E> addOns

 An array of objects representing the add-ons to enable for the new instance.
 








Class com.amazonaws.services.lightsail.model.CreateInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the results of your create instances request.
 








Class com.amazonaws.services.lightsail.model.CreateKeyPairRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyPairName
String keyPairName

 The name for your new key pair.
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 








Class com.amazonaws.services.lightsail.model.CreateKeyPairResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyPair
KeyPair keyPair

 An array of key-value pairs containing information about the new key pair you just created.
 


publicKeyBase64
String publicKeyBase64

 A base64-encoded public key of the ssh-rsa type.
 


privateKeyBase64
String privateKeyBase64

 A base64-encoded RSA private key.
 


operation
Operation operation

 An array of key-value pairs containing information about the results of your create key pair request.
 








Class com.amazonaws.services.lightsail.model.CreateLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of your load balancer.
 


instancePort
Integer instancePort

 The instance port where you're creating your load balancer.
 


healthCheckPath
String healthCheckPath

 The path you provided to perform the load balancer health check. If you didn't specify a health check path,
 Lightsail uses the root path of your website (e.g., "/").
 
 
 You may want to specify a custom health check path other than the root of your application if your home page
 loads slowly or has a lot of media or scripting on it.
 


certificateName
String certificateName

 The name of the SSL/TLS certificate.
 
 
 If you specify certificateName, then certificateDomainName is required (and
 vice-versa).
 


certificateDomainName
String certificateDomainName

 The domain name with which your certificate is associated (e.g., example.com).
 
 
 If you specify certificateDomainName, then certificateName is required (and
 vice-versa).
 


certificateAlternativeNames
List<E> certificateAlternativeNames

 The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g.,
 www.example.com, example.com, m.example.com, blog.example.com
 ).
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 








Class com.amazonaws.services.lightsail.model.CreateLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object containing information about the API operations.
 








Class com.amazonaws.services.lightsail.model.CreateLoadBalancerTlsCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The load balancer name where you want to create the SSL/TLS certificate.
 


certificateName
String certificateName

 The SSL/TLS certificate name.
 
 
 You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2
 certificates associated with it at one time. There is also an overall limit to the number of certificates that
 can be issue in a 365-day period. For more information, see Limits.
 


certificateDomainName
String certificateDomainName

 The domain name (e.g., example.com) for your SSL/TLS certificate.
 


certificateAlternativeNames
List<E> certificateAlternativeNames

 An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will
 de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain).
 We do not support wildcards (e.g., *.example.com).
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 








Class com.amazonaws.services.lightsail.model.CreateLoadBalancerTlsCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object containing information about the API operations.
 








Class com.amazonaws.services.lightsail.model.CreateRelationalDatabaseFromSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name to use for your new database.
 
 
 Constraints:
 
 
 
 
 Must contain from 2 to 255 alphanumeric characters, or hyphens.
 
 
 
 
 The first and last character must be a letter or number.
 
 
 


availabilityZone
String availabilityZone

 The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive
 format.
 
 
 You can get a list of Availability Zones by using the get regions operation. Be sure to add the
 include relational database Availability Zones parameter to your request.
 


publiclyAccessible
Boolean publiclyAccessible

 Specifies the accessibility options for your new database. A value of true specifies a database that
 is available to resources outside of your Lightsail account. A value of false specifies a database
 that is available only to your Lightsail resources in the same region as your database.
 


relationalDatabaseSnapshotName
String relationalDatabaseSnapshotName

 The name of the database snapshot from which to create your new database.
 


relationalDatabaseBundleId
String relationalDatabaseBundleId

 The bundle ID for your new database. A bundle describes the performance specifications for your database.
 
 
 You can get a list of database bundle IDs by using the get relational database bundles operation.
 
 
 When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the
 source database.
 


sourceRelationalDatabaseName
String sourceRelationalDatabaseName

 The name of the source database.
 


restoreTime
Date restoreTime

 The date and time to restore your database from.
 
 
 Constraints:
 
 
 
 
 Must be before the latest restorable time for the database.
 
 
 
 
 Cannot be specified if the use latest restorable time parameter is true.
 
 
 
 
 Specified in Coordinated Universal Time (UTC).
 
 
 
 
 Specified in the Unix time format.
 
 
 For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input
 1538424000 as the restore time.
 
 
 


useLatestRestorableTime
Boolean useLatestRestorableTime

 Specifies whether your database is restored from the latest backup time. A value of true restores
 from the latest backup time.
 
 
 Default: false
 
 
 Constraints: Cannot be specified if the restore time parameter is provided.
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 








Class com.amazonaws.services.lightsail.model.CreateRelationalDatabaseFromSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the result of your create relational database from snapshot request.
 








Class com.amazonaws.services.lightsail.model.CreateRelationalDatabaseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name to use for your new database.
 
 
 Constraints:
 
 
 
 
 Must contain from 2 to 255 alphanumeric characters, or hyphens.
 
 
 
 
 The first and last character must be a letter or number.
 
 
 


availabilityZone
String availabilityZone

 The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive
 format.
 
 
 You can get a list of Availability Zones by using the get regions operation. Be sure to add the
 include relational database Availability Zones parameter to your request.
 


relationalDatabaseBlueprintId
String relationalDatabaseBlueprintId

 The blueprint ID for your new database. A blueprint describes the major engine version of a database.
 
 
 You can get a list of database blueprints IDs by using the get relational database blueprints
 operation.
 


relationalDatabaseBundleId
String relationalDatabaseBundleId

 The bundle ID for your new database. A bundle describes the performance specifications for your database.
 
 
 You can get a list of database bundle IDs by using the get relational database bundles operation.
 


masterDatabaseName
String masterDatabaseName

 The name of the master database created when the Lightsail database resource is created.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 64 alphanumeric characters.
 
 
 
 
 Cannot be a word reserved by the specified database engine
 
 
 


masterUsername
String masterUsername

 The master user name for your new database.
 
 
 Constraints:
 
 
 
 
 Master user name is required.
 
 
 
 
 Must contain from 1 to 16 alphanumeric characters.
 
 
 
 
 The first character must be a letter.
 
 
 
 
 Cannot be a reserved word for the database engine you choose.
 
 
 For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for
 MySQL 5.6 or MySQL 5.7 respectively.
 
 
 


masterUserPassword
String masterUserPassword

 The password for the master user of your new database. The password can include any printable ASCII character
 except "/", """, or "@".
 
 
 Constraints: Must contain 8 to 41 characters.
 


preferredBackupWindow
String preferredBackupWindow

 The daily time range during which automated backups are created for your new database if automated backups are
 enabled.
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more
 information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.
 
 
 Constraints:
 
 
 
 
 Must be in the hh24:mi-hh24:mi format.
 
 
 Example: 16:00-16:30
 
 
 
 
 Specified in Coordinated Universal 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 on your new database.
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring
 on a random day of the week.
 
 
 Constraints:
 
 
 
 
 Must be in the ddd:hh24:mi-ddd:hh24:mi format.
 
 
 
 
 Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
 
 
 
 
 Must be at least 30 minutes.
 
 
 
 
 Specified in Coordinated Universal Time (UTC).
 
 
 
 
 Example: Tue:17:00-Tue:17:30
 
 
 


publiclyAccessible
Boolean publiclyAccessible

 Specifies the accessibility options for your new database. A value of true specifies a database that
 is available to resources outside of your Lightsail account. A value of false specifies a database
 that is available only to your Lightsail resources in the same region as your database.
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 








Class com.amazonaws.services.lightsail.model.CreateRelationalDatabaseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the result of your create relational database request.
 








Class com.amazonaws.services.lightsail.model.CreateRelationalDatabaseSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of the database on which to base your new snapshot.
 


relationalDatabaseSnapshotName
String relationalDatabaseSnapshotName

 The name for your new database snapshot.
 
 
 Constraints:
 
 
 
 
 Must contain from 2 to 255 alphanumeric characters, or hyphens.
 
 
 
 
 The first and last character must be a letter or number.
 
 
 


tags
List<E> tags

 The tag keys and optional values to add to the resource during create.
 
 
 To tag a resource after it has been created, see the tag resource operation.
 








Class com.amazonaws.services.lightsail.model.CreateRelationalDatabaseSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the result of your create relational database snapshot request.
 








Class com.amazonaws.services.lightsail.model.DeleteAutoSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceName
String resourceName

 The name of the source instance or disk from which to delete the automatic snapshot.
 


date
String date

 The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the
 get auto snapshots operation to get the available automatic snapshots for a resource.
 








Class com.amazonaws.services.lightsail.model.DeleteAutoSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of objects that describe the result of your request.
 








Class com.amazonaws.services.lightsail.model.DeleteDiskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


diskName
String diskName

 The unique name of the disk you want to delete (e.g., my-disk).
 


forceDeleteAddOns
Boolean forceDeleteAddOns

 A Boolean value to indicate whether to delete the enabled add-ons for the disk.
 








Class com.amazonaws.services.lightsail.model.DeleteDiskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of objects that describe the result of your request.
 








Class com.amazonaws.services.lightsail.model.DeleteDiskSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


diskSnapshotName
String diskSnapshotName

 The name of the disk snapshot you want to delete (e.g., my-disk-snapshot).
 








Class com.amazonaws.services.lightsail.model.DeleteDiskSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the API operations.
 








Class com.amazonaws.services.lightsail.model.DeleteDomainEntryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the domain entry to delete.
 


domainEntry
DomainEntry domainEntry

 An array of key-value pairs containing information about your domain entries.
 








Class com.amazonaws.services.lightsail.model.DeleteDomainEntryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operation
Operation operation

 An array of key-value pairs containing information about the results of your delete domain entry request.
 








Class com.amazonaws.services.lightsail.model.DeleteDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The specific domain name to delete.
 








Class com.amazonaws.services.lightsail.model.DeleteDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operation
Operation operation

 An array of key-value pairs containing information about the results of your delete domain request.
 








Class com.amazonaws.services.lightsail.model.DeleteInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the instance to delete.
 


forceDeleteAddOns
Boolean forceDeleteAddOns

 A Boolean value to indicate whether to delete the enabled add-ons for the disk.
 








Class com.amazonaws.services.lightsail.model.DeleteInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the results of your delete instance request.
 








Class com.amazonaws.services.lightsail.model.DeleteInstanceSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceSnapshotName
String instanceSnapshotName

 The name of the snapshot to delete.
 








Class com.amazonaws.services.lightsail.model.DeleteInstanceSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the results of your delete instance snapshot request.
 








Class com.amazonaws.services.lightsail.model.DeleteKeyPairRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyPairName
String keyPairName

 The name of the key pair to delete.
 








Class com.amazonaws.services.lightsail.model.DeleteKeyPairResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operation
Operation operation

 An array of key-value pairs containing information about the results of your delete key pair request.
 








Class com.amazonaws.services.lightsail.model.DeleteKnownHostKeysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the instance for which you want to reset the host key or certificate.
 








Class com.amazonaws.services.lightsail.model.DeleteKnownHostKeysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 A list of objects describing the API operation.
 








Class com.amazonaws.services.lightsail.model.DeleteLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer you want to delete.
 








Class com.amazonaws.services.lightsail.model.DeleteLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the API operations.
 








Class com.amazonaws.services.lightsail.model.DeleteLoadBalancerTlsCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The load balancer name.
 


certificateName
String certificateName

 The SSL/TLS certificate name.
 


force
Boolean force

 When true, forces the deletion of an SSL/TLS certificate.
 
 
 There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The
 force parameter is required when the primary SSL/TLS certificate is in use by an instance attached
 to the load balancer.
 








Class com.amazonaws.services.lightsail.model.DeleteLoadBalancerTlsCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the API operations.
 








Class com.amazonaws.services.lightsail.model.DeleteRelationalDatabaseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of the database that you are deleting.
 


skipFinalSnapshot
Boolean skipFinalSnapshot

 Determines whether a final database snapshot is created before your database is deleted. If true is
 specified, no database snapshot is created. If false is specified, a database snapshot is created
 before your database is deleted.
 
 
 You must specify the final relational database snapshot name parameter if the
 skip final snapshot parameter is false.
 
 
 Default: false
 


finalRelationalDatabaseSnapshotName
String finalRelationalDatabaseSnapshotName

 The name of the database snapshot created if skip final snapshot is false, which is the
 default value for that parameter.
 
 
 
 Specifying this parameter and also specifying the skip final snapshot parameter to true
 results in an error.
 
 
 
 Constraints:
 
 
 
 
 Must contain from 2 to 255 alphanumeric characters, or hyphens.
 
 
 
 
 The first and last character must be a letter or number.
 
 
 








Class com.amazonaws.services.lightsail.model.DeleteRelationalDatabaseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the result of your delete relational database request.
 








Class com.amazonaws.services.lightsail.model.DeleteRelationalDatabaseSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseSnapshotName
String relationalDatabaseSnapshotName

 The name of the database snapshot that you are deleting.
 








Class com.amazonaws.services.lightsail.model.DeleteRelationalDatabaseSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the result of your delete relational database snapshot request.
 








Class com.amazonaws.services.lightsail.model.DestinationInfo extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the resource created at the destination.
 


service
String service

 The destination service of the record.
 








Class com.amazonaws.services.lightsail.model.DetachDiskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


diskName
String diskName

 The unique name of the disk you want to detach from your instance (e.g., my-disk).
 








Class com.amazonaws.services.lightsail.model.DetachDiskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the API operations.
 








Class com.amazonaws.services.lightsail.model.DetachInstancesFromLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the Lightsail load balancer.
 


instanceNames
List<E> instanceNames

 An array of strings containing the names of the instances you want to detach from the load balancer.
 








Class com.amazonaws.services.lightsail.model.DetachInstancesFromLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the API operations.
 








Class com.amazonaws.services.lightsail.model.DetachStaticIpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


staticIpName
String staticIpName

 The name of the static IP to detach from the instance.
 








Class com.amazonaws.services.lightsail.model.DetachStaticIpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the results of your detach static IP request.
 








Class com.amazonaws.services.lightsail.model.DisableAddOnRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


addOnType
String addOnType

 The add-on type to disable.
 


resourceName
String resourceName

 The name of the source resource for which to disable the add-on.
 








Class com.amazonaws.services.lightsail.model.DisableAddOnResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of objects that describe the result of your request.
 








Class com.amazonaws.services.lightsail.model.Disk extends Object implements Serializable


Serialized Fields


name
String name

 The unique name of the disk.
 


arn
String arn

 The Amazon Resource Name (ARN) of the disk.
 


supportCode
String supportCode

 The support code. Include this code in your email to support when you have questions about an instance or another
 resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
 


createdAt
Date createdAt

 The date when the disk was created.
 


location
ResourceLocation location

 The AWS Region and Availability Zone where the disk is located.
 


resourceType
String resourceType

 The Lightsail resource type (e.g., Disk).
 


tags
List<E> tags

 The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
 


addOns
List<E> addOns

 An array of objects representing the add-ons enabled on the disk.
 


sizeInGb
Integer sizeInGb

 The size of the disk in GB.
 


isSystemDisk
Boolean isSystemDisk

 A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
 


iops
Integer iops

 The input/output operations per second (IOPS) of the disk.
 


path
String path

 The disk path.
 


state
String state

 Describes the status of the disk.
 


attachedTo
String attachedTo

 The resources to which the disk is attached.
 


isAttached
Boolean isAttached

 A Boolean value indicating whether the disk is attached.
 


attachmentState
String attachmentState
Deprecated. 

 (Deprecated) The attachment state of the disk.
 
 
 
 In releases prior to November 14, 2017, this parameter returned attached for system disks in the API
 response. It is now deprecated, but still included in the response. Use isAttached instead.
 
 


gbInUse
Integer gbInUse
Deprecated. 

 (Deprecated) The number of GB in use by the disk.
 
 
 
 In releases prior to November 14, 2017, this parameter was not included in the API response. It is now
 deprecated.
 
 








Class com.amazonaws.services.lightsail.model.DiskInfo extends Object implements Serializable


Serialized Fields


name
String name

 The disk name.
 


path
String path

 The disk path.
 


sizeInGb
Integer sizeInGb

 The size of the disk in GB (e.g., 32).
 


isSystemDisk
Boolean isSystemDisk

 A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
 








Class com.amazonaws.services.lightsail.model.DiskMap extends Object implements Serializable


Serialized Fields


originalDiskPath
String originalDiskPath

 The original disk path exposed to the instance (for example, /dev/sdh).
 


newDiskName
String newDiskName

 The new disk name (e.g., my-new-disk).
 








Class com.amazonaws.services.lightsail.model.DiskSnapshot extends Object implements Serializable


Serialized Fields


name
String name

 The name of the disk snapshot (e.g., my-disk-snapshot).
 


arn
String arn

 The Amazon Resource Name (ARN) of the disk snapshot.
 


supportCode
String supportCode

 The support code. Include this code in your email to support when you have questions about an instance or another
 resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
 


createdAt
Date createdAt

 The date when the disk snapshot was created.
 


location
ResourceLocation location

 The AWS Region and Availability Zone where the disk snapshot was created.
 


resourceType
String resourceType

 The Lightsail resource type (e.g., DiskSnapshot).
 


tags
List<E> tags

 The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
 


sizeInGb
Integer sizeInGb

 The size of the disk in GB.
 


state
String state

 The status of the disk snapshot operation.
 


progress
String progress

 The progress of the disk snapshot operation.
 


fromDiskName
String fromDiskName

 The unique name of the source disk from which the disk snapshot was created.
 


fromDiskArn
String fromDiskArn

 The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.
 


fromInstanceName
String fromInstanceName

 The unique name of the source instance from which the disk (system volume) snapshot was created.
 


fromInstanceArn
String fromInstanceArn

 The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.
 


isFromAutoSnapshot
Boolean isFromAutoSnapshot

 A Boolean value indicating whether the snapshot was created from an automatic snapshot.
 








Class com.amazonaws.services.lightsail.model.DiskSnapshotInfo extends Object implements Serializable


Serialized Fields


sizeInGb
Integer sizeInGb

 The size of the disk in GB (e.g., 32).
 








Class com.amazonaws.services.lightsail.model.Domain extends Object implements Serializable


Serialized Fields


name
String name

 The name of the domain.
 


arn
String arn

 The Amazon Resource Name (ARN) of the domain recordset (e.g.,
 arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).
 


supportCode
String supportCode

 The support code. Include this code in your email to support when you have questions about an instance or another
 resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
 


createdAt
Date createdAt

 The date when the domain recordset was created.
 


location
ResourceLocation location

 The AWS Region and Availability Zones where the domain recordset was created.
 


resourceType
String resourceType

 The resource type.
 


tags
List<E> tags

 The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
 


domainEntries
List<E> domainEntries

 An array of key-value pairs containing information about the domain entries.
 








Class com.amazonaws.services.lightsail.model.DomainEntry extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the domain recordset entry.
 


name
String name

 The name of the domain.
 


target
String target

 The target AWS name server (e.g., ns-111.awsdns-22.com.).
 
 
 For Lightsail load balancers, the value looks like
 ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Be sure to also set
 isAlias to true when setting up an A record for a load balancer.
 


isAlias
Boolean isAlias

 When true, specifies whether the domain entry is an alias used by the Lightsail load balancer. You
 can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic
 to your load balancer
 


type
String type

 The type of domain entry, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS),
 start of authority (SOA), service locator (SRV), or text (TXT).
 
 
 The following domain entry types can be used:
 
 
 
 
 A
 
 
 
 
 CNAME
 
 
 
 
 MX
 
 
 
 
 NS
 
 
 
 
 SOA
 
 
 
 
 SRV
 
 
 
 
 TXT
 
 
 


options
Map<K,V> options
Deprecated. 

 (Deprecated) The options for the domain entry.
 
 
 
 In releases prior to November 29, 2017, this parameter was not included in the API response. It is now
 deprecated.
 
 








Class com.amazonaws.services.lightsail.model.DownloadDefaultKeyPairRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.lightsail.model.DownloadDefaultKeyPairResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


publicKeyBase64
String publicKeyBase64

 A base64-encoded public key of the ssh-rsa type.
 


privateKeyBase64
String privateKeyBase64

 A base64-encoded RSA private key.
 








Class com.amazonaws.services.lightsail.model.EnableAddOnRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceName
String resourceName

 The name of the source resource for which to enable or modify the add-on.
 


addOnRequest
AddOnRequest addOnRequest

 An array of strings representing the add-on to enable or modify.
 








Class com.amazonaws.services.lightsail.model.EnableAddOnResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of objects that describe the result of your request.
 








Class com.amazonaws.services.lightsail.model.ExportSnapshotRecord extends Object implements Serializable


Serialized Fields


name
String name

 The export snapshot record name.
 


arn
String arn

 The Amazon Resource Name (ARN) of the export snapshot record.
 


createdAt
Date createdAt

 The date when the export snapshot record was created.
 


location
ResourceLocation location

 The AWS Region and Availability Zone where the export snapshot record is located.
 


resourceType
String resourceType

 The Lightsail resource type (e.g., ExportSnapshotRecord).
 


state
String state

 The state of the export snapshot record.
 


sourceInfo
ExportSnapshotRecordSourceInfo sourceInfo

 A list of objects describing the source of the export snapshot record.
 


destinationInfo
DestinationInfo destinationInfo

 A list of objects describing the destination of the export snapshot record.
 








Class com.amazonaws.services.lightsail.model.ExportSnapshotRecordSourceInfo extends Object implements Serializable


Serialized Fields


resourceType
String resourceType

 The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot).
 


createdAt
Date createdAt

 The date when the source instance or disk snapshot was created.
 


name
String name

 The name of the source instance or disk snapshot.
 


arn
String arn

 The Amazon Resource Name (ARN) of the source instance or disk snapshot.
 


fromResourceName
String fromResourceName

 The name of the snapshot's source instance or disk.
 


fromResourceArn
String fromResourceArn

 The Amazon Resource Name (ARN) of the snapshot's source instance or disk.
 


instanceSnapshotInfo
InstanceSnapshotInfo instanceSnapshotInfo

 A list of objects describing an instance snapshot.
 


diskSnapshotInfo
DiskSnapshotInfo diskSnapshotInfo

 A list of objects describing a disk snapshot.
 








Class com.amazonaws.services.lightsail.model.ExportSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceSnapshotName
String sourceSnapshotName

 The name of the instance or disk snapshot to be exported to Amazon EC2.
 








Class com.amazonaws.services.lightsail.model.ExportSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 A list of objects describing the API operation.
 








Class com.amazonaws.services.lightsail.model.GetActiveNamesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for paginating results from your get active names request.
 








Class com.amazonaws.services.lightsail.model.GetActiveNamesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


activeNames
List<E> activeNames

 The list of active names returned by the get active names request.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get active names request.
 








Class com.amazonaws.services.lightsail.model.GetAutoSnapshotsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceName
String resourceName

 The name of the source instance or disk from which to get automatic snapshot information.
 








Class com.amazonaws.services.lightsail.model.GetAutoSnapshotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceName
String resourceName

 The name of the source instance or disk for the automatic snapshots.
 


resourceType
String resourceType

 The resource type (e.g., Instance or Disk).
 


autoSnapshots
List<E> autoSnapshots

 An array of objects that describe the automatic snapshots that are available for the specified source instance or
 disk.
 








Class com.amazonaws.services.lightsail.model.GetBlueprintsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


includeInactive
Boolean includeInactive

 A Boolean value indicating whether to include inactive results in your request.
 


pageToken
String pageToken

 A token used for advancing to the next page of results from your get blueprints request.
 








Class com.amazonaws.services.lightsail.model.GetBlueprintsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


blueprints
List<E> blueprints

 An array of key-value pairs that contains information about the available blueprints.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get blueprints request.
 








Class com.amazonaws.services.lightsail.model.GetBundlesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


includeInactive
Boolean includeInactive

 A Boolean value that indicates whether to include inactive bundle results in your request.
 


pageToken
String pageToken

 A token used for advancing to the next page of results from your get bundles request.
 








Class com.amazonaws.services.lightsail.model.GetBundlesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bundles
List<E> bundles

 An array of key-value pairs that contains information about the available bundles.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get active names request.
 








Class com.amazonaws.services.lightsail.model.GetCloudFormationStackRecordsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to a specific page of results for your get cloud formation stack records
 request.
 








Class com.amazonaws.services.lightsail.model.GetCloudFormationStackRecordsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


cloudFormationStackRecords
List<E> cloudFormationStackRecords

 A list of objects describing the CloudFormation stack records.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results of your get relational database bundles request.
 








Class com.amazonaws.services.lightsail.model.GetDiskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


diskName
String diskName

 The name of the disk (e.g., my-disk).
 








Class com.amazonaws.services.lightsail.model.GetDiskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


disk
Disk disk

 An object containing information about the disk.
 








Class com.amazonaws.services.lightsail.model.GetDiskSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


diskSnapshotName
String diskSnapshotName

 The name of the disk snapshot (e.g., my-disk-snapshot).
 








Class com.amazonaws.services.lightsail.model.GetDiskSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


diskSnapshot
DiskSnapshot diskSnapshot

 An object containing information about the disk snapshot.
 








Class com.amazonaws.services.lightsail.model.GetDiskSnapshotsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to the next page of results from your GetDiskSnapshots request.
 








Class com.amazonaws.services.lightsail.model.GetDiskSnapshotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


diskSnapshots
List<E> diskSnapshots

 An array of objects containing information about all block storage disk snapshots.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your GetDiskSnapshots request.
 








Class com.amazonaws.services.lightsail.model.GetDisksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to the next page of results from your GetDisks request.
 








Class com.amazonaws.services.lightsail.model.GetDisksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


disks
List<E> disks

 An array of objects containing information about all block storage disks.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your GetDisks request.
 








Class com.amazonaws.services.lightsail.model.GetDomainRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The domain name for which your want to return information about.
 








Class com.amazonaws.services.lightsail.model.GetDomainResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domain
Domain domain

 An array of key-value pairs containing information about your get domain request.
 








Class com.amazonaws.services.lightsail.model.GetDomainsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to the next page of results from your get domains request.
 








Class com.amazonaws.services.lightsail.model.GetDomainsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


domains
List<E> domains

 An array of key-value pairs containing information about each of the domain entries in the user's account.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get active names request.
 








Class com.amazonaws.services.lightsail.model.GetExportSnapshotRecordsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to a specific page of results for your get export snapshot records
 request.
 








Class com.amazonaws.services.lightsail.model.GetExportSnapshotRecordsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


exportSnapshotRecords
List<E> exportSnapshotRecords

 A list of objects describing the export snapshot records.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results of your get relational database bundles request.
 








Class com.amazonaws.services.lightsail.model.GetInstanceAccessDetailsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the instance to access.
 


protocol
String protocol

 The protocol to use to connect to your instance. Defaults to ssh.
 








Class com.amazonaws.services.lightsail.model.GetInstanceAccessDetailsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accessDetails
InstanceAccessDetails accessDetails

 An array of key-value pairs containing information about a get instance access request.
 








Class com.amazonaws.services.lightsail.model.GetInstanceMetricDataRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the instance for which you want to get metrics data.
 


metricName
String metricName

 The metric name to get data about.
 


period
Integer period

 The granularity, in seconds, of the returned data points.
 


startTime
Date startTime

 The start time of the time period.
 


endTime
Date endTime

 The end time of the time period.
 


unit
String unit

 The unit. The list of valid values is below.
 


statistics
List<E> statistics

 The instance statistics.
 








Class com.amazonaws.services.lightsail.model.GetInstanceMetricDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


metricName
String metricName

 The metric name to return data for.
 


metricData
List<E> metricData

 An array of key-value pairs containing information about the results of your get instance metric data request.
 








Class com.amazonaws.services.lightsail.model.GetInstancePortStatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the instance.
 








Class com.amazonaws.services.lightsail.model.GetInstancePortStatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


portStates
List<E> portStates

 Information about the port states resulting from your request.
 








Class com.amazonaws.services.lightsail.model.GetInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the instance.
 








Class com.amazonaws.services.lightsail.model.GetInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instance
Instance instance

 An array of key-value pairs containing information about the specified instance.
 








Class com.amazonaws.services.lightsail.model.GetInstanceSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceSnapshotName
String instanceSnapshotName

 The name of the snapshot for which you are requesting information.
 








Class com.amazonaws.services.lightsail.model.GetInstanceSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceSnapshot
InstanceSnapshot instanceSnapshot

 An array of key-value pairs containing information about the results of your get instance snapshot request.
 








Class com.amazonaws.services.lightsail.model.GetInstanceSnapshotsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to the next page of results from your get instance snapshots request.
 








Class com.amazonaws.services.lightsail.model.GetInstanceSnapshotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceSnapshots
List<E> instanceSnapshots

 An array of key-value pairs containing information about the results of your get instance snapshots request.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get instance snapshots request.
 








Class com.amazonaws.services.lightsail.model.GetInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to the next page of results from your get instances request.
 








Class com.amazonaws.services.lightsail.model.GetInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instances
List<E> instances

 An array of key-value pairs containing information about your instances.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get instances request.
 








Class com.amazonaws.services.lightsail.model.GetInstanceStateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the instance to get state information about.
 








Class com.amazonaws.services.lightsail.model.GetInstanceStateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


state
InstanceState state

 The state of the instance.
 








Class com.amazonaws.services.lightsail.model.GetKeyPairRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyPairName
String keyPairName

 The name of the key pair for which you are requesting information.
 








Class com.amazonaws.services.lightsail.model.GetKeyPairResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyPair
KeyPair keyPair

 An array of key-value pairs containing information about the key pair.
 








Class com.amazonaws.services.lightsail.model.GetKeyPairsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to the next page of results from your get key pairs request.
 








Class com.amazonaws.services.lightsail.model.GetKeyPairsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


keyPairs
List<E> keyPairs

 An array of key-value pairs containing information about the key pairs.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get key pairs request.
 








Class com.amazonaws.services.lightsail.model.GetLoadBalancerMetricDataRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


metricName
String metricName

 The metric about which you want to return information. Valid values are listed below, along with the most useful
 statistics to include in your request.
 
 
 
 
  ClientTLSNegotiationErrorCount  - The number of TLS connections initiated by the client that
 did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.
 
 
 Statistics: The most useful statistic is Sum.
 
 
 
 
  HealthyHostCount  - The number of target instances that are considered healthy.
 
 
 Statistics: The most useful statistic are Average, Minimum, and
 Maximum.
 
 
 
 
  UnhealthyHostCount  - The number of target instances that are considered unhealthy.
 
 
 Statistics: The most useful statistic are Average, Minimum, and
 Maximum.
 
 
 
 
  HTTPCode_LB_4XX_Count  - The number of HTTP 4XX client error codes that originate from the
 load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not
 been received by the target instance. This count does not include any response codes generated by the target
 instances.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 
 
  HTTPCode_LB_5XX_Count  - The number of HTTP 5XX server error codes that originate from the
 load balancer. This count does not include any response codes generated by the target instances.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 
 
  HTTPCode_Instance_2XX_Count  - The number of HTTP response codes generated by the target
 instances. This does not include any response codes generated by the load balancer.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 
 
  HTTPCode_Instance_3XX_Count  - The number of HTTP response codes generated by the target
 instances. This does not include any response codes generated by the load balancer.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 
 
  HTTPCode_Instance_4XX_Count  - The number of HTTP response codes generated by the target
 instances. This does not include any response codes generated by the load balancer.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 
 
  HTTPCode_Instance_5XX_Count  - The number of HTTP response codes generated by the target
 instances. This does not include any response codes generated by the load balancer.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 
 
  InstanceResponseTime  - The time elapsed, in seconds, after the request leaves the load
 balancer until a response from the target instance is received.
 
 
 Statistics: The most useful statistic is Average.
 
 
 
 
  RejectedConnectionCount  - The number of connections that were rejected because the load
 balancer had reached its maximum number of connections.
 
 
 Statistics: The most useful statistic is Sum.
 
 
 
 
  RequestCount  - The number of requests processed over IPv4. This count includes only the
 requests with a response generated by a target instance of the load balancer.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 


period
Integer period

 The granularity, in seconds, of the returned data points.
 


startTime
Date startTime

 The start time of the period.
 


endTime
Date endTime

 The end time of the period.
 


unit
String unit

 The unit for the time period request. Valid values are listed below.
 


statistics
List<E> statistics

 An array of statistics that you want to request metrics for. Valid values are listed below.
 
 
 
 
  SampleCount  - The count (number) of data points used for the statistical calculation.
 
 
 
 
  Average  - The value of Sum / SampleCount during the specified period. By comparing this
 statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average
 use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources
 as needed.
 
 
 
 
  Sum  - All values submitted for the matching metric added together. This statistic can be
 useful for determining the total volume of a metric.
 
 
 
 
  Minimum  - The lowest value observed during the specified period. You can use this value to
 determine low volumes of activity for your application.
 
 
 
 
  Maximum  - The highest value observed during the specified period. You can use this value to
 determine high volumes of activity for your application.
 
 
 








Class com.amazonaws.services.lightsail.model.GetLoadBalancerMetricDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


metricName
String metricName

 The metric about which you are receiving information. Valid values are listed below, along with the most useful
 statistics to include in your request.
 
 
 
 
  ClientTLSNegotiationErrorCount  - The number of TLS connections initiated by the client that
 did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.
 
 
 Statistics: The most useful statistic is Sum.
 
 
 
 
  HealthyHostCount  - The number of target instances that are considered healthy.
 
 
 Statistics: The most useful statistic are Average, Minimum, and
 Maximum.
 
 
 
 
  UnhealthyHostCount  - The number of target instances that are considered unhealthy.
 
 
 Statistics: The most useful statistic are Average, Minimum, and
 Maximum.
 
 
 
 
  HTTPCode_LB_4XX_Count  - The number of HTTP 4XX client error codes that originate from the
 load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not
 been received by the target instance. This count does not include any response codes generated by the target
 instances.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 
 
  HTTPCode_LB_5XX_Count  - The number of HTTP 5XX server error codes that originate from the
 load balancer. This count does not include any response codes generated by the target instances.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 
 
  HTTPCode_Instance_2XX_Count  - The number of HTTP response codes generated by the target
 instances. This does not include any response codes generated by the load balancer.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 
 
  HTTPCode_Instance_3XX_Count  - The number of HTTP response codes generated by the target
 instances. This does not include any response codes generated by the load balancer.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 
 
  HTTPCode_Instance_4XX_Count  - The number of HTTP response codes generated by the target
 instances. This does not include any response codes generated by the load balancer.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 
 
  HTTPCode_Instance_5XX_Count  - The number of HTTP response codes generated by the target
 instances. This does not include any response codes generated by the load balancer.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 
 
  InstanceResponseTime  - The time elapsed, in seconds, after the request leaves the load
 balancer until a response from the target instance is received.
 
 
 Statistics: The most useful statistic is Average.
 
 
 
 
  RejectedConnectionCount  - The number of connections that were rejected because the load
 balancer had reached its maximum number of connections.
 
 
 Statistics: The most useful statistic is Sum.
 
 
 
 
  RequestCount  - The number of requests processed over IPv4. This count includes only the
 requests with a response generated by a target instance of the load balancer.
 
 
 Statistics: The most useful statistic is Sum. Note that Minimum,
 Maximum, and Average all return 1.
 
 
 


metricData
List<E> metricData

 An array of metric datapoint objects.
 








Class com.amazonaws.services.lightsail.model.GetLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 








Class com.amazonaws.services.lightsail.model.GetLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loadBalancer
LoadBalancer loadBalancer

 An object containing information about your load balancer.
 








Class com.amazonaws.services.lightsail.model.GetLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for paginating the results from your GetLoadBalancers request.
 








Class com.amazonaws.services.lightsail.model.GetLoadBalancersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loadBalancers
List<E> loadBalancers

 An array of LoadBalancer objects describing your load balancers.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your GetLoadBalancers request.
 








Class com.amazonaws.services.lightsail.model.GetLoadBalancerTlsCertificatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer you associated with your SSL/TLS certificate.
 








Class com.amazonaws.services.lightsail.model.GetLoadBalancerTlsCertificatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tlsCertificates
List<E> tlsCertificates

 An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.
 








Class com.amazonaws.services.lightsail.model.GetOperationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


operationId
String operationId

 A GUID used to identify the operation.
 








Class com.amazonaws.services.lightsail.model.GetOperationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operation
Operation operation

 An array of key-value pairs containing information about the results of your get operation request.
 








Class com.amazonaws.services.lightsail.model.GetOperationsForResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceName
String resourceName

 The name of the resource for which you are requesting information.
 


pageToken
String pageToken

 A token used for advancing to the next page of results from your get operations for resource request.
 








Class com.amazonaws.services.lightsail.model.GetOperationsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the results of your get operations for resource request.
 


nextPageCount
String nextPageCount
Deprecated. 

 (Deprecated) Returns the number of pages of results that remain.
 
 
 
 In releases prior to June 12, 2017, this parameter returned null by the API. It is now deprecated,
 and the API returns the next page token parameter instead.
 
 


nextPageToken
String nextPageToken

 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.lightsail.model.GetOperationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to the next page of results from your get operations request.
 








Class com.amazonaws.services.lightsail.model.GetOperationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the results of your get operations request.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get operations request.
 








Class com.amazonaws.services.lightsail.model.GetRegionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


includeAvailabilityZones
Boolean includeAvailabilityZones

 A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability
 Zones are indicated with a letter: e.g., us-east-2a.
 


includeRelationalDatabaseAvailabilityZones
Boolean includeRelationalDatabaseAvailabilityZones

 >A Boolean value indicating whether to also include Availability Zones for databases in your get regions
 request. Availability Zones are indicated with a letter (e.g., us-east-2a).
 








Class com.amazonaws.services.lightsail.model.GetRegionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


regions
List<E> regions

 An array of key-value pairs containing information about your get regions request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseBlueprintsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to a specific page of results for your get relational database blueprints
 request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseBlueprintsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


blueprints
List<E> blueprints

 An object describing the result of your get relational database blueprints request.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results of your get relational database blueprints request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseBundlesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to a specific page of results for your get relational database bundles
 request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseBundlesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bundles
List<E> bundles

 An object describing the result of your get relational database bundles request.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results of your get relational database bundles request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of the database from which to get events.
 


durationInMinutes
Integer durationInMinutes

 The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2
 hours, enter 120.
 
 
 Default: 60
 
 
 The minimum is 1 and the maximum is 14 days (20160 minutes).
 


pageToken
String pageToken

 A token used for advancing to a specific page of results from for get relational database events request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


relationalDatabaseEvents
List<E> relationalDatabaseEvents

 An object describing the result of your get relational database events request.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get relational database events request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseLogEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of your database for which to get log events.
 


logStreamName
String logStreamName

 The name of the log stream.
 
 
 Use the get relational database log streams operation to get a list of available log streams.
 


startTime
Date startTime

 The start of the time interval from which to get log events.
 
 
 Constraints:
 
 
 
 
 Specified in Coordinated Universal Time (UTC).
 
 
 
 
 Specified in the Unix time format.
 
 
 For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input
 1538424000 as the start time.
 
 
 


endTime
Date endTime

 The end of the time interval from which to get log events.
 
 
 Constraints:
 
 
 
 
 Specified in Coordinated Universal Time (UTC).
 
 
 
 
 Specified in the Unix time format.
 
 
 For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input
 1538424000 as the end time.
 
 
 


startFromHead
Boolean startFromHead

 Parameter to specify if the log should start from head or tail. If true is specified, the log event
 starts from the head of the log. If false is specified, the log event starts from the tail of the
 log.
 
 
 
 For PostgreSQL, the default value of false is the only option available.
 
 


pageToken
String pageToken

 A token used for advancing to a specific page of results for your get relational database log events
 request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseLogEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceLogEvents
List<E> resourceLogEvents

 An object describing the result of your get relational database log events request.
 


nextBackwardToken
String nextBackwardToken

 A token used for advancing to the previous page of results from your get relational database log events request.
 


nextForwardToken
String nextForwardToken

 A token used for advancing to the next page of results from your get relational database log events request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseLogStreamsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of your database for which to get log streams.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseLogStreamsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


logStreams
List<E> logStreams

 An object describing the result of your get relational database log streams request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseMasterUserPasswordRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of your database for which to get the master user password.
 


passwordVersion
String passwordVersion

 The password version to return.
 
 
 Specifying CURRENT or PREVIOUS returns the current or previous passwords respectively.
 Specifying PENDING returns the newest version of the password that will rotate to
 CURRENT. After the PENDING password rotates to CURRENT, the
 PENDING password is no longer available.
 
 
 Default: CURRENT
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseMasterUserPasswordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


masterUserPassword
String masterUserPassword

 The master user password for the password version specified.
 


createdAt
Date createdAt

 The timestamp when the specified version of the master user password was created.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseMetricDataRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of your database from which to get metric data.
 


metricName
String metricName

 The name of the metric data to return.
 


period
Integer period

 The granularity, in seconds, of the returned data points.
 


startTime
Date startTime

 The start of the time interval from which to get metric data.
 
 
 Constraints:
 
 
 
 
 Specified in Coordinated Universal Time (UTC).
 
 
 
 
 Specified in the Unix time format.
 
 
 For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input
 1538424000 as the start time.
 
 
 


endTime
Date endTime

 The end of the time interval from which to get metric data.
 
 
 Constraints:
 
 
 
 
 Specified in Coordinated Universal Time (UTC).
 
 
 
 
 Specified in the Unix time format.
 
 
 For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input
 1538424000 as the end time.
 
 
 


unit
String unit

 The unit for the metric data request.
 


statistics
List<E> statistics

 The array of statistics for your metric data request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseMetricDataResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


metricName
String metricName

 The name of the metric.
 


metricData
List<E> metricData

 An object describing the result of your get relational database metric data request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseParametersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of your database for which to get parameters.
 


pageToken
String pageToken

 A token used for advancing to a specific page of results for your get relational database parameters
 request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseParametersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


parameters
List<E> parameters

 An object describing the result of your get relational database parameters request.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get static IPs request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of the database that you are looking up.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


relationalDatabase
RelationalDatabase relationalDatabase

 An object describing the specified database.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseSnapshotName
String relationalDatabaseSnapshotName

 The name of the database snapshot for which to get information.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


relationalDatabaseSnapshot
RelationalDatabaseSnapshot relationalDatabaseSnapshot

 An object describing the specified database snapshot.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseSnapshotsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to a specific page of results for your get relational database snapshots
 request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabaseSnapshotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


relationalDatabaseSnapshots
List<E> relationalDatabaseSnapshots

 An object describing the result of your get relational database snapshots request.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get relational database snapshots request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabasesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to a specific page of results for your get relational database request.
 








Class com.amazonaws.services.lightsail.model.GetRelationalDatabasesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


relationalDatabases
List<E> relationalDatabases

 An object describing the result of your get relational databases request.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get relational databases request.
 








Class com.amazonaws.services.lightsail.model.GetStaticIpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


staticIpName
String staticIpName

 The name of the static IP in Lightsail.
 








Class com.amazonaws.services.lightsail.model.GetStaticIpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


staticIp
StaticIp staticIp

 An array of key-value pairs containing information about the requested static IP.
 








Class com.amazonaws.services.lightsail.model.GetStaticIpsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


pageToken
String pageToken

 A token used for advancing to the next page of results from your get static IPs request.
 








Class com.amazonaws.services.lightsail.model.GetStaticIpsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


staticIps
List<E> staticIps

 An array of key-value pairs containing information about your get static IPs request.
 


nextPageToken
String nextPageToken

 A token used for advancing to the next page of results from your get static IPs request.
 








Class com.amazonaws.services.lightsail.model.HostKeyAttributes extends Object implements Serializable


Serialized Fields


algorithm
String algorithm

 The SSH host key algorithm or the RDP certificate format.
 
 
 For SSH host keys, the algorithm may be ssh-rsa, ecdsa-sha2-nistp256,
 ssh-ed25519, etc. For RDP certificates, the algorithm is always x509-cert.
 


publicKey
String publicKey

 The public SSH host key or the RDP certificate.
 


witnessedAt
Date witnessedAt

 The time that the SSH host key or RDP certificate was recorded by Lightsail.
 


fingerprintSHA1
String fingerprintSHA1

 The SHA-1 fingerprint of the returned SSH host key or RDP certificate.
 
 
 
 
 Example of an SHA-1 SSH fingerprint:
 
 
 SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0
 
 
 
 
 Example of an SHA-1 RDP fingerprint:
 
 
 af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45
 
 
 


fingerprintSHA256
String fingerprintSHA256

 The SHA-256 fingerprint of the returned SSH host key or RDP certificate.
 
 
 
 
 Example of an SHA-256 SSH fingerprint:
 
 
 SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o
 
 
 
 
 Example of an SHA-256 RDP fingerprint:
 
 
 03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68
 
 
 


notValidBefore
Date notValidBefore

 The returned RDP certificate is valid after this point in time.
 
 
 This value is listed only for RDP certificates.
 


notValidAfter
Date notValidAfter

 The returned RDP certificate is not valid after this point in time.
 
 
 This value is listed only for RDP certificates.
 








Class com.amazonaws.services.lightsail.model.ImportKeyPairRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


keyPairName
String keyPairName

 The name of the key pair for which you want to import the public key.
 


publicKeyBase64
String publicKeyBase64

 A base64-encoded public key of the ssh-rsa type.
 








Class com.amazonaws.services.lightsail.model.ImportKeyPairResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operation
Operation operation

 An array of key-value pairs containing information about the request operation.
 








Class com.amazonaws.services.lightsail.model.Instance extends Object implements Serializable


Serialized Fields


name
String name

 The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).
 


arn
String arn

 The Amazon Resource Name (ARN) of the instance (e.g.,
 arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
 


supportCode
String supportCode

 The support code. Include this code in your email to support when you have questions about an instance or another
 resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
 


createdAt
Date createdAt

 The timestamp when the instance was created (e.g., 1479734909.17).
 


location
ResourceLocation location

 The region name and Availability Zone where the instance is located.
 


resourceType
String resourceType

 The type of resource (usually Instance).
 


tags
List<E> tags

 The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
 


blueprintId
String blueprintId

 The blueprint ID (e.g., os_amlinux_2016_03).
 


blueprintName
String blueprintName

 The friendly name of the blueprint (e.g., Amazon Linux).
 


bundleId
String bundleId

 The bundle for the instance (e.g., micro_1_0).
 


addOns
List<E> addOns

 An array of objects representing the add-ons enabled on the instance.
 


isStaticIp
Boolean isStaticIp

 A Boolean value indicating whether this instance has a static IP assigned to it.
 


privateIpAddress
String privateIpAddress

 The private IP address of the instance.
 


publicIpAddress
String publicIpAddress

 The public IP address of the instance.
 


ipv6Address
String ipv6Address

 The IPv6 address of the instance.
 


hardware
InstanceHardware hardware

 The size of the vCPU and the amount of RAM for the instance.
 


networking
InstanceNetworking networking

 Information about the public ports and monthly data transfer rates for the instance.
 


state
InstanceState state

 The status code and the state (e.g., running) for the instance.
 


username
String username

 The user name for connecting to the instance (e.g., ec2-user).
 


sshKeyName
String sshKeyName

 The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).
 








Class com.amazonaws.services.lightsail.model.InstanceAccessDetails extends Object implements Serializable


Serialized Fields


certKey
String certKey

 For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH),
 you should save this value to tempkey-cert.pub.
 


expiresAt
Date expiresAt

 For SSH access, the date on which the temporary keys expire.
 


ipAddress
String ipAddress

 The public IP address of the Amazon Lightsail instance.
 


password
String password

 For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password
 for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the
 instance to be ready.
 
 
 
 If you create an instance using any key pair other than the default (LightsailDefaultKeyPair),
 password will always be an empty string.
 
 
 If you change the Administrator password on the instance, Lightsail will continue to return the original password
 value. When accessing the instance using RDP, you need to manually enter the Administrator password after
 changing it from the default.
 
 


passwordData
PasswordData passwordData

 For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only
 needed if password is empty and the instance is not new (and therefore the password is not ready
 yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.
 


privateKey
String privateKey

 For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this
 value to tempkey).
 


protocol
String protocol

 The protocol for these Amazon Lightsail instance access details.
 


instanceName
String instanceName

 The name of this Amazon Lightsail instance.
 


username
String username

 The user name to use when logging in to the Amazon Lightsail instance.
 


hostKeys
List<E> hostKeys

 Describes the public SSH host keys or the RDP certificate.
 








Class com.amazonaws.services.lightsail.model.InstanceEntry extends Object implements Serializable


Serialized Fields


sourceName
String sourceName

 The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used
 as the source of the new Amazon EC2 instance.
 
 
 Use the get export snapshot records operation to get a list of export snapshot records that you can
 use to create a CloudFormation stack.
 


instanceType
String instanceType

 The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.
 


portInfoSource
String portInfoSource

 The port configuration to use for the new Amazon EC2 instance.
 
 
 The following configuration options are available:
 
 
 
 
 DEFAULT — Use the default firewall settings from the image.
 
 
 
 
 INSTANCE — Use the firewall settings from the source Lightsail instance.
 
 
 
 
 NONE — Default to Amazon EC2.
 
 
 
 
 CLOSED — All ports closed.
 
 
 


userData
String userData

 A launch script you can create that configures a server with additional user data. For example, you might want to
 run apt-get -y update.
 
 
 
 Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and
 CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg.
 
 


availabilityZone
String availabilityZone

 The Availability Zone for the new Amazon EC2 instance.
 








Class com.amazonaws.services.lightsail.model.InstanceHardware extends Object implements Serializable


Serialized Fields


cpuCount
Integer cpuCount

 The number of vCPUs the instance has.
 


disks
List<E> disks

 The disks attached to the instance.
 


ramSizeInGb
Float ramSizeInGb

 The amount of RAM in GB on the instance (e.g., 1.0).
 








Class com.amazonaws.services.lightsail.model.InstanceHealthSummary extends Object implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the Lightsail instance for which you are requesting health check data.
 


instanceHealth
String instanceHealth

 Describes the overall instance health. Valid values are below.
 


instanceHealthReason
String instanceHealthReason

 More information about the instance health. If the instanceHealth is healthy, then an
 instanceHealthReason value is not provided.
 
 
 If  instanceHealth  is initial, the  instanceHealthReason 
 value can be one of the following:
 
 
 
 
  Lb.RegistrationInProgress  - The target instance is in the process of being registered with
 the load balancer.
 
 
 
 
  Lb.InitialHealthChecking  - The Lightsail load balancer is still sending the target instance
 the minimum number of health checks required to determine its health status.
 
 
 
 
 If  instanceHealth  is unhealthy, the  instanceHealthReason 
 value can be one of the following:
 
 
 
 
  Instance.ResponseCodeMismatch  - The health checks did not return an expected HTTP code.
 
 
 
 
  Instance.Timeout  - The health check requests timed out.
 
 
 
 
  Instance.FailedHealthChecks  - The health checks failed because the connection to the target
 instance timed out, the target instance response was malformed, or the target instance failed the health check
 for an unknown reason.
 
 
 
 
  Lb.InternalError  - The health checks failed due to an internal error.
 
 
 
 
 If  instanceHealth  is unused, the  instanceHealthReason 
 value can be one of the following:
 
 
 
 
  Instance.NotRegistered  - The target instance is not registered with the target group.
 
 
 
 
  Instance.NotInUse  - The target group is not used by any load balancer, or the target
 instance is in an Availability Zone that is not enabled for its load balancer.
 
 
 
 
  Instance.IpUnusable  - The target IP address is reserved for use by a Lightsail load
 balancer.
 
 
 
 
  Instance.InvalidState  - The target is in the stopped or terminated state.
 
 
 
 
 If  instanceHealth  is draining, the  instanceHealthReason 
 value can be one of the following:
 
 
 
 
  Instance.DeregistrationInProgress  - The target instance is in the process of being
 deregistered and the deregistration delay period has not expired.
 
 
 








Class com.amazonaws.services.lightsail.model.InstanceNetworking extends Object implements Serializable


Serialized Fields


monthlyTransfer
MonthlyTransfer monthlyTransfer

 The amount of data in GB allocated for monthly data transfers.
 


ports
List<E> ports

 An array of key-value pairs containing information about the ports on the instance.
 








Class com.amazonaws.services.lightsail.model.InstancePortInfo extends Object implements Serializable


Serialized Fields


fromPort
Integer fromPort

 The first port in the range.
 


toPort
Integer toPort

 The last port in the range.
 


protocol
String protocol

 The protocol being used. Can be one of the following.
 
 
 
 
 tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of
 streamed data between applications running on hosts communicating by an IP network. If you have an application
 that doesn't require reliable data stream service, use UDP instead.
 
 
 
 
 all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
 
 
 
 
 udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to
 other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission
 channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides
 a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable
 data stream service, use TCP instead.
 
 
 


accessFrom
String accessFrom

 The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)).
 


accessType
String accessType

 The type of access (Public or Private).
 


commonName
String commonName

 The common name.
 


accessDirection
String accessDirection

 The access direction (inbound or outbound).
 








Class com.amazonaws.services.lightsail.model.InstancePortState extends Object implements Serializable


Serialized Fields


fromPort
Integer fromPort

 The first port in the range.
 


toPort
Integer toPort

 The last port in the range.
 


protocol
String protocol

 The protocol being used. Can be one of the following.
 
 
 
 
 tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of
 streamed data between applications running on hosts communicating by an IP network. If you have an application
 that doesn't require reliable data stream service, use UDP instead.
 
 
 
 
 all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
 
 
 
 
 udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to
 other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission
 channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides
 a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable
 data stream service, use TCP instead.
 
 
 


state
String state

 Specifies whether the instance port is open or closed.
 








Class com.amazonaws.services.lightsail.model.InstanceSnapshot extends Object implements Serializable


Serialized Fields


name
String name

 The name of the snapshot.
 


arn
String arn

 The Amazon Resource Name (ARN) of the snapshot (e.g.,
 arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
 


supportCode
String supportCode

 The support code. Include this code in your email to support when you have questions about an instance or another
 resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
 


createdAt
Date createdAt

 The timestamp when the snapshot was created (e.g., 1479907467.024).
 


location
ResourceLocation location

 The region name and Availability Zone where you created the snapshot.
 


resourceType
String resourceType

 The type of resource (usually InstanceSnapshot).
 


tags
List<E> tags

 The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
 


state
String state

 The state the snapshot is in.
 


progress
String progress

 The progress of the snapshot.
 


fromAttachedDisks
List<E> fromAttachedDisks

 An array of disk objects containing information about all block storage disks.
 


fromInstanceName
String fromInstanceName

 The instance from which the snapshot was created.
 


fromInstanceArn
String fromInstanceArn

 The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g.,
 arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
 


fromBlueprintId
String fromBlueprintId

 The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual
 private server (or instance) image used to create instances quickly.
 


fromBundleId
String fromBundleId

 The bundle ID from which you created the snapshot (e.g., micro_1_0).
 


isFromAutoSnapshot
Boolean isFromAutoSnapshot

 A Boolean value indicating whether the snapshot was created from an automatic snapshot.
 


sizeInGb
Integer sizeInGb

 The size in GB of the SSD.
 








Class com.amazonaws.services.lightsail.model.InstanceSnapshotInfo extends Object implements Serializable


Serialized Fields


fromBundleId
String fromBundleId

 The bundle ID from which the source instance was created (e.g., micro_1_0).
 


fromBlueprintId
String fromBlueprintId

 The blueprint ID from which the source instance (e.g., os_debian_8_3).
 


fromDiskInfo
List<E> fromDiskInfo

 A list of objects describing the disks that were attached to the source instance.
 








Class com.amazonaws.services.lightsail.model.InstanceState extends Object implements Serializable


Serialized Fields


code
Integer code

 The status code for the instance.
 


name
String name

 The state of the instance (e.g., running or pending).
 








Class com.amazonaws.services.lightsail.model.InvalidInputException extends AmazonLightsailException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code


docs
String docs


tip
String tip








Class com.amazonaws.services.lightsail.model.IsVpcPeeredRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.lightsail.model.IsVpcPeeredResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


isPeered
Boolean isPeered

 Returns true if the Lightsail VPC is peered; otherwise, false.
 








Class com.amazonaws.services.lightsail.model.KeyPair extends Object implements Serializable


Serialized Fields


name
String name

 The friendly name of the SSH key pair.
 


arn
String arn

 The Amazon Resource Name (ARN) of the key pair (e.g.,
 arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
 


supportCode
String supportCode

 The support code. Include this code in your email to support when you have questions about an instance or another
 resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
 


createdAt
Date createdAt

 The timestamp when the key pair was created (e.g., 1479816991.349).
 


location
ResourceLocation location

 The region name and Availability Zone where the key pair was created.
 


resourceType
String resourceType

 The resource type (usually KeyPair).
 


tags
List<E> tags

 The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
 


fingerprint
String fingerprint

 The RSA fingerprint of the key pair.
 








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


Serialized Fields


name
String name

 The name of the load balancer (e.g., my-load-balancer).
 


arn
String arn

 The Amazon Resource Name (ARN) of the load balancer.
 


supportCode
String supportCode

 The support code. Include this code in your email to support when you have questions about your Lightsail load
 balancer. This code enables our support team to look up your Lightsail information more easily.
 


createdAt
Date createdAt

 The date when your load balancer was created.
 


location
ResourceLocation location

 The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically
 creates your load balancer across Availability Zones.
 


resourceType
String resourceType

 The resource type (e.g., LoadBalancer.
 


tags
List<E> tags

 The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
 


dnsName
String dnsName

 The DNS name of your Lightsail load balancer.
 


state
String state

 The status of your load balancer. Valid values are below.
 


protocol
String protocol

 The protocol you have enabled for your load balancer. Valid values are below.
 
 
 You can't just have HTTP_HTTPS, but you can have just HTTP.
 


publicPorts
List<E> publicPorts

 An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.
 


healthCheckPath
String healthCheckPath

 The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a
 request to the default (root) page.
 


instancePort
Integer instancePort

 The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80.
 For HTTPS traffic, it's port 443.
 


instanceHealthSummary
List<E> instanceHealthSummary

 An array of InstanceHealthSummary objects describing the health of the load balancer.
 


tlsCertificateSummaries
List<E> tlsCertificateSummaries

 An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS
 certificates. For example, if true, the certificate is attached to the load balancer.
 


configurationOptions
Map<K,V> configurationOptions

 A string to string map of the configuration options for your load balancer. Valid values are listed below.
 








Class com.amazonaws.services.lightsail.model.LoadBalancerTlsCertificate extends Object implements Serializable


Serialized Fields


name
String name

 The name of the SSL/TLS certificate (e.g., my-certificate).
 


arn
String arn

 The Amazon Resource Name (ARN) of the SSL/TLS certificate.
 


supportCode
String supportCode

 The support code. Include this code in your email to support when you have questions about your Lightsail load
 balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more
 easily.
 


createdAt
Date createdAt

 The time when you created your SSL/TLS certificate.
 


location
ResourceLocation location

 The AWS Region and Availability Zone where you created your certificate.
 


resourceType
String resourceType

 The resource type (e.g., LoadBalancerTlsCertificate).
 
 
 
 
  Instance  - A Lightsail instance (a virtual private server)
 
 
 
 
  StaticIp  - A static IP address
 
 
 
 
  KeyPair  - The key pair used to connect to a Lightsail instance
 
 
 
 
  InstanceSnapshot  - A Lightsail instance snapshot
 
 
 
 
  Domain  - A DNS zone
 
 
 
 
  PeeredVpc  - A peered VPC
 
 
 
 
  LoadBalancer  - A Lightsail load balancer
 
 
 
 
  LoadBalancerTlsCertificate  - An SSL/TLS certificate associated with a Lightsail load
 balancer
 
 
 
 
  Disk  - A Lightsail block storage disk
 
 
 
 
  DiskSnapshot  - A block storage disk snapshot
 
 
 


tags
List<E> tags

 The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
 


loadBalancerName
String loadBalancerName

 The load balancer name where your SSL/TLS certificate is attached.
 


isAttached
Boolean isAttached

 When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
 


status
String status

 The status of the SSL/TLS certificate. Valid values are below.
 


domainName
String domainName

 The domain name for your SSL/TLS certificate.
 


domainValidationRecords
List<E> domainValidationRecords

 An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.
 


failureReason
String failureReason

 The reason for the SSL/TLS certificate validation failure.
 


issuedAt
Date issuedAt

 The time when the SSL/TLS certificate was issued.
 


issuer
String issuer

 The issuer of the certificate.
 


keyAlgorithm
String keyAlgorithm

 The algorithm that was used to generate the key pair (the public and private key).
 


notAfter
Date notAfter

 The timestamp when the SSL/TLS certificate expires.
 


notBefore
Date notBefore

 The timestamp when the SSL/TLS certificate is first valid.
 


renewalSummary
LoadBalancerTlsCertificateRenewalSummary renewalSummary

 An object containing information about the status of Lightsail's managed renewal for the certificate.
 


revocationReason
String revocationReason

 The reason the certificate was revoked. Valid values are below.
 


revokedAt
Date revokedAt

 The timestamp when the SSL/TLS certificate was revoked.
 


serial
String serial

 The serial number of the certificate.
 


signatureAlgorithm
String signatureAlgorithm

 The algorithm that was used to sign the certificate.
 


subject
String subject

 The name of the entity that is associated with the public key contained in the certificate.
 


subjectAlternativeNames
List<E> subjectAlternativeNames

 One or more domains or subdomains included in the certificate. This list contains the domain names that are bound
 to the public key that is contained in the certificate. The subject alternative names include the canonical
 domain name (CNAME) of the certificate and additional domain names that can be used to connect to the website,
 such as example.com, www.example.com, or m.example.com.
 








Class com.amazonaws.services.lightsail.model.LoadBalancerTlsCertificateDomainValidationOption extends Object implements Serializable


Serialized Fields


domainName
String domainName

 The fully qualified domain name in the certificate request.
 


validationStatus
String validationStatus

 The status of the domain validation. Valid values are listed below.
 








Class com.amazonaws.services.lightsail.model.LoadBalancerTlsCertificateDomainValidationRecord extends Object implements Serializable


Serialized Fields


name
String name

 A fully qualified domain name in the certificate. For example, example.com.
 


type
String type

 The type of validation record. For example, CNAME for domain validation.
 


value
String value

 The value for that type.
 


validationStatus
String validationStatus

 The validation status. Valid values are listed below.
 


domainName
String domainName

 The domain name against which your SSL/TLS certificate was validated.
 








Class com.amazonaws.services.lightsail.model.LoadBalancerTlsCertificateRenewalSummary extends Object implements Serializable


Serialized Fields


renewalStatus
String renewalStatus

 The status of Lightsail's managed renewal of the certificate. Valid values are listed below.
 


domainValidationOptions
List<E> domainValidationOptions

 Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail's
 managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate
 request.
 








Class com.amazonaws.services.lightsail.model.LoadBalancerTlsCertificateSummary extends Object implements Serializable


Serialized Fields


name
String name

 The name of the SSL/TLS certificate.
 


isAttached
Boolean isAttached

 When true, the SSL/TLS certificate is attached to the Lightsail load balancer.
 








Class com.amazonaws.services.lightsail.model.LogEvent extends Object implements Serializable


Serialized Fields


createdAt
Date createdAt

 The timestamp when the database log event was created.
 


message
String message

 The message of the database log event.
 








Class com.amazonaws.services.lightsail.model.MetricDatapoint extends Object implements Serializable


Serialized Fields


average
Double average

 The average.
 


maximum
Double maximum

 The maximum.
 


minimum
Double minimum

 The minimum.
 


sampleCount
Double sampleCount

 The sample count.
 


sum
Double sum

 The sum.
 


timestamp
Date timestamp

 The timestamp (e.g., 1479816991.349).
 


unit
String unit

 The unit.
 








Class com.amazonaws.services.lightsail.model.MonthlyTransfer extends Object implements Serializable


Serialized Fields


gbPerMonthAllocated
Integer gbPerMonthAllocated

 The amount allocated per month (in GB).
 








Class com.amazonaws.services.lightsail.model.NotFoundException extends AmazonLightsailException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code


docs
String docs


tip
String tip








Class com.amazonaws.services.lightsail.model.OpenInstancePublicPortsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


portInfo
PortInfo portInfo

 An array of key-value pairs containing information about the port mappings.
 


instanceName
String instanceName

 The name of the instance for which you want to open the public ports.
 








Class com.amazonaws.services.lightsail.model.OpenInstancePublicPortsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operation
Operation operation

 An array of key-value pairs containing information about the request operation.
 








Class com.amazonaws.services.lightsail.model.Operation extends Object implements Serializable


Serialized Fields


id
String id

 The ID of the operation.
 


resourceName
String resourceName

 The resource name.
 


resourceType
String resourceType

 The resource type.
 


createdAt
Date createdAt

 The timestamp when the operation was initialized (e.g., 1479816991.349).
 


location
ResourceLocation location

 The AWS Region and Availability Zone.
 


isTerminal
Boolean isTerminal

 A Boolean value indicating whether the operation is terminal.
 


operationDetails
String operationDetails

 Details about the operation (e.g., Debian-1GB-Ohio-1).
 


operationType
String operationType

 The type of operation.
 


status
String status

 The status of the operation.
 


statusChangedAt
Date statusChangedAt

 The timestamp when the status was changed (e.g., 1479816991.349).
 


errorCode
String errorCode

 The error code.
 


errorDetails
String errorDetails

 The error details.
 








Class com.amazonaws.services.lightsail.model.OperationFailureException extends AmazonLightsailException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code


docs
String docs


tip
String tip








Class com.amazonaws.services.lightsail.model.PasswordData extends Object implements Serializable


Serialized Fields


ciphertext
String ciphertext

 The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When
 you create an instance, it can take up to 15 minutes for the instance to be ready.
 
 
 
 If you use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available
 in the password field.
 
 
 If you are using a custom key pair, you need to use your own means of decryption.
 
 
 If you change the Administrator password on the instance, Lightsail will continue to return the original
 ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password
 after changing it from the default.
 
 


keyPairName
String keyPairName

 The name of the key pair that you used when creating your instance. If no key pair name was specified when
 creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair).
 
 
 If you are using a custom key pair, you need to use your own means of decrypting your password using the
 ciphertext. Lightsail creates the ciphertext by encrypting your password with the public key part of
 this key pair.
 








Class com.amazonaws.services.lightsail.model.PeerVpcRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.lightsail.model.PeerVpcResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operation
Operation operation

 An array of key-value pairs containing information about the request operation.
 








Class com.amazonaws.services.lightsail.model.PendingMaintenanceAction extends Object implements Serializable


Serialized Fields


action
String action

 The type of pending database maintenance action.
 


description
String description

 Additional detail about the pending database maintenance action.
 


currentApplyDate
Date currentApplyDate

 The effective date of the pending database maintenance action.
 








Class com.amazonaws.services.lightsail.model.PendingModifiedRelationalDatabaseValues extends Object implements Serializable


Serialized Fields


masterUserPassword
String masterUserPassword

 The password for the master user of the database.
 


engineVersion
String engineVersion

 The database engine version.
 


backupRetentionEnabled
Boolean backupRetentionEnabled

 A Boolean value indicating whether automated backup retention is enabled.
 








Class com.amazonaws.services.lightsail.model.PortInfo extends Object implements Serializable


Serialized Fields


fromPort
Integer fromPort

 The first port in the range.
 


toPort
Integer toPort

 The last port in the range.
 


protocol
String protocol

 The protocol.
 








Class com.amazonaws.services.lightsail.model.PutInstancePublicPortsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


portInfos
List<E> portInfos

 Specifies information about the public port(s).
 


instanceName
String instanceName

 The Lightsail instance name of the public port(s) you are setting.
 








Class com.amazonaws.services.lightsail.model.PutInstancePublicPortsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operation
Operation operation

 Describes metadata about the operation you just executed.
 








Class com.amazonaws.services.lightsail.model.RebootInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the instance to reboot.
 








Class com.amazonaws.services.lightsail.model.RebootInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the request operations.
 








Class com.amazonaws.services.lightsail.model.RebootRelationalDatabaseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of your database to reboot.
 








Class com.amazonaws.services.lightsail.model.RebootRelationalDatabaseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the result of your reboot relational database request.
 








Class com.amazonaws.services.lightsail.model.Region extends Object implements Serializable


Serialized Fields


continentCode
String continentCode

 The continent code (e.g., NA, meaning North America).
 


description
String description

 The description of the AWS Region (e.g.,
 This region is recommended to serve users in the eastern United States and eastern Canada).
 


displayName
String displayName

 The display name (e.g., Ohio).
 


name
String name

 The region name (e.g., us-east-2).
 


availabilityZones
List<E> availabilityZones

 The Availability Zones. Follows the format us-east-2a (case-sensitive).
 


relationalDatabaseAvailabilityZones
List<E> relationalDatabaseAvailabilityZones

 The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).
 








Class com.amazonaws.services.lightsail.model.RelationalDatabase extends Object implements Serializable


Serialized Fields


name
String name

 The unique name of the database resource in Lightsail.
 


arn
String arn

 The Amazon Resource Name (ARN) of the database.
 


supportCode
String supportCode

 The support code for the database. Include this code in your email to support when you have questions about a
 database in Lightsail. This code enables our support team to look up your Lightsail information more easily.
 


createdAt
Date createdAt

 The timestamp when the database was created. Formatted in Unix time.
 


location
ResourceLocation location

 The Region name and Availability Zone where the database is located.
 


resourceType
String resourceType

 The Lightsail resource type for the database (for example, RelationalDatabase).
 


tags
List<E> tags

 The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
 


relationalDatabaseBlueprintId
String relationalDatabaseBlueprintId

 The blueprint ID for the database. A blueprint describes the major engine version of a database.
 


relationalDatabaseBundleId
String relationalDatabaseBundleId

 The bundle ID for the database. A bundle describes the performance specifications for your database.
 


masterDatabaseName
String masterDatabaseName

 The name of the master database created when the Lightsail database resource is created.
 


hardware
RelationalDatabaseHardware hardware

 Describes the hardware of the database.
 


state
String state

 Describes the current state of the database.
 


secondaryAvailabilityZone
String secondaryAvailabilityZone

 Describes the secondary Availability Zone of a high availability database.
 
 
 The secondary database is used for failover support of a high availability database.
 


backupRetentionEnabled
Boolean backupRetentionEnabled

 A Boolean value indicating whether automated backup retention is enabled for the database.
 


pendingModifiedValues
PendingModifiedRelationalDatabaseValues pendingModifiedValues

 Describes pending database value modifications.
 


engine
String engine

 The database software (for example, MySQL).
 


engineVersion
String engineVersion

 The database engine version (for example, 5.7.23).
 


latestRestorableTime
Date latestRestorableTime

 The latest point in time to which the database can be restored. Formatted in Unix time.
 


masterUsername
String masterUsername

 The master user name of the database.
 


parameterApplyStatus
String parameterApplyStatus

 The status of parameter updates for the database.
 


preferredBackupWindow
String preferredBackupWindow

 The daily time range during which automated backups are created for the database (for example,
 16:00-16:30).
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 The weekly time range during which system maintenance can occur on the database.
 
 
 In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.
 


publiclyAccessible
Boolean publiclyAccessible

 A Boolean value indicating whether the database is publicly accessible.
 


masterEndpoint
RelationalDatabaseEndpoint masterEndpoint

 The master endpoint for the database.
 


pendingMaintenanceActions
List<E> pendingMaintenanceActions

 Describes the pending maintenance actions for the database.
 


caCertificateIdentifier
String caCertificateIdentifier

 The certificate associated with the database.
 








Class com.amazonaws.services.lightsail.model.RelationalDatabaseBlueprint extends Object implements Serializable


Serialized Fields


blueprintId
String blueprintId

 The ID for the database blueprint.
 


engine
String engine

 The database software of the database blueprint (for example, MySQL).
 


engineVersion
String engineVersion

 The database engine version for the database blueprint (for example, 5.7.23).
 


engineDescription
String engineDescription

 The description of the database engine for the database blueprint.
 


engineVersionDescription
String engineVersionDescription

 The description of the database engine version for the database blueprint.
 


isEngineDefault
Boolean isEngineDefault

 A Boolean value indicating whether the engine version is the default for the database blueprint.
 








Class com.amazonaws.services.lightsail.model.RelationalDatabaseBundle extends Object implements Serializable


Serialized Fields


bundleId
String bundleId

 The ID for the database bundle.
 


name
String name

 The name for the database bundle.
 


price
Float price

 The cost of the database bundle in US currency.
 


ramSizeInGb
Float ramSizeInGb

 The amount of RAM in GB (for example, 2.0) for the database bundle.
 


diskSizeInGb
Integer diskSizeInGb

 The size of the disk for the database bundle.
 


transferPerMonthInGb
Integer transferPerMonthInGb

 The data transfer rate per month in GB for the database bundle.
 


cpuCount
Integer cpuCount

 The number of virtual CPUs (vCPUs) for the database bundle.
 


isEncrypted
Boolean isEncrypted

 A Boolean value indicating whether the database bundle is encrypted.
 


isActive
Boolean isActive

 A Boolean value indicating whether the database bundle is active.
 








Class com.amazonaws.services.lightsail.model.RelationalDatabaseEndpoint extends Object implements Serializable


Serialized Fields


port
Integer port

 Specifies the port that the database is listening on.
 


address
String address

 Specifies the DNS address of the database.
 








Class com.amazonaws.services.lightsail.model.RelationalDatabaseEvent extends Object implements Serializable


Serialized Fields


resource
String resource

 The database that the database event relates to.
 


createdAt
Date createdAt

 The timestamp when the database event was created.
 


message
String message

 The message of the database event.
 


eventCategories
List<E> eventCategories

 The category that the database event belongs to.
 








Class com.amazonaws.services.lightsail.model.RelationalDatabaseHardware extends Object implements Serializable


Serialized Fields


cpuCount
Integer cpuCount

 The number of vCPUs for the database.
 


diskSizeInGb
Integer diskSizeInGb

 The size of the disk for the database.
 


ramSizeInGb
Float ramSizeInGb

 The amount of RAM in GB for the database.
 








Class com.amazonaws.services.lightsail.model.RelationalDatabaseParameter extends Object implements Serializable


Serialized Fields


allowedValues
String allowedValues

 Specifies the valid range of values for the parameter.
 


applyMethod
String applyMethod

 Indicates when parameter updates are applied.
 
 
 Can be immediate or pending-reboot.
 


applyType
String applyType

 Specifies the engine-specific parameter type.
 


dataType
String dataType

 Specifies the valid data type for the parameter.
 


description
String description

 Provides a description of the parameter.
 


isModifiable
Boolean isModifiable

 A Boolean value indicating whether the parameter can be modified.
 


parameterName
String parameterName

 Specifies the name of the parameter.
 


parameterValue
String parameterValue

 Specifies the value of the parameter.
 








Class com.amazonaws.services.lightsail.model.RelationalDatabaseSnapshot extends Object implements Serializable


Serialized Fields


name
String name

 The name of the database snapshot.
 


arn
String arn

 The Amazon Resource Name (ARN) of the database snapshot.
 


supportCode
String supportCode

 The support code for the database snapshot. Include this code in your email to support when you have questions
 about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information
 more easily.
 


createdAt
Date createdAt

 The timestamp when the database snapshot was created.
 


location
ResourceLocation location

 The Region name and Availability Zone where the database snapshot is located.
 


resourceType
String resourceType

 The Lightsail resource type.
 


tags
List<E> tags

 The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.
 


engine
String engine

 The software of the database snapshot (for example, MySQL)
 


engineVersion
String engineVersion

 The database engine version for the database snapshot (for example, 5.7.23).
 


sizeInGb
Integer sizeInGb

 The size of the disk in GB (for example, 32) for the database snapshot.
 


state
String state

 The state of the database snapshot.
 


fromRelationalDatabaseName
String fromRelationalDatabaseName

 The name of the source database from which the database snapshot was created.
 


fromRelationalDatabaseArn
String fromRelationalDatabaseArn

 The Amazon Resource Name (ARN) of the database from which the database snapshot was created.
 


fromRelationalDatabaseBundleId
String fromRelationalDatabaseBundleId

 The bundle ID of the database from which the database snapshot was created.
 


fromRelationalDatabaseBlueprintId
String fromRelationalDatabaseBlueprintId

 The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major
 engine version of a database.
 








Class com.amazonaws.services.lightsail.model.ReleaseStaticIpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


staticIpName
String staticIpName

 The name of the static IP to delete.
 








Class com.amazonaws.services.lightsail.model.ReleaseStaticIpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the request operation.
 








Class com.amazonaws.services.lightsail.model.ResourceLocation extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone

 The Availability Zone. Follows the format us-east-2a (case-sensitive).
 


regionName
String regionName

 The AWS Region name.
 








Class com.amazonaws.services.lightsail.model.ServiceException extends AmazonLightsailException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code


docs
String docs


tip
String tip








Class com.amazonaws.services.lightsail.model.StartInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the instance (a virtual private server) to start.
 








Class com.amazonaws.services.lightsail.model.StartInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the request operation.
 








Class com.amazonaws.services.lightsail.model.StartRelationalDatabaseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of your database to start.
 








Class com.amazonaws.services.lightsail.model.StartRelationalDatabaseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the result of your start relational database request.
 








Class com.amazonaws.services.lightsail.model.StaticIp extends Object implements Serializable


Serialized Fields


name
String name

 The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).
 


arn
String arn

 The Amazon Resource Name (ARN) of the static IP (e.g.,
 arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).
 


supportCode
String supportCode

 The support code. Include this code in your email to support when you have questions about an instance or another
 resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
 


createdAt
Date createdAt

 The timestamp when the static IP was created (e.g., 1479735304.222).
 


location
ResourceLocation location

 The region and Availability Zone where the static IP was created.
 


resourceType
String resourceType

 The resource type (usually StaticIp).
 


ipAddress
String ipAddress

 The static IP address.
 


attachedTo
String attachedTo

 The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).
 


isAttached
Boolean isAttached

 A Boolean value indicating whether the static IP is attached.
 








Class com.amazonaws.services.lightsail.model.StopInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceName
String instanceName

 The name of the instance (a virtual private server) to stop.
 


force
Boolean force

 When set to True, forces a Lightsail instance that is stuck in a stopping state to
 stop.
 
 
 
 Only use the force parameter if your instance is stuck in the stopping state. In any
 other state, your instance should stop normally without adding this parameter to your API request.
 
 








Class com.amazonaws.services.lightsail.model.StopInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the request operation.
 








Class com.amazonaws.services.lightsail.model.StopRelationalDatabaseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of your database to stop.
 


relationalDatabaseSnapshotName
String relationalDatabaseSnapshotName

 The name of your new database snapshot to be created before stopping your database.
 








Class com.amazonaws.services.lightsail.model.StopRelationalDatabaseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the result of your stop relational database request.
 








Class com.amazonaws.services.lightsail.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key of the tag.
 
 
 Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + -
 = . _ : / @
 


value
String value

 The value of the tag.
 
 
 Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: +
 - = . _ : / @
 








Class com.amazonaws.services.lightsail.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceName
String resourceName

 The name of the resource to which you are adding tags.
 


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource to which you want to add a tag.
 


tags
List<E> tags

 The tag key and optional value.
 








Class com.amazonaws.services.lightsail.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 A list of objects describing the API operation.
 








Class com.amazonaws.services.lightsail.model.UnauthenticatedException extends AmazonLightsailException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
String code


docs
String docs


tip
String tip








Class com.amazonaws.services.lightsail.model.UnpeerVpcRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.lightsail.model.UnpeerVpcResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operation
Operation operation

 An array of key-value pairs containing information about the request operation.
 








Class com.amazonaws.services.lightsail.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceName
String resourceName

 The name of the resource from which you are removing a tag.
 


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.
 


tagKeys
List<E> tagKeys

 The tag keys to delete from the specified resource.
 








Class com.amazonaws.services.lightsail.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 A list of objects describing the API operation.
 








Class com.amazonaws.services.lightsail.model.UpdateDomainEntryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


domainName
String domainName

 The name of the domain recordset to update.
 


domainEntry
DomainEntry domainEntry

 An array of key-value pairs containing information about the domain entry.
 








Class com.amazonaws.services.lightsail.model.UpdateDomainEntryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An array of key-value pairs containing information about the request operation.
 








Class com.amazonaws.services.lightsail.model.UpdateLoadBalancerAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer that you want to modify (e.g., my-load-balancer.
 


attributeName
String attributeName

 The name of the attribute you want to update. Valid values are below.
 


attributeValue
String attributeValue

 The value that you want to specify for the attribute name.
 








Class com.amazonaws.services.lightsail.model.UpdateLoadBalancerAttributeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the API operations.
 








Class com.amazonaws.services.lightsail.model.UpdateRelationalDatabaseParametersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of your database for which to update parameters.
 


parameters
List<E> parameters

 The database parameters to update.
 








Class com.amazonaws.services.lightsail.model.UpdateRelationalDatabaseParametersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the result of your update relational database parameters request.
 








Class com.amazonaws.services.lightsail.model.UpdateRelationalDatabaseRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


relationalDatabaseName
String relationalDatabaseName

 The name of your database to update.
 


masterUserPassword
String masterUserPassword

 The password for the master user of your database. The password can include any printable ASCII character except
 "/", """, or "@".
 
 
 Constraints: Must contain 8 to 41 characters.
 


rotateMasterUserPassword
Boolean rotateMasterUserPassword

 When true, the master user password is changed to a new strong password generated by Lightsail.
 
 
 Use the get relational database master user password operation to get the new password.
 


preferredBackupWindow
String preferredBackupWindow

 The daily time range during which automated backups are created for your database if automated backups are
 enabled.
 
 
 Constraints:
 
 
 
 
 Must be in the hh24:mi-hh24:mi format.
 
 
 Example: 16:00-16:30
 
 
 
 
 Specified in Coordinated Universal 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 on your database.
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring
 on a random day of the week.
 
 
 Constraints:
 
 
 
 
 Must be in the ddd:hh24:mi-ddd:hh24:mi format.
 
 
 
 
 Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
 
 
 
 
 Must be at least 30 minutes.
 
 
 
 
 Specified in Coordinated Universal Time (UTC).
 
 
 
 
 Example: Tue:17:00-Tue:17:30
 
 
 


enableBackupRetention
Boolean enableBackupRetention

 When true, enables automated backup retention for your database.
 
 
 Updates are applied during the next maintenance window because this can result in an outage.
 


disableBackupRetention
Boolean disableBackupRetention

 When true, disables automated backup retention for your database.
 
 
 Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create
 a snapshot of your database using the create relational database snapshot operation.
 
 
 Updates are applied during the next maintenance window because this can result in an outage.
 


publiclyAccessible
Boolean publiclyAccessible

 Specifies the accessibility options for your database. A value of true specifies a database that is
 available to resources outside of your Lightsail account. A value of false specifies a database that
 is available only to your Lightsail resources in the same region as your database.
 


applyImmediately
Boolean applyImmediately

 When true, applies changes immediately. When false, applies changes during the
 preferred maintenance window. Some changes may cause an outage.
 
 
 Default: false
 


caCertificateIdentifier
String caCertificateIdentifier

 Indicates the certificate that needs to be associated with the database.
 








Class com.amazonaws.services.lightsail.model.UpdateRelationalDatabaseResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operations
List<E> operations

 An object describing the result of your update relational database request.
 








Package com.amazonaws.services.logs.model




Class com.amazonaws.services.logs.model.AssociateKmsKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


kmsKeyId
String kmsKeyId

 The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. This must be a symmetric CMK. For more
 information, see Amazon Resource
 Names - AWS Key Management Service (AWS KMS) and Using Symmetric and
 Asymmetric Keys.
 








Class com.amazonaws.services.logs.model.AssociateKmsKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.AWSLogsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.CancelExportTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 The ID of the export task.
 








Class com.amazonaws.services.logs.model.CancelExportTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.CreateExportTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskName
String taskName

 The name of the export task.
 


logGroupName
String logGroupName

 The name of the log group.
 


logStreamNamePrefix
String logStreamNamePrefix

 Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is
 applied.
 


from
Long from

 The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00
 UTC. Events with a timestamp earlier than this time are not exported.
 


to
Long to

 The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00
 UTC. Events with a timestamp later than this time are not exported.
 


destination
String destination

 The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.
 


destinationPrefix
String destinationPrefix

 The prefix used as the start of the key for every object exported. If you don't specify a value, the default is
 exportedlogs.
 








Class com.amazonaws.services.logs.model.CreateExportTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


taskId
String taskId

 The ID of the export task.
 








Class com.amazonaws.services.logs.model.CreateLogGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


kmsKeyId
String kmsKeyId

 The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource
 Names - AWS Key Management Service (AWS KMS).
 


tags
SdkInternalMap<K,V> tags

 The key-value pairs to use for the tags.
 








Class com.amazonaws.services.logs.model.CreateLogGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.CreateLogStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


logStreamName
String logStreamName

 The name of the log stream.
 








Class com.amazonaws.services.logs.model.CreateLogStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.DataAlreadyAcceptedException extends AWSLogsException implements Serializable

serialVersionUID:
1L



Serialized Fields


expectedSequenceToken
String expectedSequenceToken








Class com.amazonaws.services.logs.model.DeleteDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationName
String destinationName

 The name of the destination.
 








Class com.amazonaws.services.logs.model.DeleteDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.DeleteLogGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 








Class com.amazonaws.services.logs.model.DeleteLogGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.DeleteLogStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


logStreamName
String logStreamName

 The name of the log stream.
 








Class com.amazonaws.services.logs.model.DeleteLogStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.DeleteMetricFilterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


filterName
String filterName

 The name of the metric filter.
 








Class com.amazonaws.services.logs.model.DeleteMetricFilterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.DeleteResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 The name of the policy to be revoked. This parameter is required.
 








Class com.amazonaws.services.logs.model.DeleteResourcePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.DeleteRetentionPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 








Class com.amazonaws.services.logs.model.DeleteRetentionPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.DeleteSubscriptionFilterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


filterName
String filterName

 The name of the subscription filter.
 








Class com.amazonaws.services.logs.model.DeleteSubscriptionFilterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.DescribeDestinationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationNamePrefix
String destinationNamePrefix

 The prefix to match. If you don't specify a value, no prefix filter is applied.
 


nextToken
String nextToken

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


limit
Integer limit

 The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
 








Class com.amazonaws.services.logs.model.DescribeDestinationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


destinations
SdkInternalList<T> destinations

 The destinations.
 


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeExportTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


taskId
String taskId

 The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.
 


statusCode
String statusCode

 The status code of the export task. Specifying a status code filters the results to zero or more export tasks.
 


nextToken
String nextToken

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


limit
Integer limit

 The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
 








Class com.amazonaws.services.logs.model.DescribeExportTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


exportTasks
SdkInternalList<T> exportTasks

 The export tasks.
 


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeLogGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupNamePrefix
String logGroupNamePrefix

 The prefix to match.
 


nextToken
String nextToken

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


limit
Integer limit

 The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
 








Class com.amazonaws.services.logs.model.DescribeLogGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


logGroups
SdkInternalList<T> logGroups

 The log groups.
 


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeLogStreamsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


logStreamNamePrefix
String logStreamNamePrefix

 The prefix to match.
 
 
 If orderBy is LastEventTime,you cannot specify this parameter.
 


orderBy
String orderBy

 If the value is LogStreamName, the results are ordered by log stream name. If the value is
 LastEventTime, the results are ordered by the event time. The default value is
 LogStreamName.
 
 
 If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.
 
 
 lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This
 number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on
 an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in
 some rare situations.
 


descending
Boolean descending

 If the value is true, results are returned in descending order. If the value is to false, results are returned in
 ascending order. The default value is false.
 


nextToken
String nextToken

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


limit
Integer limit

 The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
 








Class com.amazonaws.services.logs.model.DescribeLogStreamsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


logStreams
SdkInternalList<T> logStreams

 The log streams.
 


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeMetricFiltersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


filterNamePrefix
String filterNamePrefix

 The prefix to match.
 


nextToken
String nextToken

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


limit
Integer limit

 The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
 


metricName
String metricName

 Filters results to include only those with the specified metric name. If you include this parameter in your
 request, you must also include the metricNamespace parameter.
 


metricNamespace
String metricNamespace

 Filters results to include only those in the specified namespace. If you include this parameter in your request,
 you must also include the metricName parameter.
 








Class com.amazonaws.services.logs.model.DescribeMetricFiltersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


metricFilters
SdkInternalList<T> metricFilters

 The metric filters.
 


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeQueriesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 Limits the returned queries to only those for the specified log group.
 


status
String status

 Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.
 


maxResults
Integer maxResults

 Limits the number of returned queries to the specified number.
 


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeQueriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


queries
SdkInternalList<T> queries

 The list of queries that match the request.
 


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeResourcePoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken


limit
Integer limit

 The maximum number of resource policies to be displayed with one call of this API.
 








Class com.amazonaws.services.logs.model.DescribeResourcePoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourcePolicies
SdkInternalList<T> resourcePolicies

 The resource policies that exist in this account.
 


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeSubscriptionFiltersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


filterNamePrefix
String filterNamePrefix

 The prefix to match. If you don't specify a value, no prefix filter is applied.
 


nextToken
String nextToken

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


limit
Integer limit

 The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
 








Class com.amazonaws.services.logs.model.DescribeSubscriptionFiltersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


subscriptionFilters
SdkInternalList<T> subscriptionFilters

 The subscription filters.
 


nextToken
String nextToken








Class com.amazonaws.services.logs.model.Destination extends Object implements Serializable


Serialized Fields


destinationName
String destinationName

 The name of the destination.
 


targetArn
String targetArn

 The Amazon Resource Name (ARN) of the physical target to where the log events are delivered (for example, a
 Kinesis stream).
 


roleArn
String roleArn

 A role for impersonation, used when delivering log events to the target.
 


accessPolicy
String accessPolicy

 An IAM policy document that governs which AWS accounts can create subscription filters against this destination.
 


arn
String arn

 The ARN of this destination.
 


creationTime
Long creationTime

 The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 








Class com.amazonaws.services.logs.model.DisassociateKmsKeyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 








Class com.amazonaws.services.logs.model.DisassociateKmsKeyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.ExportTask extends Object implements Serializable


Serialized Fields


taskId
String taskId

 The ID of the export task.
 


taskName
String taskName

 The name of the export task.
 


logGroupName
String logGroupName

 The name of the log group from which logs data was exported.
 


from
Long from

 The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp
 before this time are not exported.
 


to
Long to

 The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp
 later than this time are not exported.
 


destination
String destination

 The name of Amazon S3 bucket to which the log data was exported.
 


destinationPrefix
String destinationPrefix

 The prefix that was used as the start of Amazon S3 key for every object exported.
 


status
ExportTaskStatus status

 The status of the export task.
 


executionInfo
ExportTaskExecutionInfo executionInfo

 Execution info about the export task.
 








Class com.amazonaws.services.logs.model.ExportTaskExecutionInfo extends Object implements Serializable


Serialized Fields


creationTime
Long creationTime

 The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 


completionTime
Long completionTime

 The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 








Class com.amazonaws.services.logs.model.ExportTaskStatus extends Object implements Serializable


Serialized Fields


code
String code

 The status code of the export task.
 


message
String message

 The status message related to the status code.
 








Class com.amazonaws.services.logs.model.FilteredLogEvent extends Object implements Serializable


Serialized Fields


logStreamName
String logStreamName

 The name of the log stream to which this event belongs.
 


timestamp
Long timestamp

 The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 


message
String message

 The data contained in the log event.
 


ingestionTime
Long ingestionTime

 The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 


eventId
String eventId

 The ID of the event.
 








Class com.amazonaws.services.logs.model.FilterLogEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group to search.
 


logStreamNames
SdkInternalList<T> logStreamNames

 Filters the results to only logs from the log streams in this list.
 
 
 If you specify a value for both logStreamNamePrefix and logStreamNames, the action
 returns an InvalidParameterException error.
 


logStreamNamePrefix
String logStreamNamePrefix

 Filters the results to include only events from log streams that have names starting with this prefix.
 
 
 If you specify a value for both logStreamNamePrefix and logStreamNames, but the value
 for logStreamNamePrefix does not match any log stream names specified in logStreamNames
 , the action returns an InvalidParameterException error.
 


startTime
Long startTime

 The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with
 a timestamp before this time are not returned.
 


endTime
Long endTime

 The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a
 timestamp later than this time are not returned.
 


filterPattern
String filterPattern

 The filter pattern to use. For more information, see Filter and Pattern
 Syntax.
 
 
 If not provided, all the events are matched.
 


nextToken
String nextToken

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


limit
Integer limit

 The maximum number of events to return. The default is 10,000 events.
 


interleaved
Boolean interleaved
Deprecated. 

 If the value is true, the operation makes a best effort to provide responses that contain events from multiple
 log streams within the log group, interleaved in a single response. If the value is false, all the matched log
 events in the first log stream are searched first, then those in the next log stream, and so on. The default is
 false.
 
 
 IMPORTANT: Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be
 true. The response from this operation will always interleave events from multiple log streams within a log
 group.
 








Class com.amazonaws.services.logs.model.FilterLogEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


events
SdkInternalList<T> events

 The matched events.
 


searchedLogStreams
SdkInternalList<T> searchedLogStreams

 Indicates which log streams have been searched and whether each has been searched completely.
 


nextToken
String nextToken

 The token to use when requesting the next set of items. The token expires after 24 hours.
 








Class com.amazonaws.services.logs.model.GetLogEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


logStreamName
String logStreamName

 The name of the log stream.
 


startTime
Long startTime

 The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with
 a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this
 time are not included.
 


endTime
Long endTime

 The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a
 timestamp equal to or later than this time are not included.
 


nextToken
String nextToken

 The token for the next set of items to return. (You received this token from a previous call.)
 
 
 Using this token works only when you specify true for startFromHead.
 


limit
Integer limit

 The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can
 fit in a response size of 1 MB, up to 10,000 log events.
 


startFromHead
Boolean startFromHead

 If the value is true, the earliest log events are returned first. If the value is false, the latest log events
 are returned first. The default value is false.
 
 
 If you are using nextToken in this operation, you must specify true for
 startFromHead.
 








Class com.amazonaws.services.logs.model.GetLogEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


events
SdkInternalList<T> events

 The events.
 


nextForwardToken
String nextForwardToken

 The token for the next set of items in the forward direction. The token expires after 24 hours. If you have
 reached the end of the stream, it will return the same token you passed in.
 


nextBackwardToken
String nextBackwardToken

 The token for the next set of items in the backward direction. The token expires after 24 hours. This token will
 never be null. If you have reached the end of the stream, it will return the same token you passed in.
 








Class com.amazonaws.services.logs.model.GetLogGroupFieldsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group to search.
 


time
Long time

 The time to set as the center of the query. If you specify time, the 8 minutes before and 8 minutes
 after this time are searched. If you omit time, the past 15 minutes are queried.
 
 
 The time value is specified as epoch time, the number of seconds since January 1, 1970, 00:00:00
 UTC.
 








Class com.amazonaws.services.logs.model.GetLogGroupFieldsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


logGroupFields
SdkInternalList<T> logGroupFields

 The array of fields found in the query. Each object in the array contains the name of the field, along with the
 percentage of time it appeared in the log events that were queried.
 








Class com.amazonaws.services.logs.model.GetLogRecordRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logRecordPointer
String logRecordPointer

 The pointer corresponding to the log event record you want to retrieve. You get this from the response of a
 GetQueryResults operation. In that response, the value of the @ptr field for a log
 event is the value to use as logRecordPointer to retrieve that complete log event record.
 








Class com.amazonaws.services.logs.model.GetLogRecordResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


logRecord
SdkInternalMap<K,V> logRecord

 The requested log event, as a JSON string.
 








Class com.amazonaws.services.logs.model.GetQueryResultsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


queryId
String queryId

 The ID number of the query.
 








Class com.amazonaws.services.logs.model.GetQueryResultsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


results
SdkInternalList<T> results

 The log events that matched the query criteria during the most recent time it ran.
 
 
 The results value is an array of arrays. Each log event is one object in the top-level array. Each
 of these log event objects is an array of field/value pairs.
 


statistics
QueryStatistics statistics

 Includes the number of log events scanned by the query, the number of log events that matched the query criteria,
 and the total number of bytes in the log events that were scanned.
 


status
String status

 The status of the most recent running of the query. Possible values are Cancelled,
 Complete, Failed, Running, Scheduled, Timeout,
 and Unknown.
 
 
 Queries time out after 15 minutes of execution. To avoid having your queries time out, reduce the time range
 being searched, or partition your query into a number of queries.
 








Class com.amazonaws.services.logs.model.InputLogEvent extends Object implements Serializable


Serialized Fields


timestamp
Long timestamp

 The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 


message
String message

 The raw event message.
 








Class com.amazonaws.services.logs.model.InvalidOperationException extends AWSLogsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.InvalidParameterException extends AWSLogsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.InvalidSequenceTokenException extends AWSLogsException implements Serializable

serialVersionUID:
1L



Serialized Fields


expectedSequenceToken
String expectedSequenceToken








Class com.amazonaws.services.logs.model.LimitExceededException extends AWSLogsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.ListTagsLogGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 








Class com.amazonaws.services.logs.model.ListTagsLogGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalMap<K,V> tags

 The tags for the log group.
 








Class com.amazonaws.services.logs.model.LogGroup extends Object implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


creationTime
Long creationTime

 The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 


retentionInDays
Integer retentionInDays


metricFilterCount
Integer metricFilterCount

 The number of metric filters.
 


arn
String arn

 The Amazon Resource Name (ARN) of the log group.
 


storedBytes
Long storedBytes

 The number of bytes stored.
 


kmsKeyId
String kmsKeyId

 The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.
 








Class com.amazonaws.services.logs.model.LogGroupField extends Object implements Serializable


Serialized Fields


name
String name

 The name of a log field.
 


percent
Integer percent

 The percentage of log events queried that contained the field.
 








Class com.amazonaws.services.logs.model.LogStream extends Object implements Serializable


Serialized Fields


logStreamName
String logStreamName

 The name of the log stream.
 


creationTime
Long creationTime

 The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 


firstEventTimestamp
Long firstEventTimestamp

 The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 


lastEventTimestamp
Long lastEventTimestamp

 The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the
 number of milliseconds after Jan 1, 1970 00:00:00 UTC. The lastEventTime value updates on an
 eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some
 rare situations.
 


lastIngestionTime
Long lastIngestionTime

 The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 


uploadSequenceToken
String uploadSequenceToken

 The sequence token.
 


arn
String arn

 The Amazon Resource Name (ARN) of the log stream.
 


storedBytes
Long storedBytes
Deprecated. 

 The number of bytes stored.
 
 
 IMPORTANT:On June 17, 2019, this parameter was deprecated for log streams, and is always reported as zero.
 This change applies only to log streams. The storedBytes parameter for log groups is not affected.
 








Class com.amazonaws.services.logs.model.MalformedQueryException extends AWSLogsException implements Serializable

serialVersionUID:
1L



Serialized Fields


queryCompileError
QueryCompileError queryCompileError








Class com.amazonaws.services.logs.model.MetricFilter extends Object implements Serializable


Serialized Fields


filterName
String filterName

 The name of the metric filter.
 


filterPattern
String filterPattern


metricTransformations
SdkInternalList<T> metricTransformations

 The metric transformations.
 


creationTime
Long creationTime

 The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 


logGroupName
String logGroupName

 The name of the log group.
 








Class com.amazonaws.services.logs.model.MetricFilterMatchRecord extends Object implements Serializable


Serialized Fields


eventNumber
Long eventNumber

 The event number.
 


eventMessage
String eventMessage

 The raw event data.
 


extractedValues
SdkInternalMap<K,V> extractedValues

 The values extracted from the event data by the filter.
 








Class com.amazonaws.services.logs.model.MetricTransformation extends Object implements Serializable


Serialized Fields


metricName
String metricName

 The name of the CloudWatch metric.
 


metricNamespace
String metricNamespace

 The namespace of the CloudWatch metric.
 


metricValue
String metricValue

 The value to publish to the CloudWatch metric when a filter pattern matches a log event.
 


defaultValue
Double defaultValue

 (Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
 








Class com.amazonaws.services.logs.model.OperationAbortedException extends AWSLogsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.OutputLogEvent extends Object implements Serializable


Serialized Fields


timestamp
Long timestamp

 The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 


message
String message

 The data contained in the log event.
 


ingestionTime
Long ingestionTime

 The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
 








Class com.amazonaws.services.logs.model.PutDestinationPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationName
String destinationName

 A name for an existing destination.
 


accessPolicy
String accessPolicy

 An IAM policy document that authorizes cross-account users to deliver their log events to the associated
 destination.
 








Class com.amazonaws.services.logs.model.PutDestinationPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.PutDestinationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinationName
String destinationName

 A name for the destination.
 


targetArn
String targetArn

 The ARN of an Amazon Kinesis stream to which to deliver matching log events.
 


roleArn
String roleArn

 The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on
 the destination stream.
 








Class com.amazonaws.services.logs.model.PutDestinationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


destination
Destination destination

 The destination.
 








Class com.amazonaws.services.logs.model.PutLogEventsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


logStreamName
String logStreamName

 The name of the log stream.
 


logEvents
SdkInternalList<T> logEvents

 The log events.
 


sequenceToken
String sequenceToken

 The sequence token obtained from the response of the previous PutLogEvents call. An upload in a
 newly created log stream does not require a sequence token. You can also get the sequence token using
 DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same
 value for sequenceToken, both calls may be successful, or one may be rejected.
 








Class com.amazonaws.services.logs.model.PutLogEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextSequenceToken
String nextSequenceToken

 The next sequence token.
 


rejectedLogEventsInfo
RejectedLogEventsInfo rejectedLogEventsInfo

 The rejected events.
 








Class com.amazonaws.services.logs.model.PutMetricFilterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


filterName
String filterName

 A name for the metric filter.
 


filterPattern
String filterPattern

 A filter pattern for extracting metric data out of ingested log events.
 


metricTransformations
SdkInternalList<T> metricTransformations

 A collection of information that defines how metric data gets emitted.
 








Class com.amazonaws.services.logs.model.PutMetricFilterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.PutResourcePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyName
String policyName

 Name of the new policy. This parameter is required.
 


policyDocument
String policyDocument

 Details of the new policy, including the identity of the principal that is enabled to put logs to this account.
 This is formatted as a JSON string. This parameter is required.
 
 
 The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the
 specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log
 stream.
 
 
 { "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action":"logs:PutLogEvents", "Resource": "logArn" } ] } 
 








Class com.amazonaws.services.logs.model.PutResourcePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourcePolicy
ResourcePolicy resourcePolicy

 The new policy.
 








Class com.amazonaws.services.logs.model.PutRetentionPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


retentionInDays
Integer retentionInDays








Class com.amazonaws.services.logs.model.PutRetentionPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.PutSubscriptionFilterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


filterName
String filterName

 A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in
 filterName. Otherwise, the call fails because you cannot associate a second filter with a log group.
 To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.
 


filterPattern
String filterPattern

 A filter pattern for subscribing to a filtered stream of log events.
 


destinationArn
String destinationArn

 The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:
 
 
 
 
 An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.
 
 
 
 
 A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.
 
 
 
 
 An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for
 same-account delivery.
 
 
 
 
 An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.
 
 
 


roleArn
String roleArn

 The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination
 stream. You don't need to provide the ARN when you are working with a logical destination for cross-account
 delivery.
 


distribution
String distribution

 The method used to distribute log data to the destination. By default log data is grouped by log stream, but the
 grouping can be set to random for a more even distribution. This property is only applicable when the destination
 is an Amazon Kinesis stream.
 








Class com.amazonaws.services.logs.model.PutSubscriptionFilterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.QueryCompileError extends Object implements Serializable


Serialized Fields


location
QueryCompileErrorLocation location

 Reserved.
 


message
String message

 Reserved.
 








Class com.amazonaws.services.logs.model.QueryCompileErrorLocation extends Object implements Serializable


Serialized Fields


startCharOffset
Integer startCharOffset

 Reserved.
 


endCharOffset
Integer endCharOffset

 Reserved.
 








Class com.amazonaws.services.logs.model.QueryInfo extends Object implements Serializable


Serialized Fields


queryId
String queryId

 The unique ID number of this query.
 


queryString
String queryString

 The query string used in this query.
 


status
String status

 The status of this query. Possible values are Cancelled, Complete, Failed,
 Running, Scheduled, and Unknown.
 


createTime
Long createTime

 The date and time that this query was created.
 


logGroupName
String logGroupName

 The name of the log group scanned by this query.
 








Class com.amazonaws.services.logs.model.QueryStatistics extends Object implements Serializable


Serialized Fields


recordsMatched
Double recordsMatched

 The number of log events that matched the query string.
 


recordsScanned
Double recordsScanned

 The total number of log events scanned during the query.
 


bytesScanned
Double bytesScanned

 The total number of bytes in the log events scanned during the query.
 








Class com.amazonaws.services.logs.model.RejectedLogEventsInfo extends Object implements Serializable


Serialized Fields


tooNewLogEventStartIndex
Integer tooNewLogEventStartIndex

 The log events that are too new.
 


tooOldLogEventEndIndex
Integer tooOldLogEventEndIndex

 The log events that are too old.
 


expiredLogEventEndIndex
Integer expiredLogEventEndIndex

 The expired log events.
 








Class com.amazonaws.services.logs.model.ResourceAlreadyExistsException extends AWSLogsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.ResourceNotFoundException extends AWSLogsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.ResourcePolicy extends Object implements Serializable


Serialized Fields


policyName
String policyName

 The name of the resource policy.
 


policyDocument
String policyDocument

 The details of the policy.
 


lastUpdatedTime
Long lastUpdatedTime

 Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970
 00:00:00 UTC.
 








Class com.amazonaws.services.logs.model.ResultField extends Object implements Serializable


Serialized Fields


field
String field

 The log event field.
 


value
String value

 The value of this field.
 








Class com.amazonaws.services.logs.model.SearchedLogStream extends Object implements Serializable


Serialized Fields


logStreamName
String logStreamName

 The name of the log stream.
 


searchedCompletely
Boolean searchedCompletely

 Indicates whether all the events in this log stream were searched.
 








Class com.amazonaws.services.logs.model.ServiceUnavailableException extends AWSLogsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.StartQueryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The log group on which to perform the query.
 
 
 A StartQuery operation must include a logGroupNames or a logGroupName
 parameter, but not both.
 


logGroupNames
SdkInternalList<T> logGroupNames

 The list of log groups to be queried. You can include up to 20 log groups.
 
 
 A StartQuery operation must include a logGroupNames or a logGroupName
 parameter, but not both.
 


startTime
Long startTime

 The beginning of the time range to query. The range is inclusive, so the specified start time is included in the
 query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.
 


endTime
Long endTime

 The end of the time range to query. The range is inclusive, so the specified end time is included in the query.
 Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.
 


queryString
String queryString

 The query string to use. For more information, see CloudWatch Logs Insights
 Query Syntax.
 


limit
Integer limit

 The maximum number of log events to return in the query. If the query string uses the fields
 command, only the specified fields and their values are returned. The default is 1000.
 








Class com.amazonaws.services.logs.model.StartQueryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


queryId
String queryId

 The unique ID of the query.
 








Class com.amazonaws.services.logs.model.StopQueryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


queryId
String queryId

 The ID number of the query to stop. If necessary, you can use DescribeQueries to find this ID
 number.
 








Class com.amazonaws.services.logs.model.StopQueryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


success
Boolean success

 This is true if the query was stopped by the StopQuery operation.
 








Class com.amazonaws.services.logs.model.SubscriptionFilter extends Object implements Serializable


Serialized Fields


filterName
String filterName

 The name of the subscription filter.
 


logGroupName
String logGroupName

 The name of the log group.
 


filterPattern
String filterPattern


destinationArn
String destinationArn

 The Amazon Resource Name (ARN) of the destination.
 


roleArn
String roleArn



distribution
String distribution


creationTime
Long creationTime

 The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00
 UTC.
 








Class com.amazonaws.services.logs.model.TagLogGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


tags
SdkInternalMap<K,V> tags

 The key-value pairs to use for the tags.
 








Class com.amazonaws.services.logs.model.TagLogGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.logs.model.TestMetricFilterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filterPattern
String filterPattern


logEventMessages
SdkInternalList<T> logEventMessages

 The log event messages to test.
 








Class com.amazonaws.services.logs.model.TestMetricFilterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


matches
SdkInternalList<T> matches

 The matched events.
 








Class com.amazonaws.services.logs.model.UnrecognizedClientException extends AWSLogsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.UntagLogGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


logGroupName
String logGroupName

 The name of the log group.
 


tags
SdkInternalList<T> tags

 The tag keys. The corresponding tags are removed from the log group.
 








Class com.amazonaws.services.logs.model.UntagLogGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.machinelearning.model




Class com.amazonaws.services.machinelearning.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tags
SdkInternalList<T> tags

 The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a
 tag with the specified key and a value of null.
 


resourceId
String resourceId

 The ID of the ML object to tag. For example, exampleModelId.
 


resourceType
String resourceType

 The type of the ML object to tag.
 








Class com.amazonaws.services.machinelearning.model.AddTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceId
String resourceId

 The ID of the ML object that was tagged.
 


resourceType
String resourceType

 The type of the ML object that was tagged.
 








Class com.amazonaws.services.machinelearning.model.AmazonMachineLearningException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.machinelearning.model.BatchPrediction extends Object implements Serializable


Serialized Fields


batchPredictionId
String batchPredictionId

 The ID assigned to the BatchPrediction at creation. This value should be identical to the value of
 the BatchPredictionID in the request.
 


mLModelId
String mLModelId

 The ID of the MLModel that generated predictions for the BatchPrediction request.
 


batchPredictionDataSourceId
String batchPredictionDataSourceId

 The ID of the DataSource that points to the group of observations to predict.
 


inputDataLocationS3
String inputDataLocationS3

 The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
 


createdByIamUser
String createdByIamUser

 The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root
 account or an AWS Identity and Access Management (IAM) user account.
 


createdAt
Date createdAt

 The time that the BatchPrediction was created. The time is expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.
 


name
String name

 A user-supplied name or description of the BatchPrediction.
 


status
String status

 The status of the BatchPrediction. This element can have one of the following values:
 
 
  PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a
 batch of observations.
  INPROGRESS - The process is underway.
  FAILED - The request to perform a batch prediction did not run to completion. It is not usable.
  COMPLETED - The batch prediction process completed successfully.
  DELETED - The BatchPrediction is marked as deleted. It is not usable.
 


outputUri
String outputUri

 The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are
 not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.
 


message
String message

 A description of the most recent details about processing the batch prediction request.
 


computeTime
Long computeTime


finishedAt
Date finishedAt


startedAt
Date startedAt


totalRecordCount
Long totalRecordCount


invalidRecordCount
Long invalidRecordCount








Class com.amazonaws.services.machinelearning.model.CreateBatchPredictionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


batchPredictionId
String batchPredictionId

 A user-supplied ID that uniquely identifies the BatchPrediction.
 


batchPredictionName
String batchPredictionName

 A user-supplied name or description of the BatchPrediction. BatchPredictionName can
 only use the UTF-8 character set.
 


mLModelId
String mLModelId

 The ID of the MLModel that will generate predictions for the group of observations.
 


batchPredictionDataSourceId
String batchPredictionDataSourceId

 The ID of the DataSource that points to the group of observations to predict.
 


outputUri
String outputUri

 The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction
 results. The following substrings are not allowed in the s3 key portion of the
 outputURI field: ':', '//', '/./', '/../'.
 
 
 Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set
 permissions, see the Amazon Machine Learning
 Developer Guide.
 








Class com.amazonaws.services.machinelearning.model.CreateBatchPredictionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


batchPredictionId
String batchPredictionId

 A user-supplied ID that uniquely identifies the BatchPrediction. This value is identical to the
 value of the BatchPredictionId in the request.
 








Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromRDSRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon Resource Number
 (ARN) becomes the ID for a DataSource.
 


dataSourceName
String dataSourceName

 A user-supplied name or description of the DataSource.
 


rDSData
RDSDataSpec rDSData

 The data specification of an Amazon RDS DataSource:
 
 
 
 
 DatabaseInformation -
 

  DatabaseName - The name of the Amazon RDS database.
  InstanceIdentifier  - A 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 - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task
 from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for
 data pipelines.
 
 
 
 
 ServiceRole - A role (DataPipelineDefaultRole) assumed by the 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.
 
 
 
 
 SecurityInfo - The security information to use to access an RDS DB 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 RDS DB instance.
 
 
 
 
 SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource.
 
 
 
 
 S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using
 SelectSqlQuery is stored in this location.
 
 
 
 
 DataSchemaUri - The 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 that represents the splitting and rearrangement requirements for the
 Datasource.
 
 

 
 Sample -  "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
 
 
 


roleARN
String roleARN

 The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's
 account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.
 
 
 


computeStatistics
Boolean computeStatistics

 The compute statistics for a DataSource. The statistics are generated from the observation data
 referenced by a DataSource. Amazon ML uses the statistics internally during MLModel
 training. This parameter must be set to true if the DataSource needs to be
 used for MLModel training.
 








Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromRDSResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the
 DataSourceID in the request.
 








Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromRedshiftRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 A user-supplied ID that uniquely identifies the DataSource.
 


dataSourceName
String dataSourceName

 A user-supplied name or description of the DataSource.
 


dataSpec
RedshiftDataSpec dataSpec

 The data specification of an Amazon Redshift DataSource:
 
 
 
 
 DatabaseInformation -
 

  DatabaseName - The name of the Amazon Redshift database.
   ClusterIdentifier - The unique ID for the Amazon Redshift cluster.
 
 
 
 
 
 DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the
 Amazon Redshift database.
 
 
 
 
 SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource.
 
 
 
 
 S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The
 data retrieved from Amazon Redshift using the SelectSqlQuery query is stored in this location.
 
 
 
 
 DataSchemaUri - The 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 that represents the splitting and rearrangement requirements for the
 DataSource.
 
 
 Sample -  "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
 
 
 


roleARN
String roleARN

 A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the
 following:
 
 
 

 
 
 A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift
 cluster
 
 
 
 
 An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation
 
 
 
 


computeStatistics
Boolean computeStatistics

 The compute statistics for a DataSource. The statistics are generated from the observation data
 referenced by a DataSource. Amazon ML uses the statistics internally during MLModel
 training. This parameter must be set to true if the DataSource needs to be used for
 MLModel training.
 








Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromRedshiftResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the
 DataSourceID in the request.
 








Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromS3Request extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 A user-supplied identifier that uniquely identifies the DataSource.
 


dataSourceName
String dataSourceName

 A user-supplied name or description of the DataSource.
 


dataSpec
S3DataSpec dataSpec

 The data specification of a DataSource:
 
 
 
 
 DataLocationS3 - The Amazon S3 location of the observation data.
 
 
 
 
 DataSchemaLocationS3 - The 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 that represents the splitting and rearrangement requirements for the
 Datasource.
 
 
 Sample -  "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
 
 
 


computeStatistics
Boolean computeStatistics

 The compute statistics for a DataSource. The statistics are generated from the observation data
 referenced by a DataSource. Amazon ML uses the statistics internally during MLModel
 training. This parameter must be set to true if the DataSource needs to be
 used for MLModel training.
 








Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromS3Result extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 A user-supplied ID that uniquely identifies the DataSource. This value should be identical to the
 value of the DataSourceID in the request.
 








Class com.amazonaws.services.machinelearning.model.CreateEvaluationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


evaluationId
String evaluationId

 A user-supplied ID that uniquely identifies the Evaluation.
 


evaluationName
String evaluationName

 A user-supplied name or description of the Evaluation.
 


mLModelId
String mLModelId

 The ID of the MLModel to evaluate.
 
 
 The schema used in creating the MLModel must match the schema of the DataSource used in
 the Evaluation.
 


evaluationDataSourceId
String evaluationDataSourceId

 The ID of the DataSource for the evaluation. The schema of the DataSource must match
 the schema used to create the MLModel.
 








Class com.amazonaws.services.machinelearning.model.CreateEvaluationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


evaluationId
String evaluationId

 The user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the
 value of the EvaluationId in the request.
 








Class com.amazonaws.services.machinelearning.model.CreateMLModelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mLModelId
String mLModelId

 A user-supplied ID that uniquely identifies the MLModel.
 


mLModelName
String mLModelName

 A user-supplied name or description of the MLModel.
 


mLModelType
String mLModelType

 The category of supervised learning that this MLModel will address. Choose from the following types:
 
 
 Choose REGRESSION if the MLModel will be used to predict a numeric value.
 Choose BINARY if the MLModel result has two possible values.
 Choose MULTICLASS if the MLModel result has a limited number of values.
 
 
 For more information, see the Amazon Machine
 Learning Developer Guide.
 


parameters
SdkInternalMap<K,V> parameters

 A list of the training parameters in the MLModel. The list is implemented as a map of key-value
 pairs.
 
 
 The following is the current set of training parameters:
 
 
 
 
 sgd.maxMLModelSizeInBytes - The 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.
 
 
 
 
 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.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a
 model's ability to find the optimal solution for a variety of data types. The valid values are auto
 and none. The default value is none. We strongly recommend that you shuffle your data.
 
 
 
 
 sgd.l1RegularizationAmount - The 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, 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 to not use L1
 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.
 
 
 
 
 sgd.l2RegularizationAmount - The 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 value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2
 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.
 
 
 


trainingDataSourceId
String trainingDataSourceId

 The DataSource that points to the training data.
 


recipe
String recipe

 The data recipe for creating the MLModel. You must specify either the recipe or its URI. If you
 don't specify a recipe or its URI, Amazon ML creates a default.
 


recipeUri
String recipeUri

 The Amazon Simple Storage Service (Amazon S3) location and file name that contains the MLModel
 recipe. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML
 creates a default.
 








Class com.amazonaws.services.machinelearning.model.CreateMLModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


mLModelId
String mLModelId

 A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value
 of the MLModelId in the request.
 








Class com.amazonaws.services.machinelearning.model.CreateRealtimeEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mLModelId
String mLModelId

 The ID assigned to the MLModel during creation.
 








Class com.amazonaws.services.machinelearning.model.CreateRealtimeEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


mLModelId
String mLModelId

 A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value
 of the MLModelId in the request.
 


realtimeEndpointInfo
RealtimeEndpointInfo realtimeEndpointInfo

 The endpoint information of the MLModel
 








Class com.amazonaws.services.machinelearning.model.DataSource extends Object implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 The ID that is assigned to the DataSource during creation.
 


dataLocationS3
String dataLocationS3

 The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a
 DataSource.
 


dataRearrangement
String dataRearrangement

 A JSON string that represents the splitting and rearrangement requirement used when this DataSource
 was created.
 


createdByIamUser
String createdByIamUser

 The AWS user account from which the DataSource was created. The account type can be either an AWS
 root account or an AWS Identity and Access Management (IAM) user account.
 


createdAt
Date createdAt

 The time that the DataSource was created. The time is expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.
 


dataSizeInBytes
Long dataSizeInBytes

 The total number of observations contained in the data files that the DataSource references.
 


numberOfFiles
Long numberOfFiles

 The number of data files referenced by the DataSource.
 


name
String name

 A user-supplied name or description of the DataSource.
 


status
String status

 The current status of the DataSource. This element can have one of the following values:
 
 
 PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a DataSource.
 INPROGRESS - The creation process is underway.
 FAILED - The request to create a DataSource did not run to completion. It is not usable.
 COMPLETED - The creation process completed successfully.
 DELETED - The DataSource is marked as deleted. It is not usable.
 


message
String message

 A description of the most recent details about creating the DataSource.
 


redshiftMetadata
RedshiftMetadata redshiftMetadata


rDSMetadata
RDSMetadata rDSMetadata


roleARN
String roleARN


computeStatistics
Boolean computeStatistics

 The parameter is true if statistics need to be generated from the observation data.
 


computeTime
Long computeTime


finishedAt
Date finishedAt


startedAt
Date startedAt








Class com.amazonaws.services.machinelearning.model.DeleteBatchPredictionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


batchPredictionId
String batchPredictionId

 A user-supplied ID that uniquely identifies the BatchPrediction.
 








Class com.amazonaws.services.machinelearning.model.DeleteBatchPredictionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


batchPredictionId
String batchPredictionId

 A user-supplied ID that uniquely identifies the BatchPrediction. This value should be identical to
 the value of the BatchPredictionID in the request.
 








Class com.amazonaws.services.machinelearning.model.DeleteDataSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 A user-supplied ID that uniquely identifies the DataSource.
 








Class com.amazonaws.services.machinelearning.model.DeleteDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 A user-supplied ID that uniquely identifies the DataSource. This value should be identical to the
 value of the DataSourceID in the request.
 








Class com.amazonaws.services.machinelearning.model.DeleteEvaluationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


evaluationId
String evaluationId

 A user-supplied ID that uniquely identifies the Evaluation to delete.
 








Class com.amazonaws.services.machinelearning.model.DeleteEvaluationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


evaluationId
String evaluationId

 A user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the
 value of the EvaluationId in the request.
 








Class com.amazonaws.services.machinelearning.model.DeleteMLModelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mLModelId
String mLModelId

 A user-supplied ID that uniquely identifies the MLModel.
 








Class com.amazonaws.services.machinelearning.model.DeleteMLModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


mLModelId
String mLModelId

 A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value
 of the MLModelID in the request.
 








Class com.amazonaws.services.machinelearning.model.DeleteRealtimeEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mLModelId
String mLModelId

 The ID assigned to the MLModel during creation.
 








Class com.amazonaws.services.machinelearning.model.DeleteRealtimeEndpointResult extends AmazonWebServiceResult<ResponseMetadata> 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.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tagKeys
SdkInternalList<T> tagKeys

 One or more tags to delete.
 


resourceId
String resourceId

 The ID of the tagged ML object. For example, exampleModelId.
 


resourceType
String resourceType

 The type of the tagged ML object.
 








Class com.amazonaws.services.machinelearning.model.DeleteTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceId
String resourceId

 The ID of the ML object from which tags were deleted.
 


resourceType
String resourceType

 The type of the ML object from which tags were deleted.
 








Class com.amazonaws.services.machinelearning.model.DescribeBatchPredictionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filterVariable
String filterVariable

 Use one of the following variables to filter a list of BatchPrediction:
 
 
  CreatedAt - Sets the search criteria to the BatchPrediction creation date.
  Status - Sets the search criteria to the BatchPrediction status.
  Name - Sets the search criteria to the contents of the BatchPrediction 
 Name.
  IAMUser - Sets the search criteria to the user account that invoked the
 BatchPrediction creation.
  MLModelId - Sets the search criteria to the MLModel used in the
 BatchPrediction.
  DataSourceId - Sets the search criteria to the DataSource used in the
 BatchPrediction.
  DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction.
 The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
 


eQ
String eQ

 The equal to operator. The BatchPrediction results will have FilterVariable values that
 exactly match the value specified with EQ.
 


gT
String gT

 The greater than operator. The BatchPrediction results will have FilterVariable values
 that are greater than the value specified with GT.
 


lT
String lT

 The less than operator. The BatchPrediction results will have FilterVariable values
 that are less than the value specified with LT.
 


gE
String gE

 The greater than or equal to operator. The BatchPrediction results will have
 FilterVariable values that are greater than or equal to the value specified with GE.
 


lE
String lE

 The less than or equal to operator. The BatchPrediction results will have
 FilterVariable values that are less than or equal to the value specified with LE.
 


nE
String nE

 The not equal to operator. The BatchPrediction results will have FilterVariable values
 not equal to the value specified with NE.
 


prefix
String prefix

 A string that is found at the beginning of a variable, such as Name or Id.
 
 
 For example, a Batch Prediction operation could have the Name
 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select
 Name for the FilterVariable and any of the following strings for the
 Prefix:
 
 
 
 
 2014-09
 
 
 
 
 2014-09-09
 
 
 
 
 2014-09-09-Holiday
 
 
 


sortOrder
String sortOrder

 A two-value parameter that determines the sequence of the resulting list of MLModels.
 
 
  asc - Arranges the list in ascending order (A-Z, 0-9).
  dsc - Arranges the list in descending order (Z-A, 9-0).
 
 
 Results are sorted by FilterVariable.
 


nextToken
String nextToken

 An ID of the page in the paginated results.
 


limit
Integer limit

 The number of pages of information to include in the result. The range of acceptable values is 1
 through 100. The default value is 100.
 








Class com.amazonaws.services.machinelearning.model.DescribeBatchPredictionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


results
SdkInternalList<T> results

 A list of BatchPrediction objects that meet the search criteria.
 


nextToken
String nextToken

 The ID of the next page in the paginated results that indicates at least one more page follows.
 








Class com.amazonaws.services.machinelearning.model.DescribeDataSourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filterVariable
String filterVariable

 Use one of the following variables to filter a list of DataSource:
 
 
  CreatedAt - Sets the search criteria to DataSource creation dates.
  Status - Sets the search criteria to DataSource statuses.
  Name - Sets the search criteria to the contents of DataSource  
 Name.
  DataUri - Sets the search criteria to the URI of data files used to create the
 DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3)
 bucket or directory.
  IAMUser - Sets the search criteria to the user account that invoked the DataSource
 creation.
 


eQ
String eQ

 The equal to operator. The DataSource results will have FilterVariable values that
 exactly match the value specified with EQ.
 


gT
String gT

 The greater than operator. The DataSource results will have FilterVariable values that
 are greater than the value specified with GT.
 


lT
String lT

 The less than operator. The DataSource results will have FilterVariable values that are
 less than the value specified with LT.
 


gE
String gE

 The greater than or equal to operator. The DataSource results will have FilterVariable
 values that are greater than or equal to the value specified with GE.
 


lE
String lE

 The less than or equal to operator. The DataSource results will have FilterVariable
 values that are less than or equal to the value specified with LE.
 


nE
String nE

 The not equal to operator. The DataSource results will have FilterVariable values not
 equal to the value specified with NE.
 


prefix
String prefix

 A string that is found at the beginning of a variable, such as Name or Id.
 
 
 For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer
 . To search for this DataSource, select Name for the FilterVariable and
 any of the following strings for the Prefix:
 
 
 
 
 2014-09
 
 
 
 
 2014-09-09
 
 
 
 
 2014-09-09-Holiday
 
 
 


sortOrder
String sortOrder

 A two-value parameter that determines the sequence of the resulting list of DataSource.
 
 
  asc - Arranges the list in ascending order (A-Z, 0-9).
  dsc - Arranges the list in descending order (Z-A, 9-0).
 
 
 Results are sorted by FilterVariable.
 


nextToken
String nextToken

 The ID of the page in the paginated results.
 


limit
Integer limit

 The maximum number of DataSource to include in the result.
 








Class com.amazonaws.services.machinelearning.model.DescribeDataSourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


results
SdkInternalList<T> results

 A list of DataSource that meet the search criteria.
 


nextToken
String nextToken

 An ID of the next page in the paginated results that indicates at least one more page follows.
 








Class com.amazonaws.services.machinelearning.model.DescribeEvaluationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filterVariable
String filterVariable

 Use one of the following variable to filter a list of Evaluation objects:
 
 
  CreatedAt - Sets the search criteria to the Evaluation creation date.
  Status - Sets the search criteria to the Evaluation status.
  Name - Sets the search criteria to the contents of Evaluation  
 Name.
  IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
  MLModelId - Sets the search criteria to the MLModel that was evaluated.
  DataSourceId - Sets the search criteria to the DataSource used in
 Evaluation.
  DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL
 can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
 


eQ
String eQ

 The equal to operator. The Evaluation results will have FilterVariable values that
 exactly match the value specified with EQ.
 


gT
String gT

 The greater than operator. The Evaluation results will have FilterVariable values that
 are greater than the value specified with GT.
 


lT
String lT

 The less than operator. The Evaluation results will have FilterVariable values that are
 less than the value specified with LT.
 


gE
String gE

 The greater than or equal to operator. The Evaluation results will have FilterVariable
 values that are greater than or equal to the value specified with GE.
 


lE
String lE

 The less than or equal to operator. The Evaluation results will have FilterVariable
 values that are less than or equal to the value specified with LE.
 


nE
String nE

 The not equal to operator. The Evaluation results will have FilterVariable values not
 equal to the value specified with NE.
 


prefix
String prefix

 A string that is found at the beginning of a variable, such as Name or Id.
 
 
 For example, an Evaluation could have the Name
 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name
 for the FilterVariable and any of the following strings for the Prefix:
 
 
 
 
 2014-09
 
 
 
 
 2014-09-09
 
 
 
 
 2014-09-09-Holiday
 
 
 


sortOrder
String sortOrder

 A two-value parameter that determines the sequence of the resulting list of Evaluation.
 
 
  asc - Arranges the list in ascending order (A-Z, 0-9).
  dsc - Arranges the list in descending order (Z-A, 9-0).
 
 
 Results are sorted by FilterVariable.
 


nextToken
String nextToken

 The ID of the page in the paginated results.
 


limit
Integer limit

 The maximum number of Evaluation to include in the result.
 








Class com.amazonaws.services.machinelearning.model.DescribeEvaluationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


results
SdkInternalList<T> results

 A list of Evaluation that meet the search criteria.
 


nextToken
String nextToken

 The ID of the next page in the paginated results that indicates at least one more page follows.
 








Class com.amazonaws.services.machinelearning.model.DescribeMLModelsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filterVariable
String filterVariable

 Use one of the following variables to filter a list of MLModel:
 
 
  CreatedAt - Sets the search criteria to MLModel creation date.
  Status - Sets the search criteria to MLModel status.
  Name - Sets the search criteria to the contents of MLModel 
 Name.
  IAMUser - Sets the search criteria to the user account that invoked the MLModel
 creation.
  TrainingDataSourceId - Sets the search criteria to the DataSource used to train one
 or more MLModel.
  RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint
 status.
  MLModelType - Sets the search criteria to MLModel type: binary, regression, or
 multi-class.
  Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
  TrainingDataURI - Sets the search criteria to the data file(s) used in training a
 MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket
 or directory.
 


eQ
String eQ

 The equal to operator. The MLModel results will have FilterVariable values that exactly
 match the value specified with EQ.
 


gT
String gT

 The greater than operator. The MLModel results will have FilterVariable values that are
 greater than the value specified with GT.
 


lT
String lT

 The less than operator. The MLModel results will have FilterVariable values that are
 less than the value specified with LT.
 


gE
String gE

 The greater than or equal to operator. The MLModel results will have FilterVariable
 values that are greater than or equal to the value specified with GE.
 


lE
String lE

 The less than or equal to operator. The MLModel results will have FilterVariable values
 that are less than or equal to the value specified with LE.
 


nE
String nE

 The not equal to operator. The MLModel results will have FilterVariable values not
 equal to the value specified with NE.
 


prefix
String prefix

 A string that is found at the beginning of a variable, such as Name or Id.
 
 
 For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer.
 To search for this MLModel, select Name for the FilterVariable and any of
 the following strings for the Prefix:
 
 
 
 
 2014-09
 
 
 
 
 2014-09-09
 
 
 
 
 2014-09-09-Holiday
 
 
 


sortOrder
String sortOrder

 A two-value parameter that determines the sequence of the resulting list of MLModel.
 
 
  asc - Arranges the list in ascending order (A-Z, 0-9).
  dsc - Arranges the list in descending order (Z-A, 9-0).
 
 
 Results are sorted by FilterVariable.
 


nextToken
String nextToken

 The ID of the page in the paginated results.
 


limit
Integer limit

 The number of pages of information to include in the result. The range of acceptable values is 1
 through 100. The default value is 100.
 








Class com.amazonaws.services.machinelearning.model.DescribeMLModelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


results
SdkInternalList<T> results

 A list of MLModel that meet the search criteria.
 


nextToken
String nextToken

 The ID of the next page in the paginated results that indicates at least one more page follows.
 








Class com.amazonaws.services.machinelearning.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceId
String resourceId

 The ID of the ML object. For example, exampleModelId.
 


resourceType
String resourceType

 The type of the ML object.
 








Class com.amazonaws.services.machinelearning.model.DescribeTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceId
String resourceId

 The ID of the tagged ML object.
 


resourceType
String resourceType

 The type of the tagged ML object.
 


tags
SdkInternalList<T> tags

 A list of tags associated with the ML object.
 








Class com.amazonaws.services.machinelearning.model.Evaluation extends Object implements Serializable


Serialized Fields


evaluationId
String evaluationId

 The ID that is assigned to the Evaluation at creation.
 


mLModelId
String mLModelId

 The ID of the MLModel that is the focus of the evaluation.
 


evaluationDataSourceId
String evaluationDataSourceId

 The ID of the DataSource that is used to evaluate the MLModel.
 


inputDataLocationS3
String inputDataLocationS3

 The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.
 


createdByIamUser
String createdByIamUser

 The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS
 Identity and Access Management (IAM) user account.
 


createdAt
Date createdAt

 The time that the Evaluation was created. The time is expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the Evaluation. The time is expressed in epoch time.
 


name
String name

 A user-supplied name or description of the Evaluation.
 


status
String status

 The status of the evaluation. This element can have one of the following values:
 
 
  PENDING - Amazon Machine Learning (Amazon ML) submitted a request to evaluate an
 MLModel.
  INPROGRESS - The evaluation is underway.
  FAILED - The request to evaluate an MLModel did not run to completion. It is not
 usable.
  COMPLETED - The evaluation process completed successfully.
  DELETED - The Evaluation is marked as deleted. It is not usable.
 


performanceMetrics
PerformanceMetrics performanceMetrics

 Measurements of how well the MLModel performed, using observations referenced by the
 DataSource. One of the following metrics is returned, based on the type of the MLModel:
 
 
 
 
 BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
 
 
 
 
 RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure
 performance. RMSE measures the difference between predicted and actual values for a single variable.
 
 
 
 
 MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.
 
 
 
 
 For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
 


message
String message

 A description of the most recent details about evaluating the MLModel.
 


computeTime
Long computeTime


finishedAt
Date finishedAt


startedAt
Date startedAt








Class com.amazonaws.services.machinelearning.model.GetBatchPredictionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


batchPredictionId
String batchPredictionId

 An ID assigned to the BatchPrediction at creation.
 








Class com.amazonaws.services.machinelearning.model.GetBatchPredictionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


batchPredictionId
String batchPredictionId

 An ID assigned to the BatchPrediction at creation. This value should be identical to the value of
 the BatchPredictionID in the request.
 


mLModelId
String mLModelId

 The ID of the MLModel that generated predictions for the BatchPrediction request.
 


batchPredictionDataSourceId
String batchPredictionDataSourceId

 The ID of the DataSource that was used to create the BatchPrediction.
 


inputDataLocationS3
String inputDataLocationS3

 The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
 


createdByIamUser
String createdByIamUser

 The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root
 account or an AWS Identity and Access Management (IAM) user account.
 


createdAt
Date createdAt

 The time when the BatchPrediction was created. The time is expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.
 


name
String name

 A user-supplied name or description of the BatchPrediction.
 


status
String status

 The status of the BatchPrediction, which can be one of the following values:
 
 
  PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.
 
  INPROGRESS - The batch predictions are in progress.
  FAILED - The request to perform a batch prediction did not run to completion. It is not usable.
  COMPLETED - The batch prediction process completed successfully.
  DELETED - The BatchPrediction is marked as deleted. It is not usable.
 


outputUri
String outputUri

 The location of an Amazon S3 bucket or directory to receive the operation results.
 


logUri
String logUri

 A link to the file that contains logs of the CreateBatchPrediction operation.
 


message
String message

 A description of the most recent details about processing the batch prediction request.
 


computeTime
Long computeTime

 The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the
 BatchPrediction, normalized and scaled on computation resources. ComputeTime is only
 available if the BatchPrediction is in the COMPLETED state.
 


finishedAt
Date finishedAt

 The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or
 FAILED. FinishedAt is only available when the BatchPrediction is in the
 COMPLETED or FAILED state.
 


startedAt
Date startedAt

 The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS.
 StartedAt isn't available if the BatchPrediction is in the PENDING state.
 


totalRecordCount
Long totalRecordCount

 The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.
 


invalidRecordCount
Long invalidRecordCount

 The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.
 








Class com.amazonaws.services.machinelearning.model.GetDataSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 The ID assigned to the DataSource at creation.
 


verbose
Boolean verbose

 Specifies whether the GetDataSource operation should return DataSourceSchema.
 
 
 If true, DataSourceSchema is returned.
 
 
 If false, DataSourceSchema is not returned.
 








Class com.amazonaws.services.machinelearning.model.GetDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 The ID assigned to the DataSource at creation. This value should be identical to the value of the
 DataSourceId in the request.
 


dataLocationS3
String dataLocationS3

 The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
 


dataRearrangement
String dataRearrangement

 A JSON string that represents the splitting and rearrangement requirement used when this DataSource
 was created.
 


createdByIamUser
String createdByIamUser

 The AWS user account from which the DataSource was created. The account type can be either an AWS
 root account or an AWS Identity and Access Management (IAM) user account.
 


createdAt
Date createdAt

 The time that the DataSource was created. The time is expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the DataSource. The time is expressed in epoch time.
 


dataSizeInBytes
Long dataSizeInBytes

 The total size of observations in the data files.
 


numberOfFiles
Long numberOfFiles

 The number of data files referenced by the DataSource.
 


name
String name

 A user-supplied name or description of the DataSource.
 


status
String status

 The current status of the DataSource. This element can have one of the following values:
 
 
  PENDING - Amazon ML submitted a request to create a DataSource.
  INPROGRESS - The creation process is underway.
  FAILED - The request to create a DataSource did not run to completion. It is not
 usable.
  COMPLETED - The creation process completed successfully.
  DELETED - The DataSource is marked as deleted. It is not usable.
 


logUri
String logUri

 A link to the file containing logs of CreateDataSourceFrom* operations.
 


message
String message

 The user-supplied description of the most recent details about creating the DataSource.
 


redshiftMetadata
RedshiftMetadata redshiftMetadata


rDSMetadata
RDSMetadata rDSMetadata


roleARN
String roleARN


computeStatistics
Boolean computeStatistics

 The parameter is true if statistics need to be generated from the observation data.
 


computeTime
Long computeTime

 The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the
 DataSource, normalized and scaled on computation resources. ComputeTime is only
 available if the DataSource is in the COMPLETED state and the
 ComputeStatistics is set to true.
 


finishedAt
Date finishedAt

 The epoch time when Amazon Machine Learning marked the DataSource as COMPLETED or
 FAILED. FinishedAt is only available when the DataSource is in the
 COMPLETED or FAILED state.
 


startedAt
Date startedAt

 The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS.
 StartedAt isn't available if the DataSource is in the PENDING state.
 


dataSourceSchema
String dataSourceSchema

 The schema used by all of the data files of this DataSource.
 
 Note
 
 This parameter is provided as part of the verbose format.
 
 








Class com.amazonaws.services.machinelearning.model.GetEvaluationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


evaluationId
String evaluationId

 The ID of the Evaluation to retrieve. The evaluation of each MLModel is recorded and
 cataloged. The ID provides the means to access the information.
 








Class com.amazonaws.services.machinelearning.model.GetEvaluationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


evaluationId
String evaluationId

 The evaluation ID which is same as the EvaluationId in the request.
 


mLModelId
String mLModelId

 The ID of the MLModel that was the focus of the evaluation.
 


evaluationDataSourceId
String evaluationDataSourceId

 The DataSource used for this evaluation.
 


inputDataLocationS3
String inputDataLocationS3

 The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
 


createdByIamUser
String createdByIamUser

 The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS
 Identity and Access Management (IAM) user account.
 


createdAt
Date createdAt

 The time that the Evaluation was created. The time is expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the Evaluation. The time is expressed in epoch time.
 


name
String name

 A user-supplied name or description of the Evaluation.
 


status
String status

 The status of the evaluation. This element can have one of the following values:
 
 
  PENDING - Amazon Machine Language (Amazon ML) submitted a request to evaluate an
 MLModel.
  INPROGRESS - The evaluation is underway.
  FAILED - The request to evaluate an MLModel did not run to completion. It is not
 usable.
  COMPLETED - The evaluation process completed successfully.
  DELETED - The Evaluation is marked as deleted. It is not usable.
 


performanceMetrics
PerformanceMetrics performanceMetrics

 Measurements of how well the MLModel performed using observations referenced by the
 DataSource. One of the following metric is returned based on the type of the MLModel:
 
 
 
 
 BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.
 
 
 
 
 RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure
 performance. RMSE measures the difference between predicted and actual values for a single variable.
 
 
 
 
 MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.
 
 
 
 
 For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.
 


logUri
String logUri

 A link to the file that contains logs of the CreateEvaluation operation.
 


message
String message

 A description of the most recent details about evaluating the MLModel.
 


computeTime
Long computeTime

 The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the
 Evaluation, normalized and scaled on computation resources. ComputeTime is only
 available if the Evaluation is in the COMPLETED state.
 


finishedAt
Date finishedAt

 The epoch time when Amazon Machine Learning marked the Evaluation as COMPLETED or
 FAILED. FinishedAt is only available when the Evaluation is in the
 COMPLETED or FAILED state.
 


startedAt
Date startedAt

 The epoch time when Amazon Machine Learning marked the Evaluation as INPROGRESS.
 StartedAt isn't available if the Evaluation is in the PENDING state.
 








Class com.amazonaws.services.machinelearning.model.GetMLModelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mLModelId
String mLModelId

 The ID assigned to the MLModel at creation.
 


verbose
Boolean verbose

 Specifies whether the GetMLModel operation should return Recipe.
 
 
 If true, Recipe is returned.
 
 
 If false, Recipe is not returned.
 








Class com.amazonaws.services.machinelearning.model.GetMLModelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


mLModelId
String mLModelId

 The MLModel ID, which is
 same as the MLModelId in the request.
 


trainingDataSourceId
String trainingDataSourceId

 The ID of the training DataSource.
 


createdByIamUser
String createdByIamUser

 The AWS user account from which the MLModel was created. The account type can be either an AWS root
 account or an AWS Identity and Access Management (IAM) user account.
 


createdAt
Date createdAt

 The time that the MLModel was created. The time is expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the MLModel. The time is expressed in epoch time.
 


name
String name

 A user-supplied name or description of the MLModel.
 


status
String status

 The current status of the MLModel. This element can have one of the following values:
 
 
  PENDING - Amazon Machine Learning (Amazon ML) submitted a request to describe a
 MLModel.
  INPROGRESS - The request is processing.
  FAILED - The request did not run to completion. The ML model isn't usable.
  COMPLETED - The request completed successfully.
  DELETED - The MLModel is marked as deleted. It isn't usable.
 


sizeInBytes
Long sizeInBytes


endpointInfo
RealtimeEndpointInfo endpointInfo

 The current endpoint of the MLModel
 


trainingParameters
SdkInternalMap<K,V> trainingParameters

 A list of the training parameters in the MLModel. The list is implemented as a map of key-value
 pairs.
 
 
 The following is the current set of training parameters:
 
 
 
 
 sgd.maxMLModelSizeInBytes - The 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.
 
 
 
 
 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.shuffleType - Whether Amazon ML shuffles the training data. Shuffling data improves a model's
 ability to find the optimal solution for a variety of data types. The valid values are auto and
 none. The default value is none. We strongly recommend that you shuffle your data.
 
 
 
 
 sgd.l1RegularizationAmount - The 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, 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 to not use L1
 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.
 
 
 
 
 sgd.l2RegularizationAmount - The 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 value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2
 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.
 
 
 


inputDataLocationS3
String inputDataLocationS3

 The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
 


mLModelType
String mLModelType

 Identifies the MLModel category. The following are the available types:
 
 
 REGRESSION -- Produces a numeric result. For example, "What price should a house be listed at?"
 BINARY -- Produces one of two possible results. For example, "Is this an e-commerce website?"
 MULTICLASS -- Produces one of several possible results. For example,
 "Is this a HIGH, LOW or MEDIUM risk trade?"
 


scoreThreshold
Float scoreThreshold

 The scoring threshold is used in binary classification MLModel models. It marks the boundary between a positive prediction
 and a negative prediction.
 
 
 Output values greater than or equal to the threshold receive a positive result from the MLModel, such as
 true. Output values less than the threshold receive a negative response from the MLModel, such as
 false.
 


scoreThresholdLastUpdatedAt
Date scoreThresholdLastUpdatedAt

 The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.
 


logUri
String logUri

 A link to the file that contains logs of the CreateMLModel operation.
 


message
String message

 A description of the most recent details about accessing the MLModel.
 


computeTime
Long computeTime

 The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the MLModel,
 normalized and scaled on computation resources. ComputeTime is only available if the
 MLModel is in the COMPLETED state.
 


finishedAt
Date finishedAt

 The epoch time when Amazon Machine Learning marked the MLModel as COMPLETED or
 FAILED. FinishedAt is only available when the MLModel is in the
 COMPLETED or FAILED state.
 


startedAt
Date startedAt

 The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS.
 StartedAt isn't available if the MLModel is in the PENDING state.
 


recipe
String recipe

 The recipe to use when training the MLModel. The Recipe provides detailed information
 about the observation data to use during training, and manipulations to perform on the observation data during
 training.
 
 Note
 
 This parameter is provided as part of the verbose format.
 
 


schema
String schema

 The schema used by all of the data files referenced by the DataSource.
 
 Note
 
 This parameter is provided as part of the verbose format.
 
 








Class com.amazonaws.services.machinelearning.model.IdempotentParameterMismatchException extends AmazonMachineLearningException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
Integer code








Class com.amazonaws.services.machinelearning.model.InternalServerException extends AmazonMachineLearningException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
Integer code








Class com.amazonaws.services.machinelearning.model.InvalidInputException extends AmazonMachineLearningException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
Integer code








Class com.amazonaws.services.machinelearning.model.InvalidTagException extends AmazonMachineLearningException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.machinelearning.model.LimitExceededException extends AmazonMachineLearningException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
Integer code








Class com.amazonaws.services.machinelearning.model.MLModel extends Object implements Serializable


Serialized Fields


mLModelId
String mLModelId

 The ID assigned to the MLModel at creation.
 


trainingDataSourceId
String trainingDataSourceId

 The ID of the training DataSource. The CreateMLModel operation uses the
 TrainingDataSourceId.
 


createdByIamUser
String createdByIamUser

 The AWS user account from which the MLModel was created. The account type can be either an AWS root
 account or an AWS Identity and Access Management (IAM) user account.
 


createdAt
Date createdAt

 The time that the MLModel was created. The time is expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the MLModel. The time is expressed in epoch time.
 


name
String name

 A user-supplied name or description of the MLModel.
 


status
String status

 The current status of an MLModel. This element can have one of the following values:
 
 
  PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create an
 MLModel.
  INPROGRESS - The creation process is underway.
  FAILED - The request to create an MLModel didn't run to completion. The model isn't
 usable.
  COMPLETED - The creation process completed successfully.
  DELETED - The MLModel is marked as deleted. It isn't usable.
 


sizeInBytes
Long sizeInBytes


endpointInfo
RealtimeEndpointInfo endpointInfo

 The current endpoint of the MLModel.
 


trainingParameters
SdkInternalMap<K,V> trainingParameters

 A list of the training parameters in the MLModel. The list is implemented as a map of key-value
 pairs.
 
 
 The following is the current set of training parameters:
 
 
 
 
 sgd.maxMLModelSizeInBytes - The 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.
 
 
 
 
 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.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a
 model's ability to find the optimal solution for a variety of data types. The valid values are auto
 and none. The default value is none.
 
 
 
 
 sgd.l1RegularizationAmount - The coefficient regularization L1 norm, which controls overfitting the
 data by penalizing large coefficients. This parameter 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 to not use L1
 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.
 
 
 
 
 sgd.l2RegularizationAmount - The coefficient regularization L2 norm, which 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 value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2
 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.
 
 
 


inputDataLocationS3
String inputDataLocationS3

 The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).
 


algorithm
String algorithm

 The algorithm used to train the MLModel. The following algorithm is supported:
 
 
  SGD -- Stochastic gradient descent. The goal of SGD is to minimize the gradient of
 the loss function.
 


mLModelType
String mLModelType

 Identifies the MLModel category. The following are the available types:
 
 
  REGRESSION - Produces a numeric result. For example, "What price should a house be listed at?"
  BINARY - Produces one of two possible results. For example,
 "Is this a child-friendly web site?".
  MULTICLASS - Produces one of several possible results. For example,
 "Is this a HIGH-, LOW-, or MEDIUM-risk trade?".
 


scoreThreshold
Float scoreThreshold


scoreThresholdLastUpdatedAt
Date scoreThresholdLastUpdatedAt

 The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.
 


message
String message

 A description of the most recent details about accessing the MLModel.
 


computeTime
Long computeTime


finishedAt
Date finishedAt


startedAt
Date startedAt








Class com.amazonaws.services.machinelearning.model.PerformanceMetrics extends Object implements Serializable


Serialized Fields


properties
SdkInternalMap<K,V> properties








Class com.amazonaws.services.machinelearning.model.Prediction extends Object implements Serializable


Serialized Fields


predictedLabel
String predictedLabel

 The prediction label for either a BINARY or MULTICLASS MLModel.
 


predictedValue
Float predictedValue
The prediction value for REGRESSION MLModel.


predictedScores
SdkInternalMap<K,V> predictedScores


details
SdkInternalMap<K,V> details








Class com.amazonaws.services.machinelearning.model.PredictorNotMountedException extends AmazonMachineLearningException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.machinelearning.model.PredictRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mLModelId
String mLModelId

 A unique identifier of the MLModel.
 


record
SdkInternalMap<K,V> record


predictEndpoint
String predictEndpoint








Class com.amazonaws.services.machinelearning.model.PredictResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


prediction
Prediction prediction








Class com.amazonaws.services.machinelearning.model.RDSDatabase extends Object implements Serializable


Serialized Fields


instanceIdentifier
String instanceIdentifier

 The ID of an RDS DB instance.
 


databaseName
String databaseName








Class com.amazonaws.services.machinelearning.model.RDSDatabaseCredentials extends Object implements Serializable


Serialized Fields


username
String username


password
String password








Class com.amazonaws.services.machinelearning.model.RDSDataSpec extends Object implements Serializable


Serialized Fields


databaseInformation
RDSDatabase databaseInformation

 Describes the DatabaseName and InstanceIdentifier of an Amazon RDS database.
 


selectSqlQuery
String selectSqlQuery

 The query that is used to retrieve the observation data for the DataSource.
 


databaseCredentials
RDSDatabaseCredentials databaseCredentials

 The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.
 


s3StagingLocation
String s3StagingLocation

 The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using
 SelectSqlQuery is stored in this location.
 


dataRearrangement
String dataRearrangement

 A JSON string that represents the splitting and rearrangement processing to be applied to a
 DataSource. If the DataRearrangement parameter is not provided, all of the input data
 is used to create the Datasource.
 
 
 There are multiple parameters that control what data is used to create a datasource:
 
 
 
 
 percentBegin
 
 
 Use percentBegin to indicate the beginning of the range of the data used to create the Datasource.
 If you do not include percentBegin and percentEnd, Amazon ML includes all of the data
 when creating the datasource.
 
 
 
 
 percentEnd
 
 
 Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do
 not include percentBegin and percentEnd, Amazon ML includes all of the data when
 creating the datasource.
 
 
 
 
 complement
 
 
 The complement parameter instructs Amazon ML to use the data that is not included in the range of
 percentBegin to percentEnd to create a datasource. The complement
 parameter is useful if you need to create complementary datasources for training and evaluation. To create a
 complementary datasource, use the same values for percentBegin and percentEnd, along
 with the complement parameter.
 
 
 For example, the following two datasources do not share any data, and can be used to train and evaluate a model.
 The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
 
 
 Datasource for evaluation: {"splitting":{"percentBegin":0, "percentEnd":25}}
 
 
 Datasource for training: {"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}
 
 
 
 
 strategy
 
 
 To change how Amazon ML splits the data for a datasource, use the strategy parameter.
 
 
 The default value for the strategy parameter is sequential, meaning that Amazon ML
 takes all of the data records between the percentBegin and percentEnd parameters for
 the datasource, in the order that the records appear in the input data.
 
 
 The following two DataRearrangement lines are examples of sequentially ordered training and
 evaluation datasources:
 
 
 Datasource for evaluation:
 {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}
 
 
 Datasource for training:
 {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}
 
 
 To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters,
 set the strategy parameter to random and provide a string that is used as the seed
 value for the random data splitting (for example, you can use the S3 path to your data as the random seed
 string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number
 between 0 and 100, and then selects the rows that have an assigned number between percentBegin and
 percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte
 offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The
 random splitting strategy ensures that variables in the training and evaluation data are distributed similarly.
 It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in
 training and evaluation datasources containing non-similar data records.
 
 
 The following two DataRearrangement lines are examples of non-sequentially ordered training and
 evaluation datasources:
 
 
 Datasource for evaluation:
 {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}
 
 
 Datasource for training:
 {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}
 
 
 


dataSchema
String dataSchema

 A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema
 defines the structure of the observation data in the data file(s) referenced in the DataSource.
 
 
 A DataSchema is not required if you specify a DataSchemaUri
 
 
 Define your DataSchema as a series of key-value pairs. attributes and
 excludedVariableNames have an array of key-value pairs for their value. Use the following format to
 define your DataSchema.
 
 
 { "version": "1.0",
 
 
 "recordAnnotationFieldName": "F1",
 
 
 "recordWeightFieldName": "F2",
 
 
 "targetFieldName": "F3",
 
 
 "dataFormat": "CSV",
 
 
 "dataFileContainsHeader": true,
 
 
 "attributes": [
 
 
 { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3",
 "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType":
 "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType":
 "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],
 
 
 "excludedVariableNames": [ "F6" ] }
 
 


dataSchemaUri
String dataSchemaUri

 The Amazon S3 location of the DataSchema.
 


resourceRole
String resourceRole

 The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to
 carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for
 data pipelines.
 


serviceRole
String serviceRole

 The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task
 from Amazon RDS to Amazon S3. For more information, see Role templates for
 data pipelines.
 


subnetId
String subnetId

 The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry
 out the copy task from Amazon RDS to Amazon S3.
 


securityGroupIds
SdkInternalList<T> securityGroupIds

 The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate
 ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out
 the copy operation from Amazon RDS to an Amazon S3 task.
 








Class com.amazonaws.services.machinelearning.model.RDSMetadata extends Object implements Serializable


Serialized Fields


database
RDSDatabase database

 The database details required to connect to an Amazon RDS.
 


databaseUserName
String databaseUserName


selectSqlQuery
String selectSqlQuery

 The SQL query that is supplied during CreateDataSourceFromRDS. Returns only if Verbose is
 true in GetDataSourceInput.
 


resourceRole
String resourceRole

 The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from
 Amazon RDS to Amazon S3. For more information, see Role templates for
 data pipelines.
 


serviceRole
String serviceRole

 The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task
 from Amazon RDS to Amazon S3. For more information, see Role templates for
 data pipelines.
 


dataPipelineId
String dataPipelineId

 The ID of the Data Pipeline instance that is used to carry to copy data from Amazon RDS to Amazon S3. You can use
 the ID to find details about the instance in the Data Pipeline console.
 








Class com.amazonaws.services.machinelearning.model.RealtimeEndpointInfo extends Object implements Serializable


Serialized Fields


peakRequestsPerSecond
Integer peakRequestsPerSecond

 The maximum processing rate for the real-time endpoint for MLModel, measured in incoming requests
 per second.
 


createdAt
Date createdAt

 The time that the request to create the real-time endpoint for the MLModel was received. The time is
 expressed in epoch time.
 


endpointUrl
String endpointUrl

 The URI that specifies where to send real-time prediction requests for the MLModel.
 
 Note
 
 The application must wait until the real-time endpoint is ready before using this URI.
 
 


endpointStatus
String endpointStatus

 The current status of the real-time endpoint for the MLModel. This element can have one of the
 following values:
 
 
  NONE - Endpoint does not exist or was previously deleted.
  READY - Endpoint is ready to be used for real-time predictions.
  UPDATING - Updating/creating the endpoint.
 








Class com.amazonaws.services.machinelearning.model.RedshiftDatabase extends Object implements Serializable


Serialized Fields


databaseName
String databaseName


clusterIdentifier
String clusterIdentifier








Class com.amazonaws.services.machinelearning.model.RedshiftDatabaseCredentials extends Object implements Serializable


Serialized Fields


username
String username


password
String password








Class com.amazonaws.services.machinelearning.model.RedshiftDataSpec extends Object implements Serializable


Serialized Fields


databaseInformation
RedshiftDatabase databaseInformation

 Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift
 DataSource.
 


selectSqlQuery
String selectSqlQuery

 Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift DataSource.
 


databaseCredentials
RedshiftDatabaseCredentials databaseCredentials

 Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift
 database.
 


s3StagingLocation
String s3StagingLocation

 Describes an Amazon S3 location to store the result set of the SelectSqlQuery query.
 


dataRearrangement
String dataRearrangement

 A JSON string that represents the splitting and rearrangement processing to be applied to a
 DataSource. If the DataRearrangement parameter is not provided, all of the input data
 is used to create the Datasource.
 
 
 There are multiple parameters that control what data is used to create a datasource:
 
 
 
 
 percentBegin
 
 
 Use percentBegin to indicate the beginning of the range of the data used to create the Datasource.
 If you do not include percentBegin and percentEnd, Amazon ML includes all of the data
 when creating the datasource.
 
 
 
 
 percentEnd
 
 
 Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do
 not include percentBegin and percentEnd, Amazon ML includes all of the data when
 creating the datasource.
 
 
 
 
 complement
 
 
 The complement parameter instructs Amazon ML to use the data that is not included in the range of
 percentBegin to percentEnd to create a datasource. The complement
 parameter is useful if you need to create complementary datasources for training and evaluation. To create a
 complementary datasource, use the same values for percentBegin and percentEnd, along
 with the complement parameter.
 
 
 For example, the following two datasources do not share any data, and can be used to train and evaluate a model.
 The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
 
 
 Datasource for evaluation: {"splitting":{"percentBegin":0, "percentEnd":25}}
 
 
 Datasource for training: {"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}
 
 
 
 
 strategy
 
 
 To change how Amazon ML splits the data for a datasource, use the strategy parameter.
 
 
 The default value for the strategy parameter is sequential, meaning that Amazon ML
 takes all of the data records between the percentBegin and percentEnd parameters for
 the datasource, in the order that the records appear in the input data.
 
 
 The following two DataRearrangement lines are examples of sequentially ordered training and
 evaluation datasources:
 
 
 Datasource for evaluation:
 {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}
 
 
 Datasource for training:
 {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}
 
 
 To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters,
 set the strategy parameter to random and provide a string that is used as the seed
 value for the random data splitting (for example, you can use the S3 path to your data as the random seed
 string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number
 between 0 and 100, and then selects the rows that have an assigned number between percentBegin and
 percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte
 offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The
 random splitting strategy ensures that variables in the training and evaluation data are distributed similarly.
 It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in
 training and evaluation datasources containing non-similar data records.
 
 
 The following two DataRearrangement lines are examples of non-sequentially ordered training and
 evaluation datasources:
 
 
 Datasource for evaluation:
 {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}
 
 
 Datasource for training:
 {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}
 
 
 


dataSchema
String dataSchema

 A JSON string that represents the schema for an Amazon Redshift DataSource. The
 DataSchema defines the structure of the observation data in the data file(s) referenced in the
 DataSource.
 
 
 A DataSchema is not required if you specify a DataSchemaUri.
 
 
 Define your DataSchema as a series of key-value pairs. attributes and
 excludedVariableNames have an array of key-value pairs for their value. Use the following format to
 define your DataSchema.
 
 
 { "version": "1.0",
 
 
 "recordAnnotationFieldName": "F1",
 
 
 "recordWeightFieldName": "F2",
 
 
 "targetFieldName": "F3",
 
 
 "dataFormat": "CSV",
 
 
 "dataFileContainsHeader": true,
 
 
 "attributes": [
 
 
 { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3",
 "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType":
 "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType":
 "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],
 
 
 "excludedVariableNames": [ "F6" ] }
 


dataSchemaUri
String dataSchemaUri

 Describes the schema location for an Amazon Redshift DataSource.
 








Class com.amazonaws.services.machinelearning.model.RedshiftMetadata extends Object implements Serializable


Serialized Fields


redshiftDatabase
RedshiftDatabase redshiftDatabase


databaseUserName
String databaseUserName


selectSqlQuery
String selectSqlQuery

 The SQL query that is specified during CreateDataSourceFromRedshift. Returns only if Verbose
 is true in GetDataSourceInput.
 








Class com.amazonaws.services.machinelearning.model.ResourceNotFoundException extends AmazonMachineLearningException implements Serializable

serialVersionUID:
1L



Serialized Fields


code
Integer code








Class com.amazonaws.services.machinelearning.model.S3DataSpec extends Object implements Serializable


Serialized Fields


dataLocationS3
String dataLocationS3

 The location of the data file(s) used by a DataSource. The URI specifies a data file or an Amazon
 Simple Storage Service (Amazon S3) directory or bucket containing data files.
 


dataRearrangement
String dataRearrangement

 A JSON string that represents the splitting and rearrangement processing to be applied to a
 DataSource. If the DataRearrangement parameter is not provided, all of the input data
 is used to create the Datasource.
 
 
 There are multiple parameters that control what data is used to create a datasource:
 
 
 
 
 percentBegin
 
 
 Use percentBegin to indicate the beginning of the range of the data used to create the Datasource.
 If you do not include percentBegin and percentEnd, Amazon ML includes all of the data
 when creating the datasource.
 
 
 
 
 percentEnd
 
 
 Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do
 not include percentBegin and percentEnd, Amazon ML includes all of the data when
 creating the datasource.
 
 
 
 
 complement
 
 
 The complement parameter instructs Amazon ML to use the data that is not included in the range of
 percentBegin to percentEnd to create a datasource. The complement
 parameter is useful if you need to create complementary datasources for training and evaluation. To create a
 complementary datasource, use the same values for percentBegin and percentEnd, along
 with the complement parameter.
 
 
 For example, the following two datasources do not share any data, and can be used to train and evaluate a model.
 The first datasource has 25 percent of the data, and the second one has 75 percent of the data.
 
 
 Datasource for evaluation: {"splitting":{"percentBegin":0, "percentEnd":25}}
 
 
 Datasource for training: {"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}
 
 
 
 
 strategy
 
 
 To change how Amazon ML splits the data for a datasource, use the strategy parameter.
 
 
 The default value for the strategy parameter is sequential, meaning that Amazon ML
 takes all of the data records between the percentBegin and percentEnd parameters for
 the datasource, in the order that the records appear in the input data.
 
 
 The following two DataRearrangement lines are examples of sequentially ordered training and
 evaluation datasources:
 
 
 Datasource for evaluation:
 {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}
 
 
 Datasource for training:
 {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}
 
 
 To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters,
 set the strategy parameter to random and provide a string that is used as the seed
 value for the random data splitting (for example, you can use the S3 path to your data as the random seed
 string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number
 between 0 and 100, and then selects the rows that have an assigned number between percentBegin and
 percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte
 offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The
 random splitting strategy ensures that variables in the training and evaluation data are distributed similarly.
 It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in
 training and evaluation datasources containing non-similar data records.
 
 
 The following two DataRearrangement lines are examples of non-sequentially ordered training and
 evaluation datasources:
 
 
 Datasource for evaluation:
 {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}
 
 
 Datasource for training:
 {"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}
 
 
 


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.
 
 
 You must provide either the DataSchema or the DataSchemaLocationS3.
 
 
 Define your DataSchema as a series of key-value pairs. attributes and
 excludedVariableNames have an array of key-value pairs for their value. Use the following format to
 define your DataSchema.
 
 
 { "version": "1.0",
 
 
 "recordAnnotationFieldName": "F1",
 
 
 "recordWeightFieldName": "F2",
 
 
 "targetFieldName": "F3",
 
 
 "dataFormat": "CSV",
 
 
 "dataFileContainsHeader": true,
 
 
 "attributes": [
 
 
 { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3",
 "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType":
 "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType":
 "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],
 
 
 "excludedVariableNames": [ "F6" ] }
 
 


dataSchemaLocationS3
String dataSchemaLocationS3

 Describes the schema location in Amazon S3. You must provide either the DataSchema or the
 DataSchemaLocationS3.
 








Class com.amazonaws.services.machinelearning.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A unique identifier for the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -,
 %, and @.
 


value
String value

 An optional string, typically used to describe or define the tag. Valid characters include Unicode letters,
 digits, white space, _, ., /, =, +, -, %, and @.
 








Class com.amazonaws.services.machinelearning.model.TagLimitExceededException extends AmazonMachineLearningException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.machinelearning.model.UpdateBatchPredictionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


batchPredictionId
String batchPredictionId

 The ID assigned to the BatchPrediction during creation.
 


batchPredictionName
String batchPredictionName

 A new user-supplied name or description of the BatchPrediction.
 








Class com.amazonaws.services.machinelearning.model.UpdateBatchPredictionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


batchPredictionId
String batchPredictionId

 The ID assigned to the BatchPrediction during creation. This value should be identical to the value
 of the BatchPredictionId in the request.
 








Class com.amazonaws.services.machinelearning.model.UpdateDataSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 The ID assigned to the DataSource during creation.
 


dataSourceName
String dataSourceName

 A new user-supplied name or description of the DataSource that will replace the current description.
 








Class com.amazonaws.services.machinelearning.model.UpdateDataSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataSourceId
String dataSourceId

 The ID assigned to the DataSource during creation. This value should be identical to the value of
 the DataSourceID in the request.
 








Class com.amazonaws.services.machinelearning.model.UpdateEvaluationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


evaluationId
String evaluationId

 The ID assigned to the Evaluation during creation.
 


evaluationName
String evaluationName

 A new user-supplied name or description of the Evaluation that will replace the current content.
 








Class com.amazonaws.services.machinelearning.model.UpdateEvaluationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


evaluationId
String evaluationId

 The ID assigned to the Evaluation during creation. This value should be identical to the value of
 the Evaluation in the request.
 








Class com.amazonaws.services.machinelearning.model.UpdateMLModelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


mLModelId
String mLModelId

 The ID assigned to the MLModel during creation.
 


mLModelName
String mLModelName

 A user-supplied name or description of the MLModel.
 


scoreThreshold
Float scoreThreshold

 The ScoreThreshold used in binary classification MLModel that marks the boundary
 between a positive prediction and a negative prediction.
 
 
 Output values greater than or equal to the ScoreThreshold receive a positive result from the
 MLModel, such as true. Output values less than the ScoreThreshold receive
 a negative response from the MLModel, such as false.
 








Class com.amazonaws.services.machinelearning.model.UpdateMLModelResult extends AmazonWebServiceResult<ResponseMetadata> 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.macie.model




Class com.amazonaws.services.macie.model.AccessDeniedException extends AmazonMacieException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceType
String resourceType








Class com.amazonaws.services.macie.model.AmazonMacieException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.macie.model.AssociateMemberAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


memberAccountId
String memberAccountId

 The ID of the AWS account that you want to associate with Amazon Macie as a member account.
 








Class com.amazonaws.services.macie.model.AssociateMemberAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.macie.model.AssociateS3ResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


memberAccountId
String memberAccountId

 The ID of the Amazon Macie member account whose resources you want to associate with Macie.
 


s3Resources
List<E> s3Resources

 The S3 resources that you want to associate with Amazon Macie for monitoring and data classification.
 








Class com.amazonaws.services.macie.model.AssociateS3ResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedS3Resources
List<E> failedS3Resources

 S3 resources that couldn't be associated with Amazon Macie. An error code and an error message are provided for
 each failed item.
 








Class com.amazonaws.services.macie.model.ClassificationType extends Object implements Serializable


Serialized Fields


oneTime
String oneTime

 A one-time classification of all of the existing objects in a specified S3 bucket.
 


continuous
String continuous

 A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins
 performing continuous classification after a bucket is successfully associated with Amazon Macie.
 








Class com.amazonaws.services.macie.model.ClassificationTypeUpdate extends Object implements Serializable


Serialized Fields


oneTime
String oneTime

 A one-time classification of all of the existing objects in a specified S3 bucket.
 


continuous
String continuous

 A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins
 performing continuous classification after a bucket is successfully associated with Amazon Macie.
 








Class com.amazonaws.services.macie.model.DisassociateMemberAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


memberAccountId
String memberAccountId

 The ID of the member account that you want to remove from Amazon Macie.
 








Class com.amazonaws.services.macie.model.DisassociateMemberAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.macie.model.DisassociateS3ResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


memberAccountId
String memberAccountId

 The ID of the Amazon Macie member account whose resources you want to remove from being monitored by Amazon
 Macie.
 


associatedS3Resources
List<E> associatedS3Resources

 The S3 resources (buckets or prefixes) that you want to remove from being monitored and classified by Amazon
 Macie.
 








Class com.amazonaws.services.macie.model.DisassociateS3ResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedS3Resources
List<E> failedS3Resources

 S3 resources that couldn't be removed from being monitored and classified by Amazon Macie. An error code and an
 error message are provided for each failed item.
 








Class com.amazonaws.services.macie.model.FailedS3Resource extends Object implements Serializable


Serialized Fields


failedItem
S3Resource failedItem

 The failed S3 resources.
 


errorCode
String errorCode

 The status code of a failed item.
 


errorMessage
String errorMessage

 The error message of a failed item.
 








Class com.amazonaws.services.macie.model.InternalException extends AmazonMacieException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.macie.model.InvalidInputException extends AmazonMacieException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode


fieldName
String fieldName








Class com.amazonaws.services.macie.model.LimitExceededException extends AmazonMacieException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorCode
String errorCode


resourceType
String resourceType








Class com.amazonaws.services.macie.model.ListMemberAccountsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 Use this parameter when paginating results. Set the value of this parameter to null on your first call to the
 ListMemberAccounts action. Subsequent calls to the action fill nextToken in the request with the value of
 nextToken from the previous response to continue listing data.
 


maxResults
Integer maxResults

 Use this parameter to indicate the maximum number of items that you want in the response. The default value is
 250.
 








Class com.amazonaws.services.macie.model.ListMemberAccountsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


memberAccounts
List<E> memberAccounts

 A list of the Amazon Macie member accounts returned by the action. The current master account is also included in
 this list.
 


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.macie.model.ListS3ResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


memberAccountId
String memberAccountId

 The Amazon Macie member account ID whose associated S3 resources you want to list.
 


nextToken
String nextToken

 Use this parameter when paginating results. Set its value to null on your first call to the ListS3Resources
 action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the
 previous response to continue listing data.
 


maxResults
Integer maxResults

 Use this parameter to indicate the maximum number of items that you want in the response. The default value is
 250.
 








Class com.amazonaws.services.macie.model.ListS3ResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


s3Resources
List<E> s3Resources

 A list of the associated S3 resources 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.macie.model.MemberAccount extends Object implements Serializable


Serialized Fields


accountId
String accountId

 The AWS account ID of the Amazon Macie member account.
 








Class com.amazonaws.services.macie.model.S3Resource extends Object implements Serializable


Serialized Fields


bucketName
String bucketName

 The name of the S3 bucket.
 


prefix
String prefix

 The prefix of the S3 bucket.
 








Class com.amazonaws.services.macie.model.S3ResourceClassification extends Object implements Serializable


Serialized Fields


bucketName
String bucketName

 The name of the S3 bucket that you want to associate with Amazon Macie.
 


prefix
String prefix

 The prefix of the S3 bucket that you want to associate with Amazon Macie.
 


classificationType
ClassificationType classificationType

 The classification type that you want to specify for the resource associated with Amazon Macie.
 








Class com.amazonaws.services.macie.model.S3ResourceClassificationUpdate extends Object implements Serializable


Serialized Fields


bucketName
String bucketName

 The name of the S3 bucket whose classification types you want to update.
 


prefix
String prefix

 The prefix of the S3 bucket whose classification types you want to update.
 


classificationTypeUpdate
ClassificationTypeUpdate classificationTypeUpdate

 The classification type that you want to update for the resource associated with Amazon Macie.
 








Class com.amazonaws.services.macie.model.UpdateS3ResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


memberAccountId
String memberAccountId

 The AWS ID of the Amazon Macie member account whose S3 resources' classification types you want to update.
 


s3ResourcesUpdate
List<E> s3ResourcesUpdate

 The S3 resources whose classification types you want to update.
 








Class com.amazonaws.services.macie.model.UpdateS3ResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


failedS3Resources
List<E> failedS3Resources

 The S3 resources whose classification types can't be updated. An error code and an error message are provided for
 each failed item.
 








Package com.amazonaws.services.managedblockchain.model




Class com.amazonaws.services.managedblockchain.model.AccessDeniedException extends AmazonManagedBlockchainException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.managedblockchain.model.AmazonManagedBlockchainException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.managedblockchain.model.ApprovalThresholdPolicy extends Object implements Serializable


Serialized Fields


thresholdPercentage
Integer thresholdPercentage

 The percentage of votes among all members that must be YES for a proposal to be approved. For
 example, a ThresholdPercentage value of 50 indicates 50%. The
 ThresholdComparator determines the precise comparison. If a ThresholdPercentage value
 of 50 is specified on a network with 10 members, along with a ThresholdComparator value
 of GREATER_THAN, this indicates that 6 YES votes are required for the proposal to be
 approved.
 


proposalDurationInHours
Integer proposalDurationInHours

 The duration from the time that a proposal is created until it expires. If members cast neither the required
 number of YES votes to approve the proposal nor the number of NO votes required to
 reject it before the duration expires, the proposal is EXPIRED and ProposalActions are
 not carried out.
 


thresholdComparator
String thresholdComparator

 Determines whether the vote percentage must be greater than the ThresholdPercentage or must be
 greater than or equal to the ThreholdPercentage to be approved.
 








Class com.amazonaws.services.managedblockchain.model.CreateMemberRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientRequestToken
String clientRequestToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent
 operation completes no more than one time. This identifier is required only if you make a service request
 directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.
 


invitationId
String invitationId

 The unique identifier of the invitation that is sent to the member to join the network.
 


networkId
String networkId

 The unique identifier of the network in which the member is created.
 


memberConfiguration
MemberConfiguration memberConfiguration

 Member configuration parameters.
 








Class com.amazonaws.services.managedblockchain.model.CreateMemberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


memberId
String memberId

 The unique identifier of the member.
 








Class com.amazonaws.services.managedblockchain.model.CreateNetworkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientRequestToken
String clientRequestToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent
 operation completes no more than one time. This identifier is required only if you make a service request
 directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.
 


name
String name

 The name of the network.
 


description
String description

 An optional description for the network.
 


framework
String framework

 The blockchain framework that the network uses.
 


frameworkVersion
String frameworkVersion

 The version of the blockchain framework that the network uses.
 


frameworkConfiguration
NetworkFrameworkConfiguration frameworkConfiguration

 Configuration properties of the blockchain framework relevant to the network configuration.
 


votingPolicy
VotingPolicy votingPolicy

 The voting rules used by the network to determine if a proposal is approved.
 


memberConfiguration
MemberConfiguration memberConfiguration

 Configuration properties for the first member within the network.
 








Class com.amazonaws.services.managedblockchain.model.CreateNetworkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier for the network.
 


memberId
String memberId

 The unique identifier for the first member within the network.
 








Class com.amazonaws.services.managedblockchain.model.CreateNodeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientRequestToken
String clientRequestToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent
 operation completes no more than one time. This identifier is required only if you make a service request
 directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.
 


networkId
String networkId

 The unique identifier of the network in which this node runs.
 


memberId
String memberId

 The unique identifier of the member that owns this node.
 


nodeConfiguration
NodeConfiguration nodeConfiguration

 The properties of a node configuration.
 








Class com.amazonaws.services.managedblockchain.model.CreateNodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nodeId
String nodeId

 The unique identifier of the node.
 








Class com.amazonaws.services.managedblockchain.model.CreateProposalRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


clientRequestToken
String clientRequestToken

 A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent
 operation completes no more than one time. This identifier is required only if you make a service request
 directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.
 


networkId
String networkId

 The unique identifier of the network for which the proposal is made.
 


memberId
String memberId

 The unique identifier of the member that is creating the proposal. This identifier is especially useful for
 identifying the member making the proposal when multiple members exist in a single AWS account.
 


actions
ProposalActions actions

 The type of actions proposed, such as inviting a member or removing a member. The types of Actions
 in a proposal are mutually exclusive. For example, a proposal with Invitations actions cannot also
 contain Removals actions.
 


description
String description

 A description for the proposal that is visible to voting members, for example,
 "Proposal to add Example Corp. as member."
 








Class com.amazonaws.services.managedblockchain.model.CreateProposalResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


proposalId
String proposalId

 The unique identifier of the proposal.
 








Class com.amazonaws.services.managedblockchain.model.DeleteMemberRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network from which the member is removed.
 


memberId
String memberId

 The unique identifier of the member to remove.
 








Class com.amazonaws.services.managedblockchain.model.DeleteMemberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.managedblockchain.model.DeleteNodeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network that the node belongs to.
 


memberId
String memberId

 The unique identifier of the member that owns this node.
 


nodeId
String nodeId

 The unique identifier of the node.
 








Class com.amazonaws.services.managedblockchain.model.DeleteNodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.managedblockchain.model.GetMemberRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network to which the member belongs.
 


memberId
String memberId

 The unique identifier of the member.
 








Class com.amazonaws.services.managedblockchain.model.GetMemberResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


member
Member member

 The properties of a member.
 








Class com.amazonaws.services.managedblockchain.model.GetNetworkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network to get information about.
 








Class com.amazonaws.services.managedblockchain.model.GetNetworkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


network
Network network

 An object containing network configuration parameters.
 








Class com.amazonaws.services.managedblockchain.model.GetNodeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network to which the node belongs.
 


memberId
String memberId

 The unique identifier of the member that owns the node.
 


nodeId
String nodeId

 The unique identifier of the node.
 








Class com.amazonaws.services.managedblockchain.model.GetNodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


node
Node node

 Properties of the node configuration.
 








Class com.amazonaws.services.managedblockchain.model.GetProposalRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network for which the proposal is made.
 


proposalId
String proposalId

 The unique identifier of the proposal.
 








Class com.amazonaws.services.managedblockchain.model.GetProposalResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


proposal
Proposal proposal

 Information about a proposal.
 








Class com.amazonaws.services.managedblockchain.model.IllegalActionException extends AmazonManagedBlockchainException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.managedblockchain.model.InternalServiceErrorException extends AmazonManagedBlockchainException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.managedblockchain.model.InvalidRequestException extends AmazonManagedBlockchainException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.managedblockchain.model.Invitation extends Object implements Serializable


Serialized Fields


invitationId
String invitationId

 The unique identifier for the invitation.
 


creationDate
Date creationDate

 The date and time that the invitation was created.
 


expirationDate
Date expirationDate

 The date and time that the invitation expires. This is the CreationDate plus the
 ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this
 date and time, the invitee can no longer create a member and join the network using this
 InvitationId.
 


status
String status

 The status of the invitation:
 
 
 
 
 PENDING - The invitee has not created a member to join the network, and the invitation has not yet
 expired.
 
 
 
 
 ACCEPTING - The invitee has begun creating a member, and creation has not yet completed.
 
 
 
 
 ACCEPTED - The invitee created a member and joined the network using the InvitationID.
 
 
 
 
 REJECTED - The invitee rejected the invitation.
 
 
 
 
 EXPIRED - The invitee neither created a member nor rejected the invitation before the
 ExpirationDate.
 
 
 


networkSummary
NetworkSummary networkSummary








Class com.amazonaws.services.managedblockchain.model.InviteAction extends Object implements Serializable


Serialized Fields


principal
String principal

 The AWS account ID to invite.
 








Class com.amazonaws.services.managedblockchain.model.ListInvitationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 The maximum number of invitations to return.
 


nextToken
String nextToken

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.managedblockchain.model.ListInvitationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


invitations
List<E> invitations

 The invitations for the network.
 


nextToken
String nextToken

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.managedblockchain.model.ListMembersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network for which to list members.
 


name
String name

 The optional name of the member to list.
 


status
String status

 An optional status specifier. If provided, only members currently in this status are listed.
 


isOwned
Boolean isOwned

 An optional Boolean value. If provided, the request is limited either to members that the current AWS account
 owns (true) or that other AWS accounts own (false). If omitted, all members are listed.
 


maxResults
Integer maxResults

 The maximum number of members to return in the request.
 


nextToken
String nextToken

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.managedblockchain.model.ListMembersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


members
List<E> members

 An array of MemberSummary objects. Each object contains details about a network member.
 


nextToken
String nextToken

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.managedblockchain.model.ListNetworksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name of the network.
 


framework
String framework

 An optional framework specifier. If provided, only networks of this framework type are listed.
 


status
String status

 An optional status specifier. If provided, only networks currently in this status are listed.
 


maxResults
Integer maxResults

 The maximum number of networks to list.
 


nextToken
String nextToken

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.managedblockchain.model.ListNetworksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


networks
List<E> networks

 An array of NetworkSummary objects that contain configuration properties for each network.
 


nextToken
String nextToken

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.managedblockchain.model.ListNodesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network for which to list nodes.
 


memberId
String memberId

 The unique identifier of the member who owns the nodes to list.
 


status
String status

 An optional status specifier. If provided, only nodes currently in this status are listed.
 


maxResults
Integer maxResults

 The maximum number of nodes to list.
 


nextToken
String nextToken

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.managedblockchain.model.ListNodesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nodes
List<E> nodes

 An array of NodeSummary objects that contain configuration properties for each node.
 


nextToken
String nextToken

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.managedblockchain.model.ListProposalsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network.
 


maxResults
Integer maxResults

 The maximum number of proposals to return.
 


nextToken
String nextToken

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.managedblockchain.model.ListProposalsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


proposals
List<E> proposals

 The summary of each proposal made on the network.
 


nextToken
String nextToken

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.managedblockchain.model.ListProposalVotesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network.
 


proposalId
String proposalId

 The unique identifier of the proposal.
 


maxResults
Integer maxResults

 The maximum number of votes to return.
 


nextToken
String nextToken

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.managedblockchain.model.ListProposalVotesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


proposalVotes
List<E> proposalVotes

 The listing of votes.
 


nextToken
String nextToken

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.managedblockchain.model.Member extends Object implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network to which the member belongs.
 


id
String id

 The unique identifier of the member.
 


name
String name

 The name of the member.
 


description
String description

 An optional description for the member.
 


frameworkAttributes
MemberFrameworkAttributes frameworkAttributes

 Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.
 


status
String status

 The status of a member.
 
 
 
 
 CREATING - The AWS account is in the process of creating a member.
 
 
 
 
 AVAILABLE - The member has been created and can participate in the network.
 
 
 
 
 CREATE_FAILED - The AWS account attempted to create a member and creation failed.
 
 
 
 
 DELETING - The member and all associated resources are in the process of being deleted. Either the
 AWS account that owns the member deleted it, or the member is being deleted as the result of an
 APPROVED PROPOSAL to remove the member.
 
 
 
 
 DELETED - The member can no longer participate on the network and all associated resources are
 deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of
 an APPROVED PROPOSAL to remove the member.
 
 
 


creationDate
Date creationDate

 The date and time that the member was created.
 








Class com.amazonaws.services.managedblockchain.model.MemberConfiguration extends Object implements Serializable


Serialized Fields


name
String name

 The name of the member.
 


description
String description

 An optional description of the member.
 


frameworkConfiguration
MemberFrameworkConfiguration frameworkConfiguration

 Configuration properties of the blockchain framework relevant to the member.
 








Class com.amazonaws.services.managedblockchain.model.MemberFabricAttributes extends Object implements Serializable


Serialized Fields


adminUsername
String adminUsername

 The user name for the initial administrator user for the member.
 


caEndpoint
String caEndpoint

 The endpoint used to access the member's certificate authority.
 








Class com.amazonaws.services.managedblockchain.model.MemberFabricConfiguration extends Object implements Serializable


Serialized Fields


adminUsername
String adminUsername

 The user name for the member's initial administrative user.
 


adminPassword
String adminPassword

 The password for the member's initial administrative user. The AdminPassword must be at least eight
 characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase
 letter, and one digit. It cannot have a single quote(‘), double quote(“), forward slash(/), backward slash(\), @,
 or a space.
 








Class com.amazonaws.services.managedblockchain.model.MemberFrameworkAttributes extends Object implements Serializable


Serialized Fields


fabric
MemberFabricAttributes fabric

 Attributes of Hyperledger Fabric relevant to a member on a Managed Blockchain network that uses Hyperledger
 Fabric.
 








Class com.amazonaws.services.managedblockchain.model.MemberFrameworkConfiguration extends Object implements Serializable


Serialized Fields


fabric
MemberFabricConfiguration fabric

 Attributes of Hyperledger Fabric for a member on a Managed Blockchain network that uses Hyperledger Fabric.
 








Class com.amazonaws.services.managedblockchain.model.MemberSummary extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier of the member.
 


name
String name

 The name of the member.
 


description
String description

 An optional description of the member.
 


status
String status

 The status of the member.
 
 
 
 
 CREATING - The AWS account is in the process of creating a member.
 
 
 
 
 AVAILABLE - The member has been created and can participate in the network.
 
 
 
 
 CREATE_FAILED - The AWS account attempted to create a member and creation failed.
 
 
 
 
 DELETING - The member and all associated resources are in the process of being deleted. Either the
 AWS account that owns the member deleted it, or the member is being deleted as the result of an
 APPROVED PROPOSAL to remove the member.
 
 
 
 
 DELETED - The member can no longer participate on the network and all associated resources are
 deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of
 an APPROVED PROPOSAL to remove the member.
 
 
 


creationDate
Date creationDate

 The date and time that the member was created.
 


isOwned
Boolean isOwned

 An indicator of whether the member is owned by your AWS account or a different AWS account.
 








Class com.amazonaws.services.managedblockchain.model.Network extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier of the network.
 


name
String name

 The name of the network.
 


description
String description

 Attributes of the blockchain framework for the network.
 


framework
String framework

 The blockchain framework that the network uses.
 


frameworkVersion
String frameworkVersion

 The version of the blockchain framework that the network uses.
 


frameworkAttributes
NetworkFrameworkAttributes frameworkAttributes

 Attributes of the blockchain framework that the network uses.
 


vpcEndpointServiceName
String vpcEndpointServiceName

 The VPC endpoint service name of the VPC endpoint service of the network. Members use the VPC endpoint service
 name to create a VPC endpoint to access network resources.
 


votingPolicy
VotingPolicy votingPolicy

 The voting rules for the network to decide if a proposal is accepted.
 


status
String status

 The current status of the network.
 


creationDate
Date creationDate

 The date and time that the network was created.
 








Class com.amazonaws.services.managedblockchain.model.NetworkFabricAttributes extends Object implements Serializable


Serialized Fields


orderingServiceEndpoint
String orderingServiceEndpoint

 The endpoint of the ordering service for the network.
 


edition
String edition

 The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more information, see Amazon Managed Blockchain Pricing.
 








Class com.amazonaws.services.managedblockchain.model.NetworkFabricConfiguration extends Object implements Serializable


Serialized Fields


edition
String edition

 The edition of Amazon Managed Blockchain that the network uses. For more information, see Amazon Managed Blockchain Pricing.
 








Class com.amazonaws.services.managedblockchain.model.NetworkFrameworkAttributes extends Object implements Serializable


Serialized Fields


fabric
NetworkFabricAttributes fabric

 Attributes of Hyperledger Fabric for a Managed Blockchain network that uses Hyperledger Fabric.
 








Class com.amazonaws.services.managedblockchain.model.NetworkFrameworkConfiguration extends Object implements Serializable


Serialized Fields


fabric
NetworkFabricConfiguration fabric

 Hyperledger Fabric configuration properties for a Managed Blockchain network that uses Hyperledger Fabric.
 








Class com.amazonaws.services.managedblockchain.model.NetworkSummary extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier of the network.
 


name
String name

 The name of the network.
 


description
String description

 An optional description of the network.
 


framework
String framework

 The blockchain framework that the network uses.
 


frameworkVersion
String frameworkVersion

 The version of the blockchain framework that the network uses.
 


status
String status

 The current status of the network.
 


creationDate
Date creationDate

 The date and time that the network was created.
 








Class com.amazonaws.services.managedblockchain.model.Node extends Object implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network that the node is in.
 


memberId
String memberId

 The unique identifier of the member to which the node belongs.
 


id
String id

 The unique identifier of the node.
 


instanceType
String instanceType

 The instance type of the node.
 


availabilityZone
String availabilityZone

 The Availability Zone in which the node exists.
 


frameworkAttributes
NodeFrameworkAttributes frameworkAttributes

 Attributes of the blockchain framework being used.
 


status
String status

 The status of the node.
 


creationDate
Date creationDate

 The date and time that the node was created.
 








Class com.amazonaws.services.managedblockchain.model.NodeConfiguration extends Object implements Serializable


Serialized Fields


instanceType
String instanceType

 The Amazon Managed Blockchain instance type for the node.
 


availabilityZone
String availabilityZone

 The Availability Zone in which the node exists.
 








Class com.amazonaws.services.managedblockchain.model.NodeFabricAttributes extends Object implements Serializable


Serialized Fields


peerEndpoint
String peerEndpoint

 The endpoint that identifies the peer node for all services except peer channel-based event services.
 


peerEventEndpoint
String peerEventEndpoint

 The endpoint that identifies the peer node for peer channel-based event services.
 








Class com.amazonaws.services.managedblockchain.model.NodeFrameworkAttributes extends Object implements Serializable


Serialized Fields


fabric
NodeFabricAttributes fabric

 Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.
 








Class com.amazonaws.services.managedblockchain.model.NodeSummary extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier of the node.
 


status
String status

 The status of the node.
 


creationDate
Date creationDate

 The date and time that the node was created.
 


availabilityZone
String availabilityZone

 The Availability Zone in which the node exists.
 


instanceType
String instanceType

 The EC2 instance type for the node.
 








Class com.amazonaws.services.managedblockchain.model.Proposal extends Object implements Serializable


Serialized Fields


proposalId
String proposalId

 The unique identifier of the proposal.
 


networkId
String networkId

 The unique identifier of the network for which the proposal is made.
 


description
String description

 The description of the proposal.
 


actions
ProposalActions actions

 The actions to perform on the network if the proposal is APPROVED.
 


proposedByMemberId
String proposedByMemberId

 The unique identifier of the member that created the proposal.
 


proposedByMemberName
String proposedByMemberName

 The name of the member that created the proposal.
 


status
String status

 The status of the proposal. Values are as follows:
 
 
 
 
 IN_PROGRESS - The proposal is active and open for member voting.
 
 
 
 
 APPROVED - The proposal was approved with sufficient YES votes among members according
 to the VotingPolicy specified for the Network. The specified proposal actions are
 carried out.
 
 
 
 
 REJECTED - The proposal was rejected with insufficient YES votes among members
 according to the VotingPolicy specified for the Network. The specified
 ProposalActions are not carried out.
 
 
 
 
 EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before
 the proposal expired. The specified ProposalActions are not carried out.
 
 
 
 
 ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was
 approved could not be completed because of an error.
 
 
 


creationDate
Date creationDate

 The date and time that the proposal was created.
 


expirationDate
Date expirationDate

 The date and time that the proposal expires. This is the CreationDate plus the
 ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this
 date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the
 proposal is EXPIRED and Actions are not carried out.
 


yesVoteCount
Integer yesVoteCount

 The current total of YES votes cast on the proposal by members.
 


noVoteCount
Integer noVoteCount

 The current total of NO votes cast on the proposal by members.
 


outstandingVoteCount
Integer outstandingVoteCount

 The number of votes remaining to be cast on the proposal by members. In other words, the number of members minus
 the sum of YES votes and NO votes.
 








Class com.amazonaws.services.managedblockchain.model.ProposalActions extends Object implements Serializable


Serialized Fields


invitations
List<E> invitations

 The actions to perform for an APPROVED proposal to invite an AWS account to create a member and join
 the network.
 


removals
List<E> removals

 The actions to perform for an APPROVED proposal to remove a member from the network, which deletes
 the member and all associated member resources from the network.
 








Class com.amazonaws.services.managedblockchain.model.ProposalSummary extends Object implements Serializable


Serialized Fields


proposalId
String proposalId

 The unique identifier of the proposal.
 


description
String description

 The description of the proposal.
 


proposedByMemberId
String proposedByMemberId

 The unique identifier of the member that created the proposal.
 


proposedByMemberName
String proposedByMemberName

 The name of the member that created the proposal.
 


status
String status

 The status of the proposal. Values are as follows:
 
 
 
 
 IN_PROGRESS - The proposal is active and open for member voting.
 
 
 
 
 APPROVED - The proposal was approved with sufficient YES votes among members according
 to the VotingPolicy specified for the Network. The specified proposal actions are
 carried out.
 
 
 
 
 REJECTED - The proposal was rejected with insufficient YES votes among members
 according to the VotingPolicy specified for the Network. The specified
 ProposalActions are not carried out.
 
 
 
 
 EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before
 the proposal expired. The specified ProposalActions are not carried out.
 
 
 
 
 ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was
 approved could not be completed because of an error.
 
 
 


creationDate
Date creationDate

 The date and time that the proposal was created.
 


expirationDate
Date expirationDate

 The date and time that the proposal expires. This is the CreationDate plus the
 ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this
 date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the
 proposal is EXPIRED and Actions are not carried out.
 








Class com.amazonaws.services.managedblockchain.model.RejectInvitationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


invitationId
String invitationId

 The unique identifier of the invitation to reject.
 








Class com.amazonaws.services.managedblockchain.model.RejectInvitationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.managedblockchain.model.RemoveAction extends Object implements Serializable


Serialized Fields


memberId
String memberId

 The unique identifier of the member to remove.
 








Class com.amazonaws.services.managedblockchain.model.ResourceAlreadyExistsException extends AmazonManagedBlockchainException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.managedblockchain.model.ResourceLimitExceededException extends AmazonManagedBlockchainException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.managedblockchain.model.ResourceNotFoundException extends AmazonManagedBlockchainException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.managedblockchain.model.ResourceNotReadyException extends AmazonManagedBlockchainException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.managedblockchain.model.ThrottlingException extends AmazonManagedBlockchainException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.managedblockchain.model.VoteOnProposalRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


networkId
String networkId

 The unique identifier of the network.
 


proposalId
String proposalId

 The unique identifier of the proposal.
 


voterMemberId
String voterMemberId

 The unique identifier of the member casting the vote.
 


vote
String vote

 The value of the vote.
 








Class com.amazonaws.services.managedblockchain.model.VoteOnProposalResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.managedblockchain.model.VoteSummary extends Object implements Serializable


Serialized Fields


vote
String vote

 The vote value, either YES or NO.
 


memberName
String memberName

 The name of the member that cast the vote.
 


memberId
String memberId

 The unique identifier of the member that cast the vote.
 








Class com.amazonaws.services.managedblockchain.model.VotingPolicy extends Object implements Serializable


Serialized Fields


approvalThresholdPolicy
ApprovalThresholdPolicy approvalThresholdPolicy

 Defines the rules for the network for voting on proposals, such as the percentage of YES votes
 required for the proposal to be approved and the duration of the proposal. The policy applies to all proposals
 and is specified when the network is created.
 








Package com.amazonaws.services.marketplacecatalog.model




Class com.amazonaws.services.marketplacecatalog.model.AccessDeniedException extends AWSMarketplaceCatalogException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacecatalog.model.AWSMarketplaceCatalogException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacecatalog.model.CancelChangeSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalog
String catalog

 Required. The catalog related to the request. Fixed value: AWSMarketplace.
 


changeSetId
String changeSetId

 Required. The unique identifier of the StartChangeSet request that you want to cancel.
 








Class com.amazonaws.services.marketplacecatalog.model.CancelChangeSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


changeSetId
String changeSetId

 The unique identifier for the change set referenced in this request.
 


changeSetArn
String changeSetArn

 The ARN associated with the change set referenced in this request.
 








Class com.amazonaws.services.marketplacecatalog.model.Change extends Object implements Serializable


Serialized Fields


changeType
String changeType

 Change types are single string values that describe your intention for the change. Each change type is unique for
 each EntityType provided in the change's scope.
 


entity
Entity entity

 The entity to be changed.
 


details
String details

 This object contains details specific to the change type of the requested change.
 








Class com.amazonaws.services.marketplacecatalog.model.ChangeSetSummaryListItem extends Object implements Serializable


Serialized Fields


changeSetId
String changeSetId

 The unique identifier for a change set.
 


changeSetArn
String changeSetArn

 The ARN associated with the unique identifier for the change set referenced in this request.
 


changeSetName
String changeSetName

 The non-unique name for the change set.
 


startTime
String startTime

 The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was started.
 


endTime
String endTime

 The time, in ISO 8601 format (2018-02-27T13:45:22Z), when the change set was finished.
 


status
String status

 The current status of the change set.
 


entityIdList
List<E> entityIdList

 This object is a list of entity IDs (string) that are a part of a change set. The entity ID list is a maximum of
 20 entities. It must contain at least one entity.
 








Class com.amazonaws.services.marketplacecatalog.model.ChangeSummary extends Object implements Serializable


Serialized Fields


changeType
String changeType

 The type of the change.
 


entity
Entity entity

 The entity to be changed.
 


errorDetailList
List<E> errorDetailList

 An array of ErrorDetail objects associated with the change.
 








Class com.amazonaws.services.marketplacecatalog.model.DescribeChangeSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalog
String catalog

 Required. The catalog related to the request. Fixed value: AWSMarketplace
 


changeSetId
String changeSetId

 Required. The unique identifier for the StartChangeSet request that you want to describe the details
 for.
 








Class com.amazonaws.services.marketplacecatalog.model.DescribeChangeSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


changeSetId
String changeSetId

 Required. The unique identifier for the change set referenced in this request.
 


changeSetArn
String changeSetArn

 The ARN associated with the unique identifier for the change set referenced in this request.
 


changeSetName
String changeSetName

 The optional name provided in the StartChangeSet request. If you do not provide a name, one is set
 by default.
 


startTime
String startTime

 The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request started.
 


endTime
String endTime

 The date and time, in ISO 8601 format (2018-02-27T13:45:22Z), the request transitioned to a terminal state. The
 change cannot transition to a different state. Null if the request is not in a terminal state.
 


status
String status

 The status of the change request.
 


failureDescription
String failureDescription

 Returned if there is a failure on the change set, but that failure is not related to any of the changes in the
 request.
 


changeSet
List<E> changeSet

 An array of ChangeSummary objects.
 








Class com.amazonaws.services.marketplacecatalog.model.DescribeEntityRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalog
String catalog

 Required. The catalog related to the request. Fixed value: AWSMarketplace
 


entityId
String entityId

 Required. The unique ID of the entity to describe.
 








Class com.amazonaws.services.marketplacecatalog.model.DescribeEntityResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entityType
String entityType

 The named type of the entity, in the format of EntityType@Version.
 


entityIdentifier
String entityIdentifier

 The identifier of the entity, in the format of EntityId@RevisionId.
 


entityArn
String entityArn

 The ARN associated to the unique identifier for the change set referenced in this request.
 


lastModifiedDate
String lastModifiedDate

 The last modified date of the entity, in ISO 8601 format (2018-02-27T13:45:22Z).
 


details
String details

 This stringified JSON object includes the details of the entity.
 








Class com.amazonaws.services.marketplacecatalog.model.Entity extends Object implements Serializable


Serialized Fields


type
String type

 The type of entity.
 


identifier
String identifier

 The identifier for the entity.
 








Class com.amazonaws.services.marketplacecatalog.model.EntitySummary extends Object implements Serializable


Serialized Fields


name
String name

 The name for the entity. This value is not unique. It is defined by the provider.
 


entityType
String entityType

 The type of the entity.
 


entityId
String entityId

 The unique identifier for the entity.
 


entityArn
String entityArn

 The ARN associated with the unique identifier for the entity.
 


lastModifiedDate
String lastModifiedDate

 The last time the entity was published, using ISO 8601 format (2018-02-27T13:45:22Z).
 


visibility
String visibility

 The visibility status of the entity to subscribers. This value can be Public (everyone can view the
 entity), Limited (the entity is visible to limited accounts only), or Restricted (the
 entity was published and then unpublished and only existing subscribers can view it).
 








Class com.amazonaws.services.marketplacecatalog.model.ErrorDetail extends Object implements Serializable


Serialized Fields


errorCode
String errorCode

 The error code that identifies the type of error.
 


errorMessage
String errorMessage

 The message for the error.
 








Class com.amazonaws.services.marketplacecatalog.model.Filter extends Object implements Serializable


Serialized Fields


name
String name

 For ListEntities, the supported value for this is an EntityId.
 
 
 For ListChangeSets, the supported values are as follows:
 


valueList
List<E> valueList

 ListEntities - This is a list of unique EntityIds.
 
 
 ListChangeSets - The supported filter names and associated ValueLists is as follows:
 
 
 
 
 ChangeSetName - The supported ValueList is a list of non-unique
 ChangeSetNames. These are defined when you call the StartChangeSet action.
 
 
 
 
 Status - The supported ValueList is a list of statuses for all change set requests.
 
 
 
 
 EntityId - The supported ValueList is a list of unique EntityIds.
 
 
 
 
 BeforeStartTime - The supported ValueList is a list of all change sets that started
 before the filter value.
 
 
 
 
 AfterStartTime - The supported ValueList is a list of all change sets that started
 after the filter value.
 
 
 
 
 BeforeEndTime - The supported ValueList is a list of all change sets that ended before
 the filter value.
 
 
 
 
 AfterEndTime - The supported ValueList is a list of all change sets that ended after
 the filter value.
 
 
 








Class com.amazonaws.services.marketplacecatalog.model.InternalServiceException extends AWSMarketplaceCatalogException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacecatalog.model.ListChangeSetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalog
String catalog

 The catalog related to the request. Fixed value: AWSMarketplace
 


filterList
List<E> filterList

 An array of filter objects.
 


sort
Sort sort

 An object that contains two attributes, sortBy and sortOrder.
 


maxResults
Integer maxResults

 The maximum number of results returned by a single call. This value must be provided in the next call to retrieve
 the next set of results. By default, this value is 20.
 


nextToken
String nextToken

 The token value retrieved from a previous call to access the next page of results.
 








Class com.amazonaws.services.marketplacecatalog.model.ListChangeSetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


changeSetSummaryList
List<E> changeSetSummaryList

 Array of ChangeSetSummaryListItem objects.
 


nextToken
String nextToken

 The value of the next token, if it exists. Null if there are no more results.
 








Class com.amazonaws.services.marketplacecatalog.model.ListEntitiesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalog
String catalog

 The catalog related to the request. Fixed value: AWSMarketplace
 


entityType
String entityType

 The type of entities to retrieve.
 


filterList
List<E> filterList

 An array of filter objects. Each filter object contains two attributes, filterName and
 filterValues.
 


sort
Sort sort

 An object that contains two attributes, sortBy and sortOrder.
 


nextToken
String nextToken

 The value of the next token, if it exists. Null if there are no more results.
 


maxResults
Integer maxResults

 Specifies the upper limit of the elements on a single page. If a value isn't provided, the default value is 20.
 








Class com.amazonaws.services.marketplacecatalog.model.ListEntitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entitySummaryList
List<E> entitySummaryList

 Array of EntitySummary object.
 


nextToken
String nextToken

 The value of the next token if it exists. Null if there is no more result.
 








Class com.amazonaws.services.marketplacecatalog.model.ResourceInUseException extends AWSMarketplaceCatalogException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacecatalog.model.ResourceNotFoundException extends AWSMarketplaceCatalogException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacecatalog.model.ResourceNotSupportedException extends AWSMarketplaceCatalogException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacecatalog.model.ServiceQuotaExceededException extends AWSMarketplaceCatalogException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacecatalog.model.Sort extends Object implements Serializable


Serialized Fields


sortBy
String sortBy

 For ListEntities, supported attributes include LastModifiedDate (default),
 Visibility, EntityId, and Name.
 
 
 For ListChangeSets, supported attributes include StartTime and EndTime.
 


sortOrder
String sortOrder

 The sorting order. Can be ASCENDING or DESCENDING. The default value is
 DESCENDING.
 








Class com.amazonaws.services.marketplacecatalog.model.StartChangeSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


catalog
String catalog

 The catalog related to the request. Fixed value: AWSMarketplace
 


changeSet
List<E> changeSet

 Array of change object.
 


changeSetName
String changeSetName

 Optional case sensitive string of up to 100 ASCII characters. The change set name can be used to filter the list
 of change sets.
 


clientRequestToken
String clientRequestToken

 A unique token to identify the request to ensure idempotency.
 








Class com.amazonaws.services.marketplacecatalog.model.StartChangeSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


changeSetId
String changeSetId

 Unique identifier generated for the request.
 


changeSetArn
String changeSetArn

 The ARN associated to the unique identifier generated for the request.
 








Class com.amazonaws.services.marketplacecatalog.model.ThrottlingException extends AWSMarketplaceCatalogException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacecatalog.model.ValidationException extends AWSMarketplaceCatalogException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.marketplacecommerceanalytics.model




Class com.amazonaws.services.marketplacecommerceanalytics.model.AWSMarketplaceCommerceAnalyticsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacecommerceanalytics.model.GenerateDataSetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSetType
String dataSetType

 The desired data set type.
 
 
 

 customer_subscriber_hourly_monthly_subscriptions
 
 From 2017-09-15 to present: Available daily by 24:00 UTC.
 
 
 customer_subscriber_annual_subscriptions
 
 From 2017-09-15 to present: Available daily by 24:00 UTC.
 
 
 daily_business_usage_by_instance_type
 
 From 2017-09-15 to present: Available daily by 24:00 UTC.
 
 
 daily_business_fees
 
 From 2017-09-15 to present: Available daily by 24:00 UTC.
 
 
 daily_business_free_trial_conversions
 
 From 2017-09-15 to present: Available daily by 24:00 UTC.
 
 
 daily_business_new_instances
 
 From 2017-09-15 to present: Available daily by 24:00 UTC.
 
 
 daily_business_new_product_subscribers
 
 From 2017-09-15 to present: Available daily by 24:00 UTC.
 
 
 daily_business_canceled_product_subscribers
 
 From 2017-09-15 to present: Available daily by 24:00 UTC.
 
 
 monthly_revenue_billing_and_revenue_data
 
 From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered
 transactions (e.g. hourly) from one month prior.
 
 
 monthly_revenue_annual_subscriptions
 
 From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes up-front
 software charges (e.g. annual) from one month prior.
 
 
 monthly_revenue_field_demonstration_usage
 
 From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
 
 
 monthly_revenue_flexible_payment_schedule
 
 From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
 
 
 disbursed_amount_by_product
 
 From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
 
 
 disbursed_amount_by_instance_hours
 
 From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
 
 
 disbursed_amount_by_customer_geo
 
 From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
 
 
 disbursed_amount_by_age_of_uncollected_funds
 
 From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
 
 
 disbursed_amount_by_age_of_disbursed_funds
 
 From 2017-09-15 to present: Available every 30 days by 24:00 UTC.
 
 
 disbursed_amount_by_age_of_past_due_funds
 
 From 2018-04-07 to present: Available every 30 days by 24:00 UTC.
 
 
 disbursed_amount_by_uncollected_funds_breakdown
 
 From 2019-10-04 to present: Available every 30 days by 24:00 UTC.
 
 
 sales_compensation_billed_revenue
 
 From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered
 transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month
 prior.
 
 
 us_sales_and_use_tax_records
 
 From 2017-09-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.
 
 
 
 


dataSetPublicationDate
Date dataSetPublicationDate
The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired
 day. For weekly data sets, provide a date with day-level granularity within the desired week (the day value will
 be ignored). For monthly data sets, provide a date with month-level granularity for the desired month (the day
 value will be ignored).


roleNameArn
String roleNameArn
The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS
 services.


destinationS3BucketName
String destinationS3BucketName
The name (friendly name, not ARN) of the destination S3 bucket.


destinationS3Prefix
String destinationS3Prefix
(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file
 systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file
 "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory
 structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3
 bucket root.


snsTopicArn
String snsTopicArn
Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an
 error has occurred.


customerDefinedValues
Map<K,V> customerDefinedValues
(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the
 data set metadata file. These key-value pairs can be used to correlated responses with tracking information from
 other systems.








Class com.amazonaws.services.marketplacecommerceanalytics.model.GenerateDataSetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataSetRequestId
String dataSetRequestId
A unique identifier representing a specific request to the GenerateDataSet operation. This identifier can be used
 to correlate a request with notifications from the SNS topic.








Class com.amazonaws.services.marketplacecommerceanalytics.model.MarketplaceCommerceAnalyticsException extends AWSMarketplaceCommerceAnalyticsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacecommerceanalytics.model.StartSupportDataExportRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dataSetType
String dataSetType

 Specifies the data set type to be written to the output csv file. The data set types
 customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the
 following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date,
 Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code,
 Operation Type, and Operation Time.
 
 
 

 customer_support_contacts_data Customer support contact data. The data set will contain all changes
 (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date
 parameter.
 test_customer_support_contacts_data An example data set containing static test data in the same format
 as customer_support_contacts_data
 
 


fromDate
Date fromDate
The start date from which to retrieve the data set in UTC. This parameter only affects the
 customer_support_contacts_data data set type.


roleNameArn
String roleNameArn
The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS
 services.


destinationS3BucketName
String destinationS3BucketName
The name (friendly name, not ARN) of the destination S3 bucket.


destinationS3Prefix
String destinationS3Prefix
(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file
 systems. For example, if given the bucket name "mybucket" and the prefix "myprefix/mydatasets", the output file
 "outputfile" would be published to "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory
 structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3
 bucket root.


snsTopicArn
String snsTopicArn
Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an
 error has occurred.


customerDefinedValues
Map<K,V> customerDefinedValues
(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the
 data set metadata file.








Class com.amazonaws.services.marketplacecommerceanalytics.model.StartSupportDataExportResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dataSetRequestId
String dataSetRequestId
A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can
 be used to correlate a request with notifications from the SNS topic.








Package com.amazonaws.services.marketplaceentitlement.model




Class com.amazonaws.services.marketplaceentitlement.model.AWSMarketplaceEntitlementException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplaceentitlement.model.Entitlement extends Object implements Serializable


Serialized Fields


productCode
String productCode

 The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the
 product listing is created.
 


dimension
String dimension

 The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product
 and are specified when the product is listed in AWS Marketplace.
 


customerIdentifier
String customerIdentifier

 The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained
 through the ResolveCustomer operation in AWS Marketplace Metering Service.
 


value
EntitlementValue value

 The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.
 


expirationDate
Date expirationDate

 The expiration date represents the minimum date through which this entitlement is expected to remain valid. For
 contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew
 or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an
 expiration date.
 








Class com.amazonaws.services.marketplaceentitlement.model.EntitlementValue extends Object implements Serializable


Serialized Fields


integerValue
Integer integerValue

 The IntegerValue field will be populated with an integer value when the entitlement is an integer type.
 Otherwise, the field will not be set.
 


doubleValue
Double doubleValue

 The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the
 field will not be set.
 


booleanValue
Boolean booleanValue

 The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise,
 the field will not be set.
 


stringValue
String stringValue

 The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the
 field will not be set.
 








Class com.amazonaws.services.marketplaceentitlement.model.GetEntitlementsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


productCode
String productCode

 Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS
 Marketplace when the product listing is created.
 


filter
Map<K,V> filter

 Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described
 as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and
 then intersected for each filter key.
 


nextToken
String nextToken

 For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.
 


maxResults
Integer maxResults

 The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken
 field in subsequent calls to GetEntitlements.
 








Class com.amazonaws.services.marketplaceentitlement.model.GetEntitlementsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entitlements
List<E> entitlements

 The set of entitlements found through the GetEntitlements operation. If the result contains an empty set of
 entitlements, NextToken might still be present and should be used.
 


nextToken
String nextToken

 For paginated results, use NextToken in subsequent calls to GetEntitlements. If the result contains an empty set
 of entitlements, NextToken might still be present and should be used.
 








Class com.amazonaws.services.marketplaceentitlement.model.InternalServiceErrorException extends AWSMarketplaceEntitlementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplaceentitlement.model.InvalidParameterException extends AWSMarketplaceEntitlementException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplaceentitlement.model.ThrottlingException extends AWSMarketplaceEntitlementException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.marketplacemetering.model




Class com.amazonaws.services.marketplacemetering.model.AWSMarketplaceMeteringException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.BatchMeterUsageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


usageRecords
List<E> usageRecords

 The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.
 


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.
 








Class com.amazonaws.services.marketplacemetering.model.BatchMeterUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


results
List<E> results

 Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace
 Metering Service or were invalid.
 


unprocessedRecords
List<E> unprocessedRecords

 Contains all UsageRecords that were not processed by BatchMeterUsage. This is a list of UsageRecords. You can
 retry the failed request by making another BatchMeterUsage call with this list as input in the
 BatchMeterUsageRequest.
 








Class com.amazonaws.services.marketplacemetering.model.CustomerNotEntitledException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.DisabledApiException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.DuplicateRequestException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.ExpiredTokenException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.InternalServiceErrorException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.InvalidCustomerIdentifierException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.InvalidEndpointRegionException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.InvalidProductCodeException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.InvalidPublicKeyVersionException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.InvalidRegionException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.InvalidTokenException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.InvalidUsageDimensionException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.MeterUsageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


productCode
String productCode

 Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as
 the one used during the publishing of a new product.
 


timestamp
Date timestamp

 Timestamp, in UTC, for which the usage is being reported. Your application can meter usage for up to one hour in
 the past. Make sure the timestamp value is not before the start of the software usage.
 


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. Defaults to 0 if not specified.
 


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. Defaults to
 false if not specified.
 








Class com.amazonaws.services.marketplacemetering.model.MeterUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


meteringRecordId
String meteringRecordId

 Metering record id.
 








Class com.amazonaws.services.marketplacemetering.model.PlatformNotSupportedException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.RegisterUsageRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


productCode
String productCode

 Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as
 the one used during the publishing of a new product.
 


publicKeyVersion
Integer publicKeyVersion

 Public Key Version provided by AWS Marketplace
 


nonce
String nonce

 (Optional) To scope down the registration to a specific running software instance and guard against replay
 attacks.
 








Class com.amazonaws.services.marketplacemetering.model.RegisterUsageResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


publicKeyRotationTimestamp
Date publicKeyRotationTimestamp

 (Optional) Only included when public key version has expired
 


signature
String signature

 JWT Token
 








Class com.amazonaws.services.marketplacemetering.model.ResolveCustomerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


registrationToken
String registrationToken

 When a buyer visits your website during the registration process, the buyer submits a registration token through
 the browser. The registration token is resolved to obtain a CustomerIdentifier and product code.
 








Class com.amazonaws.services.marketplacemetering.model.ResolveCustomerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


customerIdentifier
String customerIdentifier

 The CustomerIdentifier is used to identify an individual customer in your application. Calls to BatchMeterUsage
 require CustomerIdentifiers for each UsageRecord.
 


productCode
String productCode

 The product code is returned to confirm that the buyer is registering for your product. Subsequent
 BatchMeterUsage calls should be made using this product code.
 








Class com.amazonaws.services.marketplacemetering.model.ThrottlingException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.TimestampOutOfBoundsException extends AWSMarketplaceMeteringException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.UsageRecord extends Object implements Serializable


Serialized Fields


timestamp
Date timestamp

 Timestamp, in UTC, for which the usage is being reported.
 
 
 Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the
 start of the software usage.
 


customerIdentifier
String customerIdentifier

 The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in
 your application.
 


dimension
String dimension

 During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These
 represent different units of value in your application.
 


quantity
Integer quantity

 The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if
 not specified.
 








Class com.amazonaws.services.marketplacemetering.model.UsageRecordResult extends Object implements Serializable


Serialized Fields


usageRecord
UsageRecord usageRecord

 The UsageRecord that was part of the BatchMeterUsage request.
 


meteringRecordId
String meteringRecordId

 The MeteringRecordId is a unique identifier for this metering event.
 


status
String status

 The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage.
 
 
 
 
 Success- The UsageRecord was accepted and honored by BatchMeterUsage.
 
 
 
 
 CustomerNotSubscribed- The CustomerIdentifier specified is not subscribed to your product. The UsageRecord
 was not honored. Future UsageRecords for this customer will fail until the customer subscribes to your product.
 
 
 
 
 DuplicateRecord- Indicates that the UsageRecord was invalid and not honored. A previously metered
 UsageRecord had the same customer, dimension, and time, but a different quantity.
 
 
 








Package com.amazonaws.services.mediaconnect.model




Class com.amazonaws.services.mediaconnect.model.AddFlowOutputs420Exception extends AWSMediaConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconnect.model.AddFlowOutputsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowArn
String flowArn
The flow that you want to add outputs to.


outputs
List<E> outputs
A list of outputs that you want to add.








Class com.amazonaws.services.mediaconnect.model.AddFlowOutputsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowArn
String flowArn
The ARN of the flow that these outputs were added to.


outputs
List<E> outputs
The details of the newly added outputs.








Class com.amazonaws.services.mediaconnect.model.AddOutputRequest extends Object implements Serializable


Serialized Fields


cidrAllowList
List<E> cidrAllowList
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses
 should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.


description
String description
A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not
 be seen by the end user.


destination
String destination
The IP address from which video will be sent to output destinations.


encryption
Encryption encryption
The type of key used for the encryption. If no keyType is provided, the service will use the default setting
 (static-key).


maxLatency
Integer maxLatency
The maximum latency in milliseconds for Zixi-based streams.


name
String name
The name of the output. This value must be unique within the current flow.


port
Integer port
The port to use when content is distributed to this output.


protocol
String protocol
The protocol to use for the output.


remoteId
String remoteId
The remote ID for the Zixi-pull output stream.


smoothingLatency
Integer smoothingLatency
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.


streamId
String streamId
The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.








Class com.amazonaws.services.mediaconnect.model.AWSMediaConnectException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconnect.model.BadRequestException extends AWSMediaConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconnect.model.CreateFlow420Exception extends AWSMediaConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconnect.model.CreateFlowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZone
String availabilityZone
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones
 within the current AWS Region.


entitlements
List<E> entitlements
The entitlements that you want to grant on a flow.


name
String name
The name of the flow.


outputs
List<E> outputs
The outputs that you want to add to this flow.


source
SetSourceRequest source








Class com.amazonaws.services.mediaconnect.model.CreateFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flow
Flow flow








Class com.amazonaws.services.mediaconnect.model.DeleteFlowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowArn
String flowArn
The ARN of the flow that you want to delete.








Class com.amazonaws.services.mediaconnect.model.DeleteFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowArn
String flowArn
The ARN of the flow that was deleted.


status
String status
The status of the flow when the DeleteFlow process begins.








Class com.amazonaws.services.mediaconnect.model.DescribeFlowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowArn
String flowArn
The ARN of the flow that you want to describe.








Class com.amazonaws.services.mediaconnect.model.DescribeFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flow
Flow flow


messages
Messages messages








Class com.amazonaws.services.mediaconnect.model.Encryption extends Object implements Serializable


Serialized Fields


algorithm
String algorithm
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).


constantInitializationVector
String constantInitializationVector
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting
 content. This parameter is not valid for static key encryption.


deviceId
String deviceId
The value of one of the devices that you configured with your digital rights management (DRM) platform key
 provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.


keyType
String keyType
The type of key that is used for the encryption. If no keyType is provided, the service will use the default
 setting (static-key).


region
String region
The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE
 encryption and is not valid for static key encryption.


resourceId
String resourceId
An identifier for the content. The service sends this value to the key server to identify the current endpoint.
 The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid
 for static key encryption.


roleArn
String roleArn
The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted
 entity).


secretArn
String secretArn
The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is
 required for static key encryption and is not valid for SPEKE encryption.


url
String url
The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for
 SPEKE encryption and is not valid for static key encryption.








Class com.amazonaws.services.mediaconnect.model.Entitlement extends Object implements Serializable


Serialized Fields


dataTransferSubscriberFeePercent
Integer dataTransferSubscriberFeePercent
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.


description
String description
A description of the entitlement.


encryption
Encryption encryption
The type of encryption that will be used on the output that is associated with this entitlement.


entitlementArn
String entitlementArn
The ARN of the entitlement.


name
String name
The name of the entitlement.


subscribers
List<E> subscribers
The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be
 allowed to create their own flow using your content as the source.








Class com.amazonaws.services.mediaconnect.model.Flow extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone
The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones
 within the current AWS.


description
String description
A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect
 account.


egressIp
String egressIp
The IP address from which video will be sent to output destinations.


entitlements
List<E> entitlements
The entitlements in this flow.


flowArn
String flowArn
The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow.


name
String name
The name of the flow.


outputs
List<E> outputs
The outputs in this flow.


source
Source source


status
String status
The current status of the flow.








Class com.amazonaws.services.mediaconnect.model.ForbiddenException extends AWSMediaConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconnect.model.GrantEntitlementRequest extends Object implements Serializable


Serialized Fields


dataTransferSubscriberFeePercent
Integer dataTransferSubscriberFeePercent
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.


description
String description
A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and
 will not be seen by the subscriber or end user.


encryption
Encryption encryption
The type of encryption that will be used on the output that is associated with this entitlement.


name
String name
The name of the entitlement. This value must be unique within the current flow.


subscribers
List<E> subscribers
The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be
 allowed to create their own flows using your content as the source.








Class com.amazonaws.services.mediaconnect.model.GrantFlowEntitlements420Exception extends AWSMediaConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconnect.model.GrantFlowEntitlementsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


entitlements
List<E> entitlements
The list of entitlements that you want to grant.


flowArn
String flowArn
The flow that you want to grant entitlements on.








Class com.amazonaws.services.mediaconnect.model.GrantFlowEntitlementsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entitlements
List<E> entitlements
The entitlements that were just granted.


flowArn
String flowArn
The ARN of the flow that these entitlements were granted to.








Class com.amazonaws.services.mediaconnect.model.InternalServerErrorException extends AWSMediaConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconnect.model.ListedEntitlement extends Object implements Serializable


Serialized Fields


dataTransferSubscriberFeePercent
Integer dataTransferSubscriberFeePercent
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.


entitlementArn
String entitlementArn
The ARN of the entitlement.


entitlementName
String entitlementName
The name of the entitlement.








Class com.amazonaws.services.mediaconnect.model.ListedFlow extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone
The Availability Zone that the flow was created in.


description
String description
A description of the flow.


flowArn
String flowArn
The ARN of the flow.


name
String name
The name of the flow.


sourceType
String sourceType
The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect
 flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another
 AWS account).


status
String status
The current status of the flow.








Class com.amazonaws.services.mediaconnect.model.ListEntitlementsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults
The maximum number of results to return per API request. For example, you submit a ListEntitlements request with
 MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items.
 (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service
 might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service
 defaults to pagination with a maximum of 20 results per page.


nextToken
String nextToken
The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements
 request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value.
 To see the next batch of results, you can submit the ListEntitlements request a second time and specify the
 NextToken value.








Class com.amazonaws.services.mediaconnect.model.ListEntitlementsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entitlements
List<E> entitlements
A list of entitlements that have been granted to you from other AWS accounts.


nextToken
String nextToken
The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements
 request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value.
 To see the next batch of results, you can submit the ListEntitlements request a second time and specify the
 NextToken value.








Class com.amazonaws.services.mediaconnect.model.ListFlowsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults
The maximum number of results to return per API request. For example, you submit a ListFlows request with
 MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items.
 (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service
 might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service
 defaults to pagination with a maximum of 10 results per page.


nextToken
String nextToken
The token that identifies which batch of results that you want to see. For example, you submit a ListFlows
 request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value.
 To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken
 value.








Class com.amazonaws.services.mediaconnect.model.ListFlowsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flows
List<E> flows
A list of flow summaries.


nextToken
String nextToken
The token that identifies which batch of results that you want to see. For example, you submit a ListFlows
 request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value.
 To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken
 value.








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


Serialized Fields


resourceArn
String resourceArn
The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource for which to list the
 tags.








Class com.amazonaws.services.mediaconnect.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags
A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can
 have a maximum length of 256 characters.








Class com.amazonaws.services.mediaconnect.model.Messages extends Object implements Serializable


Serialized Fields


errors
List<E> errors
A list of errors that might have been generated from processes on this flow.








Class com.amazonaws.services.mediaconnect.model.NotFoundException extends AWSMediaConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconnect.model.Output extends Object implements Serializable


Serialized Fields


dataTransferSubscriberFeePercent
Integer dataTransferSubscriberFeePercent
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.


description
String description
A description of the output.


destination
String destination
The address where you want to send the output.


encryption
Encryption encryption
The type of key used for the encryption. If no keyType is provided, the service will use the default setting
 (static-key).


entitlementArn
String entitlementArn
The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows.


mediaLiveInputArn
String mediaLiveInputArn
The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added
 by creating a MediaLive input.


name
String name
The name of the output. This value must be unique within the current flow.


outputArn
String outputArn
The ARN of the output.


port
Integer port
The port to use when content is distributed to this output.


transport
Transport transport
Attributes related to the transport stream that are used in the output.








Class com.amazonaws.services.mediaconnect.model.RemoveFlowOutputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowArn
String flowArn
The flow that you want to remove an output from.


outputArn
String outputArn
The ARN of the output that you want to remove.








Class com.amazonaws.services.mediaconnect.model.RemoveFlowOutputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowArn
String flowArn
The ARN of the flow that is associated with the output you removed.


outputArn
String outputArn
The ARN of the output that was removed.








Class com.amazonaws.services.mediaconnect.model.RevokeFlowEntitlementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


entitlementArn
String entitlementArn
The ARN of the entitlement that you want to revoke.


flowArn
String flowArn
The flow that you want to revoke an entitlement from.








Class com.amazonaws.services.mediaconnect.model.RevokeFlowEntitlementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entitlementArn
String entitlementArn
The ARN of the entitlement that was revoked.


flowArn
String flowArn
The ARN of the flow that the entitlement was revoked from.








Class com.amazonaws.services.mediaconnect.model.ServiceUnavailableException extends AWSMediaConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconnect.model.SetSourceRequest extends Object implements Serializable


Serialized Fields


decryption
Encryption decryption
The type of encryption that is used on the content ingested from this source.


description
String description
A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect
 account.


entitlementArn
String entitlementArn
The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow
 originator, and the ARN is generated as part of the originator's flow.


ingestPort
Integer ingestPort
The port that the flow will be listening on for incoming content.


maxBitrate
Integer maxBitrate
The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.


maxLatency
Integer maxLatency
The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.


name
String name
The name of the source.


protocol
String protocol
The protocol that is used by the source.


streamId
String streamId
The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.


whitelistCidr
String whitelistCidr
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should
 be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.








Class com.amazonaws.services.mediaconnect.model.Source extends Object implements Serializable


Serialized Fields


dataTransferSubscriberFeePercent
Integer dataTransferSubscriberFeePercent
Percentage from 0-100 of the data transfer cost to be billed to the subscriber.


decryption
Encryption decryption
The type of encryption that is used on the content ingested from this source.


description
String description
A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect
 account.


entitlementArn
String entitlementArn
The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The
 entitlement is set by the content originator and the ARN is generated as part of the originator's flow.


ingestIp
String ingestIp
The IP address that the flow will be listening on for incoming content.


ingestPort
Integer ingestPort
The port that the flow will be listening on for incoming content.


name
String name
The name of the source.


sourceArn
String sourceArn
The ARN of the source.


transport
Transport transport
Attributes related to the transport stream that are used in the source.


whitelistCidr
String whitelistCidr
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should
 be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.








Class com.amazonaws.services.mediaconnect.model.StartFlowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowArn
String flowArn
The ARN of the flow that you want to start.








Class com.amazonaws.services.mediaconnect.model.StartFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowArn
String flowArn
The ARN of the flow that you started.


status
String status
The status of the flow when the StartFlow process begins.








Class com.amazonaws.services.mediaconnect.model.StopFlowRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


flowArn
String flowArn
The ARN of the flow that you want to stop.








Class com.amazonaws.services.mediaconnect.model.StopFlowResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowArn
String flowArn
The ARN of the flow that you stopped.


status
String status
The status of the flow when the StopFlow process begins.








Class com.amazonaws.services.mediaconnect.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn
The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource to which to add tags.


tags
Map<K,V> tags
A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can
 have a maximum length of 256 characters.








Class com.amazonaws.services.mediaconnect.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediaconnect.model.TooManyRequestsException extends AWSMediaConnectException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconnect.model.Transport extends Object implements Serializable


Serialized Fields


cidrAllowList
List<E> cidrAllowList
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses
 should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.


maxBitrate
Integer maxBitrate
The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.


maxLatency
Integer maxLatency
The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.


protocol
String protocol
The protocol that is used by the source or output.


remoteId
String remoteId
The remote ID for the Zixi-pull stream.


smoothingLatency
Integer smoothingLatency
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.


streamId
String streamId
The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.








Class com.amazonaws.services.mediaconnect.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn
The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource from which to delete tags.


tagKeys
List<E> tagKeys
The keys of the tags to be removed.








Class com.amazonaws.services.mediaconnect.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediaconnect.model.UpdateEncryption extends Object implements Serializable


Serialized Fields


algorithm
String algorithm
The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256).


constantInitializationVector
String constantInitializationVector
A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting
 content. This parameter is not valid for static key encryption.


deviceId
String deviceId
The value of one of the devices that you configured with your digital rights management (DRM) platform key
 provider. This parameter is required for SPEKE encryption and is not valid for static key encryption.


keyType
String keyType
The type of key that is used for the encryption. If no keyType is provided, the service will use the default
 setting (static-key).


region
String region
The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE
 encryption and is not valid for static key encryption.


resourceId
String resourceId
An identifier for the content. The service sends this value to the key server to identify the current endpoint.
 The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid
 for static key encryption.


roleArn
String roleArn
The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted
 entity).


secretArn
String secretArn
The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is
 required for static key encryption and is not valid for SPEKE encryption.


url
String url
The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for
 SPEKE encryption and is not valid for static key encryption.








Class com.amazonaws.services.mediaconnect.model.UpdateFlowEntitlementRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description
A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and
 will not be seen by the subscriber or end user.


encryption
UpdateEncryption encryption
The type of encryption that will be used on the output associated with this entitlement.


entitlementArn
String entitlementArn
The ARN of the entitlement that you want to update.


flowArn
String flowArn
The flow that is associated with the entitlement that you want to update.


subscribers
List<E> subscribers
The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be
 allowed to create their own flow using your content as the source.








Class com.amazonaws.services.mediaconnect.model.UpdateFlowEntitlementResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


entitlement
Entitlement entitlement


flowArn
String flowArn
The ARN of the flow that this entitlement was granted on.








Class com.amazonaws.services.mediaconnect.model.UpdateFlowOutputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cidrAllowList
List<E> cidrAllowList
The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses
 should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.


description
String description
A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not
 be seen by the end user.


destination
String destination
The IP address where you want to send the output.


encryption
UpdateEncryption encryption
The type of key used for the encryption. If no keyType is provided, the service will use the default setting
 (static-key).


flowArn
String flowArn
The flow that is associated with the output that you want to update.


maxLatency
Integer maxLatency
The maximum latency in milliseconds for Zixi-based streams.


outputArn
String outputArn
The ARN of the output that you want to update.


port
Integer port
The port to use when content is distributed to this output.


protocol
String protocol
The protocol to use for the output.


remoteId
String remoteId
The remote ID for the Zixi-pull stream.


smoothingLatency
Integer smoothingLatency
The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.


streamId
String streamId
The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.








Class com.amazonaws.services.mediaconnect.model.UpdateFlowOutputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowArn
String flowArn
The ARN of the flow that is associated with the updated output.


output
Output output








Class com.amazonaws.services.mediaconnect.model.UpdateFlowSourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


decryption
UpdateEncryption decryption
The type of encryption used on the content ingested from this source.


description
String description
A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect
 account.


entitlementArn
String entitlementArn
The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow
 originator, and the ARN is generated as part of the originator's flow.


flowArn
String flowArn
The flow that is associated with the source that you want to update.


ingestPort
Integer ingestPort
The port that the flow will be listening on for incoming content.


maxBitrate
Integer maxBitrate
The smoothing max bitrate for RIST, RTP, and RTP-FEC streams.


maxLatency
Integer maxLatency
The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.


protocol
String protocol
The protocol that is used by the source.


sourceArn
String sourceArn
The ARN of the source that you want to update.


streamId
String streamId
The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams.


whitelistCidr
String whitelistCidr
The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should
 be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16.








Class com.amazonaws.services.mediaconnect.model.UpdateFlowSourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


flowArn
String flowArn
The ARN of the flow that you want to update.


source
Source source
The settings for the source of the flow.








Package com.amazonaws.services.mediaconvert.model




Class com.amazonaws.services.mediaconvert.model.AacSettings extends Object implements Serializable


Serialized Fields


audioDescriptionBroadcasterMix
String audioDescriptionBroadcasterMix
Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo
 pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains
 "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does
 not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in
 AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio
 description (AD). In this case, the encoder will use any values you provide for AudioType and
 FollowInputAudioType.


bitrate
Integer bitrate
Specify the average bitrate in bits per second. The set of valid values for this setting is: 6000, 8000, 10000,
 12000, 14000, 16000, 20000, 24000, 28000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000,
 160000, 192000, 224000, 256000, 288000, 320000, 384000, 448000, 512000, 576000, 640000, 768000, 896000, 1024000.
 The value you set is also constrained by the values that you choose for Profile (codecProfile), Bitrate control
 mode (codingMode), and Sample rate (sampleRate). Default values depend on Bitrate control mode and Profile.


codecProfile
String codecProfile
AAC Profile.


codingMode
String codingMode
Mono (Audio Description), Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and
 profile. "1.0 - Audio Description (Receiver Mix)" setting receives a stereo description plus control track and
 emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101
 154 Annex E.


rateControlMode
String rateControlMode
Rate Control Mode.


rawFormat
String rawFormat
Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose "No container" for
 the output container.


sampleRate
Integer sampleRate
Sample rate in Hz. Valid values depend on rate control mode and profile.


specification
String specification
Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.


vbrQuality
String vbrQuality
VBR Quality Level - Only used if rate_control_mode is VBR.








Class com.amazonaws.services.mediaconvert.model.Ac3Settings extends Object implements Serializable


Serialized Fields


bitrate
Integer bitrate
Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode.


bitstreamMode
String bitstreamMode
Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3
 bitstream mode, see ATSC A/52-2012 (Annex E).


codingMode
String codingMode
Dolby Digital coding mode. Determines number of channels.


dialnorm
Integer dialnorm
Sets the dialnorm for the output. If blank and input audio is Dolby Digital, dialnorm will be passed through.


dynamicRangeCompressionProfile
String dynamicRangeCompressionProfile
If set to FILM_STANDARD, adds dynamic range compression signaling to the output bitstream as defined in the Dolby
 Digital specification.


lfeFilter
String lfeFilter
Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.


metadataControl
String metadataControl
When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this
 audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.


sampleRate
Integer sampleRate
This value is always 48000. It represents the sample rate in Hz.








Class com.amazonaws.services.mediaconvert.model.AccelerationSettings extends Object implements Serializable


Serialized Fields


mode
String mode
Specify the conditions when the service will run your job with accelerated transcoding.








Class com.amazonaws.services.mediaconvert.model.AiffSettings extends Object implements Serializable


Serialized Fields


bitDepth
Integer bitDepth
Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track.


channels
Integer channels
Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For
 example, 1, 2, 4, 6, and so on, up to 64.


sampleRate
Integer sampleRate
Sample rate in hz.








Class com.amazonaws.services.mediaconvert.model.AncillarySourceSettings extends Object implements Serializable


Serialized Fields


convert608To708
String convert608To708
Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose
 Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using
 the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.


sourceAncillaryChannelNumber
Integer sourceAncillaryChannelNumber
Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for
 passthrough.


terminateCaptions
String terminateCaptions
By default, the service terminates any unterminated captions at the end of each input. If you want the caption to
 continue onto your next input, disable this setting.








Class com.amazonaws.services.mediaconvert.model.AssociateCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn
The ARN of the ACM certificate that you want to associate with your MediaConvert resource.








Class com.amazonaws.services.mediaconvert.model.AssociateCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediaconvert.model.AudioCodecSettings extends Object implements Serializable


Serialized Fields


aacSettings
AacSettings aacSettings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AAC. The service accepts one
 of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of
 Bitrate control mode (rateControlMode) to "VBR" or "CBR". In VBR mode, you control the audio quality with the
 setting VBR quality (vbrQuality). In CBR mode, you use the setting Bitrate (bitrate). Defaults and valid values
 depend on the rate control mode.


ac3Settings
Ac3Settings ac3Settings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3.


aiffSettings
AiffSettings aiffSettings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF.


codec
String codec
Type of Audio codec.


eac3AtmosSettings
Eac3AtmosSettings eac3AtmosSettings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3_ATMOS.


eac3Settings
Eac3Settings eac3Settings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3.


mp2Settings
Mp2Settings mp2Settings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2.


mp3Settings
Mp3Settings mp3Settings
Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3.


wavSettings
WavSettings wavSettings
Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV.








Class com.amazonaws.services.mediaconvert.model.AudioDescription extends Object implements Serializable


Serialized Fields


audioNormalizationSettings
AudioNormalizationSettings audioNormalizationSettings
Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.


audioSourceName
String audioSourceName
Specifies which audio data to use from each input. In the simplest case, specify an
 "Audio Selector":#inputs-audio_selector by name based on its order within each input. For example if you specify
 "Audio Selector 3", then the third audio selector will be used from each input. If an input does not have an
 "Audio Selector 3", then the audio selector marked as "default" in that input will be used. If there is no audio
 selector marked as "default", silence will be inserted for the duration of that input. Alternatively, an
 "Audio Selector Group":#inputs-audio_selector_group name may be specified, with similar default/silence behavior.
 If no audio_source_name is specified, then "Audio Selector 1" will be chosen automatically.


audioType
Integer audioType
Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are
 defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired
 Commentary, 4-255 = Reserved.


audioTypeControl
String audioTypeControl
When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the
 output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise
 the value in Audio Type is included in the output. Note that this field and audioType are both ignored if
 audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD.


codecSettings
AudioCodecSettings codecSettings
Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio
 encoding. The settings in this group vary depending on the value that you choose for Audio codec (Codec). For
 each codec enum that you choose, define the corresponding settings object. The following lists the codec enum,
 settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * MP3, Mp3Settings * WAV, WavSettings * AIFF,
 AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings


customLanguageCode
String customLanguageCode
Specify the language for this audio output track. The service puts this language code into your output audio
 track when you set Language code control (AudioLanguageCodeControl) to Use configured (USE_CONFIGURED). The
 service also uses your specified custom language code when you set Language code control
 (AudioLanguageCodeControl) to Follow input (FOLLOW_INPUT), but your input file doesn't specify a language code.
 For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other
 code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output
 groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.


languageCode
String languageCode
Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down
 will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected
 but there is no ISO 639 language code specified by the input.


languageCodeControl
String languageCodeControl
Specify which source for language code takes precedence for this audio track. When you choose Follow input
 (FOLLOW_INPUT), the service uses the language code from the input track if it's present. If there's no languge
 code on the input track, the service uses the code that you specify in the setting Language code (languageCode or
 customLanguageCode). When you choose Use configured (USE_CONFIGURED), the service uses the language code that you
 specify.


remixSettings
RemixSettings remixSettings
Advanced audio remixing settings.


streamName
String streamName
Specify a label for this output audio stream. For example, "English", "Director commentary", or "track_2". For
 streaming outputs, MediaConvert passes this information into destination manifests for display on the
 end-viewer's player device. For outputs in other output groups, the service ignores this setting.








Class com.amazonaws.services.mediaconvert.model.AudioNormalizationSettings extends Object implements Serializable


Serialized Fields


algorithm
String algorithm
Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of
 ungated average loudness for an entire piece of content, suitable for measurement of short-form content under
 ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of
 gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R
 BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak
 measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms,
 including configurations such as 7.1.


algorithmControl
String algorithmControl
When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured
 but not adjusted.


correctionGateLevel
Integer correctionGateLevel
Content measuring above this level will be corrected to the target level. Content measuring below this level will
 not be corrected. Gating only applies when not using real_time_correction.


loudnessLogging
String loudnessLogging
If set to LOG, log each output's audio track loudness to a CSV file.


peakCalculation
String peakCalculation
If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.


targetLkfs
Double targetLkfs
When you use Audio normalization (AudioNormalizationSettings), optionally use this setting to specify a target
 loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you
 choose for Algorithm (algorithm). If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the
 encoder will choose -23 LKFS.








Class com.amazonaws.services.mediaconvert.model.AudioSelector extends Object implements Serializable


Serialized Fields


customLanguageCode
String customLanguageCode
Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter
 language code


defaultSelection
String defaultSelection
Enable this setting on one audio selector to set it as the default for the job. The service uses this default for
 outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.


externalAudioFileInput
String externalAudioFileInput
Specifies audio data from an external file source.


languageCode
String languageCode
Selects a specific language code from within an audio source.


offset
Integer offset
Specifies a time delta in milliseconds to offset the audio from the input video.


pids
List<E> pids
Selects a specific PID from within an audio source (e.g. 257 selects PID 0x101).


programSelection
Integer programSelection
Use this setting for input streams that contain Dolby E, to have the service extract specific program data from
 the track. To select multiple programs, create multiple selectors with the same Track and different Program
 numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number
 from the dropdown list. If you are sending a JSON file, provide the program ID, which is part of the audio
 metadata. If your input file has incorrect metadata, you can choose All channels instead of a program number to
 have the service ignore the program IDs and include all the programs in the track.


remixSettings
RemixSettings remixSettings
Use these settings to reorder the audio channels of one input to match those of another input. This allows you to
 combine the two files into a single output, one after the other.


selectorType
String selectorType
Specifies the type of the audio selector.


tracks
List<E> tracks
Identify a track from the input audio to include in this selector by entering the track index number. To include
 several tracks in a single audio selector, specify multiple tracks as follows. Using the console, enter a
 comma-separated list. For examle, type "1,2,3" to include tracks 1 through 3. Specifying directly in your JSON job
 file, provide the track numbers in an array. For example, "tracks": [1,2,3].








Class com.amazonaws.services.mediaconvert.model.AudioSelectorGroup extends Object implements Serializable


Serialized Fields


audioSelectorNames
List<E> audioSelectorNames
Name of an Audio Selector within the same input to include in the group. Audio selector names are standardized,
 based on their order within the input (e.g., "Audio Selector 1"). The audio selector name parameter can be
 repeated to add any number of audio selectors to the group.








Class com.amazonaws.services.mediaconvert.model.AvailBlanking extends Object implements Serializable


Serialized Fields


availBlankingImage
String availBlankingImage
Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.








Class com.amazonaws.services.mediaconvert.model.AWSMediaConvertException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconvert.model.BadRequestException extends AWSMediaConvertException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconvert.model.BurninDestinationSettings extends Object implements Serializable


Serialized Fields


alignment
String alignment
If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the
 bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the
 output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified
 (either left or centered) relative to those coordinates. This option is not valid for source captions that are
 STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in
 and DVB-Sub font settings must match.


backgroundColor
String backgroundColor
Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.


backgroundOpacity
Integer backgroundOpacity
Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank
 is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.


fontColor
String fontColor
Specifies the color of the burned-in captions. This option is not valid for source captions that are STL,
 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and
 DVB-Sub font settings must match.


fontOpacity
Integer fontOpacity
Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font
 settings must match.


fontResolution
Integer fontResolution
Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.


fontScript
String fontScript
Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining
 the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is
 used to help determine the appropriate font for rendering burn-in captions.


fontSize
Integer fontSize
A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All
 burn-in and DVB-Sub font settings must match.


outlineColor
String outlineColor
Specifies font outline color. This option is not valid for source captions that are either 608/embedded or
 teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font
 settings must match.


outlineSize
Integer outlineSize
Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded
 or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font
 settings must match.


shadowColor
String shadowColor
Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.


shadowOpacity
Integer shadowOpacity
Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent
 to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.


shadowXOffset
Integer shadowXOffset
Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a
 shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.


shadowYOffset
Integer shadowYOffset
Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a
 shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.


teletextSpacing
String teletextSpacing
Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters
 in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to
 the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if
 the captions are closed caption.


xPosition
Integer xPosition
Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10
 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is
 provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid
 for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the
 caption stream. All burn-in and DVB-Sub font settings must match.


yPosition
Integer yPosition
Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would
 result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the
 caption will be positioned towards the bottom of the output. This option is not valid for source captions that are
 STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in
 and DVB-Sub font settings must match.








Class com.amazonaws.services.mediaconvert.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The Job ID of the job to be cancelled.








Class com.amazonaws.services.mediaconvert.model.CancelJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediaconvert.model.CaptionDescription extends Object implements Serializable


Serialized Fields


captionSelectorName
String captionSelectorName
Specifies which "Caption Selector":#inputs-caption_selector to use from each input when generating captions. The
 name should be of the format "Caption Selector ", which denotes that the Nth Caption Selector will be used
 from each input.


customLanguageCode
String customLanguageCode
Specify the language for this captions output track. For most captions output formats, the encoder puts this
 language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the
 encoder uses this language information when automatically selecting the font script for rendering the captions
 text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any
 other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output
 groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.


destinationSettings
CaptionDestinationSettings destinationSettings
Specific settings required by destination type. Note that burnin_destination_settings are not available if the
 source of the caption data is Embedded or Teletext.


languageCode
String languageCode
Specify the language of this captions output track. For most captions output formats, the encoder puts this
 language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the
 encoder uses this language information to choose the font language for rendering the captions text.


languageDescription
String languageDescription
Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For
 streaming outputs, MediaConvert passes this information into destination manifests for display on the
 end-viewer's player device. For outputs in other output groups, the service ignores this setting.








Class com.amazonaws.services.mediaconvert.model.CaptionDescriptionPreset extends Object implements Serializable


Serialized Fields


customLanguageCode
String customLanguageCode
Specify the language for this captions output track. For most captions output formats, the encoder puts this
 language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the
 encoder uses this language information when automatically selecting the font script for rendering the captions
 text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any
 other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output
 groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.


destinationSettings
CaptionDestinationSettings destinationSettings
Specific settings required by destination type. Note that burnin_destination_settings are not available if the
 source of the caption data is Embedded or Teletext.


languageCode
String languageCode
Specify the language of this captions output track. For most captions output formats, the encoder puts this
 language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the
 encoder uses this language information to choose the font language for rendering the captions text.


languageDescription
String languageDescription
Specify a label for this set of output captions. For example, "English", "Director commentary", or "track_2". For
 streaming outputs, MediaConvert passes this information into destination manifests for display on the
 end-viewer's player device. For outputs in other output groups, the service ignores this setting.








Class com.amazonaws.services.mediaconvert.model.CaptionDestinationSettings extends Object implements Serializable


Serialized Fields


burninDestinationSettings
BurninDestinationSettings burninDestinationSettings
Burn-In Destination Settings.


destinationType
String destinationType
Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other
 options are embedded with SCTE-20, burn-in, DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are
 using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the
 SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus
 SCTE-20 (EMBEDDED_PLUS_SCTE20).


dvbSubDestinationSettings
DvbSubDestinationSettings dvbSubDestinationSettings
DVB-Sub Destination Settings


embeddedDestinationSettings
EmbeddedDestinationSettings embeddedDestinationSettings
Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number.


imscDestinationSettings
ImscDestinationSettings imscDestinationSettings
Settings specific to IMSC caption outputs.


sccDestinationSettings
SccDestinationSettings sccDestinationSettings
Settings for SCC caption output.


teletextDestinationSettings
TeletextDestinationSettings teletextDestinationSettings
Settings for Teletext caption output


ttmlDestinationSettings
TtmlDestinationSettings ttmlDestinationSettings
Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).








Class com.amazonaws.services.mediaconvert.model.CaptionSelector extends Object implements Serializable


Serialized Fields


customLanguageCode
String customLanguageCode
The specific language to extract from source, using the ISO 639-2 or ISO 639-3 three-letter language code. If
 input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub
 and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If
 input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a
 specific language with pass-through captions.


languageCode
String languageCode
The specific language to extract from source. If input is SCTE-27, complete this field and/or PID to select the
 caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or
 PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field
 (and PID field); there is no way to extract a specific language with pass-through captions.


sourceSettings
CaptionSourceSettings sourceSettings
If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input
 captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of
 FileSoureSettings.








Class com.amazonaws.services.mediaconvert.model.CaptionSourceSettings extends Object implements Serializable


Serialized Fields


ancillarySourceSettings
AncillarySourceSettings ancillarySourceSettings
Settings for ancillary captions source.


dvbSubSourceSettings
DvbSubSourceSettings dvbSubSourceSettings
DVB Sub Source Settings


embeddedSourceSettings
EmbeddedSourceSettings embeddedSourceSettings
Settings for embedded captions Source


fileSourceSettings
FileSourceSettings fileSourceSettings
If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input
 caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of
 FileSoureSettings.


sourceType
String sourceType
Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption
 format.


teletextSourceSettings
TeletextSourceSettings teletextSourceSettings
Settings specific to Teletext caption sources, including Page number.


trackSourceSettings
TrackSourceSettings trackSourceSettings
Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in
 an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of
 TrackSourceSettings.








Class com.amazonaws.services.mediaconvert.model.ChannelMapping extends Object implements Serializable


Serialized Fields


outputChannels
List<E> outputChannels
List of output channels








Class com.amazonaws.services.mediaconvert.model.CmafAdditionalManifest extends Object implements Serializable


Serialized Fields


manifestNameModifier
String manifestNameModifier
Specify a name modifier that the service adds to the name of this manifest to make it different from the file
 names of the other main manifests in the output group. For example, say that the default main manifest for your
 HLS group is film-name.m3u8. If you enter "-no-premium" for this setting, then the file name the service generates
 for this top-level manifest is film-name-no-premium.m3u8. For HLS output groups, specify a manifestNameModifier
 that is different from the nameModifier of the output. The service uses the output name modifier to create unique
 names for the individual variant manifests.


selectedOutputs
List<E> selectedOutputs
Specify the outputs that you want this additional top-level manifest to reference.








Class com.amazonaws.services.mediaconvert.model.CmafEncryptionSettings extends Object implements Serializable


Serialized Fields


constantInitializationVector
String constantInitializationVector
This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then
 the Initialization Vector will follow the segment number by default.


encryptionMethod
String encryptionMethod
Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC
 subsample (SAMPLE-AES) or AES_CTR (AES-CTR).


initializationVectorInManifest
String initializationVectorInManifest
When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization
 vector in the HLS and DASH manifests.


spekeKeyProvider
SpekeKeyProviderCmaf spekeKeyProvider
If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key
 provider. If your output group type is HLS, DASH, or Microsoft Smooth, use the SpekeKeyProvider settings instead.


staticKeyProvider
StaticKeyProvider staticKeyProvider
Use these settings to set up encryption with a static key provider.


type
String type
Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For
 more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.








Class com.amazonaws.services.mediaconvert.model.CmafGroupSettings extends Object implements Serializable


Serialized Fields


additionalManifests
List<E> additionalManifests
By default, the service creates one top-level .m3u8 HLS manifest and one top -level .mpd DASH manifest for each
 CMAF output group in your job. These default manifests reference every output in the output group. To create
 additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them
 here. For each additional manifest that you specify, the service creates one HLS manifest and one DASH manifest.


baseUrl
String baseUrl
A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if
 streams are delivered from a different URL than the manifest file.


clientCache
String clientCache
When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later
 replay.


codecSpecification
String codecSpecification
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.


destination
String destination
Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts
 format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the
 input file. If your job has multiple inputs, the service uses the filename of the first input file.


destinationSettings
DestinationSettings destinationSettings
Settings associated with the destination. Will vary based on the type of destination


encryption
CmafEncryptionSettings encryption
DRM settings.


fragmentLength
Integer fragmentLength
Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate.
 Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be
 longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not
 cause the creation of many output files as in other output types.


manifestCompression
String manifestCompression
When set to GZIP, compresses HLS playlist.


manifestDurationFormat
String manifestDurationFormat
Indicates whether the output manifest should use floating point values for segment duration.


minBufferTime
Integer minBufferTime
Minimum time of initially buffered media that is needed to ensure smooth playout.


minFinalSegmentLength
Double minFinalSegmentLength
Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back
 the end of your video asset. If you know that player devices are hanging on the final segment of your video
 because the length of your final segment is too short, use this setting to specify a minimum final segment length,
 in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify
 a value for this setting, the encoder will combine any final segment that is shorter than the length that you
 specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5
 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final
 segment is 3.5 seconds.


mpdProfile
String mpdProfile
Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service
 signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand
 (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose
 On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file
 (SINGLE_FILE).


segmentControl
String segmentControl
When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment
 Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.


segmentLength
Integer segmentLength
Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the
 whole package; that is, to every output in the output group. Note that segments end on the first keyframe after
 this number of seconds, so the actual segment length might be slightly longer. If you set Segment control
 (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has
 metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each
 output, each with the content of one segment.


streamInfResolution
String streamInfResolution
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.


writeDashManifest
String writeDashManifest
When set to ENABLED, a DASH MPD manifest will be generated for this output.


writeHlsManifest
String writeHlsManifest
When set to ENABLED, an Apple HLS manifest will be generated for this output.


writeSegmentTimelineInRepresentation
String writeSegmentTimelineInRepresentation
When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH
 manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline
 element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment
 durations in your DASH manifest are approximate. The segment duration information appears in the duration
 attribute of the SegmentTemplate element.








Class com.amazonaws.services.mediaconvert.model.CmfcSettings extends Object implements Serializable


Serialized Fields


scte35Esam
String scte35Esam
Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this
 output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC
 XML (sccXml).


scte35Source
String scte35Source
Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if
 you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't
 want those SCTE-35 markers in this output.








Class com.amazonaws.services.mediaconvert.model.ColorCorrector extends Object implements Serializable


Serialized Fields


brightness
Integer brightness
Brightness level.


colorSpaceConversion
String colorSpaceConversion
Specify the color space you want for this output. The service supports conversion between HDR formats, between
 SDR formats, and from SDR to HDR. The service doesn't support conversion from HDR to SDR. SDR to HDR conversion
 doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an
 unconverted output.


contrast
Integer contrast
Contrast level.


hdr10Metadata
Hdr10Metadata hdr10Metadata
Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color
 Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are
 encoded in the video stream. They are intended to help the downstream video player display content in a way that
 reflects the intentions of the the content creator. When you set Color space conversion (ColorSpaceConversion) to
 HDR 10 (FORCE_HDR10), these settings are required. You must set values for Max frame average light level
 (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a
 default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For
 more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.


hue
Integer hue
Hue in degrees.


saturation
Integer saturation
Saturation level.








Class com.amazonaws.services.mediaconvert.model.ConflictException extends AWSMediaConvertException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconvert.model.ContainerSettings extends Object implements Serializable


Serialized Fields


cmfcSettings
CmfcSettings cmfcSettings
Settings for MP4 segments in CMAF


container
String container
Container for this output. Some containers require a container settings object. If not specified, the default
 object will be created.


f4vSettings
F4vSettings f4vSettings
Settings for F4v container


m2tsSettings
M2tsSettings m2tsSettings
MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container
 (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table
 (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these
 subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds
 to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems
 and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs
 to locate specific data within the asset.


m3u8Settings
M3u8Settings m3u8Settings
Settings for TS segments in HLS


movSettings
MovSettings movSettings
Settings for MOV Container.


mp4Settings
Mp4Settings mp4Settings
Settings for MP4 container. You can create audio-only AAC outputs with this container.


mpdSettings
MpdSettings mpdSettings
Settings for MP4 segments in DASH








Class com.amazonaws.services.mediaconvert.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accelerationSettings
AccelerationSettings accelerationSettings
Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use
 this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental
 MediaConvert User Guide.


billingTagsSource
String billingTagsSource
Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert
 costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will
 appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will
 appear on the billing report unsorted.


clientRequestToken
String clientRequestToken
Idempotency token for CreateJob operation.


jobTemplate
String jobTemplate
When you create a job, you can either specify a job template or specify the transcoding settings individually


priority
Integer priority
Specify the relative priority for this job. In any given queue, the service begins processing the job with the
 highest value first. When more than one job has the same priority, the service begins processing the job that you
 submitted first. If you don't specify a priority, the service uses the default value 0.


queue
String queue
Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to
 the default queue. For more about queues, see the User Guide topic at
 http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.


role
String role
Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at
 the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.


settings
JobSettings settings
JobSettings contains all the transcode settings for a job.


simulateReservedQueue
String simulateReservedQueue
Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When
 this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see
 with one RTS in a reserved queue. This setting is disabled by default.


statusUpdateInterval
String statusUpdateInterval
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in
 seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins
 processing your job to the time it completes the transcode or encounters an error.


tags
Map<K,V> tags
The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.


userMetadata
Map<K,V> userMetadata
User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value
 pairs.








Class com.amazonaws.services.mediaconvert.model.CreateJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


job
Job job
Each job converts an input file into an output file or files. For more information, see the User Guide at
 http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html








Class com.amazonaws.services.mediaconvert.model.CreateJobTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accelerationSettings
AccelerationSettings accelerationSettings
Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use
 this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental
 MediaConvert User Guide.


category
String category
Optional. A category for the job template you are creating


description
String description
Optional. A description of the job template you are creating.


name
String name
The name of the job template you are creating.


priority
Integer priority
Specify the relative priority for this job. In any given queue, the service begins processing the job with the
 highest value first. When more than one job has the same priority, the service begins processing the job that you
 submitted first. If you don't specify a priority, the service uses the default value 0.


queue
String queue
Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go
 to the default queue.


settings
JobTemplateSettings settings
JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs
 created from it.


statusUpdateInterval
String statusUpdateInterval
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in
 seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins
 processing your job to the time it completes the transcode or encounters an error.


tags
Map<K,V> tags
The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.








Class com.amazonaws.services.mediaconvert.model.CreateJobTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobTemplate
JobTemplate jobTemplate
A job template is a pre-made set of encoding instructions that you can use to quickly create a job.








Class com.amazonaws.services.mediaconvert.model.CreatePresetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


category
String category
Optional. A category for the preset you are creating.


description
String description
Optional. A description of the preset you are creating.


name
String name
The name of the preset you are creating.


settings
PresetSettings settings
Settings for preset


tags
Map<K,V> tags
The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.








Class com.amazonaws.services.mediaconvert.model.CreatePresetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


preset
Preset preset
A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the
 output during the conversion process.








Class com.amazonaws.services.mediaconvert.model.CreateQueueRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description
Optional. A description of the queue that you are creating.


name
String name
The name of the queue that you are creating.


pricingPlan
String pricingPlan
Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute,
 billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue,
 regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. When you use the
 API to create a queue, the default is on-demand.


reservationPlanSettings
ReservationPlanSettings reservationPlanSettings
Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to
 on-demand queues.


status
String status
Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.


tags
Map<K,V> tags
The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.








Class com.amazonaws.services.mediaconvert.model.CreateQueueResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


queue
Queue queue
You can use queues to manage the resources that are available to your AWS account for running multiple
 transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default
 queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.








Class com.amazonaws.services.mediaconvert.model.DashAdditionalManifest extends Object implements Serializable


Serialized Fields


manifestNameModifier
String manifestNameModifier
Specify a name modifier that the service adds to the name of this manifest to make it different from the file
 names of the other main manifests in the output group. For example, say that the default main manifest for your
 DASH group is film-name.mpd. If you enter "-no-premium" for this setting, then the file name the service generates
 for this top-level manifest is film-name-no-premium.mpd.


selectedOutputs
List<E> selectedOutputs
Specify the outputs that you want this additional top-level manifest to reference.








Class com.amazonaws.services.mediaconvert.model.DashIsoEncryptionSettings extends Object implements Serializable


Serialized Fields


playbackDeviceCompatibility
String playbackDeviceCompatibility
This setting can improve the compatibility of your output with video players on obsolete devices. It applies only
 to DASH H.264 outputs with DRM encryption. Choose Unencrypted SEI (UNENCRYPTED_SEI) only to correct problems with
 playback on older devices. Otherwise, keep the default setting CENC v1 (CENC_V1). If you choose Unencrypted SEI,
 for that output, the service will exclude the access unit delimiter and will leave the SEI NAL units unencrypted.


spekeKeyProvider
SpekeKeyProvider spekeKeyProvider
If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a
 SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.








Class com.amazonaws.services.mediaconvert.model.DashIsoGroupSettings extends Object implements Serializable


Serialized Fields


additionalManifests
List<E> additionalManifests
By default, the service creates one .mpd DASH manifest for each DASH ISO output group in your job. This default
 manifest references every output in the output group. To create additional DASH manifests that reference a subset
 of the outputs in the output group, specify a list of them here.


baseUrl
String baseUrl
A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used
 if streams are delivered from a different URL than the manifest file.


destination
String destination
Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts
 format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the
 input file. If your job has multiple inputs, the service uses the filename of the first input file.


destinationSettings
DestinationSettings destinationSettings
Settings associated with the destination. Will vary based on the type of destination


encryption
DashIsoEncryptionSettings encryption
DRM settings.


fragmentLength
Integer fragmentLength
Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate.
 Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be
 longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not
 cause the creation of many output files as in other output types.


hbbtvCompliance
String hbbtvCompliance
Supports HbbTV specification as indicated


minBufferTime
Integer minBufferTime
Minimum time of initially buffered media that is needed to ensure smooth playout.


mpdProfile
String mpdProfile
Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service
 signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand
 (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose
 On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file
 (SINGLE_FILE).


segmentControl
String segmentControl
When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment
 Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.


segmentLength
Integer segmentLength
Length of mpd segments to create (in seconds). Note that segments will end on the next keyframe after this number
 of seconds, so actual segment length may be longer. When Emit Single File is checked, the segmentation is
 internal to a single output file and it does not cause the creation of many output files as in other output types.


writeSegmentTimelineInRepresentation
String writeSegmentTimelineInRepresentation
If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your
 transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH
 manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at
 the Representation level. When you don't enable this setting, the service writes approximate segment durations in
 your DASH manifest.








Class com.amazonaws.services.mediaconvert.model.Deinterlacer extends Object implements Serializable


Serialized Fields


algorithm
String algorithm
Only applies when you set Deinterlacer (DeinterlaceMode) to Deinterlace (DEINTERLACE) or Adaptive (ADAPTIVE).
 Motion adaptive interpolate (INTERPOLATE) produces sharper pictures, while blend (BLEND) produces smoother
 motion. Use (INTERPOLATE_TICKER) OR (BLEND_TICKER) if your source file includes a ticker, such as a scrolling
 headline at the bottom of the frame.


control
String control
- When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as
 progressive. It will only convert those that are tagged as some other type. - When set to FORCE_ALL_FRAMES, the
 deinterlacer converts every frame to progressive - even those that are already tagged as progressive. Turn Force
 mode on only if there is a good chance that the metadata has tagged frames as progressive when they are not
 progressive. Do not turn on otherwise; processing frames that are already progressive into progressive will
 probably result in lower quality video.


mode
String mode
Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. -
 Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive
 23.976p. - Adaptive auto-detects and converts to progressive.








Class com.amazonaws.services.mediaconvert.model.DeleteJobTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name
The name of the job template to be deleted.








Class com.amazonaws.services.mediaconvert.model.DeleteJobTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediaconvert.model.DeletePresetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name
The name of the preset to be deleted.








Class com.amazonaws.services.mediaconvert.model.DeletePresetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediaconvert.model.DeleteQueueRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name
The name of the queue that you want to delete.








Class com.amazonaws.services.mediaconvert.model.DeleteQueueResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediaconvert.model.DescribeEndpointsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults
Optional. Max number of endpoints, up to twenty, that will be returned at one time.


mode
String mode
Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or
 to create an endpoint for you and return it if one doesn't already exist. Specify GET_ONLY to return your
 endpoints if any exist, or an empty list if none exist.


nextToken
String nextToken
Use this string, provided with the response to a previous request, to request the next batch of endpoints.








Class com.amazonaws.services.mediaconvert.model.DescribeEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


endpoints
List<E> endpoints
List of endpoints


nextToken
String nextToken
Use this string to request the next batch of endpoints.








Class com.amazonaws.services.mediaconvert.model.DestinationSettings extends Object implements Serializable


Serialized Fields


s3Settings
S3DestinationSettings s3Settings
Settings associated with S3 destination








Class com.amazonaws.services.mediaconvert.model.DisassociateCertificateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn
The ARN of the ACM certificate that you want to disassociate from your MediaConvert resource.








Class com.amazonaws.services.mediaconvert.model.DisassociateCertificateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediaconvert.model.DolbyVision extends Object implements Serializable


Serialized Fields


l6Metadata
DolbyVisionLevel6Metadata l6Metadata
Use these settings when you set DolbyVisionLevel6Mode to SPECIFY to override the MaxCLL and MaxFALL values in
 your input with new values.


l6Mode
String l6Mode
Use Dolby Vision Mode to choose how the service will handle Dolby Vision MaxCLL and MaxFALL properies.


profile
String profile
In the current MediaConvert implementation, the Dolby Vision profile is always 5 (PROFILE_5). Therefore, all of
 your inputs must contain Dolby Vision frame interleaved data.








Class com.amazonaws.services.mediaconvert.model.DolbyVisionLevel6Metadata extends Object implements Serializable


Serialized Fields


maxCll
Integer maxCll
Maximum Content Light Level. Static HDR metadata that corresponds to the brightest pixel in the entire stream.
 Measured in nits.


maxFall
Integer maxFall
Maximum Frame-Average Light Level. Static HDR metadata that corresponds to the highest frame-average brightness
 in the entire stream. Measured in nits.








Class com.amazonaws.services.mediaconvert.model.DvbNitSettings extends Object implements Serializable


Serialized Fields


networkId
Integer networkId
The numeric value placed in the Network Information Table (NIT).


networkName
String networkName
The network name text placed in the network_name_descriptor inside the Network Information Table. Maximum length
 is 256 characters.


nitInterval
Integer nitInterval
The number of milliseconds between instances of this table in the output transport stream.








Class com.amazonaws.services.mediaconvert.model.DvbSdtSettings extends Object implements Serializable


Serialized Fields


outputSdt
String outputSdt
Selects method of inserting SDT information into output stream. "Follow input SDT" copies SDT information from
 input stream to output stream. "Follow input SDT if present" copies SDT information from input stream to output
 stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. Enter
 "SDT  Manually" means user will enter the SDT information. "No SDT" means output stream will not contain SDT
 information.


sdtInterval
Integer sdtInterval
The number of milliseconds between instances of this table in the output transport stream.


serviceName
String serviceName
The service name placed in the service_descriptor in the Service Description Table. Maximum length is 256
 characters.


serviceProviderName
String serviceProviderName
The service provider name placed in the service_descriptor in the Service Description Table. Maximum length is
 256 characters.








Class com.amazonaws.services.mediaconvert.model.DvbSubDestinationSettings extends Object implements Serializable


Serialized Fields


alignment
String alignment
If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the
 bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the
 output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified
 (either left or centered) relative to those coordinates. This option is not valid for source captions that are
 STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in
 and DVB-Sub font settings must match.


backgroundColor
String backgroundColor
Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.


backgroundOpacity
Integer backgroundOpacity
Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank
 is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.


fontColor
String fontColor
Specifies the color of the burned-in captions. This option is not valid for source captions that are STL,
 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and
 DVB-Sub font settings must match.


fontOpacity
Integer fontOpacity
Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font
 settings must match.


fontResolution
Integer fontResolution
Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.


fontScript
String fontScript
Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining
 the script type. Where LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or leave unset. This is
 used to help determine the appropriate font for rendering DVB-Sub captions.


fontSize
Integer fontSize
A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All
 burn-in and DVB-Sub font settings must match.


outlineColor
String outlineColor
Specifies font outline color. This option is not valid for source captions that are either 608/embedded or
 teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font
 settings must match.


outlineSize
Integer outlineSize
Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded
 or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font
 settings must match.


shadowColor
String shadowColor
Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.


shadowOpacity
Integer shadowOpacity
Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent
 to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.


shadowXOffset
Integer shadowXOffset
Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a
 shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.


shadowYOffset
Integer shadowYOffset
Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a
 shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.


subtitlingType
String subtitlingType
Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your
 subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.


teletextSpacing
String teletextSpacing
Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters
 in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to
 the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if
 the captions are closed caption.


xPosition
Integer xPosition
Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10
 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is
 provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid
 for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the
 caption stream. All burn-in and DVB-Sub font settings must match.


yPosition
Integer yPosition
Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would
 result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the
 caption will be positioned towards the bottom of the output. This option is not valid for source captions that are
 STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in
 and DVB-Sub font settings must match.








Class com.amazonaws.services.mediaconvert.model.DvbSubSourceSettings extends Object implements Serializable


Serialized Fields


pid
Integer pid
When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough.
 All DVB-Sub content is passed through, regardless of selectors.








Class com.amazonaws.services.mediaconvert.model.DvbTdtSettings extends Object implements Serializable


Serialized Fields


tdtInterval
Integer tdtInterval
The number of milliseconds between instances of this table in the output transport stream.








Class com.amazonaws.services.mediaconvert.model.Eac3AtmosSettings extends Object implements Serializable


Serialized Fields


bitrate
Integer bitrate
Specify the average bitrate in bits per second. Valid values: 384k, 448k, 640k, 768k


bitstreamMode
String bitstreamMode
Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3
 bitstream mode, see ATSC A/52-2012 (Annex E).


codingMode
String codingMode
The coding mode for Dolby Digital Plus JOC (Atmos) is always 9.1.6 (CODING_MODE_9_1_6).


dialogueIntelligence
String dialogueIntelligence
Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis.


dynamicRangeCompressionLine
String dynamicRangeCompressionLine
Specify the absolute peak level for a signal with dynamic range compression.


dynamicRangeCompressionRf
String dynamicRangeCompressionRf
Specify how the service limits the audio dynamic range when compressing the audio.


loRoCenterMixLevel
Double loRoCenterMixLevel
Specify a value for the following Dolby Atmos setting: Left only/Right only center mix (Lo/Ro center).
 MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose
 for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0.


loRoSurroundMixLevel
Double loRoSurroundMixLevel
Specify a value for the following Dolby Atmos setting: Left only/Right only (Lo/Ro surround). MediaConvert uses
 this value for downmixing. How the service uses this value depends on the value that you choose for Stereo
 downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel.


ltRtCenterMixLevel
Double ltRtCenterMixLevel
Specify a value for the following Dolby Atmos setting: Left total/Right total center mix (Lt/Rt center).
 MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose
 for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0.


ltRtSurroundMixLevel
Double ltRtSurroundMixLevel
Specify a value for the following Dolby Atmos setting: Left total/Right total surround mix (Lt/Rt surround).
 MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose
 for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes
 the channel.


meteringMode
String meteringMode
Choose how the service meters the loudness of your audio.


sampleRate
Integer sampleRate
This value is always 48000. It represents the sample rate in Hz.


speechThreshold
Integer speechThreshold
Specify the percentage of audio content that must be speech before the encoder uses the measured speech loudness
 as the overall program loudness.


stereoDownmix
String stereoDownmix
Choose how the service does stereo downmixing.


surroundExMode
String surroundExMode
Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and
 right surround channels.








Class com.amazonaws.services.mediaconvert.model.Eac3Settings extends Object implements Serializable


Serialized Fields


attenuationControl
String attenuationControl
If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.


bitrate
Integer bitrate
Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode.


bitstreamMode
String bitstreamMode
Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3
 bitstream mode, see ATSC A/52-2012 (Annex E).


codingMode
String codingMode
Dolby Digital Plus coding mode. Determines number of channels.


dcFilter
String dcFilter
Activates a DC highpass filter for all input channels.


dialnorm
Integer dialnorm
Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed
 through.


dynamicRangeCompressionLine
String dynamicRangeCompressionLine
Specify the absolute peak level for a signal with dynamic range compression.


dynamicRangeCompressionRf
String dynamicRangeCompressionRf
Specify how the service limits the audio dynamic range when compressing the audio.


lfeControl
String lfeControl
When encoding 3/2 audio, controls whether the LFE channel is enabled


lfeFilter
String lfeFilter
Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.


loRoCenterMixLevel
Double loRoCenterMixLevel
Specify a value for the following Dolby Digital Plus setting: Left only/Right only center mix (Lo/Ro center).
 MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose
 for Stereo downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value
 -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs
 (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode,
 the service ignores Left only/Right only center (loRoCenterMixLevel).


loRoSurroundMixLevel
Double loRoSurroundMixLevel
Specify a value for the following Dolby Digital Plus setting: Left only/Right only (Lo/Ro surround). MediaConvert
 uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo
 downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This
 setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting
 Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left only/Right
 only surround (loRoSurroundMixLevel).


ltRtCenterMixLevel
Double ltRtCenterMixLevel
Specify a value for the following Dolby Digital Plus setting: Left total/Right total center mix (Lt/Rt center).
 MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose
 for Stereo downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value
 -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs
 (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode,
 the service ignores Left total/Right total center (ltRtCenterMixLevel).


ltRtSurroundMixLevel
Double ltRtSurroundMixLevel
Specify a value for the following Dolby Digital Plus setting: Left total/Right total surround mix (Lt/Rt
 surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that
 you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60
 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs
 (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode,
 the service ignores Left total/Right total surround (ltRtSurroundMixLevel).


metadataControl
String metadataControl
When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this
 audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.


passthroughControl
String passthroughControl
When set to WHEN_POSSIBLE, input DD+ audio will be passed through if it is present on the input. this detection
 is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a
 consistent DD+ output as the system alternates between passthrough and encoding.


phaseControl
String phaseControl
Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode.


sampleRate
Integer sampleRate
This value is always 48000. It represents the sample rate in Hz.


stereoDownmix
String stereoDownmix
Choose how the service does stereo downmixing. This setting only applies if you keep the default value of 3/2 -
 L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value
 for Coding mode, the service ignores Stereo downmix (Eac3StereoDownmix).


surroundExMode
String surroundExMode
When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and
 right surround channels.


surroundMode
String surroundMode
When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.








Class com.amazonaws.services.mediaconvert.model.EmbeddedDestinationSettings extends Object implements Serializable


Serialized Fields


destination608ChannelNumber
Integer destination608ChannelNumber
Ignore this setting unless your input captions are SCC format and your output captions are embedded in the video
 stream. Specify a CC number for each captions channel in this output. If you have two channels, choose CC numbers
 that aren't in the same field. For example, choose 1 and 3. For more information, see
 https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded.


destination708ServiceNumber
Integer destination708ServiceNumber
Ignore this setting unless your input captions are SCC format and you want both 608 and 708 captions embedded in
 your output stream. Optionally, specify the 708 service number for each output captions channel. Choose a
 different number for each channel. To use this setting, also set Force 608 to 708 upconvert (Convert608To708) to
 Upconvert (UPCONVERT) in your input captions selector settings. If you choose to upconvert but don't specify a 708
 service number, MediaConvert uses the number that you specify for CC channel number (destination608ChannelNumber)
 for the 708 service number. For more information, see
 https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded.








Class com.amazonaws.services.mediaconvert.model.EmbeddedSourceSettings extends Object implements Serializable


Serialized Fields


convert608To708
String convert608To708
Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose
 Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using
 the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.


source608ChannelNumber
Integer source608ChannelNumber
Specifies the 608/708 channel number within the video track from which to extract captions. Unused for
 passthrough.


source608TrackNumber
Integer source608TrackNumber
Specifies the video track index used for extracting captions. The system only supports one input video track, so
 this should always be set to '1'.


terminateCaptions
String terminateCaptions
By default, the service terminates any unterminated captions at the end of each input. If you want the caption to
 continue onto your next input, disable this setting.








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


Serialized Fields


url
String url
URL of endpoint








Class com.amazonaws.services.mediaconvert.model.EsamManifestConfirmConditionNotification extends Object implements Serializable


Serialized Fields


mccXml
String mccXml
Provide your ESAM ManifestConfirmConditionNotification XML document inside your JSON job settings. Form the XML
 document as per OC-SP-ESAM-API-I03-131025. The transcoder will use the Manifest Conditioning instructions in the
 message that you supply.








Class com.amazonaws.services.mediaconvert.model.EsamSettings extends Object implements Serializable


Serialized Fields


manifestConfirmConditionNotification
EsamManifestConfirmConditionNotification manifestConfirmConditionNotification
Specifies an ESAM ManifestConfirmConditionNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses
 the manifest conditioning instructions that you provide in the setting MCC XML (mccXml).


responseSignalPreroll
Integer responseSignalPreroll
Specifies the stream distance, in milliseconds, between the SCTE 35 messages that the transcoder places and the
 splice points that they refer to. If the time between the start of the asset and the SCTE-35 message is less than
 this value, then the transcoder places the SCTE-35 marker at the beginning of the stream.


signalProcessingNotification
EsamSignalProcessingNotification signalProcessingNotification
Specifies an ESAM SignalProcessingNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the
 signal processing instructions that you provide in the setting SCC XML (sccXml).








Class com.amazonaws.services.mediaconvert.model.EsamSignalProcessingNotification extends Object implements Serializable


Serialized Fields


sccXml
String sccXml
Provide your ESAM SignalProcessingNotification XML document inside your JSON job settings. Form the XML document
 as per OC-SP-ESAM-API-I03-131025. The transcoder will use the signal processing instructions in the message that
 you supply. Provide your ESAM SignalProcessingNotification XML document inside your JSON job settings. For your
 MPEG2-TS file outputs, if you want the service to place SCTE-35 markers at the insertion points you specify in the
 XML document, you must also enable SCTE-35 ESAM (scte35Esam). Note that you can either specify an ESAM XML
 document or enable SCTE-35 passthrough. You can't do both.








Class com.amazonaws.services.mediaconvert.model.F4vSettings extends Object implements Serializable


Serialized Fields


moovPlacement
String moovPlacement
If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for
 progressive downloading. Otherwise it is placed normally at the end.








Class com.amazonaws.services.mediaconvert.model.FileGroupSettings extends Object implements Serializable


Serialized Fields


destination
String destination
Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts
 format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the
 input file. If your job has multiple inputs, the service uses the filename of the first input file.


destinationSettings
DestinationSettings destinationSettings
Settings associated with the destination. Will vary based on the type of destination








Class com.amazonaws.services.mediaconvert.model.FileSourceSettings extends Object implements Serializable


Serialized Fields


convert608To708
String convert608To708
Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose
 Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using
 the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.


sourceFile
String sourceFile
External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl',
 'srt', 'xml', and 'smi'.


timeDelta
Integer timeDelta
Specifies a time delta in seconds to offset the captions from the source file.








Class com.amazonaws.services.mediaconvert.model.ForbiddenException extends AWSMediaConvertException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconvert.model.FrameCaptureSettings extends Object implements Serializable


Serialized Fields


framerateDenominator
Integer framerateDenominator
Frame capture will encode the first frame of the output stream, then one frame every
 framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
 framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s.
 Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture.


framerateNumerator
Integer framerateNumerator
Frame capture will encode the first frame of the output stream, then one frame every
 framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and
 framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s.
 Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal
 places.


maxCaptures
Integer maxCaptures
Maximum number of captures (encoded jpg output files).


quality
Integer quality
JPEG Quality - a higher value equals higher quality.








Class com.amazonaws.services.mediaconvert.model.GetJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
the job ID of the job.








Class com.amazonaws.services.mediaconvert.model.GetJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


job
Job job
Each job converts an input file into an output file or files. For more information, see the User Guide at
 http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html








Class com.amazonaws.services.mediaconvert.model.GetJobTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name
The name of the job template.








Class com.amazonaws.services.mediaconvert.model.GetJobTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobTemplate
JobTemplate jobTemplate
A job template is a pre-made set of encoding instructions that you can use to quickly create a job.








Class com.amazonaws.services.mediaconvert.model.GetPresetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name
The name of the preset.








Class com.amazonaws.services.mediaconvert.model.GetPresetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


preset
Preset preset
A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the
 output during the conversion process.








Class com.amazonaws.services.mediaconvert.model.GetQueueRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name
The name of the queue that you want information about.








Class com.amazonaws.services.mediaconvert.model.GetQueueResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


queue
Queue queue
You can use queues to manage the resources that are available to your AWS account for running multiple
 transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default
 queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.








Class com.amazonaws.services.mediaconvert.model.H264QvbrSettings extends Object implements Serializable


Serialized Fields


maxAverageBitrate
Integer maxAverageBitrate
Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average
 bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video
 part of this output to the value that you choose. That is, the total size of the video element is less than or
 equal to the value you set multiplied by the number of seconds of encoded output.


qvbrQualityLevel
Integer qvbrQualityLevel
Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h264Settings. Specify
 the target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results
 in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9.








Class com.amazonaws.services.mediaconvert.model.H264Settings extends Object implements Serializable


Serialized Fields


adaptiveQuantization
String adaptiveQuantization
Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.


bitrate
Integer bitrate
Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be
 unique when rounded down to the nearest multiple of 1000.


codecLevel
String codecLevel
Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to
 specify, choose Auto (AUTO).


codecProfile
String codecProfile
H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License.


dynamicSubGop
String dynamicSubGop
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use
 fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more
 B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the
 setting B frames between reference frames (numberBFramesBetweenReferenceFrames).


entropyEncoding
String entropyEncoding
Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC.


fieldEncoding
String fieldEncoding
Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs.


flickerAdaptiveQuantization
String flickerAdaptiveQuantization
Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.


framerateControl
String framerateControl
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to
 keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion,
 choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal
 approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your
 transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the
 service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the
 frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the
 settings FramerateNumerator and FramerateDenominator.


framerateConversionAlgorithm
String framerateConversionAlgorithm
When set to INTERPOLATE, produces smoother motion during frame rate conversion.


framerateDenominator
Integer framerateDenominator
When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For
 example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this
 example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use
 frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.


framerateNumerator
Integer framerateNumerator
Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps.


gopBReference
String gopBReference
If enable, use reference B frames for GOP structures that have B frames > 1.


gopClosedCadence
Integer gopClosedCadence
Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining
 mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output
 segmenting.


gopSize
Double gopSize
GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.


gopSizeUnits
String gopSizeUnits
Indicates if the GOP Size in H264 is specified in frames or seconds. If seconds the system will convert the GOP
 Size into a frame count at run time.


hrdBufferInitialFillPercentage
Integer hrdBufferInitialFillPercentage
Percentage of the buffer that should initially be filled (HRD buffer model).


hrdBufferSize
Integer hrdBufferSize
Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.


interlaceMode
String interlaceMode
Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and
 Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity
 (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD)
 use the same field polarity as the source. Therefore, behavior depends on the input scan type, as follows. - If
 the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the
 source). The output could therefore be a mix of "top field first" and "bottom field first". - If the source is
 progressive, the output will be interlaced with "top field first" or "bottom field first" polarity, depending on
 which of the Follow options you chose.


maxBitrate
Integer maxBitrate
Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate
 control mode is QVBR.


minIInterval
Integer minIInterval
Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a
 scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the
 scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence
 resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch
 = GOP size + Min-I-interval - 1


numberBFramesBetweenReferenceFrames
Integer numberBFramesBetweenReferenceFrames
Number of B-frames between reference frames.


numberReferenceFrames
Integer numberReferenceFrames
Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced
 encoding.


parControl
String parControl
Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using
 the console, do this by choosing Follow source for Pixel aspect ratio.


parDenominator
Integer parDenominator
Pixel Aspect Ratio denominator.


parNumerator
Integer parNumerator
Pixel Aspect Ratio numerator.


qualityTuningLevel
String qualityTuningLevel
Use Quality tuning level (H264QualityTuningLevel) to specifiy whether to use fast single-pass, high-quality
 singlepass, or high-quality multipass video encoding.


qvbrSettings
H264QvbrSettings qvbrSettings
Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control
 mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate
 control mode.


rateControlMode
String rateControlMode
Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or
 quality-defined variable bitrate (QVBR).


repeatPps
String repeatPps
Places a PPS header on each encoded picture, even if repeated.


sceneChangeDetect
String sceneChangeDetect
Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves
 video quality and is enabled by default. If this output uses QVBR, choose Transition detection
 (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see
 https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.


slices
Integer slices
Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive
 pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.


slowPal
String slowPal
Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up
 correspondingly.


softness
Integer softness
Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.


spatialAdaptiveQuantization
String spatialAdaptiveQuantization
Adjust quantization within each frame based on spatial variation of content complexity.


syntax
String syntax
Produces a bitstream compliant with SMPTE RP-2027.


telecine
String telecine
This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field
 works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams >
 Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive,
 Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces
 23.976; the player converts this output to 29.97i.


temporalAdaptiveQuantization
String temporalAdaptiveQuantization
Adjust quantization within each frame based on temporal variation of content complexity.


unregisteredSeiTimecode
String unregisteredSeiTimecode
Inserts timecode for each frame as 4 bytes of an unregistered SEI message.








Class com.amazonaws.services.mediaconvert.model.H265QvbrSettings extends Object implements Serializable


Serialized Fields


maxAverageBitrate
Integer maxAverageBitrate
Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average
 bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video
 part of this output to the value that you choose. That is, the total size of the video element is less than or
 equal to the value you set multiplied by the number of seconds of encoded output.


qvbrQualityLevel
Integer qvbrQualityLevel
Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h265Settings. Specify
 the target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results
 in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9.








Class com.amazonaws.services.mediaconvert.model.H265Settings extends Object implements Serializable


Serialized Fields


adaptiveQuantization
String adaptiveQuantization
Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.


alternateTransferFunctionSei
String alternateTransferFunctionSei
Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer
 Function (EOTF).


bitrate
Integer bitrate
Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be
 unique when rounded down to the nearest multiple of 1000.


codecLevel
String codecLevel
H.265 Level.


codecProfile
String codecProfile
Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] /
 [Tier], so "Main/High" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC
 4:2:2 License.


dynamicSubGop
String dynamicSubGop
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use
 fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more
 B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the
 setting B frames between reference frames (numberBFramesBetweenReferenceFrames).


flickerAdaptiveQuantization
String flickerAdaptiveQuantization
Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.


framerateControl
String framerateControl
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to
 keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion,
 choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal
 approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your
 transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the
 service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the
 frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the
 settings FramerateNumerator and FramerateDenominator.


framerateConversionAlgorithm
String framerateConversionAlgorithm
When set to INTERPOLATE, produces smoother motion during frame rate conversion.


framerateDenominator
Integer framerateDenominator
Frame rate denominator.


framerateNumerator
Integer framerateNumerator
Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps.


gopBReference
String gopBReference
If enable, use reference B frames for GOP structures that have B frames > 1.


gopClosedCadence
Integer gopClosedCadence
Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining
 mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output
 segmenting.


gopSize
Double gopSize
GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.


gopSizeUnits
String gopSizeUnits
Indicates if the GOP Size in H265 is specified in frames or seconds. If seconds the system will convert the GOP
 Size into a frame count at run time.


hrdBufferInitialFillPercentage
Integer hrdBufferInitialFillPercentage
Percentage of the buffer that should initially be filled (HRD buffer model).


hrdBufferSize
Integer hrdBufferSize
Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.


interlaceMode
String interlaceMode
Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to create a progressive output,
 regardless of the scan type of your input. Choose Top Field First (TOP_FIELD) or Bottom Field First
 (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Choose Follow,
 Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) to create an interlaced output with
 the same field polarity as the source. If the source is interlaced, the output will be interlaced with the same
 polarity as the source (it will follow the source). The output could therefore be a mix of "top field first" and
 "bottom field first". If the source is progressive, your output will be interlaced with "top field first" or
 "bottom field first" polarity, depending on which of the Follow options you chose. If you don't choose a value,
 the service will default to Progressive (PROGRESSIVE).


maxBitrate
Integer maxBitrate
Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate
 control mode is QVBR.


minIInterval
Integer minIInterval
Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a
 scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the
 scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence
 resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch
 = GOP size + Min-I-interval - 1


numberBFramesBetweenReferenceFrames
Integer numberBFramesBetweenReferenceFrames
Number of B-frames between reference frames.


numberReferenceFrames
Integer numberReferenceFrames
Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced
 encoding.


parControl
String parControl
Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using
 the console, do this by choosing Follow source for Pixel aspect ratio.


parDenominator
Integer parDenominator
Pixel Aspect Ratio denominator.


parNumerator
Integer parNumerator
Pixel Aspect Ratio numerator.


qualityTuningLevel
String qualityTuningLevel
Use Quality tuning level (H265QualityTuningLevel) to specifiy whether to use fast single-pass, high-quality
 singlepass, or high-quality multipass video encoding.


qvbrSettings
H265QvbrSettings qvbrSettings
Settings for quality-defined variable bitrate encoding with the H.265 codec. Required when you set Rate control
 mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate
 control mode.


rateControlMode
String rateControlMode
Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or
 quality-defined variable bitrate (QVBR).


sampleAdaptiveOffsetFilterMode
String sampleAdaptiveOffsetFilterMode
Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on
 content


sceneChangeDetect
String sceneChangeDetect
Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves
 video quality and is enabled by default. If this output uses QVBR, choose Transition detection
 (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see
 https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.


slices
Integer slices
Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive
 pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.


slowPal
String slowPal
Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up
 correspondingly.


spatialAdaptiveQuantization
String spatialAdaptiveQuantization
Adjust quantization within each frame based on spatial variation of content complexity.


telecine
String telecine
This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field
 works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams >
 Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive,
 Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces
 23.976; the player converts this output to 29.97i.


temporalAdaptiveQuantization
String temporalAdaptiveQuantization
Adjust quantization within each frame based on temporal variation of content complexity.


temporalIds
String temporalIds
Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are supported depending on GOP
 structure: I- and P-frames form one layer, reference B-frames can form a second layer and non-reference b-frames
 can form a third layer. Decoders can optionally decode only the lower temporal layers to generate a lower frame
 rate output. For example, given a bitstream with temporal IDs and with b-frames = 1 (i.e. IbPbPb display order), a
 decoder could decode all the frames for full frame rate output or only the I and P frames (lowest temporal layer)
 for a half frame rate output.


tiles
String tiles
Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures.


unregisteredSeiTimecode
String unregisteredSeiTimecode
Inserts timecode for each frame as 4 bytes of an unregistered SEI message.


writeMp4PackagingType
String writeMp4PackagingType
If the location of parameter set NAL units doesn't matter in your workflow, ignore this setting. Use this setting
 only with CMAF or DASH outputs, or with standalone file outputs in an MPEG-4 container (MP4 outputs). Choose HVC1
 to mark your output as HVC1. This makes your output compliant with the following specification: ISO IECJTC1 SC29
 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in
 the sample headers but not in the samples directly. For MP4 outputs, when you choose HVC1, your output video might
 not work properly with some downstream systems and video players. The service defaults to marking your output as
 HEV1. For these outputs, the service writes parameter set NAL units directly into the samples.








Class com.amazonaws.services.mediaconvert.model.Hdr10Metadata extends Object implements Serializable


Serialized Fields


bluePrimaryX
Integer bluePrimaryX
HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to
 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color
 correction.


bluePrimaryY
Integer bluePrimaryY
HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to
 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color
 correction.


greenPrimaryX
Integer greenPrimaryX
HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to
 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color
 correction.


greenPrimaryY
Integer greenPrimaryY
HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to
 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color
 correction.


maxContentLightLevel
Integer maxContentLightLevel
Maximum light level among all samples in the coded video sequence, in units of candelas per square meter. This
 setting doesn't have a default value; you must specify a value that is suitable for the content.


maxFrameAverageLightLevel
Integer maxFrameAverageLightLevel
Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter. This
 setting doesn't have a default value; you must specify a value that is suitable for the content.


maxLuminance
Integer maxLuminance
Nominal maximum mastering display luminance in units of of 0.0001 candelas per square meter.


minLuminance
Integer minLuminance
Nominal minimum mastering display luminance in units of of 0.0001 candelas per square meter


redPrimaryX
Integer redPrimaryX
HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to
 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color
 correction.


redPrimaryY
Integer redPrimaryY
HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to
 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color
 correction.


whitePointX
Integer whitePointX
HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to
 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color
 correction.


whitePointY
Integer whitePointY
HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to
 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color
 correction.








Class com.amazonaws.services.mediaconvert.model.HlsAdditionalManifest extends Object implements Serializable


Serialized Fields


manifestNameModifier
String manifestNameModifier
Specify a name modifier that the service adds to the name of this manifest to make it different from the file
 names of the other main manifests in the output group. For example, say that the default main manifest for your
 HLS group is film-name.m3u8. If you enter "-no-premium" for this setting, then the file name the service generates
 for this top-level manifest is film-name-no-premium.m3u8. For HLS output groups, specify a manifestNameModifier
 that is different from the nameModifier of the output. The service uses the output name modifier to create unique
 names for the individual variant manifests.


selectedOutputs
List<E> selectedOutputs
Specify the outputs that you want this additional top-level manifest to reference.








Class com.amazonaws.services.mediaconvert.model.HlsCaptionLanguageMapping extends Object implements Serializable


Serialized Fields


captionChannel
Integer captionChannel
Caption channel.


customLanguageCode
String customLanguageCode
Specify the language for this captions channel, using the ISO 639-2 or ISO 639-3 three-letter language code


languageCode
String languageCode
Specify the language, using the ISO 639-2 three-letter code listed at
 https://www.loc.gov/standards/iso639-2/php/code_list.php.


languageDescription
String languageDescription
Caption language description.








Class com.amazonaws.services.mediaconvert.model.HlsEncryptionSettings extends Object implements Serializable


Serialized Fields


constantInitializationVector
String constantInitializationVector
This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then
 the Initialization Vector will follow the segment number by default.


encryptionMethod
String encryptionMethod
Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web
 interface also disables encryption.


initializationVectorInManifest
String initializationVectorInManifest
The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to
 INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.


offlineEncrypted
String offlineEncrypted
Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline
 Apple HLS FairPlay content protection.


spekeKeyProvider
SpekeKeyProvider spekeKeyProvider
If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a
 SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.


staticKeyProvider
StaticKeyProvider staticKeyProvider
Use these settings to set up encryption with a static key provider.


type
String type
Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For
 more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.








Class com.amazonaws.services.mediaconvert.model.HlsGroupSettings extends Object implements Serializable


Serialized Fields


adMarkers
List<E> adMarkers
Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether
 SCTE-35 markers appear in the outputs themselves.


additionalManifests
List<E> additionalManifests
By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This
 default manifest references every output in the output group. To create additional top-level manifests that
 reference a subset of the outputs in the output group, specify a list of them here.


baseUrl
String baseUrl
A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest
 is delivered from a different URL than the main .m3u8 file.


captionLanguageMappings
List<E> captionLanguageMappings
Language to be used on Caption outputs


captionLanguageSetting
String captionLanguageSetting
Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at
 least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you
 specify. Make sure to specify the languages in the order in which they appear in the original source (if the
 source is embedded format) or the order of the caption selectors (if the source is other than embedded).
 Otherwise, languages in the manifest will not match up properly with the output captions. None: Include
 CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.


clientCache
String clientCache
When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later
 replay.


codecSpecification
String codecSpecification
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.


destination
String destination
Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts
 format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the
 input file. If your job has multiple inputs, the service uses the filename of the first input file.


destinationSettings
DestinationSettings destinationSettings
Settings associated with the destination. Will vary based on the type of destination


directoryStructure
String directoryStructure
Indicates whether segments should be placed in subdirectories.


encryption
HlsEncryptionSettings encryption
DRM settings.


manifestCompression
String manifestCompression
When set to GZIP, compresses HLS playlist.


manifestDurationFormat
String manifestDurationFormat
Indicates whether the output manifest should use floating point values for segment duration.


minFinalSegmentLength
Double minFinalSegmentLength
Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back
 the end of your video asset. If you know that player devices are hanging on the final segment of your video
 because the length of your final segment is too short, use this setting to specify a minimum final segment length,
 in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify
 a value for this setting, the encoder will combine any final segment that is shorter than the length that you
 specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5
 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final
 segment is 3.5 seconds.


minSegmentLength
Integer minSegmentLength
When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby
 avail and extending the segment size if needed.


outputSelection
String outputSelection
Indicates whether the .m3u8 manifest file should be generated for this HLS output group.


programDateTime
String programDateTime
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows:
 either the program date and time are initialized using the input timecode source, or the time is initialized
 using the input timecode source and the date is initialized using the timestamp_offset.


programDateTimePeriod
Integer programDateTimePeriod
Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.


segmentControl
String segmentControl
When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index
 segment for playback.


segmentLength
Integer segmentLength
Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next
 keyframe after this number of seconds, so actual segment length may be longer.


segmentsPerSubdirectory
Integer segmentsPerSubdirectory
Number of segments to write to a subdirectory before starting a new one. directoryStructure must be
 SINGLE_DIRECTORY for this setting to have an effect.


streamInfResolution
String streamInfResolution
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.


timedMetadataId3Frame
String timedMetadataId3Frame
Indicates ID3 frame that has the timecode.


timedMetadataId3Period
Integer timedMetadataId3Period
Timed Metadata interval in seconds.


timestampDeltaMilliseconds
Integer timestampDeltaMilliseconds
Provides an extra millisecond delta offset to fine tune the timestamps.








Class com.amazonaws.services.mediaconvert.model.HlsSettings extends Object implements Serializable


Serialized Fields


audioGroupId
String audioGroupId
Specifies the group to which the audio Rendition belongs.


audioOnlyContainer
String audioOnlyContainer
Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an
 MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container.
 Regardless of the value that you specify here, if this output has video, the service will place the output into an
 MPEG2-TS container.


audioRenditionSets
String audioRenditionSets
List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are
 associated to the video, separate by ','.


audioTrackType
String audioTrackType
Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only
 stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest.
 Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default.
 Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select,
 Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in
 the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the
 client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO,
 AUTOSELECT=NO


iFrameOnlyManifest
String iFrameOnlyManifest
When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest


segmentModifier
String segmentModifier
String concatenated to end of segment filenames. Accepts "Format Identifiers":#format_identifier_parameters.








Class com.amazonaws.services.mediaconvert.model.Id3Insertion extends Object implements Serializable


Serialized Fields


id3
String id3
Use ID3 tag (Id3) to provide a tag value in base64-encode format.


timecode
String timecode
Provide a Timecode (TimeCode) in HH:MM:SS:FF or HH:MM:SS;FF format.








Class com.amazonaws.services.mediaconvert.model.ImageInserter extends Object implements Serializable


Serialized Fields


insertableImages
List<E> insertableImages
Specify the images that you want to overlay on your video. The images must be PNG or TGA files.








Class com.amazonaws.services.mediaconvert.model.ImscDestinationSettings extends Object implements Serializable


Serialized Fields


stylePassthrough
String stylePassthrough
Keep this setting enabled to have MediaConvert use the font style and position information from the captions
 source in the output. This option is available only when your input captions are CFF-TT, IMSC, SMPTE-TT, or TTML.
 Disable this setting for simplified output captions.








Class com.amazonaws.services.mediaconvert.model.Input extends Object implements Serializable


Serialized Fields


audioSelectorGroups
Map<K,V> audioSelectorGroups
Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups.
 See "Audio Selector Group":#inputs-audio_selector_group for more information.


audioSelectors
Map<K,V> audioSelectors
Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your
 outputs. You can use mutiple Audio selectors per input.


captionSelectors
Map<K,V> captionSelectors
Use Captions selectors (CaptionSelectors) to specify the captions data from the input that you will use in your
 outputs. You can use mutiple captions selectors per input.


crop
Rectangle crop
Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.
 If you specify a value here, it will override any value that you specify in the output setting Cropping selection
 (crop).


deblockFilter
String deblockFilter
Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manaully
 controllable for MPEG2 and uncompressed video inputs.


decryptionSettings
InputDecryptionSettings decryptionSettings
Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can
 decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt
 your content.


denoiseFilter
String denoiseFilter
Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to
 MPEG2, H.264, H.265, and uncompressed video inputs.


fileInput
String fileInput
Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service
 concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input
 format is IMF, specify your input by providing the path to your CPL. For example, "s3://bucket/vf/cpl.xml". If the
 CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental
 IMPs that contain assets referenced by the CPL.


filterEnable
String filterEnable
Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock
 filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock
 (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input
 type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in
 (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type.


filterStrength
Integer filterStrength
Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The
 range is -5 to 5. Default is 0.


imageInserter
ImageInserter imageInserter
Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for
 each input individually. This setting is disabled by default.


inputClippings
List<E> inputClippings
(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in
 the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If
 you provide only an end time, it will be the entire input up to that point. When you specify more than one input
 clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify
 them.


position
Rectangle position
Use Selection placement (position) to define the video area in your output frame. The area outside of the
 rectangle that you specify here is black. If you specify a value here, it will override any value that you
 specify in the output setting Selection placement (position). If you specify a value here, this will override any
 AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a
 value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior).


programNumber
Integer programNumber
Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that
 Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you
 specify doesn't exist, the transcoding service will use this default.


psiControl
String psiControl
Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. *
 Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data.


supplementalImps
List<E> supplementalImps
Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if the CPL that you're using for
 your input is in an incomplete IMP. Specify either the supplemental IMP directories with a trailing slash or the
 ASSETMAP.xml files. For example ["s3://bucket/ov/", "s3://bucket/vf2/ASSETMAP.xml"]. You don't need to specify the
 IMP that contains your input CPL, because the service automatically detects it.


timecodeSource
String timecodeSource
Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the
 service counts input video frames. This input frame count affects only the behavior of features that apply to a
 single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED)
 to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero.
 Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting
 Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by
 default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.


timecodeStart
String timecodeStart
Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you
 must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start
 (SPECIFIEDSTART). For more information about timecodes, see
 https://docs.aws.amazon.com/console/mediaconvert/timecode.


videoSelector
VideoSelector videoSelector
Selector for video.








Class com.amazonaws.services.mediaconvert.model.InputClipping extends Object implements Serializable


Serialized Fields


endTimecode
String endTimecode
Set End timecode (EndTimecode) to the end of the portion of the input you are clipping. The frame corresponding
 to the End timecode value is included in the clip. Start timecode or End timecode may be left blank, but not
 both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF
 is the frame number. When choosing this value, take into account your setting for timecode source under input
 settings (InputTimecodeSource). For example, if you have embedded timecodes that start at 01:00:00:00 and you want
 your clip to end six minutes into the video, use 01:06:00:00.


startTimecode
String startTimecode
Set Start timecode (StartTimecode) to the beginning of the portion of the input you are clipping. The frame
 corresponding to the Start timecode value is included in the clip. Start timecode or End timecode may be left
 blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the
 second, and FF is the frame number. When choosing this value, take into account your setting for Input timecode
 source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five
 minutes into the video, use 01:05:00:00.








Class com.amazonaws.services.mediaconvert.model.InputDecryptionSettings extends Object implements Serializable


Serialized Fields


decryptionMode
String decryptionMode
Specify the encryption mode that you used to encrypt your input files.


encryptedDecryptionKey
String encryptedDecryptionKey
Warning! Don't provide your encryption key in plaintext. Your job settings could be intercepted, making your
 encrypted content vulnerable. Specify the encrypted version of the data key that you used to encrypt your
 content. The data key must be encrypted by AWS Key Management Service (KMS). The key can be 128, 192, or 256 bits.


initializationVector
String initializationVector
Specify the initialization vector that you used when you encrypted your content before uploading it to Amazon S3.
 You can use a 16-byte initialization vector with any encryption mode. Or, you can use a 12-byte initialization
 vector with GCM or CTR. MediaConvert accepts only initialization vectors that are base64-encoded.


kmsKeyRegion
String kmsKeyRegion
Specify the AWS Region for AWS Key Management Service (KMS) that you used to encrypt your data key, if that
 Region is different from the one you are using for AWS Elemental MediaConvert.








Class com.amazonaws.services.mediaconvert.model.InputTemplate extends Object implements Serializable


Serialized Fields


audioSelectorGroups
Map<K,V> audioSelectorGroups
Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups.
 See "Audio Selector Group":#inputs-audio_selector_group for more information.


audioSelectors
Map<K,V> audioSelectors
Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your
 outputs. You can use mutiple Audio selectors per input.


captionSelectors
Map<K,V> captionSelectors
Use Captions selectors (CaptionSelectors) to specify the captions data from the input that you will use in your
 outputs. You can use mutiple captions selectors per input.


crop
Rectangle crop
Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.
 If you specify a value here, it will override any value that you specify in the output setting Cropping selection
 (crop).


deblockFilter
String deblockFilter
Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manaully
 controllable for MPEG2 and uncompressed video inputs.


denoiseFilter
String denoiseFilter
Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to
 MPEG2, H.264, H.265, and uncompressed video inputs.


filterEnable
String filterEnable
Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock
 filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock
 (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input
 type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in
 (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type.


filterStrength
Integer filterStrength
Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The
 range is -5 to 5. Default is 0.


imageInserter
ImageInserter imageInserter
Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for
 each input individually. This setting is disabled by default.


inputClippings
List<E> inputClippings
(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in
 the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If
 you provide only an end time, it will be the entire input up to that point. When you specify more than one input
 clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify
 them.


position
Rectangle position
Use Selection placement (position) to define the video area in your output frame. The area outside of the
 rectangle that you specify here is black. If you specify a value here, it will override any value that you
 specify in the output setting Selection placement (position). If you specify a value here, this will override any
 AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a
 value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior).


programNumber
Integer programNumber
Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that
 Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you
 specify doesn't exist, the transcoding service will use this default.


psiControl
String psiControl
Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. *
 Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data.


timecodeSource
String timecodeSource
Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the
 service counts input video frames. This input frame count affects only the behavior of features that apply to a
 single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED)
 to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero.
 Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting
 Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by
 default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.


timecodeStart
String timecodeStart
Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you
 must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start
 (SPECIFIEDSTART). For more information about timecodes, see
 https://docs.aws.amazon.com/console/mediaconvert/timecode.


videoSelector
VideoSelector videoSelector
Selector for video.








Class com.amazonaws.services.mediaconvert.model.InsertableImage extends Object implements Serializable


Serialized Fields


duration
Integer duration
Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in
 time but not fade-out time.


fadeIn
Integer fadeIn
Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and
 the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity
 setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time.


fadeOut
Integer fadeOut
Specify the length of time, in milliseconds, between the end of the time that you have specified for the image
 overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for
 Fade-out, the image will disappear abruptly at the end of the inserted image duration.


height
Integer height
Specify the height of the inserted image in pixels. If you specify a value that's larger than the video
 resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep
 this setting blank.


imageInserterInput
String imageInserterInput
Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or
 TGA file.


imageX
Integer imageX
Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for
 any image overlay that you specify.


imageY
Integer imageY
Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any
 image overlay that you specify.


layer
Integer layer
Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with
 lower values for Layer.


opacity
Integer opacity
Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is
 transparent and 100 is fully opaque. Default is 50.


startTime
String startTime
Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode
 (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.


width
Integer width
Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution
 width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting
 blank.








Class com.amazonaws.services.mediaconvert.model.InternalServerErrorException extends AWSMediaConvertException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconvert.model.Job extends Object implements Serializable


Serialized Fields


accelerationSettings
AccelerationSettings accelerationSettings
Accelerated transcoding can significantly speed up jobs with long, visually complex content.


accelerationStatus
String accelerationStatus
Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration
 (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration
 (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus
 is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible
 with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings
 aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated
 transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without
 accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.


arn
String arn
An identifier for this resource that is unique within all of AWS.


billingTagsSource
String billingTagsSource
Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert
 costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will
 appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will
 appear on the billing report unsorted.


createdAt
Date createdAt
The time, in Unix epoch format in seconds, when the job got created.


currentPhase
String currentPhase
A job's phase can be PROBING, TRANSCODING OR UPLOADING


errorCode
Integer errorCode
Error code for the job


errorMessage
String errorMessage
Error message of Job


id
String id
A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources


jobPercentComplete
Integer jobPercentComplete
An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from
 when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental
 MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and
 ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime,
 Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those
 cases, jobPercentComplete returns a null value.


jobTemplate
String jobTemplate
The job template that the job is created from, if it is created from a job template.


messages
JobMessages messages
Provides messages from the service about jobs that you have already successfully submitted.


outputGroupDetails
List<E> outputGroupDetails
List of output group details


priority
Integer priority
Relative priority on the job.


queue
String queue
Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to
 the default queue. For more about queues, see the User Guide topic at
 http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html


retryCount
Integer retryCount
The number of times that the service automatically attempted to process your job after encountering an error.


role
String role
The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User
 Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html


settings
JobSettings settings
JobSettings contains all the transcode settings for a job.


simulateReservedQueue
String simulateReservedQueue
Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When
 this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see
 with one RTS in a reserved queue. This setting is disabled by default.


status
String status
A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.


statusUpdateInterval
String statusUpdateInterval
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in
 seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins
 processing your job to the time it completes the transcode or encounters an error.


timing
Timing timing
Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.


userMetadata
Map<K,V> userMetadata
User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value
 pairs.








Class com.amazonaws.services.mediaconvert.model.JobMessages extends Object implements Serializable


Serialized Fields


info
List<E> info
List of messages that are informational only and don't indicate a problem with your job.


warning
List<E> warning
List of messages that warn about conditions that might cause your job not to run or to fail.








Class com.amazonaws.services.mediaconvert.model.JobSettings extends Object implements Serializable


Serialized Fields


adAvailOffset
Integer adAvailOffset
When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.


availBlanking
AvailBlanking availBlanking
Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35
 triggered ad avails.


esam
EsamSettings esam
Settings for Event Signaling And Messaging (ESAM).


inputs
List<E> inputs
Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job.
 These inputs will be concantenated together to create the output.


motionImageInserter
MotionImageInserter motionImageInserter
Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in
 all output groups.


nielsenConfiguration
NielsenConfiguration nielsenConfiguration
Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these
 settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging
 for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of
 nielsenConfiguration in your JSON job specification. Even if you don't include any children of
 nielsenConfiguration, you still enable the setting.


outputGroups
List<E> outputGroups
(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All
 unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as
 well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object
 depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs
 are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings *
 DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings *
 CMAF_GROUP_SETTINGS, CmafGroupSettings


timecodeConfig
TimecodeConfig timecodeConfig
Contains settings used to acquire and adjust timecode information from inputs.


timedMetadataInsertion
TimedMetadataInsertion timedMetadataInsertion
Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed
 metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3
 insertion (Id3Insertion) objects.








Class com.amazonaws.services.mediaconvert.model.JobTemplate extends Object implements Serializable


Serialized Fields


accelerationSettings
AccelerationSettings accelerationSettings
Accelerated transcoding can significantly speed up jobs with long, visually complex content.


arn
String arn
An identifier for this resource that is unique within all of AWS.


category
String category
An optional category you create to organize your job templates.


createdAt
Date createdAt
The timestamp in epoch seconds for Job template creation.


description
String description
An optional description you create for each job template.


lastUpdated
Date lastUpdated
The timestamp in epoch seconds when the Job template was last updated.


name
String name
A name you create for each job template. Each name must be unique within your account.


priority
Integer priority
Relative priority on the job.


queue
String queue
Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go
 to the default queue.


settings
JobTemplateSettings settings
JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs
 created from it.


statusUpdateInterval
String statusUpdateInterval
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in
 seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins
 processing your job to the time it completes the transcode or encounters an error.


type
String type
A job template can be of two types: system or custom. System or built-in job templates can't be modified or
 deleted by the user.








Class com.amazonaws.services.mediaconvert.model.JobTemplateSettings extends Object implements Serializable


Serialized Fields


adAvailOffset
Integer adAvailOffset
When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.


availBlanking
AvailBlanking availBlanking
Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35
 triggered ad avails.


esam
EsamSettings esam
Settings for Event Signaling And Messaging (ESAM).


inputs
List<E> inputs
Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job
 template. Using the API, you can include multiple inputs when referencing a job template.


motionImageInserter
MotionImageInserter motionImageInserter
Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in
 all output groups.


nielsenConfiguration
NielsenConfiguration nielsenConfiguration
Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these
 settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging
 for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of
 nielsenConfiguration in your JSON job specification. Even if you don't include any children of
 nielsenConfiguration, you still enable the setting.


outputGroups
List<E> outputGroups
(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All
 unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as
 well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object
 depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs
 are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings *
 DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings *
 CMAF_GROUP_SETTINGS, CmafGroupSettings


timecodeConfig
TimecodeConfig timecodeConfig
Contains settings used to acquire and adjust timecode information from inputs.


timedMetadataInsertion
TimedMetadataInsertion timedMetadataInsertion
Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed
 metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3
 insertion (Id3Insertion) objects.








Class com.amazonaws.services.mediaconvert.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults
Optional. Number of jobs, up to twenty, that will be returned at one time.


nextToken
String nextToken
Use this string, provided with the response to a previous request, to request the next batch of jobs.


order
String order
When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or
 DESCENDING order. Default varies by resource.


queue
String queue
Provide a queue name to get back only jobs from that queue.


status
String status
A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.








Class com.amazonaws.services.mediaconvert.model.ListJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobs
List<E> jobs
List of jobs


nextToken
String nextToken
Use this string to request the next batch of jobs.








Class com.amazonaws.services.mediaconvert.model.ListJobTemplatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


category
String category
Optionally, specify a job template category to limit responses to only job templates from that category.


listBy
String listBy
Optional. When you request a list of job templates, you can choose to list them alphabetically by NAME or
 chronologically by CREATION_DATE. If you don't specify, the service will list them by name.


maxResults
Integer maxResults
Optional. Number of job templates, up to twenty, that will be returned at one time.


nextToken
String nextToken
Use this string, provided with the response to a previous request, to request the next batch of job templates.


order
String order
When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or
 DESCENDING order. Default varies by resource.








Class com.amazonaws.services.mediaconvert.model.ListJobTemplatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobTemplates
List<E> jobTemplates
List of Job templates.


nextToken
String nextToken
Use this string to request the next batch of job templates.








Class com.amazonaws.services.mediaconvert.model.ListPresetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


category
String category
Optionally, specify a preset category to limit responses to only presets from that category.


listBy
String listBy
Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or
 chronologically by CREATION_DATE. If you don't specify, the service will list them by name.


maxResults
Integer maxResults
Optional. Number of presets, up to twenty, that will be returned at one time


nextToken
String nextToken
Use this string, provided with the response to a previous request, to request the next batch of presets.


order
String order
When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or
 DESCENDING order. Default varies by resource.








Class com.amazonaws.services.mediaconvert.model.ListPresetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
Use this string to request the next batch of presets.


presets
List<E> presets
List of presets








Class com.amazonaws.services.mediaconvert.model.ListQueuesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


listBy
String listBy
Optional. When you request a list of queues, you can choose to list them alphabetically by NAME or
 chronologically by CREATION_DATE. If you don't specify, the service will list them by creation date.


maxResults
Integer maxResults
Optional. Number of queues, up to twenty, that will be returned at one time.


nextToken
String nextToken
Use this string, provided with the response to a previous request, to request the next batch of queues.


order
String order
When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or
 DESCENDING order. Default varies by resource.








Class com.amazonaws.services.mediaconvert.model.ListQueuesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
Use this string to request the next batch of queues.


queues
List<E> queues
List of queues.








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


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) of the resource that you want to list tags for. To get the ARN, send a GET request
 with the resource name.








Class com.amazonaws.services.mediaconvert.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


resourceTags
ResourceTags resourceTags
The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource.








Class com.amazonaws.services.mediaconvert.model.M2tsScte35Esam extends Object implements Serializable


Serialized Fields


scte35EsamPid
Integer scte35EsamPid
Packet Identifier (PID) of the SCTE-35 stream in the transport stream generated by ESAM.








Class com.amazonaws.services.mediaconvert.model.M2tsSettings extends Object implements Serializable


Serialized Fields


audioBufferModel
String audioBufferModel
Selects between the DVB and ATSC buffer models for Dolby Digital audio.


audioFramesPerPes
Integer audioFramesPerPes
The number of audio frames to insert for each PES packet.


audioPids
List<E> audioPids
Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify
 multiple PIDs as a JSON array. Default is the range 482-492.


bitrate
Integer bitrate
Specify the output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically
 determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000.


bufferModel
String bufferModel
Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If
 set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream
 without interruptions.


dvbNitSettings
DvbNitSettings dvbNitSettings
Inserts DVB Network Information Table (NIT) at the specified table repetition interval.


dvbSdtSettings
DvbSdtSettings dvbSdtSettings
Inserts DVB Service Description Table (NIT) at the specified table repetition interval.


dvbSubPids
List<E> dvbSubPids
Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a
 JSON array. Default is the range 460-479.


dvbTdtSettings
DvbTdtSettings dvbTdtSettings
Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.


dvbTeletextPid
Integer dvbTeletextPid
Specify the packet identifier (PID) for DVB teletext data you include in this output. Default is 499.


ebpAudioInterval
String ebpAudioInterval
When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval
 between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval.
 When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation
 markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).


ebpPlacement
String ebpPlacement
Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video
 PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP
 or EBP_LEGACY).


esRateInPes
String esRateInPes
Controls whether to include the ES Rate field in the PES header.


forceTsVideoEbpOrder
String forceTsVideoEbpOrder
Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before
 your video EBP markers. To correct this problem, set this value to Force (FORCE).


fragmentTime
Double fragmentTime
The length, in seconds, of each fragment. Only used with EBP markers.


maxPcrInterval
Integer maxPcrInterval
Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport
 stream.


minEbpInterval
Integer minEbpInterval
When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by
 looking ahead at input video. If another EBP is going to come in within the specified time interval, the current
 EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to
 the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead
 accurate.


nielsenId3
String nielsenId3
If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3
 tag will be inserted in the output.


nullPacketBitrate
Double nullPacketBitrate
Value in bits per second of extra null packets to insert into the transport stream. This can be used if a
 downstream encryption system requires periodic null packets.


patInterval
Integer patInterval
The number of milliseconds between instances of this table in the output transport stream.


pcrControl
String pcrControl
When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary
 Stream (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream.


pcrPid
Integer pcrPid
Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a
 value, the service will use the value for Video PID (VideoPid).


pmtInterval
Integer pmtInterval
Specify the number of milliseconds between instances of the program map table (PMT) in the output transport
 stream.


pmtPid
Integer pmtPid
Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480.


privateMetadataPid
Integer privateMetadataPid
Specify the packet identifier (PID) of the private metadata stream. Default is 503.


programNumber
Integer programNumber
Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this
 output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers,
 used for organizing data.


rateMode
String rateMode
When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the
 bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.


scte35Esam
M2tsScte35Esam scte35Esam
Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the
 insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).


scte35Pid
Integer scte35Pid
Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream.


scte35Source
String scte35Source
For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in
 your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output.
 For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the
 setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam).


segmentationMarkers
String segmentationMarkers
Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit
 in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes.
 psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to
 the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point
 information to the adaptation field using a legacy proprietary format.


segmentationStyle
String segmentationStyle
The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With
 avails, it is possible that segments may be truncated, which can influence where future segmentation markers are
 inserted. When a segmentation style of "reset_cadence" is selected and a segment is truncated due to an avail, we
 will reset the segmentation cadence. This means the subsequent segment will have a duration of of
 $segmentation_time seconds. When a segmentation style of "maintain_cadence" is selected and a segment is truncated
 due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be
 truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that
 EBP lookahead is a slight exception to this rule.


segmentationTime
Double segmentationTime
Specify the length, in seconds, of each segment. Required unless markers is set to _none_.


timedMetadataPid
Integer timedMetadataPid
Specify the packet identifier (PID) for timed metadata in this output. Default is 502.


transportStreamId
Integer transportStreamId
Specify the ID for the transport stream itself in the program map table for this output. Transport stream IDs and
 program map tables are parts of MPEG-2 transport stream containers, used for organizing data.


videoPid
Integer videoPid
Specify the packet identifier (PID) of the elementary video stream in the transport stream.








Class com.amazonaws.services.mediaconvert.model.M3u8Settings extends Object implements Serializable


Serialized Fields


audioFramesPerPes
Integer audioFramesPerPes
The number of audio frames to insert for each PES packet.


audioPids
List<E> audioPids
Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted,
 and can be entered in ranges and/or by comma separation.


nielsenId3
String nielsenId3
If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3
 tag will be inserted in the output.


patInterval
Integer patInterval
The number of milliseconds between instances of this table in the output transport stream.


pcrControl
String pcrControl
When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary
 Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio
 elementary stream.


pcrPid
Integer pcrPid
Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the
 encoder will assign the same value as the Video PID.


pmtInterval
Integer pmtInterval
The number of milliseconds between instances of this table in the output transport stream.


pmtPid
Integer pmtPid
Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream.


privateMetadataPid
Integer privateMetadataPid
Packet Identifier (PID) of the private metadata stream in the transport stream.


programNumber
Integer programNumber
The value of the program number field in the Program Map Table.


scte35Pid
Integer scte35Pid
Packet Identifier (PID) of the SCTE-35 stream in the transport stream.


scte35Source
String scte35Source
For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in
 your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output.
 For SCTE-35 markers from an ESAM XML document-- Choose None (NONE) if you don't want manifest conditioning. Choose
 Passthrough (PASSTHROUGH) and choose Ad markers (adMarkers) if you do want manifest conditioning. In both cases,
 also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml).


timedMetadata
String timedMetadata
Applies only to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from
 the input in this output.


timedMetadataPid
Integer timedMetadataPid
Packet Identifier (PID) of the timed metadata stream in the transport stream.


transportStreamId
Integer transportStreamId
The value of the transport stream ID field in the Program Map Table.


videoPid
Integer videoPid
Packet Identifier (PID) of the elementary video stream in the transport stream.








Class com.amazonaws.services.mediaconvert.model.MotionImageInserter extends Object implements Serializable


Serialized Fields


framerate
MotionImageInsertionFramerate framerate
If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a
 series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example,
 specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your
 intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png
 images. This overlay frame rate doesn't need to match the frame rate of the underlying video.


input
String input
Specify the .mov file or series of .png files that you want to overlay on your video. For .png files, provide the
 file name of the first file in the series. Make sure that the names of the .png files end with sequential numbers
 that specify the order that they are played in. For example, overlay_000.png, overlay_001.png, overlay_002.png,
 and so on. The sequence must start at zero, and each image file name must have the same number of digits. Pad your
 initial file names with enough zeros to complete the sequence. For example, if the first image is overlay_0.png,
 there can be only 10 images in the sequence, with the last image being overlay_9.png. But if the first image is
 overlay_00.png, there can be 100 images in the sequence.


insertionMode
String insertionMode
Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov
 file or a series of .png files.


offset
MotionImageInsertionOffset offset
Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from
 the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full
 size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or
 down with any video scaling.


playback
String playback
Specify whether your motion graphic overlay repeats on a loop or plays only once.


startTime
String startTime
Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the
 timecode you provide here takes into account how you have set up your timecode configuration under both job
 settings and input settings. The simplest way to do that is to set both to start at 0. If you need to set up your
 job to follow timecodes embedded in your source that don't start at zero, make sure that you specify a start time
 that is after the first embedded timecode. For more information, see
 https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode
 configuration settings in your JSON job settings specification at settings>timecodeConfig>source and
 settings>inputs>timecodeSource.








Class com.amazonaws.services.mediaconvert.model.MotionImageInsertionFramerate extends Object implements Serializable


Serialized Fields


framerateDenominator
Integer framerateDenominator
The bottom of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set
 this value to 1.


framerateNumerator
Integer framerateNumerator
The top of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set
 this value to 24.








Class com.amazonaws.services.mediaconvert.model.MotionImageInsertionOffset extends Object implements Serializable


Serialized Fields


imageX
Integer imageX
Set the distance, in pixels, between the overlay and the left edge of the video frame.


imageY
Integer imageY
Set the distance, in pixels, between the overlay and the top edge of the video frame.








Class com.amazonaws.services.mediaconvert.model.MovSettings extends Object implements Serializable


Serialized Fields


clapAtom
String clapAtom
When enabled, include 'clap' atom if appropriate for the video output settings.


cslgAtom
String cslgAtom
When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to
 sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included
 per 14496-1 amendment 1. This improves compatibility with Apple players and tools.


mpeg2FourCCControl
String mpeg2FourCCControl
When set to XDCAM, writes MPEG2 video streams into the QuickTime file using XDCAM fourcc codes. This increases
 compatibility with Apple editors and players, but may decrease compatibility with other players. Only applicable
 when the video codec is MPEG2.


paddingControl
String paddingControl
If set to OMNEON, inserts Omneon-compatible padding


reference
String reference
Always keep the default value (SELF_CONTAINED) for this setting.








Class com.amazonaws.services.mediaconvert.model.Mp2Settings extends Object implements Serializable


Serialized Fields


bitrate
Integer bitrate
Specify the average bitrate in bits per second.


channels
Integer channels
Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give
 you 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2.


sampleRate
Integer sampleRate
Sample rate in hz.








Class com.amazonaws.services.mediaconvert.model.Mp3Settings extends Object implements Serializable


Serialized Fields


bitrate
Integer bitrate
Specify the average bitrate in bits per second.


channels
Integer channels
Specify the number of channels in this output audio track. Choosing Mono on the console gives you 1 output
 channel; choosing Stereo gives you 2. In the API, valid values are 1 and 2.


rateControlMode
String rateControlMode
Specify whether the service encodes this MP3 audio output with a constant bitrate (CBR) or a variable bitrate
 (VBR).


sampleRate
Integer sampleRate
Sample rate in hz.


vbrQuality
Integer vbrQuality
Required when you set Bitrate control mode (rateControlMode) to VBR. Specify the audio quality of this MP3 output
 from 0 (highest quality) to 9 (lowest quality).








Class com.amazonaws.services.mediaconvert.model.Mp4Settings extends Object implements Serializable


Serialized Fields


cslgAtom
String cslgAtom
When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to
 sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included
 per 14496-1 amendment 1. This improves compatibility with Apple players and tools.


cttsVersion
Integer cttsVersion
Ignore this setting unless compliance to the CTTS box version specification matters in your workflow. Specify a
 value of 1 to set your CTTS box version to 1 and make your output compliant with the specification. When you
 specify a value of 1, you must also set CSLG atom (cslgAtom) to the value INCLUDE. Keep the default value 0 to set
 your CTTS box version to 0. This can provide backward compatibility for some players and packagers.


freeSpaceBox
String freeSpaceBox
Inserts a free-space box immediately after the moov box.


moovPlacement
String moovPlacement
If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for
 progressive downloading. Otherwise it is placed normally at the end.


mp4MajorBrand
String mp4MajorBrand
Overrides the "Major Brand" field in the output file. Usually not necessary to specify.








Class com.amazonaws.services.mediaconvert.model.MpdSettings extends Object implements Serializable


Serialized Fields


captionContainerType
String captionContainerType
Use this setting only in DASH output groups that include sidecar TTML or IMSC captions. You specify sidecar
 captions in a separate output from your audio and video. Choose Raw (RAW) for captions in a single XML file in a
 raw container. Choose Fragmented MPEG-4 (FRAGMENTED_MP4) for captions in XML format contained within fragmented
 MP4 files. This set of fragmented MP4 files is separate from your video and audio fragmented MP4 files.


scte35Esam
String scte35Esam
Use this setting only when you specify SCTE-35 markers from ESAM. Choose INSERT to put SCTE-35 markers in this
 output at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC
 XML (sccXml).


scte35Source
String scte35Source
Ignore this setting unless you have SCTE-35 markers in your input video file. Choose Passthrough (PASSTHROUGH) if
 you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't
 want those SCTE-35 markers in this output.








Class com.amazonaws.services.mediaconvert.model.Mpeg2Settings extends Object implements Serializable


Serialized Fields


adaptiveQuantization
String adaptiveQuantization
Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.


bitrate
Integer bitrate
Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be
 unique when rounded down to the nearest multiple of 1000.


codecLevel
String codecLevel
Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output.


codecProfile
String codecProfile
Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output.


dynamicSubGop
String dynamicSubGop
Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use
 fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more
 B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the
 setting B frames between reference frames (numberBFramesBetweenReferenceFrames).


framerateControl
String framerateControl
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to
 keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion,
 choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal
 approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your
 transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the
 service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the
 frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the
 settings FramerateNumerator and FramerateDenominator.


framerateConversionAlgorithm
String framerateConversionAlgorithm
When set to INTERPOLATE, produces smoother motion during frame rate conversion.


framerateDenominator
Integer framerateDenominator
Frame rate denominator.


framerateNumerator
Integer framerateNumerator
Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps.


gopClosedCadence
Integer gopClosedCadence
Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining
 mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output
 segmenting.


gopSize
Double gopSize
GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.


gopSizeUnits
String gopSizeUnits
Indicates if the GOP Size in MPEG2 is specified in frames or seconds. If seconds the system will convert the GOP
 Size into a frame count at run time.


hrdBufferInitialFillPercentage
Integer hrdBufferInitialFillPercentage
Percentage of the buffer that should initially be filled (HRD buffer model).


hrdBufferSize
Integer hrdBufferSize
Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.


interlaceMode
String interlaceMode
Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and
 Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity
 (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD)
 use the same field polarity as the source. Therefore, behavior depends on the input scan type. - If the source is
 interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The
 output could therefore be a mix of "top field first" and "bottom field first". - If the source is progressive,
 the output will be interlaced with "top field first" or "bottom field first" polarity, depending on which of the
 Follow options you chose.


intraDcPrecision
String intraDcPrecision
Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If
 you choose the value auto, the service will automatically select the precision based on the per-frame compression
 ratio.


maxBitrate
Integer maxBitrate
Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000.


minIInterval
Integer minIInterval
Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a
 scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the
 scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence
 resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch
 = GOP size + Min-I-interval - 1


numberBFramesBetweenReferenceFrames
Integer numberBFramesBetweenReferenceFrames
Number of B-frames between reference frames.


parControl
String parControl
Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using
 the console, do this by choosing Follow source for Pixel aspect ratio.


parDenominator
Integer parDenominator
Pixel Aspect Ratio denominator.


parNumerator
Integer parNumerator
Pixel Aspect Ratio numerator.


qualityTuningLevel
String qualityTuningLevel
Use Quality tuning level (Mpeg2QualityTuningLevel) to specifiy whether to use single-pass or multipass video
 encoding.


rateControlMode
String rateControlMode
Use Rate control mode (Mpeg2RateControlMode) to specifiy whether the bitrate is variable (vbr) or constant (cbr).


sceneChangeDetect
String sceneChangeDetect
Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves
 video quality and is enabled by default.


slowPal
String slowPal
Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up
 correspondingly.


softness
Integer softness
Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.


spatialAdaptiveQuantization
String spatialAdaptiveQuantization
Adjust quantization within each frame based on spatial variation of content complexity.


syntax
String syntax
Produces a Type D-10 compatible bitstream (SMPTE 356M-2001).


telecine
String telecine
Only use Telecine (Mpeg2Telecine) when you set Framerate (Framerate) to 29.970. Set Telecine (Mpeg2Telecine) to
 Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and
 leave converstion to the player.


temporalAdaptiveQuantization
String temporalAdaptiveQuantization
Adjust quantization within each frame based on temporal variation of content complexity.








Class com.amazonaws.services.mediaconvert.model.MsSmoothAdditionalManifest extends Object implements Serializable


Serialized Fields


manifestNameModifier
String manifestNameModifier
Specify a name modifier that the service adds to the name of this manifest to make it different from the file
 names of the other main manifests in the output group. For example, say that the default main manifest for your
 Microsoft Smooth group is film-name.ismv. If you enter "-no-premium" for this setting, then the file name the
 service generates for this top-level manifest is film-name-no-premium.ismv.


selectedOutputs
List<E> selectedOutputs
Specify the outputs that you want this additional top-level manifest to reference.








Class com.amazonaws.services.mediaconvert.model.MsSmoothEncryptionSettings extends Object implements Serializable


Serialized Fields


spekeKeyProvider
SpekeKeyProvider spekeKeyProvider
If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a
 SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.








Class com.amazonaws.services.mediaconvert.model.MsSmoothGroupSettings extends Object implements Serializable


Serialized Fields


additionalManifests
List<E> additionalManifests
By default, the service creates one .ism Microsoft Smooth Streaming manifest for each Microsoft Smooth Streaming
 output group in your job. This default manifest references every output in the output group. To create additional
 manifests that reference a subset of the outputs in the output group, specify a list of them here.


audioDeduplication
String audioDeduplication
COMBINE_DUPLICATE_STREAMS combines identical audio encoding settings across a Microsoft Smooth output group into
 a single audio stream.


destination
String destination
Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts
 format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the
 input file. If your job has multiple inputs, the service uses the filename of the first input file.


destinationSettings
DestinationSettings destinationSettings
Settings associated with the destination. Will vary based on the type of destination


encryption
MsSmoothEncryptionSettings encryption
If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider.


fragmentLength
Integer fragmentLength
Use Fragment length (FragmentLength) to specify the mp4 fragment sizes in seconds. Fragment length must be
 compatible with GOP size and frame rate.


manifestEncoding
String manifestEncoding
Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format for the server and client
 manifest. Valid options are utf8 and utf16.








Class com.amazonaws.services.mediaconvert.model.NielsenConfiguration extends Object implements Serializable


Serialized Fields


breakoutCode
Integer breakoutCode
Nielsen has discontinued the use of breakout code functionality. If you must include this property, set the value
 to zero.


distributorId
String distributorId
Use Distributor ID (DistributorID) to specify the distributor ID that is assigned to your organization by
 Neilsen.








Class com.amazonaws.services.mediaconvert.model.NoiseReducer extends Object implements Serializable


Serialized Fields


filter
String filter
Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions.
 To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral preserves edges while
 reducing noise. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) do convolution filtering. * Conserve
 does min/max noise reduction. * Spatial does frequency-domain filtering based on JND principles. * Temporal
 optimizes video quality for complex motion.


filterSettings
NoiseReducerFilterSettings filterSettings
Settings for a noise reducer filter


spatialFilterSettings
NoiseReducerSpatialFilterSettings spatialFilterSettings
Noise reducer filter settings for spatial filter.


temporalFilterSettings
NoiseReducerTemporalFilterSettings temporalFilterSettings
Noise reducer filter settings for temporal filter.








Class com.amazonaws.services.mediaconvert.model.NoiseReducerFilterSettings extends Object implements Serializable


Serialized Fields


strength
Integer strength
Relative strength of noise reducing filter. Higher values produce stronger filtering.








Class com.amazonaws.services.mediaconvert.model.NoiseReducerSpatialFilterSettings extends Object implements Serializable


Serialized Fields


postFilterSharpenStrength
Integer postFilterSharpenStrength
Specify strength of post noise reduction sharpening filter, with 0 disabling the filter and 3 enabling it at
 maximum strength.


speed
Integer speed
The speed of the filter, from -2 (lower speed) to 3 (higher speed), with 0 being the nominal value.


strength
Integer strength
Relative strength of noise reducing filter. Higher values produce stronger filtering.








Class com.amazonaws.services.mediaconvert.model.NoiseReducerTemporalFilterSettings extends Object implements Serializable


Serialized Fields


aggressiveMode
Integer aggressiveMode
Use Aggressive mode for content that has complex motion. Higher values produce stronger temporal filtering. This
 filters highly complex scenes more aggressively and creates better VQ for low bitrate outputs.


speed
Integer speed
The speed of the filter (higher number is faster). Low setting reduces bit rate at the cost of transcode time,
 high setting improves transcode time at the cost of bit rate.


strength
Integer strength
Specify the strength of the noise reducing filter on this output. Higher values produce stronger filtering. We
 recommend the following value ranges, depending on the result that you want: * 0-2 for complexity reduction with
 minimal sharpness loss * 2-8 for complexity reduction with image preservation * 8-16 for a high level of
 complexity reduction








Class com.amazonaws.services.mediaconvert.model.NotFoundException extends AWSMediaConvertException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconvert.model.Output extends Object implements Serializable


Serialized Fields


audioDescriptions
List<E> audioDescriptions
(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of
 (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.


captionDescriptions
List<E> captionDescriptions
(CaptionDescriptions) contains groups of captions settings. For each output that has captions, include one
 instance of (CaptionDescriptions). (CaptionDescriptions) can contain multiple groups of captions settings.


containerSettings
ContainerSettings containerSettings
Container specific settings.


extension
String extension
Use Extension (Extension) to specify the file extension for outputs in File output groups. If you do not specify
 a value, the service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts *
 Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * No Container, the service will use codec extensions
 (e.g. AAC, H265, H265, AC3)


nameModifier
String nameModifier
Use Name modifier (NameModifier) to have the service add a string to the end of each output filename. You specify
 the base filename as part of your destination URI. When you create multiple outputs in the same output group,
 Name modifier (NameModifier) is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if
 you use the format identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs
 of the output group.


outputSettings
OutputSettings outputSettings
Specific settings for this type of output.


preset
String preset
Use Preset (Preset) to specifiy a preset for your transcoding settings. Provide the system or custom preset name.
 You can specify either Preset (Preset) or Container settings (ContainerSettings), but not both.


videoDescription
VideoDescription videoDescription
(VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video
 codec that you choose when you specify a value for Video codec (codec). Include one instance of
 (VideoDescription) per output.








Class com.amazonaws.services.mediaconvert.model.OutputChannelMapping extends Object implements Serializable


Serialized Fields


inputChannels
List<E> inputChannels
List of input channels








Class com.amazonaws.services.mediaconvert.model.OutputDetail extends Object implements Serializable


Serialized Fields


durationInMs
Integer durationInMs
Duration in milliseconds


videoDetails
VideoDetail videoDetails
Contains details about the output's video stream








Class com.amazonaws.services.mediaconvert.model.OutputGroup extends Object implements Serializable


Serialized Fields


customName
String customName
Use Custom Group Name (CustomName) to specify a name for the output group. This value is displayed on the console
 and can make your job settings JSON more human-readable. It does not affect your outputs. Use up to twelve
 characters that are either letters, numbers, spaces, or underscores.


name
String name
Name of the output group


outputGroupSettings
OutputGroupSettings outputGroupSettings
Output Group settings, including type


outputs
List<E> outputs
This object holds groups of encoding settings, one group of settings per output.








Class com.amazonaws.services.mediaconvert.model.OutputGroupDetail extends Object implements Serializable


Serialized Fields


outputDetails
List<E> outputDetails
Details about the output








Class com.amazonaws.services.mediaconvert.model.OutputGroupSettings extends Object implements Serializable


Serialized Fields


cmafGroupSettings
CmafGroupSettings cmafGroupSettings
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a
 CMAF Output Group may only contain a single video, audio, or caption output.


dashIsoGroupSettings
DashIsoGroupSettings dashIsoGroupSettings
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS.


fileGroupSettings
FileGroupSettings fileGroupSettings
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to FILE_GROUP_SETTINGS.


hlsGroupSettings
HlsGroupSettings hlsGroupSettings
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS.


msSmoothGroupSettings
MsSmoothGroupSettings msSmoothGroupSettings
Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MS_SMOOTH_GROUP_SETTINGS.


type
String type
Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF)








Class com.amazonaws.services.mediaconvert.model.OutputSettings extends Object implements Serializable


Serialized Fields


hlsSettings
HlsSettings hlsSettings
Settings for HLS output groups








Class com.amazonaws.services.mediaconvert.model.Preset extends Object implements Serializable


Serialized Fields


arn
String arn
An identifier for this resource that is unique within all of AWS.


category
String category
An optional category you create to organize your presets.


createdAt
Date createdAt
The timestamp in epoch seconds for preset creation.


description
String description
An optional description you create for each preset.


lastUpdated
Date lastUpdated
The timestamp in epoch seconds when the preset was last updated.


name
String name
A name you create for each preset. Each name must be unique within your account.


settings
PresetSettings settings
Settings for preset


type
String type
A preset can be of two types: system or custom. System or built-in preset can't be modified or deleted by the
 user.








Class com.amazonaws.services.mediaconvert.model.PresetSettings extends Object implements Serializable


Serialized Fields


audioDescriptions
List<E> audioDescriptions
(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of
 (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.


captionDescriptions
List<E> captionDescriptions
Caption settings for this preset. There can be multiple caption settings in a single output.


containerSettings
ContainerSettings containerSettings
Container specific settings.


videoDescription
VideoDescription videoDescription
(VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video
 codec that you choose when you specify a value for Video codec (codec). Include one instance of
 (VideoDescription) per output.








Class com.amazonaws.services.mediaconvert.model.ProresSettings extends Object implements Serializable


Serialized Fields


codecProfile
String codecProfile
Use Profile (ProResCodecProfile) to specifiy the type of Apple ProRes codec to use for this output.


framerateControl
String framerateControl
If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to
 keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion,
 choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal
 approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your
 transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the
 service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the
 frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the
 settings FramerateNumerator and FramerateDenominator.


framerateConversionAlgorithm
String framerateConversionAlgorithm
When set to INTERPOLATE, produces smoother motion during frame rate conversion.


framerateDenominator
Integer framerateDenominator
Frame rate denominator.


framerateNumerator
Integer framerateNumerator
When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For
 example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this
 example, use 24000 for the value of FramerateNumerator.


interlaceMode
String interlaceMode
Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and
 Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity
 (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD)
 use the same field polarity as the source. Therefore, behavior depends on the input scan type. - If the source is
 interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The
 output could therefore be a mix of "top field first" and "bottom field first". - If the source is progressive,
 the output will be interlaced with "top field first" or "bottom field first" polarity, depending on which of the
 Follow options you chose.


parControl
String parControl
Use (ProresParControl) to specify how the service determines the pixel aspect ratio. Set to Follow source
 (INITIALIZE_FROM_SOURCE) to use the pixel aspect ratio from the input. To specify a different pixel aspect ratio:
 Using the console, choose it from the dropdown menu. Using the API, set ProresParControl to (SPECIFIED) and
 provide for (ParNumerator) and (ParDenominator).


parDenominator
Integer parDenominator
Pixel Aspect Ratio denominator.


parNumerator
Integer parNumerator
Pixel Aspect Ratio numerator.


slowPal
String slowPal
Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up
 correspondingly.


telecine
String telecine
Only use Telecine (ProresTelecine) when you set Framerate (Framerate) to 29.970. Set Telecine (ProresTelecine) to
 Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and
 leave converstion to the player.








Class com.amazonaws.services.mediaconvert.model.Queue extends Object implements Serializable


Serialized Fields


arn
String arn
An identifier for this resource that is unique within all of AWS.


createdAt
Date createdAt
The timestamp in epoch seconds for when you created the queue.


description
String description
An optional description that you create for each queue.


lastUpdated
Date lastUpdated
The timestamp in epoch seconds for when you most recently updated the queue.


name
String name
A name that you create for each queue. Each name must be unique within your account.


pricingPlan
String pricingPlan
Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute,
 billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue,
 regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.


progressingJobsCount
Integer progressingJobsCount
The estimated number of jobs with a PROGRESSING status.


reservationPlan
ReservationPlan reservationPlan
Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to
 on-demand queues.


status
String status
Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs
 that are running when you pause the queue continue to run until they finish or result in an error.


submittedJobsCount
Integer submittedJobsCount
The estimated number of jobs with a SUBMITTED status.


type
String type
Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or
 delete system queues. You can create and modify custom queues.








Class com.amazonaws.services.mediaconvert.model.Rectangle extends Object implements Serializable


Serialized Fields


height
Integer height
Height of rectangle in pixels. Specify only even numbers.


width
Integer width
Width of rectangle in pixels. Specify only even numbers.


x
Integer x
The distance, in pixels, between the rectangle and the left edge of the video frame. Specify only even numbers.


y
Integer y
The distance, in pixels, between the rectangle and the top edge of the video frame. Specify only even numbers.








Class com.amazonaws.services.mediaconvert.model.RemixSettings extends Object implements Serializable


Serialized Fields


channelMapping
ChannelMapping channelMapping
Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel.
 Units are in dB. Acceptable values are within the range from -60 (mute) through 6. A setting of 0 passes the
 input channel unchanged to the output channel (no attenuation or amplification).


channelsIn
Integer channelsIn
Specify the number of audio channels from your input that you want to use in your output. With remixing, you
 might combine or split the data in these channels, so the number of channels in your final output might be
 different.


channelsOut
Integer channelsOut
Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8... 64. (1 and even
 numbers to 64.)








Class com.amazonaws.services.mediaconvert.model.ReservationPlan extends Object implements Serializable


Serialized Fields


commitment
String commitment
The length of the term of your reserved queue pricing plan commitment.


expiresAt
Date expiresAt
The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires.


purchasedAt
Date purchasedAt
The timestamp in epoch seconds for when you set up the current pricing plan for this reserved queue.


renewalType
String renewalType
Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires
 (EXPIRE) at the end of the term.


reservedSlots
Integer reservedSlots
Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs
 the queue can process in parallel; each RTS can process one job at a time. When you increase this number, you
 extend your existing commitment with a new 12-month commitment for a larger number of RTS. The new commitment
 begins when you purchase the additional capacity. You can't decrease the number of RTS in your reserved queue.


status
String status
Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.








Class com.amazonaws.services.mediaconvert.model.ReservationPlanSettings extends Object implements Serializable


Serialized Fields


commitment
String commitment
The length of the term of your reserved queue pricing plan commitment.


renewalType
String renewalType
Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires
 (EXPIRE) at the end of the term. When your term is auto renewed, you extend your commitment by 12 months from the
 auto renew date. You can cancel this commitment.


reservedSlots
Integer reservedSlots
Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs
 the queue can process in parallel; each RTS can process one job at a time. You can't decrease the number of RTS
 in your reserved queue. You can increase the number of RTS by extending your existing commitment with a new
 12-month commitment for the larger number. The new commitment begins when you purchase the additional capacity.
 You can't cancel your commitment or revert to your original commitment after you increase the capacity.








Class com.amazonaws.services.mediaconvert.model.ResourceTags extends Object implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) of the resource.


tags
Map<K,V> tags
The tags for the resource.








Class com.amazonaws.services.mediaconvert.model.S3DestinationAccessControl extends Object implements Serializable


Serialized Fields


cannedAcl
String cannedAcl
Choose an Amazon S3 canned ACL for MediaConvert to apply to this output.








Class com.amazonaws.services.mediaconvert.model.S3DestinationSettings extends Object implements Serializable


Serialized Fields


accessControl
S3DestinationAccessControl accessControl
Optional. Have MediaConvert automatically apply Amazon S3 access control for the outputs in this output group.
 When you don't use this setting, S3 automatically applies the default access control list PRIVATE.


encryption
S3EncryptionSettings encryption
Settings for how your job outputs are encrypted as they are uploaded to Amazon S3.








Class com.amazonaws.services.mediaconvert.model.S3EncryptionSettings extends Object implements Serializable


Serialized Fields


encryptionType
String encryptionType
Specify how you want your data keys managed. AWS uses data keys to encrypt your content. AWS also encrypts the
 data keys themselves, using a customer master key (CMK), and then stores the encrypted data keys alongside your
 encrypted content. Use this setting to specify which AWS service manages the CMK. For simplest set up, choose
 Amazon S3 (SERVER_SIDE_ENCRYPTION_S3). If you want your master key to be managed by AWS Key Management Service
 (KMS), choose AWS KMS (SERVER_SIDE_ENCRYPTION_KMS). By default, when you choose AWS KMS, KMS uses the AWS managed
 customer master key (CMK) associated with Amazon S3 to encrypt your data keys. You can optionally choose to
 specify a different, customer managed CMK. Do so by specifying the Amazon Resource Name (ARN) of the key for the
 setting KMS ARN (kmsKeyArn).


kmsKeyArn
String kmsKeyArn
Optionally, specify the customer master key (CMK) that you want to use to encrypt the data key that AWS uses to
 encrypt your output content. Enter the Amazon Resource Name (ARN) of the CMK. To use this setting, you must also
 set Server-side encryption (S3ServerSideEncryptionType) to AWS KMS (SERVER_SIDE_ENCRYPTION_KMS). If you set
 Server-side encryption to AWS KMS but don't specify a CMK here, AWS uses the AWS managed CMK associated with
 Amazon S3.








Class com.amazonaws.services.mediaconvert.model.SccDestinationSettings extends Object implements Serializable


Serialized Fields


framerate
String framerate
Set Framerate (SccDestinationFramerate) to make sure that the captions and the video are synchronized in the
 output. Specify a frame rate that matches the frame rate of the associated video. If the video frame rate is
 29.97, choose 29.97 dropframe (FRAMERATE_29_97_DROPFRAME) only if the video has video_insertion=true and
 drop_frame_timecode=true; otherwise, choose 29.97 non-dropframe (FRAMERATE_29_97_NON_DROPFRAME).








Class com.amazonaws.services.mediaconvert.model.SpekeKeyProvider extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn
If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate
 with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here.


resourceId
String resourceId
Specify the resource ID that your SPEKE-compliant key provider uses to identify this content.


systemIds
List<E> systemIds
Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids.
 Other group types support one system id. See https://dashif.org/identifiers/content_protection/ for more details.


url
String url
Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting
 your content.








Class com.amazonaws.services.mediaconvert.model.SpekeKeyProviderCmaf extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn
If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate
 with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here.


dashSignaledSystemIds
List<E> dashSignaledSystemIds
Specify the DRM system IDs that you want signaled in the DASH manifest that MediaConvert creates as part of this
 CMAF package. The DASH manifest can currently signal up to three system IDs. For more information, see
 https://dashif.org/identifiers/content_protection/.


hlsSignaledSystemIds
List<E> hlsSignaledSystemIds
Specify the DRM system ID that you want signaled in the HLS manifest that MediaConvert creates as part of this
 CMAF package. The HLS manifest can currently signal only one system ID. For more information, see
 https://dashif.org/identifiers/content_protection/.


resourceId
String resourceId
Specify the resource ID that your SPEKE-compliant key provider uses to identify this content.


url
String url
Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting
 your content.








Class com.amazonaws.services.mediaconvert.model.StaticKeyProvider extends Object implements Serializable


Serialized Fields


keyFormat
String keyFormat
Relates to DRM implementation. Sets the value of the KEYFORMAT attribute. Must be 'identity' or a reverse DNS
 string. May be omitted to indicate an implicit value of 'identity'.


keyFormatVersions
String keyFormatVersions
Relates to DRM implementation. Either a single positive integer version value or a slash delimited list of
 version values (1/2/3).


staticKeyValue
String staticKeyValue
Relates to DRM implementation. Use a 32-character hexidecimal string to specify Key Value (StaticKeyValue).


url
String url
Relates to DRM implementation. The location of the license server used for protecting content.








Class com.amazonaws.services.mediaconvert.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) of the resource that you want to tag. To get the ARN, send a GET request with the
 resource name.


tags
Map<K,V> tags
The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.








Class com.amazonaws.services.mediaconvert.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediaconvert.model.TeletextDestinationSettings extends Object implements Serializable


Serialized Fields


pageNumber
String pageNumber
Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a
 three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of
 Teletext data, do not use this field.


pageTypes
List<E> pageTypes
Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type
 to the default value Subtitle (PAGE_TYPE_SUBTITLE). If you pass through the entire set of Teletext data, don't
 use this field. When you pass through a set of Teletext pages, your output has the same page types as your input.








Class com.amazonaws.services.mediaconvert.model.TeletextSourceSettings extends Object implements Serializable


Serialized Fields


pageNumber
String pageNumber
Use Page Number (PageNumber) to specify the three-digit hexadecimal page number that will be used for Teletext
 captions. Do not use this setting if you are passing through teletext from the input source to output.








Class com.amazonaws.services.mediaconvert.model.TimecodeBurnin extends Object implements Serializable


Serialized Fields


fontSize
Integer fontSize
Use Font Size (FontSize) to set the font size of any burned-in timecode. Valid values are 10, 16, 32, 48.


position
String position
Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to specify the location the burned-in
 timecode on output video.


prefix
String prefix
Use Prefix (Prefix) to place ASCII characters before any burned-in timecode. For example, a prefix of "EZ-" will
 result in the timecode "EZ-00:00:00:00". Provide either the characters themselves or the ASCII code equivalents.
 The supported range of characters is 0x20 through 0x7e. This includes letters, numbers, and all special characters
 represented on a standard English keyboard.








Class com.amazonaws.services.mediaconvert.model.TimecodeConfig extends Object implements Serializable


Serialized Fields


anchor
String anchor
If you use an editing platform that relies on an anchor timecode, use Anchor Timecode (Anchor) to specify a
 timecode that will match the input video frame to the output video frame. Use 24-hour format with frame number,
 (HH:MM:SS:FF) or (HH:MM:SS;FF). This setting ignores frame rate conversion. System behavior for Anchor Timecode
 varies depending on your setting for Source (TimecodeSource). * If Source (TimecodeSource) is set to Specified
 Start (SPECIFIEDSTART), the first input frame is the specified value in Start Timecode (Start). Anchor Timecode
 (Anchor) and Start Timecode (Start) are used calculate output timecode. * If Source (TimecodeSource) is set to
 Start at 0 (ZEROBASED) the first frame is 00:00:00:00. * If Source (TimecodeSource) is set to Embedded (EMBEDDED),
 the first frame is the timecode value on the first input frame of the input.


source
String source
Use Source (TimecodeSource) to set how timecodes are handled within this job. To make sure that your video,
 audio, captions, and markers are synchronized and that time-based features, such as image inserter, work
 correctly, choose the Timecode source option that matches your assets. All timecodes are in a 24-hour format with
 frame number (HH:MM:SS:FF). * Embedded (EMBEDDED) - Use the timecode that is in the input video. If no embedded
 timecode is in the source, the service will use Start at 0 (ZEROBASED) instead. * Start at 0 (ZEROBASED) - Set the
 timecode of the initial frame to 00:00:00:00. * Specified Start (SPECIFIEDSTART) - Set the timecode of the initial
 frame to a value other than zero. You use Start timecode (Start) to provide this value.


start
String start
Only use when you set Source (TimecodeSource) to Specified start (SPECIFIEDSTART). Use Start timecode (Start) to
 specify the timecode for the initial frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF).


timestampOffset
String timestampOffset
Only applies to outputs that support program-date-time stamp. Use Timestamp offset (TimestampOffset) to overwrite
 the timecode date without affecting the time and frame number. Provide the new date as a string in the format
 "yyyy-mm-dd". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in
 the output settings. For example, if the date part of your timecodes is 2002-1-25 and you want to change it to one
 year later, set Timestamp offset (TimestampOffset) to 2003-1-25.








Class com.amazonaws.services.mediaconvert.model.TimedMetadataInsertion extends Object implements Serializable


Serialized Fields


id3Insertions
List<E> id3Insertions
Id3Insertions contains the array of Id3Insertion instances.








Class com.amazonaws.services.mediaconvert.model.Timing extends Object implements Serializable


Serialized Fields


finishTime
Date finishTime
The time, in Unix epoch format, that the transcoding job finished


startTime
Date startTime
The time, in Unix epoch format, that transcoding for the job began.


submitTime
Date submitTime
The time, in Unix epoch format, that you submitted the job.








Class com.amazonaws.services.mediaconvert.model.TooManyRequestsException extends AWSMediaConvertException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediaconvert.model.TrackSourceSettings extends Object implements Serializable


Serialized Fields


trackNumber
Integer trackNumber
Use this setting to select a single captions track from a source. Track numbers correspond to the order in the
 captions source file. For IMF sources, track numbering is based on the order that the captions appear in the CPL.
 For example, use 1 to select the captions asset that is listed first in the CPL. To include more than one captions
 track in your job outputs, create multiple input captions selectors. Specify one track per selector.








Class com.amazonaws.services.mediaconvert.model.TtmlDestinationSettings extends Object implements Serializable


Serialized Fields


stylePassthrough
String stylePassthrough
Pass through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT
 output or TTML output.








Class com.amazonaws.services.mediaconvert.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) of the resource that you want to remove tags from. To get the ARN, send a GET
 request with the resource name.


tagKeys
List<E> tagKeys
The keys of the tags that you want to remove from the resource.








Class com.amazonaws.services.mediaconvert.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediaconvert.model.UpdateJobTemplateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accelerationSettings
AccelerationSettings accelerationSettings
Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use
 this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental
 MediaConvert User Guide.


category
String category
The new category for the job template, if you are changing it.


description
String description
The new description for the job template, if you are changing it.


name
String name
The name of the job template you are modifying


priority
Integer priority
Specify the relative priority for this job. In any given queue, the service begins processing the job with the
 highest value first. When more than one job has the same priority, the service begins processing the job that you
 submitted first. If you don't specify a priority, the service uses the default value 0.


queue
String queue
The new queue for the job template, if you are changing it.


settings
JobTemplateSettings settings
JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs
 created from it.


statusUpdateInterval
String statusUpdateInterval
Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in
 seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins
 processing your job to the time it completes the transcode or encounters an error.








Class com.amazonaws.services.mediaconvert.model.UpdateJobTemplateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


jobTemplate
JobTemplate jobTemplate
A job template is a pre-made set of encoding instructions that you can use to quickly create a job.








Class com.amazonaws.services.mediaconvert.model.UpdatePresetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


category
String category
The new category for the preset, if you are changing it.


description
String description
The new description for the preset, if you are changing it.


name
String name
The name of the preset you are modifying.


settings
PresetSettings settings
Settings for preset








Class com.amazonaws.services.mediaconvert.model.UpdatePresetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


preset
Preset preset
A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the
 output during the conversion process.








Class com.amazonaws.services.mediaconvert.model.UpdateQueueRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description
The new description for the queue, if you are changing it.


name
String name
The name of the queue that you are modifying.


reservationPlanSettings
ReservationPlanSettings reservationPlanSettings
The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an
 expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the
 number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make
 these commitments, you can't cancel them.


status
String status
Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that
 queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in
 an error.








Class com.amazonaws.services.mediaconvert.model.UpdateQueueResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


queue
Queue queue
You can use queues to manage the resources that are available to your AWS account for running multiple
 transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default
 queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.








Class com.amazonaws.services.mediaconvert.model.VideoCodecSettings extends Object implements Serializable


Serialized Fields


codec
String codec
Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec.


frameCaptureSettings
FrameCaptureSettings frameCaptureSettings
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.


h264Settings
H264Settings h264Settings
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264.


h265Settings
H265Settings h265Settings
Settings for H265 codec


mpeg2Settings
Mpeg2Settings mpeg2Settings
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value MPEG2.


proresSettings
ProresSettings proresSettings
Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES.








Class com.amazonaws.services.mediaconvert.model.VideoDescription extends Object implements Serializable


Serialized Fields


afdSignaling
String afdSignaling
This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify
 whether the service includes AFD values in the output video data and what those values are. * Choose None to
 remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value
 specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.


antiAlias
String antiAlias
The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED
 for AntiAlias. If you specify that in your job, the service will ignore the setting.


codecSettings
VideoCodecSettings codecSettings
Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video
 encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For
 each codec enum that you choose, define the corresponding settings object. The following lists the codec enum,
 settings object pairs. * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, H265Settings * MPEG2,
 Mpeg2Settings * PRORES, ProresSettings


colorMetadata
String colorMetadata
Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to
 exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by
 default.


crop
Rectangle crop
Use Cropping selection (crop) to specify the video area that the service will include in the output video frame.


dropFrameTimecode
String dropFrameTimecode
Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on
 outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This
 setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.


fixedAfd
Integer fixedAfd
Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit
 AFD value which the service will write on all frames of this video output.


height
Integer height
Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you
 don't provide a value here, the service will use the input height.


position
Rectangle position
Use Selection placement (position) to define the video area in your output frame. The area outside of the
 rectangle that you specify here is black.


respondToAfd
String respondToAfd
Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values
 in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect
 ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this
 when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE)
 and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.


scalingBehavior
String scalingBehavior
Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose
 Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting
 Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you
 specify for the setting Selection placement (position) in this output.


sharpness
Integer sharpness
Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the
 anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from
 your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.


timecodeInsertion
String timecodeInsertion
Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate
 is identical to the output frame rate. To include timecodes in this output, set Timecode insertion
 (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the
 service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are
 present, the service will set the timecode for the first output frame to zero. To change this default behavior,
 adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located
 under Job > Job settings > Timecode configuration. Note - Timecode source under input settings
 (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings >
 Timecode configuration (TimecodeSource) does.


videoPreprocessors
VideoPreprocessor videoPreprocessors
Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output
 individually. These features are disabled by default.


width
Integer width
Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value
 here, the service will use the input width.








Class com.amazonaws.services.mediaconvert.model.VideoDetail extends Object implements Serializable


Serialized Fields


heightInPx
Integer heightInPx
Height in pixels for the output


widthInPx
Integer widthInPx
Width in pixels for the output








Class com.amazonaws.services.mediaconvert.model.VideoPreprocessor extends Object implements Serializable


Serialized Fields


colorCorrector
ColorCorrector colorCorrector
Enable the Color corrector (ColorCorrector) feature if necessary. Enable or disable this feature for each output
 individually. This setting is disabled by default.


deinterlacer
Deinterlacer deinterlacer
Use Deinterlacer (Deinterlacer) to produce smoother motion and a clearer picture.


dolbyVision
DolbyVision dolbyVision
Enable Dolby Vision feature to produce Dolby Vision compatible video output.


imageInserter
ImageInserter imageInserter
Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable
 this feature for each output individually. This setting is disabled by default.


noiseReducer
NoiseReducer noiseReducer
Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or
 disable this feature for each output individually. This setting is disabled by default.


timecodeBurnin
TimecodeBurnin timecodeBurnin
Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output.








Class com.amazonaws.services.mediaconvert.model.VideoSelector extends Object implements Serializable


Serialized Fields


alphaBehavior
String alphaBehavior
Ignore this setting unless this input is a QuickTime animation with an alpha channel. Use this setting to create
 separate Key and Fill outputs. In each output, specify which part of the input MediaConvert uses. Leave this
 setting at the default value DISCARD to delete the alpha channel and preserve the video. Set it to REMAP_TO_LUMA
 to delete the video and map the alpha channel to the luma channel of your outputs.


colorSpace
String colorSpace
If your input video has accurate color space metadata, or if you don't know about color space, leave this set to
 the default value Follow (FOLLOW). The service will automatically detect your input color space. If your input
 video has metadata indicating the wrong color space, specify the accurate color space here. If your input video is
 HDR 10 and the SMPTE ST 2086 Mastering Display Color Volume static metadata isn't present in your video stream, or
 if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) here and specify correct values in
 the input HDR 10 metadata (Hdr10Metadata) settings. For more information about MediaConvert HDR jobs, see
 https://docs.aws.amazon.com/console/mediaconvert/hdr.


colorSpaceUsage
String colorSpaceUsage
There are two sources for color metadata, the input file and the job input settings Color space (ColorSpace) and
 HDR master display information settings(Hdr10Metadata). The Color space usage setting determines which takes
 precedence. Choose Force (FORCE) to use color metadata from the input job settings. If you don't specify values
 for those settings, the service defaults to using metadata from your input. FALLBACK - Choose Fallback (FALLBACK)
 to use color metadata from the source when it is present. If there's no color metadata in your input file, the
 service defaults to using values you specify in the input settings.


hdr10Metadata
Hdr10Metadata hdr10Metadata
Use these settings to provide HDR 10 metadata that is missing or inaccurate in your input video. Appropriate
 values vary depending on the input video and must be provided by a color grader. The color grader generates these
 values during the HDR 10 mastering process. The valid range for each of these settings is 0 to 50,000. Each
 increment represents 0.00002 in CIE1931 color coordinate. Related settings - When you specify these values, you
 must also set Color space (ColorSpace) to HDR 10 (HDR10). To specify whether the the values you specify here take
 precedence over the values in the metadata of your input file, set Color space usage (ColorSpaceUsage). To specify
 whether color metadata is included in an output, set Color metadata (ColorMetadata). For more information about
 MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.


pid
Integer pid
Use PID (Pid) to select specific video data from an input file. Specify this value as an integer; the system
 automatically converts it to the hexidecimal value. For example, 257 selects PID 0x101. A PID, or packet
 identifier, is an identifier for a set of data in an MPEG-2 transport stream container.


programNumber
Integer programNumber
Selects a specific program from within a multi-program transport stream. Note that Quad 4K is not currently
 supported.


rotate
String rotate
Use Rotate (InputRotate) to specify how the service rotates your video. You can choose automatic rotation or
 specify a rotation. You can specify a clockwise rotation of 0, 90, 180, or 270 degrees. If your input video
 container is .mov or .mp4 and your input has rotation metadata, you can choose Automatic to have the service
 rotate your video according to the rotation specified in the metadata. The rotation must be within one degree of
 90, 180, or 270 degrees. If the rotation metadata specifies any other rotation, the service will default to no
 rotation. By default, the service does no rotation, even if your input video has rotation metadata. The service
 doesn't pass through rotation metadata.








Class com.amazonaws.services.mediaconvert.model.WavSettings extends Object implements Serializable


Serialized Fields


bitDepth
Integer bitDepth
Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track.


channels
Integer channels
Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For
 example, 1, 2, 4, 6, and so on, up to 64.


format
String format
The service defaults to using RIFF for WAV outputs. If your output audio is likely to exceed 4 GB in file size,
 or if you otherwise need the extended support of the RF64 format, set your output WAV file format to RF64.


sampleRate
Integer sampleRate
Sample rate in Hz.








Package com.amazonaws.services.medialive.model




Class com.amazonaws.services.medialive.model.AacSettings extends Object implements Serializable


Serialized Fields


bitrate
Double bitrate
Average bitrate in bits/second. Valid values depend on rate control mode and profile.


codingMode
String codingMode
Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix
 setting receives a stereo description plus control track and emits a mono AAC encode of the description track,
 with control data emitted in the PES header as per ETSI TS 101 154 Annex E.


inputType
String inputType
Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio
 Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains
 "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does
 not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to
 broadcasterMixedAd.
 
 Leave set to "normal" when input does not contain pre-mixed audio + AD.


profile
String profile
AAC Profile.


rateControlMode
String rateControlMode
Rate Control Mode.


rawFormat
String rawFormat
Sets LATM / LOAS AAC output for raw containers.


sampleRate
Double sampleRate
Sample rate in Hz. Valid values depend on rate control mode and profile.


spec
String spec
Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.


vbrQuality
String vbrQuality
VBR Quality Level - Only used if rateControlMode is VBR.








Class com.amazonaws.services.medialive.model.Ac3Settings extends Object implements Serializable


Serialized Fields


bitrate
Double bitrate
Average bitrate in bits/second. Valid bitrates depend on the coding mode.


bitstreamMode
String bitstreamMode
Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these
 values.


codingMode
String codingMode
Dolby Digital coding mode. Determines number of channels.


dialnorm
Integer dialnorm
Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.


drcProfile
String drcProfile
If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby
 Digital specification.


lfeFilter
String lfeFilter
When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in
 codingMode32Lfe mode.


metadataControl
String metadataControl
When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied
 this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be
 used.








Class com.amazonaws.services.medialive.model.ArchiveContainerSettings extends Object implements Serializable


Serialized Fields


m2tsSettings
M2tsSettings m2tsSettings








Class com.amazonaws.services.medialive.model.ArchiveGroupSettings extends Object implements Serializable


Serialized Fields


destination
OutputLocationRef destination
A directory and base filename where archive files should be written.


rolloverInterval
Integer rolloverInterval
Number of seconds to write to archive file before closing and starting a new one.








Class com.amazonaws.services.medialive.model.ArchiveOutputSettings extends Object implements Serializable


Serialized Fields


containerSettings
ArchiveContainerSettings containerSettings
Settings specific to the container type of the file.


extension
String extension
Output file extension. If excluded, this will be auto-selected from the container type.


nameModifier
String nameModifier
String concatenated to the end of the destination filename. Required for multiple outputs of the same type.








Class com.amazonaws.services.medialive.model.AribDestinationSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.AribSourceSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.AudioChannelMapping extends Object implements Serializable


Serialized Fields


inputChannelLevels
List<E> inputChannelLevels
Indices and gain values for each input channel that should be remixed into this output channel.


outputChannel
Integer outputChannel
The index of the output channel being produced.








Class com.amazonaws.services.medialive.model.AudioCodecSettings extends Object implements Serializable


Serialized Fields


aacSettings
AacSettings aacSettings


ac3Settings
Ac3Settings ac3Settings


eac3Settings
Eac3Settings eac3Settings


mp2Settings
Mp2Settings mp2Settings


passThroughSettings
PassThroughSettings passThroughSettings








Class com.amazonaws.services.medialive.model.AudioDescription extends Object implements Serializable


Serialized Fields


audioNormalizationSettings
AudioNormalizationSettings audioNormalizationSettings
Advanced audio normalization settings.


audioSelectorName
String audioSelectorName
The name of the AudioSelector used as the source for this AudioDescription.


audioType
String audioType
Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.


audioTypeControl
String audioTypeControl
Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value
 is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included
 in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and
 audioType are both ignored if inputType is broadcasterMixedAd.


codecSettings
AudioCodecSettings codecSettings
Audio codec settings.


languageCode
String languageCode
Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is
 no ISO 639 language code specified in the input.


languageCodeControl
String languageCodeControl
Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of
 the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is
 no ISO 639 language code specified by the input.


name
String name
The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription.
 Description names should be unique within this Live Event.


remixSettings
RemixSettings remixSettings
Settings that control how input audio channels are remixed into the output audio channels.


streamName
String streamName
Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director
 Commentary).








Class com.amazonaws.services.medialive.model.AudioLanguageSelection extends Object implements Serializable


Serialized Fields


languageCode
String languageCode
Selects a specific three-letter language code from within an audio source.


languageSelectionPolicy
String languageSelectionPolicy
When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor.
 If a PMT update occurs such that an audio stream matching the initially selected language is no longer present
 then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose
 another audio stream in the program with the same stream type if it can't find one with the same language.








Class com.amazonaws.services.medialive.model.AudioNormalizationSettings extends Object implements Serializable


Serialized Fields


algorithm
String algorithm
Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the
 EBU R-128 specification.


algorithmControl
String algorithmControl
When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the
 audio will be measured but not adjusted.


targetLkfs
Double targetLkfs
Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the
 chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2)
 recommends a target of -23 LKFS.








Class com.amazonaws.services.medialive.model.AudioOnlyHlsSettings extends Object implements Serializable


Serialized Fields


audioGroupId
String audioGroupId
Specifies the group to which the audio Rendition belongs.


audioOnlyImage
InputLocation audioOnlyImage
Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low
 bit-size file because the image increases the output audio bandwidth.
 
 The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the
 "ID3 tag version 2.4.0 - Native Frames" standard.


audioTrackType
String audioTrackType
Four types of audio-only tracks are supported:
 
 Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth
 scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest.
 
 Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default.
 Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES
 
 Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default.
 Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES
 
 Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default.
 Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO


segmentType
String segmentType
Specifies the segment type.








Class com.amazonaws.services.medialive.model.AudioPidSelection extends Object implements Serializable


Serialized Fields


pid
Integer pid
Selects a specific PID from within a source.








Class com.amazonaws.services.medialive.model.AudioSelector extends Object implements Serializable


Serialized Fields


name
String name
The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector
 names should be unique per input.


selectorSettings
AudioSelectorSettings selectorSettings
The audio selector settings.








Class com.amazonaws.services.medialive.model.AudioSelectorSettings extends Object implements Serializable


Serialized Fields


audioLanguageSelection
AudioLanguageSelection audioLanguageSelection


audioPidSelection
AudioPidSelection audioPidSelection








Class com.amazonaws.services.medialive.model.AvailBlanking extends Object implements Serializable


Serialized Fields


availBlankingImage
InputLocation availBlankingImage
Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.


state
String state
When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.








Class com.amazonaws.services.medialive.model.AvailConfiguration extends Object implements Serializable


Serialized Fields


availSettings
AvailSettings availSettings
Ad avail settings.








Class com.amazonaws.services.medialive.model.AvailSettings extends Object implements Serializable


Serialized Fields


scte35SpliceInsert
Scte35SpliceInsert scte35SpliceInsert


scte35TimeSignalApos
Scte35TimeSignalApos scte35TimeSignalApos








Class com.amazonaws.services.medialive.model.AWSMediaLiveException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.medialive.model.BadGatewayException extends AWSMediaLiveException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.medialive.model.BadRequestException extends AWSMediaLiveException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.medialive.model.BatchScheduleActionCreateRequest extends Object implements Serializable


Serialized Fields


scheduleActions
List<E> scheduleActions
A list of schedule actions to create.








Class com.amazonaws.services.medialive.model.BatchScheduleActionCreateResult extends Object implements Serializable


Serialized Fields


scheduleActions
List<E> scheduleActions
List of actions that have been created in the schedule.








Class com.amazonaws.services.medialive.model.BatchScheduleActionDeleteRequest extends Object implements Serializable


Serialized Fields


actionNames
List<E> actionNames
A list of schedule actions to delete.








Class com.amazonaws.services.medialive.model.BatchScheduleActionDeleteResult extends Object implements Serializable


Serialized Fields


scheduleActions
List<E> scheduleActions
List of actions that have been deleted from the schedule.








Class com.amazonaws.services.medialive.model.BatchUpdateScheduleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelId
String channelId
Id of the channel whose schedule is being updated.


creates
BatchScheduleActionCreateRequest creates
Schedule actions to create in the schedule.


deletes
BatchScheduleActionDeleteRequest deletes
Schedule actions to delete from the schedule.








Class com.amazonaws.services.medialive.model.BatchUpdateScheduleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


creates
BatchScheduleActionCreateResult creates
Schedule actions created in the schedule.


deletes
BatchScheduleActionDeleteResult deletes
Schedule actions deleted from the schedule.








Class com.amazonaws.services.medialive.model.BlackoutSlate extends Object implements Serializable


Serialized Fields


blackoutSlateImage
InputLocation blackoutSlateImage
Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.


networkEndBlackout
String networkEndBlackout
Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the
 "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The
 blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network
 Start descriptors must contain a network ID that matches the value entered in "Network ID".


networkEndBlackoutImage
InputLocation networkEndBlackoutImage
Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.


networkId
String networkId
Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").


state
String state
When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.








Class com.amazonaws.services.medialive.model.BurnInDestinationSettings extends Object implements Serializable


Serialized Fields


alignment
String alignment
If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the
 bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the
 output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified
 (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live
 subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match.


backgroundColor
String backgroundColor
Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.


backgroundOpacity
Integer backgroundOpacity
Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is
 equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.


font
InputLocation font
External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select
 output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid
 system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All
 burn-in and DVB-Sub font settings must match.


fontColor
String fontColor
Specifies the color of the burned-in captions. This option is not valid for source captions that are STL,
 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and
 DVB-Sub font settings must match.


fontOpacity
Integer fontOpacity
Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font
 settings must match.


fontResolution
Integer fontResolution
Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.


fontSize
String fontSize
When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will
 specify the exact font size in points. All burn-in and DVB-Sub font settings must match.


outlineColor
String outlineColor
Specifies font outline color. This option is not valid for source captions that are either 608/embedded or
 teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font
 settings must match.


outlineSize
Integer outlineSize
Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded
 or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font
 settings must match.


shadowColor
String shadowColor
Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.


shadowOpacity
Integer shadowOpacity
Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to
 setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.


shadowXOffset
Integer shadowXOffset
Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a
 shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.


shadowYOffset
Integer shadowYOffset
Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a
 shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.


teletextGridControl
String teletextGridControl
Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for
 Teletext inputs and DVB-Sub/Burn-in outputs.


xPosition
Integer xPosition
Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10
 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is
 provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub
 font settings must match.


yPosition
Integer yPosition
Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would
 result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the
 caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.








Class com.amazonaws.services.medialive.model.CaptionDescription extends Object implements Serializable


Serialized Fields


captionSelectorName
String captionSelectorName
Specifies which input caption selector to use as a caption source when generating output captions. This field
 should match a captionSelector name.


destinationSettings
CaptionDestinationSettings destinationSettings
Additional settings for captions destination that depend on the destination type.


languageCode
String languageCode
ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/


languageDescription
String languageDescription
Human readable information to indicate captions available for players (eg. English, or Spanish).


name
String name
Name of the caption description. Used to associate a caption description with an output. Names must be unique
 within an event.








Class com.amazonaws.services.medialive.model.CaptionDestinationSettings extends Object implements Serializable


Serialized Fields


aribDestinationSettings
AribDestinationSettings aribDestinationSettings


burnInDestinationSettings
BurnInDestinationSettings burnInDestinationSettings


dvbSubDestinationSettings
DvbSubDestinationSettings dvbSubDestinationSettings


embeddedDestinationSettings
EmbeddedDestinationSettings embeddedDestinationSettings


embeddedPlusScte20DestinationSettings
EmbeddedPlusScte20DestinationSettings embeddedPlusScte20DestinationSettings


rtmpCaptionInfoDestinationSettings
RtmpCaptionInfoDestinationSettings rtmpCaptionInfoDestinationSettings


scte20PlusEmbeddedDestinationSettings
Scte20PlusEmbeddedDestinationSettings scte20PlusEmbeddedDestinationSettings


scte27DestinationSettings
Scte27DestinationSettings scte27DestinationSettings


smpteTtDestinationSettings
SmpteTtDestinationSettings smpteTtDestinationSettings


teletextDestinationSettings
TeletextDestinationSettings teletextDestinationSettings


ttmlDestinationSettings
TtmlDestinationSettings ttmlDestinationSettings


webvttDestinationSettings
WebvttDestinationSettings webvttDestinationSettings








Class com.amazonaws.services.medialive.model.CaptionLanguageMapping extends Object implements Serializable


Serialized Fields


captionChannel
Integer captionChannel
The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a
 unique channel number (maximum of 4)


languageCode
String languageCode
Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)


languageDescription
String languageDescription
Textual description of language








Class com.amazonaws.services.medialive.model.CaptionSelector extends Object implements Serializable


Serialized Fields


languageCode
String languageCode
When specified this field indicates the three letter language code of the caption track to extract from the
 source.


name
String name
Name identifier for a caption selector. This name is used to associate this caption selector with one or more
 caption descriptions. Names must be unique within an event.


selectorSettings
CaptionSelectorSettings selectorSettings
Caption selector settings.








Class com.amazonaws.services.medialive.model.CaptionSelectorSettings extends Object implements Serializable


Serialized Fields


aribSourceSettings
AribSourceSettings aribSourceSettings


dvbSubSourceSettings
DvbSubSourceSettings dvbSubSourceSettings


embeddedSourceSettings
EmbeddedSourceSettings embeddedSourceSettings


scte20SourceSettings
Scte20SourceSettings scte20SourceSettings


scte27SourceSettings
Scte27SourceSettings scte27SourceSettings


teletextSourceSettings
TeletextSourceSettings teletextSourceSettings








Class com.amazonaws.services.medialive.model.Channel extends Object implements Serializable


Serialized Fields


arn
String arn
The unique arn of the channel.


channelClass
String channelClass
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one
 pipeline.


destinations
List<E> destinations
A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types
 (HLS, for example), there is one destination per packager.


egressEndpoints
List<E> egressEndpoints
The endpoints where outgoing connections initiate from


encoderSettings
EncoderSettings encoderSettings


id
String id
The unique id of the channel.


inputAttachments
List<E> inputAttachments
List of input attachments for channel.


inputSpecification
InputSpecification inputSpecification


logLevel
String logLevel
The log level being written to CloudWatch Logs.


name
String name
The name of the channel. (user-mutable)


pipelineDetails
List<E> pipelineDetails
Runtime details for the pipelines of a running channel.


pipelinesRunningCount
Integer pipelinesRunningCount
The number of currently healthy pipelines.


roleArn
String roleArn
The Amazon Resource Name (ARN) of the role assumed when running the Channel.


state
String state


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.ChannelEgressEndpoint extends Object implements Serializable


Serialized Fields


sourceIp
String sourceIp
Public IP of where a channel's output comes from








Class com.amazonaws.services.medialive.model.ChannelSummary extends Object implements Serializable


Serialized Fields


arn
String arn
The unique arn of the channel.


channelClass
String channelClass
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one
 pipeline.


destinations
List<E> destinations
A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types
 (HLS, for example), there is one destination per packager.


egressEndpoints
List<E> egressEndpoints
The endpoints where outgoing connections initiate from


id
String id
The unique id of the channel.


inputAttachments
List<E> inputAttachments
List of input attachments for channel.


inputSpecification
InputSpecification inputSpecification


logLevel
String logLevel
The log level being written to CloudWatch Logs.


name
String name
The name of the channel. (user-mutable)


pipelinesRunningCount
Integer pipelinesRunningCount
The number of currently healthy pipelines.


roleArn
String roleArn
The Amazon Resource Name (ARN) of the role assumed when running the Channel.


state
String state


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.ColorSpacePassthroughSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.ConflictException extends AWSMediaLiveException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.medialive.model.CreateChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelClass
String channelClass
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one
 pipeline.


destinations
List<E> destinations


encoderSettings
EncoderSettings encoderSettings


inputAttachments
List<E> inputAttachments
List of input attachments for channel.


inputSpecification
InputSpecification inputSpecification
Specification of input for this channel (max. bitrate, resolution, codec, etc.)


logLevel
String logLevel
The log level to write to CloudWatch Logs.


name
String name
Name of channel.


requestId
String requestId
Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.


reserved
String reserved
Deprecated. 
Deprecated field that's only usable by whitelisted customers.


roleArn
String roleArn
An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.CreateChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channel
Channel channel








Class com.amazonaws.services.medialive.model.CreateInputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinations
List<E> destinations
Destination settings for PUSH type inputs.


inputSecurityGroups
List<E> inputSecurityGroups
A list of security groups referenced by IDs to attach to the input.


mediaConnectFlows
List<E> mediaConnectFlows
A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one Flow and
 presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate
 Availability Zone as this ensures your EML input is redundant to AZ issues.


name
String name
Name of the input.


requestId
String requestId
Unique identifier of the request to ensure the request is handled exactly once in case of retries.


roleArn
String roleArn
The Amazon Resource Name (ARN) of the role this input assumes during and after creation.


sources
List<E> sources
The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only
 specify sources for PULL type Inputs. Leave Destinations empty.


tags
Map<K,V> tags
A collection of key-value pairs.


type
String type


vpc
InputVpcRequest vpc








Class com.amazonaws.services.medialive.model.CreateInputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


input
Input input








Class com.amazonaws.services.medialive.model.CreateInputSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


tags
Map<K,V> tags
A collection of key-value pairs.


whitelistRules
List<E> whitelistRules
List of IPv4 CIDR addresses to whitelist








Class com.amazonaws.services.medialive.model.CreateInputSecurityGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityGroup
InputSecurityGroup securityGroup








Class com.amazonaws.services.medialive.model.CreateMultiplexProgramRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


multiplexId
String multiplexId
ID of the multiplex where the program is to be created.


multiplexProgramSettings
MultiplexProgramSettings multiplexProgramSettings
The settings for this multiplex program.


programName
String programName
Name of multiplex program.


requestId
String requestId
Unique request ID. This prevents retries from creating multiple resources.








Class com.amazonaws.services.medialive.model.CreateMultiplexProgramResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


multiplexProgram
MultiplexProgram multiplexProgram
The newly created multiplex program.








Class com.amazonaws.services.medialive.model.CreateMultiplexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZones
List<E> availabilityZones
A list of availability zones for the multiplex. You must specify exactly two.


multiplexSettings
MultiplexSettings multiplexSettings
Configuration for a multiplex event.


name
String name
Name of multiplex.


requestId
String requestId
Unique request ID. This prevents retries from creating multiple resources.


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.CreateMultiplexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


multiplex
Multiplex multiplex
The newly created multiplex.








Class com.amazonaws.services.medialive.model.CreateTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn


tags
Map<K,V> tags








Class com.amazonaws.services.medialive.model.CreateTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.medialive.model.DeleteChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelId
String channelId
Unique ID of the channel.








Class com.amazonaws.services.medialive.model.DeleteChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The unique arn of the channel.


channelClass
String channelClass
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one
 pipeline.


destinations
List<E> destinations
A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types
 (HLS, for example), there is one destination per packager.


egressEndpoints
List<E> egressEndpoints
The endpoints where outgoing connections initiate from


encoderSettings
EncoderSettings encoderSettings


id
String id
The unique id of the channel.


inputAttachments
List<E> inputAttachments
List of input attachments for channel.


inputSpecification
InputSpecification inputSpecification


logLevel
String logLevel
The log level being written to CloudWatch Logs.


name
String name
The name of the channel. (user-mutable)


pipelineDetails
List<E> pipelineDetails
Runtime details for the pipelines of a running channel.


pipelinesRunningCount
Integer pipelinesRunningCount
The number of currently healthy pipelines.


roleArn
String roleArn
The Amazon Resource Name (ARN) of the role assumed when running the Channel.


state
String state


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.DeleteInputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputId
String inputId
Unique ID of the input








Class com.amazonaws.services.medialive.model.DeleteInputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.medialive.model.DeleteInputSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputSecurityGroupId
String inputSecurityGroupId
The Input Security Group to delete








Class com.amazonaws.services.medialive.model.DeleteInputSecurityGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.medialive.model.DeleteMultiplexProgramRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


multiplexId
String multiplexId
The ID of the multiplex that the program belongs to.


programName
String programName
The multiplex program name.








Class com.amazonaws.services.medialive.model.DeleteMultiplexProgramResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channelId
String channelId
The MediaLive channel associated with the program.


multiplexProgramSettings
MultiplexProgramSettings multiplexProgramSettings
The settings for this multiplex program.


packetIdentifiersMap
MultiplexProgramPacketIdentifiersMap packetIdentifiersMap
The packet identifier map for this multiplex program.


programName
String programName
The name of the multiplex program.








Class com.amazonaws.services.medialive.model.DeleteMultiplexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


multiplexId
String multiplexId
The ID of the multiplex.








Class com.amazonaws.services.medialive.model.DeleteMultiplexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The unique arn of the multiplex.


availabilityZones
List<E> availabilityZones
A list of availability zones for the multiplex.


destinations
List<E> destinations
A list of the multiplex output destinations.


id
String id
The unique id of the multiplex.


multiplexSettings
MultiplexSettings multiplexSettings
Configuration for a multiplex event.


name
String name
The name of the multiplex.


pipelinesRunningCount
Integer pipelinesRunningCount
The number of currently healthy pipelines.


programCount
Integer programCount
The number of programs in the multiplex.


state
String state
The current state of the multiplex.


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.DeleteReservationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reservationId
String reservationId
Unique reservation ID, e.g. '1234567'








Class com.amazonaws.services.medialive.model.DeleteReservationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'


count
Integer count
Number of reserved resources


currencyCode
String currencyCode
Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'


duration
Integer duration
Lease duration, e.g. '12'


durationUnits
String durationUnits
Units for duration, e.g. 'MONTHS'


end
String end
Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'


fixedPrice
Double fixedPrice
One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering


name
String name
User specified reservation name


offeringDescription
String offeringDescription
Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'


offeringId
String offeringId
Unique offering ID, e.g. '87654321'


offeringType
String offeringType
Offering type, e.g. 'NO_UPFRONT'


region
String region
AWS region, e.g. 'us-west-2'


reservationId
String reservationId
Unique reservation ID, e.g. '1234567'


resourceSpecification
ReservationResourceSpecification resourceSpecification
Resource configuration details


start
String start
Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'


state
String state
Current state of reservation, e.g. 'ACTIVE'


tags
Map<K,V> tags
A collection of key-value pairs


usagePrice
Double usagePrice
Recurring usage charge for each reserved resource, e.g. '157.0'








Class com.amazonaws.services.medialive.model.DeleteScheduleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelId
String channelId
Id of the channel whose schedule is being deleted.








Class com.amazonaws.services.medialive.model.DeleteScheduleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.medialive.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn


tagKeys
List<E> tagKeys
An array of tag keys to delete








Class com.amazonaws.services.medialive.model.DeleteTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.medialive.model.DescribeChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelId
String channelId
channel ID








Class com.amazonaws.services.medialive.model.DescribeChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The unique arn of the channel.


channelClass
String channelClass
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one
 pipeline.


destinations
List<E> destinations
A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types
 (HLS, for example), there is one destination per packager.


egressEndpoints
List<E> egressEndpoints
The endpoints where outgoing connections initiate from


encoderSettings
EncoderSettings encoderSettings


id
String id
The unique id of the channel.


inputAttachments
List<E> inputAttachments
List of input attachments for channel.


inputSpecification
InputSpecification inputSpecification


logLevel
String logLevel
The log level being written to CloudWatch Logs.


name
String name
The name of the channel. (user-mutable)


pipelineDetails
List<E> pipelineDetails
Runtime details for the pipelines of a running channel.


pipelinesRunningCount
Integer pipelinesRunningCount
The number of currently healthy pipelines.


roleArn
String roleArn
The Amazon Resource Name (ARN) of the role assumed when running the Channel.


state
String state


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.DescribeInputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputId
String inputId
Unique ID of the input








Class com.amazonaws.services.medialive.model.DescribeInputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The Unique ARN of the input (generated, immutable).


attachedChannels
List<E> attachedChannels
A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).


destinations
List<E> destinations
A list of the destinations of the input (PUSH-type).


id
String id
The generated ID of the input (unique for user account, immutable).


inputClass
String inputClass
STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both
 sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second
 source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source
 to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD,
 this value is not valid because the channel requires two sources in the input.


inputSourceType
String inputSourceType
Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during
 input switch actions. Presently, this functionality only works with MP4_FILE inputs.


mediaConnectFlows
List<E> mediaConnectFlows
A list of MediaConnect Flows for this input.


name
String name
The user-assigned name (This is a mutable value).


roleArn
String roleArn
The Amazon Resource Name (ARN) of the role this input assumes during and after creation.


securityGroups
List<E> securityGroups
A list of IDs for all the Input Security Groups attached to the input.


sources
List<E> sources
A list of the sources of the input (PULL-type).


state
String state


tags
Map<K,V> tags
A collection of key-value pairs.


type
String type








Class com.amazonaws.services.medialive.model.DescribeInputSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputSecurityGroupId
String inputSecurityGroupId
The id of the Input Security Group to describe








Class com.amazonaws.services.medialive.model.DescribeInputSecurityGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
Unique ARN of Input Security Group


id
String id
The Id of the Input Security Group


inputs
List<E> inputs
The list of inputs currently using this Input Security Group.


state
String state
The current state of the Input Security Group.


tags
Map<K,V> tags
A collection of key-value pairs.


whitelistRules
List<E> whitelistRules
Whitelist rules and their sync status








Class com.amazonaws.services.medialive.model.DescribeMultiplexProgramRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


multiplexId
String multiplexId
The ID of the multiplex that the program belongs to.


programName
String programName
The name of the program.








Class com.amazonaws.services.medialive.model.DescribeMultiplexProgramResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channelId
String channelId
The MediaLive channel associated with the program.


multiplexProgramSettings
MultiplexProgramSettings multiplexProgramSettings
The settings for this multiplex program.


packetIdentifiersMap
MultiplexProgramPacketIdentifiersMap packetIdentifiersMap
The packet identifier map for this multiplex program.


programName
String programName
The name of the multiplex program.








Class com.amazonaws.services.medialive.model.DescribeMultiplexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


multiplexId
String multiplexId
The ID of the multiplex.








Class com.amazonaws.services.medialive.model.DescribeMultiplexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The unique arn of the multiplex.


availabilityZones
List<E> availabilityZones
A list of availability zones for the multiplex.


destinations
List<E> destinations
A list of the multiplex output destinations.


id
String id
The unique id of the multiplex.


multiplexSettings
MultiplexSettings multiplexSettings
Configuration for a multiplex event.


name
String name
The name of the multiplex.


pipelinesRunningCount
Integer pipelinesRunningCount
The number of currently healthy pipelines.


programCount
Integer programCount
The number of programs in the multiplex.


state
String state
The current state of the multiplex.


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.DescribeOfferingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


offeringId
String offeringId
Unique offering ID, e.g. '87654321'








Class com.amazonaws.services.medialive.model.DescribeOfferingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'


currencyCode
String currencyCode
Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'


duration
Integer duration
Lease duration, e.g. '12'


durationUnits
String durationUnits
Units for duration, e.g. 'MONTHS'


fixedPrice
Double fixedPrice
One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering


offeringDescription
String offeringDescription
Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'


offeringId
String offeringId
Unique offering ID, e.g. '87654321'


offeringType
String offeringType
Offering type, e.g. 'NO_UPFRONT'


region
String region
AWS region, e.g. 'us-west-2'


resourceSpecification
ReservationResourceSpecification resourceSpecification
Resource configuration details


usagePrice
Double usagePrice
Recurring usage charge for each reserved resource, e.g. '157.0'








Class com.amazonaws.services.medialive.model.DescribeReservationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


reservationId
String reservationId
Unique reservation ID, e.g. '1234567'








Class com.amazonaws.services.medialive.model.DescribeReservationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'


count
Integer count
Number of reserved resources


currencyCode
String currencyCode
Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'


duration
Integer duration
Lease duration, e.g. '12'


durationUnits
String durationUnits
Units for duration, e.g. 'MONTHS'


end
String end
Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'


fixedPrice
Double fixedPrice
One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering


name
String name
User specified reservation name


offeringDescription
String offeringDescription
Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'


offeringId
String offeringId
Unique offering ID, e.g. '87654321'


offeringType
String offeringType
Offering type, e.g. 'NO_UPFRONT'


region
String region
AWS region, e.g. 'us-west-2'


reservationId
String reservationId
Unique reservation ID, e.g. '1234567'


resourceSpecification
ReservationResourceSpecification resourceSpecification
Resource configuration details


start
String start
Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'


state
String state
Current state of reservation, e.g. 'ACTIVE'


tags
Map<K,V> tags
A collection of key-value pairs


usagePrice
Double usagePrice
Recurring usage charge for each reserved resource, e.g. '157.0'








Class com.amazonaws.services.medialive.model.DescribeScheduleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelId
String channelId
Id of the channel whose schedule is being updated.


maxResults
Integer maxResults


nextToken
String nextToken








Class com.amazonaws.services.medialive.model.DescribeScheduleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
The next token; for use in pagination.


scheduleActions
List<E> scheduleActions
The list of actions in the schedule.








Class com.amazonaws.services.medialive.model.DvbNitSettings extends Object implements Serializable


Serialized Fields


networkId
Integer networkId
The numeric value placed in the Network Information Table (NIT).


networkName
String networkName
The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is
 256 characters.


repInterval
Integer repInterval
The number of milliseconds between instances of this table in the output transport stream.








Class com.amazonaws.services.medialive.model.DvbSdtSettings extends Object implements Serializable


Serialized Fields


outputSdt
String outputSdt
Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from
 input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output
 stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The
 sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not
 contain SDT information.


repInterval
Integer repInterval
The number of milliseconds between instances of this table in the output transport stream.


serviceName
String serviceName
The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256
 characters.


serviceProviderName
String serviceProviderName
The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256
 characters.








Class com.amazonaws.services.medialive.model.DvbSubDestinationSettings extends Object implements Serializable


Serialized Fields


alignment
String alignment
If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the
 bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the
 output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified
 (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live
 subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or
 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font
 settings must match.


backgroundColor
String backgroundColor
Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.


backgroundOpacity
Integer backgroundOpacity
Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank
 is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.


font
InputLocation font
External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select
 output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid
 system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All
 burn-in and DVB-Sub font settings must match.


fontColor
String fontColor
Specifies the color of the burned-in captions. This option is not valid for source captions that are STL,
 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and
 DVB-Sub font settings must match.


fontOpacity
Integer fontOpacity
Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font
 settings must match.


fontResolution
Integer fontResolution
Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.


fontSize
String fontSize
When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify
 the exact font size in points. All burn-in and DVB-Sub font settings must match.


outlineColor
String outlineColor
Specifies font outline color. This option is not valid for source captions that are either 608/embedded or
 teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font
 settings must match.


outlineSize
Integer outlineSize
Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded
 or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font
 settings must match.


shadowColor
String shadowColor
Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.


shadowOpacity
Integer shadowOpacity
Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent
 to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.


shadowXOffset
Integer shadowXOffset
Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a
 shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.


shadowYOffset
Integer shadowYOffset
Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a
 shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.


teletextGridControl
String teletextGridControl
Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for
 Teletext inputs and DVB-Sub/Burn-in outputs.


xPosition
Integer xPosition
Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10
 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is
 provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid
 for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the
 caption stream. All burn-in and DVB-Sub font settings must match.


yPosition
Integer yPosition
Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would
 result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the
 caption will be positioned towards the bottom of the output. This option is not valid for source captions that are
 STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in
 and DVB-Sub font settings must match.








Class com.amazonaws.services.medialive.model.DvbSubSourceSettings extends Object implements Serializable


Serialized Fields


pid
Integer pid
When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough.
 All DVB-Sub content is passed through, regardless of selectors.








Class com.amazonaws.services.medialive.model.DvbTdtSettings extends Object implements Serializable


Serialized Fields


repInterval
Integer repInterval
The number of milliseconds between instances of this table in the output transport stream.








Class com.amazonaws.services.medialive.model.Eac3Settings extends Object implements Serializable


Serialized Fields


attenuationControl
String attenuationControl
When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.


bitrate
Double bitrate
Average bitrate in bits/second. Valid bitrates depend on the coding mode.


bitstreamMode
String bitstreamMode
Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background
 on these values.


codingMode
String codingMode
Dolby Digital Plus coding mode. Determines number of channels.


dcFilter
String dcFilter
When set to enabled, activates a DC highpass filter for all input channels.


dialnorm
Integer dialnorm
Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed
 through.


drcLine
String drcLine
Sets the Dolby dynamic range compression profile.


drcRf
String drcRf
Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not
 exceed specified levels.


lfeControl
String lfeControl
When encoding 3/2 audio, setting to lfe enables the LFE channel


lfeFilter
String lfeFilter
When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with
 codingMode32 coding mode.


loRoCenterMixLevel
Double loRoCenterMixLevel
Left only/Right only center mix level. Only used for 3/2 coding mode.


loRoSurroundMixLevel
Double loRoSurroundMixLevel
Left only/Right only surround mix level. Only used for 3/2 coding mode.


ltRtCenterMixLevel
Double ltRtCenterMixLevel
Left total/Right total center mix level. Only used for 3/2 coding mode.


ltRtSurroundMixLevel
Double ltRtSurroundMixLevel
Left total/Right total surround mix level. Only used for 3/2 coding mode.


metadataControl
String metadataControl
When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this
 audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.


passthroughControl
String passthroughControl
When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is
 dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a
 consistent DD+ output as the system alternates between passthrough and encoding.


phaseControl
String phaseControl
When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding
 mode.


stereoDownmix
String stereoDownmix
Stereo downmix preference. Only used for 3/2 coding mode.


surroundExMode
String surroundExMode
When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and
 right surround channels.


surroundMode
String surroundMode
When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.








Class com.amazonaws.services.medialive.model.EmbeddedDestinationSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.EmbeddedPlusScte20DestinationSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.EmbeddedSourceSettings extends Object implements Serializable


Serialized Fields


convert608To708
String convert608To708
If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well
 as translated into 708. 708 data present in the source content will be discarded.


scte20Detection
String scte20Detection
Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.


source608ChannelNumber
Integer source608ChannelNumber
Specifies the 608/708 channel number within the video track from which to extract captions. Unused for
 passthrough.


source608TrackNumber
Integer source608TrackNumber
This field is unused and deprecated.








Class com.amazonaws.services.medialive.model.EncoderSettings extends Object implements Serializable


Serialized Fields


audioDescriptions
List<E> audioDescriptions


availBlanking
AvailBlanking availBlanking
Settings for ad avail blanking.


availConfiguration
AvailConfiguration availConfiguration
Event-wide configuration settings for ad avail insertion.


blackoutSlate
BlackoutSlate blackoutSlate
Settings for blackout slate.


captionDescriptions
List<E> captionDescriptions
Settings for caption decriptions


globalConfiguration
GlobalConfiguration globalConfiguration
Configuration settings that apply to the event as a whole.


nielsenConfiguration
NielsenConfiguration nielsenConfiguration
Nielsen configuration settings.


outputGroups
List<E> outputGroups


timecodeConfig
TimecodeConfig timecodeConfig
Contains settings used to acquire and adjust timecode information from inputs.


videoDescriptions
List<E> videoDescriptions








Class com.amazonaws.services.medialive.model.FecOutputSettings extends Object implements Serializable


Serialized Fields


columnDepth
Integer columnDepth
Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets
 per column error correction packet. Must be between 4 and 20, inclusive.


includeFec
String includeFec
Enables column only or column and row based FEC


rowLength
Integer rowLength
Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If
 only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of
 transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if
 includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.








Class com.amazonaws.services.medialive.model.FixedModeScheduleActionStartSettings extends Object implements Serializable


Serialized Fields


time
String time
Start time for the action to start in the channel. (Not the time for the action to be added to the schedule:
 actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are
 digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format".








Class com.amazonaws.services.medialive.model.Fmp4HlsSettings extends Object implements Serializable


Serialized Fields


audioRenditionSets
String audioRenditionSets
List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are
 associated to the video, separate by ','.








Class com.amazonaws.services.medialive.model.FollowModeScheduleActionStartSettings extends Object implements Serializable


Serialized Fields


followPoint
String followPoint
Identifies whether this action starts relative to the start or relative to the end of the reference action.


referenceActionName
String referenceActionName
The action name of another action that this one refers to.








Class com.amazonaws.services.medialive.model.ForbiddenException extends AWSMediaLiveException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.medialive.model.FrameCaptureGroupSettings extends Object implements Serializable


Serialized Fields


destination
OutputLocationRef destination
The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name
 prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container,
 plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names
 consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5
 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg








Class com.amazonaws.services.medialive.model.FrameCaptureOutputSettings extends Object implements Serializable


Serialized Fields


nameModifier
String nameModifier
Required if the output group contains more than one output. This modifier forms part of the output file name.








Class com.amazonaws.services.medialive.model.FrameCaptureSettings extends Object implements Serializable


Serialized Fields


captureInterval
Integer captureInterval
The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or
 milliseconds, as specified by captureIntervalUnits.


captureIntervalUnits
String captureIntervalUnits
Unit for the frame capture interval.








Class com.amazonaws.services.medialive.model.GatewayTimeoutException extends AWSMediaLiveException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.medialive.model.GlobalConfiguration extends Object implements Serializable


Serialized Fields


initialAudioGain
Integer initialAudioGain
Value to set the initial audio gain for the Live Event.


inputEndAction
String inputEndAction
Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is
 configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder
 will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior"
 configuration until the next input switch occurs (which is controlled through the Channel Schedule API).


inputLossBehavior
InputLossBehavior inputLossBehavior
Settings for system actions when input is lost.


outputLockingMode
String outputLockingMode
Indicates how MediaLive pipelines are synchronized.
 
 PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING -
 MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch.


outputTimingSource
String outputTimingSource
Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which
 optionally may be locked to another source via NTP) or should be locked to the clock of the source that is
 providing the input stream.


supportLowFramerateInputs
String supportLowFramerateInputs
Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music
 channels with less than one video frame per second.








Class com.amazonaws.services.medialive.model.H264ColorSpaceSettings extends Object implements Serializable


Serialized Fields


colorSpacePassthroughSettings
ColorSpacePassthroughSettings colorSpacePassthroughSettings


rec601Settings
Rec601Settings rec601Settings


rec709Settings
Rec709Settings rec709Settings








Class com.amazonaws.services.medialive.model.H264Settings extends Object implements Serializable


Serialized Fields


adaptiveQuantization
String adaptiveQuantization
Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.


afdSignaling
String afdSignaling
Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try
 to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value
 will be the value configured in the fixedAfd parameter.


bitrate
Integer bitrate
Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS
 Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest
 multiple of 1000.


bufFillPct
Integer bufFillPct
Percentage of the buffer that should initially be filled (HRD buffer model).


bufSize
Integer bufSize
Size of buffer (HRD buffer model) in bits.


colorMetadata
String colorMetadata
Includes colorspace metadata in the output.


colorSpaceSettings
H264ColorSpaceSettings colorSpaceSettings
Color Space settings


entropyEncoding
String entropyEncoding
Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.


fixedAfd
String fixedAfd
Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to
 'Fixed'.


flickerAq
String flickerAq
If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.


framerateControl
String framerateControl
This field indicates how the output video frame rate is specified. If "specified" is selected then the output
 video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is
 selected then the output video frame rate will be set equal to the input video frame rate of the first input.


framerateDenominator
Integer framerateDenominator
Framerate denominator.


framerateNumerator
Integer framerateNumerator
Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.


gopBReference
String gopBReference
Documentation update needed


gopClosedCadence
Integer gopClosedCadence
Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining
 mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output
 segmenting.


gopNumBFrames
Integer gopNumBFrames
Number of B-frames between reference frames.


gopSize
Double gopSize
GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames,
 gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be
 greater than 0, but need not be an integer.


gopSizeUnits
String gopSizeUnits
Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a
 frame count at run time.


level
String level
H.264 Level.


lookAheadRateControl
String lookAheadRateControl
Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality
 for certain content.


maxBitrate
Integer maxBitrate
For QVBR: See the tooltip for Quality level
 
 For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.


minIInterval
Integer minIInterval
Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces
 separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change
 I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change
 I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the
 next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1


numRefFrames
Integer numRefFrames
Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced
 encoding.


parControl
String parControl
This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output
 video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is
 selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first
 input.


parDenominator
Integer parDenominator
Pixel Aspect Ratio denominator.


parNumerator
Integer parNumerator
Pixel Aspect Ratio numerator.


profile
String profile
H.264 Profile.


qvbrQualityLevel
Integer qvbrQualityLevel
Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for
 the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended
 values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max
 bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M


rateControlMode
String rateControlMode
Rate control mode.
 
 QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate.
 Recommended if you or your viewers pay for bandwidth.
 
 VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to
 maintain a specific average bitrate over the duration of the channel.
 
 CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices
 that cannot handle variable bitrates.
 
 Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a
 MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the
 Multiplex Program.


scanType
String scanType
Sets the scan type of the output to progressive or top-field-first interlaced.


sceneChangeDetect
String sceneChangeDetect
Scene change detection.
 
 - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is
 detected.


slices
Integer slices
Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive
 pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is
 optional; when no value is specified the encoder will choose the number of slices based on encode resolution.


softness
Integer softness
Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.


spatialAq
String spatialAq
If set to enabled, adjust quantization within each frame based on spatial variation of content complexity.


subgopLength
String subgopLength
If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used
 for each sub-GOP to improve visual quality.


syntax
String syntax
Produces a bitstream compliant with SMPTE RP-2027.


temporalAq
String temporalAq
If set to enabled, adjust quantization within each frame based on temporal variation of content complexity.


timecodeInsertion
String timecodeInsertion
Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include
 timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config








Class com.amazonaws.services.medialive.model.H265ColorSpaceSettings extends Object implements Serializable


Serialized Fields


colorSpacePassthroughSettings
ColorSpacePassthroughSettings colorSpacePassthroughSettings


hdr10Settings
Hdr10Settings hdr10Settings


rec601Settings
Rec601Settings rec601Settings


rec709Settings
Rec709Settings rec709Settings








Class com.amazonaws.services.medialive.model.H265Settings extends Object implements Serializable


Serialized Fields


adaptiveQuantization
String adaptiveQuantization
Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.


afdSignaling
String afdSignaling
Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try
 to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value
 will be the value configured in the fixedAfd parameter.


alternativeTransferFunction
String alternativeTransferFunction
Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility
 with non-HDR decoders and displays.


bitrate
Integer bitrate
Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS
 Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest
 multiple of 1000.


bufSize
Integer bufSize
Size of buffer (HRD buffer model) in bits.


colorMetadata
String colorMetadata
Includes colorspace metadata in the output.


colorSpaceSettings
H265ColorSpaceSettings colorSpaceSettings
Color Space settings


fixedAfd
String fixedAfd
Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to
 'Fixed'.


flickerAq
String flickerAq
If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.


framerateDenominator
Integer framerateDenominator
Framerate denominator.


framerateNumerator
Integer framerateNumerator
Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.


gopClosedCadence
Integer gopClosedCadence
Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining
 mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output
 segmenting.


gopSize
Double gopSize
GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames,
 gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be
 greater than 0, but need not be an integer.


gopSizeUnits
String gopSizeUnits
Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a
 frame count at run time.


level
String level
H.265 Level.


lookAheadRateControl
String lookAheadRateControl
Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality
 for certain content.


maxBitrate
Integer maxBitrate
For QVBR: See the tooltip for Quality level


minIInterval
Integer minIInterval
Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. Enforces
 separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change
 I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change
 I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the
 next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1


parDenominator
Integer parDenominator
Pixel Aspect Ratio denominator.


parNumerator
Integer parNumerator
Pixel Aspect Ratio numerator.


profile
String profile
H.265 Profile.


qvbrQualityLevel
Integer qvbrQualityLevel
Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for
 the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended
 values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max
 bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M


rateControlMode
String rateControlMode
Rate control mode.
 
 QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate.
 Recommended if you or your viewers pay for bandwidth.
 
 CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices
 that cannot handle variable bitrates.


scanType
String scanType
Sets the scan type of the output to progressive or top-field-first interlaced.


sceneChangeDetect
String sceneChangeDetect
Scene change detection.


slices
Integer slices
Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive
 pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is
 optional; when no value is specified the encoder will choose the number of slices based on encode resolution.


tier
String tier
H.265 Tier.


timecodeInsertion
String timecodeInsertion
Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include
 timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config








Class com.amazonaws.services.medialive.model.Hdr10Settings extends Object implements Serializable


Serialized Fields


maxCll
Integer maxCll
Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single
 pixel within an encoded HDR video stream or file.


maxFall
Integer maxFall
Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits,
 for any single frame within an encoded HDR video stream or file.








Class com.amazonaws.services.medialive.model.HlsAkamaiSettings extends Object implements Serializable


Serialized Fields


connectionRetryInterval
Integer connectionRetryInterval
Number of seconds to wait before retrying connection to the CDN if the connection is lost.


filecacheDuration
Integer filecacheDuration
Size in seconds of file cache for streaming outputs.


httpTransferMode
String httpTransferMode
Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this
 feature.


numRetries
Integer numRetries
Number of retry attempts that will be made before the Live Event is put into an error state.


restartDelay
Integer restartDelay
If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never
 restart.


salt
String salt
Salt for authenticated Akamai.


token
String token
Token parameter for authenticated akamai. If not specified, _gda_ is used.








Class com.amazonaws.services.medialive.model.HlsBasicPutSettings extends Object implements Serializable


Serialized Fields


connectionRetryInterval
Integer connectionRetryInterval
Number of seconds to wait before retrying connection to the CDN if the connection is lost.


filecacheDuration
Integer filecacheDuration
Size in seconds of file cache for streaming outputs.


numRetries
Integer numRetries
Number of retry attempts that will be made before the Live Event is put into an error state.


restartDelay
Integer restartDelay
If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never
 restart.








Class com.amazonaws.services.medialive.model.HlsCdnSettings extends Object implements Serializable


Serialized Fields


hlsAkamaiSettings
HlsAkamaiSettings hlsAkamaiSettings


hlsBasicPutSettings
HlsBasicPutSettings hlsBasicPutSettings


hlsMediaStoreSettings
HlsMediaStoreSettings hlsMediaStoreSettings


hlsWebdavSettings
HlsWebdavSettings hlsWebdavSettings








Class com.amazonaws.services.medialive.model.HlsGroupSettings extends Object implements Serializable


Serialized Fields


adMarkers
List<E> adMarkers
Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.


baseUrlContent
String baseUrlContent
A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest
 is delivered from a different URL than the main .m3u8 file.


baseUrlContent1
String baseUrlContent1
Optional. One value per output group.
 
 This field is required only if you are completing Base URL content A, and the downstream system has notified you
 that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline
 0.


baseUrlManifest
String baseUrlManifest
A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest
 is delivered from a different URL than the main .m3u8 file.


baseUrlManifest1
String baseUrlManifest1
Optional. One value per output group.
 
 Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you
 that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest
 files for pipeline 0.


captionLanguageMappings
List<E> captionLanguageMappings
Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to
 "insert".


captionLanguageSetting
String captionLanguageSetting
Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at
 least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you
 specify. Make sure to specify the languages in the order in which they appear in the original source (if the
 source is embedded format) or the order of the caption selectors (if the source is other than embedded).
 Otherwise, languages in the manifest will not match up properly with the output captions. none: Include
 CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest.


clientCache
String clientCache
When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving
 media segments for later replay.


codecSpecification
String codecSpecification
Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.


constantIv
String constantIv
For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If
 ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.


destination
OutputLocationRef destination
A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).


directoryStructure
String directoryStructure
Place segments in subdirectories.


encryptionType
String encryptionType
Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.


hlsCdnSettings
HlsCdnSettings hlsCdnSettings
Parameters that control interactions with the CDN.


hlsId3SegmentTagging
String hlsId3SegmentTagging
State of HLS ID3 Segment Tagging


iFrameOnlyPlaylists
String iFrameOnlyPlaylists
DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the
 Output Selection field).
 
 STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests
 (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate
 it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example,
 #EXT-X-BYTERANGE:160364@1461888"


indexNSegments
Integer indexNSegments
Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After
 this maximum, older segments are removed from the media manifest. This number must be less than or equal to the
 Keep Segments field.


inputLossAction
String inputLossAction
Parameter that control output group behavior on input loss.


ivInManifest
String ivInManifest
For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key
 for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the
 manifest.


ivSource
String ivSource
For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key
 for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment
 (to match the segment number). If this is set to "explicit", you must enter a constantIv value.


keepSegments
Integer keepSegments
Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the
 destination directory.


keyFormat
String keyFormat
The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an
 implicit value of "identity" is used. A reverse DNS string can also be given.


keyFormatVersions
String keyFormatVersions
Either a single positive integer version value or a slash delimited list of version values (1/2/3).


keyProviderSettings
KeyProviderSettings keyProviderSettings
The key provider settings.


manifestCompression
String manifestCompression
When set to gzip, compresses HLS playlist.


manifestDurationFormat
String manifestDurationFormat
Indicates whether the output manifest should use floating point or integer values for segment duration.


minSegmentLength
Integer minSegmentLength
When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby
 avail and extending the segment size if needed.


mode
String mode
If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the
 number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments,
 which may prevent players from rewinding all the way to the beginning of the event.
 
 VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type
 manifest on completion of the stream.


outputSelection
String outputSelection
MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output
 group.
 
 SEGMENTSONLY: Does not generate any manifests for this output group.


programDateTime
String programDateTime
Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows:
 either the program date and time are initialized using the input timecode source, or the time is initialized
 using the input timecode source and the date is initialized using the timestampOffset.


programDateTimePeriod
Integer programDateTimePeriod
Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.


redundantManifest
String redundantManifest
ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its
 own media files, then the media files of the other pipeline. This feature allows playout device that support
 stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale.
 There are still two destinations and two master manifests, but both master manifests reference the media files
 from both pipelines.
 
 DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only.
 
 For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed.
 MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant.


segmentLength
Integer segmentLength
Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next
 keyframe after this number of seconds, so actual segment length may be longer.


segmentationMode
String segmentationMode
useInputSegmentation has been deprecated. The configured segment size is always used.


segmentsPerSubdirectory
Integer segmentsPerSubdirectory
Number of segments to write to a subdirectory before starting a new one. directoryStructure must be
 subdirectoryPerStream for this setting to have an effect.


streamInfResolution
String streamInfResolution
Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.


timedMetadataId3Frame
String timedMetadataId3Frame
Indicates ID3 frame that has the timecode.


timedMetadataId3Period
Integer timedMetadataId3Period
Timed Metadata interval in seconds.


timestampDeltaMilliseconds
Integer timestampDeltaMilliseconds
Provides an extra millisecond delta offset to fine tune the timestamps.


tsFileMode
String tsFileMode
SEGMENTEDFILES: Emit the program as segments - multiple .ts media files.
 
 SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest
 includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the
 output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is
 running is not guaranteed due to HTTP server caching.








Class com.amazonaws.services.medialive.model.HlsId3SegmentTaggingScheduleActionSettings extends Object implements Serializable


Serialized Fields


tag
String tag
ID3 tag to insert into each segment. Supports special keyword identifiers to substitute in segment-related
 values.\nSupported keyword identifiers:
 https://docs.aws.amazon.com/medialive/latest/ug/variable-data-identifiers.html








Class com.amazonaws.services.medialive.model.HlsInputSettings extends Object implements Serializable


Serialized Fields


bandwidth
Integer bandwidth
When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen,
 otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second,
 as in an HLS manifest.


bufferSegments
Integer bufferSegments
When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written
 segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.


retries
Integer retries
The number of consecutive times that attempts to read a manifest or segment must fail before the input is
 considered unavailable.


retryInterval
Integer retryInterval
The number of seconds between retries when an attempt to read a manifest or segment fails.








Class com.amazonaws.services.medialive.model.HlsMediaStoreSettings extends Object implements Serializable


Serialized Fields


connectionRetryInterval
Integer connectionRetryInterval
Number of seconds to wait before retrying connection to the CDN if the connection is lost.


filecacheDuration
Integer filecacheDuration
Size in seconds of file cache for streaming outputs.


mediaStoreStorageClass
String mediaStoreStorageClass
When set to temporal, output files are stored in non-persistent memory for faster reading and writing.


numRetries
Integer numRetries
Number of retry attempts that will be made before the Live Event is put into an error state.


restartDelay
Integer restartDelay
If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never
 restart.








Class com.amazonaws.services.medialive.model.HlsOutputSettings extends Object implements Serializable


Serialized Fields


h265PackagingType
String h265PackagingType
Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should
 be packaged as HEV1 or HVC1.


hlsSettings
HlsSettings hlsSettings
Settings regarding the underlying stream. These settings are different for audio-only outputs.


nameModifier
String nameModifier
String concatenated to the end of the destination filename. Accepts \"Format
 Identifiers\":#formatIdentifierParameters.


segmentModifier
String segmentModifier
String concatenated to end of segment filenames.








Class com.amazonaws.services.medialive.model.HlsSettings extends Object implements Serializable


Serialized Fields


audioOnlyHlsSettings
AudioOnlyHlsSettings audioOnlyHlsSettings


fmp4HlsSettings
Fmp4HlsSettings fmp4HlsSettings


standardHlsSettings
StandardHlsSettings standardHlsSettings








Class com.amazonaws.services.medialive.model.HlsTimedMetadataScheduleActionSettings extends Object implements Serializable


Serialized Fields


id3
String id3
Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure








Class com.amazonaws.services.medialive.model.HlsWebdavSettings extends Object implements Serializable


Serialized Fields


connectionRetryInterval
Integer connectionRetryInterval
Number of seconds to wait before retrying connection to the CDN if the connection is lost.


filecacheDuration
Integer filecacheDuration
Size in seconds of file cache for streaming outputs.


httpTransferMode
String httpTransferMode
Specify whether or not to use chunked transfer encoding to WebDAV.


numRetries
Integer numRetries
Number of retry attempts that will be made before the Live Event is put into an error state.


restartDelay
Integer restartDelay
If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never
 restart.








Class com.amazonaws.services.medialive.model.ImmediateModeScheduleActionStartSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.Input extends Object implements Serializable


Serialized Fields


arn
String arn
The Unique ARN of the input (generated, immutable).


attachedChannels
List<E> attachedChannels
A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).


destinations
List<E> destinations
A list of the destinations of the input (PUSH-type).


id
String id
The generated ID of the input (unique for user account, immutable).


inputClass
String inputClass
STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both
 sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second
 source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source
 to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD,
 this value is not valid because the channel requires two sources in the input.


inputSourceType
String inputSourceType
Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes during
 input switch actions. Presently, this functionality only works with MP4_FILE inputs.


mediaConnectFlows
List<E> mediaConnectFlows
A list of MediaConnect Flows for this input.


name
String name
The user-assigned name (This is a mutable value).


roleArn
String roleArn
The Amazon Resource Name (ARN) of the role this input assumes during and after creation.


securityGroups
List<E> securityGroups
A list of IDs for all the Input Security Groups attached to the input.


sources
List<E> sources
A list of the sources of the input (PULL-type).


state
String state


tags
Map<K,V> tags
A collection of key-value pairs.


type
String type








Class com.amazonaws.services.medialive.model.InputAttachment extends Object implements Serializable


Serialized Fields


inputAttachmentName
String inputAttachmentName
User-specified name for the attachment. This is required if the user wants to use this input in an input switch
 action.


inputId
String inputId
The ID of the input


inputSettings
InputSettings inputSettings
Settings of an input (caption selector, etc.)








Class com.amazonaws.services.medialive.model.InputChannelLevel extends Object implements Serializable


Serialized Fields


gain
Integer gain
Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.


inputChannel
Integer inputChannel
The index of the input channel used as a source.








Class com.amazonaws.services.medialive.model.InputClippingSettings extends Object implements Serializable


Serialized Fields


inputTimecodeSource
String inputTimecodeSource
The source of the timecodes in the source being clipped.


startTimecode
StartTimecode startTimecode
Settings to identify the start of the clip.


stopTimecode
StopTimecode stopTimecode
Settings to identify the end of the clip.








Class com.amazonaws.services.medialive.model.InputDestination extends Object implements Serializable


Serialized Fields


ip
String ip
The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.


port
String port
The port number for the input.


url
String url
This represents the endpoint that the customer stream will be pushed to.


vpc
InputDestinationVpc vpc








Class com.amazonaws.services.medialive.model.InputDestinationRequest extends Object implements Serializable


Serialized Fields


streamName
String streamName
A unique name for the location the RTMP stream is being pushed to.








Class com.amazonaws.services.medialive.model.InputDestinationVpc extends Object implements Serializable


Serialized Fields


availabilityZone
String availabilityZone
The availability zone of the Input destination.


networkInterfaceId
String networkInterfaceId
The network interface ID of the Input destination in the VPC.








Class com.amazonaws.services.medialive.model.InputLocation extends Object implements Serializable


Serialized Fields


passwordParam
String passwordParam
key used to extract the password from EC2 Parameter store


uri
String uri
Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI)
 depending on the output type. For example, a RTMP destination should have a uri simliar to:
 "rtmp://fmsserver/live".


username
String username
Documentation update needed








Class com.amazonaws.services.medialive.model.InputLossBehavior extends Object implements Serializable


Serialized Fields


blackFrameMsec
Integer blackFrameMsec
Documentation update needed


inputLossImageColor
String inputLossImageColor
When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing
 the values of RGB.


inputLossImageSlate
InputLocation inputLossImageSlate
When input loss image type is "slate" these fields specify the parameters for accessing the slate.


inputLossImageType
String inputLossImageType
Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.


repeatFrameMsec
Integer repeatFrameMsec
Documentation update needed








Class com.amazonaws.services.medialive.model.InputSecurityGroup extends Object implements Serializable


Serialized Fields


arn
String arn
Unique ARN of Input Security Group


id
String id
The Id of the Input Security Group


inputs
List<E> inputs
The list of inputs currently using this Input Security Group.


state
String state
The current state of the Input Security Group.


tags
Map<K,V> tags
A collection of key-value pairs.


whitelistRules
List<E> whitelistRules
Whitelist rules and their sync status








Class com.amazonaws.services.medialive.model.InputSettings extends Object implements Serializable


Serialized Fields


audioSelectors
List<E> audioSelectors
Used to select the audio stream to decode for inputs that have multiple available.


captionSelectors
List<E> captionSelectors
Used to select the caption input to use for inputs that have multiple available.


deblockFilter
String deblockFilter
Enable or disable the deblock filter when filtering.


denoiseFilter
String denoiseFilter
Enable or disable the denoise filter when filtering.


filterStrength
Integer filterStrength
Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).


inputFilter
String inputFilter
Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto -
 filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input
 3) forced - filtering will be applied regardless of input type


networkInputSettings
NetworkInputSettings networkInputSettings
Input settings.


sourceEndBehavior
String sourceEndBehavior
Loop input if it is a file. This allows a file input to be streamed indefinitely.


videoSelector
VideoSelector videoSelector
Informs which video elementary stream to decode for input types that have multiple available.








Class com.amazonaws.services.medialive.model.InputSource extends Object implements Serializable


Serialized Fields


passwordParam
String passwordParam
The key used to extract the password from EC2 Parameter store.


url
String url
This represents the customer's source URL where stream is pulled from.


username
String username
The username for the input source.








Class com.amazonaws.services.medialive.model.InputSourceRequest extends Object implements Serializable


Serialized Fields


passwordParam
String passwordParam
The key used to extract the password from EC2 Parameter store.


url
String url
This represents the customer's source URL where stream is pulled from.


username
String username
The username for the input source.








Class com.amazonaws.services.medialive.model.InputSpecification extends Object implements Serializable


Serialized Fields


codec
String codec
Input codec


maximumBitrate
String maximumBitrate
Maximum input bitrate, categorized coarsely


resolution
String resolution
Input resolution, categorized coarsely








Class com.amazonaws.services.medialive.model.InputSwitchScheduleActionSettings extends Object implements Serializable


Serialized Fields


inputAttachmentNameReference
String inputAttachmentNameReference
The name of the input attachment (not the name of the input!) to switch to. The name is specified in the channel
 configuration.


inputClippingSettings
InputClippingSettings inputClippingSettings
Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the
 file.


urlPath
List<E> urlPath
The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time
 you use the same dynamic input in an input switch action, you can provide a different value, in order to connect
 the input to a different content source.








Class com.amazonaws.services.medialive.model.InputVpcRequest extends Object implements Serializable


Serialized Fields


securityGroupIds
List<E> securityGroupIds
A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces. Requires subnetIds.
 If none are specified then the VPC default security group will be used.


subnetIds
List<E> subnetIds
A list of 2 VPC subnet IDs from the same VPC. Subnet IDs must be mapped to two unique availability zones (AZ).








Class com.amazonaws.services.medialive.model.InputWhitelistRule extends Object implements Serializable


Serialized Fields


cidr
String cidr
The IPv4 CIDR that's whitelisted.








Class com.amazonaws.services.medialive.model.InputWhitelistRuleCidr extends Object implements Serializable


Serialized Fields


cidr
String cidr
The IPv4 CIDR to whitelist.








Class com.amazonaws.services.medialive.model.InternalServerErrorException extends AWSMediaLiveException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.medialive.model.KeyProviderSettings extends Object implements Serializable


Serialized Fields


staticKeySettings
StaticKeySettings staticKeySettings








Class com.amazonaws.services.medialive.model.ListChannelsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults


nextToken
String nextToken








Class com.amazonaws.services.medialive.model.ListChannelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channels
List<E> channels


nextToken
String nextToken








Class com.amazonaws.services.medialive.model.ListInputSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults


nextToken
String nextToken








Class com.amazonaws.services.medialive.model.ListInputSecurityGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


inputSecurityGroups
List<E> inputSecurityGroups
List of input security groups


nextToken
String nextToken








Class com.amazonaws.services.medialive.model.ListInputsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults


nextToken
String nextToken








Class com.amazonaws.services.medialive.model.ListInputsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


inputs
List<E> inputs


nextToken
String nextToken








Class com.amazonaws.services.medialive.model.ListMultiplexesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults
The maximum number of items to return.


nextToken
String nextToken
The token to retrieve the next page of results.








Class com.amazonaws.services.medialive.model.ListMultiplexesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


multiplexes
List<E> multiplexes
List of multiplexes.


nextToken
String nextToken
Token for the next ListMultiplexes request.








Class com.amazonaws.services.medialive.model.ListMultiplexProgramsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults
The maximum number of items to return.


multiplexId
String multiplexId
The ID of the multiplex that the programs belong to.


nextToken
String nextToken
The token to retrieve the next page of results.








Class com.amazonaws.services.medialive.model.ListMultiplexProgramsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


multiplexPrograms
List<E> multiplexPrograms
List of multiplex programs.


nextToken
String nextToken
Token for the next ListMultiplexProgram request.








Class com.amazonaws.services.medialive.model.ListOfferingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelClass
String channelClass
Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'


channelConfiguration
String channelConfiguration
Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)


codec
String codec
Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'


duration
String duration
Filter by offering duration, e.g. '12'


maxResults
Integer maxResults


maximumBitrate
String maximumBitrate
Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'


maximumFramerate
String maximumFramerate
Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'


nextToken
String nextToken


resolution
String resolution
Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'


resourceType
String resourceType
Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'


specialFeature
String specialFeature
Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'


videoQuality
String videoQuality
Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'








Class com.amazonaws.services.medialive.model.ListOfferingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
Token to retrieve the next page of results


offerings
List<E> offerings
List of offerings








Class com.amazonaws.services.medialive.model.ListReservationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelClass
String channelClass
Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'


codec
String codec
Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'


maxResults
Integer maxResults


maximumBitrate
String maximumBitrate
Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'


maximumFramerate
String maximumFramerate
Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'


nextToken
String nextToken


resolution
String resolution
Filter by resolution, 'SD', 'HD', 'FHD', or 'UHD'


resourceType
String resourceType
Filter by resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'


specialFeature
String specialFeature
Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'


videoQuality
String videoQuality
Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'








Class com.amazonaws.services.medialive.model.ListReservationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
Token to retrieve the next page of results


reservations
List<E> reservations
List of reservations








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


Serialized Fields


resourceArn
String resourceArn








Class com.amazonaws.services.medialive.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags








Class com.amazonaws.services.medialive.model.M2tsSettings extends Object implements Serializable


Serialized Fields


absentInputAudioBehavior
String absentInputAudioBehavior
When set to drop, output audio streams will be removed from the program if the selected input audio stream is
 removed from the input. This allows the output audio configuration to dynamically change based on input
 configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not
 connected to an active input stream.


arib
String arib
When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.


aribCaptionsPid
String aribCaptionsPid
Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal
 value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).


aribCaptionsPidControl
String aribCaptionsPidControl
If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to
 useConfigured, ARIB Captions will be on the configured pid number.


audioBufferModel
String audioBufferModel
When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.


audioFramesPerPes
Integer audioFramesPerPes
The number of audio frames to insert for each PES packet.


audioPids
String audioPids
Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted,
 and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each
 PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).


audioStreamType
String audioStreamType
When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream
 type = 0x06.


bitrate
Integer bitrate
The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically
 determine the appropriate bitrate.


bufferModel
String bufferModel
If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can
 lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.


ccDescriptor
String ccDescriptor
When set to enabled, generates captionServiceDescriptor in PMT.


dvbNitSettings
DvbNitSettings dvbNitSettings
Inserts DVB Network Information Table (NIT) at the specified table repetition interval.


dvbSdtSettings
DvbSdtSettings dvbSdtSettings
Inserts DVB Service Description Table (SDT) at the specified table repetition interval.


dvbSubPids
String dvbSubPids
Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can
 be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID
 specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).


dvbTdtSettings
DvbTdtSettings dvbTdtSettings
Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.


dvbTeletextPid
String dvbTeletextPid
Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or
 hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).


ebif
String ebif
If set to passthrough, passes any EBIF data from the input source to this output.


ebpAudioInterval
String ebpAudioInterval
When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval
 between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval.
 Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the
 video interval.


ebpLookaheadMs
Integer ebpLookaheadMs
When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by
 looking ahead at input video. If another EBP is going to come in within the specified time interval, the current
 EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to
 the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead
 accurate.


ebpPlacement
String ebpPlacement
Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID
 and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID.


ecmPid
String ecmPid
This field is unused and deprecated.


esRateInPes
String esRateInPes
Include or exclude the ES Rate field in the PES header.


etvPlatformPid
String etvPlatformPid
Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or
 hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).


etvSignalPid
String etvSignalPid
Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or
 hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).


fragmentTime
Double fragmentTime
The length in seconds of each fragment. Only used with EBP markers.


klv
String klv
If set to passthrough, passes any KLV data from the input source to this output.


klvDataPids
String klvDataPids
Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be
 entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified
 must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).


nielsenId3Behavior
String nielsenId3Behavior
If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an
 equivalent ID3 tag will be inserted in the output.


nullPacketBitrate
Double nullPacketBitrate
Value in bits per second of extra null packets to insert into the transport stream. This can be used if a
 downstream encryption system requires periodic null packets.


patInterval
Integer patInterval
The number of milliseconds between instances of this table in the output transport stream. Valid values are 0,
 10..1000.


pcrControl
String pcrControl
When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream
 (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary
 stream.


pcrPeriod
Integer pcrPeriod
Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.


pcrPid
String pcrPid
Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the
 encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid
 values are 32 (or 0x20)..8182 (or 0x1ff6).


pmtInterval
Integer pmtInterval
The number of milliseconds between instances of this table in the output transport stream. Valid values are 0,
 10..1000.


pmtPid
String pmtPid
Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or
 hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).


programNum
Integer programNum
The value of the program number field in the Program Map Table.


rateMode
String rateMode
When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts
 as the maximum bitrate when vbr is set.


scte27Pids
String scte27Pids
Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be
 entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified
 must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).


scte35Control
String scte35Control
Optionally pass SCTE-35 signals from the input source to this output.


scte35Pid
String scte35Pid
Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal
 value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).


segmentationMarkers
String segmentationMarkers
Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in
 the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes.
 psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to
 the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point
 information to the adaptation field using a legacy proprietary format.


segmentationStyle
String segmentationStyle
The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With
 avails, it is possible that segments may be truncated, which can influence where future segmentation markers are
 inserted.
 
 When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset
 the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds.
 
 When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will
 not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However,
 all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight
 exception to this rule.


segmentationTime
Double segmentationTime
The length in seconds of each segment. Required unless markers is set to None_.


timedMetadataBehavior
String timedMetadataBehavior
When set to passthrough, timed metadata will be passed through from input to output.


timedMetadataPid
String timedMetadataPid
Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or
 hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).


transportStreamId
Integer transportStreamId
The value of the transport stream ID field in the Program Map Table.


videoPid
String videoPid
Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or
 hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).








Class com.amazonaws.services.medialive.model.M3u8Settings extends Object implements Serializable


Serialized Fields


audioFramesPerPes
Integer audioFramesPerPes
The number of audio frames to insert for each PES packet.


audioPids
String audioPids
Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted,
 and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.


ecmPid
String ecmPid
This parameter is unused and deprecated.


nielsenId3Behavior
String nielsenId3Behavior
If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an
 equivalent ID3 tag will be inserted in the output.


patInterval
Integer patInterval
The number of milliseconds between instances of this table in the output transport stream. A value of \"0\"
 writes out the PMT once per segment file.


pcrControl
String pcrControl
When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream
 (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary
 stream.


pcrPeriod
Integer pcrPeriod
Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.


pcrPid
String pcrPid
Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the
 encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.


pmtInterval
Integer pmtInterval
The number of milliseconds between instances of this table in the output transport stream. A value of \"0\"
 writes out the PMT once per segment file.


pmtPid
String pmtPid
Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or
 hexadecimal value.


programNum
Integer programNum
The value of the program number field in the Program Map Table.


scte35Behavior
String scte35Behavior
If set to passthrough, passes any SCTE-35 signals from the input source to this output.


scte35Pid
String scte35Pid
Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal
 value.


timedMetadataBehavior
String timedMetadataBehavior
When set to passthrough, timed metadata is passed through from input to output.


timedMetadataPid
String timedMetadataPid
Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or
 hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).


transportStreamId
Integer transportStreamId
The value of the transport stream ID field in the Program Map Table.


videoPid
String videoPid
Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or
 hexadecimal value.








Class com.amazonaws.services.medialive.model.MediaConnectFlow extends Object implements Serializable


Serialized Fields


flowArn
String flowArn
The unique ARN of the MediaConnect Flow being used as a source.








Class com.amazonaws.services.medialive.model.MediaConnectFlowRequest extends Object implements Serializable


Serialized Fields


flowArn
String flowArn
The ARN of the MediaConnect Flow that you want to use as a source.








Class com.amazonaws.services.medialive.model.MediaPackageGroupSettings extends Object implements Serializable


Serialized Fields


destination
OutputLocationRef destination
MediaPackage channel destination.








Class com.amazonaws.services.medialive.model.MediaPackageOutputDestinationSettings extends Object implements Serializable


Serialized Fields


channelId
String channelId
ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the
 individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two
 MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.








Class com.amazonaws.services.medialive.model.MediaPackageOutputSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.Mp2Settings extends Object implements Serializable


Serialized Fields


bitrate
Double bitrate
Average bitrate in bits/second.


codingMode
String codingMode
The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).


sampleRate
Double sampleRate
Sample rate in Hz.








Class com.amazonaws.services.medialive.model.MsSmoothGroupSettings extends Object implements Serializable


Serialized Fields


acquisitionPointId
String acquisitionPointId
The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only
 enabled if sparseTrackType is not "none".


audioOnlyTimecodeControl
String audioOnlyTimecodeControl
If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current
 timecode. This option does not write timecodes to the audio elementary stream.


certificateMode
String certificateMode
If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This
 will cause https outputs to self-signed certificates to fail.


connectionRetryInterval
Integer connectionRetryInterval
Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be
 cached during this time and the cache will be be delivered to the IIS server once the connection is
 re-established.


destination
OutputLocationRef destination
Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.


eventId
String eventId
MS Smooth event ID to be sent to the IIS server.
 
 Should only be specified if eventIdMode is set to useConfigured.


eventIdMode
String eventIdMode
Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is
 used without changing the publishing point, clients might see cached video from the previous run.
 
 Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID
 based on the current timestamp - "noEventId" - do not send an event ID to the IIS server.


eventStopBehavior
String eventStopBehavior
When set to sendEos, send EOS signal to IIS server when stopping the event


filecacheDuration
Integer filecacheDuration
Size in seconds of file cache for streaming outputs.


fragmentLength
Integer fragmentLength
Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.


inputLossAction
String inputLossAction
Parameter that control output group behavior on input loss.


numRetries
Integer numRetries
Number of retry attempts.


restartDelay
Integer restartDelay
Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one
 segment, or exceeding filecacheDuration.


segmentationMode
String segmentationMode
useInputSegmentation has been deprecated. The configured segment size is always used.


sendDelayMs
Integer sendDelayMs
Number of milliseconds to delay the output from the second pipeline.


sparseTrackType
String sparseTrackType
If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs.


streamManifestBehavior
String streamManifestBehavior
When set to send, send stream manifest so publishing point doesn't start until all streams start.


timestampOffset
String timestampOffset
Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.


timestampOffsetMode
String timestampOffsetMode
Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset -
 useConfiguredOffset: Use an explicitly configured date as the offset








Class com.amazonaws.services.medialive.model.MsSmoothOutputSettings extends Object implements Serializable


Serialized Fields


h265PackagingType
String h265PackagingType
Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should
 be packaged as HEV1 or HVC1.


nameModifier
String nameModifier
String concatenated to the end of the destination filename. Required for multiple outputs of the same type.








Class com.amazonaws.services.medialive.model.Multiplex extends Object implements Serializable


Serialized Fields


arn
String arn
The unique arn of the multiplex.


availabilityZones
List<E> availabilityZones
A list of availability zones for the multiplex.


destinations
List<E> destinations
A list of the multiplex output destinations.


id
String id
The unique id of the multiplex.


multiplexSettings
MultiplexSettings multiplexSettings
Configuration for a multiplex event.


name
String name
The name of the multiplex.


pipelinesRunningCount
Integer pipelinesRunningCount
The number of currently healthy pipelines.


programCount
Integer programCount
The number of programs in the multiplex.


state
String state
The current state of the multiplex.


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.MultiplexGroupSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.MultiplexMediaConnectOutputDestinationSettings extends Object implements Serializable


Serialized Fields


entitlementArn
String entitlementArn
The MediaConnect entitlement ARN available as a Flow source.








Class com.amazonaws.services.medialive.model.MultiplexOutputDestination extends Object implements Serializable


Serialized Fields


mediaConnectSettings
MultiplexMediaConnectOutputDestinationSettings mediaConnectSettings
Multiplex MediaConnect output destination settings.








Class com.amazonaws.services.medialive.model.MultiplexOutputSettings extends Object implements Serializable


Serialized Fields


destination
OutputLocationRef destination
Destination is a Multiplex.








Class com.amazonaws.services.medialive.model.MultiplexProgram extends Object implements Serializable


Serialized Fields


channelId
String channelId
The MediaLive channel associated with the program.


multiplexProgramSettings
MultiplexProgramSettings multiplexProgramSettings
The settings for this multiplex program.


packetIdentifiersMap
MultiplexProgramPacketIdentifiersMap packetIdentifiersMap
The packet identifier map for this multiplex program.


programName
String programName
The name of the multiplex program.








Class com.amazonaws.services.medialive.model.MultiplexProgramChannelDestinationSettings extends Object implements Serializable


Serialized Fields


multiplexId
String multiplexId
The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs
 to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex
 instances. The Multiplex must be in the same region as the Channel.


programName
String programName
The program name of the Multiplex program that the encoder is providing output to.








Class com.amazonaws.services.medialive.model.MultiplexProgramPacketIdentifiersMap extends Object implements Serializable


Serialized Fields


audioPids
List<E> audioPids


dvbSubPids
List<E> dvbSubPids


dvbTeletextPid
Integer dvbTeletextPid


etvPlatformPid
Integer etvPlatformPid


etvSignalPid
Integer etvSignalPid


klvDataPids
List<E> klvDataPids


pcrPid
Integer pcrPid


pmtPid
Integer pmtPid


privateMetadataPid
Integer privateMetadataPid


scte27Pids
List<E> scte27Pids


scte35Pid
Integer scte35Pid


timedMetadataPid
Integer timedMetadataPid


videoPid
Integer videoPid








Class com.amazonaws.services.medialive.model.MultiplexProgramServiceDescriptor extends Object implements Serializable


Serialized Fields


providerName
String providerName
Name of the provider.


serviceName
String serviceName
Name of the service.








Class com.amazonaws.services.medialive.model.MultiplexProgramSettings extends Object implements Serializable


Serialized Fields


programNumber
Integer programNumber
Unique program number.


serviceDescriptor
MultiplexProgramServiceDescriptor serviceDescriptor
Transport stream service descriptor configuration for the Multiplex program.


videoSettings
MultiplexVideoSettings videoSettings
Program video settings configuration.








Class com.amazonaws.services.medialive.model.MultiplexProgramSummary extends Object implements Serializable


Serialized Fields


channelId
String channelId
The MediaLive Channel associated with the program.


programName
String programName
The name of the multiplex program.








Class com.amazonaws.services.medialive.model.MultiplexSettings extends Object implements Serializable


Serialized Fields


maximumVideoBufferDelayMilliseconds
Integer maximumVideoBufferDelayMilliseconds
Maximum video buffer delay in milliseconds.


transportStreamBitrate
Integer transportStreamBitrate
Transport stream bit rate.


transportStreamId
Integer transportStreamId
Transport stream ID.


transportStreamReservedBitrate
Integer transportStreamReservedBitrate
Transport stream reserved bit rate.








Class com.amazonaws.services.medialive.model.MultiplexSettingsSummary extends Object implements Serializable


Serialized Fields


transportStreamBitrate
Integer transportStreamBitrate
Transport stream bit rate.








Class com.amazonaws.services.medialive.model.MultiplexStatmuxVideoSettings extends Object implements Serializable


Serialized Fields


maximumBitrate
Integer maximumBitrate
Maximum statmux bitrate.


minimumBitrate
Integer minimumBitrate
Minimum statmux bitrate.








Class com.amazonaws.services.medialive.model.MultiplexSummary extends Object implements Serializable


Serialized Fields


arn
String arn
The unique arn of the multiplex.


availabilityZones
List<E> availabilityZones
A list of availability zones for the multiplex.


id
String id
The unique id of the multiplex.


multiplexSettings
MultiplexSettingsSummary multiplexSettings
Configuration for a multiplex event.


name
String name
The name of the multiplex.


pipelinesRunningCount
Integer pipelinesRunningCount
The number of currently healthy pipelines.


programCount
Integer programCount
The number of programs in the multiplex.


state
String state
The current state of the multiplex.


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.MultiplexVideoSettings extends Object implements Serializable


Serialized Fields


constantBitrate
Integer constantBitrate
The constant bitrate configuration for the video encode. When this field is defined, StatmuxSettings must be
 undefined.


statmuxSettings
MultiplexStatmuxVideoSettings statmuxSettings
Statmux rate control settings. When this field is defined, ConstantBitrate must be undefined.








Class com.amazonaws.services.medialive.model.NetworkInputSettings extends Object implements Serializable


Serialized Fields


hlsInputSettings
HlsInputSettings hlsInputSettings
Specifies HLS input settings when the uri is for a HLS manifest.


serverValidation
String serverValidation
Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be
 checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do
 not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error.
 This setting is ignored for protocols that do not use https.








Class com.amazonaws.services.medialive.model.NielsenConfiguration extends Object implements Serializable


Serialized Fields


distributorId
String distributorId
Enter the Distributor ID assigned to your organization by Nielsen.


nielsenPcmToId3Tagging
String nielsenPcmToId3Tagging
Enables Nielsen PCM to ID3 tagging








Class com.amazonaws.services.medialive.model.NotFoundException extends AWSMediaLiveException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.medialive.model.Offering extends Object implements Serializable


Serialized Fields


arn
String arn
Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'


currencyCode
String currencyCode
Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'


duration
Integer duration
Lease duration, e.g. '12'


durationUnits
String durationUnits
Units for duration, e.g. 'MONTHS'


fixedPrice
Double fixedPrice
One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering


offeringDescription
String offeringDescription
Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'


offeringId
String offeringId
Unique offering ID, e.g. '87654321'


offeringType
String offeringType
Offering type, e.g. 'NO_UPFRONT'


region
String region
AWS region, e.g. 'us-west-2'


resourceSpecification
ReservationResourceSpecification resourceSpecification
Resource configuration details


usagePrice
Double usagePrice
Recurring usage charge for each reserved resource, e.g. '157.0'








Class com.amazonaws.services.medialive.model.Output extends Object implements Serializable


Serialized Fields


audioDescriptionNames
List<E> audioDescriptionNames
The names of the AudioDescriptions used as audio sources for this output.


captionDescriptionNames
List<E> captionDescriptionNames
The names of the CaptionDescriptions used as caption sources for this output.


outputName
String outputName
The name used to identify an output.


outputSettings
OutputSettings outputSettings
Output type-specific settings.


videoDescriptionName
String videoDescriptionName
The name of the VideoDescription used as the source for this output.








Class com.amazonaws.services.medialive.model.OutputDestination extends Object implements Serializable


Serialized Fields


id
String id
User-specified id. This is used in an output group or an output.


mediaPackageSettings
List<E> mediaPackageSettings
Destination settings for a MediaPackage output; one destination for both encoders.


multiplexSettings
MultiplexProgramChannelDestinationSettings multiplexSettings
Destination settings for a Multiplex output; one destination for both encoders.


settings
List<E> settings
Destination settings for a standard output; one destination for each redundant encoder.








Class com.amazonaws.services.medialive.model.OutputDestinationSettings extends Object implements Serializable


Serialized Fields


passwordParam
String passwordParam
key used to extract the password from EC2 Parameter store


streamName
String streamName
Stream name for RTMP destinations (URLs of type rtmp://)


url
String url
A URL specifying a destination


username
String username
username for destination








Class com.amazonaws.services.medialive.model.OutputGroup extends Object implements Serializable


Serialized Fields


name
String name
Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character
 allowed; only 32 characters allowed.


outputGroupSettings
OutputGroupSettings outputGroupSettings
Settings associated with the output group.


outputs
List<E> outputs








Class com.amazonaws.services.medialive.model.OutputGroupSettings extends Object implements Serializable


Serialized Fields


archiveGroupSettings
ArchiveGroupSettings archiveGroupSettings


frameCaptureGroupSettings
FrameCaptureGroupSettings frameCaptureGroupSettings


hlsGroupSettings
HlsGroupSettings hlsGroupSettings


mediaPackageGroupSettings
MediaPackageGroupSettings mediaPackageGroupSettings


msSmoothGroupSettings
MsSmoothGroupSettings msSmoothGroupSettings


multiplexGroupSettings
MultiplexGroupSettings multiplexGroupSettings


rtmpGroupSettings
RtmpGroupSettings rtmpGroupSettings


udpGroupSettings
UdpGroupSettings udpGroupSettings








Class com.amazonaws.services.medialive.model.OutputLocationRef extends Object implements Serializable


Serialized Fields


destinationRefId
String destinationRefId








Class com.amazonaws.services.medialive.model.OutputSettings extends Object implements Serializable


Serialized Fields


archiveOutputSettings
ArchiveOutputSettings archiveOutputSettings


frameCaptureOutputSettings
FrameCaptureOutputSettings frameCaptureOutputSettings


hlsOutputSettings
HlsOutputSettings hlsOutputSettings


mediaPackageOutputSettings
MediaPackageOutputSettings mediaPackageOutputSettings


msSmoothOutputSettings
MsSmoothOutputSettings msSmoothOutputSettings


multiplexOutputSettings
MultiplexOutputSettings multiplexOutputSettings


rtmpOutputSettings
RtmpOutputSettings rtmpOutputSettings


udpOutputSettings
UdpOutputSettings udpOutputSettings








Class com.amazonaws.services.medialive.model.PassThroughSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.PauseStateScheduleActionSettings extends Object implements Serializable


Serialized Fields


pipelines
List<E> pipelines








Class com.amazonaws.services.medialive.model.PipelineDetail extends Object implements Serializable


Serialized Fields


activeInputAttachmentName
String activeInputAttachmentName
The name of the active input attachment currently being ingested by this pipeline.


activeInputSwitchActionName
String activeInputSwitchActionName
The name of the input switch schedule action that occurred most recently and that resulted in the switch to the
 current input attachment for this pipeline.


pipelineId
String pipelineId
Pipeline ID








Class com.amazonaws.services.medialive.model.PipelinePauseStateSettings extends Object implements Serializable


Serialized Fields


pipelineId
String pipelineId
Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1").








Class com.amazonaws.services.medialive.model.PurchaseOfferingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


count
Integer count
Number of resources


name
String name
Name for the new reservation


offeringId
String offeringId
Offering to purchase, e.g. '87654321'


requestId
String requestId
Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.


start
String start
Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of
 the current month and one year from now. If no value is given, the default is now.


tags
Map<K,V> tags
A collection of key-value pairs








Class com.amazonaws.services.medialive.model.PurchaseOfferingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservation
Reservation reservation








Class com.amazonaws.services.medialive.model.Rec601Settings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.Rec709Settings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.RemixSettings extends Object implements Serializable


Serialized Fields


channelMappings
List<E> channelMappings
Mapping of input channels to output channels, with appropriate gain adjustments.


channelsIn
Integer channelsIn
Number of input channels to be used.


channelsOut
Integer channelsOut
Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8








Class com.amazonaws.services.medialive.model.Reservation extends Object implements Serializable


Serialized Fields


arn
String arn
Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'


count
Integer count
Number of reserved resources


currencyCode
String currencyCode
Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'


duration
Integer duration
Lease duration, e.g. '12'


durationUnits
String durationUnits
Units for duration, e.g. 'MONTHS'


end
String end
Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'


fixedPrice
Double fixedPrice
One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering


name
String name
User specified reservation name


offeringDescription
String offeringDescription
Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'


offeringId
String offeringId
Unique offering ID, e.g. '87654321'


offeringType
String offeringType
Offering type, e.g. 'NO_UPFRONT'


region
String region
AWS region, e.g. 'us-west-2'


reservationId
String reservationId
Unique reservation ID, e.g. '1234567'


resourceSpecification
ReservationResourceSpecification resourceSpecification
Resource configuration details


start
String start
Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'


state
String state
Current state of reservation, e.g. 'ACTIVE'


tags
Map<K,V> tags
A collection of key-value pairs


usagePrice
Double usagePrice
Recurring usage charge for each reserved resource, e.g. '157.0'








Class com.amazonaws.services.medialive.model.ReservationResourceSpecification extends Object implements Serializable


Serialized Fields


channelClass
String channelClass
Channel class, e.g. 'STANDARD'


codec
String codec
Codec, e.g. 'AVC'


maximumBitrate
String maximumBitrate
Maximum bitrate, e.g. 'MAX_20_MBPS'


maximumFramerate
String maximumFramerate
Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)


resolution
String resolution
Resolution, e.g. 'HD'


resourceType
String resourceType
Resource type, 'INPUT', 'OUTPUT', 'MULTIPLEX', or 'CHANNEL'


specialFeature
String specialFeature
Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)


videoQuality
String videoQuality
Video quality, e.g. 'STANDARD' (Outputs only)








Class com.amazonaws.services.medialive.model.RtmpCaptionInfoDestinationSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.RtmpGroupSettings extends Object implements Serializable


Serialized Fields


authenticationScheme
String authenticationScheme
Authentication scheme to use when connecting with CDN


cacheFullBehavior
String cacheFullBehavior
Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not
 accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by
 cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force
 a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP
 output will wait up to 5 minutes to allow the origin server to begin accepting data again.


cacheLength
Integer cacheLength
Cache length, in seconds, is used to calculate buffer size.


captionData
String captionData
Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC
 data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both
 fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed.


inputLossAction
String inputLossAction
Controls the behavior of this RTMP group if input becomes unavailable.
 
 - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This
 does not close the underlying RTMP connection.


restartDelay
Integer restartDelay
If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never
 restart.








Class com.amazonaws.services.medialive.model.RtmpOutputSettings extends Object implements Serializable


Serialized Fields


certificateMode
String certificateMode
If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will
 cause rtmps outputs with self-signed certificates to fail.


connectionRetryInterval
Integer connectionRetryInterval
Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.


destination
OutputLocationRef destination
The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and
 password must be supplied. URI fields accept format identifiers.


numRetries
Integer numRetries
Number of retry attempts.








Class com.amazonaws.services.medialive.model.ScheduleAction extends Object implements Serializable


Serialized Fields


actionName
String actionName
The name of the action, must be unique within the schedule. This name provides the main reference to an action
 once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is
 automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that
 point a name can be reused.


scheduleActionSettings
ScheduleActionSettings scheduleActionSettings
Settings for this schedule action.


scheduleActionStartSettings
ScheduleActionStartSettings scheduleActionStartSettings
The time for the action to start in the channel.








Class com.amazonaws.services.medialive.model.ScheduleActionSettings extends Object implements Serializable


Serialized Fields


hlsId3SegmentTaggingSettings
HlsId3SegmentTaggingScheduleActionSettings hlsId3SegmentTaggingSettings
Action to insert HLS ID3 segment tagging


hlsTimedMetadataSettings
HlsTimedMetadataScheduleActionSettings hlsTimedMetadataSettings
Action to insert HLS metadata


inputSwitchSettings
InputSwitchScheduleActionSettings inputSwitchSettings
Action to switch the input


pauseStateSettings
PauseStateScheduleActionSettings pauseStateSettings
Action to pause or unpause one or both channel pipelines


scte35ReturnToNetworkSettings
Scte35ReturnToNetworkScheduleActionSettings scte35ReturnToNetworkSettings
Action to insert SCTE-35 return_to_network message


scte35SpliceInsertSettings
Scte35SpliceInsertScheduleActionSettings scte35SpliceInsertSettings
Action to insert SCTE-35 splice_insert message


scte35TimeSignalSettings
Scte35TimeSignalScheduleActionSettings scte35TimeSignalSettings
Action to insert SCTE-35 time_signal message


staticImageActivateSettings
StaticImageActivateScheduleActionSettings staticImageActivateSettings
Action to activate a static image overlay


staticImageDeactivateSettings
StaticImageDeactivateScheduleActionSettings staticImageDeactivateSettings
Action to deactivate a static image overlay








Class com.amazonaws.services.medialive.model.ScheduleActionStartSettings extends Object implements Serializable


Serialized Fields


fixedModeScheduleActionStartSettings
FixedModeScheduleActionStartSettings fixedModeScheduleActionStartSettings
Option for specifying the start time for an action.


followModeScheduleActionStartSettings
FollowModeScheduleActionStartSettings followModeScheduleActionStartSettings
Option for specifying an action as relative to another action.


immediateModeScheduleActionStartSettings
ImmediateModeScheduleActionStartSettings immediateModeScheduleActionStartSettings
Option for specifying an action that should be applied immediately.








Class com.amazonaws.services.medialive.model.Scte20PlusEmbeddedDestinationSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.Scte20SourceSettings extends Object implements Serializable


Serialized Fields


convert608To708
String convert608To708
If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well
 as translated into 708. 708 data present in the source content will be discarded.


source608ChannelNumber
Integer source608ChannelNumber
Specifies the 608/708 channel number within the video track from which to extract captions. Unused for
 passthrough.








Class com.amazonaws.services.medialive.model.Scte27DestinationSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.Scte27SourceSettings extends Object implements Serializable


Serialized Fields


pid
Integer pid
The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and
 Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language:
 Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that
 happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all
 languages will be passed through.








Class com.amazonaws.services.medialive.model.Scte35DeliveryRestrictions extends Object implements Serializable


Serialized Fields


archiveAllowedFlag
String archiveAllowedFlag
Corresponds to SCTE-35 archive_allowed_flag.


deviceRestrictions
String deviceRestrictions
Corresponds to SCTE-35 device_restrictions parameter.


noRegionalBlackoutFlag
String noRegionalBlackoutFlag
Corresponds to SCTE-35 no_regional_blackout_flag parameter.


webDeliveryAllowedFlag
String webDeliveryAllowedFlag
Corresponds to SCTE-35 web_delivery_allowed_flag parameter.








Class com.amazonaws.services.medialive.model.Scte35Descriptor extends Object implements Serializable


Serialized Fields


scte35DescriptorSettings
Scte35DescriptorSettings scte35DescriptorSettings
SCTE-35 Descriptor Settings.








Class com.amazonaws.services.medialive.model.Scte35DescriptorSettings extends Object implements Serializable


Serialized Fields


segmentationDescriptorScte35DescriptorSettings
Scte35SegmentationDescriptor segmentationDescriptorScte35DescriptorSettings
SCTE-35 Segmentation Descriptor.








Class com.amazonaws.services.medialive.model.Scte35ReturnToNetworkScheduleActionSettings extends Object implements Serializable


Serialized Fields


spliceEventId
Long spliceEventId
The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.








Class com.amazonaws.services.medialive.model.Scte35SegmentationDescriptor extends Object implements Serializable


Serialized Fields


deliveryRestrictions
Scte35DeliveryRestrictions deliveryRestrictions
Holds the four SCTE-35 delivery restriction parameters.


segmentNum
Integer segmentNum
Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.


segmentationCancelIndicator
String segmentationCancelIndicator
Corresponds to SCTE-35 segmentation_event_cancel_indicator.


segmentationDuration
Long segmentationDuration
Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To
 convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a
 duration, the time_signal will continue until you insert a cancellation message.


segmentationEventId
Long segmentationEventId
Corresponds to SCTE-35 segmentation_event_id.


segmentationTypeId
Integer segmentationTypeId
Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35
 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the
 ID in hex (for example, "0x34") or decimal (for example, "52").


segmentationUpid
String segmentationUpid
Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the
 characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do
 not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex
 "41445320496e666f726d6174696f6e.


segmentationUpidType
Integer segmentationUpidType
Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35
 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the
 CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example,
 "0x0C" ) or in decimal (for example, "12").


segmentsExpected
Integer segmentsExpected
Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.


subSegmentNum
Integer subSegmentNum
Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.


subSegmentsExpected
Integer subSegmentsExpected
Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.








Class com.amazonaws.services.medialive.model.Scte35SpliceInsert extends Object implements Serializable


Serialized Fields


adAvailOffset
Integer adAvailOffset
When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to
 embedded SCTE 104/35 messages and does not apply to OOB messages.


noRegionalBlackoutFlag
String noRegionalBlackoutFlag
When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or
 Ad Avail slates


webDeliveryAllowedFlag
String webDeliveryAllowedFlag
When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or
 Ad Avail slates








Class com.amazonaws.services.medialive.model.Scte35SpliceInsertScheduleActionSettings extends Object implements Serializable


Serialized Fields


duration
Long duration
Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds
 by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and
 cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an
 expectation that you will enter a return_to_network to end the splice_insert at the appropriate time.


spliceEventId
Long spliceEventId
The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.








Class com.amazonaws.services.medialive.model.Scte35TimeSignalApos extends Object implements Serializable


Serialized Fields


adAvailOffset
Integer adAvailOffset
When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to
 embedded SCTE 104/35 messages and does not apply to OOB messages.


noRegionalBlackoutFlag
String noRegionalBlackoutFlag
When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or
 Ad Avail slates


webDeliveryAllowedFlag
String webDeliveryAllowedFlag
When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or
 Ad Avail slates








Class com.amazonaws.services.medialive.model.Scte35TimeSignalScheduleActionSettings extends Object implements Serializable


Serialized Fields


scte35Descriptors
List<E> scte35Descriptors
The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.








Class com.amazonaws.services.medialive.model.SmpteTtDestinationSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.StandardHlsSettings extends Object implements Serializable


Serialized Fields


audioRenditionSets
String audioRenditionSets
List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are
 associated to the video, separate by ','.


m3u8Settings
M3u8Settings m3u8Settings








Class com.amazonaws.services.medialive.model.StartChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelId
String channelId
A request to start a channel








Class com.amazonaws.services.medialive.model.StartChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The unique arn of the channel.


channelClass
String channelClass
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one
 pipeline.


destinations
List<E> destinations
A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types
 (HLS, for example), there is one destination per packager.


egressEndpoints
List<E> egressEndpoints
The endpoints where outgoing connections initiate from


encoderSettings
EncoderSettings encoderSettings


id
String id
The unique id of the channel.


inputAttachments
List<E> inputAttachments
List of input attachments for channel.


inputSpecification
InputSpecification inputSpecification


logLevel
String logLevel
The log level being written to CloudWatch Logs.


name
String name
The name of the channel. (user-mutable)


pipelineDetails
List<E> pipelineDetails
Runtime details for the pipelines of a running channel.


pipelinesRunningCount
Integer pipelinesRunningCount
The number of currently healthy pipelines.


roleArn
String roleArn
The Amazon Resource Name (ARN) of the role assumed when running the Channel.


state
String state


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.StartMultiplexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


multiplexId
String multiplexId
The ID of the multiplex.








Class com.amazonaws.services.medialive.model.StartMultiplexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The unique arn of the multiplex.


availabilityZones
List<E> availabilityZones
A list of availability zones for the multiplex.


destinations
List<E> destinations
A list of the multiplex output destinations.


id
String id
The unique id of the multiplex.


multiplexSettings
MultiplexSettings multiplexSettings
Configuration for a multiplex event.


name
String name
The name of the multiplex.


pipelinesRunningCount
Integer pipelinesRunningCount
The number of currently healthy pipelines.


programCount
Integer programCount
The number of programs in the multiplex.


state
String state
The current state of the multiplex.


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.StartTimecode extends Object implements Serializable


Serialized Fields


timecode
String timecode
The timecode for the frame where you want to start the clip. Optional; if not specified, the clip starts at first
 frame in the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.








Class com.amazonaws.services.medialive.model.StaticImageActivateScheduleActionSettings extends Object implements Serializable


Serialized Fields


duration
Integer duration
The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is
 unlimited and the image will remain until it is explicitly deactivated.


fadeIn
Integer fadeIn
The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default
 is 0 (no fade-in).


fadeOut
Integer fadeOut
Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts
 when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).


height
Integer height
The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the
 specified height. Leave blank to use the native height of the overlay.


image
InputLocation image
The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA
 file, and must not be larger (in pixels) than the input video.


imageX
Integer imageX
Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the
 default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of
 the underlying video, then the overlay is cropped on the right.


imageY
Integer imageY
Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default)
 is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the
 underlying video, then the overlay is cropped on the bottom.


layer
Integer layer
The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a
 different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on
 top of overlays with lower values of layer. Default is 0.


opacity
Integer opacity
Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.


width
Integer width
The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the
 specified width. Leave blank to use the native width of the overlay.








Class com.amazonaws.services.medialive.model.StaticImageDeactivateScheduleActionSettings extends Object implements Serializable


Serialized Fields


fadeOut
Integer fadeOut
The time in milliseconds for the image to fade out. Default is 0 (no fade-out).


layer
Integer layer
The image overlay layer to deactivate, 0 to 7. Default is 0.








Class com.amazonaws.services.medialive.model.StaticKeySettings extends Object implements Serializable


Serialized Fields


keyProviderServer
InputLocation keyProviderServer
The URL of the license server used for protecting content.


staticKeyValue
String staticKeyValue
Static key value as a 32 character hexadecimal string.








Class com.amazonaws.services.medialive.model.StopChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelId
String channelId
A request to stop a running channel








Class com.amazonaws.services.medialive.model.StopChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The unique arn of the channel.


channelClass
String channelClass
The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one
 pipeline.


destinations
List<E> destinations
A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types
 (HLS, for example), there is one destination per packager.


egressEndpoints
List<E> egressEndpoints
The endpoints where outgoing connections initiate from


encoderSettings
EncoderSettings encoderSettings


id
String id
The unique id of the channel.


inputAttachments
List<E> inputAttachments
List of input attachments for channel.


inputSpecification
InputSpecification inputSpecification


logLevel
String logLevel
The log level being written to CloudWatch Logs.


name
String name
The name of the channel. (user-mutable)


pipelineDetails
List<E> pipelineDetails
Runtime details for the pipelines of a running channel.


pipelinesRunningCount
Integer pipelinesRunningCount
The number of currently healthy pipelines.


roleArn
String roleArn
The Amazon Resource Name (ARN) of the role assumed when running the Channel.


state
String state


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.StopMultiplexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


multiplexId
String multiplexId
The ID of the multiplex.








Class com.amazonaws.services.medialive.model.StopMultiplexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The unique arn of the multiplex.


availabilityZones
List<E> availabilityZones
A list of availability zones for the multiplex.


destinations
List<E> destinations
A list of the multiplex output destinations.


id
String id
The unique id of the multiplex.


multiplexSettings
MultiplexSettings multiplexSettings
Configuration for a multiplex event.


name
String name
The name of the multiplex.


pipelinesRunningCount
Integer pipelinesRunningCount
The number of currently healthy pipelines.


programCount
Integer programCount
The number of programs in the multiplex.


state
String state
The current state of the multiplex.


tags
Map<K,V> tags
A collection of key-value pairs.








Class com.amazonaws.services.medialive.model.StopTimecode extends Object implements Serializable


Serialized Fields


lastFrameClippingBehavior
String lastFrameClippingBehavior
If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to
 exclude (the default) or include the frame specified by the timecode.


timecode
String timecode
The timecode for the frame where you want to stop the clip. Optional; if not specified, the clip continues to the
 end of the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF.








Class com.amazonaws.services.medialive.model.TeletextDestinationSettings extends Object implements Serializable




Class com.amazonaws.services.medialive.model.TeletextSourceSettings extends Object implements Serializable


Serialized Fields


pageNumber
String pageNumber
Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to
 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.








Class com.amazonaws.services.medialive.model.TimecodeConfig extends Object implements Serializable


Serialized Fields


source
String source
Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded):
 Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the
 source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time.
 -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00.


syncThreshold
Integer syncThreshold
Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below
 this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when
 this is not specified.








Class com.amazonaws.services.medialive.model.TooManyRequestsException extends AWSMediaLiveException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.medialive.model.TtmlDestinationSettings extends Object implements Serializable


Serialized Fields


styleControl
String styleControl
When set to passthrough, passes through style and position information from a TTML-like input source (TTML,
 SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.








Class com.amazonaws.services.medialive.model.UdpContainerSettings extends Object implements Serializable


Serialized Fields


m2tsSettings
M2tsSettings m2tsSettings








Class com.amazonaws.services.medialive.model.UdpGroupSettings extends Object implements Serializable


Serialized Fields


inputLossAction
String inputLossAction
Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs
 is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be
 dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when
 emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames,
 or slate frames substituted for the absent input video.


timedMetadataId3Frame
String timedMetadataId3Frame
Indicates ID3 frame that has the timecode.


timedMetadataId3Period
Integer timedMetadataId3Period
Timed Metadata interval in seconds.








Class com.amazonaws.services.medialive.model.UdpOutputSettings extends Object implements Serializable


Serialized Fields


bufferMsec
Integer bufferMsec
UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously
 assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery,
 input switching, input disruptions, picture reordering, etc.


containerSettings
UdpContainerSettings containerSettings


destination
OutputLocationRef destination
Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg.
 rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).


fecOutputSettings
FecOutputSettings fecOutputSettings
Settings for enabling and adjusting Forward Error Correction on UDP outputs.








Class com.amazonaws.services.medialive.model.UnprocessableEntityException extends AWSMediaLiveException implements Serializable

serialVersionUID:
1L



Serialized Fields


validationErrors
List<E> validationErrors
A collection of validation error responses.








Class com.amazonaws.services.medialive.model.UpdateChannelClassRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelClass
String channelClass
The channel class that you wish to update this channel to use.


channelId
String channelId
Channel Id of the channel whose class should be updated.


destinations
List<E> destinations
A list of output destinations for this channel.








Class com.amazonaws.services.medialive.model.UpdateChannelClassResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channel
Channel channel








Class com.amazonaws.services.medialive.model.UpdateChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelId
String channelId
channel ID


destinations
List<E> destinations
A list of output destinations for this channel.


encoderSettings
EncoderSettings encoderSettings
The encoder settings for this channel.


inputAttachments
List<E> inputAttachments


inputSpecification
InputSpecification inputSpecification
Specification of input for this channel (max. bitrate, resolution, codec, etc.)


logLevel
String logLevel
The log level to write to CloudWatch Logs.


name
String name
The name of the channel.


roleArn
String roleArn
An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this
 on an update call but the role was previously set that role will be removed.








Class com.amazonaws.services.medialive.model.UpdateChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channel
Channel channel








Class com.amazonaws.services.medialive.model.UpdateInputRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


destinations
List<E> destinations
Destination settings for PUSH type inputs.


inputId
String inputId
Unique ID of the input.


inputSecurityGroups
List<E> inputSecurityGroups
A list of security groups referenced by IDs to attach to the input.


mediaConnectFlows
List<E> mediaConnectFlows
A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as
 one Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is
 in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.


name
String name
Name of the input.


roleArn
String roleArn
The Amazon Resource Name (ARN) of the role this input assumes during and after creation.


sources
List<E> sources
The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only
 specify sources for PULL type Inputs. Leave Destinations empty.








Class com.amazonaws.services.medialive.model.UpdateInputResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


input
Input input








Class com.amazonaws.services.medialive.model.UpdateInputSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


inputSecurityGroupId
String inputSecurityGroupId
The id of the Input Security Group to update.


tags
Map<K,V> tags
A collection of key-value pairs.


whitelistRules
List<E> whitelistRules
List of IPv4 CIDR addresses to whitelist








Class com.amazonaws.services.medialive.model.UpdateInputSecurityGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


securityGroup
InputSecurityGroup securityGroup








Class com.amazonaws.services.medialive.model.UpdateMultiplexProgramRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


multiplexId
String multiplexId
The ID of the multiplex of the program to update.


multiplexProgramSettings
MultiplexProgramSettings multiplexProgramSettings
The new settings for a multiplex program.


programName
String programName
The name of the program to update.








Class com.amazonaws.services.medialive.model.UpdateMultiplexProgramResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


multiplexProgram
MultiplexProgram multiplexProgram
The updated multiplex program.








Class com.amazonaws.services.medialive.model.UpdateMultiplexRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


multiplexId
String multiplexId
ID of the multiplex to update.


multiplexSettings
MultiplexSettings multiplexSettings
The new settings for a multiplex.


name
String name
Name of the multiplex.








Class com.amazonaws.services.medialive.model.UpdateMultiplexResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


multiplex
Multiplex multiplex
The updated multiplex.








Class com.amazonaws.services.medialive.model.UpdateReservationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name
Name of the reservation


reservationId
String reservationId
Unique reservation ID, e.g. '1234567'








Class com.amazonaws.services.medialive.model.UpdateReservationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


reservation
Reservation reservation








Class com.amazonaws.services.medialive.model.ValidationError extends Object implements Serializable


Serialized Fields


elementPath
String elementPath


errorMessage
String errorMessage








Class com.amazonaws.services.medialive.model.VideoCodecSettings extends Object implements Serializable


Serialized Fields


frameCaptureSettings
FrameCaptureSettings frameCaptureSettings


h264Settings
H264Settings h264Settings


h265Settings
H265Settings h265Settings








Class com.amazonaws.services.medialive.model.VideoDescription extends Object implements Serializable


Serialized Fields


codecSettings
VideoCodecSettings codecSettings
Video codec settings.


height
Integer height
Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank
 in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not
 recommended. For the Frame Capture codec, height and width are required.


name
String name
The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description
 names should be unique within this Live Event.


respondToAfd
String respondToAfd
Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped,
 depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for
 FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores
 the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values
 and does not include the values through to the output, so input video is not clipped.


scalingBehavior
String scalingBehavior
STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height
 and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter
 boxes) around the video to provide the specified output resolution.


sharpness
Integer sharpness
Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A
 setting of 50 is recommended for most content.


width
Integer width
Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank
 in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not
 recommended. For the Frame Capture codec, height and width are required.








Class com.amazonaws.services.medialive.model.VideoSelector extends Object implements Serializable


Serialized Fields


colorSpace
String colorSpace
Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video
 description's colorSpaceSettingsChoice to determine if any conversion will be performed.


colorSpaceUsage
String colorSpaceUsage
Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace
 field will be used. fallback means that when the input does include color space data, that data will be used, but
 when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is
 sometimes missing color space data, but when it does have color space data, that data is correct. force means to
 always use the value in colorSpace. Choose force if your input usually has no color space data or might have
 unreliable color space data.


selectorSettings
VideoSelectorSettings selectorSettings
The video selector settings.








Class com.amazonaws.services.medialive.model.VideoSelectorPid extends Object implements Serializable


Serialized Fields


pid
Integer pid
Selects a specific PID from within a video source.








Class com.amazonaws.services.medialive.model.VideoSelectorProgramId extends Object implements Serializable


Serialized Fields


programId
Integer programId
Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first
 program within the transport stream will be selected by default.








Class com.amazonaws.services.medialive.model.VideoSelectorSettings extends Object implements Serializable


Serialized Fields


videoSelectorPid
VideoSelectorPid videoSelectorPid


videoSelectorProgramId
VideoSelectorProgramId videoSelectorProgramId








Class com.amazonaws.services.medialive.model.WebvttDestinationSettings extends Object implements Serializable




Package com.amazonaws.services.mediapackage.model




Class com.amazonaws.services.mediapackage.model.Authorization extends Object implements Serializable


Serialized Fields


cdnIdentifierSecret
String cdnIdentifierSecret
The Amazon Resource Name (ARN) for the secret in Secrets Manager that your Content Distribution Network (CDN)
 uses for authorization to access your endpoint.


secretsRoleArn
String secretsRoleArn
The Amazon Resource Name (ARN) for the IAM role that allows MediaPackage to communicate with AWS Secrets Manager.








Class com.amazonaws.services.mediapackage.model.AWSMediaPackageException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackage.model.Channel extends Object implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) assigned to the Channel.


description
String description
A short text description of the Channel.


hlsIngest
HlsIngest hlsIngest


id
String id
The ID of the Channel.


tags
Map<K,V> tags








Class com.amazonaws.services.mediapackage.model.CmafEncryption extends Object implements Serializable


Serialized Fields


keyRotationIntervalSeconds
Integer keyRotationIntervalSeconds
Time (in seconds) between each encryption key rotation.


spekeKeyProvider
SpekeKeyProvider spekeKeyProvider








Class com.amazonaws.services.mediapackage.model.CmafPackage extends Object implements Serializable


Serialized Fields


encryption
CmafEncryption encryption


hlsManifests
List<E> hlsManifests
A list of HLS manifest configurations


segmentDurationSeconds
Integer segmentDurationSeconds
Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source
 segment duration.


segmentPrefix
String segmentPrefix
An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the
 ChannelId.


streamSelection
StreamSelection streamSelection








Class com.amazonaws.services.mediapackage.model.CmafPackageCreateOrUpdateParameters extends Object implements Serializable


Serialized Fields


encryption
CmafEncryption encryption


hlsManifests
List<E> hlsManifests
A list of HLS manifest configurations


segmentDurationSeconds
Integer segmentDurationSeconds
Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source
 segment duration.


segmentPrefix
String segmentPrefix
An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the
 ChannelId.


streamSelection
StreamSelection streamSelection








Class com.amazonaws.services.mediapackage.model.CreateChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description
A short text description of the Channel.


id
String id
The ID of the Channel. The ID must be unique within the region and it cannot be changed after a Channel is
 created.


tags
Map<K,V> tags








Class com.amazonaws.services.mediapackage.model.CreateChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) assigned to the Channel.


description
String description
A short text description of the Channel.


hlsIngest
HlsIngest hlsIngest


id
String id
The ID of the Channel.


tags
Map<K,V> tags








Class com.amazonaws.services.mediapackage.model.CreateHarvestJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


endTime
String endTime
The end of the time-window which will be harvested


id
String id
The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob
 is submitted


originEndpointId
String originEndpointId
The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob
 is submitted.


s3Destination
S3Destination s3Destination


startTime
String startTime
The start of the time-window which will be harvested








Class com.amazonaws.services.mediapackage.model.CreateHarvestJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) assigned to the HarvestJob.


channelId
String channelId
The ID of the Channel that the HarvestJob will harvest from.


createdAt
String createdAt
The time the HarvestJob was submitted


endTime
String endTime
The end of the time-window which will be harvested.


id
String id
The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob
 is submitted.


originEndpointId
String originEndpointId
The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob
 is submitted.


s3Destination
S3Destination s3Destination


startTime
String startTime
The start of the time-window which will be harvested.


status
String status
The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they
 succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob
 failed.








Class com.amazonaws.services.mediapackage.model.CreateOriginEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


authorization
Authorization authorization


channelId
String channelId
The ID of the Channel that the OriginEndpoint will be associated with. This cannot be changed after the
 OriginEndpoint is created.


cmafPackage
CmafPackageCreateOrUpdateParameters cmafPackage


dashPackage
DashPackage dashPackage


description
String description
A short text description of the OriginEndpoint.


hlsPackage
HlsPackage hlsPackage


id
String id
The ID of the OriginEndpoint. The ID must be unique within the region and it cannot be changed after the
 OriginEndpoint is created.


manifestName
String manifestName
A short string that will be used as the filename of the OriginEndpoint URL (defaults to "index").


mssPackage
MssPackage mssPackage


origination
String origination
Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may
 by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
 requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination


startoverWindowSeconds
Integer startoverWindowSeconds
Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will
 be disabled for the OriginEndpoint.


tags
Map<K,V> tags


timeDelaySeconds
Integer timeDelaySeconds
Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time
 delay in effect for the OriginEndpoint.


whitelist
List<E> whitelist
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.








Class com.amazonaws.services.mediapackage.model.CreateOriginEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) assigned to the OriginEndpoint.


authorization
Authorization authorization


channelId
String channelId
The ID of the Channel the OriginEndpoint is associated with.


cmafPackage
CmafPackage cmafPackage


dashPackage
DashPackage dashPackage


description
String description
A short text description of the OriginEndpoint.


hlsPackage
HlsPackage hlsPackage


id
String id
The ID of the OriginEndpoint.


manifestName
String manifestName
A short string appended to the end of the OriginEndpoint URL.


mssPackage
MssPackage mssPackage


origination
String origination
Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may
 by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
 requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination


startoverWindowSeconds
Integer startoverWindowSeconds
Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will
 be disabled for the OriginEndpoint.


tags
Map<K,V> tags


timeDelaySeconds
Integer timeDelaySeconds
Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time
 delay in effect for the OriginEndpoint.


url
String url
The URL of the packaged OriginEndpoint for consumption.


whitelist
List<E> whitelist
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.








Class com.amazonaws.services.mediapackage.model.DashEncryption extends Object implements Serializable


Serialized Fields


keyRotationIntervalSeconds
Integer keyRotationIntervalSeconds
Time (in seconds) between each encryption key rotation.


spekeKeyProvider
SpekeKeyProvider spekeKeyProvider








Class com.amazonaws.services.mediapackage.model.DashPackage extends Object implements Serializable


Serialized Fields


adTriggers
List<E> adTriggers


adsOnDeliveryRestrictions
String adsOnDeliveryRestrictions


encryption
DashEncryption encryption


manifestLayout
String manifestLayout
Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like
 SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate
 elements are combined and presented at the AdaptationSet level.


manifestWindowSeconds
Integer manifestWindowSeconds
Time window (in seconds) contained in each manifest.


minBufferTimeSeconds
Integer minBufferTimeSeconds
Minimum duration (in seconds) that a player will buffer media before starting the presentation.


minUpdatePeriodSeconds
Integer minUpdatePeriodSeconds
Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media
 Presentation Description (MPD).


periodTriggers
List<E> periodTriggers
A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation
 Description (MPD) will be partitioned into multiple periods. If empty, the content will not be partitioned into
 more than one period. If the list contains "ADS", new periods will be created where the Channel source contains
 SCTE-35 ad markers.


profile
String profile
The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output
 is enabled.


segmentDurationSeconds
Integer segmentDurationSeconds
Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source
 segment duration.


segmentTemplateFormat
String segmentTemplateFormat
Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to
 NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to
 TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to
 NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.


streamSelection
StreamSelection streamSelection


suggestedPresentationDelaySeconds
Integer suggestedPresentationDelaySeconds
Duration (in seconds) to delay live content before presentation.








Class com.amazonaws.services.mediapackage.model.DeleteChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of the Channel to delete.








Class com.amazonaws.services.mediapackage.model.DeleteChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediapackage.model.DeleteOriginEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of the OriginEndpoint to delete.








Class com.amazonaws.services.mediapackage.model.DeleteOriginEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediapackage.model.DescribeChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of a Channel.








Class com.amazonaws.services.mediapackage.model.DescribeChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) assigned to the Channel.


description
String description
A short text description of the Channel.


hlsIngest
HlsIngest hlsIngest


id
String id
The ID of the Channel.


tags
Map<K,V> tags








Class com.amazonaws.services.mediapackage.model.DescribeHarvestJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of the HarvestJob.








Class com.amazonaws.services.mediapackage.model.DescribeHarvestJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) assigned to the HarvestJob.


channelId
String channelId
The ID of the Channel that the HarvestJob will harvest from.


createdAt
String createdAt
The time the HarvestJob was submitted


endTime
String endTime
The end of the time-window which will be harvested.


id
String id
The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob
 is submitted.


originEndpointId
String originEndpointId
The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob
 is submitted.


s3Destination
S3Destination s3Destination


startTime
String startTime
The start of the time-window which will be harvested.


status
String status
The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they
 succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob
 failed.








Class com.amazonaws.services.mediapackage.model.DescribeOriginEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of the OriginEndpoint.








Class com.amazonaws.services.mediapackage.model.DescribeOriginEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) assigned to the OriginEndpoint.


authorization
Authorization authorization


channelId
String channelId
The ID of the Channel the OriginEndpoint is associated with.


cmafPackage
CmafPackage cmafPackage


dashPackage
DashPackage dashPackage


description
String description
A short text description of the OriginEndpoint.


hlsPackage
HlsPackage hlsPackage


id
String id
The ID of the OriginEndpoint.


manifestName
String manifestName
A short string appended to the end of the OriginEndpoint URL.


mssPackage
MssPackage mssPackage


origination
String origination
Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may
 by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
 requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination


startoverWindowSeconds
Integer startoverWindowSeconds
Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will
 be disabled for the OriginEndpoint.


tags
Map<K,V> tags


timeDelaySeconds
Integer timeDelaySeconds
Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time
 delay in effect for the OriginEndpoint.


url
String url
The URL of the packaged OriginEndpoint for consumption.


whitelist
List<E> whitelist
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.








Class com.amazonaws.services.mediapackage.model.ForbiddenException extends AWSMediaPackageException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackage.model.HarvestJob extends Object implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) assigned to the HarvestJob.


channelId
String channelId
The ID of the Channel that the HarvestJob will harvest from.


createdAt
String createdAt
The time the HarvestJob was submitted


endTime
String endTime
The end of the time-window which will be harvested.


id
String id
The ID of the HarvestJob. The ID must be unique within the region and it cannot be changed after the HarvestJob
 is submitted.


originEndpointId
String originEndpointId
The ID of the OriginEndpoint that the HarvestJob will harvest from. This cannot be changed after the HarvestJob
 is submitted.


s3Destination
S3Destination s3Destination


startTime
String startTime
The start of the time-window which will be harvested.


status
String status
The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for HarvestJobs as they
 succeed or fail. In the event of failure, the CloudWatch Event will include an explanation of why the HarvestJob
 failed.








Class com.amazonaws.services.mediapackage.model.HlsEncryption extends Object implements Serializable


Serialized Fields


constantInitializationVector
String constantInitializationVector
A constant initialization vector for encryption (optional). When not specified the initialization vector will be
 periodically rotated.


encryptionMethod
String encryptionMethod
The encryption method to use.


keyRotationIntervalSeconds
Integer keyRotationIntervalSeconds
Interval (in seconds) between each encryption key rotation.


repeatExtXKey
Boolean repeatExtXKey
When enabled, the EXT-X-KEY tag will be repeated in output manifests.


spekeKeyProvider
SpekeKeyProvider spekeKeyProvider








Class com.amazonaws.services.mediapackage.model.HlsIngest extends Object implements Serializable


Serialized Fields


ingestEndpoints
List<E> ingestEndpoints
A list of endpoints to which the source stream should be sent.








Class com.amazonaws.services.mediapackage.model.HlsManifest extends Object implements Serializable


Serialized Fields


adMarkers
String adMarkers
This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad
 markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments)
 taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and
 blackout tags based on SCTE-35 messages in the input source.


id
String id
The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is
 created.


includeIframeOnlyStream
Boolean includeIframeOnlyStream
When enabled, an I-Frame only stream will be included in the output.


manifestName
String manifestName
An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the
 manifestName for the OriginEndpoint.


playlistType
String playlistType
The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding
 EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.


playlistWindowSeconds
Integer playlistWindowSeconds
Time window (in seconds) contained in each parent manifest.


programDateTimeIntervalSeconds
Integer programDateTimeIntervalSeconds
The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an
 interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the
 content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted
 into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if
 any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.


url
String url
The URL of the packaged OriginEndpoint for consumption.








Class com.amazonaws.services.mediapackage.model.HlsManifestCreateOrUpdateParameters extends Object implements Serializable


Serialized Fields


adMarkers
String adMarkers
This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad
 markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments)
 taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and
 blackout tags based on SCTE-35 messages in the input source.


adTriggers
List<E> adTriggers


adsOnDeliveryRestrictions
String adsOnDeliveryRestrictions


id
String id
The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is
 created.


includeIframeOnlyStream
Boolean includeIframeOnlyStream
When enabled, an I-Frame only stream will be included in the output.


manifestName
String manifestName
An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the
 manifestName for the OriginEndpoint.


playlistType
String playlistType
The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding
 EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.


playlistWindowSeconds
Integer playlistWindowSeconds
Time window (in seconds) contained in each parent manifest.


programDateTimeIntervalSeconds
Integer programDateTimeIntervalSeconds
The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an
 interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the
 content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted
 into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if
 any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.








Class com.amazonaws.services.mediapackage.model.HlsPackage extends Object implements Serializable


Serialized Fields


adMarkers
String adMarkers
This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad
 markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments)
 taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and
 blackout tags based on SCTE-35 messages in the input source.


adTriggers
List<E> adTriggers


adsOnDeliveryRestrictions
String adsOnDeliveryRestrictions


encryption
HlsEncryption encryption


includeIframeOnlyStream
Boolean includeIframeOnlyStream
When enabled, an I-Frame only stream will be included in the output.


playlistType
String playlistType
The HTTP Live Streaming (HLS) playlist type. When either "EVENT" or "VOD" is specified, a corresponding
 EXT-X-PLAYLIST-TYPE entry will be included in the media playlist.


playlistWindowSeconds
Integer playlistWindowSeconds
Time window (in seconds) contained in each parent manifest.


programDateTimeIntervalSeconds
Integer programDateTimeIntervalSeconds
The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an
 interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the
 content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted
 into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if
 any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.


segmentDurationSeconds
Integer segmentDurationSeconds
Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source
 fragment duration.


streamSelection
StreamSelection streamSelection


useAudioRenditionGroup
Boolean useAudioRenditionGroup
When enabled, audio streams will be placed in rendition groups in the output.








Class com.amazonaws.services.mediapackage.model.IngestEndpoint extends Object implements Serializable


Serialized Fields


id
String id
The system generated unique identifier for the IngestEndpoint


password
String password
The system generated password for ingest authentication.


url
String url
The ingest URL to which the source stream should be sent.


username
String username
The system generated username for ingest authentication.








Class com.amazonaws.services.mediapackage.model.InternalServerErrorException extends AWSMediaPackageException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackage.model.ListChannelsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults
Upper bound on number of records to return.


nextToken
String nextToken
A token used to resume pagination from the end of a previous request.








Class com.amazonaws.services.mediapackage.model.ListChannelsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


channels
List<E> channels
A list of Channel records.


nextToken
String nextToken
A token that can be used to resume pagination from the end of the collection.








Class com.amazonaws.services.mediapackage.model.ListHarvestJobsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


includeChannelId
String includeChannelId
When specified, the request will return only HarvestJobs associated with the given Channel ID.


includeStatus
String includeStatus
When specified, the request will return only HarvestJobs in the given status.


maxResults
Integer maxResults
The upper bound on the number of records to return.


nextToken
String nextToken
A token used to resume pagination from the end of a previous request.








Class com.amazonaws.services.mediapackage.model.ListHarvestJobsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


harvestJobs
List<E> harvestJobs
A list of HarvestJob records.


nextToken
String nextToken
A token that can be used to resume pagination from the end of the collection.








Class com.amazonaws.services.mediapackage.model.ListOriginEndpointsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


channelId
String channelId
When specified, the request will return only OriginEndpoints associated with the given Channel ID.


maxResults
Integer maxResults
The upper bound on the number of records to return.


nextToken
String nextToken
A token used to resume pagination from the end of a previous request.








Class com.amazonaws.services.mediapackage.model.ListOriginEndpointsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
A token that can be used to resume pagination from the end of the collection.


originEndpoints
List<E> originEndpoints
A list of OriginEndpoint records.








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


Serialized Fields


resourceArn
String resourceArn








Class com.amazonaws.services.mediapackage.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags








Class com.amazonaws.services.mediapackage.model.MssEncryption extends Object implements Serializable


Serialized Fields


spekeKeyProvider
SpekeKeyProvider spekeKeyProvider








Class com.amazonaws.services.mediapackage.model.MssPackage extends Object implements Serializable


Serialized Fields


encryption
MssEncryption encryption


manifestWindowSeconds
Integer manifestWindowSeconds
The time window (in seconds) contained in each manifest.


segmentDurationSeconds
Integer segmentDurationSeconds
The duration (in seconds) of each segment.


streamSelection
StreamSelection streamSelection








Class com.amazonaws.services.mediapackage.model.NotFoundException extends AWSMediaPackageException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackage.model.OriginEndpoint extends Object implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) assigned to the OriginEndpoint.


authorization
Authorization authorization


channelId
String channelId
The ID of the Channel the OriginEndpoint is associated with.


cmafPackage
CmafPackage cmafPackage


dashPackage
DashPackage dashPackage


description
String description
A short text description of the OriginEndpoint.


hlsPackage
HlsPackage hlsPackage


id
String id
The ID of the OriginEndpoint.


manifestName
String manifestName
A short string appended to the end of the OriginEndpoint URL.


mssPackage
MssPackage mssPackage


origination
String origination
Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may
 by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
 requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination


startoverWindowSeconds
Integer startoverWindowSeconds
Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will
 be disabled for the OriginEndpoint.


tags
Map<K,V> tags


timeDelaySeconds
Integer timeDelaySeconds
Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time
 delay in effect for the OriginEndpoint.


url
String url
The URL of the packaged OriginEndpoint for consumption.


whitelist
List<E> whitelist
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.








Class com.amazonaws.services.mediapackage.model.RotateChannelCredentialsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of the channel to update.








Class com.amazonaws.services.mediapackage.model.RotateChannelCredentialsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
Deprecated. 
The Amazon Resource Name (ARN) assigned to the Channel.


description
String description
Deprecated. 
A short text description of the Channel.


hlsIngest
HlsIngest hlsIngest
Deprecated. 


id
String id
Deprecated. 
The ID of the Channel.


tags
Map<K,V> tags
Deprecated. 








Class com.amazonaws.services.mediapackage.model.RotateIngestEndpointCredentialsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of the channel the IngestEndpoint is on.


ingestEndpointId
String ingestEndpointId
The id of the IngestEndpoint whose credentials should be rotated








Class com.amazonaws.services.mediapackage.model.RotateIngestEndpointCredentialsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) assigned to the Channel.


description
String description
A short text description of the Channel.


hlsIngest
HlsIngest hlsIngest


id
String id
The ID of the Channel.


tags
Map<K,V> tags








Class com.amazonaws.services.mediapackage.model.S3Destination extends Object implements Serializable


Serialized Fields


bucketName
String bucketName
The name of an S3 bucket within which harvested content will be exported


manifestKey
String manifestKey
The key in the specified S3 bucket where the harvested top-level manifest will be placed.


roleArn
String roleArn
The IAM role used to write to the specified S3 bucket








Class com.amazonaws.services.mediapackage.model.ServiceUnavailableException extends AWSMediaPackageException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackage.model.SpekeKeyProvider extends Object implements Serializable


Serialized Fields


certificateArn
String certificateArn
An Amazon Resource Name (ARN) of a Certificate Manager certificate that MediaPackage will use for enforcing
 secure end-to-end data transfer with the key provider service.


resourceId
String resourceId
The resource ID to include in key requests.


roleArn
String roleArn
An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key
 provider service.


systemIds
List<E> systemIds
The system IDs to include in key requests.


url
String url
The URL of the external key provider service.








Class com.amazonaws.services.mediapackage.model.StreamSelection extends Object implements Serializable


Serialized Fields


maxVideoBitsPerSecond
Integer maxVideoBitsPerSecond
The maximum video bitrate (bps) to include in output.


minVideoBitsPerSecond
Integer minVideoBitsPerSecond
The minimum video bitrate (bps) to include in output.


streamOrder
String streamOrder
A directive that determines the order of streams in the output.








Class com.amazonaws.services.mediapackage.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn


tags
Map<K,V> tags








Class com.amazonaws.services.mediapackage.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediapackage.model.TooManyRequestsException extends AWSMediaPackageException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackage.model.UnprocessableEntityException extends AWSMediaPackageException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackage.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn


tagKeys
List<E> tagKeys
The key(s) of tag to be deleted








Class com.amazonaws.services.mediapackage.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediapackage.model.UpdateChannelRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description
A short text description of the Channel.


id
String id
The ID of the Channel to update.








Class com.amazonaws.services.mediapackage.model.UpdateChannelResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) assigned to the Channel.


description
String description
A short text description of the Channel.


hlsIngest
HlsIngest hlsIngest


id
String id
The ID of the Channel.


tags
Map<K,V> tags








Class com.amazonaws.services.mediapackage.model.UpdateOriginEndpointRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


authorization
Authorization authorization


cmafPackage
CmafPackageCreateOrUpdateParameters cmafPackage


dashPackage
DashPackage dashPackage


description
String description
A short text description of the OriginEndpoint.


hlsPackage
HlsPackage hlsPackage


id
String id
The ID of the OriginEndpoint to update.


manifestName
String manifestName
A short string that will be appended to the end of the Endpoint URL.


mssPackage
MssPackage mssPackage


origination
String origination
Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may
 by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
 requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination


startoverWindowSeconds
Integer startoverWindowSeconds
Maximum duration (in seconds) of content to retain for startover playback. If not specified, startover playback
 will be disabled for the OriginEndpoint.


timeDelaySeconds
Integer timeDelaySeconds
Amount of delay (in seconds) to enforce on the playback of live content. If not specified, there will be no time
 delay in effect for the OriginEndpoint.


whitelist
List<E> whitelist
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.








Class com.amazonaws.services.mediapackage.model.UpdateOriginEndpointResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The Amazon Resource Name (ARN) assigned to the OriginEndpoint.


authorization
Authorization authorization


channelId
String channelId
The ID of the Channel the OriginEndpoint is associated with.


cmafPackage
CmafPackage cmafPackage


dashPackage
DashPackage dashPackage


description
String description
A short text description of the OriginEndpoint.


hlsPackage
HlsPackage hlsPackage


id
String id
The ID of the OriginEndpoint.


manifestName
String manifestName
A short string appended to the end of the OriginEndpoint URL.


mssPackage
MssPackage mssPackage


origination
String origination
Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint may
 by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be
 requested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination


startoverWindowSeconds
Integer startoverWindowSeconds
Maximum duration (seconds) of content to retain for startover playback. If not specified, startover playback will
 be disabled for the OriginEndpoint.


tags
Map<K,V> tags


timeDelaySeconds
Integer timeDelaySeconds
Amount of delay (seconds) to enforce on the playback of live content. If not specified, there will be no time
 delay in effect for the OriginEndpoint.


url
String url
The URL of the packaged OriginEndpoint for consumption.


whitelist
List<E> whitelist
A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.








Package com.amazonaws.services.mediapackagevod.model




Class com.amazonaws.services.mediapackagevod.model.AssetShallow extends Object implements Serializable


Serialized Fields


arn
String arn
The ARN of the Asset.


createdAt
String createdAt
The time the Asset was initially submitted for Ingest.


id
String id
The unique identifier for the Asset.


packagingGroupId
String packagingGroupId
The ID of the PackagingGroup for the Asset.


resourceId
String resourceId
The resource ID to include in SPEKE key requests.


sourceArn
String sourceArn
ARN of the source object in S3.


sourceRoleArn
String sourceRoleArn
The IAM role ARN used to access the source S3 bucket.








Class com.amazonaws.services.mediapackagevod.model.AWSMediaPackageVodException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackagevod.model.CmafEncryption extends Object implements Serializable


Serialized Fields


spekeKeyProvider
SpekeKeyProvider spekeKeyProvider








Class com.amazonaws.services.mediapackagevod.model.CmafPackage extends Object implements Serializable


Serialized Fields


encryption
CmafEncryption encryption


hlsManifests
List<E> hlsManifests
A list of HLS manifest configurations.


segmentDurationSeconds
Integer segmentDurationSeconds
Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source
 fragment duration.








Class com.amazonaws.services.mediapackagevod.model.CreateAssetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The unique identifier for the Asset.


packagingGroupId
String packagingGroupId
The ID of the PackagingGroup for the Asset.


resourceId
String resourceId
The resource ID to include in SPEKE key requests.


sourceArn
String sourceArn
ARN of the source object in S3.


sourceRoleArn
String sourceRoleArn
The IAM role ARN used to access the source S3 bucket.








Class com.amazonaws.services.mediapackagevod.model.CreateAssetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the Asset.


createdAt
String createdAt
The time the Asset was initially submitted for Ingest.


egressEndpoints
List<E> egressEndpoints
The list of egress endpoints available for the Asset.


id
String id
The unique identifier for the Asset.


packagingGroupId
String packagingGroupId
The ID of the PackagingGroup for the Asset.


resourceId
String resourceId
The resource ID to include in SPEKE key requests.


sourceArn
String sourceArn
ARN of the source object in S3.


sourceRoleArn
String sourceRoleArn
The IAM role_arn used to access the source S3 bucket.








Class com.amazonaws.services.mediapackagevod.model.CreatePackagingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


cmafPackage
CmafPackage cmafPackage


dashPackage
DashPackage dashPackage


hlsPackage
HlsPackage hlsPackage


id
String id
The ID of the PackagingConfiguration.


mssPackage
MssPackage mssPackage


packagingGroupId
String packagingGroupId
The ID of a PackagingGroup.








Class com.amazonaws.services.mediapackagevod.model.CreatePackagingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the PackagingConfiguration.


cmafPackage
CmafPackage cmafPackage


dashPackage
DashPackage dashPackage


hlsPackage
HlsPackage hlsPackage


id
String id
The ID of the PackagingConfiguration.


mssPackage
MssPackage mssPackage


packagingGroupId
String packagingGroupId
The ID of a PackagingGroup.








Class com.amazonaws.services.mediapackagevod.model.CreatePackagingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of the PackagingGroup.








Class com.amazonaws.services.mediapackagevod.model.CreatePackagingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the PackagingGroup.


domainName
String domainName
The fully qualified domain name for Assets in the PackagingGroup.


id
String id
The ID of the PackagingGroup.








Class com.amazonaws.services.mediapackagevod.model.DashEncryption extends Object implements Serializable


Serialized Fields


spekeKeyProvider
SpekeKeyProvider spekeKeyProvider








Class com.amazonaws.services.mediapackagevod.model.DashManifest extends Object implements Serializable


Serialized Fields


manifestName
String manifestName
An optional string to include in the name of the manifest.


minBufferTimeSeconds
Integer minBufferTimeSeconds
Minimum duration (in seconds) that a player will buffer media before starting the presentation.


profile
String profile
The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to "HBBTV_1_5", HbbTV 1.5 compliant output
 is enabled.


streamSelection
StreamSelection streamSelection








Class com.amazonaws.services.mediapackagevod.model.DashPackage extends Object implements Serializable


Serialized Fields


dashManifests
List<E> dashManifests
A list of DASH manifest configurations.


encryption
DashEncryption encryption


segmentDurationSeconds
Integer segmentDurationSeconds
Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source
 segment duration.








Class com.amazonaws.services.mediapackagevod.model.DeleteAssetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of the MediaPackage VOD Asset resource to delete.








Class com.amazonaws.services.mediapackagevod.model.DeleteAssetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediapackagevod.model.DeletePackagingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of the MediaPackage VOD PackagingConfiguration resource to delete.








Class com.amazonaws.services.mediapackagevod.model.DeletePackagingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediapackagevod.model.DeletePackagingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of the MediaPackage VOD PackagingGroup resource to delete.








Class com.amazonaws.services.mediapackagevod.model.DeletePackagingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediapackagevod.model.DescribeAssetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of an MediaPackage VOD Asset resource.








Class com.amazonaws.services.mediapackagevod.model.DescribeAssetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the Asset.


createdAt
String createdAt
The time the Asset was initially submitted for Ingest.


egressEndpoints
List<E> egressEndpoints
The list of egress endpoints available for the Asset.


id
String id
The unique identifier for the Asset.


packagingGroupId
String packagingGroupId
The ID of the PackagingGroup for the Asset.


resourceId
String resourceId
The resource ID to include in SPEKE key requests.


sourceArn
String sourceArn
ARN of the source object in S3.


sourceRoleArn
String sourceRoleArn
The IAM role_arn used to access the source S3 bucket.








Class com.amazonaws.services.mediapackagevod.model.DescribePackagingConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of a MediaPackage VOD PackagingConfiguration resource.








Class com.amazonaws.services.mediapackagevod.model.DescribePackagingConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the PackagingConfiguration.


cmafPackage
CmafPackage cmafPackage


dashPackage
DashPackage dashPackage


hlsPackage
HlsPackage hlsPackage


id
String id
The ID of the PackagingConfiguration.


mssPackage
MssPackage mssPackage


packagingGroupId
String packagingGroupId
The ID of a PackagingGroup.








Class com.amazonaws.services.mediapackagevod.model.DescribePackagingGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


id
String id
The ID of a MediaPackage VOD PackagingGroup resource.








Class com.amazonaws.services.mediapackagevod.model.DescribePackagingGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
The ARN of the PackagingGroup.


domainName
String domainName
The fully qualified domain name for Assets in the PackagingGroup.


id
String id
The ID of the PackagingGroup.








Class com.amazonaws.services.mediapackagevod.model.EgressEndpoint extends Object implements Serializable


Serialized Fields


packagingConfigurationId
String packagingConfigurationId
The ID of the PackagingConfiguration being applied to the Asset.


url
String url
The URL of the parent manifest for the repackaged Asset.








Class com.amazonaws.services.mediapackagevod.model.ForbiddenException extends AWSMediaPackageVodException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackagevod.model.HlsEncryption extends Object implements Serializable


Serialized Fields


constantInitializationVector
String constantInitializationVector
A constant initialization vector for encryption (optional). When not specified the initialization vector will be
 periodically rotated.


encryptionMethod
String encryptionMethod
The encryption method to use.


spekeKeyProvider
SpekeKeyProvider spekeKeyProvider








Class com.amazonaws.services.mediapackagevod.model.HlsManifest extends Object implements Serializable


Serialized Fields


adMarkers
String adMarkers
This setting controls how ad markers are included in the packaged OriginEndpoint. "NONE" will omit all SCTE-35 ad
 markers from the output. "PASSTHROUGH" causes the manifest to contain a copy of the SCTE-35 ad markers (comments)
 taken directly from the input HTTP Live Streaming (HLS) manifest. "SCTE35_ENHANCED" generates ad markers and
 blackout tags based on SCTE-35 messages in the input source.


includeIframeOnlyStream
Boolean includeIframeOnlyStream
When enabled, an I-Frame only stream will be included in the output.


manifestName
String manifestName
An optional string to include in the name of the manifest.


programDateTimeIntervalSeconds
Integer programDateTimeIntervalSeconds
The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag inserted into manifests. Additionally, when an
 interval is specified ID3Timed Metadata messages will be generated every 5 seconds using the ingest time of the
 content. If the interval is not specified, or set to 0, then no EXT-X-PROGRAM-DATE-TIME tags will be inserted
 into manifests and no ID3Timed Metadata messages will be generated. Note that irrespective of this parameter, if
 any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input, it will be passed through to HLS output.


repeatExtXKey
Boolean repeatExtXKey
When enabled, the EXT-X-KEY tag will be repeated in output manifests.


streamSelection
StreamSelection streamSelection








Class com.amazonaws.services.mediapackagevod.model.HlsPackage extends Object implements Serializable


Serialized Fields


encryption
HlsEncryption encryption


hlsManifests
List<E> hlsManifests
A list of HLS manifest configurations.


segmentDurationSeconds
Integer segmentDurationSeconds
Duration (in seconds) of each fragment. Actual fragments will be rounded to the nearest multiple of the source
 fragment duration.


useAudioRenditionGroup
Boolean useAudioRenditionGroup
When enabled, audio streams will be placed in rendition groups in the output.








Class com.amazonaws.services.mediapackagevod.model.InternalServerErrorException extends AWSMediaPackageVodException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackagevod.model.ListAssetsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults
Upper bound on number of records to return.


nextToken
String nextToken
A token used to resume pagination from the end of a previous request.


packagingGroupId
String packagingGroupId
Returns Assets associated with the specified PackagingGroup.








Class com.amazonaws.services.mediapackagevod.model.ListAssetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assets
List<E> assets
A list of MediaPackage VOD Asset resources.


nextToken
String nextToken
A token that can be used to resume pagination from the end of the collection.








Class com.amazonaws.services.mediapackagevod.model.ListPackagingConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults
Upper bound on number of records to return.


nextToken
String nextToken
A token used to resume pagination from the end of a previous request.


packagingGroupId
String packagingGroupId
Returns MediaPackage VOD PackagingConfigurations associated with the specified PackagingGroup.








Class com.amazonaws.services.mediapackagevod.model.ListPackagingConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
A token that can be used to resume pagination from the end of the collection.


packagingConfigurations
List<E> packagingConfigurations
A list of MediaPackage VOD PackagingConfiguration resources.








Class com.amazonaws.services.mediapackagevod.model.ListPackagingGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults
Upper bound on number of records to return.


nextToken
String nextToken
A token used to resume pagination from the end of a previous request.








Class com.amazonaws.services.mediapackagevod.model.ListPackagingGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken
A token that can be used to resume pagination from the end of the collection.


packagingGroups
List<E> packagingGroups
A list of MediaPackage VOD PackagingGroup resources.








Class com.amazonaws.services.mediapackagevod.model.MssEncryption extends Object implements Serializable


Serialized Fields


spekeKeyProvider
SpekeKeyProvider spekeKeyProvider








Class com.amazonaws.services.mediapackagevod.model.MssManifest extends Object implements Serializable


Serialized Fields


manifestName
String manifestName
An optional string to include in the name of the manifest.


streamSelection
StreamSelection streamSelection








Class com.amazonaws.services.mediapackagevod.model.MssPackage extends Object implements Serializable


Serialized Fields


encryption
MssEncryption encryption


mssManifests
List<E> mssManifests
A list of MSS manifest configurations.


segmentDurationSeconds
Integer segmentDurationSeconds
The duration (in seconds) of each segment.








Class com.amazonaws.services.mediapackagevod.model.NotFoundException extends AWSMediaPackageVodException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackagevod.model.PackagingConfiguration extends Object implements Serializable


Serialized Fields


arn
String arn
The ARN of the PackagingConfiguration.


cmafPackage
CmafPackage cmafPackage


dashPackage
DashPackage dashPackage


hlsPackage
HlsPackage hlsPackage


id
String id
The ID of the PackagingConfiguration.


mssPackage
MssPackage mssPackage


packagingGroupId
String packagingGroupId
The ID of a PackagingGroup.








Class com.amazonaws.services.mediapackagevod.model.PackagingGroup extends Object implements Serializable


Serialized Fields


arn
String arn
The ARN of the PackagingGroup.


domainName
String domainName
The fully qualified domain name for Assets in the PackagingGroup.


id
String id
The ID of the PackagingGroup.








Class com.amazonaws.services.mediapackagevod.model.ServiceUnavailableException extends AWSMediaPackageVodException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackagevod.model.SpekeKeyProvider extends Object implements Serializable


Serialized Fields


roleArn
String roleArn
An Amazon Resource Name (ARN) of an IAM role that AWS Elemental MediaPackage will assume when accessing the key
 provider service.


systemIds
List<E> systemIds
The system IDs to include in key requests.


url
String url
The URL of the external key provider service.








Class com.amazonaws.services.mediapackagevod.model.StreamSelection extends Object implements Serializable


Serialized Fields


maxVideoBitsPerSecond
Integer maxVideoBitsPerSecond
The maximum video bitrate (bps) to include in output.


minVideoBitsPerSecond
Integer minVideoBitsPerSecond
The minimum video bitrate (bps) to include in output.


streamOrder
String streamOrder
A directive that determines the order of streams in the output.








Class com.amazonaws.services.mediapackagevod.model.TooManyRequestsException extends AWSMediaPackageVodException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediapackagevod.model.UnprocessableEntityException extends AWSMediaPackageVodException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.mediastore.model




Class com.amazonaws.services.mediastore.model.AWSMediaStoreException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


endpoint
String endpoint

 The DNS endpoint of the container. Use the endpoint to identify the specific container when sending requests to
 the data plane. The service assigns this value when the container is created. Once the value has been assigned,
 it does not change.
 


creationTime
Date creationTime

 Unix timestamp.
 


aRN
String aRN

 The Amazon Resource Name (ARN) of the container. The ARN has the following format:
 
 
 arn:aws:<region>:<account that owns this container>:container/<name of container>
 
 
 For example: arn:aws:mediastore:us-west-2:111122223333:container/movies
 


name
String name

 The name of the container.
 


status
String status

 The status of container creation or deletion. The status is one of the following: CREATING,
 ACTIVE, or DELETING. While the service is creating the container, the status is
 CREATING. When the endpoint is available, the status changes to ACTIVE.
 


accessLoggingEnabled
Boolean accessLoggingEnabled

 The state of access logging on the container. This value is false by default, indicating that AWS
 Elemental MediaStore does not send access logs to Amazon CloudWatch Logs. When you enable access logging on the
 container, MediaStore changes this value to true, indicating that the service delivers access logs
 for objects stored in that container to CloudWatch Logs.
 








Class com.amazonaws.services.mediastore.model.ContainerInUseException extends AWSMediaStoreException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediastore.model.ContainerNotFoundException extends AWSMediaStoreException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediastore.model.CorsPolicyNotFoundException extends AWSMediaStoreException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediastore.model.CorsRule extends Object implements Serializable


Serialized Fields


allowedOrigins
List<E> allowedOrigins

 One or more response headers that you want users to be able to access from their applications (for example, from
 a JavaScript XMLHttpRequest object).
 
 
 Each CORS rule must have at least one AllowedOrigins element. The string value can include only one
 wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard
 character to allow cross-origin access for all origins.
 


allowedMethods
List<E> allowedMethods

 Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.
 
 
 Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins element.
 


allowedHeaders
List<E> allowedHeaders

 Specifies which headers are allowed in a preflight OPTIONS request through the
 Access-Control-Request-Headers header. Each header name that is specified in
 Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that
 were requested are sent back.
 
 
 This element can contain only one wildcard character (*).
 


maxAgeSeconds
Integer maxAgeSeconds

 The time in seconds that your browser caches the preflight response for the specified resource.
 
 
 A CORS rule can have only one MaxAgeSeconds element.
 


exposeHeaders
List<E> exposeHeaders

 One or more headers in the response that you want users to be able to access from their applications (for
 example, from a JavaScript XMLHttpRequest object).
 
 
 This element is optional for each rule.
 








Class com.amazonaws.services.mediastore.model.CreateContainerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name for the container. The name must be from 1 to 255 characters. Container names must be unique to your AWS
 account within a specific region. As an example, you could create a container named movies in every
 region, as long as you don’t have an existing container with that name.
 


tags
List<E> tags

 An array of key:value pairs that you define. These values can be anything that you want. Typically, the tag key
 represents a category (such as "environment") and the tag value represents a specific value within that category
 (such as "test," "development," or "production"). You can add up to 50 tags to each container. For more
 information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.
 








Class com.amazonaws.services.mediastore.model.CreateContainerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


container
Container container

 ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The ARN has the following format:
 arn:aws:<region>:<account that owns this container>:container/<name of container>. For example:
 arn:aws:mediastore:us-west-2:111122223333:container/movies
 
 
 ContainerName: The container name as specified in the request.
 
 
 CreationTime: Unix time stamp.
 
 
 Status: The status of container creation or deletion. The status is one of the following: CREATING,
 ACTIVE, or DELETING. While the service is creating the container, the status is
 CREATING. When an endpoint is available, the status changes to ACTIVE.
 
 
 The return value does not include the container's endpoint. To make downstream requests, you must obtain this
 value by using DescribeContainer or ListContainers.
 








Class com.amazonaws.services.mediastore.model.DeleteContainerPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container that holds the policy.
 








Class com.amazonaws.services.mediastore.model.DeleteContainerPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediastore.model.DeleteContainerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container to delete.
 








Class com.amazonaws.services.mediastore.model.DeleteContainerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediastore.model.DeleteCorsPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container to remove the policy from.
 








Class com.amazonaws.services.mediastore.model.DeleteCorsPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediastore.model.DeleteLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container that holds the object lifecycle policy.
 








Class com.amazonaws.services.mediastore.model.DeleteLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediastore.model.DescribeContainerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container to query.
 








Class com.amazonaws.services.mediastore.model.DescribeContainerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


container
Container container

 The name of the queried container.
 








Class com.amazonaws.services.mediastore.model.GetContainerPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container.
 








Class com.amazonaws.services.mediastore.model.GetContainerPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
String policy

 The contents of the access policy.
 








Class com.amazonaws.services.mediastore.model.GetCorsPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container that the policy is assigned to.
 








Class com.amazonaws.services.mediastore.model.GetCorsPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


corsPolicy
List<E> corsPolicy

 The CORS policy assigned to the container.
 








Class com.amazonaws.services.mediastore.model.GetLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container that the object lifecycle policy is assigned to.
 








Class com.amazonaws.services.mediastore.model.GetLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


lifecyclePolicy
String lifecyclePolicy

 The object lifecycle policy that is assigned to the container.
 








Class com.amazonaws.services.mediastore.model.InternalServerErrorException extends AWSMediaStoreException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediastore.model.LimitExceededException extends AWSMediaStoreException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediastore.model.ListContainersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 Only if you used MaxResults in the first command, enter the token (which was included in the
 previous response) to obtain the next set of containers. This token is included in a response only if there
 actually are more containers to list.
 


maxResults
Integer maxResults

 Enter the maximum number of containers in the response. Use from 1 to 255 characters.
 








Class com.amazonaws.services.mediastore.model.ListContainersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


containers
List<E> containers

 The names of the containers.
 


nextToken
String nextToken

 NextToken is the token to use in the next call to ListContainers. This token is
 returned only if you included the MaxResults tag in the original command, and only if there are
 still containers to return.
 








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


Serialized Fields


resource
String resource

 The Amazon Resource Name (ARN) for the container.
 








Class com.amazonaws.services.mediastore.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 An array of key:value pairs that are assigned to the container.
 








Class com.amazonaws.services.mediastore.model.PolicyNotFoundException extends AWSMediaStoreException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediastore.model.PutContainerPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container.
 


policy
String policy

 The contents of the policy, which includes the following:
 
 
 
 
 One Version tag
 
 
 
 
 One Statement tag that contains the standard tags for the policy.
 
 
 








Class com.amazonaws.services.mediastore.model.PutContainerPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediastore.model.PutCorsPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container that you want to assign the CORS policy to.
 


corsPolicy
List<E> corsPolicy

 The CORS policy to apply to the container.
 








Class com.amazonaws.services.mediastore.model.PutCorsPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediastore.model.PutLifecyclePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container that you want to assign the object lifecycle policy to.
 


lifecyclePolicy
String lifecyclePolicy

 The object lifecycle policy to apply to the container.
 








Class com.amazonaws.services.mediastore.model.PutLifecyclePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediastore.model.StartAccessLoggingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container that you want to start access logging on.
 








Class com.amazonaws.services.mediastore.model.StartAccessLoggingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediastore.model.StopAccessLoggingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


containerName
String containerName

 The name of the container that you want to stop access logging on.
 








Class com.amazonaws.services.mediastore.model.StopAccessLoggingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediastore.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such
 as "customer." Tag keys are case-sensitive.
 


value
String value

 Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a
 category, such as "companyA" or "companyB." Tag values are case-sensitive.
 








Class com.amazonaws.services.mediastore.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resource
String resource

 The Amazon Resource Name (ARN) for the container.
 


tags
List<E> tags

 An array of key:value pairs that you want to add to the container. You need to specify only the tags that you
 want to add or update. For example, suppose a container already has two tags (customer:CompanyA and
 priority:High). You want to change the priority tag and also add a third tag (type:Contract). For TagResource,
 you specify the following tags: priority:Medium, type:Contract. The result is that your container has three tags:
 customer:CompanyA, priority:Medium, and type:Contract.
 








Class com.amazonaws.services.mediastore.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediastore.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resource
String resource

 The Amazon Resource Name (ARN) for the container.
 


tagKeys
List<E> tagKeys

 A comma-separated list of keys for tags that you want to remove from the container. For example, if your
 container has two tags (customer:CompanyA and priority:High) and you want to remove one of the tags
 (priority:High), you specify the key for the tag that you want to remove (priority).
 








Class com.amazonaws.services.mediastore.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.mediastoredata.model




Class com.amazonaws.services.mediastoredata.model.AWSMediaStoreDataException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediastoredata.model.ContainerNotFoundException extends AWSMediaStoreDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediastoredata.model.DeleteObjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


path
String path

 The path (including the file name) where the object is stored in the container. Format: <folder
 name>/<folder name>/<file name>
 








Class com.amazonaws.services.mediastoredata.model.DeleteObjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediastoredata.model.DescribeObjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


path
String path

 The path (including the file name) where the object is stored in the container. Format: <folder
 name>/<folder name>/<file name>
 








Class com.amazonaws.services.mediastoredata.model.DescribeObjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eTag
String eTag

 The ETag that represents a unique instance of the object.
 


contentType
String contentType

 The content type of the object.
 


contentLength
Long contentLength

 The length of the object in bytes.
 


cacheControl
String cacheControl

 An optional CacheControl header that allows the caller to control the object's cache behavior.
 Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
 
 
 Headers with a custom user-defined value are also accepted.
 


lastModified
Date lastModified

 The date and time that the object was last modified.
 








Class com.amazonaws.services.mediastoredata.model.GetObjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


path
String path

 The path (including the file name) where the object is stored in the container. Format: <folder
 name>/<folder name>/<file name>
 
 
 For example, to upload the file mlaw.avi to the folder path premium\canada in the
 container movies, enter the path premium/canada/mlaw.avi.
 
 
 Do not include the container name in this path.
 
 
 If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an
 existing premium/usa subfolder. If you specify premium/canada, the service creates a
 canada subfolder in the premium folder. You then have two subfolders, usa
 and canada, in the premium folder.
 
 
 There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental
 MediaStore.
 
 
 For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.
 
 
 The file name is the name that is assigned to the file that you upload. The file can have the same name inside
 and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an
 extension.
 


range
String range

 The range bytes of an object to retrieve. For more information about the Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. AWS Elemental MediaStore ignores this
 header for partially uploaded objects that have streaming upload availability.
 








Class com.amazonaws.services.mediastoredata.model.GetObjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


body
InputStream body

 The bytes of the object.
 


cacheControl
String cacheControl

 An optional CacheControl header that allows the caller to control the object's cache behavior.
 Headers can be passed in as specified in the HTTP spec at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
 
 
 Headers with a custom user-defined value are also accepted.
 


contentRange
String contentRange

 The range of bytes to retrieve.
 


contentLength
Long contentLength

 The length of the object in bytes.
 


contentType
String contentType

 The content type of the object.
 


eTag
String eTag

 The ETag that represents a unique instance of the object.
 


lastModified
Date lastModified

 The date and time that the object was last modified.
 


statusCode
Integer statusCode

 The HTML status code of the request. Status codes ranging from 200 to 299 indicate success. All other status
 codes indicate the type of error that occurred.
 








Class com.amazonaws.services.mediastoredata.model.InternalServerErrorException extends AWSMediaStoreDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediastoredata.model.Item extends Object implements Serializable


Serialized Fields


name
String name

 The name of the item.
 


type
String type

 The item type (folder or object).
 


eTag
String eTag

 The ETag that represents a unique instance of the item.
 


lastModified
Date lastModified

 The date and time that the item was last modified.
 


contentType
String contentType

 The content type of the item.
 


contentLength
Long contentLength

 The length of the item in bytes.
 








Class com.amazonaws.services.mediastoredata.model.ListItemsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


path
String path

 The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file
 name>
 


maxResults
Integer maxResults

 The maximum number of results to return per API request. For example, you submit a ListItems request
 with MaxResults set at 500. Although 2,000 items match your request, the service returns no more
 than the first 500 items. (The service also returns a NextToken value that you can use to fetch the
 next batch of results.) The service might return fewer results than the MaxResults value.
 
 
 If MaxResults is not included in the request, the service defaults to pagination with a maximum of
 1,000 results per page.
 


nextToken
String nextToken

 The token that identifies which batch of results that you want to see. For example, you submit a
 ListItems request with MaxResults set at 500. The service returns the first batch of
 results (up to 500) and a NextToken value. To see the next batch of results, you can submit the
 ListItems request a second time and specify the NextToken value.
 
 
 Tokens expire after 15 minutes.
 








Class com.amazonaws.services.mediastoredata.model.ListItemsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


items
List<E> items

 The metadata entries for the folders and objects at the requested path.
 


nextToken
String nextToken

 The token that can be used in a request to view the next set of results. For example, you submit a
 ListItems request that matches 2,000 items with MaxResults set at 500. The service
 returns the first batch of results (up to 500) and a NextToken value that can be used to fetch the
 next batch of results.
 








Class com.amazonaws.services.mediastoredata.model.ObjectNotFoundException extends AWSMediaStoreDataException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediastoredata.model.PutObjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


body
InputStream body

 The bytes to be stored.
 


path
String path

 The path (including the file name) where the object is stored in the container. Format: <folder
 name>/<folder name>/<file name>
 
 
 For example, to upload the file mlaw.avi to the folder path premium\canada in the
 container movies, enter the path premium/canada/mlaw.avi.
 
 
 Do not include the container name in this path.
 
 
 If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an
 existing premium/usa subfolder. If you specify premium/canada, the service creates a
 canada subfolder in the premium folder. You then have two subfolders, usa
 and canada, in the premium folder.
 
 
 There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental
 MediaStore.
 
 
 For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.
 
 
 The file name is the name that is assigned to the file that you upload. The file can have the same name inside
 and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an
 extension.
 


contentType
String contentType

 The content type of the object.
 


cacheControl
String cacheControl

 An optional CacheControl header that allows the caller to control the object's cache behavior.
 Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
 
 
 Headers with a custom user-defined value are also accepted.
 


storageClass
String storageClass

 Indicates the storage class of a Put request. Defaults to high-performance temporal storage class,
 and objects are persisted into durable storage shortly after being received.
 


uploadAvailability
String uploadAvailability

 Indicates the availability of an object while it is still uploading. If the value is set to
 streaming, the object is available for downloading after some initial buffering but before the
 object is uploaded completely. If the value is set to standard, the object is available for
 downloading only when it is uploaded completely. The default value for this header is standard.
 
 
 To use this header, you must also set the HTTP Transfer-Encoding header to chunked.
 








Class com.amazonaws.services.mediastoredata.model.PutObjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


contentSHA256
String contentSHA256

 The SHA256 digest of the object that is persisted.
 


eTag
String eTag

 Unique identifier of the object in the container.
 


storageClass
String storageClass

 The storage class where the object was persisted. The class should be “Temporal”.
 








Class com.amazonaws.services.mediastoredata.model.RequestedRangeNotSatisfiableException extends AWSMediaStoreDataException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.mediatailor.model




Class com.amazonaws.services.mediatailor.model.AWSMediaTailorException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediatailor.model.BadRequestException extends AWSMediaTailorException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mediatailor.model.CdnConfiguration extends Object implements Serializable


Serialized Fields


adSegmentUrlPrefix
String adSegmentUrlPrefix

 A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses
 Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a
 rule in your CDN for the following origin: ads.mediatailor.<region>.amazonaws.com. Then specify the rule's
 name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the
 source for ad segments.
 


contentSegmentUrlPrefix
String contentSegmentUrlPrefix

 A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to
 the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the
 rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your
 CDN as the source for content segments.
 








Class com.amazonaws.services.mediatailor.model.DashConfiguration extends Object implements Serializable


Serialized Fields


manifestEndpointPrefix
String manifestEndpointPrefix

 The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This
 setting is ignored in PUT operations.
 


mpdLocation
String mpdLocation

 The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates
 the Location tag with the URL for manifest update requests, to be used by players that don't support sticky
 redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are
 either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and
 EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
 


originManifestType
String originManifestType

 The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests
 or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD.
 The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
 








Class com.amazonaws.services.mediatailor.model.DashConfigurationForPut extends Object implements Serializable


Serialized Fields


mpdLocation
String mpdLocation

 The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates
 the Location tag with the URL for manifest update requests, to be used by players that don't support sticky
 redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are
 either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and
 EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.
 


originManifestType
String originManifestType

 The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests
 or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD.
 The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.
 








Class com.amazonaws.services.mediatailor.model.DeletePlaybackConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The identifier for the playback configuration.
 








Class com.amazonaws.services.mediatailor.model.DeletePlaybackConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediatailor.model.GetPlaybackConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The identifier for the playback configuration.
 








Class com.amazonaws.services.mediatailor.model.GetPlaybackConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


adDecisionServerUrl
String adDecisionServerUrl

 The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders
 for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as
 needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is
 25,000 characters.
 


cdnConfiguration
CdnConfiguration cdnConfiguration

 The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment
 management.
 


dashConfiguration
DashConfiguration dashConfiguration

 The configuration for DASH content.
 


hlsConfiguration
HlsConfiguration hlsConfiguration

 The configuration for HLS content.
 


livePreRollConfiguration
LivePreRollConfiguration livePreRollConfiguration

 The configuration for pre-roll ad insertion.
 


name
String name

 The identifier for the playback configuration.
 


playbackConfigurationArn
String playbackConfigurationArn

 The Amazon Resource Name (ARN) for the playback configuration.
 


playbackEndpointPrefix
String playbackEndpointPrefix

 The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use
 server-side reporting.
 


sessionInitializationEndpointPrefix
String sessionInitializationEndpointPrefix

 The URL that the player uses to initialize a session that uses client-side reporting.
 


slateAdUrl
String slateAdUrl

 The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental
 MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID
 playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated
 for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
 


tags
Map<K,V> tags

 The tags assigned to the playback configuration.
 


transcodeProfileName
String transcodeProfileName

 The name that is used to associate this playback configuration with a custom transcode profile. This overrides
 the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with
 the help of AWS Support.
 


videoContentSourceUrl
String videoContentSourceUrl

 The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.
 








Class com.amazonaws.services.mediatailor.model.HlsConfiguration extends Object implements Serializable


Serialized Fields


manifestEndpointPrefix
String manifestEndpointPrefix

 The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses
 server-side reporting.
 








Class com.amazonaws.services.mediatailor.model.ListPlaybackConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 Maximum number of records to return.
 


nextToken
String nextToken

 Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch
 the next page of results.
 








Class com.amazonaws.services.mediatailor.model.ListPlaybackConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


items
List<E> items

 Array of playback configurations. This might be all the available configurations or a subset, depending on the
 settings that you provide and the total number of configurations stored.
 


nextToken
String nextToken

 Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch
 the next page of results.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback
 configuration request.
 








Class com.amazonaws.services.mediatailor.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags

 A comma-separated list of tag key:value pairs. For example: { "Key1": "Value1", "Key2": "Value2" }
 








Class com.amazonaws.services.mediatailor.model.LivePreRollConfiguration extends Object implements Serializable


Serialized Fields


adDecisionServerUrl
String adDecisionServerUrl

 The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters
 and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and
 session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static
 VAST URL. The maximum length is 25,000 characters.
 


maxDurationSeconds
Integer maxDurationSeconds
The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to
 exceed this duration, regardless of the total duration of ads that the ADS returns.








Class com.amazonaws.services.mediatailor.model.PlaybackConfiguration extends Object implements Serializable


Serialized Fields


adDecisionServerUrl
String adDecisionServerUrl

 The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders
 for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as
 needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is
 25,000 characters.
 


cdnConfiguration
CdnConfiguration cdnConfiguration

 The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment
 management.
 


dashConfiguration
DashConfiguration dashConfiguration

 The configuration for DASH content.
 


hlsConfiguration
HlsConfiguration hlsConfiguration

 The configuration for HLS content.
 


name
String name

 The identifier for the playback configuration.
 


playbackConfigurationArn
String playbackConfigurationArn

 The Amazon Resource Name (ARN) for the playback configuration.
 


playbackEndpointPrefix
String playbackEndpointPrefix

 The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use
 server-side reporting.
 


sessionInitializationEndpointPrefix
String sessionInitializationEndpointPrefix

 The URL that the player uses to initialize a session that uses client-side reporting.
 


slateAdUrl
String slateAdUrl

 The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental
 MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID
 playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated
 for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
 


tags
Map<K,V> tags

 The tags assigned to the playback configuration.
 


transcodeProfileName
String transcodeProfileName

 The name that is used to associate this playback configuration with a custom transcode profile. This overrides
 the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with
 the help of AWS Support.
 


videoContentSourceUrl
String videoContentSourceUrl

 The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.
 








Class com.amazonaws.services.mediatailor.model.PutPlaybackConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


adDecisionServerUrl
String adDecisionServerUrl

 The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders
 for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as
 needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is
 25,000 characters.
 


cdnConfiguration
CdnConfiguration cdnConfiguration

 The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment
 management.
 


dashConfiguration
DashConfigurationForPut dashConfiguration

 The configuration for DASH content.
 


livePreRollConfiguration
LivePreRollConfiguration livePreRollConfiguration

 The configuration for pre-roll ad insertion.
 


name
String name

 The identifier for the playback configuration.
 


slateAdUrl
String slateAdUrl

 The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental
 MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID
 configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated
 for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
 


tags
Map<K,V> tags

 The tags to assign to the playback configuration.
 


transcodeProfileName
String transcodeProfileName

 The name that is used to associate this playback configuration with a custom transcode profile. This overrides
 the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with
 the help of AWS Support.
 


videoContentSourceUrl
String videoContentSourceUrl

 The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.
 








Class com.amazonaws.services.mediatailor.model.PutPlaybackConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


adDecisionServerUrl
String adDecisionServerUrl

 The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders
 for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as
 needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is
 25,000 characters.
 


cdnConfiguration
CdnConfiguration cdnConfiguration

 The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment
 management.
 


dashConfiguration
DashConfiguration dashConfiguration

 The configuration for DASH content.
 


hlsConfiguration
HlsConfiguration hlsConfiguration

 The configuration for HLS content.
 


livePreRollConfiguration
LivePreRollConfiguration livePreRollConfiguration

 The configuration for pre-roll ad insertion.
 


name
String name

 The identifier for the playback configuration.
 


playbackConfigurationArn
String playbackConfigurationArn

 The Amazon Resource Name (ARN) for the playback configuration.
 


playbackEndpointPrefix
String playbackEndpointPrefix

 The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use
 server-side reporting.
 


sessionInitializationEndpointPrefix
String sessionInitializationEndpointPrefix

 The URL that the player uses to initialize a session that uses client-side reporting.
 


slateAdUrl
String slateAdUrl

 The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental
 MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID
 playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated
 for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.
 


tags
Map<K,V> tags

 The tags assigned to the playback configuration.
 


transcodeProfileName
String transcodeProfileName

 The name that is used to associate this playback configuration with a custom transcode profile. This overrides
 the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with
 the help of AWS Support.
 


videoContentSourceUrl
String videoContentSourceUrl

 The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.
 








Class com.amazonaws.services.mediatailor.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback
 configuration request.
 


tags
Map<K,V> tags

 A comma-separated list of tag key:value pairs. For example: { "Key1": "Value1", "Key2": "Value2" }
 








Class com.amazonaws.services.mediatailor.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mediatailor.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback
 configuration request.
 


tagKeys
List<E> tagKeys

 A comma-separated list of the tag keys to remove from the playback configuration.
 








Class com.amazonaws.services.mediatailor.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Package com.amazonaws.services.migrationhub.model




Class com.amazonaws.services.migrationhub.model.AccessDeniedException extends AWSMigrationHubException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhub.model.ApplicationState extends Object implements Serializable


Serialized Fields


applicationId
String applicationId

 The configurationId from the Application Discovery Service that uniquely identifies an application.
 


applicationStatus
String applicationStatus

 The current status of an application.
 


lastUpdatedTime
Date lastUpdatedTime

 The timestamp when the application status was last updated.
 








Class com.amazonaws.services.migrationhub.model.AssociateCreatedArtifactRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


progressUpdateStream
String progressUpdateStream

 The name of the ProgressUpdateStream.
 


migrationTaskName
String migrationTaskName

 Unique identifier that references the migration task. Do not store personal data in this field.
 


createdArtifact
CreatedArtifact createdArtifact

 An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)
 


dryRun
Boolean dryRun

 Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
 to make the call.
 








Class com.amazonaws.services.migrationhub.model.AssociateCreatedArtifactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.migrationhub.model.AssociateDiscoveredResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


progressUpdateStream
String progressUpdateStream

 The name of the ProgressUpdateStream.
 


migrationTaskName
String migrationTaskName

 The identifier given to the MigrationTask. Do not store personal data in this field.
 


discoveredResource
DiscoveredResource discoveredResource

 Object representing a Resource.
 


dryRun
Boolean dryRun

 Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
 to make the call.
 








Class com.amazonaws.services.migrationhub.model.AssociateDiscoveredResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.migrationhub.model.AWSMigrationHubException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhub.model.CreatedArtifact extends Object implements Serializable


Serialized Fields


name
String name

 An ARN that uniquely identifies the result of a migration task.
 


description
String description

 A description that can be free-form text to record additional detail about the artifact for clarity or for later
 reference.
 








Class com.amazonaws.services.migrationhub.model.CreateProgressUpdateStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


progressUpdateStreamName
String progressUpdateStreamName

 The name of the ProgressUpdateStream. Do not store personal data in this field.
 


dryRun
Boolean dryRun

 Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
 to make the call.
 








Class com.amazonaws.services.migrationhub.model.CreateProgressUpdateStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.migrationhub.model.DeleteProgressUpdateStreamRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


progressUpdateStreamName
String progressUpdateStreamName

 The name of the ProgressUpdateStream. Do not store personal data in this field.
 


dryRun
Boolean dryRun

 Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
 to make the call.
 








Class com.amazonaws.services.migrationhub.model.DeleteProgressUpdateStreamResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.migrationhub.model.DescribeApplicationStateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationId
String applicationId

 The configurationId in Application Discovery Service that uniquely identifies the grouped application.
 








Class com.amazonaws.services.migrationhub.model.DescribeApplicationStateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationStatus
String applicationStatus

 Status of the application - Not Started, In-Progress, Complete.
 


lastUpdatedTime
Date lastUpdatedTime

 The timestamp when the application status was last updated.
 








Class com.amazonaws.services.migrationhub.model.DescribeMigrationTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


progressUpdateStream
String progressUpdateStream

 The name of the ProgressUpdateStream.
 


migrationTaskName
String migrationTaskName

 The identifier given to the MigrationTask. Do not store personal data in this field.
 








Class com.amazonaws.services.migrationhub.model.DescribeMigrationTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


migrationTask
MigrationTask migrationTask

 Object encapsulating information about the migration task.
 








Class com.amazonaws.services.migrationhub.model.DisassociateCreatedArtifactRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


progressUpdateStream
String progressUpdateStream

 The name of the ProgressUpdateStream.
 


migrationTaskName
String migrationTaskName

 Unique identifier that references the migration task to be disassociated with the artifact. Do not store
 personal data in this field.
 


createdArtifactName
String createdArtifactName

 An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)
 


dryRun
Boolean dryRun

 Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
 to make the call.
 








Class com.amazonaws.services.migrationhub.model.DisassociateCreatedArtifactResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.migrationhub.model.DisassociateDiscoveredResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


progressUpdateStream
String progressUpdateStream

 The name of the ProgressUpdateStream.
 


migrationTaskName
String migrationTaskName

 The identifier given to the MigrationTask. Do not store personal data in this field.
 


configurationId
String configurationId

 ConfigurationId of the Application Discovery Service resource to be disassociated.
 


dryRun
Boolean dryRun

 Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
 to make the call.
 








Class com.amazonaws.services.migrationhub.model.DisassociateDiscoveredResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.migrationhub.model.DiscoveredResource extends Object implements Serializable


Serialized Fields


configurationId
String configurationId

 The configurationId in Application Discovery Service that uniquely identifies the on-premise resource.
 


description
String description

 A description that can be free-form text to record additional detail about the discovered resource for clarity or
 later reference.
 








Class com.amazonaws.services.migrationhub.model.DryRunOperationException extends AWSMigrationHubException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhub.model.HomeRegionNotSetException extends AWSMigrationHubException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhub.model.ImportMigrationTaskRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


progressUpdateStream
String progressUpdateStream

 The name of the ProgressUpdateStream. >
 


migrationTaskName
String migrationTaskName

 Unique identifier that references the migration task. Do not store personal data in this field.
 


dryRun
Boolean dryRun

 Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
 to make the call.
 








Class com.amazonaws.services.migrationhub.model.ImportMigrationTaskResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.migrationhub.model.InternalServerErrorException extends AWSMigrationHubException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhub.model.InvalidInputException extends AWSMigrationHubException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhub.model.ListApplicationStatesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationIds
List<E> applicationIds

 The configurationIds from the Application Discovery Service that uniquely identifies your applications.
 


nextToken
String nextToken

 If a NextToken was returned by a previous call, there are more results available. To retrieve the
 next page of results, make the call again using the returned token in NextToken.
 


maxResults
Integer maxResults

 Maximum number of results to be returned per page.
 








Class com.amazonaws.services.migrationhub.model.ListApplicationStatesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


applicationStateList
List<E> applicationStateList

 A list of Applications that exist in Application Discovery Service.
 


nextToken
String nextToken

 If a NextToken was returned by a previous call, there are more results available. To retrieve the
 next page of results, make the call again using the returned token in NextToken.
 








Class com.amazonaws.services.migrationhub.model.ListCreatedArtifactsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


progressUpdateStream
String progressUpdateStream

 The name of the ProgressUpdateStream.
 


migrationTaskName
String migrationTaskName

 Unique identifier that references the migration task. Do not store personal data in this field.
 


nextToken
String nextToken

 If a NextToken was returned by a previous call, there are more results available. To retrieve the
 next page of results, make the call again using the returned token in NextToken.
 


maxResults
Integer maxResults

 Maximum number of results to be returned per page.
 








Class com.amazonaws.services.migrationhub.model.ListCreatedArtifactsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 If there are more created artifacts than the max result, return the next token to be passed to the next call as a
 bookmark of where to start from.
 


createdArtifactList
List<E> createdArtifactList

 List of created artifacts up to the maximum number of results specified in the request.
 








Class com.amazonaws.services.migrationhub.model.ListDiscoveredResourcesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


progressUpdateStream
String progressUpdateStream

 The name of the ProgressUpdateStream.
 


migrationTaskName
String migrationTaskName

 The name of the MigrationTask. Do not store personal data in this field.
 


nextToken
String nextToken

 If a NextToken was returned by a previous call, there are more results available. To retrieve the
 next page of results, make the call again using the returned token in NextToken.
 


maxResults
Integer maxResults

 The maximum number of results returned per page.
 








Class com.amazonaws.services.migrationhub.model.ListDiscoveredResourcesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 If there are more discovered resources than the max result, return the next token to be passed to the next call
 as a bookmark of where to start from.
 


discoveredResourceList
List<E> discoveredResourceList

 Returned list of discovered resources associated with the given MigrationTask.
 








Class com.amazonaws.services.migrationhub.model.ListMigrationTasksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If a NextToken was returned by a previous call, there are more results available. To retrieve the
 next page of results, make the call again using the returned token in NextToken.
 


maxResults
Integer maxResults

 Value to specify how many results are returned per page.
 


resourceName
String resourceName

 Filter migration tasks by discovered resource name.
 








Class com.amazonaws.services.migrationhub.model.ListMigrationTasksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken

 If there are more migration tasks than the max result, return the next token to be passed to the next call as a
 bookmark of where to start from.
 


migrationTaskSummaryList
List<E> migrationTaskSummaryList

 Lists the migration task's summary which includes: MigrationTaskName, ProgressPercent,
 ProgressUpdateStream, Status, and the UpdateDateTime for each task.
 








Class com.amazonaws.services.migrationhub.model.ListProgressUpdateStreamsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 If a NextToken was returned by a previous call, there are more results available. To retrieve the
 next page of results, make the call again using the returned token in NextToken.
 


maxResults
Integer maxResults

 Filter to limit the maximum number of results to list per page.
 








Class com.amazonaws.services.migrationhub.model.ListProgressUpdateStreamsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


progressUpdateStreamSummaryList
List<E> progressUpdateStreamSummaryList

 List of progress update streams up to the max number of results passed in the input.
 


nextToken
String nextToken

 If there are more streams created than the max result, return the next token to be passed to the next call as a
 bookmark of where to start from.
 








Class com.amazonaws.services.migrationhub.model.MigrationTask extends Object implements Serializable


Serialized Fields


progressUpdateStream
String progressUpdateStream

 A name that identifies the vendor of the migration tool being used.
 


migrationTaskName
String migrationTaskName

 Unique identifier that references the migration task. Do not store personal data in this field.
 


task
Task task

 Task object encapsulating task information.
 


updateDateTime
Date updateDateTime

 The timestamp when the task was gathered.
 


resourceAttributeList
List<E> resourceAttributeList

 Information about the resource that is being migrated. This data will be used to map the task to a resource in
 the Application Discovery Service repository.
 








Class com.amazonaws.services.migrationhub.model.MigrationTaskSummary extends Object implements Serializable


Serialized Fields


progressUpdateStream
String progressUpdateStream

 An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all
 updates made by the tool.
 


migrationTaskName
String migrationTaskName

 Unique identifier that references the migration task. Do not store personal data in this field.
 


status
String status

 Status of the task.
 


progressPercent
Integer progressPercent

 Indication of the percentage completion of the task.
 


statusDetail
String statusDetail

 Detail information of what is being done within the overall status state.
 


updateDateTime
Date updateDateTime

 The timestamp when the task was gathered.
 








Class com.amazonaws.services.migrationhub.model.NotifyApplicationStateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


applicationId
String applicationId

 The configurationId in Application Discovery Service that uniquely identifies the grouped application.
 


status
String status

 Status of the application - Not Started, In-Progress, Complete.
 


updateDateTime
Date updateDateTime

 The timestamp when the application state changed.
 


dryRun
Boolean dryRun

 Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
 to make the call.
 








Class com.amazonaws.services.migrationhub.model.NotifyApplicationStateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.migrationhub.model.NotifyMigrationTaskStateRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


progressUpdateStream
String progressUpdateStream

 The name of the ProgressUpdateStream.
 


migrationTaskName
String migrationTaskName

 Unique identifier that references the migration task. Do not store personal data in this field.
 


task
Task task

 Information about the task's progress and status.
 


updateDateTime
Date updateDateTime

 The timestamp when the task was gathered.
 


nextUpdateSeconds
Integer nextUpdateSeconds

 Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub
 does not receive an update within the specified interval, then the migration task will be considered stale.
 


dryRun
Boolean dryRun

 Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
 to make the call.
 








Class com.amazonaws.services.migrationhub.model.NotifyMigrationTaskStateResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.migrationhub.model.PolicyErrorException extends AWSMigrationHubException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhub.model.ProgressUpdateStreamSummary extends Object implements Serializable


Serialized Fields


progressUpdateStreamName
String progressUpdateStreamName

 The name of the ProgressUpdateStream. Do not store personal data in this field.
 








Class com.amazonaws.services.migrationhub.model.PutResourceAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


progressUpdateStream
String progressUpdateStream

 The name of the ProgressUpdateStream.
 


migrationTaskName
String migrationTaskName

 Unique identifier that references the migration task. Do not store personal data in this field.
 


resourceAttributeList
List<E> resourceAttributeList

 Information about the resource that is being migrated. This data will be used to map the task to a resource in
 the Application Discovery Service repository.
 
 
 
 Takes the object array of ResourceAttribute where the Type field is reserved for the
 following values:
 IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER
 where the identifying value can be a string up to 256 characters.
 
  
 
 
 
 If any "VM" related value is set for a ResourceAttribute object, it is required that
 VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all "VM"
 fields will be discarded and "VM" fields will not be used for matching the migration task to a server in
 Application Discovery Service repository. See the Example section below for a use case of specifying "VM" related values.
 
 
 
 
 If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in
 separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of
 matching.
 
 
 
 


dryRun
Boolean dryRun

 Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission
 to make the call.
 








Class com.amazonaws.services.migrationhub.model.PutResourceAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.migrationhub.model.ResourceAttribute extends Object implements Serializable


Serialized Fields


type
String type

 Type of resource.
 


value
String value

 Value of the resource type.
 








Class com.amazonaws.services.migrationhub.model.ResourceNotFoundException extends AWSMigrationHubException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhub.model.ServiceUnavailableException extends AWSMigrationHubException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


status
String status

 Status of the task - Not Started, In-Progress, Complete.
 


statusDetail
String statusDetail

 Details of task status as notified by a migration tool. A tool might use this field to provide clarifying
 information about the status that is unique to that tool or that explains an error state.
 


progressPercent
Integer progressPercent

 Indication of the percentage completion of the task.
 








Class com.amazonaws.services.migrationhub.model.UnauthorizedOperationException extends AWSMigrationHubException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.migrationhubconfig.model




Class com.amazonaws.services.migrationhubconfig.model.AccessDeniedException extends AWSMigrationHubConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhubconfig.model.AWSMigrationHubConfigException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhubconfig.model.CreateHomeRegionControlRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


homeRegion
String homeRegion

 The name of the home region of the calling account.
 


target
Target target

 The account for which this command sets up a home region control. The Target is always of type
 ACCOUNT.
 


dryRun
Boolean dryRun

 Optional Boolean flag to indicate whether any effect should take place. It tests whether the caller has
 permission to make the call.
 








Class com.amazonaws.services.migrationhubconfig.model.CreateHomeRegionControlResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


homeRegionControl
HomeRegionControl homeRegionControl

 This object is the HomeRegionControl object that's returned by a successful call to
 CreateHomeRegionControl.
 








Class com.amazonaws.services.migrationhubconfig.model.DescribeHomeRegionControlsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


controlId
String controlId

 The ControlID is a unique identifier string of your HomeRegionControl object.
 


homeRegion
String homeRegion

 The name of the home region you'd like to view.
 


target
Target target

 The target parameter specifies the identifier to which the home region is applied, which is always of type
 ACCOUNT. It applies the home region to the current ACCOUNT.
 


maxResults
Integer maxResults

 The maximum number of filtering results to display per page.
 


nextToken
String nextToken

 If a NextToken was returned by a previous call, more results are available. To retrieve the next
 page of results, make the call again using the returned token in NextToken.
 








Class com.amazonaws.services.migrationhubconfig.model.DescribeHomeRegionControlsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


homeRegionControls
List<E> homeRegionControls

 An array that contains your HomeRegionControl objects.
 


nextToken
String nextToken

 If a NextToken was returned by a previous call, more results are available. To retrieve the next
 page of results, make the call again using the returned token in NextToken.
 








Class com.amazonaws.services.migrationhubconfig.model.DryRunOperationException extends AWSMigrationHubConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhubconfig.model.GetHomeRegionRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.migrationhubconfig.model.GetHomeRegionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


homeRegion
String homeRegion

 The name of the home region of the calling account.
 








Class com.amazonaws.services.migrationhubconfig.model.HomeRegionControl extends Object implements Serializable


Serialized Fields


controlId
String controlId

 A unique identifier that's generated for each home region control. It's always a string that begins with "hrc-"
 followed by 12 lowercase letters and numbers.
 


homeRegion
String homeRegion

 The AWS Region that's been set as home region. For example, "us-west-2" or "eu-central-1" are valid home regions.
 


target
Target target

 The target parameter specifies the identifier to which the home region is applied, which is always an
 ACCOUNT. It applies the home region to the current ACCOUNT.
 


requestedTime
Date requestedTime

 A timestamp representing the time when the customer called CreateHomeregionControl and set the home
 region for the account.
 








Class com.amazonaws.services.migrationhubconfig.model.InternalServerErrorException extends AWSMigrationHubConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhubconfig.model.InvalidInputException extends AWSMigrationHubConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhubconfig.model.ServiceUnavailableException extends AWSMigrationHubConfigException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.migrationhubconfig.model.Target extends Object implements Serializable


Serialized Fields


type
String type

 The target type is always an ACCOUNT.
 


id
String id

 The TargetID is a 12-character identifier of the ACCOUNT for which the control was
 created. (This must be the current account.)
 








Package com.amazonaws.services.mobile.model




Class com.amazonaws.services.mobile.model.AccountActionRequiredException extends AWSMobileException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mobile.model.AWSMobileException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mobile.model.BadRequestException extends AWSMobileException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mobile.model.BundleDetails extends Object implements Serializable


Serialized Fields


bundleId
String bundleId


title
String title


version
String version


description
String description


iconUrl
String iconUrl


availablePlatforms
List<E> availablePlatforms








Class com.amazonaws.services.mobile.model.CreateProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 Name of the project.
 


region
String region

 Default region where project resources should be created.
 


contents
ByteBuffer contents

 ZIP or YAML file which contains configuration settings to be used when creating the project. This may be the
 contents of the file downloaded from the URL provided in an export project operation.
 


snapshotId
String snapshotId

 Unique identifier for an exported snapshot of project configuration. This snapshot identifier is included in the
 share URL when a project is exported.
 








Class com.amazonaws.services.mobile.model.CreateProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


details
ProjectDetails details

 Detailed information about the created AWS Mobile Hub project.
 








Class com.amazonaws.services.mobile.model.DeleteProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectId
String projectId

 Unique project identifier.
 








Class com.amazonaws.services.mobile.model.DeleteProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deletedResources
List<E> deletedResources

 Resources which were deleted.
 


orphanedResources
List<E> orphanedResources

 Resources which were not deleted, due to a risk of losing potentially important data or files.
 








Class com.amazonaws.services.mobile.model.DescribeBundleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


bundleId
String bundleId

 Unique bundle identifier.
 








Class com.amazonaws.services.mobile.model.DescribeBundleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


details
BundleDetails details

 The details of the bundle.
 








Class com.amazonaws.services.mobile.model.DescribeProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectId
String projectId

 Unique project identifier.
 


syncFromResources
Boolean syncFromResources

 If set to true, causes AWS Mobile Hub to synchronize information from other services, e.g., update state of AWS
 CloudFormation stacks in the AWS Mobile Hub project.
 








Class com.amazonaws.services.mobile.model.DescribeProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


details
ProjectDetails details








Class com.amazonaws.services.mobile.model.ExportBundleRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


bundleId
String bundleId

 Unique bundle identifier.
 


projectId
String projectId

 Unique project identifier.
 


platform
String platform

 Developer desktop or target application platform.
 








Class com.amazonaws.services.mobile.model.ExportBundleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


downloadUrl
String downloadUrl

 URL which contains the custom-generated SDK and tool packages used to integrate the client mobile app or web app
 with the AWS resources created by the AWS Mobile Hub project.
 








Class com.amazonaws.services.mobile.model.ExportProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


projectId
String projectId

 Unique project identifier.
 








Class com.amazonaws.services.mobile.model.ExportProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


downloadUrl
String downloadUrl

 URL which can be used to download the exported project configuation file(s).
 


shareUrl
String shareUrl

 URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same
 configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that
 is created when this API is called. If you want to share additional changes to your project configuration, then
 you will need to create and share a new snapshot by calling this method again.
 


snapshotId
String snapshotId

 Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in
 the share URL.
 








Class com.amazonaws.services.mobile.model.InternalFailureException extends AWSMobileException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mobile.model.LimitExceededException extends AWSMobileException implements Serializable

serialVersionUID:
1L



Serialized Fields


retryAfterSeconds
String retryAfterSeconds








Class com.amazonaws.services.mobile.model.ListBundlesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 Maximum number of records to list in a single response.
 


nextToken
String nextToken

 Pagination token. Set to null to start listing bundles from start. If non-null pagination token is returned in a
 result, then pass its value in here in another request to list more bundles.
 








Class com.amazonaws.services.mobile.model.ListBundlesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


bundleList
List<E> bundleList

 A list of bundles.
 


nextToken
String nextToken

 Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to
 fetch more entries.
 








Class com.amazonaws.services.mobile.model.ListProjectsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults

 Maximum number of records to list in a single response.
 


nextToken
String nextToken

 Pagination token. Set to null to start listing projects from start. If non-null pagination token is returned in a
 result, then pass its value in here in another request to list more projects.
 








Class com.amazonaws.services.mobile.model.ListProjectsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


projects
List<E> projects


nextToken
String nextToken








Class com.amazonaws.services.mobile.model.NotFoundException extends AWSMobileException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mobile.model.ProjectDetails extends Object implements Serializable


Serialized Fields


name
String name


projectId
String projectId


region
String region


state
String state


createdDate
Date createdDate

 Date the project was created.
 


lastUpdatedDate
Date lastUpdatedDate

 Date of the last modification of the project.
 


consoleUrl
String consoleUrl

 Website URL for this project in the AWS Mobile Hub console.
 


resources
List<E> resources








Class com.amazonaws.services.mobile.model.ProjectSummary extends Object implements Serializable


Serialized Fields


name
String name

 Name of the project.
 


projectId
String projectId

 Unique project identifier.
 








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


Serialized Fields


type
String type


name
String name


arn
String arn


feature
String feature


attributes
Map<K,V> attributes








Class com.amazonaws.services.mobile.model.ServiceUnavailableException extends AWSMobileException implements Serializable

serialVersionUID:
1L



Serialized Fields


retryAfterSeconds
String retryAfterSeconds








Class com.amazonaws.services.mobile.model.TooManyRequestsException extends AWSMobileException implements Serializable

serialVersionUID:
1L



Serialized Fields


retryAfterSeconds
String retryAfterSeconds








Class com.amazonaws.services.mobile.model.UnauthorizedException extends AWSMobileException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mobile.model.UpdateProjectRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


contents
ByteBuffer contents

 ZIP or YAML file which contains project configuration to be updated. This should be the contents of the file
 downloaded from the URL provided in an export project operation.
 


projectId
String projectId

 Unique project identifier.
 








Class com.amazonaws.services.mobile.model.UpdateProjectResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


details
ProjectDetails details

 Detailed information about the updated AWS Mobile Hub project.
 








Package com.amazonaws.services.mq.model




Class com.amazonaws.services.mq.model.AmazonMQException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


name
String name
Id for the availability zone.








Class com.amazonaws.services.mq.model.BadRequestException extends AmazonMQException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorAttribute
String errorAttribute
The attribute which caused the error.








Class com.amazonaws.services.mq.model.BrokerEngineType extends Object implements Serializable


Serialized Fields


engineType
String engineType
The type of broker engine.


engineVersions
List<E> engineVersions
The list of engine versions.








Class com.amazonaws.services.mq.model.BrokerInstance extends Object implements Serializable


Serialized Fields


consoleURL
String consoleURL
The URL of the broker's ActiveMQ Web Console.


endpoints
List<E> endpoints
The broker's wire-level protocol endpoints.


ipAddress
String ipAddress
The IP address of the Elastic Network Interface (ENI) attached to the broker.








Class com.amazonaws.services.mq.model.BrokerInstanceOption extends Object implements Serializable


Serialized Fields


availabilityZones
List<E> availabilityZones
The list of available az.


engineType
String engineType
The type of broker engine.


hostInstanceType
String hostInstanceType
The type of broker instance.


storageType
String storageType
The broker's storage type.


supportedDeploymentModes
List<E> supportedDeploymentModes
The list of supported deployment modes.


supportedEngineVersions
List<E> supportedEngineVersions
The list of supported engine versions.








Class com.amazonaws.services.mq.model.BrokerSummary extends Object implements Serializable


Serialized Fields


brokerArn
String brokerArn
The Amazon Resource Name (ARN) of the broker.


brokerId
String brokerId
The unique ID that Amazon MQ generates for the broker.


brokerName
String brokerName
The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only
 letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or
 special characters.


brokerState
String brokerState
The status of the broker.


created
Date created
The time when the broker was created.


deploymentMode
String deploymentMode
Required. The deployment mode of the broker.


hostInstanceType
String hostInstanceType
The broker's instance type.








Class com.amazonaws.services.mq.model.Configuration extends Object implements Serializable


Serialized Fields


arn
String arn
Required. The ARN of the configuration.


created
Date created
Required. The date and time of the configuration revision.


description
String description
Required. The description of the configuration.


engineType
String engineType
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.


engineVersion
String engineVersion
Required. The version of the broker engine. For a list of supported engine versions, see
 https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html


id
String id
Required. The unique ID that Amazon MQ generates for the configuration.


latestRevision
ConfigurationRevision latestRevision
Required. The latest revision of the configuration.


name
String name
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods,
 underscores, and tildes (- . _ ~). This value must be 1-150 characters long.


tags
Map<K,V> tags
The list of all tags associated with this configuration.








Class com.amazonaws.services.mq.model.ConfigurationId extends Object implements Serializable


Serialized Fields


id
String id
Required. The unique ID that Amazon MQ generates for the configuration.


revision
Integer revision
The revision number of the configuration.








Class com.amazonaws.services.mq.model.ConfigurationRevision extends Object implements Serializable


Serialized Fields


created
Date created
Required. The date and time of the configuration revision.


description
String description
The description of the configuration revision.


revision
Integer revision
Required. The revision number of the configuration.








Class com.amazonaws.services.mq.model.Configurations extends Object implements Serializable


Serialized Fields


current
ConfigurationId current
The current configuration of the broker.


history
List<E> history
The history of configurations applied to the broker.


pending
ConfigurationId pending
The pending configuration of the broker.








Class com.amazonaws.services.mq.model.ConflictException extends AmazonMQException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorAttribute
String errorAttribute
The attribute which caused the error.








Class com.amazonaws.services.mq.model.CreateBrokerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The
 automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.


brokerName
String brokerName
Required. The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must
 contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard
 characters, or special characters.


configuration
ConfigurationId configuration
A list of information about the configuration.


creatorRequestId
String creatorRequestId
The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action.
 Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the
 creatorRequestId if your application doesn't require idempotency.


deploymentMode
String deploymentMode
Required. The deployment mode of the broker.


encryptionOptions
EncryptionOptions encryptionOptions
Encryption options for the broker.


engineType
String engineType
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.


engineVersion
String engineVersion
Required. The version of the broker engine. For a list of supported engine versions, see
 https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html


hostInstanceType
String hostInstanceType
Required. The broker's instance type.


logs
Logs logs
Enables Amazon CloudWatch logging for brokers.


maintenanceWindowStartTime
WeeklyStartTime maintenanceWindowStartTime
The parameters that determine the WeeklyStartTime.


publiclyAccessible
Boolean publiclyAccessible
Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.


securityGroups
List<E> securityGroups
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.


storageType
String storageType
The broker's storage type.


subnetIds
List<E> subnetIds
The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different
 Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An
 ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.


tags
Map<K,V> tags
Create tags when creating the broker.


users
List<E> users
Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can
 contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be
 2-100 characters long.








Class com.amazonaws.services.mq.model.CreateBrokerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


brokerArn
String brokerArn
The Amazon Resource Name (ARN) of the broker.


brokerId
String brokerId
The unique ID that Amazon MQ generates for the broker.








Class com.amazonaws.services.mq.model.CreateConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


engineType
String engineType
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.


engineVersion
String engineVersion
Required. The version of the broker engine. For a list of supported engine versions, see
 https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html


name
String name
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods,
 underscores, and tildes (- . _ ~). This value must be 1-150 characters long.


tags
Map<K,V> tags
Create tags when creating the configuration.








Class com.amazonaws.services.mq.model.CreateConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
Required. The Amazon Resource Name (ARN) of the configuration.


created
Date created
Required. The date and time of the configuration.


id
String id
Required. The unique ID that Amazon MQ generates for the configuration.


latestRevision
ConfigurationRevision latestRevision
The latest revision of the configuration.


name
String name
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods,
 underscores, and tildes (- . _ ~). This value must be 1-150 characters long.








Class com.amazonaws.services.mq.model.CreateTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn
The Amazon Resource Name (ARN) of the resource tag.


tags
Map<K,V> tags
The key-value pair for the resource tag.








Class com.amazonaws.services.mq.model.CreateTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mq.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


brokerId
String brokerId
The unique ID that Amazon MQ generates for the broker.


consoleAccess
Boolean consoleAccess
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.


groups
List<E> groups
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric
 characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.


password
String password
Required. The password of the user. This value must be at least 12 characters long, must contain at least 4
 unique characters, and must not contain commas.


username
String username
The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods,
 underscores, and tildes (- . _ ~). This value must be 2-100 characters long.








Class com.amazonaws.services.mq.model.CreateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mq.model.DeleteBrokerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


brokerId
String brokerId
The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only
 letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or
 special characters.








Class com.amazonaws.services.mq.model.DeleteBrokerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


brokerId
String brokerId
The unique ID that Amazon MQ generates for the broker.








Class com.amazonaws.services.mq.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn
The Amazon Resource Name (ARN) of the resource tag.


tagKeys
List<E> tagKeys
An array of tag keys to delete








Class com.amazonaws.services.mq.model.DeleteTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mq.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


brokerId
String brokerId
The unique ID that Amazon MQ generates for the broker.


username
String username
The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods,
 underscores, and tildes (- . _ ~). This value must be 2-100 characters long.








Class com.amazonaws.services.mq.model.DeleteUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mq.model.DescribeBrokerEngineTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


engineType
String engineType
Filter response by engine type.


maxResults
Integer maxResults
The maximum number of engine types that Amazon MQ can return per page (20 by default). This value must be an
 integer from 5 to 100.


nextToken
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
 nextToken empty.








Class com.amazonaws.services.mq.model.DescribeBrokerEngineTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


brokerEngineTypes
List<E> brokerEngineTypes
List of available engine types and versions.


maxResults
Integer maxResults
Required. The maximum number of engine types that can be returned per page (20 by default). This value must be an
 integer from 5 to 100.


nextToken
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
 nextToken empty.








Class com.amazonaws.services.mq.model.DescribeBrokerInstanceOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


engineType
String engineType
Filter response by engine type.


hostInstanceType
String hostInstanceType
Filter response by host instance type.


maxResults
Integer maxResults
The maximum number of instance options that Amazon MQ can return per page (20 by default). This value must be an
 integer from 5 to 100.


nextToken
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
 nextToken empty.


storageType
String storageType
Filter response by storage type.








Class com.amazonaws.services.mq.model.DescribeBrokerInstanceOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


brokerInstanceOptions
List<E> brokerInstanceOptions
List of available broker instance options.


maxResults
Integer maxResults
Required. The maximum number of instance options that can be returned per page (20 by default). This value must
 be an integer from 5 to 100.


nextToken
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
 nextToken empty.








Class com.amazonaws.services.mq.model.DescribeBrokerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


brokerId
String brokerId
The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only
 letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or
 special characters.








Class com.amazonaws.services.mq.model.DescribeBrokerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The
 automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot.


brokerArn
String brokerArn
The Amazon Resource Name (ARN) of the broker.


brokerId
String brokerId
The unique ID that Amazon MQ generates for the broker.


brokerInstances
List<E> brokerInstances
A list of information about allocated brokers.


brokerName
String brokerName
The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only
 letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or
 special characters.


brokerState
String brokerState
The status of the broker.


configurations
Configurations configurations
The list of all revisions for the specified configuration.


created
Date created
The time when the broker was created.


deploymentMode
String deploymentMode
Required. The deployment mode of the broker.


encryptionOptions
EncryptionOptions encryptionOptions
Encryption options for the broker.


engineType
String engineType
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.


engineVersion
String engineVersion
The version of the broker engine. For a list of supported engine versions, see
 https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html


hostInstanceType
String hostInstanceType
The broker's instance type.


logs
LogsSummary logs
The list of information about logs currently enabled and pending to be deployed for the specified broker.


maintenanceWindowStartTime
WeeklyStartTime maintenanceWindowStartTime
The parameters that determine the WeeklyStartTime.


pendingEngineVersion
String pendingEngineVersion
The version of the broker engine to upgrade to. For a list of supported engine versions, see
 https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html


pendingHostInstanceType
String pendingHostInstanceType
The host instance type of the broker to upgrade to. For a list of supported instance types, see
 https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types


pendingSecurityGroups
List<E> pendingSecurityGroups
The list of pending security groups to authorize connections to brokers.


publiclyAccessible
Boolean publiclyAccessible
Required. Enables connections from applications outside of the VPC that hosts the broker's subnets.


securityGroups
List<E> securityGroups
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.


storageType
String storageType
The broker's storage type.


subnetIds
List<E> subnetIds
The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different
 Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An
 ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets.


tags
Map<K,V> tags
The list of all tags associated with this broker.


users
List<E> users
The list of all ActiveMQ usernames for the specified broker.








Class com.amazonaws.services.mq.model.DescribeConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationId
String configurationId
The unique ID that Amazon MQ generates for the configuration.








Class com.amazonaws.services.mq.model.DescribeConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
Required. The ARN of the configuration.


created
Date created
Required. The date and time of the configuration revision.


description
String description
Required. The description of the configuration.


engineType
String engineType
Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ.


engineVersion
String engineVersion
Required. The version of the broker engine. For a list of supported engine versions, see
 https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html


id
String id
Required. The unique ID that Amazon MQ generates for the configuration.


latestRevision
ConfigurationRevision latestRevision
Required. The latest revision of the configuration.


name
String name
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods,
 underscores, and tildes (- . _ ~). This value must be 1-150 characters long.


tags
Map<K,V> tags
The list of all tags associated with this configuration.








Class com.amazonaws.services.mq.model.DescribeConfigurationRevisionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationId
String configurationId
The unique ID that Amazon MQ generates for the configuration.


configurationRevision
String configurationRevision
The revision of the configuration.








Class com.amazonaws.services.mq.model.DescribeConfigurationRevisionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurationId
String configurationId
Required. The unique ID that Amazon MQ generates for the configuration.


created
Date created
Required. The date and time of the configuration.


data
String data
Required. The base64-encoded XML configuration.


description
String description
The description of the configuration.








Class com.amazonaws.services.mq.model.DescribeUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


brokerId
String brokerId
The unique ID that Amazon MQ generates for the broker.


username
String username
The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods,
 underscores, and tildes (- . _ ~). This value must be 2-100 characters long.








Class com.amazonaws.services.mq.model.DescribeUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


brokerId
String brokerId
Required. The unique ID that Amazon MQ generates for the broker.


consoleAccess
Boolean consoleAccess
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.


groups
List<E> groups
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric
 characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.


pending
UserPendingChanges pending
The status of the changes pending for the ActiveMQ user.


username
String username
Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes,
 periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.








Class com.amazonaws.services.mq.model.EncryptionOptions extends Object implements Serializable


Serialized Fields


kmsKeyId
String kmsKeyId
The customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your
 data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data.


useAwsOwnedKey
Boolean useAwsOwnedKey
Enables the use of an AWS owned CMK using AWS Key Management Service (KMS).








Class com.amazonaws.services.mq.model.EngineVersion extends Object implements Serializable


Serialized Fields


name
String name
Id for the version.








Class com.amazonaws.services.mq.model.ForbiddenException extends AmazonMQException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorAttribute
String errorAttribute
The attribute which caused the error.








Class com.amazonaws.services.mq.model.InternalServerErrorException extends AmazonMQException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorAttribute
String errorAttribute
The attribute which caused the error.








Class com.amazonaws.services.mq.model.ListBrokersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults
The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer
 from 5 to 100.


nextToken
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
 nextToken empty.








Class com.amazonaws.services.mq.model.ListBrokersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


brokerSummaries
List<E> brokerSummaries
A list of information about all brokers.


nextToken
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
 nextToken empty.








Class com.amazonaws.services.mq.model.ListConfigurationRevisionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationId
String configurationId
The unique ID that Amazon MQ generates for the configuration.


maxResults
Integer maxResults
The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an
 integer from 5 to 100.


nextToken
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
 nextToken empty.








Class com.amazonaws.services.mq.model.ListConfigurationRevisionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurationId
String configurationId
The unique ID that Amazon MQ generates for the configuration.


maxResults
Integer maxResults
The maximum number of configuration revisions that can be returned per page (20 by default). This value must be
 an integer from 5 to 100.


nextToken
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
 nextToken empty.


revisions
List<E> revisions
The list of all revisions for the specified configuration.








Class com.amazonaws.services.mq.model.ListConfigurationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxResults
Integer maxResults
The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an
 integer from 5 to 100.


nextToken
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
 nextToken empty.








Class com.amazonaws.services.mq.model.ListConfigurationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


configurations
List<E> configurations
The list of all revisions for the specified configuration.


maxResults
Integer maxResults
The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an
 integer from 5 to 100.


nextToken
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
 nextToken empty.








Class com.amazonaws.services.mq.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn
The Amazon Resource Name (ARN) of the resource tag.








Class com.amazonaws.services.mq.model.ListTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
Map<K,V> tags
The key-value pair for the resource tag.








Class com.amazonaws.services.mq.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


brokerId
String brokerId
The unique ID that Amazon MQ generates for the broker.


maxResults
Integer maxResults
The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer
 from 5 to 100.


nextToken
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
 nextToken empty.








Class com.amazonaws.services.mq.model.ListUsersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


brokerId
String brokerId
Required. The unique ID that Amazon MQ generates for the broker.


maxResults
Integer maxResults
Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be
 an integer from 5 to 100.


nextToken
String nextToken
The token that specifies the next page of results Amazon MQ should return. To request the first page, leave
 nextToken empty.


users
List<E> users
Required. The list of all ActiveMQ usernames for the specified broker.








Class com.amazonaws.services.mq.model.Logs extends Object implements Serializable


Serialized Fields


audit
Boolean audit
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.


general
Boolean general
Enables general logging.








Class com.amazonaws.services.mq.model.LogsSummary extends Object implements Serializable


Serialized Fields


audit
Boolean audit
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.


auditLogGroup
String auditLogGroup
The location of the CloudWatch Logs log group where audit logs are sent.


general
Boolean general
Enables general logging.


generalLogGroup
String generalLogGroup
The location of the CloudWatch Logs log group where general logs are sent.


pending
PendingLogs pending
The list of information about logs pending to be deployed for the specified broker.








Class com.amazonaws.services.mq.model.NotFoundException extends AmazonMQException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorAttribute
String errorAttribute
The attribute which caused the error.








Class com.amazonaws.services.mq.model.PendingLogs extends Object implements Serializable


Serialized Fields


audit
Boolean audit
Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged.


general
Boolean general
Enables general logging.








Class com.amazonaws.services.mq.model.RebootBrokerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


brokerId
String brokerId
The unique ID that Amazon MQ generates for the broker.








Class com.amazonaws.services.mq.model.RebootBrokerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mq.model.SanitizationWarning extends Object implements Serializable


Serialized Fields


attributeName
String attributeName
The name of the XML attribute that has been sanitized.


elementName
String elementName
The name of the XML element that has been sanitized.


reason
String reason
Required. The reason for which the XML elements or attributes were sanitized.








Class com.amazonaws.services.mq.model.UnauthorizedException extends AmazonMQException implements Serializable

serialVersionUID:
1L



Serialized Fields


errorAttribute
String errorAttribute
The attribute which caused the error.








Class com.amazonaws.services.mq.model.UpdateBrokerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic
 upgrades occur during the maintenance window of the broker or after a manual broker reboot.


brokerId
String brokerId
The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only
 letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or
 special characters.


configuration
ConfigurationId configuration
A list of information about the configuration.


engineVersion
String engineVersion
The version of the broker engine. For a list of supported engine versions, see
 https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html


hostInstanceType
String hostInstanceType
The host instance type of the broker to upgrade to. For a list of supported instance types, see
 https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types


logs
Logs logs
Enables Amazon CloudWatch logging for brokers.


securityGroups
List<E> securityGroups
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.








Class com.amazonaws.services.mq.model.UpdateBrokerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
The new value of automatic upgrades to new minor version for brokers.


brokerId
String brokerId
Required. The unique ID that Amazon MQ generates for the broker.


configuration
ConfigurationId configuration
The ID of the updated configuration.


engineVersion
String engineVersion
The version of the broker engine to upgrade to. For a list of supported engine versions, see
 https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html


hostInstanceType
String hostInstanceType
The host instance type of the broker to upgrade to. For a list of supported instance types, see
 https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types


logs
Logs logs
The list of information about logs to be enabled for the specified broker.


securityGroups
List<E> securityGroups
The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.








Class com.amazonaws.services.mq.model.UpdateConfigurationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


configurationId
String configurationId
The unique ID that Amazon MQ generates for the configuration.


data
String data
Required. The base64-encoded XML configuration.


description
String description
The description of the configuration.








Class com.amazonaws.services.mq.model.UpdateConfigurationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


arn
String arn
Required. The Amazon Resource Name (ARN) of the configuration.


created
Date created
Required. The date and time of the configuration.


id
String id
Required. The unique ID that Amazon MQ generates for the configuration.


latestRevision
ConfigurationRevision latestRevision
The latest revision of the configuration.


name
String name
Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods,
 underscores, and tildes (- . _ ~). This value must be 1-150 characters long.


warnings
List<E> warnings
The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.








Class com.amazonaws.services.mq.model.UpdateUserRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


brokerId
String brokerId
The unique ID that Amazon MQ generates for the broker.


consoleAccess
Boolean consoleAccess
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.


groups
List<E> groups
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric
 characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.


password
String password
The password of the user. This value must be at least 12 characters long, must contain at least 4 unique
 characters, and must not contain commas.


username
String username
Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes,
 periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.








Class com.amazonaws.services.mq.model.UpdateUserResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mq.model.User extends Object implements Serializable


Serialized Fields


consoleAccess
Boolean consoleAccess
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.


groups
List<E> groups
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric
 characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.


password
String password
Required. The password of the ActiveMQ user. This value must be at least 12 characters long, must contain at
 least 4 unique characters, and must not contain commas.


username
String username
Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes,
 periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.








Class com.amazonaws.services.mq.model.UserPendingChanges extends Object implements Serializable


Serialized Fields


consoleAccess
Boolean consoleAccess
Enables access to the the ActiveMQ Web Console for the ActiveMQ user.


groups
List<E> groups
The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric
 characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.


pendingChange
String pendingChange
Required. The type of change pending for the ActiveMQ user.








Class com.amazonaws.services.mq.model.UserSummary extends Object implements Serializable


Serialized Fields


pendingChange
String pendingChange
The type of change pending for the ActiveMQ user.


username
String username
Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes,
 periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.








Class com.amazonaws.services.mq.model.WeeklyStartTime extends Object implements Serializable


Serialized Fields


dayOfWeek
String dayOfWeek
Required. The day of the week.


timeOfDay
String timeOfDay
Required. The time, in 24-hour format.


timeZone
String timeZone
The time zone, UTC by default, in either the Country/City format, or the UTC offset format.








Package com.amazonaws.services.mturk.model




Class com.amazonaws.services.mturk.model.AcceptQualificationRequestRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


qualificationRequestId
String qualificationRequestId

 The ID of the Qualification request, as returned by the GetQualificationRequests operation.
 


integerValue
Integer integerValue

 The value of the Qualification. You can omit this value if you are using the presence or absence of the
 Qualification as the basis for a HIT requirement.
 








Class com.amazonaws.services.mturk.model.AcceptQualificationRequestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.AmazonMTurkException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.mturk.model.ApproveAssignmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assignmentId
String assignmentId

 The ID of the assignment. The assignment must correspond to a HIT created by the Requester.
 


requesterFeedback
String requesterFeedback

 A message for the Worker, which the Worker can see in the Status section of the web site.
 


overrideRejection
Boolean overrideRejection

 A flag indicating that an assignment should be approved even if it was previously rejected. Defaults to
 False.
 








Class com.amazonaws.services.mturk.model.ApproveAssignmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.Assignment extends Object implements Serializable


Serialized Fields


assignmentId
String assignmentId

 A unique identifier for the assignment.
 


workerId
String workerId

 The ID of the Worker who accepted the HIT.
 


hITId
String hITId

 The ID of the HIT.
 


assignmentStatus
String assignmentStatus

 The status of the assignment.
 


autoApprovalTime
Date autoApprovalTime

 If results have been submitted, AutoApprovalTime is the date and time the results of the assignment results are
 considered Approved automatically if they have not already been explicitly approved or rejected by the Requester.
 This value is derived from the auto-approval delay specified by the Requester in the HIT. This value is omitted
 from the assignment if the Worker has not yet submitted results.
 


acceptTime
Date acceptTime

 The date and time the Worker accepted the assignment.
 


submitTime
Date submitTime

 If the Worker has submitted results, SubmitTime is the date and time the assignment was submitted. This value is
 omitted from the assignment if the Worker has not yet submitted results.
 


approvalTime
Date approvalTime

 If the Worker has submitted results and the Requester has approved the results, ApprovalTime is the date and time
 the Requester approved the results. This value is omitted from the assignment if the Requester has not yet
 approved the results.
 


rejectionTime
Date rejectionTime

 If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and
 time the Requester rejected the results.
 


deadline
Date deadline

 The date and time of the deadline for the assignment. This value is derived from the deadline specification for
 the HIT and the date and time the Worker accepted the HIT.
 


answer
String answer

 The Worker's answers submitted for the HIT contained in a QuestionFormAnswers document, if the Worker provides an
 answer. If the Worker does not provide any answers, Answer may contain a QuestionFormAnswers document, or Answer
 may be empty.
 


requesterFeedback
String requesterFeedback

 The feedback string included with the call to the ApproveAssignment operation or the RejectAssignment operation,
 if the Requester approved or rejected the assignment and specified feedback.
 








Class com.amazonaws.services.mturk.model.AssociateQualificationWithWorkerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


qualificationTypeId
String qualificationTypeId

 The ID of the Qualification type to use for the assigned Qualification.
 


workerId
String workerId

 The ID of the Worker to whom the Qualification is being assigned. Worker IDs are included with submitted HIT
 assignments and Qualification requests.
 


integerValue
Integer integerValue

 The value of the Qualification to assign.
 


sendNotification
Boolean sendNotification

 Specifies whether to send a notification email message to the Worker saying that the qualification was assigned
 to the Worker. Note: this is true by default.
 








Class com.amazonaws.services.mturk.model.AssociateQualificationWithWorkerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.BonusPayment extends Object implements Serializable


Serialized Fields


workerId
String workerId

 The ID of the Worker to whom the bonus was paid.
 


bonusAmount
String bonusAmount


assignmentId
String assignmentId

 The ID of the assignment associated with this bonus payment.
 


reason
String reason

 The Reason text given when the bonus was granted, if any.
 


grantTime
Date grantTime

 The date and time of when the bonus was granted.
 








Class com.amazonaws.services.mturk.model.CreateAdditionalAssignmentsForHITRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hITId
String hITId

 The ID of the HIT to extend.
 


numberOfAdditionalAssignments
Integer numberOfAdditionalAssignments

 The number of additional assignments to request for this HIT.
 


uniqueRequestToken
String uniqueRequestToken

 A unique identifier for this request, which allows you to retry the call on error without extending the HIT
 multiple times. This is useful in cases such as network timeouts where it is unclear whether or not the call
 succeeded on the server. If the extend HIT already exists in the system from a previous call using the same
 UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.
 








Class com.amazonaws.services.mturk.model.CreateAdditionalAssignmentsForHITResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.CreateHITRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


maxAssignments
Integer maxAssignments

 The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
 


autoApprovalDelayInSeconds
Long autoApprovalDelayInSeconds

 The number of seconds after an assignment for the HIT has been submitted, after which the assignment is
 considered Approved automatically unless the Requester explicitly rejects it.
 


lifetimeInSeconds
Long lifetimeInSeconds

 An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime
 of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT
 have been accepted.
 


assignmentDurationInSeconds
Long assignmentDurationInSeconds

 The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not
 complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is
 still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find
 and accept.
 


reward
String reward

 The amount of money the Requester will pay a Worker for successfully completing the HIT.
 


title
String title

 The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the
 Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.
 


keywords
String keywords

 One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find
 HITs.
 


description
String description

 A general description of the HIT. A description includes detailed information about the kind of task the HIT
 contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search
 results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate
 the HIT before accepting it.
 


question
String question

 The data the person completing the HIT uses to produce the results.
 
 
 Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data
 structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including
 whitespace.
 
 
 Either a Question parameter or a HITLayoutId parameter must be provided.
 


requesterAnnotation
String requesterAnnotation

 An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT
 for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application
 that corresponds with the HIT.
 
 
 The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown
 to the Worker, or any other Requester.
 
 
 The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are
 grouped.
 


qualificationRequirements
List<E> qualificationRequirements

 Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and
 ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT.
 Additionally, other actions can be restricted using the ActionsGuarded field on each
 QualificationRequirement structure.
 


uniqueRequestToken
String uniqueRequestToken

 A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs.
 This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the
 server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken,
 subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.
 
 
 
 Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours.
 Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.
 
 


assignmentReviewPolicy
ReviewPolicy assignmentReviewPolicy

 The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk
 to take various actions based on the policy.
 


hITReviewPolicy
ReviewPolicy hITReviewPolicy

 The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based
 on the policy.
 


hITLayoutId
String hITLayoutId

 The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT
 by providing those values as HITLayoutParameters.
 
 
 Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.
 


hITLayoutParameters
List<E> hITLayoutParameters

 If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter
 structure. For more information, see HITLayout.
 








Class com.amazonaws.services.mturk.model.CreateHITResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hIT
HIT hIT

 Contains the newly created HIT data. For a description of the HIT data structure as it appears in responses, see
 the HIT Data Structure documentation.
 








Class com.amazonaws.services.mturk.model.CreateHITTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


autoApprovalDelayInSeconds
Long autoApprovalDelayInSeconds

 The number of seconds after an assignment for the HIT has been submitted, after which the assignment is
 considered Approved automatically unless the Requester explicitly rejects it.
 


assignmentDurationInSeconds
Long assignmentDurationInSeconds

 The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not
 complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is
 still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find
 and accept.
 


reward
String reward

 The amount of money the Requester will pay a Worker for successfully completing the HIT.
 


title
String title

 The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the
 Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.
 


keywords
String keywords

 One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find
 HITs.
 


description
String description

 A general description of the HIT. A description includes detailed information about the kind of task the HIT
 contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search
 results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate
 the HIT before accepting it.
 


qualificationRequirements
List<E> qualificationRequirements

 Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and
 ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT.
 Additionally, other actions can be restricted using the ActionsGuarded field on each
 QualificationRequirement structure.
 








Class com.amazonaws.services.mturk.model.CreateHITTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hITTypeId
String hITTypeId

 The ID of the newly registered HIT type.
 








Class com.amazonaws.services.mturk.model.CreateHITWithHITTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hITTypeId
String hITTypeId

 The HIT type ID you want to create this HIT with.
 


maxAssignments
Integer maxAssignments

 The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
 


lifetimeInSeconds
Long lifetimeInSeconds

 An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime
 of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT
 have been accepted.
 


question
String question

 The data the person completing the HIT uses to produce the results.
 
 
 Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data
 structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including
 whitespace.
 
 
 Either a Question parameter or a HITLayoutId parameter must be provided.
 


requesterAnnotation
String requesterAnnotation

 An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT
 for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application
 that corresponds with the HIT.
 
 
 The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown
 to the Worker, or any other Requester.
 
 
 The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are
 grouped.
 


uniqueRequestToken
String uniqueRequestToken

 A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs.
 This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the
 server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken,
 subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.
 
 
 
 Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours.
 Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.
 
 


assignmentReviewPolicy
ReviewPolicy assignmentReviewPolicy

 The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk
 to take various actions based on the policy.
 


hITReviewPolicy
ReviewPolicy hITReviewPolicy

 The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based
 on the policy.
 


hITLayoutId
String hITLayoutId

 The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT
 by providing those values as HITLayoutParameters.
 
 
 Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.
 


hITLayoutParameters
List<E> hITLayoutParameters

 If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter
 structure. For more information, see HITLayout.
 








Class com.amazonaws.services.mturk.model.CreateHITWithHITTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hIT
HIT hIT

 Contains the newly created HIT data. For a description of the HIT data structure as it appears in responses, see
 the HIT Data Structure documentation.
 








Class com.amazonaws.services.mturk.model.CreateQualificationTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and
 to find the type using a Qualification type search. It must be unique across all of your Qualification types.
 


keywords
String keywords

 One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type
 make the type easier to find during a search.
 


description
String description

 A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is
 displayed when a Worker examines a Qualification type.
 


qualificationTypeStatus
String qualificationTypeStatus

 The initial status of the Qualification type.
 
 
 Constraints: Valid values are: Active | Inactive
 


retryDelayInSeconds
Long retryDelayInSeconds

 The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before
 the worker can retry the Qualification request.
 
 
 Constraints: None. If not specified, retries are disabled and Workers can request a Qualification of this type
 only once, even if the Worker has not been granted the Qualification. It is not possible to disable retries for a
 Qualification type after it has been created with retries enabled. If you want to disable retries, you must
 delete existing retry-enabled Qualification type and then create a new Qualification type with retries disabled.
 


test
String test

 The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type.
 If this parameter is specified, TestDurationInSeconds must also be specified.
 
 
 Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be
 specified if AutoGranted is true.
 
 
 Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.
 


answerKey
String answerKey

 The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data
 structure.
 
 
 Constraints: Must not be longer than 65535 bytes.
 
 
 Constraints: None. If not specified, you must process Qualification requests manually.
 


testDurationInSeconds
Long testDurationInSeconds

 The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker
 requests the Qualification.
 


autoGranted
Boolean autoGranted

 Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with
 a Qualification test.
 
 
 Constraints: If the Test parameter is specified, this parameter cannot be true.
 


autoGrantedValue
Integer autoGrantedValue

 The Qualification value to use for automatically granted Qualifications. This parameter is used only if the
 AutoGranted parameter is true.
 








Class com.amazonaws.services.mturk.model.CreateQualificationTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


qualificationType
QualificationType qualificationType

 The created Qualification type, returned as a QualificationType data structure.
 








Class com.amazonaws.services.mturk.model.CreateWorkerBlockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


workerId
String workerId

 The ID of the Worker to block.
 


reason
String reason

 A message explaining the reason for blocking the Worker. This parameter enables you to keep track of your
 Workers. The Worker does not see this message.
 








Class com.amazonaws.services.mturk.model.CreateWorkerBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.DeleteHITRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hITId
String hITId

 The ID of the HIT to be deleted.
 








Class com.amazonaws.services.mturk.model.DeleteHITResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.DeleteQualificationTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


qualificationTypeId
String qualificationTypeId

 The ID of the QualificationType to dispose.
 








Class com.amazonaws.services.mturk.model.DeleteQualificationTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.DeleteWorkerBlockRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


workerId
String workerId

 The ID of the Worker to unblock.
 


reason
String reason

 A message that explains the reason for unblocking the Worker. The Worker does not see this message.
 








Class com.amazonaws.services.mturk.model.DeleteWorkerBlockResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.DisassociateQualificationFromWorkerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


workerId
String workerId

 The ID of the Worker who possesses the Qualification to be revoked.
 


qualificationTypeId
String qualificationTypeId

 The ID of the Qualification type of the Qualification to be revoked.
 


reason
String reason

 A text message that explains why the Qualification was revoked. The user who had the Qualification sees this
 message.
 








Class com.amazonaws.services.mturk.model.DisassociateQualificationFromWorkerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.GetAccountBalanceRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.mturk.model.GetAccountBalanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


availableBalance
String availableBalance


onHoldBalance
String onHoldBalance








Class com.amazonaws.services.mturk.model.GetAssignmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assignmentId
String assignmentId

 The ID of the Assignment to be retrieved.
 








Class com.amazonaws.services.mturk.model.GetAssignmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


assignment
Assignment assignment

 The assignment. The response includes one Assignment element.
 


hIT
HIT hIT

 The HIT associated with this assignment. The response includes one HIT element.
 








Class com.amazonaws.services.mturk.model.GetFileUploadURLRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assignmentId
String assignmentId

 The ID of the assignment that contains the question with a FileUploadAnswer.
 


questionIdentifier
String questionIdentifier

 The identifier of the question with a FileUploadAnswer, as specified in the QuestionForm of the HIT.
 








Class com.amazonaws.services.mturk.model.GetFileUploadURLResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


fileUploadURL
String fileUploadURL

 A temporary URL for the file that the Worker uploaded for the answer.
 








Class com.amazonaws.services.mturk.model.GetHITRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hITId
String hITId

 The ID of the HIT to be retrieved.
 








Class com.amazonaws.services.mturk.model.GetHITResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hIT
HIT hIT

 Contains the requested HIT data.
 








Class com.amazonaws.services.mturk.model.GetQualificationScoreRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


qualificationTypeId
String qualificationTypeId

 The ID of the QualificationType.
 


workerId
String workerId

 The ID of the Worker whose Qualification is being updated.
 








Class com.amazonaws.services.mturk.model.GetQualificationScoreResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


qualification
Qualification qualification

 The Qualification data structure of the Qualification assigned to a user, including the Qualification type and
 the value (score).
 








Class com.amazonaws.services.mturk.model.GetQualificationTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


qualificationTypeId
String qualificationTypeId

 The ID of the QualificationType.
 








Class com.amazonaws.services.mturk.model.GetQualificationTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


qualificationType
QualificationType qualificationType

 The returned Qualification Type
 








Class com.amazonaws.services.mturk.model.HIT extends Object implements Serializable


Serialized Fields


hITId
String hITId

 A unique identifier for the HIT.
 


hITTypeId
String hITTypeId

 The ID of the HIT type of this HIT
 


hITGroupId
String hITGroupId

 The ID of the HIT Group of this HIT.
 


hITLayoutId
String hITLayoutId

 The ID of the HIT Layout of this HIT.
 


creationTime
Date creationTime

 The date and time the HIT was created.
 


title
String title

 The title of the HIT.
 


description
String description

 A general description of the HIT.
 


question
String question

 The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm,
 HTMLQuestion or an ExternalQuestion data structure.
 


keywords
String keywords

 One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of
 a HIT are more likely to have the HIT in the search results.
 


hITStatus
String hITStatus

 The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing |
 Disposed.
 


maxAssignments
Integer maxAssignments

 The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
 


reward
String reward


autoApprovalDelayInSeconds
Long autoApprovalDelayInSeconds

 The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are
 automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an
 assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.
 


expiration
Date expiration

 The date and time the HIT expires.
 


assignmentDurationInSeconds
Long assignmentDurationInSeconds

 The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
 


requesterAnnotation
String requesterAnnotation

 An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of
 the HIT.
 


qualificationRequirements
List<E> qualificationRequirements

 Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and
 ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT.
 Additionally, other actions can be restricted using the ActionsGuarded field on each
 QualificationRequirement structure.
 


hITReviewStatus
String hITReviewStatus

 Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate |
 ReviewedInappropriate.
 


numberOfAssignmentsPending
Integer numberOfAssignmentsPending

 The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not
 yet been submitted, returned, or abandoned.
 


numberOfAssignmentsAvailable
Integer numberOfAssignmentsAvailable

 The number of assignments for this HIT that are available for Workers to accept.
 


numberOfAssignmentsCompleted
Integer numberOfAssignmentsCompleted

 The number of assignments for this HIT that have been approved or rejected.
 








Class com.amazonaws.services.mturk.model.HITLayoutParameter extends Object implements Serializable


Serialized Fields


name
String name

 The name of the parameter in the HITLayout.
 


value
String value

 The value substituted for the parameter referenced in the HITLayout.
 








Class com.amazonaws.services.mturk.model.ListAssignmentsForHITRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hITId
String hITId

 The ID of the HIT.
 


nextToken
String nextToken

 Pagination token
 


maxResults
Integer maxResults


assignmentStatuses
List<E> assignmentStatuses

 The status of the assignments to return: Submitted | Approved | Rejected
 








Class com.amazonaws.services.mturk.model.ListAssignmentsForHITResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken


numResults
Integer numResults

 The number of assignments on the page in the filtered results list, equivalent to the number of assignments
 returned by this call.
 


assignments
List<E> assignments

 The collection of Assignment data structures returned by this call.
 








Class com.amazonaws.services.mturk.model.ListBonusPaymentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hITId
String hITId

 The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all
 assignments for the given HIT are returned. Either the HITId parameter or the AssignmentId parameter must be
 specified
 


assignmentId
String assignmentId

 The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for
 the given assignment are returned. Either the HITId parameter or the AssignmentId parameter must be specified
 


nextToken
String nextToken

 Pagination token
 


maxResults
Integer maxResults








Class com.amazonaws.services.mturk.model.ListBonusPaymentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


numResults
Integer numResults

 The number of bonus payments on this page in the filtered results list, equivalent to the number of bonus
 payments being returned by this call.
 


nextToken
String nextToken


bonusPayments
List<E> bonusPayments

 A successful request to the ListBonusPayments operation returns a list of BonusPayment objects.
 








Class com.amazonaws.services.mturk.model.ListHITsForQualificationTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


qualificationTypeId
String qualificationTypeId

 The ID of the Qualification type to use when querying HITs.
 


nextToken
String nextToken

 Pagination Token
 


maxResults
Integer maxResults

 Limit the number of results returned.
 








Class com.amazonaws.services.mturk.model.ListHITsForQualificationTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken


numResults
Integer numResults

 The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by
 this call.
 


hITs
List<E> hITs

 The list of HIT elements returned by the query.
 








Class com.amazonaws.services.mturk.model.ListHITsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 Pagination token
 


maxResults
Integer maxResults








Class com.amazonaws.services.mturk.model.ListHITsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken


numResults
Integer numResults

 The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by
 this call.
 


hITs
List<E> hITs

 The list of HIT elements returned by the query.
 








Class com.amazonaws.services.mturk.model.ListQualificationRequestsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


qualificationTypeId
String qualificationTypeId

 The ID of the QualificationType.
 


nextToken
String nextToken


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 








Class com.amazonaws.services.mturk.model.ListQualificationRequestsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


numResults
Integer numResults

 The number of Qualification requests on this page in the filtered results list, equivalent to the number of
 Qualification requests being returned by this call.
 


nextToken
String nextToken


qualificationRequests
List<E> qualificationRequests

 The Qualification request. The response includes one QualificationRequest element for each Qualification request
 returned by the query.
 








Class com.amazonaws.services.mturk.model.ListQualificationTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


query
String query

 A text query against all of the searchable attributes of Qualification types.
 


mustBeRequestable
Boolean mustBeRequestable

 Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such
 as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those
 assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types,
 including those managed by the system, are considered. Valid values are True | False.
 


mustBeOwnedByCaller
Boolean mustBeOwnedByCaller

 Specifies that only Qualification types that the Requester created are returned. If false, the operation returns
 all Qualification types.
 


nextToken
String nextToken


maxResults
Integer maxResults

 The maximum number of results to return in a single call.
 








Class com.amazonaws.services.mturk.model.ListQualificationTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


numResults
Integer numResults

 The number of Qualification types on this page in the filtered results list, equivalent to the number of types
 this operation returns.
 


nextToken
String nextToken


qualificationTypes
List<E> qualificationTypes

 The list of QualificationType elements returned by the query.
 








Class com.amazonaws.services.mturk.model.ListReviewableHITsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hITTypeId
String hITTypeId

 The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are
 considered
 


status
String status

 Can be either Reviewable or Reviewing. Reviewable is the default value.
 


nextToken
String nextToken

 Pagination Token
 


maxResults
Integer maxResults

 Limit the number of results returned.
 








Class com.amazonaws.services.mturk.model.ListReviewableHITsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken


numResults
Integer numResults

 The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by
 this call.
 


hITs
List<E> hITs

 The list of HIT elements returned by the query.
 








Class com.amazonaws.services.mturk.model.ListReviewPolicyResultsForHITRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hITId
String hITId

 The unique identifier of the HIT to retrieve review results for.
 


policyLevels
List<E> policyLevels

 The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to
 retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.
 


retrieveActions
Boolean retrieveActions

 Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their
 outcomes.
 


retrieveResults
Boolean retrieveResults

 Specify if the operation should retrieve a list of the results computed by the Review Policies.
 


nextToken
String nextToken

 Pagination token
 


maxResults
Integer maxResults

 Limit the number of results returned.
 








Class com.amazonaws.services.mturk.model.ListReviewPolicyResultsForHITResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


hITId
String hITId

 The HITId of the HIT for which results have been returned.
 


assignmentReviewPolicy
ReviewPolicy assignmentReviewPolicy

 The name of the Assignment-level Review Policy. This contains only the PolicyName element.
 


hITReviewPolicy
ReviewPolicy hITReviewPolicy

 The name of the HIT-level Review Policy. This contains only the PolicyName element.
 


assignmentReviewReport
ReviewReport assignmentReviewReport

 Contains both ReviewResult and ReviewAction elements for an Assignment.
 


hITReviewReport
ReviewReport hITReviewReport

 Contains both ReviewResult and ReviewAction elements for a particular HIT.
 


nextToken
String nextToken








Class com.amazonaws.services.mturk.model.ListWorkerBlocksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 Pagination token
 


maxResults
Integer maxResults








Class com.amazonaws.services.mturk.model.ListWorkerBlocksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken


numResults
Integer numResults

 The number of assignments on the page in the filtered results list, equivalent to the number of assignments
 returned by this call.
 


workerBlocks
List<E> workerBlocks

 The list of WorkerBlocks, containing the collection of Worker IDs and reasons for blocking.
 








Class com.amazonaws.services.mturk.model.ListWorkersWithQualificationTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


qualificationTypeId
String qualificationTypeId

 The ID of the Qualification type of the Qualifications to return.
 


status
String status

 The status of the Qualifications to return. Can be Granted | Revoked.
 


nextToken
String nextToken

 Pagination Token
 


maxResults
Integer maxResults

 Limit the number of results returned.
 








Class com.amazonaws.services.mturk.model.ListWorkersWithQualificationTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nextToken
String nextToken


numResults
Integer numResults

 The number of Qualifications on this page in the filtered results list, equivalent to the number of
 Qualifications being returned by this call.
 


qualifications
List<E> qualifications

 The list of Qualification elements returned by this call.
 








Class com.amazonaws.services.mturk.model.Locale extends Object implements Serializable


Serialized Fields


country
String country

 The country of the locale. Must be a valid ISO 3166 country code. For example, the code US refers to the United
 States of America.
 


subdivision
String subdivision

 The state or subdivision of the locale. A valid ISO 3166-2 subdivision code. For example, the code WA refers to
 the state of Washington.
 








Class com.amazonaws.services.mturk.model.NotificationSpecification extends Object implements Serializable


Serialized Fields


destination
String destination

 The target for notification messages. The Destination’s format is determined by the specified Transport:
 
 
 
 
 When Transport is Email, the Destination is your email address.
 
 
 
 
 When Transport is SQS, the Destination is your queue URL.
 
 
 
 
 When Transport is SNS, the Destination is the ARN of your topic.
 
 
 


transport
String transport

 The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
 


version
String version

 The version of the Notification API to use. Valid value is 2006-05-05.
 


eventTypes
List<E> eventTypes

 The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted |
 AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved |
 HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the
 SendTestEventNotification operation.
 








Class com.amazonaws.services.mturk.model.NotifyWorkersFailureStatus extends Object implements Serializable


Serialized Fields


notifyWorkersFailureCode
String notifyWorkersFailureCode

 Encoded value for the failure type.
 


notifyWorkersFailureMessage
String notifyWorkersFailureMessage

 A message detailing the reason the Worker could not be notified.
 


workerId
String workerId

 The ID of the Worker.
 








Class com.amazonaws.services.mturk.model.NotifyWorkersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subject
String subject

 The subject line of the email message to send. Can include up to 200 characters.
 


messageText
String messageText

 The text of the email message to send. Can include up to 4,096 characters
 


workerIds
List<E> workerIds

 A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.
 








Class com.amazonaws.services.mturk.model.NotifyWorkersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


notifyWorkersFailureStatuses
List<E> notifyWorkersFailureStatuses

 When MTurk sends notifications to the list of Workers, it returns back any failures it encounters in this list of
 NotifyWorkersFailureStatus objects.
 








Class com.amazonaws.services.mturk.model.ParameterMapEntry extends Object implements Serializable


Serialized Fields


key
String key

 The QuestionID from the HIT that is used to identify which question requires Mechanical Turk to score as part of
 the ScoreMyKnownAnswers/2011-09-01 Review Policy.
 


values
List<E> values

 The list of answers to the question specified in the MapEntry Key element. The Worker must match all values in
 order for the answer to be scored correctly.
 








Class com.amazonaws.services.mturk.model.PolicyParameter extends Object implements Serializable


Serialized Fields


key
String key

 Name of the parameter from the list of Review Polices.
 


values
List<E> values

 The list of values of the Parameter
 


mapEntries
List<E> mapEntries

 List of ParameterMapEntry objects.
 








Class com.amazonaws.services.mturk.model.Qualification extends Object implements Serializable


Serialized Fields


qualificationTypeId
String qualificationTypeId

 The ID of the Qualification type for the Qualification.
 


workerId
String workerId

 The ID of the Worker who possesses the Qualification.
 


grantTime
Date grantTime

 The date and time the Qualification was granted to the Worker. If the Worker's Qualification was revoked, and
 then re-granted based on a new Qualification request, GrantTime is the date and time of the last call to the
 AcceptQualificationRequest operation.
 


integerValue
Integer integerValue

 The value (score) of the Qualification, if the Qualification has an integer value.
 


localeValue
Locale localeValue


status
String status

 The status of the Qualification. Valid values are Granted | Revoked.
 








Class com.amazonaws.services.mturk.model.QualificationRequest extends Object implements Serializable


Serialized Fields


qualificationRequestId
String qualificationRequestId

 The ID of the Qualification request, a unique identifier generated when the request was submitted.
 


qualificationTypeId
String qualificationTypeId

 The ID of the Qualification type the Worker is requesting, as returned by the CreateQualificationType operation.
 


workerId
String workerId

 The ID of the Worker requesting the Qualification.
 


test
String test

 The contents of the Qualification test that was presented to the Worker, if the type has a test and the Worker
 has submitted answers. This value is identical to the QuestionForm associated with the Qualification type at the
 time the Worker requests the Qualification.
 


answer
String answer

 The Worker's answers for the Qualification type's test contained in a QuestionFormAnswers document, if the type
 has a test and the Worker has submitted answers. If the Worker does not provide any answers, Answer may be empty.
 


submitTime
Date submitTime

 The date and time the Qualification request had a status of Submitted. This is either the time the Worker
 submitted answers for a Qualification test, or the time the Worker requested the Qualification if the
 Qualification type does not have a test.
 








Class com.amazonaws.services.mturk.model.QualificationRequirement extends Object implements Serializable


Serialized Fields


qualificationTypeId
String qualificationTypeId

 The ID of the Qualification type for the requirement.
 


comparator
String comparator

 The kind of comparison to make against a Qualification's value. You can compare a Qualification's value to an
 IntegerValue to see if it is LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, or
 NotEqualTo the IntegerValue. You can compare it to a LocaleValue to see if it is EqualTo, or NotEqualTo the
 LocaleValue. You can check to see if the value is In or NotIn a set of IntegerValue or LocaleValue values.
 Lastly, a Qualification requirement can also test if a Qualification Exists or DoesNotExist in the user's
 profile, regardless of its value.
 


integerValues
List<E> integerValues

 The integer value to compare against the Qualification's value. IntegerValue must not be present if Comparator is
 Exists or DoesNotExist. IntegerValue can only be used if the Qualification type has an integer value; it cannot
 be used with the Worker_Locale QualificationType ID. When performing a set comparison by using the In or the
 NotIn comparator, you can use up to 15 IntegerValue elements in a QualificationRequirement data structure.
 


localeValues
List<E> localeValues

 The locale value to compare against the Qualification's value. The local value must be a valid ISO 3166 country
 code or supports ISO 3166-2 subdivisions. LocaleValue can only be used with a Worker_Locale QualificationType ID.
 LocaleValue can only be used with the EqualTo, NotEqualTo, In, and NotIn comparators. You must only use a single
 LocaleValue element when using the EqualTo or NotEqualTo comparators. When performing a set comparison by using
 the In or the NotIn comparator, you can use up to 30 LocaleValue elements in a QualificationRequirement data
 structure.
 


requiredToPreview
Boolean requiredToPreview
Deprecated. 

 DEPRECATED: Use the ActionsGuarded field instead. If RequiredToPreview is true, the question data
 for the HIT will not be shown when a Worker whose Qualifications do not meet this requirement tries to preview
 the HIT. That is, a Worker's Qualifications must meet all of the requirements for which RequiredToPreview is true
 in order to preview the HIT. If a Worker meets all of the requirements where RequiredToPreview is true (or if
 there are no such requirements), but does not meet all of the requirements for the HIT, the Worker will be
 allowed to preview the HIT's question data, but will not be allowed to accept and complete the HIT. The default
 is false. This should not be used in combination with the ActionsGuarded field.
 


actionsGuarded
String actionsGuarded

 Setting this attribute prevents Workers whose Qualifications do not meet this QualificationRequirement from
 taking the specified action. Valid arguments include "Accept" (Worker cannot accept the HIT, but can preview the
 HIT and see it in their search results), "PreviewAndAccept" (Worker cannot accept or preview the HIT, but can see
 the HIT in their search results), and "DiscoverPreviewAndAccept" (Worker cannot accept, preview, or see the HIT
 in their search results). It's possible for you to create a HIT with multiple QualificationRequirements (which
 can have different values for the ActionGuarded attribute). In this case, the Worker is only permitted to perform
 an action when they have met all QualificationRequirements guarding the action. The actions in the order of least
 restrictive to most restrictive are Discover, Preview and Accept. For example, if a Worker meets all
 QualificationRequirements that are set to DiscoverPreviewAndAccept, but do not meet all requirements that are set
 with PreviewAndAccept, then the Worker will be able to Discover, i.e. see the HIT in their search result, but
 will not be able to Preview or Accept the HIT. ActionsGuarded should not be used in combination with the
 RequiredToPreview field.
 








Class com.amazonaws.services.mturk.model.QualificationType extends Object implements Serializable


Serialized Fields


qualificationTypeId
String qualificationTypeId

 A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you
 call the CreateQualificationType operation.
 


creationTime
Date creationTime

 The date and time the Qualification type was created.
 


name
String name

 The name of the Qualification type. The type name is used to identify the type, and to find the type using a
 Qualification type search.
 


description
String description

 A long description for the Qualification type.
 


keywords
String keywords

 One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type
 easier to find using a search.
 


qualificationTypeStatus
String qualificationTypeStatus

 The status of the Qualification type. A Qualification type's status determines if users can apply to receive a
 Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are
 Active | Inactive.
 


test
String test

 The questions for a Qualification test associated with this Qualification type that a user can take to obtain a
 Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot
 have both a specified Test parameter and an AutoGranted value of true.
 


testDurationInSeconds
Long testDurationInSeconds

 The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the
 Worker requests the Qualification.
 


answerKey
String answerKey

 The answers to the Qualification test specified in the Test parameter.
 


retryDelayInSeconds
Long retryDelayInSeconds

 The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it
 again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a
 previous attempt, or if the test offers a gradient score and they want a better score. If not specified, retries
 are disabled and Workers can request a Qualification only once.
 


isRequestable
Boolean isRequestable

 Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web
 site, such as by taking a Qualification test. This value is False for Qualifications assigned automatically by
 the system. Valid values are True | False.
 


autoGranted
Boolean autoGranted

 Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a
 Qualification test. Valid values are True | False.
 


autoGrantedValue
Integer autoGrantedValue

 The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is
 1 by default.
 








Class com.amazonaws.services.mturk.model.RejectAssignmentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


assignmentId
String assignmentId

 The ID of the assignment. The assignment must correspond to a HIT created by the Requester.
 


requesterFeedback
String requesterFeedback

 A message for the Worker, which the Worker can see in the Status section of the web site.
 








Class com.amazonaws.services.mturk.model.RejectAssignmentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.RejectQualificationRequestRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


qualificationRequestId
String qualificationRequestId

 The ID of the Qualification request, as returned by the ListQualificationRequests operation.
 


reason
String reason

 A text message explaining why the request was rejected, to be shown to the Worker who made the request.
 








Class com.amazonaws.services.mturk.model.RejectQualificationRequestResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.RequestErrorException extends AmazonMTurkException implements Serializable

serialVersionUID:
1L



Serialized Fields


turkErrorCode
String turkErrorCode








Class com.amazonaws.services.mturk.model.ReviewActionDetail extends Object implements Serializable


Serialized Fields


actionId
String actionId

 The unique identifier for the action.
 


actionName
String actionName

 The nature of the action itself. The Review Policy is responsible for examining the HIT and Assignments, emitting
 results, and deciding which other actions will be necessary.
 


targetId
String targetId

 The specific HITId or AssignmentID targeted by the action.
 


targetType
String targetType

 The type of object in TargetId.
 


status
String status

 The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.
 


completeTime
Date completeTime

 The date when the action was completed.
 


result
String result

 A description of the outcome of the review.
 


errorCode
String errorCode

 Present only when the Results have a FAILED Status.
 








Class com.amazonaws.services.mturk.model.ReviewPolicy extends Object implements Serializable


Serialized Fields


policyName
String policyName

 Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01
 


parameters
List<E> parameters

 Name of the parameter from the Review policy.
 








Class com.amazonaws.services.mturk.model.ReviewReport extends Object implements Serializable


Serialized Fields


reviewResults
List<E> reviewResults

 A list of ReviewResults objects for each action specified in the Review Policy.
 


reviewActions
List<E> reviewActions

 A list of ReviewAction objects for each action specified in the Review Policy.
 








Class com.amazonaws.services.mturk.model.ReviewResultDetail extends Object implements Serializable


Serialized Fields


actionId
String actionId

 A unique identifier of the Review action result.
 


subjectId
String subjectId

 The HITID or AssignmentId about which this result was taken. Note that HIT-level Review Policies will often emit
 results about both the HIT itself and its Assignments, while Assignment-level review policies generally only emit
 results about the Assignment itself.
 


subjectType
String subjectType

 The type of the object from the SubjectId field.
 


questionId
String questionId

 Specifies the QuestionId the result is describing. Depending on whether the TargetType is a HIT or Assignment
 this results could specify multiple values. If TargetType is HIT and QuestionId is absent, then the result
 describes results of the HIT, including the HIT agreement score. If ObjectType is Assignment and QuestionId is
 absent, then the result describes the Worker's performance on the HIT.
 


key
String key

 Key identifies the particular piece of reviewed information.
 


value
String value

 The values of Key provided by the review policies you have selected.
 








Class com.amazonaws.services.mturk.model.SendBonusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


workerId
String workerId

 The ID of the Worker being paid the bonus.
 


bonusAmount
String bonusAmount

 The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and
 "101.42" represents $101.42 USD). Do not include currency symbols or currency codes.
 


assignmentId
String assignmentId

 The ID of the assignment for which this bonus is paid.
 


reason
String reason

 A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.
 


uniqueRequestToken
String uniqueRequestToken

 A unique identifier for this request, which allows you to retry the call on error without granting multiple
 bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded
 on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken,
 subsequent calls will return an error with a message containing the request ID.
 








Class com.amazonaws.services.mturk.model.SendBonusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.SendTestEventNotificationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


notification
NotificationSpecification notification

 The notification specification to test. This value is identical to the value you would provide to the
 UpdateNotificationSettings operation when you establish the notification specification for a HIT type.
 


testEventType
String testEventType

 The event to simulate to test the notification specification. This event is included in the test message even if
 the notification specification does not include the event type. The notification specification does not filter
 out the test event.
 








Class com.amazonaws.services.mturk.model.SendTestEventNotificationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.ServiceException extends AmazonMTurkException implements Serializable

serialVersionUID:
1L



Serialized Fields


turkErrorCode
String turkErrorCode








Class com.amazonaws.services.mturk.model.UpdateExpirationForHITRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hITId
String hITId

 The HIT to update.
 


expireAt
Date expireAt

 The date and time at which you want the HIT to expire
 








Class com.amazonaws.services.mturk.model.UpdateExpirationForHITResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.UpdateHITReviewStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hITId
String hITId

 The ID of the HIT to update.
 


revert
Boolean revert

 Specifies how to update the HIT status. Default is False.
 
 
 
 
 Setting this to false will only transition a HIT from Reviewable to Reviewing
 
 
 
 
 Setting this to true will only transition a HIT from Reviewing to Reviewable
 
 
 








Class com.amazonaws.services.mturk.model.UpdateHITReviewStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.UpdateHITTypeOfHITRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hITId
String hITId

 The HIT to update.
 


hITTypeId
String hITTypeId

 The ID of the new HIT type.
 








Class com.amazonaws.services.mturk.model.UpdateHITTypeOfHITResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.UpdateNotificationSettingsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


hITTypeId
String hITTypeId

 The ID of the HIT type whose notification specification is being updated.
 


notification
NotificationSpecification notification

 The notification specification for the HIT type.
 


active
Boolean active

 Specifies whether notifications are sent for HITs of this HIT type, according to the notification specification.
 You must specify either the Notification parameter or the Active parameter for the call to
 UpdateNotificationSettings to succeed.
 








Class com.amazonaws.services.mturk.model.UpdateNotificationSettingsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.mturk.model.UpdateQualificationTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


qualificationTypeId
String qualificationTypeId

 The ID of the Qualification type to update.
 


description
String description

 The new description of the Qualification type.
 


qualificationTypeStatus
String qualificationTypeStatus

 The new status of the Qualification type - Active | Inactive
 


test
String test

 The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type.
 If this parameter is specified, TestDurationInSeconds must also be specified.
 
 
 Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be
 specified if AutoGranted is true.
 
 
 Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.
 


answerKey
String answerKey

 The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data
 structure.
 


testDurationInSeconds
Long testDurationInSeconds

 The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker
 requests the Qualification.
 


retryDelayInSeconds
Long retryDelayInSeconds

 The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified
 Qualification type before they can retry the Qualification request. It is not possible to disable retries for a
 Qualification type after it has been created with retries enabled. If you want to disable retries, you must
 dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new
 Qualification type with retries disabled using CreateQualificationType.
 


autoGranted
Boolean autoGranted

 Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with
 a Qualification test.
 
 
 Constraints: If the Test parameter is specified, this parameter cannot be true.
 


autoGrantedValue
Integer autoGrantedValue

 The Qualification value to use for automatically granted Qualifications. This parameter is used only if the
 AutoGranted parameter is true.
 








Class com.amazonaws.services.mturk.model.UpdateQualificationTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


qualificationType
QualificationType qualificationType

 Contains a QualificationType data structure.
 








Class com.amazonaws.services.mturk.model.WorkerBlock extends Object implements Serializable


Serialized Fields


workerId
String workerId

 The ID of the Worker who accepted the HIT.
 


reason
String reason

 A message explaining the reason the Worker was blocked.
 








Package com.amazonaws.services.neptune.model




Class com.amazonaws.services.neptune.model.AddRoleToDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The name of the DB cluster to associate the IAM role with.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB cluster, for example
 arn:aws:iam::123456789012:role/NeptuneAccessRole.
 








Class com.amazonaws.services.neptune.model.AddRoleToDBClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.neptune.model.AddSourceIdentifierToSubscriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subscriptionName
String subscriptionName

 The name of the event notification subscription you want to add a source identifier to.
 


sourceIdentifier
String sourceIdentifier

 The identifier of the event source to be added.
 
 
 Constraints:
 
 
 
 
 If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
 
 
 
 
 If the source type is a DB security group, a DBSecurityGroupName must be supplied.
 
 
 
 
 If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
 
 
 
 
 If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
 
 
 








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


Serialized Fields


resourceName
String resourceName

 The Amazon Neptune resource that the tags are added to. This value is an Amazon Resource Name (ARN). For
 information about creating an ARN, see 
 Constructing an Amazon Resource Name (ARN).
 


tags
List<E> tags

 The tags to be assigned to the Amazon Neptune resource.
 








Class com.amazonaws.services.neptune.model.AddTagsToResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.neptune.model.AmazonNeptuneException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.ApplyPendingMaintenanceActionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceIdentifier
String resourceIdentifier

 The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information
 about creating an ARN, see 
 Constructing an Amazon Resource Name (ARN).
 


applyAction
String applyAction

 The pending maintenance action to apply to this resource.
 
 
 Valid values: system-update, db-upgrade
 


optInType
String optInType

 A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type
 immediate can't be undone.
 
 
 Valid values:
 
 
 
 
 immediate - Apply the maintenance action immediately.
 
 
 
 
 next-maintenance - Apply the maintenance action during the next maintenance window for the resource.
 
 
 
 
 undo-opt-in - Cancel any existing next-maintenance opt-in requests.
 
 
 








Class com.amazonaws.services.neptune.model.AuthorizationNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


name
String name

 The name of the availability zone.
 








Class com.amazonaws.services.neptune.model.CertificateNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.CharacterSet extends Object implements Serializable


Serialized Fields


characterSetName
String characterSetName

 The name of the character set.
 


characterSetDescription
String characterSetDescription

 The description of the character set.
 








Class com.amazonaws.services.neptune.model.CloudwatchLogsExportConfiguration extends Object implements Serializable


Serialized Fields


enableLogTypes
List<E> enableLogTypes

 The list of log types to enable.
 


disableLogTypes
List<E> disableLogTypes

 The list of log types to disable.
 








Class com.amazonaws.services.neptune.model.CopyDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceDBClusterParameterGroupIdentifier
String sourceDBClusterParameterGroupIdentifier

 The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about
 creating an ARN, see 
 Constructing an Amazon Resource Name (ARN).
 
 
 Constraints:
 
 
 
 
 Must specify a valid DB cluster parameter group.
 
 
 
 
 If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter
 group identifier, for example my-db-cluster-param-group, or a valid ARN.
 
 
 
 
 If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter
 group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.
 
 
 


targetDBClusterParameterGroupIdentifier
String targetDBClusterParameterGroupIdentifier

 The identifier for the copied DB cluster parameter group.
 
 
 Constraints:
 
 
 
 
 Cannot be null, empty, or blank
 
 
 
 
 Must contain from 1 to 255 letters, numbers, or hyphens
 
 
 
 
 First character must be a letter
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens
 
 
 
 
 Example: my-cluster-param-group1
 


targetDBClusterParameterGroupDescription
String targetDBClusterParameterGroupDescription

 A description for the copied DB cluster parameter group.
 


tags
List<E> tags

 The tags to be assigned to the copied DB cluster parameter group.
 








Class com.amazonaws.services.neptune.model.CopyDBClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceDBClusterSnapshotIdentifier
String sourceDBClusterSnapshotIdentifier

 The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.
 
 
 You can't copy from one AWS Region to another.
 
 
 Constraints:
 
 
 
 
 Must specify a valid system snapshot in the "available" state.
 
 
 
 
 Specify a valid DB snapshot identifier.
 
 
 
 
 Example: my-cluster-snapshot1
 


targetDBClusterSnapshotIdentifier
String targetDBClusterSnapshotIdentifier

 The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is
 not case-sensitive.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 letters, numbers, or hyphens.
 
 
 
 
 First character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: my-cluster-snapshot2
 


kmsKeyId
String kmsKeyId

 The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN),
 KMS key identifier, or the KMS key alias for the KMS encryption key.
 
 
 If you copy an encrypted DB cluster 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 cluster snapshot is encrypted with the same KMS key as the source
 DB cluster snapshot.
 
 
 If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a
 value for KmsKeyId.
 
 
 KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys
 from one AWS Region in another AWS Region.
 
 
 You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB
 cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
 


preSignedUrl
String preSignedUrl

 Not currently supported.
 


copyTags
Boolean copyTags

 True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false.
 The default is false.
 


tags
List<E> tags

 The tags to assign to the new DB cluster snapshot copy.
 








Class com.amazonaws.services.neptune.model.CopyDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceDBParameterGroupIdentifier
String sourceDBParameterGroupIdentifier

 The identifier or ARN for the source DB parameter group. For information about creating an ARN, see 
 Constructing an Amazon Resource Name (ARN).
 
 
 Constraints:
 
 
 
 
 Must specify a valid DB parameter group.
 
 
 
 
 Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.
 
 
 


targetDBParameterGroupIdentifier
String targetDBParameterGroupIdentifier

 The identifier for the copied DB parameter group.
 
 
 Constraints:
 
 
 
 
 Cannot be null, empty, or blank.
 
 
 
 
 Must contain from 1 to 255 letters, numbers, or hyphens.
 
 
 
 
 First character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: my-db-parameter-group
 


targetDBParameterGroupDescription
String targetDBParameterGroupDescription

 A description for the copied DB parameter group.
 


tags
List<E> tags

 The tags to be assigned to the copied DB parameter group.
 








Class com.amazonaws.services.neptune.model.CreateDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group.
 
 
 Constraints:
 
 
 
 
 Must match the name of an existing DBClusterParameterGroup.
 
 
 
 
 
 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
List<E> tags

 The tags to be assigned to the new DB cluster parameter group.
 








Class com.amazonaws.services.neptune.model.CreateDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZones
List<E> availabilityZones

 A list of EC2 Availability Zones that instances in the DB cluster can be created in.
 


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

 (Not supported by Neptune)
 


databaseName
String databaseName

 The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune
 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 letters, numbers, 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, the
 default is used.
 
 
 Constraints:
 
 
 
 
 If supplied, must match the name of an existing DBClusterParameterGroup.
 
 
 


vpcSecurityGroupIds
List<E> vpcSecurityGroupIds

 A list of EC2 VPC security groups to associate with this DB cluster.
 


dBSubnetGroupName
String dBSubnetGroupName

 A DB subnet group to associate with this DB cluster.
 
 
 Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
 
 
 Example: mySubnetgroup
 


engine
String engine

 The name of the database engine to be used for this DB cluster.
 
 
 Valid Values: neptune
 


engineVersion
String engineVersion

 The version number of the database engine to use. Currently, setting this parameter has no effect.
 
 
 Example: 1.0.1
 


port
Integer port

 The port number on which the instances in the DB cluster accept connections.
 
 
 Default: 8182
 


masterUsername
String masterUsername

 The name of the master user for the DB cluster.
 
 
 Constraints:
 
 
 
 
 Must be 1 to 16 letters or numbers.
 
 
 
 
 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

 (Not supported by Neptune)
 


preferredBackupWindow
String preferredBackupWindow

 The daily time range during which automated backups are created if automated backups are enabled using the
 BackupRetentionPeriod parameter.
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the
 time blocks available, see  Adjusting the
 Preferred Maintenance Window in the Amazon Neptune User Guide.
 
 
 Constraints:
 
 
 
 
 Must be in the format hh24:mi-hh24:mi.
 
 
 
 
 Must 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
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring
 on a random day of the week. To see the time blocks available, see  Adjusting the
 Preferred Maintenance Window in the Amazon Neptune User Guide.
 
 
 Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
 
 
 Constraints: Minimum 30-minute window.
 


replicationSourceIdentifier
String replicationSourceIdentifier

 The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read
 Replica.
 


tags
List<E> tags

 The tags to assign to the new DB cluster.
 


storageEncrypted
Boolean storageEncrypted

 Specifies whether the DB cluster is encrypted.
 


kmsKeyId
String kmsKeyId

 The AWS 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 KMS encryption key.
 
 
 If an encryption key is not specified in KmsKeyId:
 
 
 
 
 If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the
 encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.
 
 
 
 
 If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not
 specified, then Amazon Neptune 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.
 
 
 If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId
 to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that
 AWS Region.
 


preSignedUrl
String preSignedUrl

 This parameter is not currently supported.
 


enableIAMDatabaseAuthentication
Boolean enableIAMDatabaseAuthentication

 True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
 false.
 
 
 Default: false
 


enableCloudwatchLogsExports
List<E> enableCloudwatchLogsExports

 The list of log types that need to be enabled for exporting to CloudWatch Logs.
 


deletionProtection
Boolean deletionProtection

 A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when
 deletion protection is enabled. By default, deletion protection is disabled.
 








Class com.amazonaws.services.neptune.model.CreateDBClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 letters, numbers, or hyphens.
 
 
 
 
 First character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: my-cluster1-snapshot1
 


dBClusterIdentifier
String dBClusterIdentifier

 The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing DBCluster.
 
 
 
 
 Example: my-cluster1
 


tags
List<E> tags

 The tags to be assigned to the DB cluster snapshot.
 








Class com.amazonaws.services.neptune.model.CreateDBInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBName
String dBName

 Not supported.
 


dBInstanceIdentifier
String dBInstanceIdentifier

 The DB instance identifier. This parameter is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 letters, numbers, or hyphens.
 
 
 
 
 First character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: mydbinstance
 


allocatedStorage
Integer allocatedStorage

 The amount of storage (in gibibytes) to allocate for the DB instance.
 
 
 Type: Integer
 
 
 Not applicable. Neptune cluster volumes automatically grow as the amount of data in your database increases,
 though you are only charged for the space that you use in a Neptune cluster volume.
 


dBInstanceClass
String dBInstanceClass

 The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance
 classes are available in all AWS Regions.
 


engine
String engine

 The name of the database engine to be used for this instance.
 
 
 Valid Values: neptune
 


masterUsername
String masterUsername

 The name for the master user. Not used.
 


masterUserPassword
String masterUserPassword

 The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
 
 
 Not used.
 


dBSecurityGroups
List<E> dBSecurityGroups

 A list of DB security groups to associate with this DB instance.
 
 
 Default: The default DB security group for the database engine.
 


vpcSecurityGroupIds
List<E> vpcSecurityGroupIds

 A list of EC2 VPC security groups to associate with this DB instance.
 
 
 Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more
 information, see CreateDBCluster.
 
 
 Default: The default EC2 VPC security group for the DB subnet group's VPC.
 


availabilityZone
String availabilityZone

 The EC2 Availability Zone that the DB instance is created in
 
 
 Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
 
 
 Example: us-east-1d
 
 
 Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to
 true. The specified Availability Zone must be in the same AWS Region as the current endpoint.
 


dBSubnetGroupName
String dBSubnetGroupName

 A DB subnet group to associate with this DB instance.
 
 
 If there is no DB subnet group, then it is a non-VPC DB instance.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
 
 
 Format: ddd:hh24:mi-ddd:hh24:mi
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring
 on a random day of the week.
 
 
 Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
 
 
 Constraints: Minimum 30-minute window.
 


dBParameterGroupName
String dBParameterGroupName

 The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default
 DBParameterGroup for the specified engine is used.
 
 
 Constraints:
 
 
 
 
 Must be 1 to 255 letters, numbers, or hyphens.
 
 
 
 
 First character must be a letter
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens
 
 
 


backupRetentionPeriod
Integer backupRetentionPeriod

 The number of days for which automated backups are retained.
 
 
 Not applicable. The retention period for automated backups is managed by the DB cluster. For more information,
 see CreateDBCluster.
 
 
 Default: 1
 
 
 Constraints:
 
 
 
 
 Must be a value from 0 to 35
 
 
 
 
 Cannot be set to 0 if the DB instance is a source to Read Replicas
 
 
 


preferredBackupWindow
String preferredBackupWindow

 The daily time range during which automated backups are created.
 
 
 Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more
 information, see CreateDBCluster.
 


port
Integer port

 The port number on which the database accepts connections.
 
 
 Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.
 
 
 Default: 8182
 
 
 Type: Integer
 


multiAZ
Boolean multiAZ

 Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the
 MultiAZ parameter is set to true.
 


engineVersion
String engineVersion

 The version number of the database engine to use. Currently, setting this parameter has no effect.
 


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
 
 
 Default: true
 


licenseModel
String licenseModel

 License model information for this DB instance.
 
 
 Valid values: license-included | bring-your-own-license |
 general-public-license
 


iops
Integer iops

 The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
 instance.
 


optionGroupName
String optionGroupName

 (Not supported by Neptune)
 


characterSetName
String characterSetName

 (Not supported by Neptune)
 


publiclyAccessible
Boolean publiclyAccessible
Deprecated. 

 This flag should no longer be used.
 


tags
List<E> tags

 The tags to assign to the new instance.
 


dBClusterIdentifier
String dBClusterIdentifier

 The identifier of the DB cluster that the instance will belong to.
 
 
 For information on creating a DB cluster, see CreateDBCluster.
 
 
 Type: String
 


storageType
String storageType

 Specifies the storage type to be associated with the DB instance.
 
 
 Not applicable. Storage is managed by the DB Cluster.
 


tdeCredentialArn
String tdeCredentialArn

 The ARN from the key store with which to associate the instance for TDE encryption.
 


tdeCredentialPassword
String tdeCredentialPassword

 The password for the given ARN from the key store in order to access the device.
 


storageEncrypted
Boolean storageEncrypted

 Specifies whether the DB instance is encrypted.
 
 
 Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see
 CreateDBCluster.
 
 
 Default: false
 


kmsKeyId
String kmsKeyId

 The AWS 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.
 
 
 Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see
 CreateDBCluster.
 
 
 If the StorageEncrypted parameter is true, and you do not specify a value for the
 KmsKeyId parameter, then Amazon Neptune will use your default encryption key. AWS KMS creates the
 default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS
 Region.
 


domain
String domain

 Specify the Active Directory Domain to create the instance in.
 


copyTagsToSnapshot
Boolean copyTagsToSnapshot

 True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is
 false.
 


monitoringInterval
Integer monitoringInterval

 The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To
 disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
 
 
 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 Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
 example, arn:aws:iam:123456789012:role/emaccess.
 
 
 If MonitoringInterval is set to a value other than 0, then you must supply a
 MonitoringRoleArn value.
 


domainIAMRoleName
String domainIAMRoleName

 Specify the name of the IAM role to be used when making API calls to the Directory Service.
 


promotionTier
Integer promotionTier

 A value that specifies the order in which an Read Replica is promoted to the primary instance after a failure of
 the existing primary instance.
 
 
 Default: 1
 
 
 Valid Values: 0 - 15
 


timezone
String timezone

 The time zone of the DB instance.
 


enableIAMDatabaseAuthentication
Boolean enableIAMDatabaseAuthentication

 True to enable AWS Identity and Access Management (IAM) authentication for Neptune.
 
 
 Default: false
 


enablePerformanceInsights
Boolean enablePerformanceInsights

 (Not supported by Neptune)
 


performanceInsightsKMSKeyId
String performanceInsightsKMSKeyId

 (Not supported by Neptune)
 


enableCloudwatchLogsExports
List<E> enableCloudwatchLogsExports

 The list of log types that need to be enabled for exporting to CloudWatch Logs.
 


deletionProtection
Boolean deletionProtection

 A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted
 when deletion protection is enabled. By default, deletion protection is disabled.
 
 
 You can enable or disable deletion protection for the DB cluster. For more information, see
 CreateDBCluster. DB instances in a DB cluster can be deleted even when deletion protection is enabled for
 the DB cluster.
 








Class com.amazonaws.services.neptune.model.CreateDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBParameterGroupName
String dBParameterGroupName

 The name of the DB parameter group.
 
 
 Constraints:
 
 
 
 
 Must be 1 to 255 letters, numbers, or hyphens.
 
 
 
 
 First character must be a letter
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens
 
 
 
 
 
 This value is stored as a lowercase string.
 
 


dBParameterGroupFamily
String dBParameterGroupFamily

 The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter
 group family, and can be applied only to a DB instance running a database engine and engine version compatible
 with that DB parameter group family.
 


description
String description

 The description for the DB parameter group.
 


tags
List<E> tags

 The tags to be assigned to the new DB parameter group.
 








Class com.amazonaws.services.neptune.model.CreateDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName

 The name for the DB subnet group. This value is stored as a lowercase string.
 
 
 Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not
 be default.
 
 
 Example: mySubnetgroup
 


dBSubnetGroupDescription
String dBSubnetGroupDescription

 The description for the DB subnet group.
 


subnetIds
List<E> subnetIds

 The EC2 Subnet IDs for the DB subnet group.
 


tags
List<E> tags

 The tags to be assigned to the new DB subnet group.
 








Class com.amazonaws.services.neptune.model.CreateEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subscriptionName
String subscriptionName

 The name of the subscription.
 
 
 Constraints: The name must be less than 255 characters.
 


snsTopicArn
String snsTopicArn

 The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS
 when you create a topic and subscribe to it.
 


sourceType
String sourceType

 The type of source that is 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-cluster | db-parameter-group |
 db-security-group | db-snapshot | db-cluster-snapshot
 


eventCategories
List<E> 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 by using the DescribeEventCategories action.
 


sourceIds
List<E> sourceIds

 The list of identifiers of the event sources for which events are 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 can't end with a hyphen or contain two consecutive hyphens.
 
 
 Constraints:
 
 
 
 
 If SourceIds are supplied, SourceType must also be provided.
 
 
 
 
 If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
 
 
 
 
 If the source type is a DB security group, a DBSecurityGroupName must be supplied.
 
 
 
 
 If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
 
 
 
 
 If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
 
 
 


enabled
Boolean enabled

 A Boolean value; set to true to activate the subscription, set to false to create the subscription
 but not active it.
 


tags
List<E> tags

 The tags to be applied to the new event subscription.
 








Class com.amazonaws.services.neptune.model.DBCluster extends Object implements Serializable


Serialized Fields


allocatedStorage
Integer allocatedStorage

 AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead
 automatically adjusts as needed.
 


availabilityZones
List<E> 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

 (Not supported by Neptune)
 


databaseName
String databaseName

 Contains the name of the initial database of this DB cluster that was provided at create time, if one was
 specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
 


dBClusterIdentifier
String dBClusterIdentifier

 Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
 


dBClusterParameterGroup
String dBClusterParameterGroup

 Specifies the name of the DB cluster parameter group for the DB cluster.
 


dBSubnetGroup
String dBSubnetGroup

 Specifies information on the subnet group associated with the DB cluster, including the name, description, and
 subnets in the subnet group.
 


status
String status

 Specifies the current state of this DB cluster.
 


percentProgress
String percentProgress

 Specifies the progress of the operation as a percentage.
 


earliestRestorableTime
Date earliestRestorableTime

 Specifies the earliest time to which a database can be restored with point-in-time restore.
 


endpoint
String endpoint

 Specifies the connection endpoint for the primary instance of the DB cluster.
 


readerEndpoint
String readerEndpoint

 The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the
 Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint,
 Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can
 help balance your read workload across multiple Read Replicas in your DB cluster.
 
 
 If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your
 connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then
 reconnect to the reader endpoint.
 


multiAZ
Boolean multiAZ

 Specifies whether the DB cluster has instances in multiple Availability Zones.
 


engine
String engine

 Provides the name of the database engine to be used for this DB cluster.
 


engineVersion
String engineVersion

 Indicates the database engine version.
 


latestRestorableTime
Date latestRestorableTime

 Specifies the latest time to which a database can be restored with point-in-time restore.
 


port
Integer port

 Specifies the port that the database engine is listening on.
 


masterUsername
String masterUsername

 Contains the master username for the DB cluster.
 


dBClusterOptionGroupMemberships
List<E> dBClusterOptionGroupMemberships

 (Not supported by Neptune)
 


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


replicationSourceIdentifier
String replicationSourceIdentifier

 Not supported by Neptune.
 


readReplicaIdentifiers
List<E> readReplicaIdentifiers

 Contains one or more identifiers of the Read Replicas associated with this DB cluster.
 


dBClusterMembers
List<E> dBClusterMembers

 Provides the list of instances that make up the DB cluster.
 


vpcSecurityGroups
List<E> vpcSecurityGroups

 Provides a list of VPC security groups that the DB cluster belongs to.
 


hostedZoneId
String hostedZoneId

 Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
 


storageEncrypted
Boolean storageEncrypted

 Specifies whether the DB cluster is encrypted.
 


kmsKeyId
String kmsKeyId

 If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
 


dbClusterResourceId
String dbClusterResourceId

 The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log
 entries whenever the AWS KMS key for the DB cluster is accessed.
 


dBClusterArn
String dBClusterArn

 The Amazon Resource Name (ARN) for the DB cluster.
 


associatedRoles
List<E> associatedRoles

 Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
 IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services
 on your behalf.
 


iAMDatabaseAuthenticationEnabled
Boolean iAMDatabaseAuthenticationEnabled

 True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and
 otherwise false.
 


cloneGroupId
String cloneGroupId

 Identifies the clone group to which the DB cluster is associated.
 


clusterCreateTime
Date clusterCreateTime

 Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
 


enabledCloudwatchLogsExports
List<E> enabledCloudwatchLogsExports

 A list of log types that this DB cluster is configured to export to CloudWatch Logs.
 


deletionProtection
Boolean deletionProtection

 Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion
 protection is enabled.
 








Class com.amazonaws.services.neptune.model.DBClusterAlreadyExistsException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBClusterMember extends Object implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 Specifies the instance identifier for this member of the DB cluster.
 


isClusterWriter
Boolean isClusterWriter

 Value that is true if the cluster member is the primary instance for the DB cluster and
 false otherwise.
 


dBClusterParameterGroupStatus
String dBClusterParameterGroupStatus

 Specifies the status of the DB cluster parameter group for this member of the DB cluster.
 


promotionTier
Integer promotionTier

 A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of
 the existing primary instance.
 








Class com.amazonaws.services.neptune.model.DBClusterNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBClusterOptionGroupStatus extends Object implements Serializable


Serialized Fields


dBClusterOptionGroupName
String dBClusterOptionGroupName

 Specifies the name of the DB cluster option group.
 


status
String status

 Specifies the status of the DB cluster option group.
 








Class com.amazonaws.services.neptune.model.DBClusterParameterGroup extends Object implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 Provides the name of the DB cluster parameter group.
 


dBParameterGroupFamily
String dBParameterGroupFamily

 Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.
 


description
String description

 Provides the customer-specified description for this DB cluster parameter group.
 


dBClusterParameterGroupArn
String dBClusterParameterGroupArn

 The Amazon Resource Name (ARN) for the DB cluster parameter group.
 








Class com.amazonaws.services.neptune.model.DBClusterParameterGroupNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBClusterQuotaExceededException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBClusterRole extends Object implements Serializable


Serialized Fields


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
 


status
String status

 Describes the state of association between the IAM role and the DB cluster. The Status property returns one of
 the following values:
 
 
 
 
 ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS
 services on your behalf.
 
 
 
 
 PENDING - the IAM role ARN is being associated with the DB cluster.
 
 
 
 
 INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume
 the IAM role in order to access other AWS services on your behalf.
 
 
 








Class com.amazonaws.services.neptune.model.DBClusterRoleAlreadyExistsException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBClusterRoleNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBClusterRoleQuotaExceededException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBClusterSnapshot extends Object implements Serializable


Serialized Fields


availabilityZones
List<E> availabilityZones

 Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
 


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 Specifies the identifier for the DB cluster snapshot.
 


dBClusterIdentifier
String dBClusterIdentifier

 Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
 


snapshotCreateTime
Date snapshotCreateTime

 Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
 


engine
String engine

 Specifies the name of the database engine.
 


allocatedStorage
Integer allocatedStorage

 Specifies the allocated storage size in gibibytes (GiB).
 


status
String status

 Specifies the status of this DB cluster snapshot.
 


port
Integer port

 Specifies the port that the DB cluster was listening on at the time of the snapshot.
 


vpcId
String vpcId

 Provides the VPC ID associated with the DB cluster snapshot.
 


clusterCreateTime
Date clusterCreateTime

 Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
 


masterUsername
String masterUsername

 Provides the master username for the DB cluster snapshot.
 


engineVersion
String engineVersion

 Provides the version of the database engine for this DB cluster snapshot.
 


licenseModel
String licenseModel

 Provides the license model information for this DB cluster snapshot.
 


snapshotType
String snapshotType

 Provides the type of the DB cluster snapshot.
 


percentProgress
Integer percentProgress

 Specifies the percentage of the estimated data that has been transferred.
 


storageEncrypted
Boolean storageEncrypted

 Specifies whether the DB cluster snapshot is encrypted.
 


kmsKeyId
String kmsKeyId

 If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
 


dBClusterSnapshotArn
String dBClusterSnapshotArn

 The Amazon Resource Name (ARN) for the DB cluster snapshot.
 


sourceDBClusterSnapshotArn
String sourceDBClusterSnapshotArn

 If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the
 source DB cluster snapshot, otherwise, a null value.
 


iAMDatabaseAuthenticationEnabled
Boolean iAMDatabaseAuthenticationEnabled

 True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and
 otherwise false.
 








Class com.amazonaws.services.neptune.model.DBClusterSnapshotAlreadyExistsException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBClusterSnapshotAttribute extends Object implements Serializable


Serialized Fields


attributeName
String attributeName

 The name of the manual DB cluster snapshot attribute.
 
 
 The attribute named restore refers to the list of AWS accounts that have permission to copy or
 restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API
 action.
 


attributeValues
List<E> attributeValues

 The value(s) for the manual DB cluster snapshot attribute.
 
 
 If the AttributeName field is set to restore, then this element returns a list of IDs
 of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of
 all is in the list, then the manual DB cluster snapshot is public and available for any AWS account
 to copy or restore.
 








Class com.amazonaws.services.neptune.model.DBClusterSnapshotAttributesResult extends Object implements Serializable


Serialized Fields


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 The identifier of the manual DB cluster snapshot that the attributes apply to.
 


dBClusterSnapshotAttributes
List<E> dBClusterSnapshotAttributes

 The list of attributes and values for the manual DB cluster snapshot.
 








Class com.amazonaws.services.neptune.model.DBClusterSnapshotNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBEngineVersion extends Object implements Serializable


Serialized Fields


engine
String engine

 The name of the database engine.
 


engineVersion
String engineVersion

 The version number of the database engine.
 


dBParameterGroupFamily
String dBParameterGroupFamily

 The name of the DB parameter group family for the database engine.
 


dBEngineDescription
String dBEngineDescription

 The description of the database engine.
 


dBEngineVersionDescription
String dBEngineVersionDescription

 The description of the database engine version.
 


defaultCharacterSet
CharacterSet defaultCharacterSet

 (Not supported by Neptune)
 


supportedCharacterSets
List<E> supportedCharacterSets

 (Not supported by Neptune)
 


validUpgradeTarget
List<E> validUpgradeTarget

 A list of engine versions that this database engine version can be upgraded to.
 


supportedTimezones
List<E> supportedTimezones

 A list of the time zones supported by this engine for the Timezone parameter of the
 CreateDBInstance action.
 


exportableLogTypes
List<E> exportableLogTypes

 The types of logs that the database engine has available for export to CloudWatch Logs.
 


supportsLogExportsToCloudwatchLogs
Boolean supportsLogExportsToCloudwatchLogs

 A value that indicates whether the engine version supports exporting the log types specified by
 ExportableLogTypes to CloudWatch Logs.
 


supportsReadReplica
Boolean supportsReadReplica

 Indicates whether the database engine version supports read replicas.
 








Class com.amazonaws.services.neptune.model.DBInstance extends Object implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
 


dBInstanceClass
String dBInstanceClass

 Contains the name of the compute and memory capacity class of the DB instance.
 


engine
String engine

 Provides the name of the database engine to be used for this DB instance.
 


dBInstanceStatus
String dBInstanceStatus

 Specifies the current state of this database.
 


masterUsername
String masterUsername

 Contains the master username for the DB instance.
 


dBName
String dBName

 The database name.
 


endpoint
Endpoint endpoint

 Specifies the connection endpoint.
 


allocatedStorage
Integer allocatedStorage

 Specifies the allocated storage size specified in gibibytes.
 


instanceCreateTime
Date instanceCreateTime

 Provides the date and time the DB instance was created.
 


preferredBackupWindow
String preferredBackupWindow

 Specifies the daily time range during which automated backups are created if automated backups are enabled, as
 determined by the BackupRetentionPeriod.
 


backupRetentionPeriod
Integer backupRetentionPeriod

 Specifies the number of days for which automatic DB snapshots are retained.
 


dBSecurityGroups
List<E> dBSecurityGroups

 Provides List of DB security group elements containing only DBSecurityGroup.Name and
 DBSecurityGroup.Status subelements.
 


vpcSecurityGroups
List<E> vpcSecurityGroups

 Provides a list of VPC security group elements that the DB instance belongs to.
 


dBParameterGroups
List<E> dBParameterGroups

 Provides the list of DB parameter groups applied to this DB instance.
 


availabilityZone
String availabilityZone

 Specifies the name of the Availability Zone the DB instance is located in.
 


dBSubnetGroup
DBSubnetGroup dBSubnetGroup

 Specifies information on the subnet group associated with the DB instance, including the name, description, and
 subnets in the subnet group.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
 


pendingModifiedValues
PendingModifiedValues pendingModifiedValues

 Specifies that changes to the DB instance are pending. This element is only included when changes are pending.
 Specific changes are identified by subelements.
 


latestRestorableTime
Date latestRestorableTime

 Specifies the latest time to which a database can be restored with point-in-time restore.
 


multiAZ
Boolean multiAZ

 Specifies if the DB instance is a Multi-AZ deployment.
 


engineVersion
String engineVersion

 Indicates the database engine version.
 


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 Indicates that minor version patches are applied automatically.
 


readReplicaSourceDBInstanceIdentifier
String readReplicaSourceDBInstanceIdentifier

 Contains the identifier of the source DB instance if this DB instance is a Read Replica.
 


readReplicaDBInstanceIdentifiers
List<E> readReplicaDBInstanceIdentifiers

 Contains one or more identifiers of the Read Replicas associated with this DB instance.
 


readReplicaDBClusterIdentifiers
List<E> readReplicaDBClusterIdentifiers

 Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
 


licenseModel
String licenseModel

 License model information for this DB instance.
 


iops
Integer iops

 Specifies the Provisioned IOPS (I/O operations per second) value.
 


optionGroupMemberships
List<E> optionGroupMemberships

 (Not supported by Neptune)
 


characterSetName
String characterSetName

 (Not supported by Neptune)
 


secondaryAvailabilityZone
String secondaryAvailabilityZone

 If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
 


publiclyAccessible
Boolean publiclyAccessible
Deprecated. 

 This flag should no longer be used.
 


statusInfos
List<E> statusInfos

 The status of a Read Replica. If the instance is not a Read Replica, this is blank.
 


storageType
String storageType

 Specifies the storage type associated with DB instance.
 


tdeCredentialArn
String tdeCredentialArn

 The ARN from the key store with which the instance is associated for TDE encryption.
 


dbInstancePort
Integer dbInstancePort

 Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a
 different port than the DB cluster port.
 


dBClusterIdentifier
String dBClusterIdentifier

 If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a
 member of.
 


storageEncrypted
Boolean storageEncrypted

 Not supported: The encryption for DB instances is managed by the DB cluster.
 


kmsKeyId
String kmsKeyId

 Not supported: The encryption for DB instances is managed by the DB cluster.
 


dbiResourceId
String dbiResourceId

 The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log
 entries whenever the AWS KMS key for the DB instance is accessed.
 


cACertificateIdentifier
String cACertificateIdentifier

 The identifier of the CA certificate for this DB instance.
 


domainMemberships
List<E> domainMemberships

 Not supported
 


copyTagsToSnapshot
Boolean copyTagsToSnapshot

 Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
 


monitoringInterval
Integer monitoringInterval

 The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
 


enhancedMonitoringResourceArn
String enhancedMonitoringResourceArn

 The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring
 metrics data for the DB instance.
 


monitoringRoleArn
String monitoringRoleArn

 The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
 


promotionTier
Integer promotionTier

 A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of
 the existing primary instance.
 


dBInstanceArn
String dBInstanceArn

 The Amazon Resource Name (ARN) for the DB instance.
 


timezone
String timezone

 Not supported.
 


iAMDatabaseAuthenticationEnabled
Boolean iAMDatabaseAuthenticationEnabled

 True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.
 


performanceInsightsEnabled
Boolean performanceInsightsEnabled

 (Not supported by Neptune)
 


performanceInsightsKMSKeyId
String performanceInsightsKMSKeyId

 (Not supported by Neptune)
 


enabledCloudwatchLogsExports
List<E> enabledCloudwatchLogsExports

 A list of log types that this DB instance is configured to export to CloudWatch Logs.
 


deletionProtection
Boolean deletionProtection

 Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion
 protection is enabled.
 








Class com.amazonaws.services.neptune.model.DBInstanceAlreadyExistsException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBInstanceNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBInstanceStatusInfo extends Object implements Serializable


Serialized Fields


statusType
String statusType

 This value is currently "read replication."
 


normal
Boolean normal

 Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.
 


status
String status

 Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or
 terminated.
 


message
String message

 Details of the error if there is an error for the instance. If the instance is not in an error state, this value
 is blank.
 








Class com.amazonaws.services.neptune.model.DBParameterGroup extends Object implements Serializable


Serialized Fields


dBParameterGroupName
String dBParameterGroupName

 Provides the name of the DB parameter group.
 


dBParameterGroupFamily
String dBParameterGroupFamily

 Provides the name of the DB parameter group family that this DB parameter group is compatible with.
 


description
String description

 Provides the customer-specified description for this DB parameter group.
 


dBParameterGroupArn
String dBParameterGroupArn

 The Amazon Resource Name (ARN) for the DB parameter group.
 








Class com.amazonaws.services.neptune.model.DBParameterGroupAlreadyExistsException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBParameterGroupNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBParameterGroupQuotaExceededException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBParameterGroupStatus extends Object implements Serializable


Serialized Fields


dBParameterGroupName
String dBParameterGroupName

 The name of the DP parameter group.
 


parameterApplyStatus
String parameterApplyStatus

 The status of parameter updates.
 








Class com.amazonaws.services.neptune.model.DBSecurityGroupMembership extends Object implements Serializable


Serialized Fields


dBSecurityGroupName
String dBSecurityGroupName

 The name of the DB security group.
 


status
String status

 The status of the DB security group.
 








Class com.amazonaws.services.neptune.model.DBSecurityGroupNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBSnapshotAlreadyExistsException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBSnapshotNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBSubnetGroup extends Object implements Serializable


Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName

 The name of the DB subnet group.
 


dBSubnetGroupDescription
String dBSubnetGroupDescription

 Provides the description of the DB subnet group.
 


vpcId
String vpcId

 Provides the VpcId of the DB subnet group.
 


subnetGroupStatus
String subnetGroupStatus

 Provides the status of the DB subnet group.
 


subnets
List<E> subnets

 Contains a list of Subnet elements.
 


dBSubnetGroupArn
String dBSubnetGroupArn

 The Amazon Resource Name (ARN) for the DB subnet group.
 








Class com.amazonaws.services.neptune.model.DBSubnetGroupAlreadyExistsException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBSubnetGroupDoesNotCoverEnoughAZsException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBSubnetGroupNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBSubnetGroupQuotaExceededException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBSubnetQuotaExceededException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DBUpgradeDependencyFailureException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DeleteDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group.
 
 
 Constraints:
 
 
 
 
 Must be the name of an existing DB cluster parameter group.
 
 
 
 
 You can't delete a default DB cluster parameter group.
 
 
 
 
 Cannot be associated with any DB clusters.
 
 
 








Class com.amazonaws.services.neptune.model.DeleteDBClusterParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.neptune.model.DeleteDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.
 
 
 Constraints:
 
 
 
 
 Must match an existing DBClusterIdentifier.
 
 
 


skipFinalSnapshot
Boolean skipFinalSnapshot

 Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true
 is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is
 created before the DB cluster is deleted.
 
 
 
 You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is
 false.
 
 
 
 Default: false
 


finalDBSnapshotIdentifier
String finalDBSnapshotIdentifier

 The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is
 set to false.
 
 
 
 Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an
 error.
 
 
 
 Constraints:
 
 
 
 
 Must be 1 to 255 letters, numbers, or hyphens.
 
 
 
 
 First character must be a letter
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens
 
 
 








Class com.amazonaws.services.neptune.model.DeleteDBClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 The identifier of the DB cluster snapshot to delete.
 
 
 Constraints: Must be the name of an existing DB cluster snapshot in the available state.
 








Class com.amazonaws.services.neptune.model.DeleteDBInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.
 
 
 Constraints:
 
 
 
 
 Must match the name of an existing DB instance.
 
 
 


skipFinalSnapshot
Boolean skipFinalSnapshot

 Determines whether a final DB snapshot is created before the DB instance is deleted. If true is
 specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB
 instance is deleted.
 
 
 Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or
 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".
 
 
 Specify true when deleting a Read Replica.
 
 
 
 The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.
 
 
 
 Default: false
 


finalDBSnapshotIdentifier
String finalDBSnapshotIdentifier

 The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.
 
 
 
 Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.
 
 
 
 Constraints:
 
 
 
 
 Must be 1 to 255 letters or numbers.
 
 
 
 
 First character must be a letter
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens
 
 
 
 
 Cannot be specified when deleting a Read Replica.
 
 
 








Class com.amazonaws.services.neptune.model.DeleteDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBParameterGroupName
String dBParameterGroupName

 The name of the DB parameter group.
 
 
 Constraints:
 
 
 
 
 Must be the name of an existing DB parameter group
 
 
 
 
 You can't delete a default DB parameter group
 
 
 
 
 Cannot be associated with any DB instances
 
 
 








Class com.amazonaws.services.neptune.model.DeleteDBParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.neptune.model.DeleteDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName

 The name of the database subnet group to delete.
 
 
 
 You can't delete the default subnet group.
 
 
 
 Constraints:
 
 
 Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
 
 
 Example: mySubnetgroup
 








Class com.amazonaws.services.neptune.model.DeleteDBSubnetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.neptune.model.DeleteEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subscriptionName
String subscriptionName

 The name of the event notification subscription you want to delete.
 








Class com.amazonaws.services.neptune.model.DescribeDBClusterParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of a specific DB cluster parameter group to return details for.
 
 
 Constraints:
 
 
 
 
 If supplied, must match the name of an existing DBClusterParameterGroup.
 
 
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If
 this parameter is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 








Class com.amazonaws.services.neptune.model.DescribeDBClusterParameterGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If
 this parameter is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 


dBClusterParameterGroups
List<E> dBClusterParameterGroups

 A list of DB cluster parameter groups.
 








Class com.amazonaws.services.neptune.model.DescribeDBClusterParametersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of a specific DB cluster parameter group to return parameter details for.
 
 
 Constraints:
 
 
 
 
 If supplied, must match the name of an existing DBClusterParameterGroup.
 
 
 


source
String source

 A value that indicates to return only parameters for a specific source. Parameter sources can be
 engine, service, or customer.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeDBClusterParameters request. If this
 parameter is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 








Class com.amazonaws.services.neptune.model.DescribeDBClusterParametersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


parameters
List<E> parameters

 Provides a list of parameters for the DB cluster parameter group.
 


marker
String marker

 An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is
 specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords .
 








Class com.amazonaws.services.neptune.model.DescribeDBClusterSnapshotAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 The identifier for the DB cluster snapshot to describe the attributes for.
 








Class com.amazonaws.services.neptune.model.DescribeDBClusterSnapshotsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in
 conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.
 
 
 Constraints:
 
 
 
 
 If supplied, must match the identifier of an existing DBCluster.
 
 
 


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the
 DBClusterIdentifier parameter. This value is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 If supplied, must match the identifier of an existing DBClusterSnapshot.
 
 
 
 
 If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
 
 
 


snapshotType
String snapshotType

 The type of DB cluster snapshots to be returned. You can specify one of the following values:
 
 
 
 
 automated - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for
 my AWS account.
 
 
 
 
 manual - Return all DB cluster snapshots that have been taken by my AWS account.
 
 
 
 
 shared - Return all manual DB cluster snapshots that have been shared to my AWS account.
 
 
 
 
 public - Return all DB cluster snapshots that have been marked as public.
 
 
 
 
 If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are
 returned. You can include shared DB cluster snapshots with these results by setting the
 IncludeShared parameter to true. You can include public DB cluster snapshots with these
 results by setting the IncludePublic parameter to true.
 
 
 The IncludeShared and IncludePublic parameters don't apply for
 SnapshotType values of manual or automated. The IncludePublic
 parameter doesn't apply when SnapshotType is set to shared. The
 IncludeShared parameter doesn't apply when SnapshotType is set to public.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this
 parameter is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 


includeShared
Boolean includeShared

 True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given
 permission to copy or restore, and otherwise false. The default is false.
 
 
 You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the
 ModifyDBClusterSnapshotAttribute API action.
 


includePublic
Boolean includePublic

 True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and
 otherwise false. The default is false. The default is false.
 
 
 You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API
 action.
 








Class com.amazonaws.services.neptune.model.DescribeDBClusterSnapshotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter
 is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 


dBClusterSnapshots
List<E> dBClusterSnapshots

 Provides a list of DB cluster snapshots for the user.
 








Class com.amazonaws.services.neptune.model.DescribeDBClustersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB
 cluster is returned. This parameter isn't case-sensitive.
 
 
 Constraints:
 
 
 
 
 If supplied, must match an existing DBClusterIdentifier.
 
 
 


filters
List<E> filters

 A filter that specifies one or more DB clusters to describe.
 
 
 Supported filters:
 
 
 
 
 db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
 results list will only include information about the DB clusters identified by these ARNs.
 
 
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is
 specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 








Class com.amazonaws.services.neptune.model.DescribeDBClustersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 A pagination token that can be used in a subsequent DescribeDBClusters request.
 


dBClusters
List<E> dBClusters

 Contains a list of DB clusters for the user.
 








Class com.amazonaws.services.neptune.model.DescribeDBEngineVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


engine
String engine

 The database engine to return.
 


engineVersion
String engineVersion

 The database engine version to return.
 
 
 Example: 5.1.49
 


dBParameterGroupFamily
String dBParameterGroupFamily

 The name of a specific DB parameter group family to return details for.
 
 
 Constraints:
 
 
 
 
 If supplied, must match an existing DBParameterGroupFamily.
 
 
 


filters
List<E> filters

 Not currently supported.
 


maxRecords
Integer maxRecords

 The maximum number of records to include in the response. If more than the MaxRecords value is
 available, a pagination token called a marker is included in the response so that the following results can be
 retrieved.
 
 
 Default: 100
 
 
 Constraints: Minimum 20, maximum 100.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


defaultOnly
Boolean defaultOnly

 Indicates that only the default version of the specified engine or engine and major version combination is
 returned.
 


listSupportedCharacterSets
Boolean listSupportedCharacterSets

 If this parameter is specified and the requested engine supports the CharacterSetName parameter for
 CreateDBInstance, the response includes a list of supported character sets for each engine version.
 


listSupportedTimezones
Boolean listSupportedTimezones

 If this parameter is specified and the requested engine supports the TimeZone parameter for
 CreateDBInstance, the response includes a list of supported time zones for each engine version.
 








Class com.amazonaws.services.neptune.model.DescribeDBEngineVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


dBEngineVersions
List<E> dBEngineVersions

 A list of DBEngineVersion elements.
 








Class com.amazonaws.services.neptune.model.DescribeDBInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 The user-supplied instance identifier. If this parameter is specified, information from only the specific DB
 instance is returned. This parameter isn't case-sensitive.
 
 
 Constraints:
 
 
 
 
 If supplied, must match the identifier of an existing DBInstance.
 
 
 


filters
List<E> filters

 A filter that specifies one or more DB instances to describe.
 
 
 Supported filters:
 
 
 
 
 db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
 results list will only include information about the DB instances associated with the DB clusters identified by
 these ARNs.
 
 
 
 
 db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The
 results list will only include information about the DB instances identified by these ARNs.
 
 
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeDBInstances request. If this parameter
 is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 








Class com.amazonaws.services.neptune.model.DescribeDBInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords .
 


dBInstances
List<E> dBInstances

 A list of DBInstance instances.
 








Class com.amazonaws.services.neptune.model.DescribeDBParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBParameterGroupName
String dBParameterGroupName

 The name of a specific DB parameter group to return details for.
 
 
 Constraints:
 
 
 
 
 If supplied, must match the name of an existing DBClusterParameterGroup.
 
 
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeDBParameterGroups request. If this
 parameter is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 








Class com.amazonaws.services.neptune.model.DescribeDBParameterGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


dBParameterGroups
List<E> dBParameterGroups

 A list of DBParameterGroup instances.
 








Class com.amazonaws.services.neptune.model.DescribeDBParametersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBParameterGroupName
String dBParameterGroupName

 The name of a specific DB parameter group to return details for.
 
 
 Constraints:
 
 
 
 
 If supplied, must match the name of an existing DBParameterGroup.
 
 
 


source
String source

 The parameter types to return.
 
 
 Default: All parameter types returned
 
 
 Valid Values: user | system | engine-default
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeDBParameters request. If this parameter
 is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 








Class com.amazonaws.services.neptune.model.DescribeDBParametersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


parameters
List<E> parameters

 A list of Parameter values.
 


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.neptune.model.DescribeDBSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName

 The name of the DB subnet group to return details for.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is
 specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 








Class com.amazonaws.services.neptune.model.DescribeDBSubnetGroupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords.
 


dBSubnetGroups
List<E> dBSubnetGroups

 A list of DBSubnetGroup instances.
 








Class com.amazonaws.services.neptune.model.DescribeEngineDefaultClusterParametersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBParameterGroupFamily
String dBParameterGroupFamily

 The name of the DB cluster parameter group family to return engine parameter information for.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request.
 If this parameter is specified, the response includes only records beyond the marker, up to the value specified
 by MaxRecords.
 








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


Serialized Fields


dBParameterGroupFamily
String dBParameterGroupFamily

 The name of the DB parameter group family.
 


filters
List<E> filters

 Not currently supported.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this
 parameter is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 








Class com.amazonaws.services.neptune.model.DescribeEventCategoriesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceType
String sourceType

 The type of source that is generating the events.
 
 
 Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
 


filters
List<E> filters

 This parameter is not currently supported.
 








Class com.amazonaws.services.neptune.model.DescribeEventCategoriesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventCategoriesMapList
List<E> eventCategoriesMapList

 A list of EventCategoriesMap data types.
 








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


Serialized Fields


sourceIdentifier
String sourceIdentifier

 The identifier of the event source for which events are 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
 


endTime
Date endTime

 The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information
 about ISO 8601, go to the ISO8601 Wikipedia page.
 
 
 Example: 2009-07-08T18:00Z
 


duration
Integer duration

 The number of minutes to retrieve events for.
 
 
 Default: 60
 


eventCategories
List<E> eventCategories

 A list of event categories that trigger notifications for a event notification subscription.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the
 response includes only records beyond the marker, up to the value specified by MaxRecords.
 








Class com.amazonaws.services.neptune.model.DescribeEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous Events request. If this parameter is specified, the response
 includes only records beyond the marker, up to the value specified by MaxRecords .
 


events
List<E> events

 A list of Event instances.
 








Class com.amazonaws.services.neptune.model.DescribeEventSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subscriptionName
String subscriptionName

 The name of the event notification subscription you want to describe.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter
 is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords .
 








Class com.amazonaws.services.neptune.model.DescribeEventSubscriptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


marker
String marker

 An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter
 is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords.
 


eventSubscriptionsList
List<E> eventSubscriptionsList

 A list of EventSubscriptions data types.
 








Class com.amazonaws.services.neptune.model.DescribeOrderableDBInstanceOptionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


engine
String engine

 The name of the engine to retrieve DB instance options for.
 


engineVersion
String engineVersion

 The engine version filter value. Specify this parameter to show only the available offerings matching the
 specified engine version.
 


dBInstanceClass
String dBInstanceClass

 The DB instance class filter value. Specify this parameter to show only the available offerings matching the
 specified DB instance class.
 


licenseModel
String licenseModel

 The license model filter value. Specify this parameter to show only the available offerings matching the
 specified license model.
 


vpc
Boolean vpc

 The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
 


filters
List<E> filters

 This parameter is not currently supported.
 


maxRecords
Integer maxRecords

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


marker
String marker

 An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter
 is specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords .
 








Class com.amazonaws.services.neptune.model.DescribeOrderableDBInstanceOptionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


orderableDBInstanceOptions
List<E> orderableDBInstanceOptions

 An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
 


marker
String marker

 An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is
 specified, the response includes only records beyond the marker, up to the value specified by
 MaxRecords .
 








Class com.amazonaws.services.neptune.model.DescribePendingMaintenanceActionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceIdentifier
String resourceIdentifier

 The ARN of a resource to return pending maintenance actions for.
 


filters
List<E> filters

 A filter that specifies one or more resources to return pending maintenance actions for.
 
 
 Supported filters:
 
 
 
 
 db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The
 results list will only include pending maintenance actions for the DB clusters identified by these ARNs.
 
 
 
 
 db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only
 include pending maintenance actions for the DB instances identified by these ARNs.
 
 
 


marker
String marker

 An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If
 this parameter is specified, the response includes only records beyond the marker, up to a number of records
 specified by MaxRecords.
 


maxRecords
Integer maxRecords

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








Class com.amazonaws.services.neptune.model.DescribePendingMaintenanceActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


pendingMaintenanceActions
List<E> pendingMaintenanceActions

 A list of the pending maintenance actions for the resource.
 


marker
String marker

 An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If
 this parameter is specified, the response includes only records beyond the marker, up to a number of records
 specified by MaxRecords.
 








Class com.amazonaws.services.neptune.model.DescribeValidDBInstanceModificationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 The customer identifier or the ARN of your DB instance.
 








Class com.amazonaws.services.neptune.model.DomainMembership extends Object implements Serializable


Serialized Fields


domain
String domain

 The identifier of the Active Directory Domain.
 


status
String status

 The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).
 


fQDN
String fQDN

 The fully qualified domain name of the Active Directory Domain.
 


iAMRoleName
String iAMRoleName

 The name of the IAM role to be used when making API calls to the Directory Service.
 








Class com.amazonaws.services.neptune.model.DomainNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.DoubleRange extends Object implements Serializable


Serialized Fields


from
Double from

 The minimum value in the range.
 


to
Double to

 The maximum value in the range.
 








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


Serialized Fields


address
String address

 Specifies the DNS address of the DB instance.
 


port
Integer port

 Specifies the port that the database engine is listening on.
 


hostedZoneId
String hostedZoneId

 Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
 








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


Serialized Fields


dBParameterGroupFamily
String dBParameterGroupFamily

 Specifies the name of the DB parameter group family that the engine default parameters apply to.
 


marker
String marker

 An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the
 response includes only records beyond the marker, up to the value specified by MaxRecords .
 


parameters
List<E> parameters

 Contains a list of engine default parameters.
 








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


Serialized Fields


sourceIdentifier
String sourceIdentifier

 Provides the identifier for the source of the event.
 


sourceType
String sourceType

 Specifies the source type for this event.
 


message
String message

 Provides the text of this event.
 


eventCategories
List<E> eventCategories

 Specifies the category for the event.
 


date
Date date

 Specifies the date and time of the event.
 


sourceArn
String sourceArn

 The Amazon Resource Name (ARN) for the event.
 








Class com.amazonaws.services.neptune.model.EventCategoriesMap extends Object implements Serializable


Serialized Fields


sourceType
String sourceType

 The source type that the returned categories belong to
 


eventCategories
List<E> eventCategories

 The event categories for the specified source type
 








Class com.amazonaws.services.neptune.model.EventSubscription extends Object implements Serializable


Serialized Fields


customerAwsId
String customerAwsId

 The AWS customer account associated with the event notification subscription.
 


custSubscriptionId
String custSubscriptionId

 The event notification subscription Id.
 


snsTopicArn
String snsTopicArn

 The topic ARN of the event notification subscription.
 


status
String status

 The status of the 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 Neptune 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 event notification subscription was created.
 


sourceType
String sourceType

 The source type for the event notification subscription.
 


sourceIdsList
List<E> sourceIdsList

 A list of source IDs for the event notification subscription.
 


eventCategoriesList
List<E> eventCategoriesList

 A list of event categories for the event notification subscription.
 


enabled
Boolean enabled

 A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.
 


eventSubscriptionArn
String eventSubscriptionArn

 The Amazon Resource Name (ARN) for the event subscription.
 








Class com.amazonaws.services.neptune.model.EventSubscriptionQuotaExceededException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.FailoverDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 A DB cluster identifier to force a failover for. This parameter is not case-sensitive.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing DBCluster.
 
 
 


targetDBInstanceIdentifier
String targetDBInstanceIdentifier

 The name of the instance to promote to the primary instance.
 
 
 You must specify the instance identifier for an Read Replica in the DB cluster. For example,
 mydbcluster-replica1.
 








Class com.amazonaws.services.neptune.model.Filter extends Object implements Serializable


Serialized Fields


name
String name

 This parameter is not currently supported.
 


values
List<E> values

 This parameter is not currently supported.
 








Class com.amazonaws.services.neptune.model.InstanceQuotaExceededException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InsufficientDBClusterCapacityException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InsufficientDBInstanceCapacityException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InsufficientStorageClusterCapacityException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InvalidDBClusterSnapshotStateException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InvalidDBClusterStateException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InvalidDBInstanceStateException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InvalidDBParameterGroupStateException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InvalidDBSecurityGroupStateException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InvalidDBSnapshotStateException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InvalidDBSubnetGroupStateException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InvalidDBSubnetStateException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InvalidEventSubscriptionStateException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InvalidRestoreException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InvalidSubnetException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.InvalidVPCNetworkStateException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.KMSKeyNotAccessibleException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


resourceName
String resourceName

 The Amazon Neptune resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information
 about creating an ARN, see 
 Constructing an Amazon Resource Name (ARN).
 


filters
List<E> filters

 This parameter is not currently supported.
 








Class com.amazonaws.services.neptune.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagList
List<E> tagList

 List of tags returned by the ListTagsForResource operation.
 








Class com.amazonaws.services.neptune.model.ModifyDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group to modify.
 


parameters
List<E> parameters

 A list of parameters in the DB cluster parameter group to modify.
 








Class com.amazonaws.services.neptune.model.ModifyDBClusterParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group.
 
 
 Constraints:
 
 
 
 
 Must be 1 to 255 letters or numbers.
 
 
 
 
 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.neptune.model.ModifyDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing DBCluster.
 
 
 


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 letters, numbers, or hyphens
 
 
 
 
 The first character must be a letter
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens
 
 
 
 
 Example: my-cluster2
 


applyImmediately
Boolean applyImmediately

 A value that specifies whether the modifications in this request and any pending modifications are asynchronously
 applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB
 cluster. If this parameter is set to false, changes to the DB cluster are applied during the next
 maintenance window.
 
 
 The ApplyImmediately parameter only affects the NewDBClusterIdentifier and
 MasterUserPassword values. If you set the ApplyImmediately parameter value to false,
 then changes to the NewDBClusterIdentifier and MasterUserPassword values are applied
 during the next maintenance window. All other changes are applied immediately, regardless of the value of the
 ApplyImmediately parameter.
 
 
 Default: false
 


backupRetentionPeriod
Integer backupRetentionPeriod

 The number of days for which automated backups are retained. You must specify a minimum value of 1.
 
 
 Default: 1
 
 
 Constraints:
 
 
 
 
 Must be a value from 1 to 35
 
 
 


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group to use for the DB cluster.
 


vpcSecurityGroupIds
List<E> vpcSecurityGroupIds

 A list of VPC security groups that the DB cluster will belong to.
 


port
Integer port

 The port number on which the DB cluster accepts connections.
 
 
 Constraints: Value must be 1150-65535
 
 
 Default: The same port as the original DB cluster.
 


masterUserPassword
String masterUserPassword

 The new password for the master database user. This password can contain any printable ASCII character except
 "/", """, or "@".
 
 
 Constraints: Must contain from 8 to 41 characters.
 


optionGroupName
String optionGroupName

 (Not supported by Neptune)
 


preferredBackupWindow
String preferredBackupWindow

 The daily time range during which automated backups are created if automated backups are enabled, using the
 BackupRetentionPeriod parameter.
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.
 
 
 Constraints:
 
 
 
 
 Must be in the format hh24:mi-hh24:mi.
 
 
 
 
 Must 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
 
 
 The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring
 on a random day of the week.
 
 
 Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
 
 
 Constraints: Minimum 30-minute window.
 


enableIAMDatabaseAuthentication
Boolean enableIAMDatabaseAuthentication

 True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
 false.
 
 
 Default: false
 


cloudwatchLogsExportConfiguration
CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration

 The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
 cluster.
 


engineVersion
String engineVersion

 The version number of the database engine. Currently, setting this parameter has no effect. To upgrade your
 database engine to the most recent release, use the ApplyPendingMaintenanceAction API.
 
 
 For a list of valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
 


deletionProtection
Boolean deletionProtection

 A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when
 deletion protection is enabled. By default, deletion protection is disabled.
 








Class com.amazonaws.services.neptune.model.ModifyDBClusterSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier

 The identifier for the DB cluster snapshot to modify the attributes for.
 


attributeName
String attributeName

 The name of the DB cluster snapshot attribute to modify.
 
 
 To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to
 restore.
 


valuesToAdd
List<E> valuesToAdd

 A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.
 
 
 To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or
 more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account.
 Do not add the all value for any manual DB cluster snapshots that contain private information that
 you don't want available to all AWS accounts.
 


valuesToRemove
List<E> valuesToRemove

 A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.
 
 
 To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to
 include one or more AWS account identifiers, or all to remove authorization for any AWS account to
 copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is
 explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.
 








Class com.amazonaws.services.neptune.model.ModifyDBInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 The DB instance identifier. This value is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing DBInstance.
 
 
 


allocatedStorage
Integer allocatedStorage

 The new amount of storage (in gibibytes) to allocate for the DB instance.
 
 
 Not applicable. Storage is managed by the DB Cluster.
 


dBInstanceClass
String dBInstanceClass

 The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB
 instance classes are available in all AWS Regions.
 
 
 If you modify the DB instance class, an outage occurs during the change. The change is applied during the next
 maintenance window, unless ApplyImmediately is specified as true for this request.
 
 
 Default: Uses existing setting
 


dBSubnetGroupName
String dBSubnetGroupName

 The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different
 VPC.
 
 
 Changing the subnet group causes an outage during the change. The change is applied during the next maintenance
 window, unless you specify true for the ApplyImmediately parameter.
 
 
 Constraints: If supplied, must match the name of an existing DBSubnetGroup.
 
 
 Example: mySubnetGroup
 


dBSecurityGroups
List<E> dBSecurityGroups

 A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage
 and the change is asynchronously applied as soon as possible.
 
 
 Constraints:
 
 
 
 
 If supplied, must match existing DBSecurityGroups.
 
 
 


vpcSecurityGroupIds
List<E> vpcSecurityGroupIds

 A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon
 as possible.
 
 
 Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more
 information, see ModifyDBCluster.
 
 
 Constraints:
 
 
 
 
 If supplied, must match existing VpcSecurityGroupIds.
 
 
 


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 are applied on the next call to
 RebootDBInstance, or the next failure reboot.
 
 
 Default: false
 


masterUserPassword
String masterUserPassword

 Not applicable.
 


dBParameterGroupName
String dBParameterGroupName

 The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an
 outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied
 until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the
 parameter changes will NOT be applied during the next maintenance window.
 
 
 Default: Uses existing setting
 
 
 Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.
 


backupRetentionPeriod
Integer backupRetentionPeriod

 Not applicable. The retention period for automated backups is managed by the DB cluster. For more information,
 see ModifyDBCluster.
 
 
 Default: Uses existing setting
 


preferredBackupWindow
String preferredBackupWindow

 The daily time range during which automated backups are created if automated backups are enabled.
 
 
 Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more
 information, see ModifyDBCluster.
 
 
 Constraints:
 
 
 
 
 Must be in the format hh24:mi-hh24:mi
 
 
 
 
 Must 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 doesn't result in an outage, except in the following situation, and the change is
 asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance
 window is changed to include the current time, then changing this parameter will cause a reboot of the DB
 instance. If moving this window to the current time, there must be at least 30 minutes between the current time
 and end of the window to ensure pending changes are applied.
 
 
 Default: Uses existing setting
 
 
 Format: ddd:hh24:mi-ddd:hh24:mi
 
 
 Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
 
 
 Constraints: Must be at least 30 minutes
 


multiAZ
Boolean multiAZ

 Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't 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.
 


engineVersion
String engineVersion

 The version number of the database engine to upgrade to. Currently, setting this parameter has no effect. To
 upgrade your database engine to the most recent release, use the ApplyPendingMaintenanceAction API.
 


allowMajorVersionUpgrade
Boolean allowMajorVersionUpgrade

 Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the
 change is asynchronously applied as soon as possible.
 


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade

 Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
 Changing this parameter doesn't 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 Neptune has enabled auto patching for that engine
 version.
 


licenseModel
String licenseModel

 Not supported.
 


iops
Integer iops

 The new Provisioned IOPS (I/O operations per second) value for the instance.
 
 
 Changing this setting doesn't 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
 


optionGroupName
String optionGroupName

 (Not supported by Neptune)
 


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 letters, numbers, or hyphens.
 
 
 
 
 The first character must be a letter.
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 
 
 
 Example: mydbinstance
 


storageType
String storageType

 Not supported.
 


tdeCredentialArn
String tdeCredentialArn

 The ARN from the key store with which to associate the instance for TDE encryption.
 


tdeCredentialPassword
String tdeCredentialPassword

 The password for the given ARN from the key store in order to access the device.
 


cACertificateIdentifier
String cACertificateIdentifier

 Indicates the certificate that needs to be associated with the instance.
 


domain
String domain

 Not supported.
 


copyTagsToSnapshot
Boolean copyTagsToSnapshot

 True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is
 false.
 


monitoringInterval
Integer monitoringInterval

 The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To
 disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.
 
 
 If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value
 other than 0.
 
 
 Valid Values: 0, 1, 5, 10, 15, 30, 60
 


dBPortNumber
Integer dBPortNumber

 The port number on which the database accepts connections.
 
 
 The value of the DBPortNumber parameter must not match any of the port values specified for options
 in the option group for the DB instance.
 
 
 Your database will restart when you change the DBPortNumber value regardless of the value of the
 ApplyImmediately parameter.
 
 
 Default: 8182
 


publiclyAccessible
Boolean publiclyAccessible
Deprecated. 

 This flag should no longer be used.
 


monitoringRoleArn
String monitoringRoleArn

 The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For
 example, arn:aws:iam:123456789012:role/emaccess.
 
 
 If MonitoringInterval is set to a value other than 0, then you must supply a
 MonitoringRoleArn value.
 


domainIAMRoleName
String domainIAMRoleName

 Not supported
 


promotionTier
Integer promotionTier

 A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of
 the existing primary instance.
 
 
 Default: 1
 
 
 Valid Values: 0 - 15
 


enableIAMDatabaseAuthentication
Boolean enableIAMDatabaseAuthentication

 True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
 false.
 
 
 You can enable IAM database authentication for the following database engines
 
 
 Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information,
 see ModifyDBCluster.
 
 
 Default: false
 


enablePerformanceInsights
Boolean enablePerformanceInsights

 (Not supported by Neptune)
 


performanceInsightsKMSKeyId
String performanceInsightsKMSKeyId

 (Not supported by Neptune)
 


cloudwatchLogsExportConfiguration
CloudwatchLogsExportConfiguration cloudwatchLogsExportConfiguration

 The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB
 instance or DB cluster.
 


deletionProtection
Boolean deletionProtection

 A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted
 when deletion protection is enabled. By default, deletion protection is disabled.
 








Class com.amazonaws.services.neptune.model.ModifyDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBParameterGroupName
String dBParameterGroupName

 The name of the DB parameter group.
 
 
 Constraints:
 
 
 
 
 If supplied, must match the name of an existing DBParameterGroup.
 
 
 


parameters
List<E> 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.neptune.model.ModifyDBParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dBParameterGroupName
String dBParameterGroupName

 Provides the name of the DB parameter group.
 








Class com.amazonaws.services.neptune.model.ModifyDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName

 The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet
 group.
 
 
 Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.
 
 
 Example: mySubnetgroup
 


dBSubnetGroupDescription
String dBSubnetGroupDescription

 The description for the DB subnet group.
 


subnetIds
List<E> subnetIds

 The EC2 subnet IDs for the DB subnet group.
 








Class com.amazonaws.services.neptune.model.ModifyEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subscriptionName
String subscriptionName

 The name of the event notification subscription.
 


snsTopicArn
String snsTopicArn

 The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS
 when you create a topic and subscribe to it.
 


sourceType
String sourceType

 The type of source that is generating the events. For example, if you want to be notified of events generated by
 a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are
 returned.
 
 
 Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot
 


eventCategories
List<E> 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 by using the DescribeEventCategories action.
 


enabled
Boolean enabled

 A Boolean value; set to true to activate the subscription.
 








Class com.amazonaws.services.neptune.model.OptionGroupMembership extends Object implements Serializable


Serialized Fields


optionGroupName
String optionGroupName

 The name of the option group that the instance belongs to.
 


status
String status

 The status of the DB instance's option group membership. Valid values are: in-sync,
 pending-apply, pending-removal, pending-maintenance-apply,
 pending-maintenance-removal, applying, removing, and failed.
 








Class com.amazonaws.services.neptune.model.OptionGroupNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.OrderableDBInstanceOption extends Object implements Serializable


Serialized Fields


engine
String engine

 The engine type of a DB instance.
 


engineVersion
String engineVersion

 The engine version of a DB instance.
 


dBInstanceClass
String dBInstanceClass

 The DB instance class for a DB instance.
 


licenseModel
String licenseModel

 The license model for a DB instance.
 


availabilityZones
List<E> availabilityZones

 A list of Availability Zones for a DB instance.
 


multiAZCapable
Boolean multiAZCapable

 Indicates whether a DB instance is Multi-AZ capable.
 


readReplicaCapable
Boolean readReplicaCapable

 Indicates whether a DB instance can have a Read Replica.
 


vpc
Boolean vpc

 Indicates whether a DB instance is in a VPC.
 


supportsStorageEncryption
Boolean supportsStorageEncryption

 Indicates whether a DB instance supports encrypted storage.
 


storageType
String storageType

 Indicates the storage type for a DB instance.
 


supportsIops
Boolean supportsIops

 Indicates whether a DB instance supports provisioned IOPS.
 


supportsEnhancedMonitoring
Boolean supportsEnhancedMonitoring

 Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
 


supportsIAMDatabaseAuthentication
Boolean supportsIAMDatabaseAuthentication

 Indicates whether a DB instance supports IAM database authentication.
 


supportsPerformanceInsights
Boolean supportsPerformanceInsights

 (Not supported by Neptune)
 


minStorageSize
Integer minStorageSize

 Minimum storage size for a DB instance.
 


maxStorageSize
Integer maxStorageSize

 Maximum storage size for a DB instance.
 


minIopsPerDbInstance
Integer minIopsPerDbInstance

 Minimum total provisioned IOPS for a DB instance.
 


maxIopsPerDbInstance
Integer maxIopsPerDbInstance

 Maximum total provisioned IOPS for a DB instance.
 


minIopsPerGib
Double minIopsPerGib

 Minimum provisioned IOPS per GiB for a DB instance.
 


maxIopsPerGib
Double maxIopsPerGib

 Maximum provisioned IOPS per GiB for a DB instance.
 








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


Serialized Fields


parameterName
String parameterName

 Specifies the name of the parameter.
 


parameterValue
String parameterValue

 Specifies the value of the parameter.
 


description
String description

 Provides a description of the parameter.
 


source
String source

 Indicates the source of the parameter value.
 


applyType
String applyType

 Specifies the engine specific parameters type.
 


dataType
String dataType

 Specifies the valid data type for the parameter.
 


allowedValues
String allowedValues

 Specifies the valid range of values for the parameter.
 


isModifiable
Boolean isModifiable

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


minimumEngineVersion
String minimumEngineVersion

 The earliest engine version to which the parameter can apply.
 


applyMethod
String applyMethod

 Indicates when to apply parameter updates.
 








Class com.amazonaws.services.neptune.model.PendingCloudwatchLogsExports extends Object implements Serializable


Serialized Fields


logTypesToEnable
List<E> logTypesToEnable

 Log types that are in the process of being deactivated. After they are deactivated, these log types aren't
 exported to CloudWatch Logs.
 


logTypesToDisable
List<E> logTypesToDisable

 Log types that are in the process of being enabled. After they are enabled, these log types are exported to
 CloudWatch Logs.
 








Class com.amazonaws.services.neptune.model.PendingMaintenanceAction extends Object implements Serializable


Serialized Fields


action
String action

 The type of pending maintenance action that is available for the resource.
 


autoAppliedAfterDate
Date autoAppliedAfterDate

 The date of the maintenance window when the action is applied. The maintenance action is applied to the resource
 during its first maintenance window after this date. If this date is specified, any next-maintenance
 opt-in requests are ignored.
 


forcedApplyDate
Date forcedApplyDate

 The date when the maintenance action is automatically applied. The maintenance action is applied to the resource
 on this date regardless of the maintenance window for the resource. If this date is specified, any
 immediate opt-in requests are ignored.
 


optInStatus
String optInStatus

 Indicates the type of opt-in request that has been received for the resource.
 


currentApplyDate
Date currentApplyDate

 The effective date when the pending maintenance action is applied to the resource. This date takes into account
 opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate
 , and the ForcedApplyDate. This value is blank if an opt-in request has not been received and
 nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.
 


description
String description

 A description providing more detail about the maintenance action.
 








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


Serialized Fields


dBInstanceClass
String dBInstanceClass

 Contains the new DBInstanceClass for the DB instance that will be applied or is currently being
 applied.
 


allocatedStorage
Integer allocatedStorage

 Contains the new AllocatedStorage size for the DB instance that will be applied or is currently
 being applied.
 


masterUserPassword
String masterUserPassword

 Contains the pending or currently-in-progress change of the master credentials for the DB instance.
 


port
Integer port

 Specifies the pending port for the DB instance.
 


backupRetentionPeriod
Integer backupRetentionPeriod

 Specifies the pending number of days for which automated backups are retained.
 


multiAZ
Boolean multiAZ

 Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.
 


engineVersion
String engineVersion

 Indicates the database engine version.
 


licenseModel
String licenseModel

 The license model for the DB instance.
 
 
 Valid values: license-included | bring-your-own-license |
 general-public-license
 


iops
Integer iops

 Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.
 


dBInstanceIdentifier
String dBInstanceIdentifier

 Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being
 applied.
 


storageType
String storageType

 Specifies the storage type to be associated with the DB instance.
 


cACertificateIdentifier
String cACertificateIdentifier

 Specifies the identifier of the CA certificate for the DB instance.
 


dBSubnetGroupName
String dBSubnetGroupName

 The new DB subnet group for the DB instance.
 


pendingCloudwatchLogsExports
PendingCloudwatchLogsExports pendingCloudwatchLogsExports

 This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are
 enabled and which are disabled.
 








Class com.amazonaws.services.neptune.model.PromoteReadReplicaDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 Not supported.
 








Class com.amazonaws.services.neptune.model.ProvisionedIopsNotAvailableInAZException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.Range extends Object implements Serializable


Serialized Fields


from
Integer from

 The minimum value in the range.
 


to
Integer to

 The maximum value in the range.
 


step
Integer step

 The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000,
 the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid
 value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...
 








Class com.amazonaws.services.neptune.model.RebootDBInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier

 The DB instance identifier. This parameter is stored as a lowercase string.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing DBInstance.
 
 
 


forceFailover
Boolean forceFailover

 When true, the reboot is conducted through a MultiAZ failover.
 
 
 Constraint: You can't specify true if the instance is not configured for MultiAZ.
 








Class com.amazonaws.services.neptune.model.RemoveRoleFromDBClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The name of the DB cluster to disassociate the IAM role from.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB cluster, for example
 arn:aws:iam::123456789012:role/NeptuneAccessRole.
 








Class com.amazonaws.services.neptune.model.RemoveRoleFromDBClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.neptune.model.RemoveSourceIdentifierFromSubscriptionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


subscriptionName
String subscriptionName

 The name of the event notification subscription you want to remove a source identifier from.
 


sourceIdentifier
String sourceIdentifier

 The source identifier to be removed from the subscription, such as the DB instance identifier for a DB
 instance or the name of a security group.
 








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


Serialized Fields


resourceName
String resourceName

 The Amazon Neptune resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For
 information about creating an ARN, see 
 Constructing an Amazon Resource Name (ARN).
 


tagKeys
List<E> tagKeys

 The tag key (name) of the tag to be removed.
 








Class com.amazonaws.services.neptune.model.RemoveTagsFromResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.neptune.model.ResetDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group to reset.
 


resetAllParameters
Boolean resetAllParameters

 A value that is set to true to reset all parameters in the DB cluster parameter group to their
 default values, and false otherwise. You can't use this parameter if there is a list of parameter
 names specified for the Parameters parameter.
 


parameters
List<E> parameters

 A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this
 parameter if the ResetAllParameters parameter is set to true.
 








Class com.amazonaws.services.neptune.model.ResetDBClusterParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group.
 
 
 Constraints:
 
 
 
 
 Must be 1 to 255 letters or numbers.
 
 
 
 
 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.neptune.model.ResetDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBParameterGroupName
String dBParameterGroupName

 The name of the DB parameter group.
 
 
 Constraints:
 
 
 
 
 Must match the name of an existing DBParameterGroup.
 
 
 


resetAllParameters
Boolean resetAllParameters

 Specifies whether (true) or not (false) to reset all parameters in the DB parameter
 group to default values.
 
 
 Default: true
 


parameters
List<E> parameters

 To reset the entire DB parameter group, specify the DBParameterGroup name and
 ResetAllParameters parameters. To reset specific parameters, provide a list of the following:
 ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single
 request.
 
 
 Valid Values (for Apply method): pending-reboot
 








Class com.amazonaws.services.neptune.model.ResetDBParameterGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


dBParameterGroupName
String dBParameterGroupName

 Provides the name of the DB parameter group.
 








Class com.amazonaws.services.neptune.model.ResourceNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.ResourcePendingMaintenanceActions extends Object implements Serializable


Serialized Fields


resourceIdentifier
String resourceIdentifier

 The ARN of the resource that has pending maintenance actions.
 


pendingMaintenanceActionDetails
List<E> pendingMaintenanceActionDetails

 A list that provides details about the pending maintenance actions for the resource.
 








Class com.amazonaws.services.neptune.model.RestoreDBClusterFromSnapshotRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


availabilityZones
List<E> availabilityZones

 Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
 


dBClusterIdentifier
String dBClusterIdentifier

 The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't
 case-sensitive.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 letters, numbers, or hyphens
 
 
 
 
 First character must be a letter
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens
 
 
 
 
 Example: my-snapshot-id
 


snapshotIdentifier
String snapshotIdentifier

 The identifier for the DB snapshot or DB cluster snapshot to restore from.
 
 
 You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can
 use only the ARN to specify a DB snapshot.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing Snapshot.
 
 
 


engine
String engine

 The database engine to use for the new DB cluster.
 
 
 Default: The same as source
 
 
 Constraint: Must be compatible with the engine of the source
 


engineVersion
String engineVersion

 The version of the database engine to use for the new DB cluster.
 


port
Integer port

 The port number on which the new DB cluster accepts connections.
 
 
 Constraints: Value must be 1150-65535
 
 
 Default: The same port as the original DB cluster.
 


dBSubnetGroupName
String dBSubnetGroupName

 The name of the DB subnet group to use for the new DB cluster.
 
 
 Constraints: If supplied, must match the name of an existing DBSubnetGroup.
 
 
 Example: mySubnetgroup
 


databaseName
String databaseName

 Not supported.
 


optionGroupName
String optionGroupName

 (Not supported by Neptune)
 


vpcSecurityGroupIds
List<E> vpcSecurityGroupIds

 A list of VPC security groups that the new DB cluster will belong to.
 


tags
List<E> tags

 The tags to be assigned to the restored DB cluster.
 


kmsKeyId
String kmsKeyId

 The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or 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 snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB
 cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
 
 
 
 
 If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored
 DB cluster is not encrypted.
 
 
 


enableIAMDatabaseAuthentication
Boolean enableIAMDatabaseAuthentication

 True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
 false.
 
 
 Default: false
 


enableCloudwatchLogsExports
List<E> enableCloudwatchLogsExports

 The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
 


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group to associate with the new DB cluster.
 
 
 Constraints:
 
 
 
 
 If supplied, must match the name of an existing DBClusterParameterGroup.
 
 
 


deletionProtection
Boolean deletionProtection

 A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when
 deletion protection is enabled. By default, deletion protection is disabled.
 








Class com.amazonaws.services.neptune.model.RestoreDBClusterToPointInTimeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier

 The name of the new DB cluster to be created.
 
 
 Constraints:
 
 
 
 
 Must contain from 1 to 63 letters, numbers, or hyphens
 
 
 
 
 First character must be a letter
 
 
 
 
 Cannot end with a hyphen or contain two consecutive hyphens
 
 
 


restoreType
String restoreType

 The type of restore to be performed. You can specify one of the following values:
 
 
 
 
 full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
 
 
 
 
 copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.
 
 
 
 
 If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the
 source DB cluster.
 


sourceDBClusterIdentifier
String sourceDBClusterIdentifier

 The identifier of the source DB cluster from which to restore.
 
 
 Constraints:
 
 
 
 
 Must match the identifier of an existing DBCluster.
 
 
 


restoreToTime
Date restoreToTime

 The date and time to restore the DB cluster to.
 
 
 Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
 
 
 Constraints:
 
 
 
 
 Must be before the latest restorable time for the DB instance
 
 
 
 
 Must be specified if UseLatestRestorableTime parameter is not provided
 
 
 
 
 Cannot be specified if UseLatestRestorableTime parameter is true
 
 
 
 
 Cannot be specified if RestoreType parameter is copy-on-write
 
 
 
 
 Example: 2015-03-07T23:45:00Z
 


useLatestRestorableTime
Boolean useLatestRestorableTime

 A value that is set to true to restore the DB cluster to the latest restorable backup time, and
 false otherwise.
 
 
 Default: false
 
 
 Constraints: Cannot be specified if RestoreToTime parameter is provided.
 


port
Integer port

 The port number on which the new DB cluster accepts connections.
 
 
 Constraints: Value must be 1150-65535
 
 
 Default: The same port as the original DB cluster.
 


dBSubnetGroupName
String dBSubnetGroupName

 The DB subnet group name to use for the new DB cluster.
 
 
 Constraints: If supplied, must match the name of an existing DBSubnetGroup.
 
 
 Example: mySubnetgroup
 


optionGroupName
String optionGroupName

 (Not supported by Neptune)
 


vpcSecurityGroupIds
List<E> vpcSecurityGroupIds

 A list of VPC security groups that the new DB cluster belongs to.
 


tags
List<E> tags

 The tags to be applied to the restored DB cluster.
 


kmsKeyId
String kmsKeyId

 The AWS 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 is 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 not encrypted, then the restore request is
 rejected.
 


enableIAMDatabaseAuthentication
Boolean enableIAMDatabaseAuthentication

 True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
 false.
 
 
 Default: false
 


enableCloudwatchLogsExports
List<E> enableCloudwatchLogsExports

 The list of logs that the restored DB cluster is to export to CloudWatch Logs.
 


dBClusterParameterGroupName
String dBClusterParameterGroupName

 The name of the DB cluster parameter group to associate with the new DB cluster.
 
 
 Constraints:
 
 
 
 
 If supplied, must match the name of an existing DBClusterParameterGroup.
 
 
 


deletionProtection
Boolean deletionProtection

 A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when
 deletion protection is enabled. By default, deletion protection is disabled.
 








Class com.amazonaws.services.neptune.model.SharedSnapshotQuotaExceededException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.SnapshotQuotaExceededException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.SNSInvalidTopicException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.SNSNoAuthorizationException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.SNSTopicArnNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.SourceNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.StorageQuotaExceededException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.StorageTypeNotSupportedException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.Subnet extends Object implements Serializable


Serialized Fields


subnetIdentifier
String subnetIdentifier

 Specifies the identifier of the subnet.
 


subnetAvailabilityZone
AvailabilityZone subnetAvailabilityZone

 Specifies the EC2 Availability Zone that the subnet is in.
 


subnetStatus
String subnetStatus

 Specifies the status of the subnet.
 








Class com.amazonaws.services.neptune.model.SubnetAlreadyInUseException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.SubscriptionAlreadyExistException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.SubscriptionCategoryNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.SubscriptionNotFoundException extends AmazonNeptuneException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.neptune.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and
 can't be prefixed with "aws:" or "rds:". 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
 can't be prefixed with "aws:" or "rds:". 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.neptune.model.Timezone extends Object implements Serializable


Serialized Fields


timezoneName
String timezoneName

 The name of the time zone.
 








Class com.amazonaws.services.neptune.model.UpgradeTarget extends Object implements Serializable


Serialized Fields


engine
String engine

 The name of the upgrade target database engine.
 


engineVersion
String engineVersion

 The version number of the upgrade target database engine.
 


description
String description

 The version of the database engine that a DB instance can be upgraded to.
 


autoUpgrade
Boolean autoUpgrade

 A value that indicates whether the target version is applied to any source DB instances that have
 AutoMinorVersionUpgrade set to true.
 


isMajorVersionUpgrade
Boolean isMajorVersionUpgrade

 A value that indicates whether a database engine is upgraded to a major version.
 








Class com.amazonaws.services.neptune.model.ValidDBInstanceModificationsMessage extends Object implements Serializable


Serialized Fields


storage
List<E> storage

 Valid storage options for your DB instance.
 








Class com.amazonaws.services.neptune.model.ValidStorageOptions extends Object implements Serializable


Serialized Fields


storageType
String storageType

 The valid storage types for your DB instance. For example, gp2, io1.
 


storageSize
List<E> storageSize

 The valid range of storage in gibibytes. For example, 100 to 16384.
 


provisionedIops
List<E> provisionedIops

 The valid range of provisioned IOPS. For example, 1000-20000.
 


iopsToStorageRatio
List<E> iopsToStorageRatio

 The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that
 provisioned IOPS can be between 3 and 10 times storage.
 








Class com.amazonaws.services.neptune.model.VpcSecurityGroupMembership extends Object implements Serializable


Serialized Fields


vpcSecurityGroupId
String vpcSecurityGroupId

 The name of the VPC security group.
 


status
String status

 The status of the VPC security group.
 








Package com.amazonaws.services.networkmanager.model




Class com.amazonaws.services.networkmanager.model.AccessDeniedException extends AWSNetworkManagerException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.networkmanager.model.AssociateCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


customerGatewayArn
String customerGatewayArn

 The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.
 


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


deviceId
String deviceId

 The ID of the device.
 


linkId
String linkId

 The ID of the link.
 








Class com.amazonaws.services.networkmanager.model.AssociateCustomerGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


customerGatewayAssociation
CustomerGatewayAssociation customerGatewayAssociation

 The customer gateway association.
 








Class com.amazonaws.services.networkmanager.model.AssociateLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


deviceId
String deviceId

 The ID of the device.
 


linkId
String linkId

 The ID of the link.
 








Class com.amazonaws.services.networkmanager.model.AssociateLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


linkAssociation
LinkAssociation linkAssociation

 The link association.
 








Class com.amazonaws.services.networkmanager.model.AWSNetworkManagerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.networkmanager.model.Bandwidth extends Object implements Serializable


Serialized Fields


uploadSpeed
Integer uploadSpeed

 Upload speed in Mbps.
 


downloadSpeed
Integer downloadSpeed

 Download speed in Mbps.
 








Class com.amazonaws.services.networkmanager.model.ConflictException extends AWSNetworkManagerException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceId
String resourceId

 The ID of the resource.
 


resourceType
String resourceType

 The resource type.
 








Class com.amazonaws.services.networkmanager.model.CreateDeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


description
String description

 A description of the device.
 
 
 Length Constraints: Maximum length of 256 characters.
 


type
String type

 The type of the device.
 


vendor
String vendor

 The vendor of the device.
 
 
 Length Constraints: Maximum length of 128 characters.
 


model
String model

 The model of the device.
 
 
 Length Constraints: Maximum length of 128 characters.
 


serialNumber
String serialNumber

 The serial number of the device.
 
 
 Length Constraints: Maximum length of 128 characters.
 


location
Location location

 The location of the device.
 


siteId
String siteId

 The ID of the site.
 


tags
List<E> tags

 The tags to apply to the resource during creation.
 








Class com.amazonaws.services.networkmanager.model.CreateDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


device
Device device

 Information about the device.
 








Class com.amazonaws.services.networkmanager.model.CreateGlobalNetworkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


description
String description

 A description of the global network.
 
 
 Length Constraints: Maximum length of 256 characters.
 


tags
List<E> tags

 The tags to apply to the resource during creation.
 








Class com.amazonaws.services.networkmanager.model.CreateGlobalNetworkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


globalNetwork
GlobalNetwork globalNetwork

 Information about the global network object.
 








Class com.amazonaws.services.networkmanager.model.CreateLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


description
String description

 A description of the link.
 
 
 Length Constraints: Maximum length of 256 characters.
 


type
String type

 The type of the link.
 
 
 Constraints: Cannot include the following characters: | \ ^
 
 
 Length Constraints: Maximum length of 128 characters.
 


bandwidth
Bandwidth bandwidth

 The upload speed and download speed in Mbps.
 


provider
String provider

 The provider of the link.
 
 
 Constraints: Cannot include the following characters: | \ ^
 
 
 Length Constraints: Maximum length of 128 characters.
 


siteId
String siteId

 The ID of the site.
 


tags
List<E> tags

 The tags to apply to the resource during creation.
 








Class com.amazonaws.services.networkmanager.model.CreateLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


link
Link link

 Information about the link.
 








Class com.amazonaws.services.networkmanager.model.CreateSiteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


description
String description

 A description of your site.
 
 
 Length Constraints: Maximum length of 256 characters.
 


location
Location location

 The site location. This information is used for visualization in the Network Manager console. If you specify the
 address, the latitude and longitude are automatically calculated.
 
 
 
 
 Address: The physical address of the site.
 
 
 
 
 Latitude: The latitude of the site.
 
 
 
 
 Longitude: The longitude of the site.
 
 
 


tags
List<E> tags

 The tags to apply to the resource during creation.
 








Class com.amazonaws.services.networkmanager.model.CreateSiteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


site
Site site

 Information about the site.
 








Class com.amazonaws.services.networkmanager.model.CustomerGatewayAssociation extends Object implements Serializable


Serialized Fields


customerGatewayArn
String customerGatewayArn

 The Amazon Resource Name (ARN) of the customer gateway.
 


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


deviceId
String deviceId

 The ID of the device.
 


linkId
String linkId

 The ID of the link.
 


state
String state

 The association state.
 








Class com.amazonaws.services.networkmanager.model.DeleteDeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


deviceId
String deviceId

 The ID of the device.
 








Class com.amazonaws.services.networkmanager.model.DeleteDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


device
Device device

 Information about the device.
 








Class com.amazonaws.services.networkmanager.model.DeleteGlobalNetworkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 








Class com.amazonaws.services.networkmanager.model.DeleteGlobalNetworkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


globalNetwork
GlobalNetwork globalNetwork

 Information about the global network.
 








Class com.amazonaws.services.networkmanager.model.DeleteLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


linkId
String linkId

 The ID of the link.
 








Class com.amazonaws.services.networkmanager.model.DeleteLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


link
Link link

 Information about the link.
 








Class com.amazonaws.services.networkmanager.model.DeleteSiteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


siteId
String siteId

 The ID of the site.
 








Class com.amazonaws.services.networkmanager.model.DeleteSiteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


site
Site site

 Information about the site.
 








Class com.amazonaws.services.networkmanager.model.DeregisterTransitGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


transitGatewayArn
String transitGatewayArn

 The Amazon Resource Name (ARN) of the transit gateway.
 








Class com.amazonaws.services.networkmanager.model.DeregisterTransitGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayRegistration
TransitGatewayRegistration transitGatewayRegistration

 The transit gateway registration information.
 








Class com.amazonaws.services.networkmanager.model.DescribeGlobalNetworksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkIds
List<E> globalNetworkIds

 The IDs of one or more global networks. The maximum is 10.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.DescribeGlobalNetworksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


globalNetworks
List<E> globalNetworks

 Information about the global networks.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.Device extends Object implements Serializable


Serialized Fields


deviceId
String deviceId

 The ID of the device.
 


deviceArn
String deviceArn

 The Amazon Resource Name (ARN) of the device.
 


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


description
String description

 The description of the device.
 


type
String type

 The device type.
 


vendor
String vendor

 The device vendor.
 


model
String model

 The device model.
 


serialNumber
String serialNumber

 The device serial number.
 


location
Location location

 The site location.
 


siteId
String siteId

 The site ID.
 


createdAt
Date createdAt

 The date and time that the site was created.
 


state
String state

 The device state.
 


tags
List<E> tags

 The tags for the device.
 








Class com.amazonaws.services.networkmanager.model.DisassociateCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


customerGatewayArn
String customerGatewayArn

 The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.
 








Class com.amazonaws.services.networkmanager.model.DisassociateCustomerGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


customerGatewayAssociation
CustomerGatewayAssociation customerGatewayAssociation

 Information about the customer gateway association.
 








Class com.amazonaws.services.networkmanager.model.DisassociateLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


deviceId
String deviceId

 The ID of the device.
 


linkId
String linkId

 The ID of the link.
 








Class com.amazonaws.services.networkmanager.model.DisassociateLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


linkAssociation
LinkAssociation linkAssociation

 Information about the link association.
 








Class com.amazonaws.services.networkmanager.model.GetCustomerGatewayAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


customerGatewayArns
List<E> customerGatewayArns

 One or more customer gateway Amazon Resource Names (ARNs). For more information, see Resources Defined by Amazon EC2. The maximum is 10.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.GetCustomerGatewayAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


customerGatewayAssociations
List<E> customerGatewayAssociations

 The customer gateway associations.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.GetDevicesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


deviceIds
List<E> deviceIds

 One or more device IDs. The maximum is 10.
 


siteId
String siteId

 The ID of the site.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.GetDevicesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


devices
List<E> devices

 The devices.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.GetLinkAssociationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


deviceId
String deviceId

 The ID of the device.
 


linkId
String linkId

 The ID of the link.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.GetLinkAssociationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


linkAssociations
List<E> linkAssociations

 The link associations.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.GetLinksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


linkIds
List<E> linkIds

 One or more link IDs. The maximum is 10.
 


siteId
String siteId

 The ID of the site.
 


type
String type

 The link type.
 


provider
String provider

 The link provider.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.GetLinksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


links
List<E> links

 The links.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.GetSitesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


siteIds
List<E> siteIds

 One or more site IDs. The maximum is 10.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.GetSitesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sites
List<E> sites

 The sites.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.GetTransitGatewayRegistrationsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


transitGatewayArns
List<E> transitGatewayArns

 The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.GetTransitGatewayRegistrationsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayRegistrations
List<E> transitGatewayRegistrations

 The transit gateway registrations.
 


nextToken
String nextToken

 The token for the next page of results.
 








Class com.amazonaws.services.networkmanager.model.GlobalNetwork extends Object implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


globalNetworkArn
String globalNetworkArn

 The Amazon Resource Name (ARN) of the global network.
 


description
String description

 The description of the global network.
 


createdAt
Date createdAt

 The date and time that the global network was created.
 


state
String state

 The state of the global network.
 


tags
List<E> tags

 The tags for the global network.
 








Class com.amazonaws.services.networkmanager.model.InternalServerException extends AWSNetworkManagerException implements Serializable

serialVersionUID:
1L



Serialized Fields


retryAfterSeconds
Integer retryAfterSeconds

 Indicates when to retry the request.
 








Class com.amazonaws.services.networkmanager.model.Link extends Object implements Serializable


Serialized Fields


linkId
String linkId

 The ID of the link.
 


linkArn
String linkArn

 The Amazon Resource Name (ARN) of the link.
 


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


siteId
String siteId

 The ID of the site.
 


description
String description

 The description of the link.
 


type
String type

 The type of the link.
 


bandwidth
Bandwidth bandwidth

 The bandwidth for the link.
 


provider
String provider

 The provider of the link.
 


createdAt
Date createdAt

 The date and time that the link was created.
 


state
String state

 The state of the link.
 


tags
List<E> tags

 The tags for the link.
 








Class com.amazonaws.services.networkmanager.model.LinkAssociation extends Object implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


deviceId
String deviceId

 The device ID for the link association.
 


linkId
String linkId

 The ID of the link.
 


linkAssociationState
String linkAssociationState

 The state of the association.
 








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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 








Class com.amazonaws.services.networkmanager.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tagList
List<E> tagList

 The list of tags.
 








Class com.amazonaws.services.networkmanager.model.Location extends Object implements Serializable


Serialized Fields


address
String address

 The physical address.
 


latitude
String latitude

 The latitude.
 


longitude
String longitude

 The longitude.
 








Class com.amazonaws.services.networkmanager.model.RegisterTransitGatewayRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


transitGatewayArn
String transitGatewayArn

 The Amazon Resource Name (ARN) of the transit gateway. For more information, see Resources Defined by Amazon EC2.
 








Class com.amazonaws.services.networkmanager.model.RegisterTransitGatewayResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


transitGatewayRegistration
TransitGatewayRegistration transitGatewayRegistration

 Information about the transit gateway registration.
 








Class com.amazonaws.services.networkmanager.model.ResourceNotFoundException extends AWSNetworkManagerException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceId
String resourceId

 The ID of the resource.
 


resourceType
String resourceType

 The resource type.
 








Class com.amazonaws.services.networkmanager.model.ServiceQuotaExceededException extends AWSNetworkManagerException implements Serializable

serialVersionUID:
1L



Serialized Fields


resourceId
String resourceId

 The ID of the resource.
 


resourceType
String resourceType

 The resource type.
 


limitCode
String limitCode

 The limit code.
 


serviceCode
String serviceCode

 The service code.
 








Class com.amazonaws.services.networkmanager.model.Site extends Object implements Serializable


Serialized Fields


siteId
String siteId

 The ID of the site.
 


siteArn
String siteArn

 The Amazon Resource Name (ARN) of the site.
 


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


description
String description

 The description of the site.
 


location
Location location

 The location of the site.
 


createdAt
Date createdAt

 The date and time that the site was created.
 


state
String state

 The state of the site.
 


tags
List<E> tags

 The tags for the site.
 








Class com.amazonaws.services.networkmanager.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The tag key.
 
 
 Length Constraints: Maximum length of 128 characters.
 


value
String value

 The tag value.
 
 
 Length Constraints: Maximum length of 256 characters.
 








Class com.amazonaws.services.networkmanager.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 


tags
List<E> tags

 The tags to apply to the specified resource.
 








Class com.amazonaws.services.networkmanager.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.networkmanager.model.ThrottlingException extends AWSNetworkManagerException implements Serializable

serialVersionUID:
1L



Serialized Fields


retryAfterSeconds
Integer retryAfterSeconds

 Indicates when to retry the request.
 








Class com.amazonaws.services.networkmanager.model.TransitGatewayRegistration extends Object implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


transitGatewayArn
String transitGatewayArn

 The Amazon Resource Name (ARN) of the transit gateway.
 


state
TransitGatewayRegistrationStateReason state

 The state of the transit gateway registration.
 








Class com.amazonaws.services.networkmanager.model.TransitGatewayRegistrationStateReason extends Object implements Serializable


Serialized Fields


code
String code

 The code for the state reason.
 


message
String message

 The message for the state reason.
 








Class com.amazonaws.services.networkmanager.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Name (ARN) of the resource.
 


tagKeys
List<E> tagKeys

 The tag keys to remove from the specified resource.
 








Class com.amazonaws.services.networkmanager.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.networkmanager.model.UpdateDeviceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


deviceId
String deviceId

 The ID of the device.
 


description
String description

 A description of the device.
 
 
 Length Constraints: Maximum length of 256 characters.
 


type
String type

 The type of the device.
 


vendor
String vendor

 The vendor of the device.
 
 
 Length Constraints: Maximum length of 128 characters.
 


model
String model

 The model of the device.
 
 
 Length Constraints: Maximum length of 128 characters.
 


serialNumber
String serialNumber

 The serial number of the device.
 
 
 Length Constraints: Maximum length of 128 characters.
 


location
Location location


siteId
String siteId

 The ID of the site.
 








Class com.amazonaws.services.networkmanager.model.UpdateDeviceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


device
Device device

 Information about the device.
 








Class com.amazonaws.services.networkmanager.model.UpdateGlobalNetworkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of your global network.
 


description
String description

 A description of the global network.
 
 
 Length Constraints: Maximum length of 256 characters.
 








Class com.amazonaws.services.networkmanager.model.UpdateGlobalNetworkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


globalNetwork
GlobalNetwork globalNetwork

 Information about the global network object.
 








Class com.amazonaws.services.networkmanager.model.UpdateLinkRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


linkId
String linkId

 The ID of the link.
 


description
String description

 A description of the link.
 
 
 Length Constraints: Maximum length of 256 characters.
 


type
String type

 The type of the link.
 
 
 Length Constraints: Maximum length of 128 characters.
 


bandwidth
Bandwidth bandwidth

 The upload and download speed in Mbps.
 


provider
String provider

 The provider of the link.
 
 
 Length Constraints: Maximum length of 128 characters.
 








Class com.amazonaws.services.networkmanager.model.UpdateLinkResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


link
Link link

 Information about the link.
 








Class com.amazonaws.services.networkmanager.model.UpdateSiteRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


globalNetworkId
String globalNetworkId

 The ID of the global network.
 


siteId
String siteId

 The ID of your site.
 


description
String description

 A description of your site.
 
 
 Length Constraints: Maximum length of 256 characters.
 


location
Location location

 The site location:
 
 
 
 
 Address: The physical address of the site.
 
 
 
 
 Latitude: The latitude of the site.
 
 
 
 
 Longitude: The longitude of the site.
 
 
 








Class com.amazonaws.services.networkmanager.model.UpdateSiteResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


site
Site site

 Information about the site.
 








Class com.amazonaws.services.networkmanager.model.ValidationException extends AWSNetworkManagerException implements Serializable

serialVersionUID:
1L



Serialized Fields


reason
String reason

 The reason for the error.
 


fields
List<E> fields

 The fields that caused the error, if applicable.
 








Class com.amazonaws.services.networkmanager.model.ValidationExceptionField extends Object implements Serializable


Serialized Fields


name
String name

 The name of the field.
 


message
String message

 The message for the field.
 








Package com.amazonaws.services.opsworks.model




Class com.amazonaws.services.opsworks.model.AgentVersion extends Object implements Serializable


Serialized Fields


version
String version

 The agent version.
 


configurationManager
StackConfigurationManager configurationManager

 The configuration manager.
 








Class com.amazonaws.services.opsworks.model.App extends Object implements Serializable


Serialized Fields


appId
String appId

 The app ID.
 


stackId
String stackId

 The app stack ID.
 


shortname
String shortname

 The app's short name.
 


name
String name

 The app name.
 


description
String description

 A description of the app.
 


dataSources
SdkInternalList<T> dataSources

 The app's data sources.
 


type
String type

 The app type.
 


appSource
Source appSource

 A Source object that describes the app repository.
 


domains
SdkInternalList<T> domains

 The app vhost settings with multiple domains separated by commas. For example:
 'www.example.com, example.com'
 


enableSsl
Boolean enableSsl

 Whether to enable SSL for the app.
 


sslConfiguration
SslConfiguration sslConfiguration

 An SslConfiguration object with the SSL configuration.
 


attributes
SdkInternalMap<K,V> attributes

 The stack attributes.
 


createdAt
String createdAt

 When the app was created.
 


environment
SdkInternalList<T> environment

 An array of EnvironmentVariable objects that specify environment variables to be associated with the
 app. After you deploy the app, these variables are defined on the associated app server instances. For more
 information, see  Environment Variables.
 
 
 
 There is no specific limit on the number of environment variables. However, the size of the associated data
 structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. 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 20 KB)" message.
 
 








Class com.amazonaws.services.opsworks.model.AssignInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID.
 


layerIds
SdkInternalList<T> layerIds

 The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in
 layer.
 








Class com.amazonaws.services.opsworks.model.AssignInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.AssignVolumeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


volumeId
String volumeId

 The volume ID.
 


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.AssignVolumeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.AssociateElasticIpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


elasticIp
String elasticIp

 The Elastic IP address.
 


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.AssociateElasticIpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.AttachElasticLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


elasticLoadBalancerName
String elasticLoadBalancerName

 The Elastic Load Balancing instance's name.
 


layerId
String layerId

 The ID of the layer to which the Elastic Load Balancing instance is to be attached.
 








Class com.amazonaws.services.opsworks.model.AttachElasticLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.AutoScalingThresholds extends Object implements Serializable


Serialized Fields


instanceCount
Integer instanceCount

 The number of instances to add or remove when the load exceeds a threshold.
 


thresholdsWaitTime
Integer thresholdsWaitTime

 The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
 


ignoreMetricsTime
Integer ignoreMetricsTime

 The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and
 suppress additional scaling events. For example, AWS OpsWorks Stacks 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 Stacks to suppress scaling events long enough to
 get the new instances online.
 


cpuThreshold
Double cpuThreshold

 The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
 


memoryThreshold
Double memoryThreshold

 The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.
 


loadThreshold
Double loadThreshold

 The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).
 


alarms
SdkInternalList<T> alarms

 Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm
 names, which are case sensitive and must be in the same region as the stack.
 
 
 
 To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can
 either have AWS OpsWorks Stacks 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 Stacks to Act on Your Behalf.
 
 








Class com.amazonaws.services.opsworks.model.AWSOpsWorksException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.opsworks.model.BlockDeviceMapping extends Object implements Serializable


Serialized Fields


deviceName
String deviceName

 The device name that is exposed to the instance, such as /dev/sdh. For the root device, you can use
 the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks Stacks will
 provide the correct device name.
 


noDevice
String noDevice

 Suppresses the specified device included in the AMI's block device mapping.
 


virtualName
String virtualName

 The virtual device name. For more information, see BlockDeviceMapping.
 


ebs
EbsBlockDevice ebs

 An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.
 








Class com.amazonaws.services.opsworks.model.ChefConfiguration extends Object implements Serializable


Serialized Fields


manageBerkshelf
Boolean manageBerkshelf

 Whether to enable Berkshelf.
 


berkshelfVersion
String berkshelfVersion

 The Berkshelf version.
 








Class com.amazonaws.services.opsworks.model.CloneStackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sourceStackId
String sourceStackId

 The source stack ID.
 


name
String name

 The cloned stack name.
 


region
String region

 The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.
 


vpcId
String vpcId

 The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances
 are launched into this VPC, and you cannot change the ID later.
 
 
 
 
 If your account supports EC2 Classic, the default value is no VPC.
 
 
 
 
 If your account does not support EC2 Classic, the default value is the default VPC for the specified region.
 
 
 
 
 If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone
 or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter.
 If you specify neither parameter, AWS OpsWorks Stacks 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 about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC.
 For more information about default VPC and EC2 Classic, see Supported Platforms.
 


attributes
SdkInternalMap<K,V> attributes

 A list of stack attributes and values as key/value pairs to be added to the cloned stack.
 


serviceRoleArn
String serviceRoleArn

 The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks 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 Stacks console, it creates the role for you. You can obtain an
 existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM
 ARNs, see Using
 Identifiers.
 
 
 
 You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You
 can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.
 
 


defaultInstanceProfileArn
String defaultInstanceProfileArn

 The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2
 instances. For more information about IAM ARNs, see Using Identifiers.
 


defaultOs
String defaultOs

 The stack's operating system, which must be set to one of the following.
 
 
 
 
 A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03,
 Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09,
 Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
 
 
 
 
 A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or
 Ubuntu 12.04 LTS.
 
 
 
 
 CentOS Linux 7
 
 
 
 
 Red Hat Enterprise Linux 7
 
 
 
 
 Microsoft Windows Server 2012 R2 Base,
 Microsoft Windows Server 2012 R2 with SQL Server Express,
 Microsoft Windows Server 2012 R2 with SQL Server Standard, or
 Microsoft Windows Server 2012 R2 with SQL Server Web.
 
 
 
 
 A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more
 information about how to use custom AMIs with OpsWorks, see Using Custom
 AMIs.
 
 
 
 
 The default option is the parent stack's operating system. For more information about supported operating
 systems, see AWS
 OpsWorks Stacks Operating Systems.
 
 
 
 You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to
 Windows or Windows to Linux.
 
 


hostnameTheme
String hostnameTheme

 The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names
 for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which
 creates host names by appending integers to the layer's short name. The other themes are:
 
 
 
 
 Baked_Goods
 
 
 
 
 Clouds
 
 
 
 
 Europe_Cities
 
 
 
 
 Fruits
 
 
 
 
 Greek_Deities_and_Titans
 
 
 
 
 Legendary_creatures_from_Japan
 
 
 
 
 Planets_and_Moons
 
 
 
 
 Roman_Deities
 
 
 
 
 Scottish_Islands
 
 
 
 
 US_Cities
 
 
 
 
 Wild_Cats
 
 
 
 
 To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the
 current theme.
 


defaultAvailabilityZone
String defaultAvailabilityZone

 The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a
 value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the
 VpcId parameter description.
 


defaultSubnetId
String defaultSubnetId

 The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId
 parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance.
 If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For
 information on default values and when this parameter is required, see the VpcId parameter
 description.
 


customJson
String customJson

 A string that contains user-defined, custom JSON. It is used to override the corresponding default stack
 configuration JSON values. The string should be in the following format:
 
 
 "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
 
 
 For more information about custom JSON, see Use Custom JSON to Modify
 the Stack Configuration Attributes
 


configurationManager
StackConfigurationManager configurationManager

 The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify
 the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux
 stacks is currently 12.
 


chefConfiguration
ChefConfiguration chefConfiguration

 A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on
 Chef 11.10 stacks. For more information, see Create a New Stack.
 


useCustomCookbooks
Boolean useCustomCookbooks

 Whether to use custom cookbooks.
 


useOpsworksSecurityGroups
Boolean useOpsworksSecurityGroups

 Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
 
 
 AWS OpsWorks Stacks 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 Stacks 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 Stacks does not associate built-in security groups with layers. You must create appropriate
 Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you
 create. However, you can still manually associate a built-in security group with a layer on creation; custom
 security groups are required only for those layers that need custom settings.
 
 
 
 
 For more information, see Create a New Stack.
 


customCookbooksSource
Source customCookbooksSource

 Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
 


defaultSshKeyName
String defaultSshKeyName

 A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks
 installs the public key on the instance and you can use the private key with an SSH client to log in to the
 instance. For more information, see  Using SSH to Communicate
 with an Instance and  Managing SSH Access.
 You can override this setting by specifying a different key pair, or no key pair, when you  create an instance.
 


clonePermissions
Boolean clonePermissions

 Whether to clone the source stack's permissions.
 


cloneAppIds
SdkInternalList<T> cloneAppIds

 A list of source stack app IDs to be included in the cloned stack.
 


defaultRootDeviceType
String defaultRootDeviceType

 The default root device type. This value is used by default for all instances in the cloned stack, but you can
 override it when you create an instance. For more information, see Storage for the Root Device.
 


agentVersion
String agentVersion

 The default AWS OpsWorks Stacks agent version. You have the following options:
 
 
 
 
 Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks 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 Stacks 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. AgentVersion cannot be set to Chef 12.2.
 
 
 
 You can also specify an agent version when you create or update an instance, which overrides the stack's default
 setting.
 
 








Class com.amazonaws.services.opsworks.model.CloneStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackId
String stackId

 The cloned stack ID.
 








Class com.amazonaws.services.opsworks.model.CloudWatchLogsConfiguration extends Object implements Serializable


Serialized Fields


enabled
Boolean enabled

 Whether CloudWatch Logs is enabled for a layer.
 


logStreams
SdkInternalList<T> logStreams

 A list of configuration options for CloudWatch Logs.
 








Class com.amazonaws.services.opsworks.model.CloudWatchLogsLogStream extends Object implements Serializable


Serialized Fields


logGroupName
String logGroupName

 Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group
 names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-'
 (hyphen), '/' (forward slash), and '.' (period).
 


datetimeFormat
String datetimeFormat

 Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent
 Reference.
 


timeZone
String timeZone

 Specifies the time zone of log event time stamps.
 


file
String file

 Specifies log files that you want to push to CloudWatch Logs.
 
 
 File can point to a specific file or multiple files (by using wild card characters such as
 /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification
 time. We recommend that you use wild card characters to specify a series of files of the same type, such as
 access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like
 access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80
 and access_log_443. To specify multiple, different file types, add another log stream entry to the
 configuration file, so that each log file type is stored in a different log group.
 
 
 Zipped files are not supported.
 


fileFingerprintLines
String fileFingerprintLines

 Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited
 numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the
 fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.
 


multiLineStartPattern
String multiLineStartPattern

 Specifies the pattern for identifying the start of a log message.
 


initialPosition
String initialPosition

 Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting
 is only used if there is no state persisted for that log stream.
 


encoding
String encoding

 Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8.
 Encodings supported by Python codecs.decode() can be used here.
 


bufferDuration
Integer bufferDuration

 Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is
 5000ms.
 


batchCount
Integer batchCount

 Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
 


batchSize
Integer batchSize

 Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768
 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
 








Class com.amazonaws.services.opsworks.model.Command extends Object implements Serializable


Serialized Fields


commandId
String commandId

 The command ID.
 


instanceId
String instanceId

 The ID of the instance where the command was executed.
 


deploymentId
String deploymentId

 The command deployment ID.
 


createdAt
String createdAt

 Date and time when the command was run.
 


acknowledgedAt
String acknowledgedAt

 Date and time when the command was acknowledged.
 


completedAt
String completedAt

 Date when the command completed.
 


status
String status

 The command status:
 
 
 
 
 failed
 
 
 
 
 successful
 
 
 
 
 skipped
 
 
 
 
 pending
 
 
 


exitCode
Integer exitCode

 The command exit code.
 


logUrl
String logUrl

 The URL of the command log.
 


type
String type

 The command type:
 
 
 
 
 configure
 
 
 
 
 deploy
 
 
 
 
 execute_recipes
 
 
 
 
 install_dependencies
 
 
 
 
 restart
 
 
 
 
 rollback
 
 
 
 
 setup
 
 
 
 
 start
 
 
 
 
 stop
 
 
 
 
 undeploy
 
 
 
 
 update_custom_cookbooks
 
 
 
 
 update_dependencies
 
 
 








Class com.amazonaws.services.opsworks.model.CreateAppRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 


shortname
String shortname

 The app's short name.
 


name
String name

 The app name.
 


description
String description

 A description of the app.
 


dataSources
SdkInternalList<T> dataSources

 The app's data source.
 


type
String type

 The app type. Each supported type is associated with a particular layer. For example, PHP applications are
 associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of
 the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy
 recipes, specify other.
 


appSource
Source appSource

 A Source object that specifies the app repository.
 


domains
SdkInternalList<T> domains

 The app virtual host settings, with multiple domains separated by commas. For example:
 'www.example.com, example.com'
 


enableSsl
Boolean enableSsl

 Whether to enable SSL for the app.
 


sslConfiguration
SslConfiguration sslConfiguration

 An SslConfiguration object with the SSL configuration.
 


attributes
SdkInternalMap<K,V> attributes

 One or more user-defined key/value pairs to be added to the stack attributes.
 


environment
SdkInternalList<T> environment

 An array of EnvironmentVariable objects that specify environment variables to be associated with the
 app. After you deploy the app, these variables are defined on the associated app server instance. For more
 information, see  Environment Variables.
 
 
 There is no specific limit on the number of environment variables. However, the size of the associated data
 structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. 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 20KB)."
 
 
 
 If you have specified one or more environment variables, you cannot modify the stack's Chef version.
 
 








Class com.amazonaws.services.opsworks.model.CreateAppResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


appId
String appId

 The app ID.
 








Class com.amazonaws.services.opsworks.model.CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 


appId
String appId

 The app ID. This parameter is required for app deployments, but not for other deployment commands.
 


instanceIds
SdkInternalList<T> instanceIds

 The instance IDs for the deployment targets.
 


layerIds
SdkInternalList<T> layerIds

 The layer IDs for the deployment targets.
 


command
DeploymentCommand command

 A DeploymentCommand object that specifies the deployment command and any associated arguments.
 


comment
String comment

 A user-defined comment.
 


customJson
String customJson

 A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding
 default stack configuration JSON values. The string should be in the following format:
 
 
 "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
 
 
 For more information about custom JSON, see Use Custom JSON to Modify
 the Stack Configuration Attributes and Overriding
 Attributes With Custom JSON.
 








Class com.amazonaws.services.opsworks.model.CreateDeploymentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The deployment ID, which can be used with other requests to identify the deployment.
 








Class com.amazonaws.services.opsworks.model.CreateInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 


layerIds
SdkInternalList<T> layerIds

 An array that contains the instance's layer IDs.
 


instanceType
String instanceType

 The instance type, such as t2.micro. For a list of supported instance types, open the stack in the
 console, choose Instances, and choose + Instance. The Size list contains the currently
 supported types. For more information, see Instance Families and Types.
 The parameter values that you use to specify the various types are in the API Name column of the
 Available Instance Types table.
 


autoScalingType
String autoScalingType

 For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
 


hostname
String hostname

 The instance host name.
 


os
String os

 The instance's operating system, which must be set to one of the following.
 
 
 
 
 A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03,
 Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09,
 Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
 
 
 
 
 A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or
 Ubuntu 12.04 LTS.
 
 
 
 
 CentOS Linux 7
 
 
 
 
 Red Hat Enterprise Linux 7
 
 
 
 
 A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base,
 Microsoft Windows Server 2012 R2 with SQL Server Express,
 Microsoft Windows Server 2012 R2 with SQL Server Standard, or
 Microsoft Windows Server 2012 R2 with SQL Server Web.
 
 
 
 
 A custom AMI: Custom.
 
 
 
 
 For more information about the supported operating systems, see AWS OpsWorks Stacks
 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 about supported
 operating systems, see Operating SystemsFor
 more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom
 AMIs.
 


amiId
String amiId

 A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating
 systems. For more information, see Using Custom
 AMIs.
 
 
 
 If you specify a custom AMI, you must set Os to Custom.
 
 


sshKeyName
String sshKeyName

 The instance's Amazon EC2 key-pair name.
 


availabilityZone
String availabilityZone

 The instance Availability Zone. For more information, see Regions and Endpoints.
 


virtualizationType
String virtualizationType

 The instance's virtualization type, paravirtual or hvm.
 


subnetId
String subnetId

 The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the
 stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.
 


architecture
String architecture

 The instance architecture. The default option is x86_64. Instance types do not necessarily support
 both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.
 


rootDeviceType
String rootDeviceType

 The instance root device type. For more information, see Storage for the Root Device.
 


blockDeviceMappings
SdkInternalList<T> blockDeviceMappings

 An array of BlockDeviceMapping objects that specify the instance's block devices. For more
 information, see Block Device
 Mapping. Note that block device mappings are not supported for custom AMIs.
 


installUpdatesOnBoot
Boolean installUpdatesOnBoot

 Whether to install operating system and package updates when the instance boots. The default value is
 true. To control when updates are installed, set this value to false. You must then
 update your instances manually by using CreateDeployment to run the update_dependencies stack
 command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
 
 
 
 We strongly recommend using the default value of true to ensure that your instances have the latest
 security updates.
 
 


ebsOptimized
Boolean ebsOptimized

 Whether to create an Amazon EBS-optimized instance.
 


agentVersion
String agentVersion

 The default AWS OpsWorks Stacks 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 Stacks 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. AgentVersion cannot be set to Chef 12.2.
 


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.
 








Class com.amazonaws.services.opsworks.model.CreateInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.CreateLayerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The layer stack ID.
 


type
String type

 The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of
 custom layers. Built-in layers are not available in Chef 12 stacks.
 


name
String name

 The layer name, which is used by the console.
 


shortname
String shortname

 For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS
 OpsWorks Stacks 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 Stacks. For more information, see the Layer Reference.
 


attributes
SdkInternalMap<K,V> attributes

 One or more user-defined key-value pairs to be added to the stack attributes.
 
 
 To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.
 


cloudWatchLogsConfiguration
CloudWatchLogsConfiguration cloudWatchLogsConfiguration

 Specifies CloudWatch Logs configuration options for the layer. For more information, see
 CloudWatchLogsLogStream.
 


customInstanceProfileArn
String customInstanceProfileArn

 The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
 


customJson
String customJson

 A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the
 layer's instances. For more information, see  Using Custom
 JSON. This feature is supported as of version 1.7.42 of the AWS CLI.
 


customSecurityGroupIds
SdkInternalList<T> customSecurityGroupIds

 An array containing the layer custom security group IDs.
 


packages
SdkInternalList<T> packages

 An array of Package objects that describes the layer packages.
 


volumeConfigurations
SdkInternalList<T> volumeConfigurations

 A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
 


enableAutoHealing
Boolean enableAutoHealing

 Whether to disable auto healing for the layer.
 


autoAssignElasticIps
Boolean autoAssignElasticIps

 Whether to automatically assign an Elastic IP address
 to the layer's instances. For more information, see How to Edit a
 Layer.
 


autoAssignPublicIps
Boolean autoAssignPublicIps

 For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's
 instances. For more information, see How to Edit a
 Layer.
 


customRecipes
Recipes customRecipes

 A LayerCustomRecipes object that specifies the layer custom recipes.
 


installUpdatesOnBoot
Boolean installUpdatesOnBoot

 Whether to install operating system and package updates when the instance boots. The default value is
 true. To control when updates are installed, set this value to false. You must then
 update your instances manually by using CreateDeployment to run the update_dependencies stack
 command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
 
 
 
 To ensure that your instances have the latest security updates, we strongly recommend using the default value of
 true.
 
 


useEbsOptimizedInstances
Boolean useEbsOptimizedInstances

 Whether to use Amazon EBS-optimized instances.
 


lifecycleEventConfiguration
LifecycleEventConfiguration lifecycleEventConfiguration

 A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an
 execution timeout and enable or disable Elastic Load Balancer connection draining.
 








Class com.amazonaws.services.opsworks.model.CreateLayerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


layerId
String layerId

 The layer ID.
 








Class com.amazonaws.services.opsworks.model.CreateStackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The stack name.
 


region
String region

 The stack's AWS region, such as ap-south-1. For more information about Amazon regions, see Regions and Endpoints.
 
 
 
 In the AWS CLI, this API maps to the --stack-region parameter. If the --stack-region
 parameter and the AWS CLI common parameter --region are set to the same value, the stack uses a
 regional endpoint. If the --stack-region parameter is not set, but the AWS CLI
 --region parameter is, this also results in a stack with a regional endpoint. However, if the
 --region parameter is set to us-east-1, and the --stack-region parameter
 is set to one of the following, then the stack uses a legacy or classic region:
 us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2
 . In this case, the actual API endpoint of the stack is in us-east-1. Only the preceding regions are
 supported as classic regions in the us-east-1 API endpoint. Because it is a best practice to choose
 the regional endpoint that is closest to where you manage AWS, we recommend that you use regional endpoints for
 new stacks. The AWS CLI common --region parameter always specifies a regional API endpoint; it
 cannot be used to specify a classic AWS OpsWorks Stacks region.
 
 


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 Stacks infers the value of the other parameter.
 If you specify neither parameter, AWS OpsWorks Stacks 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 about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC.
 For more information about default VPC and EC2-Classic, see Supported Platforms.
 


attributes
SdkInternalMap<K,V> attributes

 One or more user-defined key-value pairs to be added to the stack attributes.
 


serviceRoleArn
String serviceRoleArn

 The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS
 resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role.
 For more information about IAM ARNs, see Using Identifiers.
 


defaultInstanceProfileArn
String defaultInstanceProfileArn

 The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2
 instances. For more information about IAM ARNs, see Using Identifiers.
 


defaultOs
String defaultOs

 The stack's default operating system, which is installed on every instance unless you specify a different
 operating system when you create the instance. You can specify one of the following.
 
 
 
 
 A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03,
 Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09,
 Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
 
 
 
 
 A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or
 Ubuntu 12.04 LTS.
 
 
 
 
 CentOS Linux 7
 
 
 
 
 Red Hat Enterprise Linux 7
 
 
 
 
 A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base,
 Microsoft Windows Server 2012 R2 with SQL Server Express,
 Microsoft Windows Server 2012 R2 with SQL Server Standard, or
 Microsoft Windows Server 2012 R2 with SQL Server Web.
 
 
 
 
 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 about supported operating systems,
 see AWS OpsWorks Stacks
 Operating Systems.
 


hostnameTheme
String hostnameTheme

 The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for
 the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which
 creates host names by appending integers to the layer's short name. The other themes are:
 
 
 
 
 Baked_Goods
 
 
 
 
 Clouds
 
 
 
 
 Europe_Cities
 
 
 
 
 Fruits
 
 
 
 
 Greek_Deities_and_Titans
 
 
 
 
 Legendary_creatures_from_Japan
 
 
 
 
 Planets_and_Moons
 
 
 
 
 Roman_Deities
 
 
 
 
 Scottish_Islands
 
 
 
 
 US_Cities
 
 
 
 
 Wild_Cats
 
 
 
 
 To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the
 current theme.
 


defaultAvailabilityZone
String defaultAvailabilityZone

 The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a
 value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the
 VpcId parameter description.
 


defaultSubnetId
String defaultSubnetId

 The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId
 parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance.
 If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For
 information on default values and when this parameter is required, see the VpcId parameter
 description.
 


customJson
String customJson

 A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack
 configuration attribute values or to pass data to recipes. The string should be in the following format:
 
 
 "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
 
 
 For more information about custom JSON, see Use Custom JSON to Modify
 the Stack Configuration Attributes.
 


configurationManager
StackConfigurationManager configurationManager

 The configuration manager. When you create a stack we recommend that you use the configuration manager to specify
 the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux
 stacks is currently 12.
 


chefConfiguration
ChefConfiguration chefConfiguration

 A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on
 Chef 11.10 stacks. For more information, see Create a New Stack.
 


useCustomCookbooks
Boolean useCustomCookbooks

 Whether the stack uses custom cookbooks.
 


useOpsworksSecurityGroups
Boolean useOpsworksSecurityGroups

 Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
 
 
 AWS OpsWorks Stacks 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 Stacks 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 Stacks does not associate built-in security groups with layers. You must create appropriate
 EC2 security groups and associate a security group with each layer that you create. However, you can still
 manually associate a built-in security group with a layer on creation; custom security groups are required only
 for those layers that need custom settings.
 
 
 
 
 For more information, see Create a New Stack.
 


customCookbooksSource
Source customCookbooksSource

 Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
 


defaultSshKeyName
String defaultSshKeyName

 A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks
 installs the public key on the instance and you can use the private key with an SSH client to log in to the
 instance. For more information, see  Using SSH to Communicate
 with an Instance and  Managing SSH Access.
 You can override this setting by specifying a different key pair, or no key pair, when you  create an instance.
 


defaultRootDeviceType
String defaultRootDeviceType

 The default root device type. This value is the default for all instances in the stack, but you can override it
 when you create an instance. The default option is instance-store. For more information, see Storage for
 the Root Device.
 


agentVersion
String agentVersion

 The default AWS OpsWorks Stacks agent version. You have the following options:
 
 
 
 
 Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks 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 Stacks 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. AgentVersion cannot be set to Chef 12.2.
 
 
 
 You can also specify an agent version when you create or update an instance, which overrides the stack's default
 setting.
 
 








Class com.amazonaws.services.opsworks.model.CreateStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID, which is an opaque string that you use to identify the stack when performing actions such as
 DescribeStacks.
 








Class com.amazonaws.services.opsworks.model.CreateUserProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


iamUserArn
String iamUserArn

 The user's IAM ARN; this can also be a federated user's ARN.
 


sshUsername
String sshUsername

 The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name
 includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be
 changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from
 the IAM user name.
 


sshPublicKey
String sshPublicKey

 The user's public SSH key.
 


allowSelfManagement
Boolean allowSelfManagement

 Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's
 Public SSH Key.
 








Class com.amazonaws.services.opsworks.model.CreateUserProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


iamUserArn
String iamUserArn

 The user's IAM ARN.
 








Class com.amazonaws.services.opsworks.model.DataSource extends Object implements Serializable


Serialized Fields


type
String type

 The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance,
 RdsDbInstance, or None.
 


arn
String arn

 The data source's ARN.
 


databaseName
String databaseName

 The database name.
 








Class com.amazonaws.services.opsworks.model.DeleteAppRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appId
String appId

 The app ID.
 








Class com.amazonaws.services.opsworks.model.DeleteAppResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.DeleteInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID.
 


deleteElasticIp
Boolean deleteElasticIp

 Whether to delete the instance Elastic IP address.
 


deleteVolumes
Boolean deleteVolumes

 Whether to delete the instance's Amazon EBS volumes.
 








Class com.amazonaws.services.opsworks.model.DeleteInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.DeleteLayerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


layerId
String layerId

 The layer ID.
 








Class com.amazonaws.services.opsworks.model.DeleteLayerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.DeleteStackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.DeleteStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.DeleteUserProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


iamUserArn
String iamUserArn

 The user's IAM ARN. This can also be a federated user's ARN.
 








Class com.amazonaws.services.opsworks.model.DeleteUserProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




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


Serialized Fields


deploymentId
String deploymentId

 The deployment ID.
 


stackId
String stackId

 The stack ID.
 


appId
String appId

 The app ID.
 


createdAt
String createdAt

 Date when the deployment was created.
 


completedAt
String completedAt

 Date when the deployment completed.
 


duration
Integer duration

 The deployment duration.
 


iamUserArn
String iamUserArn

 The user's IAM ARN.
 


comment
String comment

 A user-defined comment.
 


command
DeploymentCommand command

 Used to specify a stack or deployment command.
 


status
String status

 The deployment status:
 
 
 
 
 running
 
 
 
 
 successful
 
 
 
 
 failed
 
 
 


customJson
String customJson

 A string that contains user-defined custom JSON. It can be used to override the corresponding default stack
 configuration attribute values for stack or to pass data to recipes. The string should be in the following
 format:
 
 
 "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
 
 
 For more information on custom JSON, see Use Custom JSON to Modify
 the Stack Configuration Attributes.
 


instanceIds
SdkInternalList<T> instanceIds

 The IDs of the target instances.
 








Class com.amazonaws.services.opsworks.model.DeploymentCommand extends Object implements Serializable


Serialized Fields


name
String name

 Specifies the operation. You can specify only one command.
 
 
 For stacks, the following commands are available:
 
 
 
 
 execute_recipes: Execute one or more recipes. To specify the recipes, set an Args
 parameter named recipes to the list of recipes to be executed. For example, to execute
 phpapp::appsetup, set Args to {"recipes":["phpapp::appsetup"]}.
 
 
 
 
 install_dependencies: Install the stack's dependencies.
 
 
 
 
 update_custom_cookbooks: Update the stack's custom cookbooks.
 
 
 
 
 update_dependencies: Update the stack's dependencies.
 
 
 
 
 
 The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the
 commands successfully on Windows instances, but they do nothing.
 
 
 
 For apps, the following commands are available:
 
 
 
 
 deploy: Deploy an app. Ruby on Rails apps have an optional Args parameter named
 migrate. Set Args to {"migrate":["true"]} to migrate the database. The default setting
 is {"migrate":["false"]}.
 
 
 
 
 rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks Stacks
 stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as
 many as four versions.
 
 
 
 
 start: Start the app's web or application server.
 
 
 
 
 stop: Stop the app's web or application server.
 
 
 
 
 restart: Restart the app's web or application server.
 
 
 
 
 undeploy: Undeploy the app.
 
 
 


args
SdkInternalMap<K,V> args

 The arguments of those commands that take arguments. It should be set to a JSON object with the following format:
 
 
 {"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}
 
 
 The update_dependencies command takes two arguments:
 
 
 
 
 upgrade_os_to - Specifies the desired Amazon Linux version for instances whose OS you want to
 upgrade, such as Amazon Linux 2016.09. You must also set the allow_reboot argument to
 true.
 
 
 
 
 allow_reboot - Specifies whether to allow AWS OpsWorks Stacks 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 2016.09, set Args to the following.
 
 
  { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] } 
 








Class com.amazonaws.services.opsworks.model.DeregisterEcsClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ecsClusterArn
String ecsClusterArn

 The cluster's Amazon Resource Number (ARN).
 








Class com.amazonaws.services.opsworks.model.DeregisterEcsClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.DeregisterElasticIpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


elasticIp
String elasticIp

 The Elastic IP address.
 








Class com.amazonaws.services.opsworks.model.DeregisterElasticIpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.DeregisterInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.DeregisterInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.DeregisterRdsDbInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rdsDbInstanceArn
String rdsDbInstanceArn

 The Amazon RDS instance's ARN.
 








Class com.amazonaws.services.opsworks.model.DeregisterRdsDbInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.DeregisterVolumeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


volumeId
String volumeId

 The AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks Stacks 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 extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.DescribeAgentVersionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 


configurationManager
StackConfigurationManager configurationManager

 The configuration manager.
 








Class com.amazonaws.services.opsworks.model.DescribeAgentVersionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


agentVersions
SdkInternalList<T> agentVersions

 The agent versions for the specified stack or configuration manager. Note that this value is the complete version
 number, not the abbreviated number used by the console.
 








Class com.amazonaws.services.opsworks.model.DescribeAppsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the
 specified stack.
 


appIds
SdkInternalList<T> appIds

 An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a
 description of the specified apps. Otherwise, it returns a description of every app.
 








Class com.amazonaws.services.opsworks.model.DescribeAppsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


apps
SdkInternalList<T> apps

 An array of App objects that describe the specified apps.
 








Class com.amazonaws.services.opsworks.model.DescribeCommandsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


deploymentId
String deploymentId

 The deployment ID. If you include this parameter, DescribeCommands returns a description of the
 commands associated with the specified deployment.
 


instanceId
String instanceId

 The instance ID. If you include this parameter, DescribeCommands returns a description of the
 commands associated with the specified instance.
 


commandIds
SdkInternalList<T> commandIds

 An array of command IDs. If you include this parameter, DescribeCommands returns a description of
 the specified commands. Otherwise, it returns a description of every command.
 








Class com.amazonaws.services.opsworks.model.DescribeCommandsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


commands
SdkInternalList<T> commands

 An array of Command objects that describe each of the specified commands.
 








Class com.amazonaws.services.opsworks.model.DescribeDeploymentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID. If you include this parameter, the command returns a description of the commands associated with
 the specified stack.
 


appId
String appId

 The app ID. If you include this parameter, the command returns a description of the commands associated with the
 specified app.
 


deploymentIds
SdkInternalList<T> deploymentIds

 An array of deployment IDs to be described. If you include this parameter, the command returns a description of
 the specified deployments. Otherwise, it returns a description of every deployment.
 








Class com.amazonaws.services.opsworks.model.DescribeDeploymentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


deployments
SdkInternalList<T> deployments

 An array of Deployment objects that describe the deployments.
 








Class com.amazonaws.services.opsworks.model.DescribeEcsClustersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ecsClusterArns
SdkInternalList<T> ecsClusterArns

 A list of ARNs, one for each cluster to be described.
 


stackId
String stackId

 A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the
 stack.
 


nextToken
String nextToken

 If the previous paginated request did not return all of the remaining results, the response object's
 NextToken parameter value is set to a token. To retrieve the next set of results, call
 DescribeEcsClusters again and assign that token to the request object's NextToken
 parameter. If there are no remaining results, the previous response object's NextToken parameter is
 set to null.
 


maxResults
Integer maxResults

 To receive a paginated response, use this parameter to specify the maximum number of results to be returned with
 a single call. If the number of available results exceeds this maximum, the response includes a
 NextToken value that you can assign to the NextToken request parameter to get the next
 set of results.
 








Class com.amazonaws.services.opsworks.model.DescribeEcsClustersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ecsClusters
SdkInternalList<T> ecsClusters

 A list of EcsCluster objects containing the cluster descriptions.
 


nextToken
String nextToken

 If a paginated request does not return all of the remaining results, this parameter is set to a token that you
 can assign to the request object's NextToken parameter to retrieve the next set of results. If the
 previous paginated request returned all of the remaining results, this parameter is set to null.
 








Class com.amazonaws.services.opsworks.model.DescribeElasticIpsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID. If you include this parameter, DescribeElasticIps returns a description of the
 Elastic IP addresses associated with the specified instance.
 


stackId
String stackId

 A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic
 IP addresses that are registered with the specified stack.
 


ips
SdkInternalList<T> ips

 An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps
 returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic
 IP address.
 








Class com.amazonaws.services.opsworks.model.DescribeElasticIpsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


elasticIps
SdkInternalList<T> elasticIps

 An ElasticIps object that describes the specified Elastic IP addresses.
 








Class com.amazonaws.services.opsworks.model.DescribeElasticLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 A stack ID. The action describes the stack's Elastic Load Balancing instances.
 


layerIds
SdkInternalList<T> layerIds

 A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.
 








Class com.amazonaws.services.opsworks.model.DescribeElasticLoadBalancersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


elasticLoadBalancers
SdkInternalList<T> elasticLoadBalancers

 A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.
 








Class com.amazonaws.services.opsworks.model.DescribeInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances
 associated with the specified stack.
 


layerId
String layerId

 A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances
 associated with the specified layer.
 


instanceIds
SdkInternalList<T> instanceIds

 An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a
 description of the specified instances. Otherwise, it returns a description of every instance.
 








Class com.amazonaws.services.opsworks.model.DescribeInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instances
SdkInternalList<T> instances

 An array of Instance objects that describe the instances.
 








Class com.amazonaws.services.opsworks.model.DescribeLayersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 


layerIds
SdkInternalList<T> layerIds

 An array of layer IDs that specify the layers to be described. If you omit this parameter,
 DescribeLayers returns a description of every layer in the specified stack.
 








Class com.amazonaws.services.opsworks.model.DescribeLayersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


layers
SdkInternalList<T> layers

 An array of Layer objects that describe the layers.
 








Class com.amazonaws.services.opsworks.model.DescribeLoadBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


layerIds
SdkInternalList<T> layerIds

 An array of layer IDs.
 








Class com.amazonaws.services.opsworks.model.DescribeLoadBasedAutoScalingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


loadBasedAutoScalingConfigurations
SdkInternalList<T> loadBasedAutoScalingConfigurations

 An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.
 








Class com.amazonaws.services.opsworks.model.DescribeMyUserProfileRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.opsworks.model.DescribeMyUserProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userProfile
SelfUserProfile userProfile

 A UserProfile object that describes the user's SSH information.
 








Class com.amazonaws.services.opsworks.model.DescribeOperatingSystemsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.opsworks.model.DescribeOperatingSystemsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


operatingSystems
SdkInternalList<T> operatingSystems

 Contains information in response to a DescribeOperatingSystems request.
 








Class com.amazonaws.services.opsworks.model.DescribePermissionsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


iamUserArn
String iamUserArn

 The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see Using Identifiers.
 


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.DescribePermissionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


permissions
SdkInternalList<T> permissions

 An array of Permission objects that describe the stack permissions.
 
 
 
 
 If the request object contains only a stack ID, the array contains a Permission object with
 permissions for each of the stack IAM ARNs.
 
 
 
 
 If the request object contains only an IAM ARN, the array contains a Permission object with
 permissions for each of the user's stack IDs.
 
 
 
 
 If the request contains a stack ID and an IAM ARN, the array contains a single Permission object
 with permissions for the specified stack and IAM ARN.
 
 
 








Class com.amazonaws.services.opsworks.model.DescribeRaidArraysRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID
 arrays associated with the specified instance.
 


stackId
String stackId

 The stack ID.
 


raidArrayIds
SdkInternalList<T> raidArrayIds

 An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of
 the specified arrays. Otherwise, it returns a description of every array.
 








Class com.amazonaws.services.opsworks.model.DescribeRaidArraysResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


raidArrays
SdkInternalList<T> raidArrays

 A RaidArrays object that describes the specified RAID arrays.
 








Class com.amazonaws.services.opsworks.model.DescribeRdsDbInstancesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The ID of the stack with which the instances are registered. The operation returns descriptions of all registered
 Amazon RDS instances.
 


rdsDbInstanceArns
SdkInternalList<T> rdsDbInstanceArns

 An array containing the ARNs of the instances to be described.
 








Class com.amazonaws.services.opsworks.model.DescribeRdsDbInstancesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


rdsDbInstances
SdkInternalList<T> rdsDbInstances

 An a array of RdsDbInstance objects that describe the instances.
 








Class com.amazonaws.services.opsworks.model.DescribeServiceErrorsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors
 associated with the specified stack.
 


instanceId
String instanceId

 The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors
 associated with the specified instance.
 


serviceErrorIds
SdkInternalList<T> serviceErrorIds

 An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions
 of the specified errors. Otherwise, it returns a description of every error.
 








Class com.amazonaws.services.opsworks.model.DescribeServiceErrorsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serviceErrors
SdkInternalList<T> serviceErrors

 An array of ServiceError objects that describe the specified service errors.
 








Class com.amazonaws.services.opsworks.model.DescribeStackProvisioningParametersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.DescribeStackProvisioningParametersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


agentInstallerUrl
String agentInstallerUrl

 The AWS OpsWorks Stacks agent installer's URL.
 


parameters
SdkInternalMap<K,V> parameters

 An embedded object that contains the provisioning parameters.
 








Class com.amazonaws.services.opsworks.model.DescribeStacksRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackIds
SdkInternalList<T> stackIds

 An array of stack IDs that specify the stacks to be described. If you omit this parameter,
 DescribeStacks returns a description of every stack.
 








Class com.amazonaws.services.opsworks.model.DescribeStacksResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stacks
SdkInternalList<T> stacks

 An array of Stack objects that describe the stacks.
 








Class com.amazonaws.services.opsworks.model.DescribeStackSummaryRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.DescribeStackSummaryResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


stackSummary
StackSummary stackSummary

 A StackSummary object that contains the results.
 








Class com.amazonaws.services.opsworks.model.DescribeTimeBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceIds
SdkInternalList<T> instanceIds

 An array of instance IDs.
 








Class com.amazonaws.services.opsworks.model.DescribeTimeBasedAutoScalingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


timeBasedAutoScalingConfigurations
SdkInternalList<T> timeBasedAutoScalingConfigurations

 An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the
 specified instances.
 








Class com.amazonaws.services.opsworks.model.DescribeUserProfilesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


iamUserArns
SdkInternalList<T> iamUserArns

 An array of IAM or federated user ARNs that identify the users to be described.
 








Class com.amazonaws.services.opsworks.model.DescribeUserProfilesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


userProfiles
SdkInternalList<T> userProfiles

 A Users object that describes the specified users.
 








Class com.amazonaws.services.opsworks.model.DescribeVolumesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes
 associated with the specified instance.
 


stackId
String stackId

 A stack ID. The action describes the stack's registered Amazon EBS volumes.
 


raidArrayId
String raidArrayId

 The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes
 associated with the specified RAID array.
 


volumeIds
SdkInternalList<T> volumeIds

 Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the
 specified volumes. Otherwise, it returns a description of every volume.
 








Class com.amazonaws.services.opsworks.model.DescribeVolumesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


volumes
SdkInternalList<T> volumes

 An array of volume IDs.
 








Class com.amazonaws.services.opsworks.model.DetachElasticLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


elasticLoadBalancerName
String elasticLoadBalancerName

 The Elastic Load Balancing instance's name.
 


layerId
String layerId

 The ID of the layer that the Elastic Load Balancing instance is attached to.
 








Class com.amazonaws.services.opsworks.model.DetachElasticLoadBalancerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.DisassociateElasticIpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


elasticIp
String elasticIp

 The Elastic IP address.
 








Class com.amazonaws.services.opsworks.model.DisassociateElasticIpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.EbsBlockDevice extends Object implements Serializable


Serialized Fields


snapshotId
String snapshotId

 The snapshot ID.
 


iops
Integer iops

 The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.
 


volumeSize
Integer volumeSize

 The volume size, in GiB. For more information, see EbsBlockDevice.
 


volumeType
String volumeType

 The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD)
 volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and
 standard for Magnetic volumes.
 
 
 If you specify the io1 volume type, you must also specify a value for the Iops
 attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default
 volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).
 


deleteOnTermination
Boolean deleteOnTermination

 Whether the volume is deleted on instance termination.
 








Class com.amazonaws.services.opsworks.model.EcsCluster extends Object implements Serializable


Serialized Fields


ecsClusterArn
String ecsClusterArn

 The cluster's ARN.
 


ecsClusterName
String ecsClusterName

 The cluster name.
 


stackId
String stackId

 The stack ID.
 


registeredAt
String registeredAt

 The time and date that the cluster was registered with the stack.
 








Class com.amazonaws.services.opsworks.model.ElasticIp extends Object implements Serializable


Serialized Fields


ip
String ip

 The IP address.
 


name
String name

 The name.
 


domain
String domain

 The domain.
 


region
String region

 The AWS region. For more information, see Regions and Endpoints.
 


instanceId
String instanceId

 The ID of the instance that the address is attached to.
 








Class com.amazonaws.services.opsworks.model.ElasticLoadBalancer extends Object implements Serializable


Serialized Fields


elasticLoadBalancerName
String elasticLoadBalancerName

 The Elastic Load Balancing instance's name.
 


region
String region

 The instance's AWS region.
 


dnsName
String dnsName

 The instance's public DNS name.
 


stackId
String stackId

 The ID of the stack that the instance is associated with.
 


layerId
String layerId

 The ID of the layer that the instance is attached to.
 


vpcId
String vpcId

 The VPC ID.
 


availabilityZones
SdkInternalList<T> availabilityZones

 A list of Availability Zones.
 


subnetIds
SdkInternalList<T> subnetIds

 A list of subnet IDs, if the stack is running in a VPC.
 


ec2InstanceIds
SdkInternalList<T> ec2InstanceIds

 A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.
 








Class com.amazonaws.services.opsworks.model.EnvironmentVariable extends Object implements Serializable


Serialized Fields


key
String key

 (Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The
 name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or
 underscore.
 


value
String value

 (Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up
 to 256 characters, which must all be printable.
 


secure
Boolean secure

 (Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an
 environment variable's value, set Secure to true. DescribeApps then
 returns *****FILTERED***** instead of the actual value. The default value for Secure is
 false.
 








Class com.amazonaws.services.opsworks.model.GetHostnameSuggestionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


layerId
String layerId

 The layer ID.
 








Class com.amazonaws.services.opsworks.model.GetHostnameSuggestionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


layerId
String layerId

 The layer ID.
 


hostname
String hostname

 The generated host name.
 








Class com.amazonaws.services.opsworks.model.GrantAccessRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance's AWS OpsWorks Stacks ID.
 


validForInMinutes
Integer validForInMinutes

 The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the
 user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she
 automatically will be logged out.
 








Class com.amazonaws.services.opsworks.model.GrantAccessResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


temporaryCredential
TemporaryCredential temporaryCredential

 A TemporaryCredential object that contains the data needed to log in to the instance by RDP clients,
 such as the Microsoft Remote Desktop Connection.
 








Class com.amazonaws.services.opsworks.model.Instance extends Object implements Serializable


Serialized Fields


agentVersion
String agentVersion

 The agent version. This parameter is set to INHERIT if the instance inherits the default stack
 setting or to a a version number for a fixed agent version.
 


amiId
String amiId

 A custom AMI ID to be used to create the instance. For more information, see Instances
 


architecture
String architecture

 The instance architecture: "i386" or "x86_64".
 


arn
String arn

 The instance's Amazon Resource Number (ARN).
 


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
SdkInternalList<T> blockDeviceMappings

 An array of BlockDeviceMapping objects that specify the instance's block device mappings.
 


createdAt
String createdAt

 The time that the instance was created.
 


ebsOptimized
Boolean ebsOptimized

 Whether this is an Amazon EBS-optimized instance.
 


ec2InstanceId
String ec2InstanceId

 The ID of the associated Amazon EC2 instance.
 


ecsClusterArn
String ecsClusterArn

 For container instances, the Amazon ECS cluster's ARN.
 


ecsContainerInstanceArn
String ecsContainerInstanceArn

 For container instances, the instance's ARN.
 


elasticIp
String elasticIp

 The instance Elastic
 IP address .
 


hostname
String hostname

 The instance host name.
 


infrastructureClass
String infrastructureClass

 For registered instances, the infrastructure class: ec2 or on-premises.
 


installUpdatesOnBoot
Boolean installUpdatesOnBoot

 Whether to install operating system and package updates when the instance boots. The default value is
 true. If this value is set to false, you must then update your instances manually by
 using CreateDeployment to run the update_dependencies stack command or by manually running
 yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
 
 
 
 We strongly recommend using the default value of true, to ensure that your instances have the latest
 security updates.
 
 


instanceId
String instanceId

 The instance ID.
 


instanceProfileArn
String instanceProfileArn

 The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
 


instanceType
String instanceType

 The instance type, such as t2.micro.
 


lastServiceErrorId
String lastServiceErrorId

 The ID of the last service error. For more information, call DescribeServiceErrors.
 


layerIds
SdkInternalList<T> layerIds

 An array containing the instance layer IDs.
 


os
String os

 The instance's operating system.
 


platform
String platform

 The instance's platform.
 


privateDns
String privateDns

 The 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 Stacks 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
SdkInternalList<T> securityGroupIds

 An array containing the instance security group IDs.
 


sshHostDsaKeyFingerprint
String sshHostDsaKeyFingerprint

 The SSH key's Deep Security Agent (DSA) fingerprint.
 


sshHostRsaKeyFingerprint
String sshHostRsaKeyFingerprint

 The SSH key's RSA fingerprint.
 


sshKeyName
String sshKeyName

 The instance's Amazon EC2 key-pair name.
 


stackId
String stackId

 The stack ID.
 


status
String status

 The instance status:
 
 
 
 
 booting
 
 
 
 
 connection_lost
 
 
 
 
 online
 
 
 
 
 pending
 
 
 
 
 rebooting
 
 
 
 
 requested
 
 
 
 
 running_setup
 
 
 
 
 setup_failed
 
 
 
 
 shutting_down
 
 
 
 
 start_failed
 
 
 
 
 stop_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 extends Object implements Serializable


Serialized Fields


document
String document

 A JSON document that contains the metadata.
 


signature
String signature

 A signature that can be used to verify the document's accuracy and authenticity.
 








Class com.amazonaws.services.opsworks.model.InstancesCount extends Object implements Serializable


Serialized Fields


assigning
Integer assigning

 The number of instances in the Assigning state.
 


booting
Integer booting

 The number of instances with booting status.
 


connectionLost
Integer connectionLost

 The number of instances with connection_lost status.
 


deregistering
Integer deregistering

 The number of instances in the Deregistering state.
 


online
Integer online

 The number of instances with online status.
 


pending
Integer pending

 The number of instances with pending status.
 


rebooting
Integer rebooting

 The number of instances with rebooting status.
 


registered
Integer registered

 The number of instances in the Registered state.
 


registering
Integer registering

 The number of instances in the Registering state.
 


requested
Integer requested

 The number of instances with requested status.
 


runningSetup
Integer runningSetup

 The number of instances with running_setup status.
 


setupFailed
Integer setupFailed

 The number of instances with setup_failed status.
 


shuttingDown
Integer shuttingDown

 The number of instances with shutting_down status.
 


startFailed
Integer startFailed

 The number of instances with start_failed status.
 


stopFailed
Integer stopFailed

 The number of instances with stop_failed status.
 


stopped
Integer stopped

 The number of instances with stopped status.
 


stopping
Integer stopping

 The number of instances with stopping status.
 


terminated
Integer terminated

 The number of instances with terminated status.
 


terminating
Integer terminating

 The number of instances with terminating status.
 


unassigning
Integer unassigning

 The number of instances in the Unassigning state.
 








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


Serialized Fields


arn
String arn

 The Amazon Resource Number (ARN) of a layer.
 


stackId
String stackId

 The layer stack ID.
 


layerId
String layerId

 The layer ID.
 


type
String type

 The layer type.
 


name
String name

 The layer name.
 


shortname
String shortname

 The layer short name.
 


attributes
SdkInternalMap<K,V> attributes

 The layer attributes.
 
 
 For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword
 attributes, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value
 
 
 For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's
 ARN.
 


cloudWatchLogsConfiguration
CloudWatchLogsConfiguration cloudWatchLogsConfiguration

 The Amazon CloudWatch Logs configuration settings for the layer.
 


customInstanceProfileArn
String customInstanceProfileArn

 The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs,
 see Using Identifiers.
 


customJson
String customJson

 A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
 


customSecurityGroupIds
SdkInternalList<T> customSecurityGroupIds

 An array containing the layer's custom security group IDs.
 


defaultSecurityGroupNames
SdkInternalList<T> defaultSecurityGroupNames

 An array containing the layer's security group names.
 


packages
SdkInternalList<T> packages

 An array of Package objects that describe the layer's packages.
 


volumeConfigurations
SdkInternalList<T> volumeConfigurations

 A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
 


enableAutoHealing
Boolean enableAutoHealing

 Whether auto healing is disabled for the layer.
 


autoAssignElasticIps
Boolean autoAssignElasticIps

 Whether to automatically assign an Elastic IP address
 to the layer's instances. For more information, see How to Edit a
 Layer.
 


autoAssignPublicIps
Boolean autoAssignPublicIps

 For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's
 instances. For more information, see How to Edit a
 Layer.
 


defaultRecipes
Recipes defaultRecipes

 AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy,
 undeploy, and shutdown. For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each
 event. You can also provide custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom
 event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a
 particular layer to be run in response to each of the five events.
 
 
 To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe
 name, which is the recipe's file name without the .rb extension. For example:
 phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's
 phpapp2 folder.
 


customRecipes
Recipes customRecipes

 A LayerCustomRecipes object that specifies the layer's custom recipes.
 


createdAt
String createdAt

 Date when the layer was created.
 


installUpdatesOnBoot
Boolean installUpdatesOnBoot

 Whether to install operating system and package updates when the instance boots. The default value is
 true. If this value is set to false, you must then update your instances manually by
 using CreateDeployment to run the update_dependencies stack command or manually running
 yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
 
 
 
 We strongly recommend using the default value of true, to ensure that your instances have the latest
 security updates.
 
 


useEbsOptimizedInstances
Boolean useEbsOptimizedInstances

 Whether the layer uses Amazon EBS-optimized instances.
 


lifecycleEventConfiguration
LifecycleEventConfiguration lifecycleEventConfiguration

 A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
 








Class com.amazonaws.services.opsworks.model.LifecycleEventConfiguration extends Object implements Serializable


Serialized Fields


shutdown
ShutdownEventConfiguration shutdown

 A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
 








Class com.amazonaws.services.opsworks.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The stack or layer's Amazon Resource Number (ARN).
 


maxResults
Integer maxResults

 Do not use. A validation exception occurs if you add a MaxResults parameter to a
 ListTagsRequest call.
 


nextToken
String nextToken

 Do not use. A validation exception occurs if you add a NextToken parameter to a
 ListTagsRequest call.
 








Class com.amazonaws.services.opsworks.model.ListTagsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
SdkInternalMap<K,V> tags

 A set of key-value pairs that contain tag keys and tag values that are attached to a stack or layer.
 


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 get 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.LoadBasedAutoScalingConfiguration extends Object implements Serializable


Serialized Fields


layerId
String layerId

 The layer ID.
 


enable
Boolean enable

 Whether load-based auto scaling is enabled for the layer.
 


upScaling
AutoScalingThresholds upScaling

 An AutoScalingThresholds object that describes the upscaling configuration, which defines how and
 when AWS OpsWorks Stacks increases the number of instances.
 


downScaling
AutoScalingThresholds downScaling

 An AutoScalingThresholds object that describes the downscaling configuration, which defines how and
 when AWS OpsWorks Stacks reduces the number of instances.
 








Class com.amazonaws.services.opsworks.model.OperatingSystem extends Object implements Serializable


Serialized Fields


name
String name

 The name of the operating system, such as Amazon Linux 2018.03.
 


id
String id

 The ID of a supported operating system, such as Amazon Linux 2018.03.
 


type
String type

 The type of a supported operating system, either Linux or Windows.
 


configurationManagers
SdkInternalList<T> configurationManagers

 Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system.
 


reportedName
String reportedName

 A short name for the operating system manufacturer.
 


reportedVersion
String reportedVersion

 The version of the operating system, including the release and edition, if applicable.
 


supported
Boolean supported

 Indicates that an operating system is not supported for new instances.
 








Class com.amazonaws.services.opsworks.model.OperatingSystemConfigurationManager extends Object implements Serializable


Serialized Fields


name
String name

 The name of the configuration manager, which is Chef.
 


version
String version

 The versions of the configuration manager that are supported by an operating system.
 








Class com.amazonaws.services.opsworks.model.Permission extends Object implements Serializable


Serialized Fields


stackId
String stackId

 A stack ID.
 


iamUserArn
String iamUserArn

 The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about
 IAM ARNs, see Using
 Identifiers.
 


allowSsh
Boolean allowSsh

 Whether the user can use SSH.
 


allowSudo
Boolean allowSudo

 Whether the user can use sudo.
 


level
String level

 The user's permission level, which must be the following:
 
 
 
 
 deny
 
 
 
 
 show
 
 
 
 
 deploy
 
 
 
 
 manage
 
 
 
 
 iam_only
 
 
 
 
 For more information on the permissions associated with these levels, see Managing User
 Permissions
 








Class com.amazonaws.services.opsworks.model.RaidArray extends Object implements Serializable


Serialized Fields


raidArrayId
String raidArrayId

 The array ID.
 


instanceId
String instanceId

 The instance ID.
 


name
String name

 The array name.
 


raidLevel
Integer raidLevel

 The RAID level.
 


numberOfDisks
Integer numberOfDisks

 The number of disks in the array.
 


size
Integer size

 The array's size.
 


device
String device

 The array's Linux device. For example /dev/mdadm0.
 


mountPoint
String mountPoint

 The array's mount point.
 


availabilityZone
String availabilityZone

 The array's Availability Zone. For more information, see Regions and Endpoints.
 


createdAt
String createdAt

 When the RAID array was created.
 


stackId
String stackId

 The stack ID.
 


volumeType
String volumeType

 The volume type, standard or PIOPS.
 


iops
Integer iops

 For PIOPS volumes, the IOPS per disk.
 








Class com.amazonaws.services.opsworks.model.RdsDbInstance extends Object implements Serializable


Serialized Fields


rdsDbInstanceArn
String rdsDbInstanceArn

 The instance's ARN.
 


dbInstanceIdentifier
String dbInstanceIdentifier

 The DB instance identifier.
 


dbUser
String dbUser

 The master user name.
 


dbPassword
String dbPassword

 AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
 


region
String region

 The instance's AWS region.
 


address
String address

 The instance's address.
 


engine
String engine

 The instance's database engine.
 


stackId
String stackId

 The ID of the stack with which the instance is registered.
 


missingOnRds
Boolean missingOnRds

 Set to true if AWS OpsWorks Stacks is unable to discover the Amazon RDS instance. AWS OpsWorks
 Stacks attempts to discover the instance only once. If this value is set to true, you must
 deregister the instance, and then register it again.
 








Class com.amazonaws.services.opsworks.model.RebootInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.RebootInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.Recipes extends Object implements Serializable


Serialized Fields


setup
SdkInternalList<T> setup

 An array of custom recipe names to be run following a setup event.
 


configure
SdkInternalList<T> configure

 An array of custom recipe names to be run following a configure event.
 


deploy
SdkInternalList<T> deploy

 An array of custom recipe names to be run following a deploy event.
 


undeploy
SdkInternalList<T> undeploy

 An array of custom recipe names to be run following a undeploy event.
 


shutdown
SdkInternalList<T> shutdown

 An array of custom recipe names to be run following a shutdown event.
 








Class com.amazonaws.services.opsworks.model.RegisterEcsClusterRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ecsClusterArn
String ecsClusterArn

 The cluster's ARN.
 


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.RegisterEcsClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


ecsClusterArn
String ecsClusterArn

 The cluster's ARN.
 








Class com.amazonaws.services.opsworks.model.RegisterElasticIpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


elasticIp
String elasticIp

 The Elastic IP address.
 


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.RegisterElasticIpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


elasticIp
String elasticIp

 The Elastic IP address.
 








Class com.amazonaws.services.opsworks.model.RegisterInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The ID of the stack that the instance is to be registered with.
 


hostname
String hostname

 The instance's hostname.
 


publicIp
String publicIp

 The instance's public IP address.
 


privateIp
String privateIp

 The instance's private IP address.
 


rsaPublicKey
String rsaPublicKey

 The instances public RSA key. This key is used to encrypt communication between the instance and the service.
 


rsaPublicKeyFingerprint
String rsaPublicKeyFingerprint

 The instances public RSA key fingerprint.
 


instanceIdentity
InstanceIdentity instanceIdentity

 An InstanceIdentity object that contains the instance's identity.
 








Class com.amazonaws.services.opsworks.model.RegisterInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceId
String instanceId

 The registered instance's AWS OpsWorks Stacks ID.
 








Class com.amazonaws.services.opsworks.model.RegisterRdsDbInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 


rdsDbInstanceArn
String rdsDbInstanceArn

 The Amazon RDS instance's ARN.
 


dbUser
String dbUser

 The database's master user name.
 


dbPassword
String dbPassword

 The database password.
 








Class com.amazonaws.services.opsworks.model.RegisterRdsDbInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.RegisterVolumeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


ec2VolumeId
String ec2VolumeId

 The Amazon EBS volume ID.
 


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.RegisterVolumeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


volumeId
String volumeId

 The volume ID.
 








Class com.amazonaws.services.opsworks.model.ReportedOs extends Object implements Serializable


Serialized Fields


family
String family

 The operating system family.
 


name
String name

 The operating system name.
 


version
String version

 The operating system version.
 








Class com.amazonaws.services.opsworks.model.ResourceNotFoundException extends AWSOpsWorksException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.opsworks.model.SelfUserProfile extends Object implements Serializable


Serialized Fields


iamUserArn
String iamUserArn

 The user's IAM ARN.
 


name
String name

 The user's name.
 


sshUsername
String sshUsername

 The user's SSH user name.
 


sshPublicKey
String sshPublicKey

 The user's SSH public key.
 








Class com.amazonaws.services.opsworks.model.ServiceError extends Object implements Serializable


Serialized Fields


serviceErrorId
String serviceErrorId

 The error ID.
 


stackId
String stackId

 The stack ID.
 


instanceId
String instanceId

 The instance ID.
 


type
String type

 The error type.
 


message
String message

 A message that describes the error.
 


createdAt
String createdAt

 When the error occurred.
 








Class com.amazonaws.services.opsworks.model.SetLoadBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


layerId
String layerId

 The layer ID.
 


enable
Boolean enable

 Enables load-based auto scaling for the layer.
 


upScaling
AutoScalingThresholds upScaling

 An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds
 these thresholds for a specified amount of time, AWS OpsWorks Stacks starts a specified number of instances.
 


downScaling
AutoScalingThresholds downScaling

 An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls
 below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified number of instances.
 








Class com.amazonaws.services.opsworks.model.SetLoadBasedAutoScalingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.SetPermissionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 


iamUserArn
String iamUserArn

 The user's IAM ARN. This can also be a federated user's ARN.
 


allowSsh
Boolean allowSsh

 The user is allowed to use SSH to communicate with the instance.
 


allowSudo
Boolean allowSudo

 The user is allowed to use sudo to elevate privileges.
 


level
String level

 The user's permission level, which must be set to one of the following strings. You cannot set your own
 permissions level.
 
 
 
 
 deny
 
 
 
 
 show
 
 
 
 
 deploy
 
 
 
 
 manage
 
 
 
 
 iam_only
 
 
 
 
 For more information about the permissions associated with these levels, see Managing User
 Permissions.
 








Class com.amazonaws.services.opsworks.model.SetPermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.SetTimeBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID.
 


autoScalingSchedule
WeeklyAutoScalingSchedule autoScalingSchedule

 An AutoScalingSchedule with the instance schedule.
 








Class com.amazonaws.services.opsworks.model.SetTimeBasedAutoScalingResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.ShutdownEventConfiguration extends Object implements Serializable


Serialized Fields


executionTimeout
Integer executionTimeout

 The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down
 an instance.
 


delayUntilElbConnectionsDrained
Boolean delayUntilElbConnectionsDrained

 Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
 








Class com.amazonaws.services.opsworks.model.Source extends Object implements Serializable


Serialized Fields


type
String type

 The repository type.
 


url
String url

 The source URL. The following is an example of an Amazon S3 source URL:
 https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.
 


username
String username

 This parameter depends on the repository type.
 
 
 
 
 For Amazon S3 bundles, set Username to the appropriate IAM access key ID.
 
 
 
 
 For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.
 
 
 


password
String password

 When included in a request, the parameter depends on the repository type.
 
 
 
 
 For Amazon S3 bundles, set Password to the appropriate IAM secret access key.
 
 
 
 
 For HTTP bundles and Subversion repositories, set Password to the password.
 
 
 
 
 For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
 
 
 In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
 


sshKey
String sshKey

 In requests, the repository's SSH key.
 
 
 In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
 


revision
String revision

 The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One
 of the simplest approaches is to have branches or revisions in your repository that represent different versions
 that can potentially be deployed.
 








Class com.amazonaws.services.opsworks.model.SslConfiguration extends Object implements Serializable


Serialized Fields


certificate
String certificate

 The contents of the certificate's domain.crt file.
 


privateKey
String privateKey

 The private key; the contents of the certificate's domain.kex file.
 


chain
String chain

 Optional. Can be used to specify an intermediate certificate authority key or client authentication.
 








Class com.amazonaws.services.opsworks.model.Stack extends Object implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 


name
String name

 The stack name.
 


arn
String arn

 The stack's ARN.
 


region
String region

 The stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.
 


vpcId
String vpcId

 The VPC ID; applicable only if the stack is running in a VPC.
 


attributes
SdkInternalMap<K,V> attributes

 The stack's attributes.
 


serviceRoleArn
String serviceRoleArn

 The stack AWS Identity and Access Management (IAM) role.
 


defaultInstanceProfileArn
String defaultInstanceProfileArn

 The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information
 about IAM ARNs, see Using
 Identifiers.
 


defaultOs
String defaultOs

 The stack's default operating system.
 


hostnameTheme
String hostnameTheme

 The stack host name theme, with spaces replaced by underscores.
 


defaultAvailabilityZone
String defaultAvailabilityZone

 The stack's default Availability Zone. For more information, see Regions and Endpoints.
 


defaultSubnetId
String defaultSubnetId

 The default subnet ID; applicable only if the stack is running in a VPC.
 


customJson
String customJson

 A JSON object that contains user-defined attributes to be added to the stack configuration and deployment
 attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or
 to pass data to recipes. The string should be in the following format:
 
 
 "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
 
 
 For more information on custom JSON, see Use Custom JSON to Modify
 the Stack Configuration Attributes.
 


configurationManager
StackConfigurationManager configurationManager

 The configuration manager.
 


chefConfiguration
ChefConfiguration chefConfiguration

 A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For
 more information, see Create a New Stack.
 


useCustomCookbooks
Boolean useCustomCookbooks

 Whether the stack uses custom cookbooks.
 


useOpsworksSecurityGroups
Boolean useOpsworksSecurityGroups

 Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's
 layers.
 


customCookbooksSource
Source customCookbooksSource

 Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
 


defaultSshKeyName
String defaultSshKeyName

 A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an
 instance.
 


createdAt
String createdAt

 The date when the stack was created.
 


defaultRootDeviceType
String defaultRootDeviceType

 The default root device type. This value is used by default for all instances in the stack, but you can override
 it when you create an instance. For more information, see Storage for the Root Device.
 


agentVersion
String agentVersion

 The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed
 agent version.
 








Class com.amazonaws.services.opsworks.model.StackConfigurationManager extends Object implements Serializable


Serialized Fields


name
String name

 The name. This parameter must be set to "Chef".
 


version
String version

 The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows
 stacks. The default value for Linux stacks is 11.4.
 








Class com.amazonaws.services.opsworks.model.StackSummary extends Object implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 


name
String name

 The stack name.
 


arn
String arn

 The stack's ARN.
 


layersCount
Integer layersCount

 The number of layers.
 


appsCount
Integer appsCount

 The number of apps.
 


instancesCount
InstancesCount instancesCount

 An InstancesCount object with the number of instances in each status.
 








Class com.amazonaws.services.opsworks.model.StartInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.StartInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.StartStackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.StartStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.StopInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID.
 


force
Boolean force

 Specifies whether to force an instance to stop. If the instance's root device type is ebs, or
 EBS-backed, adding the Force parameter to the StopInstances API call disassociates the
 AWS OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. You must
 also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks
 instance with a new one.
 








Class com.amazonaws.services.opsworks.model.StopInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.StopStackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.StopStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The stack or layer's Amazon Resource Number (ARN).
 


tags
SdkInternalMap<K,V> tags

 A map that contains tag keys and tag values that are attached to a stack or layer.
 
 
 
 
 The key cannot be empty.
 
 
 
 
 The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the
 following special characters: + - = . _ : /
 
 
 
 
 The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the
 following special characters: + - = . _ : /
 
 
 
 
 Leading and trailing white spaces are trimmed from both the key and value.
 
 
 
 
 A maximum of 40 tags is allowed for any resource.
 
 
 








Class com.amazonaws.services.opsworks.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.TemporaryCredential extends Object implements Serializable


Serialized Fields


username
String username

 The user name.
 


password
String password

 The password.
 


validForInMinutes
Integer validForInMinutes

 The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, the
 user will no longer be able to use the credentials to log in. If they are logged in at the time, they will be
 automatically logged out.
 


instanceId
String instanceId

 The instance's AWS OpsWorks Stacks ID.
 








Class com.amazonaws.services.opsworks.model.TimeBasedAutoScalingConfiguration extends Object implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID.
 


autoScalingSchedule
WeeklyAutoScalingSchedule autoScalingSchedule

 A WeeklyAutoScalingSchedule object with the instance schedule.
 








Class com.amazonaws.services.opsworks.model.UnassignInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.UnassignInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.UnassignVolumeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


volumeId
String volumeId

 The volume ID.
 








Class com.amazonaws.services.opsworks.model.UnassignVolumeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The stack or layer's Amazon Resource Number (ARN).
 


tagKeys
SdkInternalList<T> tagKeys

 A list of the keys of tags to be removed from a stack or layer.
 








Class com.amazonaws.services.opsworks.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.UpdateAppRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


appId
String appId

 The app ID.
 


name
String name

 The app name.
 


description
String description

 A description of the app.
 


dataSources
SdkInternalList<T> dataSources

 The app's data sources.
 


type
String type

 The app type.
 


appSource
Source appSource

 A Source object that specifies the app repository.
 


domains
SdkInternalList<T> domains

 The app's virtual host settings, with multiple domains separated by commas. For example:
 'www.example.com, example.com'
 


enableSsl
Boolean enableSsl

 Whether SSL is enabled for the app.
 


sslConfiguration
SslConfiguration sslConfiguration

 An SslConfiguration object with the SSL configuration.
 


attributes
SdkInternalMap<K,V> attributes

 One or more user-defined key/value pairs to be added to the stack attributes.
 


environment
SdkInternalList<T> environment

 An array of EnvironmentVariable objects that specify environment variables to be associated with the
 app. After you deploy the app, these variables are defined on the associated app server instances.For more
 information, see  Environment Variables.
 
 
 There is no specific limit on the number of environment variables. However, the size of the associated data
 structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. 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 20 KB)."
 
 
 
 If you have specified one or more environment variables, you cannot modify the stack's Chef version.
 
 








Class com.amazonaws.services.opsworks.model.UpdateAppResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.UpdateElasticIpRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


elasticIp
String elasticIp

 The IP address for which you want to update the name.
 


name
String name

 The new name.
 








Class com.amazonaws.services.opsworks.model.UpdateElasticIpResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.UpdateInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


instanceId
String instanceId

 The instance ID.
 


layerIds
SdkInternalList<T> layerIds

 The instance's layer IDs.
 


instanceType
String instanceType

 The instance type, such as t2.micro. For a list of supported instance types, open the stack in the
 console, choose Instances, and choose + Instance. The Size list contains the currently
 supported types. For more information, see Instance Families and Types.
 The parameter values that you use to specify the various types are in the API Name column of the
 Available Instance Types table.
 


autoScalingType
String autoScalingType

 For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
 


hostname
String hostname

 The instance host name.
 


os
String os

 The instance's operating system, which must be set to one of the following. You cannot update an instance that is
 using a custom AMI.
 
 
 
 
 A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03,
 Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09,
 Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
 
 
 
 
 A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or
 Ubuntu 12.04 LTS.
 
 
 
 
 CentOS Linux 7
 
 
 
 
 Red Hat Enterprise Linux 7
 
 
 
 
 A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base,
 Microsoft Windows Server 2012 R2 with SQL Server Express,
 Microsoft Windows Server 2012 R2 with SQL Server Standard, or
 Microsoft Windows Server 2012 R2 with SQL Server Web.
 
 
 
 
 For more information about supported operating systems, see AWS OpsWorks Stacks
 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 about supported
 operating systems, see Operating Systems. For
 more information about how to use custom AMIs with OpsWorks, see Using Custom
 AMIs.
 
 
 
 You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to
 Windows or Windows to Linux.
 
 


amiId
String amiId

 The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that
 the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance.
 UpdateInstance does not work on instances that are using custom AMIs.
 


sshKeyName
String sshKeyName

 The instance's Amazon EC2 key name.
 


architecture
String architecture

 The instance architecture. Instance types do not necessarily support both architectures. For a list of the
 architectures that are supported by the different instance types, see Instance Families and Types.
 


installUpdatesOnBoot
Boolean installUpdatesOnBoot

 Whether to install operating system and package updates when the instance boots. The default value is
 true. To control when updates are installed, set this value to false. You must then
 update your instances manually by using CreateDeployment to run the update_dependencies stack
 command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
 
 
 
 We strongly recommend using the default value of true, to ensure that your instances have the latest
 security updates.
 
 


ebsOptimized
Boolean ebsOptimized

 This property cannot be updated.
 


agentVersion
String agentVersion

 The default AWS OpsWorks Stacks 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 Stacks
 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.
 
 
 AgentVersion cannot be set to Chef 12.2.
 








Class com.amazonaws.services.opsworks.model.UpdateInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.UpdateLayerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


layerId
String layerId

 The layer ID.
 


name
String name

 The layer name, which is used by the console.
 


shortname
String shortname

 For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS
 OpsWorks Stacks and 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 Stacks. For more information, see the Layer Reference
 


attributes
SdkInternalMap<K,V> attributes

 One or more user-defined key/value pairs to be added to the stack attributes.
 


cloudWatchLogsConfiguration
CloudWatchLogsConfiguration cloudWatchLogsConfiguration

 Specifies CloudWatch Logs configuration options for the layer. For more information, see
 CloudWatchLogsLogStream.
 


customInstanceProfileArn
String customInstanceProfileArn

 The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs,
 see Using Identifiers.
 


customJson
String customJson

 A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the
 layer's instances. For more information, see  Using Custom
 JSON.
 


customSecurityGroupIds
SdkInternalList<T> customSecurityGroupIds

 An array containing the layer's custom security group IDs.
 


packages
SdkInternalList<T> packages

 An array of Package objects that describe the layer's packages.
 


volumeConfigurations
SdkInternalList<T> volumeConfigurations

 A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
 


enableAutoHealing
Boolean enableAutoHealing

 Whether to disable auto healing for the layer.
 


autoAssignElasticIps
Boolean autoAssignElasticIps

 Whether to automatically assign an Elastic IP address
 to the layer's instances. For more information, see How to Edit a
 Layer.
 


autoAssignPublicIps
Boolean autoAssignPublicIps

 For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's
 instances. For more information, see How to Edit a
 Layer.
 


customRecipes
Recipes customRecipes

 A LayerCustomRecipes object that specifies the layer's custom recipes.
 


installUpdatesOnBoot
Boolean installUpdatesOnBoot

 Whether to install operating system and package updates when the instance boots. The default value is
 true. To control when updates are installed, set this value to false. You must then
 update your instances manually by using CreateDeployment to run the update_dependencies stack
 command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.
 
 
 
 We strongly recommend using the default value of true, to ensure that your instances have the latest
 security updates.
 
 


useEbsOptimizedInstances
Boolean useEbsOptimizedInstances

 Whether to use Amazon EBS-optimized instances.
 


lifecycleEventConfiguration
LifecycleEventConfiguration lifecycleEventConfiguration









Class com.amazonaws.services.opsworks.model.UpdateLayerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.UpdateMyUserProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


sshPublicKey
String sshPublicKey

 The user's SSH public key.
 








Class com.amazonaws.services.opsworks.model.UpdateMyUserProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.UpdateRdsDbInstanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rdsDbInstanceArn
String rdsDbInstanceArn

 The Amazon RDS instance's ARN.
 


dbUser
String dbUser

 The master user name.
 


dbPassword
String dbPassword

 The database password.
 








Class com.amazonaws.services.opsworks.model.UpdateRdsDbInstanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.UpdateStackRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


stackId
String stackId

 The stack ID.
 


name
String name

 The stack's new name.
 


attributes
SdkInternalMap<K,V> attributes

 One or more user-defined key-value pairs to be added to the stack attributes.
 


serviceRoleArn
String serviceRoleArn

 Do not use this parameter. You cannot update a stack's service role.
 


defaultInstanceProfileArn
String defaultInstanceProfileArn

 The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information
 about IAM ARNs, see Using
 Identifiers.
 


defaultOs
String defaultOs

 The stack's operating system, which must be set to one of the following:
 
 
 
 
 A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03,
 Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09,
 Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
 
 
 
 
 A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or
 Ubuntu 12.04 LTS.
 
 
 
 
 CentOS Linux 7
 
 
 
 
 Red Hat Enterprise Linux 7
 
 
 
 
 A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base,
 Microsoft Windows Server 2012 R2 with SQL Server Express,
 Microsoft Windows Server 2012 R2 with SQL Server Standard, or
 Microsoft Windows Server 2012 R2 with SQL Server Web.
 
 
 
 
 A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more
 information about how to use custom AMIs with OpsWorks, see Using Custom
 AMIs.
 
 
 
 
 The default option is the stack's current operating system. For more information about supported operating
 systems, see AWS
 OpsWorks Stacks Operating Systems.
 


hostnameTheme
String hostnameTheme

 The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names
 for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which
 creates host names by appending integers to the layer's short name. The other themes are:
 
 
 
 
 Baked_Goods
 
 
 
 
 Clouds
 
 
 
 
 Europe_Cities
 
 
 
 
 Fruits
 
 
 
 
 Greek_Deities_and_Titans
 
 
 
 
 Legendary_creatures_from_Japan
 
 
 
 
 Planets_and_Moons
 
 
 
 
 Roman_Deities
 
 
 
 
 Scottish_Islands
 
 
 
 
 US_Cities
 
 
 
 
 Wild_Cats
 
 
 
 
 To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the
 current theme.
 


defaultAvailabilityZone
String defaultAvailabilityZone

 The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a
 value for DefaultSubnetId, the subnet must be in the same zone. For more information, see
 CreateStack.
 


defaultSubnetId
String defaultSubnetId

 The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId
 parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance.
 If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For
 information on default values and when this parameter is required, see the VpcId parameter
 description.
 


customJson
String customJson

 A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack
 configuration JSON values or to pass data to recipes. The string should be in the following format:
 
 
 "{\"key1\": \"value1\", \"key2\": \"value2\",...}"
 
 
 For more information about custom JSON, see Use Custom JSON to Modify
 the Stack Configuration Attributes.
 


configurationManager
StackConfigurationManager configurationManager

 The configuration manager. When you update a stack, we recommend that you use the configuration manager to
 specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for
 Linux stacks is currently 12.
 


chefConfiguration
ChefConfiguration chefConfiguration

 A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on
 Chef 11.10 stacks. For more information, see Create a New Stack.
 


useCustomCookbooks
Boolean useCustomCookbooks

 Whether the stack uses custom cookbooks.
 


customCookbooksSource
Source customCookbooksSource

 Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.
 


defaultSshKeyName
String defaultSshKeyName

 A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS
 OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log
 in to the instance. For more information, see  Using SSH to Communicate
 with an Instance and  Managing SSH Access.
 You can override this setting by specifying a different key pair, or no key pair, when you  create an instance.
 


defaultRootDeviceType
String defaultRootDeviceType

 The default root device type. This value is used by default for all instances in the stack, but you can override
 it when you create an instance. For more information, see Storage for the Root Device.
 


useOpsworksSecurityGroups
Boolean useOpsworksSecurityGroups

 Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
 
 
 AWS OpsWorks Stacks 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 Stacks 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 Stacks does not associate built-in security groups with layers. You must create appropriate
 EC2 security groups and associate a security group with each layer that you create. However, you can still
 manually associate a built-in security group with a layer on. Custom security groups are required only for those
 layers that need custom settings.
 
 
 
 
 For more information, see Create a New Stack.
 


agentVersion
String agentVersion

 The default AWS OpsWorks Stacks agent version. You have the following options:
 
 
 
 
 Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks 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 Stacks 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. AgentVersion cannot be set to Chef 12.2.
 
 
 
 You can also specify an agent version when you create or update an instance, which overrides the stack's default
 setting.
 
 








Class com.amazonaws.services.opsworks.model.UpdateStackResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.UpdateUserProfileRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


iamUserArn
String iamUserArn

 The user IAM ARN. This can also be a federated user's ARN.
 


sshUsername
String sshUsername

 The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name
 includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be
 changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from
 the IAM user name.
 


sshPublicKey
String sshPublicKey

 The user's new SSH public key.
 


allowSelfManagement
Boolean allowSelfManagement

 Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User
 Permissions.
 








Class com.amazonaws.services.opsworks.model.UpdateUserProfileResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.UpdateVolumeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


volumeId
String volumeId

 The volume ID.
 


name
String name

 The new name.
 


mountPoint
String mountPoint

 The new mount point.
 








Class com.amazonaws.services.opsworks.model.UpdateVolumeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworks.model.UserProfile extends Object implements Serializable


Serialized Fields


iamUserArn
String iamUserArn

 The user's IAM ARN.
 


name
String name

 The user's name.
 


sshUsername
String sshUsername

 The user's SSH user name.
 


sshPublicKey
String sshPublicKey

 The user's SSH public key.
 


allowSelfManagement
Boolean allowSelfManagement

 Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User
 Permissions.
 








Class com.amazonaws.services.opsworks.model.ValidationException extends AWSOpsWorksException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


volumeId
String volumeId

 The volume ID.
 


ec2VolumeId
String ec2VolumeId

 The Amazon EC2 volume ID.
 


name
String name

 The volume name.
 


raidArrayId
String raidArrayId

 The RAID array ID.
 


instanceId
String instanceId

 The instance ID.
 


status
String status

 The value returned by DescribeVolumes.
 


size
Integer size

 The volume size.
 


device
String device

 The device name.
 


mountPoint
String mountPoint

 The volume mount point. For example, "/mnt/disk1".
 


region
String region

 The AWS region. For more information about AWS regions, see Regions and Endpoints.
 


availabilityZone
String availabilityZone

 The volume Availability Zone. For more information, see Regions and Endpoints.
 


volumeType
String volumeType

 The volume type. For more information, see  Amazon EBS Volume Types.
 
 
 
 
 standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024
 GiB.
 
 
 
 
 io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of
 16384 GiB.
 
 
 
 
 gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum
 size of 16384 GiB.
 
 
 
 
 st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a
 minimum size of 500 GiB and a maximum size of 16384 GiB.
 
 
 
 
 sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384
 GiB.
 
 
 


iops
Integer iops

 For PIOPS volumes, the IOPS per disk.
 


encrypted
Boolean encrypted

 Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
 








Class com.amazonaws.services.opsworks.model.VolumeConfiguration extends Object implements Serializable


Serialized Fields


mountPoint
String mountPoint

 The volume mount point. For example "/dev/sdh".
 


raidLevel
Integer raidLevel

 The volume RAID level.
 


numberOfDisks
Integer numberOfDisks

 The number of disks in the volume.
 


size
Integer size

 The volume size.
 


volumeType
String volumeType

 The volume type. For more information, see  Amazon EBS Volume Types.
 
 
 
 
 standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024
 GiB.
 
 
 
 
 io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of
 16384 GiB.
 
 
 
 
 gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum
 size of 16384 GiB.
 
 
 
 
 st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a
 minimum size of 500 GiB and a maximum size of 16384 GiB.
 
 
 
 
 sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384
 GiB.
 
 
 


iops
Integer iops

 For PIOPS volumes, the IOPS per disk.
 


encrypted
Boolean encrypted

 Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.
 








Class com.amazonaws.services.opsworks.model.WeeklyAutoScalingSchedule extends Object implements Serializable


Serialized Fields


monday
SdkInternalMap<K,V> monday

 The schedule for Monday.
 


tuesday
SdkInternalMap<K,V> tuesday

 The schedule for Tuesday.
 


wednesday
SdkInternalMap<K,V> wednesday

 The schedule for Wednesday.
 


thursday
SdkInternalMap<K,V> thursday

 The schedule for Thursday.
 


friday
SdkInternalMap<K,V> friday

 The schedule for Friday.
 


saturday
SdkInternalMap<K,V> saturday

 The schedule for Saturday.
 


sunday
SdkInternalMap<K,V> sunday

 The schedule for Sunday.
 








Package com.amazonaws.services.opsworkscm.model




Class com.amazonaws.services.opsworkscm.model.AccountAttribute extends Object implements Serializable


Serialized Fields


name
String name

 The attribute name. The following are supported attribute names.
 
 
 
 
 ServerLimit: The number of current servers/maximum number of servers allowed. By default, you can have a
 maximum of 10 servers.
 
 
 
 
 ManualBackupLimit: The number of current manual backups/maximum number of backups allowed. By default, you
 can have a maximum of 50 manual backups saved.
 
 
 


maximum
Integer maximum

 The maximum allowed value.
 


used
Integer used

 The current usage, such as the current number of servers that are associated with the account.
 








Class com.amazonaws.services.opsworkscm.model.AssociateNodeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serverName
String serverName

 The name of the server with which to associate the node.
 


nodeName
String nodeName

 The name of the node.
 


engineAttributes
List<E> engineAttributes

 Engine attributes used for associating the node.
 
 
 Attributes accepted in a AssociateNode request for Chef
 
 
 
 
 CHEF_ORGANIZATION: The Chef organization with which the node is associated. By default only one
 organization named default can exist.
 
 
 
 
 CHEF_NODE_PUBLIC_KEY: A PEM-formatted public key. This key is required for the
 chef-client agent to access the Chef API.
 
 
 
 
 Attributes accepted in a AssociateNode request for Puppet
 
 
 
 
 PUPPET_NODE_CSR: A PEM-formatted certificate-signing request (CSR) that is created by the node.
 
 
 








Class com.amazonaws.services.opsworkscm.model.AssociateNodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nodeAssociationStatusToken
String nodeAssociationStatusToken

 Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status
 of the association request.
 








Class com.amazonaws.services.opsworkscm.model.AWSOpsWorksCMException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.opsworkscm.model.Backup extends Object implements Serializable


Serialized Fields


backupArn
String backupArn

 The ARN of the backup.
 


backupId
String backupId

 The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS
 


backupType
String backupType

 The backup type. Valid values are automated or manual.
 


createdAt
Date createdAt

 The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z
 


description
String description

 A user-provided description for a manual backup. This field is empty for automated backups.
 


engine
String engine

 The engine type that is obtained from the server when the backup is created.
 


engineModel
String engineModel

 The engine model that is obtained from the server when the backup is created.
 


engineVersion
String engineVersion

 The engine version that is obtained from the server when the backup is created.
 


instanceProfileArn
String instanceProfileArn

 The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is
 stored, you are not required to provide the InstanceProfileArn again if you restore a backup.
 


instanceType
String instanceType

 The instance type that is obtained from the server when the backup is created.
 


keyPair
String keyPair

 The key pair that is obtained from the server when the backup is created.
 


preferredBackupWindow
String preferredBackupWindow

 The preferred backup period that is obtained from the server when the backup is created.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 The preferred maintenance period that is obtained from the server when the backup is created.
 


s3DataSize
Integer s3DataSize
Deprecated. 

 This field is deprecated and is no longer used.
 


s3DataUrl
String s3DataUrl
Deprecated. 

 This field is deprecated and is no longer used.
 


s3LogUrl
String s3LogUrl

 The Amazon S3 URL of the backup's log file.
 


securityGroupIds
List<E> securityGroupIds

 The security group IDs that are obtained from the server when the backup is created.
 


serverName
String serverName

 The name of the server from which the backup was made.
 


serviceRoleArn
String serviceRoleArn

 The service role ARN that is obtained from the server when the backup is created.
 


status
String status

 The status of a backup while in progress.
 


statusDescription
String statusDescription

 An informational message about backup status.
 


subnetIds
List<E> subnetIds

 The subnet IDs that are obtained from the server when the backup is created.
 


toolsVersion
String toolsVersion

 The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.
 


userArn
String userArn

 The IAM user ARN of the requester for manual backups. This field is empty for automated backups.
 








Class com.amazonaws.services.opsworkscm.model.CreateBackupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serverName
String serverName

 The name of the server that you want to back up.
 


description
String description

 A user-defined description of the backup.
 


tags
List<E> tags

 A map that contains tag keys and tag values to attach to an AWS OpsWorks-CM server backup.
 
 
 
 
 The key cannot be empty.
 
 
 
 
 The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the
 following special characters: + - = . _ : /
 
 
 
 
 The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the
 following special characters: + - = . _ : /
 
 
 
 
 Leading and trailing white spaces are trimmed from both the key and value.
 
 
 
 
 A maximum of 50 user-applied tags is allowed for tag-supported AWS OpsWorks-CM resources.
 
 
 








Class com.amazonaws.services.opsworkscm.model.CreateBackupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


backup
Backup backup

 Backup created by request.
 








Class com.amazonaws.services.opsworkscm.model.CreateServerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


associatePublicIpAddress
Boolean associatePublicIpAddress

 Associate a public IP address with a server that you are launching. Valid values are true or
 false. The default value is true.
 


customDomain
String customDomain

 Supported on servers running Chef Automate 2. An optional public endpoint of a server, such as
 https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS
 service that points the custom domain to the endpoint that is generated when the server is created (the value of
 the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint
 value if the server is using a custom domain. If you specify a custom domain, you must also specify values for
 CustomCertificate and CustomPrivateKey.
 


customCertificate
String customCertificate

 Supported on servers running Chef Automate 2. A PEM-formatted HTTPS certificate. The value can be be a single,
 self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify
 values for CustomDomain and CustomPrivateKey. The following are requirements for the
 CustomCertificate value:
 
 
 
 
 You can provide either a self-signed, custom certificate, or the full certificate chain.
 
 
 
 
 The certificate must be a valid X509 certificate, or a certificate chain in PEM format.
 
 
 
 
 The certificate must be valid at the time of upload. A certificate can't be used before its validity period
 begins (the certificate's NotBefore date), or after it expires (the certificate's
 NotAfter date).
 
 
 
 
 The certificate’s common name or subject alternative names (SANs), if present, must match the value of
 CustomDomain.
 
 
 
 
 The certificate must match the value of CustomPrivateKey.
 
 
 


customPrivateKey
String customPrivateKey

 Supported on servers running Chef Automate 2. A private key in PEM format for connecting to the server by using
 HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify
 a custom private key, you must also specify values for CustomDomain and
 CustomCertificate.
 


disableAutomatedBackup
Boolean disableAutomatedBackup

 Enable or disable scheduled backups. Valid values are true or false. The default value
 is true.
 


engine
String engine

 The configuration management engine to use. Valid values include ChefAutomate and
 Puppet.
 


engineModel
String engineModel

 The engine model of the server. Valid values in this release include Monolithic for Puppet and
 Single for Chef.
 


engineVersion
String engineVersion

 The major release version of the engine that you want to use. For a Chef server, the valid value for
 EngineVersion is currently 12. For a Puppet server, the valid value is 2017.
 


engineAttributes
List<E> engineAttributes

 Optional engine attributes on a specified server.
 
 
 Attributes accepted in a Chef createServer request:
 
 
 
 
 CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding private key is
 required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and
 returned in the response.
 
 
 
 
 CHEF_AUTOMATE_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate
 web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can
 contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower
 case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD
 is set, one is generated and returned in the response.
 
 
 
 
 Attributes accepted in a Puppet createServer request:
 
 
 
 
 PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII
 characters.
 
 
 
 
 PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository (for example,
 ssh://[email protected]:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.
 
 
 
 
 PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to
 specify a PEM-encoded private SSH key.
 
 
 


backupRetentionCount
Integer backupRetentionCount

 The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes
 the oldest backups if this number is exceeded. The default value is 1.
 


serverName
String serverName

 The name of the server. The server name must be unique within your AWS account, within each region. Server names
 must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.
 


instanceProfileArn
String instanceProfileArn

 The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically
 creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml
 AWS CloudFormation template, located at
 https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template
 creates a CloudFormation stack that includes the instance profile you need.
 


instanceType
String instanceType

 The Amazon EC2 instance type to use. For example, m5.large.
 


keyPair
String keyPair

 The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this
 parameter to connect to your instances by using SSH.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance.
 Valid values must be specified in the following format: DDD:HH:MM. The specified time is in
 coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday.
 See TimeWindowDefinition for more information.
 
 
 Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
 


preferredBackupWindow
String preferredBackupWindow

 The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server
 if automated backups are enabled. Valid values must be specified in one of the following formats:
 
 
 
 
 HH:MM for daily backups
 
 
 
 
 DDD:HH:MM for weekly backups
 
 
 
 
 The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.
 
 
 Example: 08:00, which represents a daily start time of 08:00 UTC.
 
 
 Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
 


securityGroupIds
List<E> securityGroupIds

 A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified
 security groups must be within the VPC that is specified by SubnetIds.
 
 
 If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and
 443, open to 0.0.0.0/0 (everyone).
 


serviceRoleArn
String serviceRoleArn

 The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS
 OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API
 commands, run the service-role-creation.yaml AWS CloudFormation template, located at
 https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template
 creates a CloudFormation stack that includes the service role and instance profile that you need.
 


subnetIds
List<E> subnetIds

 The IDs of subnets in which to launch the server EC2 instance.
 
 
 Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have
 "Auto Assign Public IP" enabled.
 
 
 EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a
 default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have
 "Auto Assign Public IP" enabled.
 
 
 For more information about supported Amazon EC2 platforms, see Supported Platforms.
 


tags
List<E> tags

 A map that contains tag keys and tag values to attach to an AWS OpsWorks for Chef Automate or AWS OpsWorks for
 Puppet Enterprise server.
 
 
 
 
 The key cannot be empty.
 
 
 
 
 The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the
 following special characters: + - = . _ : /
 
 
 
 
 The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the
 following special characters: + - = . _ : /
 
 
 
 
 Leading and trailing white spaces are trimmed from both the key and value.
 
 
 
 
 A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server.
 
 
 


backupId
String backupId

 If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.
 








Class com.amazonaws.services.opsworkscm.model.CreateServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


server
Server server

 The server that is created by the request.
 








Class com.amazonaws.services.opsworkscm.model.DeleteBackupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


backupId
String backupId

 The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in
 the format ServerName-yyyyMMddHHmmssSSS.
 








Class com.amazonaws.services.opsworkscm.model.DeleteBackupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworkscm.model.DeleteServerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serverName
String serverName

 The ID of the server to delete.
 








Class com.amazonaws.services.opsworkscm.model.DeleteServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworkscm.model.DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.opsworkscm.model.DescribeAccountAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


attributes
List<E> attributes

 The attributes that are currently set for the account.
 








Class com.amazonaws.services.opsworkscm.model.DescribeBackupsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


backupId
String backupId

 Describes a single backup.
 


serverName
String serverName

 Returns backups for the server with the specified ServerName.
 


nextToken
String nextToken

 This is not currently implemented for DescribeBackups requests.
 


maxResults
Integer maxResults

 This is not currently implemented for DescribeBackups requests.
 








Class com.amazonaws.services.opsworkscm.model.DescribeBackupsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


backups
List<E> backups

 Contains the response to a DescribeBackups request.
 


nextToken
String nextToken

 This is not currently implemented for DescribeBackups requests.
 








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


Serialized Fields


serverName
String serverName

 The name of the server for which you want to view events.
 


nextToken
String nextToken

 NextToken is a string that is returned in some command responses. It indicates that not all entries have been
 returned, and that you must run at least one more request to get remaining items. To get remaining results, call
 DescribeEvents again, and assign the token from the previous results as the value of the
 nextToken parameter. If there are no more results, the response object's nextToken
 parameter value is null. Setting a nextToken value that was not returned in your
 previous results causes an InvalidNextTokenException to occur.
 


maxResults
Integer maxResults

 To receive a paginated response, use this parameter to specify the maximum number of results to be returned with
 a single call. If the number of available results exceeds this maximum, the response includes a
 NextToken value that you can assign to the NextToken request parameter to get the next
 set of results.
 








Class com.amazonaws.services.opsworkscm.model.DescribeEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


serverEvents
List<E> serverEvents

 Contains the response to a DescribeEvents request.
 


nextToken
String nextToken

 NextToken is a string that is returned in some command responses. It indicates that not all entries have been
 returned, and that you must run at least one more request to get remaining items. To get remaining results, call
 DescribeEvents again, and assign the token from the previous results as the value of the
 nextToken parameter. If there are no more results, the response object's nextToken
 parameter value is null. Setting a nextToken value that was not returned in your
 previous results causes an InvalidNextTokenException to occur.
 








Class com.amazonaws.services.opsworkscm.model.DescribeNodeAssociationStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nodeAssociationStatusToken
String nodeAssociationStatusToken

 The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.
 


serverName
String serverName

 The name of the server from which to disassociate the node.
 








Class com.amazonaws.services.opsworkscm.model.DescribeNodeAssociationStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nodeAssociationStatus
String nodeAssociationStatus

 The status of the association or disassociation request.
 
 
 Possible values:
 
 
 
 
 SUCCESS: The association or disassociation succeeded.
 
 
 
 
 FAILED: The association or disassociation failed.
 
 
 
 
 IN_PROGRESS: The association or disassociation is still in progress.
 
 
 


engineAttributes
List<E> engineAttributes

 Attributes specific to the node association. In Puppet, the attibute PUPPET_NODE_CERT contains the signed
 certificate (the result of the CSR).
 








Class com.amazonaws.services.opsworkscm.model.DescribeServersRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serverName
String serverName

 Describes the server with the specified ServerName.
 


nextToken
String nextToken

 This is not currently implemented for DescribeServers requests.
 


maxResults
Integer maxResults

 This is not currently implemented for DescribeServers requests.
 








Class com.amazonaws.services.opsworkscm.model.DescribeServersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


servers
List<E> servers

 Contains the response to a DescribeServers request.
 
 
 For Chef Automate servers: If DescribeServersResponse$Servers$EngineAttributes includes
 CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef Automate 2. To be eligible for
 upgrade, a server running Chef Automate 1 must have had at least one successful maintenance run after November 1,
 2019.
 
 
 For Puppet Server: DescribeServersResponse$Servers$EngineAttributes contains
 PUPPET_API_CA_CERT. This is the PEM-encoded CA certificate that is used by the Puppet API over TCP port number
 8140. The CA certificate is also used to sign node certificates.
 


nextToken
String nextToken

 This is not currently implemented for DescribeServers requests.
 








Class com.amazonaws.services.opsworkscm.model.DisassociateNodeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serverName
String serverName

 The name of the server from which to disassociate the node.
 


nodeName
String nodeName

 The name of the client node.
 


engineAttributes
List<E> engineAttributes

 Engine attributes that are used for disassociating the node. No attributes are required for Puppet.
 
 
 Attributes required in a DisassociateNode request for Chef
 
 
 
 
 CHEF_ORGANIZATION: The Chef organization with which the node was associated. By default only one
 organization named default can exist.
 
 
 








Class com.amazonaws.services.opsworkscm.model.DisassociateNodeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


nodeAssociationStatusToken
String nodeAssociationStatusToken

 Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status
 of the disassociation request.
 








Class com.amazonaws.services.opsworkscm.model.EngineAttribute extends Object implements Serializable


Serialized Fields


name
String name

 The name of the engine attribute.
 


value
String value

 The value of the engine attribute.
 








Class com.amazonaws.services.opsworkscm.model.ExportServerEngineAttributeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


exportAttributeName
String exportAttributeName

 The name of the export attribute. Currently, the supported export attribute is Userdata. This
 exports a user data script that includes parameters and values provided in the InputAttributes list.
 


serverName
String serverName

 The name of the server from which you are exporting the attribute.
 


inputAttributes
List<E> inputAttributes

 The list of engine attributes. The list type is EngineAttribute. An EngineAttribute
 list item is a pair that includes an attribute name and its value. For the Userdata
 ExportAttributeName, the following are supported engine attribute names.
 
 
 
 
 RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter
 is ignored.
 
 
 
 
 OrganizationName In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the
 organization default. In Puppet, this parameter is ignored.
 
 
 
 
 NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). In Puppet,
 this parameter is ignored.
 
 
 
 
 NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as
 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this
 parameter is ignored.
 
 
 








Class com.amazonaws.services.opsworkscm.model.ExportServerEngineAttributeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


engineAttribute
EngineAttribute engineAttribute

 The requested engine attribute pair with attribute name and value.
 


serverName
String serverName

 The server name used in the request.
 








Class com.amazonaws.services.opsworkscm.model.InvalidNextTokenException extends AWSOpsWorksCMException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.opsworkscm.model.InvalidStateException extends AWSOpsWorksCMException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.opsworkscm.model.LimitExceededException extends AWSOpsWorksCMException implements Serializable

serialVersionUID:
1L





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


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or AWS OpsWorks for Puppet Enterprise
 server for which you want to show applied tags. For example,
 arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE
 .
 


nextToken
String nextToken

 NextToken is a string that is returned in some command responses. It indicates that not all entries have been
 returned, and that you must run at least one more request to get remaining items. To get remaining results, call
 ListTagsForResource again, and assign the token from the previous results as the value of the
 nextToken parameter. If there are no more results, the response object's nextToken
 parameter value is null. Setting a nextToken value that was not returned in your
 previous results causes an InvalidNextTokenException to occur.
 


maxResults
Integer maxResults

 To receive a paginated response, use this parameter to specify the maximum number of results to be returned with
 a single call. If the number of available results exceeds this maximum, the response includes a
 NextToken value that you can assign to the NextToken request parameter to get the next
 set of results.
 








Class com.amazonaws.services.opsworkscm.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 Tags that have been applied to the resource.
 


nextToken
String nextToken

 A token that you can use as the value of NextToken in subsequent calls to the API to show more
 results.
 








Class com.amazonaws.services.opsworkscm.model.ResourceAlreadyExistsException extends AWSOpsWorksCMException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.opsworkscm.model.ResourceNotFoundException extends AWSOpsWorksCMException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.opsworkscm.model.RestoreServerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


backupId
String backupId

 The ID of the backup that you want to use to restore a server.
 


serverName
String serverName

 The name of the server that you want to restore.
 


instanceType
String instanceType

 The type of instance to restore. Valid values must be specified in the following format:
 ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large,
 r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer uses the
 instance type from the specified backup.
 


keyPair
String keyPair

 The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has
 the SSH key.
 








Class com.amazonaws.services.opsworkscm.model.RestoreServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworkscm.model.Server extends Object implements Serializable


Serialized Fields


associatePublicIpAddress
Boolean associatePublicIpAddress

 Associate a public IP address with a server that you are launching.
 


backupRetentionCount
Integer backupRetentionCount

 The number of automated backups to keep.
 


serverName
String serverName

 The name of the server.
 


createdAt
Date createdAt

 Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
 


cloudFormationStackArn
String cloudFormationStackArn

 The ARN of the CloudFormation stack that was used to create the server.
 


customDomain
String customDomain

 An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the
 server by using the Endpoint value if the server has a CustomDomain specified.
 


disableAutomatedBackup
Boolean disableAutomatedBackup

 Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
 


endpoint
String endpoint

 A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io.
 You cannot access the server by using the Endpoint value if the server has a
 CustomDomain specified.
 


engine
String engine

 The engine type of the server. Valid values in this release include ChefAutomate and
 Puppet.
 


engineModel
String engineModel

 The engine model of the server. Valid values in this release include Monolithic for Puppet and
 Single for Chef.
 


engineAttributes
List<E> engineAttributes

 The response of a createServer() request returns the master credential to access the server in EngineAttributes.
 These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of
 createServer().
 
 
 Attributes returned in a createServer response for Chef
 
 
 
 
 CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for
 Chef Automate. This private key is required to access the Chef API.
 
 
 
 
 CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which
 includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then
 change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.
 
 
 
 
 Attributes returned in a createServer response for Puppet
 
 
 
 
 PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including
 a README and a required private key. Save this file, unzip it, and then change to the directory where you've
 unzipped the file contents.
 
 
 
 
 PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet
 Enterprise console after the server is online.
 
 
 


engineVersion
String engineVersion

 The engine version of the server. For a Chef server, the valid value for EngineVersion is currently
 12. For a Puppet server, the valid value is 2017.
 


instanceProfileArn
String instanceProfileArn

 The instance profile ARN of the server.
 


instanceType
String instanceType

 The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance
 type that is shown in the EC2 console.
 


keyPair
String keyPair

 The key pair associated with the server.
 


maintenanceStatus
String maintenanceStatus

 The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow

 The preferred maintenance period specified for the server.
 


preferredBackupWindow
String preferredBackupWindow

 The preferred backup period specified for the server.
 


securityGroupIds
List<E> securityGroupIds

 The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same
 security groups that are shown in the EC2 console.
 


serviceRoleArn
String serviceRoleArn

 The service role ARN used to create the server.
 


status
String status

 The server's status. This field displays the states of actions in progress, such as creating, running, or backing
 up the server, as well as the server's health state.
 


statusReason
String statusReason

 Depending on the server status, this field has either a human-readable message (such as a create or backup
 error), or an escaped block of JSON (used for health check results).
 


subnetIds
List<E> subnetIds

 The subnet IDs specified in a CreateServer request.
 


serverArn
String serverArn

 The ARN of the server.
 








Class com.amazonaws.services.opsworkscm.model.ServerEvent extends Object implements Serializable


Serialized Fields


createdAt
Date createdAt

 The time when the event occurred.
 


serverName
String serverName

 The name of the server on or for which the event occurred.
 


message
String message

 A human-readable informational or status message.
 


logUrl
String logUrl

 The Amazon S3 URL of the event's log file.
 








Class com.amazonaws.services.opsworkscm.model.StartMaintenanceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serverName
String serverName

 The name of the server on which to run maintenance.
 


engineAttributes
List<E> engineAttributes

 Engine attributes that are specific to the server on which you want to run maintenance.
 
 
 Attributes accepted in a StartMaintenance request for Chef
 
 
 
 
 CHEF_MAJOR_UPGRADE: If a Chef Automate server is eligible for upgrade to Chef Automate 2, add this
 engine attribute to a StartMaintenance request and set the value to true to upgrade the
 server to Chef Automate 2. For more information, see Upgrade an AWS OpsWorks for
 Chef Automate Server to Chef Automate 2.
 
 
 








Class com.amazonaws.services.opsworkscm.model.StartMaintenanceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


server
Server server

 Contains the response to a StartMaintenance request.
 








Class com.amazonaws.services.opsworkscm.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum
 of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special
 characters: + - = . _ : /
 


value
String value

 An optional tag value, such as Production or test-owcm-server. The value can be a
 maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special
 characters: + - = . _ : /
 








Class com.amazonaws.services.opsworkscm.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Number (ARN) of a resource to which you want to apply tags. For example,
 arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE
 .
 


tags
List<E> tags

 A map that contains tag keys and tag values to attach to AWS OpsWorks-CM servers or backups.
 
 
 
 
 The key cannot be empty.
 
 
 
 
 The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the
 following special characters: + - = . _ : /
 
 
 
 
 The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the
 following special characters: + - = . _ : /
 
 
 
 
 Leading and trailing white spaces are trimmed from both the key and value.
 
 
 
 
 A maximum of 50 user-applied tags is allowed for any AWS OpsWorks-CM server or backup.
 
 
 








Class com.amazonaws.services.opsworkscm.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworkscm.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceArn
String resourceArn

 The Amazon Resource Number (ARN) of a resource from which you want to remove tags. For example,
 arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE
 .
 


tagKeys
List<E> tagKeys

 The keys of tags that you want to remove.
 








Class com.amazonaws.services.opsworkscm.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.opsworkscm.model.UpdateServerEngineAttributesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


serverName
String serverName

 The name of the server to update.
 


attributeName
String attributeName

 The name of the engine attribute to update.
 


attributeValue
String attributeValue

 The value to set for the attribute.
 








Class com.amazonaws.services.opsworkscm.model.UpdateServerEngineAttributesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


server
Server server

 Contains the response to an UpdateServerEngineAttributes request.
 








Class com.amazonaws.services.opsworkscm.model.UpdateServerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


disableAutomatedBackup
Boolean disableAutomatedBackup

 Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups
 are enabled by default.
 


backupRetentionCount
Integer backupRetentionCount

 Sets the number of automated backups that you want to keep.
 


serverName
String serverName

 The name of the server to update.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow


preferredBackupWindow
String preferredBackupWindow








Class com.amazonaws.services.opsworkscm.model.UpdateServerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


server
Server server

 Contains the response to a UpdateServer request.
 








Class com.amazonaws.services.opsworkscm.model.ValidationException extends AWSOpsWorksCMException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.organizations.model




Class com.amazonaws.services.organizations.model.AcceptHandshakeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


handshakeId
String handshakeId

 The unique identifier (ID) of the handshake that you want to accept.
 
 
 The regex pattern for handshake ID string requires "h-" followed by
 from 8 to 32 lowercase letters or digits.
 








Class com.amazonaws.services.organizations.model.AcceptHandshakeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


handshake
Handshake handshake

 A structure that contains details about the accepted handshake.
 








Class com.amazonaws.services.organizations.model.AccessDeniedException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.AccessDeniedForDependencyException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L



Serialized Fields


reason
String reason








Class com.amazonaws.services.organizations.model.Account extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier (ID) of the account.
 
 
 The regex pattern for an account ID string requires exactly 12
 digits.
 


arn
String arn

 The Amazon Resource Name (ARN) of the account.
 
 
 For more information about ARNs in Organizations, see ARN
 Formats Supported by Organizations in the AWS Organizations User Guide.
 


email
String email

 The email address associated with the AWS account.
 
 
 The regex pattern for this parameter is a string of characters that
 represents a standard internet email address.
 


name
String name

 The friendly name of the account.
 
 
 The regex pattern that is used to validate this parameter is a
 string of any of the characters in the ASCII character range.
 


status
String status

 The status of the account in the organization.
 


joinedMethod
String joinedMethod

 The method by which the account joined the organization.
 


joinedTimestamp
Date joinedTimestamp

 The date the account became a part of the organization.
 








Class com.amazonaws.services.organizations.model.AccountCannotLeaveOrganizationException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.AccountNotFoundException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.AccountOwnerNotVerifiedException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.AlreadyInOrganizationException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.AttachPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy
 by calling the ListPolicies operation.
 
 
 The regex pattern for a policy ID string requires "p-" followed by
 from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
 


targetId
String targetId

 The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID
 by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.
 
 
 The regex pattern for a target ID string requires one of the
 following:
 
 
 
 
 Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
 
 
 
 
 Account - A string that consists of exactly 12 digits.
 
 
 
 
 Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
 digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32
 additional lowercase letters or digits.
 
 
 








Class com.amazonaws.services.organizations.model.AttachPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.organizations.model.AWSOrganizationsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.AWSOrganizationsNotInUseException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.CancelHandshakeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


handshakeId
String handshakeId

 The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the
 ListHandshakesForOrganization operation.
 
 
 The regex pattern for handshake ID string requires "h-" followed by
 from 8 to 32 lowercase letters or digits.
 








Class com.amazonaws.services.organizations.model.CancelHandshakeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


handshake
Handshake handshake

 A structure that contains details about the handshake that you canceled.
 








Class com.amazonaws.services.organizations.model.Child extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier (ID) of this child entity.
 
 
 The regex pattern for a child ID string requires one of the
 following:
 
 
 
 
 Account: A string that consists of exactly 12 digits.
 
 
 
 
 Organizational unit (OU): A string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits
 (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32
 additional lower-case letters or digits.
 
 
 


type
String type

 The type of this child entity.
 








Class com.amazonaws.services.organizations.model.ChildNotFoundException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.ConcurrentModificationException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.ConstraintViolationException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L



Serialized Fields


reason
String reason








Class com.amazonaws.services.organizations.model.CreateAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


email
String email

 The email address of the owner to assign to the new member account. This email address must not already be
 associated with another AWS account. You must use a valid email address to complete account creation. You can't
 access the root user of the account or remove an account that was created with an invalid email address.
 


accountName
String accountName

 The friendly name of the member account.
 


roleName
String roleName

 (Optional)
 
 
 The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. This role
 trusts the master account, allowing users in the master account to assume the role, as permitted by the master
 account administrator. The role has administrator permissions in the new member account.
 
 
 If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole.
 
 
 For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User
 Guide. Also see steps 2 and 3 in Tutorial: Delegate
 Access Across AWS Accounts Using IAM Roles in the IAM User Guide.
 
 
 The regex pattern that is used to validate this parameter. The
 pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following
 characters: =,.@-
 


iamUserAccessToBilling
String iamUserAccessToBilling

 If set to ALLOW, the new account enables IAM users to access account billing information if
 they have the required permissions. If set to DENY, only the root user of the new account can access
 account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User
 Guide.
 
 
 If you don't specify this parameter, the value defaults to ALLOW. This value allows IAM users and
 roles with the required permissions to access billing information for the new account.
 








Class com.amazonaws.services.organizations.model.CreateAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


createAccountStatus
CreateAccountStatus createAccountStatus

 A structure that contains details about the request to create an account. This response structure might not be
 fully populated when you first receive it because account creation is an asynchronous process. You can pass the
 returned CreateAccountStatus ID as a parameter to DescribeCreateAccountStatus to get status
 about the progress of the request at later times. You can also check the AWS CloudTrail log for the
 CreateAccountResult event. For more information, see Monitoring the Activity in
 Your Organization in the AWS Organizations User Guide.
 








Class com.amazonaws.services.organizations.model.CreateAccountStatus extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier (ID) that references this request. You get this value from the response of the initial
 CreateAccount request to create the account.
 
 
 The regex pattern for a create account request ID string requires
 "car-" followed by from 8 to 32 lower-case letters or digits.
 


accountName
String accountName

 The account name given to the account when it was created.
 


state
String state

 The status of the request.
 


requestedTimestamp
Date requestedTimestamp

 The date and time that the request was made for the account creation.
 


completedTimestamp
Date completedTimestamp

 The date and time that the account was created and the request completed.
 


accountId
String accountId

 If the account was created successfully, the unique identifier (ID) of the new account.
 
 
 The regex pattern for an account ID string requires exactly 12
 digits.
 


govCloudAccountId
String govCloudAccountId

 If the account was created successfully, the unique identifier (ID) of the new account in the AWS GovCloud (US)
 Region.
 


failureReason
String failureReason

 If the request failed, a description of the reason for the failure.
 
 
 
 
 ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of
 accounts in your organization.
 
 
 
 
 EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address
 already exists.
 
 
 
 
 GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the AWS GovCloud (US) Region could not be created because this
 Region already includes an account with that email address.
 
 
 
 
 INVALID_ADDRESS: The account could not be created because the address you provided is not valid.
 
 
 
 
 INVALID_EMAIL: The account could not be created because the email address you provided is not valid.
 
 
 
 
 INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the
 problem persists, contact AWS Support.
 
 
 








Class com.amazonaws.services.organizations.model.CreateAccountStatusNotFoundException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.CreateGovCloudAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


email
String email

 The email address of the owner to assign to the new member account in the commercial Region. This email address
 must not already be associated with another AWS account. You must use a valid email address to complete account
 creation. You can't access the root user of the account or remove an account that was created with an invalid
 email address. Like all request parameters for CreateGovCloudAccount, the request for the email
 address for the AWS GovCloud (US) account originates from the commercial Region. It does not come from the AWS
 GovCloud (US) Region.
 


accountName
String accountName

 The friendly name of the member account.
 


roleName
String roleName

 (Optional)
 
 
 The name of an IAM role that AWS Organizations automatically preconfigures in the new member accounts in both the
 AWS GovCloud (US) Region and in the commercial Region. This role trusts the master account, allowing users in the
 master account to assume the role, as permitted by the master account administrator. The role has administrator
 permissions in the new member account.
 
 
 If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole.
 
 
 For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User
 Guide. See also steps 2 and 3 in Tutorial: Delegate
 Access Across AWS Accounts Using IAM Roles in the IAM User Guide.
 
 
 The regex pattern that is used to validate this parameter. The
 pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following
 characters: =,.@-
 


iamUserAccessToBilling
String iamUserAccessToBilling

 If set to ALLOW, the new linked account in the commercial Region enables IAM users to access account
 billing information if they have the required permissions. If set to DENY, only the root user
 of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User
 Guide.
 
 
 If you don't specify this parameter, the value defaults to ALLOW, and IAM users and roles with the
 required permissions can access billing information for the new account.
 








Class com.amazonaws.services.organizations.model.CreateGovCloudAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


createAccountStatus
CreateAccountStatus createAccountStatus








Class com.amazonaws.services.organizations.model.CreateOrganizationalUnitRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


parentId
String parentId

 The unique identifier (ID) of the parent root or OU that you want to create the new OU in.
 
 
 The regex pattern for a parent ID string requires one of the
 following:
 
 
 
 
 Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
 
 
 
 
 Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
 digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32
 additional lowercase letters or digits.
 
 
 


name
String name

 The friendly name to assign to the new OU.
 








Class com.amazonaws.services.organizations.model.CreateOrganizationalUnitResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organizationalUnit
OrganizationalUnit organizationalUnit

 A structure that contains details about the newly created OU.
 








Class com.amazonaws.services.organizations.model.CreateOrganizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


featureSet
String featureSet

 Specifies the feature set supported by the new organization. Each feature set supports different levels of
 functionality.
 
 
 
 
 CONSOLIDATED_BILLING: All member accounts have their bills consolidated to and paid by the master
 account. For more information, see Consolidated billing in the AWS Organizations User Guide.
 
 
 The consolidated billing feature subset isn't available for organizations in the AWS GovCloud (US) Region.
 
 
 
 
 ALL: In addition to all the features that consolidated billing feature set supports, the master
 account can also apply any policy type to any member account in the organization. For more information, see All features in the AWS Organizations User Guide.
 
 
 








Class com.amazonaws.services.organizations.model.CreateOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organization
Organization organization

 A structure that contains details about the newly created organization.
 








Class com.amazonaws.services.organizations.model.CreatePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


content
String content

 The policy content to add to the new policy. For example, you could create a service control
 policy (SCP) that specifies the permissions that administrators in attached accounts can delegate to their
 users, groups, and roles. The string for this SCP must be JSON text. For more information about the SCP syntax,
 see Service
 Control Policy Syntax in the AWS Organizations User Guide.
 


description
String description

 An optional description to assign to the policy.
 


name
String name

 The friendly name to assign to the policy.
 
 
 The regex pattern that is used to validate this parameter is a
 string of any of the characters in the ASCII character range.
 


type
String type

 The type of policy to create.
 








Class com.amazonaws.services.organizations.model.CreatePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
Policy policy

 A structure that contains details about the newly created policy.
 








Class com.amazonaws.services.organizations.model.DeclineHandshakeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


handshakeId
String handshakeId

 The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the
 ListHandshakesForAccount operation.
 
 
 The regex pattern for handshake ID string requires "h-" followed by
 from 8 to 32 lowercase letters or digits.
 








Class com.amazonaws.services.organizations.model.DeclineHandshakeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


handshake
Handshake handshake

 A structure that contains details about the declined handshake. The state is updated to show the value
 DECLINED.
 








Class com.amazonaws.services.organizations.model.DeleteOrganizationalUnitRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationalUnitId
String organizationalUnitId

 The unique identifier (ID) of the organizational unit that you want to delete. You can get the ID from the
 ListOrganizationalUnitsForParent operation.
 
 
 The regex pattern for an organizational unit ID string requires
 "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string
 is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
 








Class com.amazonaws.services.organizations.model.DeleteOrganizationalUnitResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.organizations.model.DeleteOrganizationRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.organizations.model.DeleteOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.organizations.model.DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The unique identifier (ID) of the policy that you want to delete. You can get the ID from the ListPolicies
 or ListPoliciesForTarget operations.
 
 
 The regex pattern for a policy ID string requires "p-" followed by
 from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
 








Class com.amazonaws.services.organizations.model.DeletePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.organizations.model.DescribeAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The unique identifier (ID) of the AWS account that you want information about. You can get the ID from the
 ListAccounts or ListAccountsForParent operations.
 
 
 The regex pattern for an account ID string requires exactly 12
 digits.
 








Class com.amazonaws.services.organizations.model.DescribeAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


account
Account account

 A structure that contains information about the requested account.
 








Class com.amazonaws.services.organizations.model.DescribeCreateAccountStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


createAccountRequestId
String createAccountRequestId

 Specifies the operationId that uniquely identifies the request. You can get the ID from the response
 to an earlier CreateAccount request, or from the ListCreateAccountStatus operation.
 
 
 The regex pattern for a create account request ID string requires
 "car-" followed by from 8 to 32 lowercase letters or digits.
 








Class com.amazonaws.services.organizations.model.DescribeCreateAccountStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


createAccountStatus
CreateAccountStatus createAccountStatus

 A structure that contains the current status of an account creation request.
 








Class com.amazonaws.services.organizations.model.DescribeEffectivePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyType
String policyType

 The type of policy that you want information about.
 


targetId
String targetId

 When you're signed in as the master account, specify the ID of the account that you want details about.
 Specifying an organization root or OU as the target is not supported.
 








Class com.amazonaws.services.organizations.model.DescribeEffectivePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


effectivePolicy
EffectivePolicy effectivePolicy

 The contents of the effective policy.
 








Class com.amazonaws.services.organizations.model.DescribeHandshakeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


handshakeId
String handshakeId

 The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original
 call to InviteAccountToOrganization, or from a call to ListHandshakesForAccount or
 ListHandshakesForOrganization.
 
 
 The regex pattern for handshake ID string requires "h-" followed by
 from 8 to 32 lowercase letters or digits.
 








Class com.amazonaws.services.organizations.model.DescribeHandshakeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


handshake
Handshake handshake

 A structure that contains information about the specified handshake.
 








Class com.amazonaws.services.organizations.model.DescribeOrganizationalUnitRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationalUnitId
String organizationalUnitId

 The unique identifier (ID) of the organizational unit that you want details about. You can get the ID from the
 ListOrganizationalUnitsForParent operation.
 
 
 The regex pattern for an organizational unit ID string requires
 "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string
 is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
 








Class com.amazonaws.services.organizations.model.DescribeOrganizationalUnitResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organizationalUnit
OrganizationalUnit organizationalUnit

 A structure that contains details about the specified OU.
 








Class com.amazonaws.services.organizations.model.DescribeOrganizationRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.organizations.model.DescribeOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organization
Organization organization

 A structure that contains information about the organization.
 








Class com.amazonaws.services.organizations.model.DescribePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The unique identifier (ID) of the policy that you want details about. You can get the ID from the
 ListPolicies or ListPoliciesForTarget operations.
 
 
 The regex pattern for a policy ID string requires "p-" followed by
 from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
 








Class com.amazonaws.services.organizations.model.DescribePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
Policy policy

 A structure that contains details about the specified policy.
 








Class com.amazonaws.services.organizations.model.DestinationParentNotFoundException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.DetachPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The unique identifier (ID) of the policy you want to detach. You can get the ID from the ListPolicies or
 ListPoliciesForTarget operations.
 
 
 The regex pattern for a policy ID string requires "p-" followed by
 from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
 


targetId
String targetId

 The unique identifier (ID) of the root, OU, or account that you want to detach the policy from. You can get the
 ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.
 
 
 The regex pattern for a target ID string requires one of the
 following:
 
 
 
 
 Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
 
 
 
 
 Account - A string that consists of exactly 12 digits.
 
 
 
 
 Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
 digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32
 additional lowercase letters or digits.
 
 
 








Class com.amazonaws.services.organizations.model.DetachPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.organizations.model.DisableAWSServiceAccessRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


servicePrincipal
String servicePrincipal

 The service principal name of the AWS service for which you want to disable integration with your organization.
 This is typically in the form of a URL, such as  service-abbreviation.amazonaws.com.
 








Class com.amazonaws.services.organizations.model.DisableAWSServiceAccessResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.organizations.model.DisablePolicyTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rootId
String rootId

 The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the
 ListRoots operation.
 
 
 The regex pattern for a root ID string requires "r-" followed by
 from 4 to 32 lowercase letters or digits.
 


policyType
String policyType

 The policy type that you want to disable in this root.
 








Class com.amazonaws.services.organizations.model.DisablePolicyTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


root
Root root

 A structure that shows the root with the updated list of enabled policy types.
 








Class com.amazonaws.services.organizations.model.DuplicateAccountException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.DuplicateHandshakeException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.DuplicateOrganizationalUnitException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.DuplicatePolicyAttachmentException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.DuplicatePolicyException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.EffectivePolicy extends Object implements Serializable


Serialized Fields


policyContent
String policyContent

 The text content of the policy.
 


lastUpdatedTimestamp
Date lastUpdatedTimestamp

 The time of the last update to this policy.
 


targetId
String targetId

 The account ID of the policy target.
 


policyType
String policyType

 The policy type.
 








Class com.amazonaws.services.organizations.model.EffectivePolicyNotFoundException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.EnableAllFeaturesRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.organizations.model.EnableAllFeaturesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


handshake
Handshake handshake

 A structure that contains details about the handshake created to support this request to enable all features in
 the organization.
 








Class com.amazonaws.services.organizations.model.EnableAWSServiceAccessRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


servicePrincipal
String servicePrincipal

 The service principal name of the AWS service for which you want to enable integration with your organization.
 This is typically in the form of a URL, such as  service-abbreviation.amazonaws.com.
 








Class com.amazonaws.services.organizations.model.EnableAWSServiceAccessResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.organizations.model.EnabledServicePrincipal extends Object implements Serializable


Serialized Fields


servicePrincipal
String servicePrincipal

 The name of the service principal. This is typically in the form of a URL, such as:
  servicename.amazonaws.com.
 


dateEnabled
Date dateEnabled

 The date that the service principal was enabled for integration with AWS Organizations.
 








Class com.amazonaws.services.organizations.model.EnablePolicyTypeRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


rootId
String rootId

 The unique identifier (ID) of the root in which you want to enable a policy type. You can get the ID from the
 ListRoots operation.
 
 
 The regex pattern for a root ID string requires "r-" followed by
 from 4 to 32 lowercase letters or digits.
 


policyType
String policyType

 The policy type that you want to enable.
 








Class com.amazonaws.services.organizations.model.EnablePolicyTypeResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


root
Root root

 A structure that shows the root with the updated list of enabled policy types.
 








Class com.amazonaws.services.organizations.model.FinalizingOrganizationException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.FullControlAlreadyEnabledException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.Handshake extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the
 handshake.
 
 
 The regex pattern for handshake ID string requires "h-" followed by
 from 8 to 32 lower-case letters or digits.
 


arn
String arn

 The Amazon Resource Name (ARN) of a handshake.
 
 
 For more information about ARNs in Organizations, see ARN
 Formats Supported by Organizations in the AWS Organizations User Guide.
 


parties
List<E> parties

 Information about the two accounts that are participating in the handshake.
 


state
String state

 The current state of the handshake. Use the state to trace the flow of the handshake through the process from its
 creation to its acceptance. The meaning of each of the valid values is as follows:
 
 
 
 
 REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and
 not all recipients have responded yet. The request stays in this state until all recipients respond.
 
 
 
 
 OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all
 recipients have responded, allowing the originator to complete the handshake action.
 
 
 
 
 CANCELED: This handshake is no longer active because it was canceled by the originating account.
 
 
 
 
 ACCEPTED: This handshake is complete because it has been accepted by the recipient.
 
 
 
 
 DECLINED: This handshake is no longer active because it was declined by the recipient account.
 
 
 
 
 EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind
 from the recipient before the expiration time (15 days).
 
 
 


requestedTimestamp
Date requestedTimestamp

 The date and time that the handshake request was made.
 


expirationTimestamp
Date expirationTimestamp

 The date and time that the handshake expires. If the recipient of the handshake request fails to respond before
 the specified date and time, the handshake becomes inactive and is no longer valid.
 


action
String action

 The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following
 handshake types are supported:
 
 
 
 
 INVITE: This type of handshake represents a request to join an organization. It is always sent from the
 master account to only non-member accounts.
 
 
 
 
 ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an
 organization. It is always sent from the master account to only invited member accounts. Created accounts
 do not receive this because those accounts were created by the organization's master account and approval is
 inferred.
 
 
 
 
 APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member
 accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and
 signals the master that it can finalize the process to enable all features.
 
 
 


resources
List<E> resources

 Additional information that is needed to process the handshake.
 








Class com.amazonaws.services.organizations.model.HandshakeAlreadyInStateException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.HandshakeConstraintViolationException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L



Serialized Fields


reason
String reason








Class com.amazonaws.services.organizations.model.HandshakeFilter extends Object implements Serializable


Serialized Fields


actionType
String actionType

 Specifies the type of handshake action.
 
 
 If you specify ActionType, you cannot also specify ParentHandshakeId.
 


parentHandshakeId
String parentHandshakeId

 Specifies the parent handshake. Only used for handshake types that are a child of another type.
 
 
 If you specify ParentHandshakeId, you cannot also specify ActionType.
 
 
 The regex pattern for handshake ID string requires "h-" followed by
 from 8 to 32 lower-case letters or digits.
 








Class com.amazonaws.services.organizations.model.HandshakeNotFoundException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.HandshakeParty extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier (ID) for the party.
 
 
 The regex pattern for handshake ID string requires "h-" followed by
 from 8 to 32 lower-case letters or digits.
 


type
String type

 The type of party.
 








Class com.amazonaws.services.organizations.model.HandshakeResource extends Object implements Serializable


Serialized Fields


value
String value

 The information that is passed to the other party in the handshake. The format of the value string must match the
 requirements of the specified type.
 


type
String type

 The type of information being passed, specifying how the value is to be interpreted by the other party:
 
 
 
 
 ACCOUNT - Specifies an AWS account ID number.
 
 
 
 
 ORGANIZATION - Specifies an organization ID number.
 
 
 
 
 EMAIL - Specifies the email address that is associated with the account that receives the handshake.
 
 
 
 
 OWNER_EMAIL - Specifies the email address associated with the master account. Included as
 information about an organization.
 
 
 
 
 OWNER_NAME - Specifies the name associated with the master account. Included as information about an
 organization.
 
 
 
 
 NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
 
 
 


resources
List<E> resources

 When needed, contains an additional array of HandshakeResource objects.
 








Class com.amazonaws.services.organizations.model.InvalidHandshakeTransitionException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.InvalidInputException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L



Serialized Fields


reason
String reason








Class com.amazonaws.services.organizations.model.InvitationsDisabledDuringOrganizationModeChangeException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.InviteAccountToOrganizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


target
HandshakeParty target

 The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object
 that contains the following elements:
 
 
 { "Type": "ACCOUNT", "Id": "< account id number >" }
 
 
 If you use the AWS CLI, you can submit this as a single string, similar to the following example:
 
 
 --target Id=123456789012,Type=ACCOUNT
 
 
 If you specify "Type": "ACCOUNT", you must provide the AWS account ID number as the Id.
 If you specify "Type": "EMAIL", you must specify the email address that is associated with the
 account.
 
 
 --target [email protected],Type=EMAIL
 


notes
String notes

 Additional information that you want to include in the generated email to the recipient account owner.
 








Class com.amazonaws.services.organizations.model.InviteAccountToOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


handshake
Handshake handshake

 A structure that contains details about the handshake that is created to support this invitation request.
 








Class com.amazonaws.services.organizations.model.LeaveOrganizationRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.organizations.model.LeaveOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.organizations.model.ListAccountsForParentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


parentId
String parentId

 The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list.
 


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListAccountsForParentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accounts
List<E> accounts

 A list of the accounts in the specified root or OU.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.ListAccountsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListAccountsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


accounts
List<E> accounts

 A list of objects in the organization.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.ListAWSServiceAccessForOrganizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListAWSServiceAccessForOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


enabledServicePrincipals
List<E> enabledServicePrincipals

 A list of the service principals for the services that are enabled to integrate with your organization. Each
 principal is a structure that includes the name and the date that it was enabled for integration with AWS
 Organizations.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.ListChildrenRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


parentId
String parentId

 The unique identifier (ID) for the parent root or OU whose children you want to list.
 
 
 The regex pattern for a parent ID string requires one of the
 following:
 
 
 
 
 Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
 
 
 
 
 Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
 digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32
 additional lowercase letters or digits.
 
 
 


childType
String childType

 Filters the output to include only the specified child type.
 


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListChildrenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


children
List<E> children

 The list of children of the specified parent container.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.ListCreateAccountStatusRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


states
List<E> states

 A list of one or more states that you want included in the response. If this parameter isn't present, all
 requests are included in the response.
 


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListCreateAccountStatusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


createAccountStatuses
List<E> createAccountStatuses

 A list of objects with details about the requests. Certain elements, such as the accountId number, are present in
 the output only after the account has been successfully created.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.ListHandshakesForAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
HandshakeFilter filter

 Filters the handshakes that you want included in the response. The default is all types. Use the
 ActionType element to limit the output to only a specified type, such as INVITE,
 ENABLE_ALL_FEATURES, or APPROVE_ALL_FEATURES. Alternatively, you can specify the
 ENABLE_ALL_FEATURES handshake, which generates a separate child handshake for each member account.
 When you do specify ParentHandshakeId to see only the handshakes that were generated by that parent
 request.
 


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListHandshakesForAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


handshakes
List<E> handshakes

 A list of Handshake objects with details about each of the handshakes that is associated with the
 specified account.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.ListHandshakesForOrganizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
HandshakeFilter filter

 A filter of the handshakes that you want included in the response. The default is all types. Use the
 ActionType element to limit the output to only a specified type, such as INVITE,
 ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. Alternatively, you can specify the
 ENABLE-ALL-FEATURES handshake, which generates a separate child handshake for each member account.
 When you do, specify the ParentHandshakeId to see only the handshakes that were generated by that
 parent request.
 


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListHandshakesForOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


handshakes
List<E> handshakes

 A list of Handshake objects with details about each of the handshakes that are associated with an
 organization.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.ListOrganizationalUnitsForParentRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


parentId
String parentId

 The unique identifier (ID) of the root or OU whose child OUs you want to list.
 
 
 The regex pattern for a parent ID string requires one of the
 following:
 
 
 
 
 Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
 
 
 
 
 Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
 digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32
 additional lowercase letters or digits.
 
 
 


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListOrganizationalUnitsForParentResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organizationalUnits
List<E> organizationalUnits

 A list of the OUs in the specified root or parent OU.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.ListParentsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


childId
String childId

 The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.
 
 
 The regex pattern for a child ID string requires one of the
 following:
 
 
 
 
 Account - A string that consists of exactly 12 digits.
 
 
 
 
 Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
 digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32
 additional lowercase letters or digits.
 
 
 


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListParentsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


parents
List<E> parents

 A list of parents for the specified child account or OU.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.ListPoliciesForTargetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


targetId
String targetId

 The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list.
 
 
 The regex pattern for a target ID string requires one of the
 following:
 
 
 
 
 Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
 
 
 
 
 Account - A string that consists of exactly 12 digits.
 
 
 
 
 Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
 digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32
 additional lowercase letters or digits.
 
 
 


filter
String filter

 The type of policy that you want to include in the returned list.
 


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListPoliciesForTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policies
List<E> policies

 The list of policies that match the criteria in the request.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.ListPoliciesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


filter
String filter

 Specifies the type of policy that you want to include in the response.
 


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policies
List<E> policies

 A list of policies that match the filter criteria in the request. The output list doesn't include the policy
 contents. To see the content for a policy, see DescribePolicy.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.ListRootsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListRootsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


roots
List<E> roots

 A list of roots that are defined in an organization.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








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


Serialized Fields


resourceId
String resourceId

 The ID of the resource that you want to retrieve tags for.
 


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 








Class com.amazonaws.services.organizations.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


tags
List<E> tags

 The tags that are assigned to the resource.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.ListTargetsForPolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The unique identifier (ID) of the policy whose attachments you want to know.
 
 
 The regex pattern for a policy ID string requires "p-" followed by
 from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
 


nextToken
String nextToken

 Use this parameter if you receive a NextToken response in a previous request that indicates that
 there is more output available. Set it to the value of the previous call's NextToken response to
 indicate where the output should continue from.
 


maxResults
Integer maxResults

 (Optional) Use this to limit the number of results you want included per page in the response. If you do not
 include this parameter, it defaults to a value that is specific to the operation. If additional items exist
 beyond the maximum you specify, the NextToken response element is present and has a value (is not
 null). Include that value as the NextToken request parameter in the next call to the operation to
 get the next part of the results. Note that Organizations might return fewer results than the maximum even when
 there are more results available. You should check NextToken after every operation to ensure that
 you receive all of the results.
 








Class com.amazonaws.services.organizations.model.ListTargetsForPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


targets
List<E> targets

 A list of structures, each of which contains details about one of the entities to which the specified policy is
 attached.
 


nextToken
String nextToken

 If present, this value indicates that there is more output available than is included in the current response.
 Use this value in the NextToken request parameter in a subsequent call to the operation to get the
 next part of the output. You should repeat this until the NextToken response element comes back as
 null.
 








Class com.amazonaws.services.organizations.model.MalformedPolicyDocumentException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.MasterCannotLeaveOrganizationException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.MoveAccountRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The unique identifier (ID) of the account that you want to move.
 
 
 The regex pattern for an account ID string requires exactly 12
 digits.
 


sourceParentId
String sourceParentId

 The unique identifier (ID) of the root or organizational unit that you want to move the account from.
 
 
 The regex pattern for a parent ID string requires one of the
 following:
 
 
 
 
 Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
 
 
 
 
 Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
 digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32
 additional lowercase letters or digits.
 
 
 


destinationParentId
String destinationParentId

 The unique identifier (ID) of the root or organizational unit that you want to move the account to.
 
 
 The regex pattern for a parent ID string requires one of the
 following:
 
 
 
 
 Root - A string that begins with "r-" followed by from 4 to 32 lowercase letters or digits.
 
 
 
 
 Organizational unit (OU) - A string that begins with "ou-" followed by from 4 to 32 lowercase letters or
 digits (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32
 additional lowercase letters or digits.
 
 
 








Class com.amazonaws.services.organizations.model.MoveAccountResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.organizations.model.Organization extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier (ID) of an organization.
 
 
 The regex pattern for an organization ID string requires "o-"
 followed by from 10 to 32 lower-case letters or digits.
 


arn
String arn

 The Amazon Resource Name (ARN) of an organization.
 
 
 For more information about ARNs in Organizations, see ARN
 Formats Supported by Organizations in the AWS Organizations User Guide.
 


featureSet
String featureSet

 Specifies the functionality that currently is available to the organization. If set to "ALL", then all features
 are enabled and policies can be applied to accounts in the organization. If set to "CONSOLIDATED_BILLING", then
 only consolidated billing functionality is available. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.
 


masterAccountArn
String masterAccountArn

 The Amazon Resource Name (ARN) of the account that is designated as the master account for the organization.
 
 
 For more information about ARNs in Organizations, see ARN
 Formats Supported by Organizations in the AWS Organizations User Guide.
 


masterAccountId
String masterAccountId

 The unique identifier (ID) of the master account of an organization.
 
 
 The regex pattern for an account ID string requires exactly 12
 digits.
 


masterAccountEmail
String masterAccountEmail

 The email address that is associated with the AWS account that is designated as the master account for the
 organization.
 


availablePolicyTypes
List<E> availablePolicyTypes

 A list of policy types that are enabled for this organization. For example, if your organization has all features
 enabled, then service control policies (SCPs) are included in the list.
 
 
 
 Even if a policy type is shown as available in the organization, you can separately enable and disable them at
 the root level by using EnablePolicyType and DisablePolicyType. Use ListRoots to see the
 status of a policy type in that root.
 
 








Class com.amazonaws.services.organizations.model.OrganizationalUnit extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier (ID) associated with this OU.
 
 
 The regex pattern for an organizational unit ID string requires
 "ou-" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU). This
 string is followed by a second "-" dash and from 8 to 32 additional lower-case letters or digits.
 


arn
String arn

 The Amazon Resource Name (ARN) of this OU.
 
 
 For more information about ARNs in Organizations, see ARN
 Formats Supported by Organizations in the AWS Organizations User Guide.
 


name
String name

 The friendly name of this OU.
 
 
 The regex pattern that is used to validate this parameter is a
 string of any of the characters in the ASCII character range.
 








Class com.amazonaws.services.organizations.model.OrganizationalUnitNotEmptyException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.OrganizationalUnitNotFoundException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.OrganizationFromDifferentSellerOfRecordException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.OrganizationNotEmptyException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.Parent extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier (ID) of the parent entity.
 
 
 The regex pattern for a parent ID string requires one of the
 following:
 
 
 
 
 Root: A string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
 
 
 
 
 Organizational unit (OU): A string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits
 (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional
 lower-case letters or digits.
 
 
 


type
String type

 The type of the parent entity.
 








Class com.amazonaws.services.organizations.model.ParentNotFoundException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.PaymentInstrumentRequiredException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.Policy extends Object implements Serializable


Serialized Fields


policySummary
PolicySummary policySummary

 A structure that contains additional details about the policy.
 


content
String content

 The text content of the policy.
 








Class com.amazonaws.services.organizations.model.PolicyChangesInProgressException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.PolicyInUseException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.PolicyNotAttachedException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.PolicyNotFoundException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.PolicySummary extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier (ID) of the policy.
 
 
 The regex pattern for a policy ID string requires "p-" followed by
 from 8 to 128 lower-case letters or digits.
 


arn
String arn

 The Amazon Resource Name (ARN) of the policy.
 
 
 For more information about ARNs in Organizations, see ARN
 Formats Supported by Organizations in the AWS Organizations User Guide.
 


name
String name

 The friendly name of the policy.
 
 
 The regex pattern that is used to validate this parameter is a
 string of any of the characters in the ASCII character range.
 


description
String description

 The description of the policy.
 


type
String type

 The type of policy.
 


awsManaged
Boolean awsManaged

 A Boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can
 attach the policy to roots, OUs, or accounts, but you cannot edit it.
 








Class com.amazonaws.services.organizations.model.PolicyTargetSummary extends Object implements Serializable


Serialized Fields


targetId
String targetId

 The unique identifier (ID) of the policy target.
 
 
 The regex pattern for a target ID string requires one of the
 following:
 
 
 
 
 Root: A string that begins with "r-" followed by from 4 to 32 lower-case letters or digits.
 
 
 
 
 Account: A string that consists of exactly 12 digits.
 
 
 
 
 Organizational unit (OU): A string that begins with "ou-" followed by from 4 to 32 lower-case letters or digits
 (the ID of the root that the OU is in). This string is followed by a second "-" dash and from 8 to 32 additional
 lower-case letters or digits.
 
 
 


arn
String arn

 The Amazon Resource Name (ARN) of the policy target.
 
 
 For more information about ARNs in Organizations, see ARN
 Formats Supported by Organizations in the AWS Organizations User Guide.
 


name
String name

 The friendly name of the policy target.
 
 
 The regex pattern that is used to validate this parameter is a
 string of any of the characters in the ASCII character range.
 


type
String type

 The type of the policy target.
 








Class com.amazonaws.services.organizations.model.PolicyTypeAlreadyEnabledException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.PolicyTypeNotAvailableForOrganizationException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.PolicyTypeNotEnabledException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.PolicyTypeSummary extends Object implements Serializable


Serialized Fields


type
String type

 The name of the policy type.
 


status
String status

 The status of the policy type as it relates to the associated root. You can attach a policy of the specified type
 to a root or to an OU or account in that root. To do so, the policy must be available in the organization and
 enabled for that root.
 








Class com.amazonaws.services.organizations.model.RemoveAccountFromOrganizationRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


accountId
String accountId

 The unique identifier (ID) of the member account that you want to remove from the organization.
 
 
 The regex pattern for an account ID string requires exactly 12
 digits.
 








Class com.amazonaws.services.organizations.model.RemoveAccountFromOrganizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.organizations.model.Root extends Object implements Serializable


Serialized Fields


id
String id

 The unique identifier (ID) for the root.
 
 
 The regex pattern for a root ID string requires "r-" followed by
 from 4 to 32 lower-case letters or digits.
 


arn
String arn

 The Amazon Resource Name (ARN) of the root.
 
 
 For more information about ARNs in Organizations, see ARN
 Formats Supported by Organizations in the AWS Organizations User Guide.
 


name
String name

 The friendly name of the root.
 
 
 The regex pattern that is used to validate this parameter is a
 string of any of the characters in the ASCII character range.
 


policyTypes
List<E> policyTypes

 The types of policies that are currently enabled for the root and therefore can be attached to the root or to its
 OUs or accounts.
 
 
 
 Even if a policy type is shown as available in the organization, you can separately enable and disable them at
 the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to
 see the availability of the policy types in that organization.
 
 








Class com.amazonaws.services.organizations.model.RootNotFoundException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.ServiceException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.SourceParentNotFoundException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.Tag extends Object implements Serializable


Serialized Fields


key
String key

 The key identifier, or name, of the tag.
 


value
String value

 The string value that's associated with the key of the tag. You can set the value of a tag to an empty string,
 but you can't set the value of a tag to null.
 








Class com.amazonaws.services.organizations.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceId
String resourceId

 The ID of the resource to add a tag to.
 


tags
List<E> tags

 The tag to add to the specified resource. Specifying the tag key is required. You can set the value of a tag to
 an empty string, but you can't set the value of a tag to null.
 








Class com.amazonaws.services.organizations.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.organizations.model.TargetNotFoundException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.TooManyRequestsException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L



Serialized Fields


type
String type








Class com.amazonaws.services.organizations.model.UnsupportedAPIEndpointException extends AWSOrganizationsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.organizations.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


resourceId
String resourceId

 The ID of the resource to remove the tag from.
 


tagKeys
List<E> tagKeys

 The tag to remove from the specified resource.
 








Class com.amazonaws.services.organizations.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable




Class com.amazonaws.services.organizations.model.UpdateOrganizationalUnitRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


organizationalUnitId
String organizationalUnitId

 The unique identifier (ID) of the OU that you want to rename. You can get the ID from the
 ListOrganizationalUnitsForParent operation.
 
 
 The regex pattern for an organizational unit ID string requires
 "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string
 is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
 


name
String name

 The new name that you want to assign to the OU.
 
 
 The regex pattern that is used to validate this parameter is a
 string of any of the characters in the ASCII character range.
 








Class com.amazonaws.services.organizations.model.UpdateOrganizationalUnitResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


organizationalUnit
OrganizationalUnit organizationalUnit

 A structure that contains the details about the specified OU, including its new name.
 








Class com.amazonaws.services.organizations.model.UpdatePolicyRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


policyId
String policyId

 The unique identifier (ID) of the policy that you want to update.
 
 
 The regex pattern for a policy ID string requires "p-" followed by
 from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).
 


name
String name

 If provided, the new name for the policy.
 
 
 The regex pattern that is used to validate this parameter is a
 string of any of the characters in the ASCII character range.
 


description
String description

 If provided, the new description for the policy.
 


content
String content

 If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the
 syntax for the policy's type. For more information, see Service Control
 Policy Syntax in the AWS Organizations User Guide.
 








Class com.amazonaws.services.organizations.model.UpdatePolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


policy
Policy policy

 A structure that contains details about the updated policy, showing the requested changes.
 








Package com.amazonaws.services.outposts.model




Class com.amazonaws.services.outposts.model.AccessDeniedException extends AWSOutpostsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.outposts.model.AWSOutpostsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.outposts.model.CreateOutpostRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name


description
String description


siteId
String siteId


availabilityZone
String availabilityZone


availabilityZoneId
String availabilityZoneId








Class com.amazonaws.services.outposts.model.CreateOutpostResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


outpost
Outpost outpost








Class com.amazonaws.services.outposts.model.GetOutpostInstanceTypesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


outpostId
String outpostId


nextToken
String nextToken


maxResults
Integer maxResults








Class com.amazonaws.services.outposts.model.GetOutpostInstanceTypesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


instanceTypes
List<E> instanceTypes


nextToken
String nextToken


outpostId
String outpostId


outpostArn
String outpostArn








Class com.amazonaws.services.outposts.model.GetOutpostRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


outpostId
String outpostId








Class com.amazonaws.services.outposts.model.GetOutpostResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


outpost
Outpost outpost








Class com.amazonaws.services.outposts.model.InstanceTypeItem extends Object implements Serializable


Serialized Fields


instanceType
String instanceType








Class com.amazonaws.services.outposts.model.InternalServerException extends AWSOutpostsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.outposts.model.ListOutpostsRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken


maxResults
Integer maxResults








Class com.amazonaws.services.outposts.model.ListOutpostsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


outposts
List<E> outposts


nextToken
String nextToken








Class com.amazonaws.services.outposts.model.ListSitesRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


nextToken
String nextToken


maxResults
Integer maxResults








Class com.amazonaws.services.outposts.model.ListSitesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


sites
List<E> sites


nextToken
String nextToken








Class com.amazonaws.services.outposts.model.NotFoundException extends AWSOutpostsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.outposts.model.Outpost extends Object implements Serializable


Serialized Fields


outpostId
String outpostId


ownerId
String ownerId


outpostArn
String outpostArn


siteId
String siteId


name
String name


description
String description


lifeCycleStatus
String lifeCycleStatus


availabilityZone
String availabilityZone


availabilityZoneId
String availabilityZoneId








Class com.amazonaws.services.outposts.model.ServiceQuotaExceededException extends AWSOutpostsException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.outposts.model.Site extends Object implements Serializable


Serialized Fields


siteId
String siteId


accountId
String accountId


name
String name


description
String description








Class com.amazonaws.services.outposts.model.ValidationException extends AWSOutpostsException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.personalize.model




Class com.amazonaws.services.personalize.model.Algorithm extends Object implements Serializable


Serialized Fields


name
String name

 The name of the algorithm.
 


algorithmArn
String algorithmArn

 The Amazon Resource Name (ARN) of the algorithm.
 


algorithmImage
AlgorithmImage algorithmImage

 The URI of the Docker container for the algorithm image.
 


defaultHyperParameters
Map<K,V> defaultHyperParameters

 Specifies the default hyperparameters.
 


defaultHyperParameterRanges
DefaultHyperParameterRanges defaultHyperParameterRanges

 Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can
 have its value determined during hyperparameter optimization (HPO).
 


defaultResourceConfig
Map<K,V> defaultResourceConfig

 Specifies the default maximum number of training jobs and parallel training jobs.
 


trainingInputMode
String trainingInputMode

 The training input mode.
 


roleArn
String roleArn

 The Amazon Resource Name (ARN) of the role.
 


creationDateTime
Date creationDateTime

 The date and time (in Unix time) that the algorithm was created.
 


lastUpdatedDateTime
Date lastUpdatedDateTime

 The date and time (in Unix time) that the algorithm was last updated.
 








Class com.amazonaws.services.personalize.model.AlgorithmImage extends Object implements Serializable


Serialized Fields


name
String name

 The name of the algorithm image.
 


dockerURI
String dockerURI

 The URI of the Docker container for the algorithm image.
 








Class com.amazonaws.services.personalize.model.AmazonPersonalizeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.personalize.model.AutoMLConfig extends Object implements Serializable


Serialized Fields


metricName
String metricName

 The metric to optimize.
 


recipeList
List<E> recipeList

 The list of candidate recipes.
 








Class com.amazonaws.services.personalize.model.AutoMLResult extends Object implements Serializable


Serialized Fields


bestRecipeArn
String bestRecipeArn

 The Amazon Resource Name (ARN) of the best recipe.
 








Class com.amazonaws.services.personalize.model.BatchInferenceJob extends Object implements Serializable


Serialized Fields


jobName
String jobName

 The name of the batch inference job.
 


batchInferenceJobArn
String batchInferenceJobArn

 The Amazon Resource Name (ARN) of the batch inference job.
 


failureReason
String failureReason

 If the batch inference job failed, the reason for the failure.
 


solutionVersionArn
String solutionVersionArn

 The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.
 


numResults
Integer numResults

 The number of recommendations generated by the batch inference job. This number includes the error messages
 generated for failed input records.
 


jobInput
BatchInferenceJobInput jobInput

 The Amazon S3 path that leads to the input data used to generate the batch inference job.
 


jobOutput
BatchInferenceJobOutput jobOutput

 The Amazon S3 bucket that contains the output data generated by the batch inference job.
 


roleArn
String roleArn

 The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch inference job.
 


status
String status

 The status of the batch inference job. The status is one of the following values:
 
 
 
 
 PENDING
 
 
 
 
 IN PROGRESS
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE FAILED
 
 
 


creationDateTime
Date creationDateTime

 The time at which the batch inference job was created.
 


lastUpdatedDateTime
Date lastUpdatedDateTime

 The time at which the batch inference job was last updated.
 








Class com.amazonaws.services.personalize.model.BatchInferenceJobInput extends Object implements Serializable


Serialized Fields


s3DataSource
S3DataConfig s3DataSource

 The URI of the Amazon S3 location that contains your input data. The Amazon S3 bucket must be in the same region
 as the API endpoint you are calling.
 








Class com.amazonaws.services.personalize.model.BatchInferenceJobOutput extends Object implements Serializable


Serialized Fields


s3DataDestination
S3DataConfig s3DataDestination

 Information on the Amazon S3 bucket in which the batch inference job's output is stored.
 








Class com.amazonaws.services.personalize.model.BatchInferenceJobSummary extends Object implements Serializable


Serialized Fields


batchInferenceJobArn
String batchInferenceJobArn

 The Amazon Resource Name (ARN) of the batch inference job.
 


jobName
String jobName

 The name of the batch inference job.
 


status
String status

 The status of the batch inference job. The status is one of the following values:
 
 
 
 
 PENDING
 
 
 
 
 IN PROGRESS
 
 
 
 
 ACTIVE
 
 
 
 
 CREATE FAILED
 
 
 


creationDateTime
Date creationDateTime

 The time at which the batch inference job was created.
 


lastUpdatedDateTime
Date lastUpdatedDateTime

 The time at which the batch inference job was last updated.
 


failureReason
String failureReason

 If the batch inference job failed, the reason for the failure.
 








Class com.amazonaws.services.personalize.model.Campaign extends Object implements Serializable


Serialized Fields


name
String name

 The name of the campaign.
 


campaignArn
String campaignArn

 The Amazon Resource Name (ARN) of the campaign.
 


solutionVersionArn
String solutionVersionArn

 The Amazon Resource Name (ARN) of a specific version of the solution.
 


minProvisionedTPS
Integer minProvisionedTPS

 Specifies the requested minimum provisioned transactions (recommendations) per second.
 


status
String status

 The status of the campaign.
 
 
 A campaign can be in one of the following states:
 
 
 
 
 CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
 
 
 
 
 DELETE PENDING > DELETE IN_PROGRESS
 
 
 


failureReason
String failureReason

 If a campaign fails, the reason behind the failure.
 


creationDateTime
Date creationDateTime

 The date and time (in Unix format) that the campaign was created.
 


lastUpdatedDateTime
Date lastUpdatedDateTime

 The date and time (in Unix format) that the campaign was last updated.
 


latestCampaignUpdate
CampaignUpdateSummary latestCampaignUpdate








Class com.amazonaws.services.personalize.model.CampaignSummary extends Object implements Serializable


Serialized Fields


name
String name

 The name of the campaign.
 


campaignArn
String campaignArn

 The Amazon Resource Name (ARN) of the campaign.
 


status
String status

 The status of the campaign.
 
 
 A campaign can be in one of the following states:
 
 
 
 
 CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
 
 
 
 
 DELETE PENDING > DELETE IN_PROGRESS
 
 
 


creationDateTime
Date creationDateTime

 The date and time (in Unix time) that the campaign was created.
 


lastUpdatedDateTime
Date lastUpdatedDateTime

 The date and time (in Unix time) that the campaign was last updated.
 


failureReason
String failureReason

 If a campaign fails, the reason behind the failure.
 








Class com.amazonaws.services.personalize.model.CampaignUpdateSummary extends Object implements Serializable


Serialized Fields


solutionVersionArn
String solutionVersionArn

 The Amazon Resource Name (ARN) of the deployed solution version.
 


minProvisionedTPS
Integer minProvisionedTPS

 Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize
 will support.
 


status
String status

 The status of the campaign update.
 
 
 A campaign update can be in one of the following states:
 
 
 
 
 CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
 
 
 
 
 DELETE PENDING > DELETE IN_PROGRESS
 
 
 


failureReason
String failureReason

 If a campaign update fails, the reason behind the failure.
 


creationDateTime
Date creationDateTime

 The date and time (in Unix time) that the campaign update was created.
 


lastUpdatedDateTime
Date lastUpdatedDateTime

 The date and time (in Unix time) that the campaign update was last updated.
 








Class com.amazonaws.services.personalize.model.CategoricalHyperParameterRange extends Object implements Serializable


Serialized Fields


name
String name

 The name of the hyperparameter.
 


values
List<E> values

 A list of the categories for the hyperparameter.
 








Class com.amazonaws.services.personalize.model.ContinuousHyperParameterRange extends Object implements Serializable


Serialized Fields


name
String name

 The name of the hyperparameter.
 


minValue
Double minValue

 The minimum allowable value for the hyperparameter.
 


maxValue
Double maxValue

 The maximum allowable value for the hyperparameter.
 








Class com.amazonaws.services.personalize.model.CreateBatchInferenceJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 The name of the batch inference job to create.
 


solutionVersionArn
String solutionVersionArn

 The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference
 recommendations.
 


numResults
Integer numResults

 The number of recommendations to retreive.
 


jobInput
BatchInferenceJobInput jobInput

 The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in
 JSON format.
 


jobOutput
BatchInferenceJobOutput jobOutput

 The path to the Amazon S3 bucket where the job's output will be stored.
 


roleArn
String roleArn

 The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input
 and out Amazon S3 buckets respectively.
 








Class com.amazonaws.services.personalize.model.CreateBatchInferenceJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


batchInferenceJobArn
String batchInferenceJobArn

 The ARN of the batch inference job.
 








Class com.amazonaws.services.personalize.model.CreateCampaignRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 A name for the new campaign. The campaign name must be unique within your account.
 


solutionVersionArn
String solutionVersionArn

 The Amazon Resource Name (ARN) of the solution version to deploy.
 


minProvisionedTPS
Integer minProvisionedTPS

 Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize
 will support.
 








Class com.amazonaws.services.personalize.model.CreateCampaignResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


campaignArn
String campaignArn

 The Amazon Resource Name (ARN) of the campaign.
 








Class com.amazonaws.services.personalize.model.CreateDatasetGroupRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name for the new dataset group.
 


roleArn
String roleArn

 The ARN of the IAM role that has permissions to access the KMS key. Supplying an IAM role is only valid when also
 specifying a KMS key.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.
 








Class com.amazonaws.services.personalize.model.CreateDatasetGroupResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the new dataset group.
 








Class com.amazonaws.services.personalize.model.CreateDatasetImportJobRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


jobName
String jobName

 The name for the dataset import job.
 


datasetArn
String datasetArn

 The ARN of the dataset that receives the imported data.
 


dataSource
DataSource dataSource

 The Amazon S3 bucket that contains the training data to import.
 


roleArn
String roleArn

 The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
 








Class com.amazonaws.services.personalize.model.CreateDatasetImportJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetImportJobArn
String datasetImportJobArn

 The ARN of the dataset import job.
 








Class com.amazonaws.services.personalize.model.CreateDatasetRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name for the dataset.
 


schemaArn
String schemaArn

 The ARN of the schema to associate with the dataset. The schema defines the dataset fields.
 


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group to add the dataset to.
 


datasetType
String datasetType

 The type of dataset.
 
 
 One of the following (case insensitive) values:
 
 
 
 
 Interactions
 
 
 
 
 Items
 
 
 
 
 Users
 
 
 








Class com.amazonaws.services.personalize.model.CreateDatasetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


datasetArn
String datasetArn

 The ARN of the dataset.
 








Class com.amazonaws.services.personalize.model.CreateEventTrackerRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name for the event tracker.
 


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group that receives the event data.
 








Class com.amazonaws.services.personalize.model.CreateEventTrackerResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


eventTrackerArn
String eventTrackerArn

 The ARN of the event tracker.
 


trackingId
String trackingId

 The ID of the event tracker. Include this ID in requests to the PutEvents API.
 








Class com.amazonaws.services.personalize.model.CreateSchemaRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name for the schema.
 


schema
String schema

 A schema in Avro JSON format.
 








Class com.amazonaws.services.personalize.model.CreateSchemaResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


schemaArn
String schemaArn

 The Amazon Resource Name (ARN) of the created schema.
 








Class com.amazonaws.services.personalize.model.CreateSolutionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


name
String name

 The name for the solution.
 


performHPO
Boolean performHPO

 Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is
 false.
 
 
 When performing AutoML, this parameter is always true and you should not set it to
 false.
 


performAutoML
Boolean performAutoML

 Whether to perform automated machine learning (AutoML). The default is false. For this case, you
 must specify recipeArn.
 
 
 When set to true, Amazon Personalize analyzes your training data and selects the optimal
 USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon
 Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML
 lengthens the training process as compared to selecting a specific recipe.
 


recipeArn
String recipeArn

 The ARN of the recipe to use for model training. Only specified when performAutoML is false.
 


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group that provides the training data.
 


eventType
String eventType

 When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies
 which event type (for example, 'click' or 'like') is used for training the model.
 


solutionConfig
SolutionConfig solutionConfig

 The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize
 only evaluates the autoMLConfig section of the solution configuration.
 








Class com.amazonaws.services.personalize.model.CreateSolutionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


solutionArn
String solutionArn

 The ARN of the solution.
 








Class com.amazonaws.services.personalize.model.CreateSolutionVersionRequest extends AmazonWebServiceRequest implements Serializable


Serialized Fields


solutionArn
String solutionArn

 The Amazon Resource Name (ARN) of the solution containing the training configuration information.
 


trainingMode
String trainingMode

 The scope of training to be performed when creating the solution version. The FULL option trains the
 solution version based on the entirety of the input solution's training data, while the UPDATE
 option processes only the data that has changed in comparison to the input solution. Choose UPDATE
 when you want to incrementally update your solution version instead of creating an entirely new one.
 
 
 
 The UPDATE option can only be used when you already have an active solution version created from the
 input solution using the FULL option and the input solution was trained with the
 native-recipe-hrnn-coldstart recipe.
 
 








Class com.amazonaws.services.personalize.model.CreateSolutionVersionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable


Serialized Fields


solutionVersionArn
String solutionVersionArn

 The ARN of the new solution version.
 








Class com.amazonaws.services.personalize.model.Dataset extends Object implements Serializable


Serialized Fields


name
String name

 The name of the dataset.
 


datasetArn
String datasetArn

 The Amazon Resource Name (ARN) of the dataset that you want metadata for.
 


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group.
 


datasetType
String datasetType

 One of the following values:
 
 
 
 
 Interactions
 
 
 
 
 Items
 
 
 
 
 Users
 
 
 


schemaArn
String schemaArn

 The ARN of the associated schema.
 


status
String status

 The status of the dataset.
 
 
 A dataset can be in one of the following states:
 
 
 
 
 CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
 
 
 
 
 DELETE PENDING > DELETE IN_PROGRESS
 
 
 


creationDateTime
Date creationDateTime

 The creation date and time (in Unix time) of the dataset.
 


lastUpdatedDateTime
Date lastUpdatedDateTime

 A time stamp that shows when the dataset was updated.
 








Class com.amazonaws.services.personalize.model.DatasetGroup extends Object implements Serializable


Serialized Fields


name
String name

 The name of the dataset group.
 


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group.
 


status
String status

 The current status of the dataset group.
 
 
 A dataset group can be in one of the following states:
 
 
 
 
 CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
 
 
 
 
 DELETE PENDING
 
 
 


roleArn
String roleArn

 The ARN of the IAM role that has permissions to create the dataset group.
 


kmsKeyArn
String kmsKeyArn

 The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets.
 


creationDateTime
Date creationDateTime

 The creation date and time (in Unix time) of the dataset group.
 


lastUpdatedDateTime
Date lastUpdatedDateTime

 The last update date and time (in Unix time) of the dataset group.
 


failureReason
String failureReason

 If creating a dataset group fails, provides the reason why.
 








Class com.amazonaws.services.personalize.model.DatasetGroupSummary extends Object implements Serializable


Serialized Fields


name
String name

 The name of the dataset group.
 


datasetGroupArn
String datasetGroupArn

 The Amazon Resource Name (ARN) of the dataset group.
 


status
String status

 The status of the dataset group.
 
 
 A dataset group can be in one of the following states:
 
 
 
 
 CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
 
 
 
 
 DELETE PENDING
 
 
 


creationDateTime
Date creationDateTime

 The date and time (in Unix time) that the dataset group was created.
 


lastUpdatedDateTime
Date lastUpdatedDateTime

 The date and time (in Unix time) that the dataset group was last updated.
 


failureReason
String failureReason

 If creating a dataset group fails, the reason behind the failure.
 








Class com.amazonaws.services.personalize.model.DatasetImportJob extends Object implements Serializable


Serialized Fields


jobName
String jobName

 The name of the import job.
 


datasetImportJobArn
String datasetImportJobArn

 The ARN of the dataset import job.
 


datasetArn
String datasetArn

 The Amazon Resource Name (ARN) of the dataset that receives the imported data.
 


dataSource
DataSource dataSource

 The Amazon S3 bucket that contains the training data to import.
 


roleArn
String roleArn

 The ARN of the AWS Identity and Access Management (IAM) role that has permissions to read from the Amazon S3 data
 source.
 


status
String status

 The status of the dataset ACTIVE -or- CREATE FAILED

Did this page help you?

Serialized Form

Package com.amazonaws

Class com.amazonaws.AbortedException extends SdkClientException implements Serializable

Class com.amazonaws.AmazonClientException extends SdkBaseException implements Serializable

Class com.amazonaws.AmazonServiceException extends SdkClientException implements Serializable

Serialized Fields

requestId

errorCode

errorType

errorMessage

statusCode

serviceName

httpHeaders

rawResponse

Class com.amazonaws.ResetException extends SdkClientException implements Serializable

Serialized Fields

extraInfo

Class com.amazonaws.SdkBaseException extends RuntimeException implements Serializable

Class com.amazonaws.SdkClientException extends AmazonClientException implements Serializable

Package com.amazonaws.http.exception

Class com.amazonaws.http.exception.HttpRequestTimeoutException extends IOException implements Serializable

Package com.amazonaws.http.timers.client

Class com.amazonaws.http.timers.client.ClientExecutionTimeoutException extends SdkClientException implements Serializable

Class com.amazonaws.http.timers.client.SdkInterruptedException extends InterruptedException implements Serializable

Package com.amazonaws.internal

Class com.amazonaws.internal.CRC32MismatchException extends IOException implements Serializable

Class com.amazonaws.internal.ListWithAutoConstructFlag extends ArrayList<T> implements Serializable

Serialized Fields

autoConstruct

Class com.amazonaws.internal.SdkInternalList extends ArrayList<T> implements Serializable

Serialized Fields

autoConstruct

Class com.amazonaws.internal.SdkInternalMap extends Object implements Serializable

Serialized Fields

map

autoConstruct

Package com.amazonaws.jmespath

Class com.amazonaws.jmespath.InvalidTypeException extends RuntimeException implements Serializable

Package com.amazonaws.protocol.json

Class com.amazonaws.protocol.json.SdkJsonGenerator.JsonGenerationException extends SdkClientException implements Serializable

Package com.amazonaws.services.accessanalyzer.model

Class com.amazonaws.services.accessanalyzer.model.AccessDeniedException extends AWSAccessAnalyzerException implements Serializable

Class com.amazonaws.services.accessanalyzer.model.AnalyzedResource extends Object implements Serializable

Serialized Fields

actions

analyzedAt

createdAt

error

isPublic

resourceArn

resourceType

sharedVia

status

updatedAt

Class com.amazonaws.services.accessanalyzer.model.AnalyzedResourceSummary extends Object implements Serializable

Serialized Fields

resourceArn

resourceType

Class com.amazonaws.services.accessanalyzer.model.AnalyzerSummary extends Object implements Serializable

Serialized Fields

arn

createdAt

lastResourceAnalyzed

lastResourceAnalyzedAt

name

tags

type

Class com.amazonaws.services.accessanalyzer.model.ArchiveRuleSummary extends Object implements Serializable

Serialized Fields

createdAt

filter

ruleName

updatedAt

Class com.amazonaws.services.accessanalyzer.model.AWSAccessAnalyzerException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.accessanalyzer.model.ConflictException extends AWSAccessAnalyzerException implements Serializable

Serialized Fields

resourceId

resourceType

Class com.amazonaws.services.accessanalyzer.model.CreateAnalyzerRequest extends AmazonWebServiceRequest implements Serializable